@seamapi/types 1.375.2 → 1.377.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/connect.cjs +1708 -529
- package/dist/connect.cjs.map +1 -1
- package/dist/connect.d.cts +1588 -363
- package/lib/seam/connect/models/access-codes/managed-access-code.js +48 -23
- package/lib/seam/connect/models/access-codes/managed-access-code.js.map +1 -1
- package/lib/seam/connect/models/access-codes/unmanaged-access-code.js +13 -2
- package/lib/seam/connect/models/access-codes/unmanaged-access-code.js.map +1 -1
- package/lib/seam/connect/models/acs/acs-users/acs-user.d.ts +182 -150
- package/lib/seam/connect/models/acs/acs-users/acs-user.js +2 -3
- package/lib/seam/connect/models/acs/acs-users/acs-user.js.map +1 -1
- package/lib/seam/connect/models/acs/acs-users/index.d.ts +1 -1
- package/lib/seam/connect/models/acs/acs-users/index.js +1 -1
- package/lib/seam/connect/models/acs/acs-users/index.js.map +1 -1
- package/lib/seam/connect/models/acs/acs-users/{pending-modifications.d.ts → pending-mutations.d.ts} +191 -106
- package/lib/seam/connect/models/acs/acs-users/pending-mutations.js +90 -0
- package/lib/seam/connect/models/acs/acs-users/pending-mutations.js.map +1 -0
- package/lib/seam/connect/openapi.d.ts +257 -58
- package/lib/seam/connect/openapi.js +1588 -436
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +1155 -161
- package/package.json +1 -1
- package/src/lib/seam/connect/models/access-codes/managed-access-code.ts +95 -60
- package/src/lib/seam/connect/models/access-codes/unmanaged-access-code.ts +15 -2
- package/src/lib/seam/connect/models/acs/acs-users/acs-user.ts +2 -3
- package/src/lib/seam/connect/models/acs/acs-users/index.ts +1 -1
- package/src/lib/seam/connect/models/acs/acs-users/pending-mutations.ts +110 -0
- package/src/lib/seam/connect/openapi.ts +1928 -446
- package/src/lib/seam/connect/route-types.ts +1162 -161
- package/lib/seam/connect/models/acs/acs-users/pending-modifications.js +0 -85
- package/lib/seam/connect/models/acs/acs-users/pending-modifications.js.map +0 -1
- package/src/lib/seam/connect/models/acs/acs-users/pending-modifications.ts +0 -109
|
@@ -2,6 +2,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.',
|
|
@@ -2486,23 +2934,30 @@ export default {
|
|
|
2486
2934
|
type: 'string',
|
|
2487
2935
|
'x-undocumented': 'Only used internally.',
|
|
2488
2936
|
},
|
|
2489
|
-
|
|
2937
|
+
pending_mutations: {
|
|
2490
2938
|
items: {
|
|
2491
|
-
discriminator: { propertyName: '
|
|
2939
|
+
discriminator: { propertyName: 'mutation_code' },
|
|
2492
2940
|
oneOf: [
|
|
2493
2941
|
{
|
|
2494
2942
|
properties: {
|
|
2495
2943
|
created_at: { format: 'date-time', type: 'string' },
|
|
2496
|
-
|
|
2944
|
+
mutation_code: { enum: ['creating'], type: 'string' },
|
|
2497
2945
|
},
|
|
2498
|
-
required: ['created_at', '
|
|
2946
|
+
required: ['created_at', 'mutation_code'],
|
|
2499
2947
|
type: 'object',
|
|
2500
2948
|
},
|
|
2501
2949
|
{
|
|
2502
2950
|
properties: {
|
|
2503
2951
|
created_at: { format: 'date-time', type: 'string' },
|
|
2504
|
-
|
|
2505
|
-
|
|
2952
|
+
mutation_code: { enum: ['deleting'], type: 'string' },
|
|
2953
|
+
},
|
|
2954
|
+
required: ['created_at', 'mutation_code'],
|
|
2955
|
+
type: 'object',
|
|
2956
|
+
},
|
|
2957
|
+
{
|
|
2958
|
+
properties: {
|
|
2959
|
+
created_at: { format: 'date-time', type: 'string' },
|
|
2960
|
+
from: {
|
|
2506
2961
|
properties: {
|
|
2507
2962
|
email_address: {
|
|
2508
2963
|
format: 'email',
|
|
@@ -2514,7 +2969,11 @@ export default {
|
|
|
2514
2969
|
},
|
|
2515
2970
|
type: 'object',
|
|
2516
2971
|
},
|
|
2517
|
-
|
|
2972
|
+
mutation_code: {
|
|
2973
|
+
enum: ['updating_user_information'],
|
|
2974
|
+
type: 'string',
|
|
2975
|
+
},
|
|
2976
|
+
to: {
|
|
2518
2977
|
properties: {
|
|
2519
2978
|
email_address: {
|
|
2520
2979
|
format: 'email',
|
|
@@ -2527,22 +2986,13 @@ export default {
|
|
|
2527
2986
|
type: 'object',
|
|
2528
2987
|
},
|
|
2529
2988
|
},
|
|
2530
|
-
required: [
|
|
2531
|
-
'created_at',
|
|
2532
|
-
'modification_code',
|
|
2533
|
-
'modified_from',
|
|
2534
|
-
'modified_to',
|
|
2535
|
-
],
|
|
2989
|
+
required: ['created_at', 'mutation_code', 'from', 'to'],
|
|
2536
2990
|
type: 'object',
|
|
2537
2991
|
},
|
|
2538
2992
|
{
|
|
2539
2993
|
properties: {
|
|
2540
2994
|
created_at: { format: 'date-time', type: 'string' },
|
|
2541
|
-
|
|
2542
|
-
enum: ['access_schedule'],
|
|
2543
|
-
type: 'string',
|
|
2544
|
-
},
|
|
2545
|
-
modified_from: {
|
|
2995
|
+
from: {
|
|
2546
2996
|
properties: {
|
|
2547
2997
|
ends_at: {
|
|
2548
2998
|
description:
|
|
@@ -2561,7 +3011,11 @@ export default {
|
|
|
2561
3011
|
required: ['starts_at', 'ends_at'],
|
|
2562
3012
|
type: 'object',
|
|
2563
3013
|
},
|
|
2564
|
-
|
|
3014
|
+
mutation_code: {
|
|
3015
|
+
enum: ['updating_access_schedule'],
|
|
3016
|
+
type: 'string',
|
|
3017
|
+
},
|
|
3018
|
+
to: {
|
|
2565
3019
|
properties: {
|
|
2566
3020
|
ends_at: {
|
|
2567
3021
|
description:
|
|
@@ -2581,48 +3035,34 @@ export default {
|
|
|
2581
3035
|
type: 'object',
|
|
2582
3036
|
},
|
|
2583
3037
|
},
|
|
2584
|
-
required: [
|
|
2585
|
-
'created_at',
|
|
2586
|
-
'modification_code',
|
|
2587
|
-
'modified_from',
|
|
2588
|
-
'modified_to',
|
|
2589
|
-
],
|
|
3038
|
+
required: ['created_at', 'mutation_code', 'from', 'to'],
|
|
2590
3039
|
type: 'object',
|
|
2591
3040
|
},
|
|
2592
3041
|
{
|
|
2593
3042
|
properties: {
|
|
2594
3043
|
created_at: { format: 'date-time', type: 'string' },
|
|
2595
|
-
|
|
2596
|
-
enum: ['suspension_state'],
|
|
2597
|
-
type: 'string',
|
|
2598
|
-
},
|
|
2599
|
-
modified_from: {
|
|
3044
|
+
from: {
|
|
2600
3045
|
properties: { is_suspended: { type: 'boolean' } },
|
|
2601
3046
|
required: ['is_suspended'],
|
|
2602
3047
|
type: 'object',
|
|
2603
3048
|
},
|
|
2604
|
-
|
|
3049
|
+
mutation_code: {
|
|
3050
|
+
enum: ['updating_suspension_state'],
|
|
3051
|
+
type: 'string',
|
|
3052
|
+
},
|
|
3053
|
+
to: {
|
|
2605
3054
|
properties: { is_suspended: { type: 'boolean' } },
|
|
2606
3055
|
required: ['is_suspended'],
|
|
2607
3056
|
type: 'object',
|
|
2608
3057
|
},
|
|
2609
3058
|
},
|
|
2610
|
-
required: [
|
|
2611
|
-
'created_at',
|
|
2612
|
-
'modification_code',
|
|
2613
|
-
'modified_from',
|
|
2614
|
-
'modified_to',
|
|
2615
|
-
],
|
|
3059
|
+
required: ['created_at', 'mutation_code', 'from', 'to'],
|
|
2616
3060
|
type: 'object',
|
|
2617
3061
|
},
|
|
2618
3062
|
{
|
|
2619
3063
|
properties: {
|
|
2620
3064
|
created_at: { format: 'date-time', type: 'string' },
|
|
2621
|
-
|
|
2622
|
-
enum: ['acs_access_group_membership'],
|
|
2623
|
-
type: 'string',
|
|
2624
|
-
},
|
|
2625
|
-
modified_from: {
|
|
3065
|
+
from: {
|
|
2626
3066
|
properties: {
|
|
2627
3067
|
acs_access_group_id: {
|
|
2628
3068
|
format: 'uuid',
|
|
@@ -2633,7 +3073,11 @@ export default {
|
|
|
2633
3073
|
required: ['acs_access_group_id'],
|
|
2634
3074
|
type: 'object',
|
|
2635
3075
|
},
|
|
2636
|
-
|
|
3076
|
+
mutation_code: {
|
|
3077
|
+
enum: ['updating_group_membership'],
|
|
3078
|
+
type: 'string',
|
|
3079
|
+
},
|
|
3080
|
+
to: {
|
|
2637
3081
|
properties: {
|
|
2638
3082
|
acs_access_group_id: {
|
|
2639
3083
|
format: 'uuid',
|
|
@@ -2645,12 +3089,7 @@ export default {
|
|
|
2645
3089
|
type: 'object',
|
|
2646
3090
|
},
|
|
2647
3091
|
},
|
|
2648
|
-
required: [
|
|
2649
|
-
'created_at',
|
|
2650
|
-
'modification_code',
|
|
2651
|
-
'modified_from',
|
|
2652
|
-
'modified_to',
|
|
2653
|
-
],
|
|
3092
|
+
required: ['created_at', 'mutation_code', 'from', 'to'],
|
|
2654
3093
|
type: 'object',
|
|
2655
3094
|
},
|
|
2656
3095
|
],
|
|
@@ -13433,6 +13872,8 @@ export default {
|
|
|
13433
13872
|
'x-route-path': '/thermostats/schedules',
|
|
13434
13873
|
},
|
|
13435
13874
|
unmanaged_access_code: {
|
|
13875
|
+
description:
|
|
13876
|
+
'Represents an [unmanaged smart lock access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes).\n\nAn access code is a code used for a keypad or pinpad device. Unlike physical keys, which can easily be lost or duplicated, PIN codes can be customized, tracked, and altered on the fly.\n\nWhen you create an access code on a device in Seam, it is created as a managed access code. Access codes that exist on a device that were not created through Seam are considered unmanaged codes. We strictly limit the operations that can be performed on unmanaged codes.\n\nPrior to using Seam to manage your devices, you may have used another lock management system to manage the access codes on your devices. Where possible, we help you keep any existing access codes on devices and transition those codes to ones managed by your Seam workspace.',
|
|
13436
13877
|
properties: {
|
|
13437
13878
|
access_code_id: {
|
|
13438
13879
|
description: 'Unique identifier for the access code.',
|
|
@@ -13465,22 +13906,36 @@ export default {
|
|
|
13465
13906
|
},
|
|
13466
13907
|
errors: {
|
|
13467
13908
|
description:
|
|
13468
|
-
'
|
|
13909
|
+
'Errors associated with the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).',
|
|
13469
13910
|
items: {
|
|
13470
13911
|
discriminator: { propertyName: 'error_code' },
|
|
13471
13912
|
oneOf: [
|
|
13472
13913
|
{
|
|
13473
|
-
description: 'Failed to set code on
|
|
13914
|
+
description: 'Failed to set code on SmartThings device.',
|
|
13474
13915
|
properties: {
|
|
13475
|
-
created_at: {
|
|
13916
|
+
created_at: {
|
|
13917
|
+
description:
|
|
13918
|
+
'Date and time at which Seam created the error.',
|
|
13919
|
+
format: 'date-time',
|
|
13920
|
+
type: 'string',
|
|
13921
|
+
},
|
|
13476
13922
|
error_code: {
|
|
13477
13923
|
description:
|
|
13478
13924
|
'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
13479
13925
|
enum: ['smartthings_failed_to_set_access_code'],
|
|
13480
13926
|
type: 'string',
|
|
13481
13927
|
},
|
|
13482
|
-
is_access_code_error: {
|
|
13483
|
-
|
|
13928
|
+
is_access_code_error: {
|
|
13929
|
+
description:
|
|
13930
|
+
'Indicates that this is an access code error.',
|
|
13931
|
+
enum: [true],
|
|
13932
|
+
type: 'boolean',
|
|
13933
|
+
},
|
|
13934
|
+
message: {
|
|
13935
|
+
description:
|
|
13936
|
+
'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
13937
|
+
type: 'string',
|
|
13938
|
+
},
|
|
13484
13939
|
},
|
|
13485
13940
|
required: ['message', 'is_access_code_error', 'error_code'],
|
|
13486
13941
|
type: 'object',
|
|
@@ -13488,7 +13943,12 @@ export default {
|
|
|
13488
13943
|
{
|
|
13489
13944
|
description: 'Failed to set code after multiple retries.',
|
|
13490
13945
|
properties: {
|
|
13491
|
-
created_at: {
|
|
13946
|
+
created_at: {
|
|
13947
|
+
description:
|
|
13948
|
+
'Date and time at which Seam created the error.',
|
|
13949
|
+
format: 'date-time',
|
|
13950
|
+
type: 'string',
|
|
13951
|
+
},
|
|
13492
13952
|
error_code: {
|
|
13493
13953
|
description:
|
|
13494
13954
|
'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
@@ -13497,8 +13957,17 @@ export default {
|
|
|
13497
13957
|
],
|
|
13498
13958
|
type: 'string',
|
|
13499
13959
|
},
|
|
13500
|
-
is_access_code_error: {
|
|
13501
|
-
|
|
13960
|
+
is_access_code_error: {
|
|
13961
|
+
description:
|
|
13962
|
+
'Indicates that this is an access code error.',
|
|
13963
|
+
enum: [true],
|
|
13964
|
+
type: 'boolean',
|
|
13965
|
+
},
|
|
13966
|
+
message: {
|
|
13967
|
+
description:
|
|
13968
|
+
'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
13969
|
+
type: 'string',
|
|
13970
|
+
},
|
|
13502
13971
|
},
|
|
13503
13972
|
required: ['message', 'is_access_code_error', 'error_code'],
|
|
13504
13973
|
type: 'object',
|
|
@@ -13506,15 +13975,29 @@ export default {
|
|
|
13506
13975
|
{
|
|
13507
13976
|
description: 'No free slots available on the device.',
|
|
13508
13977
|
properties: {
|
|
13509
|
-
created_at: {
|
|
13978
|
+
created_at: {
|
|
13979
|
+
description:
|
|
13980
|
+
'Date and time at which Seam created the error.',
|
|
13981
|
+
format: 'date-time',
|
|
13982
|
+
type: 'string',
|
|
13983
|
+
},
|
|
13510
13984
|
error_code: {
|
|
13511
13985
|
description:
|
|
13512
13986
|
'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
13513
13987
|
enum: ['smartthings_no_free_slots_available'],
|
|
13514
13988
|
type: 'string',
|
|
13515
13989
|
},
|
|
13516
|
-
is_access_code_error: {
|
|
13517
|
-
|
|
13990
|
+
is_access_code_error: {
|
|
13991
|
+
description:
|
|
13992
|
+
'Indicates that this is an access code error.',
|
|
13993
|
+
enum: [true],
|
|
13994
|
+
type: 'boolean',
|
|
13995
|
+
},
|
|
13996
|
+
message: {
|
|
13997
|
+
description:
|
|
13998
|
+
'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
13999
|
+
type: 'string',
|
|
14000
|
+
},
|
|
13518
14001
|
},
|
|
13519
14002
|
required: ['message', 'is_access_code_error', 'error_code'],
|
|
13520
14003
|
type: 'object',
|
|
@@ -13522,15 +14005,29 @@ export default {
|
|
|
13522
14005
|
{
|
|
13523
14006
|
description: 'Failed to set code on device.',
|
|
13524
14007
|
properties: {
|
|
13525
|
-
created_at: {
|
|
14008
|
+
created_at: {
|
|
14009
|
+
description:
|
|
14010
|
+
'Date and time at which Seam created the error.',
|
|
14011
|
+
format: 'date-time',
|
|
14012
|
+
type: 'string',
|
|
14013
|
+
},
|
|
13526
14014
|
error_code: {
|
|
13527
14015
|
description:
|
|
13528
14016
|
'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
13529
14017
|
enum: ['failed_to_set_on_device'],
|
|
13530
14018
|
type: 'string',
|
|
13531
14019
|
},
|
|
13532
|
-
is_access_code_error: {
|
|
13533
|
-
|
|
14020
|
+
is_access_code_error: {
|
|
14021
|
+
description:
|
|
14022
|
+
'Indicates that this is an access code error.',
|
|
14023
|
+
enum: [true],
|
|
14024
|
+
type: 'boolean',
|
|
14025
|
+
},
|
|
14026
|
+
message: {
|
|
14027
|
+
description:
|
|
14028
|
+
'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
14029
|
+
type: 'string',
|
|
14030
|
+
},
|
|
13534
14031
|
},
|
|
13535
14032
|
required: ['message', 'is_access_code_error', 'error_code'],
|
|
13536
14033
|
type: 'object',
|
|
@@ -13538,15 +14035,29 @@ export default {
|
|
|
13538
14035
|
{
|
|
13539
14036
|
description: 'Failed to remove code from device.',
|
|
13540
14037
|
properties: {
|
|
13541
|
-
created_at: {
|
|
14038
|
+
created_at: {
|
|
14039
|
+
description:
|
|
14040
|
+
'Date and time at which Seam created the error.',
|
|
14041
|
+
format: 'date-time',
|
|
14042
|
+
type: 'string',
|
|
14043
|
+
},
|
|
13542
14044
|
error_code: {
|
|
13543
14045
|
description:
|
|
13544
14046
|
'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
13545
14047
|
enum: ['failed_to_remove_from_device'],
|
|
13546
14048
|
type: 'string',
|
|
13547
14049
|
},
|
|
13548
|
-
is_access_code_error: {
|
|
13549
|
-
|
|
14050
|
+
is_access_code_error: {
|
|
14051
|
+
description:
|
|
14052
|
+
'Indicates that this is an access code error.',
|
|
14053
|
+
enum: [true],
|
|
14054
|
+
type: 'boolean',
|
|
14055
|
+
},
|
|
14056
|
+
message: {
|
|
14057
|
+
description:
|
|
14058
|
+
'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
14059
|
+
type: 'string',
|
|
14060
|
+
},
|
|
13550
14061
|
},
|
|
13551
14062
|
required: ['message', 'is_access_code_error', 'error_code'],
|
|
13552
14063
|
type: 'object',
|
|
@@ -13554,15 +14065,29 @@ export default {
|
|
|
13554
14065
|
{
|
|
13555
14066
|
description: 'Duplicate access code detected on device.',
|
|
13556
14067
|
properties: {
|
|
13557
|
-
created_at: {
|
|
14068
|
+
created_at: {
|
|
14069
|
+
description:
|
|
14070
|
+
'Date and time at which Seam created the error.',
|
|
14071
|
+
format: 'date-time',
|
|
14072
|
+
type: 'string',
|
|
14073
|
+
},
|
|
13558
14074
|
error_code: {
|
|
13559
14075
|
description:
|
|
13560
14076
|
'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
13561
14077
|
enum: ['duplicate_code_on_device'],
|
|
13562
14078
|
type: 'string',
|
|
13563
14079
|
},
|
|
13564
|
-
is_access_code_error: {
|
|
13565
|
-
|
|
14080
|
+
is_access_code_error: {
|
|
14081
|
+
description:
|
|
14082
|
+
'Indicates that this is an access code error.',
|
|
14083
|
+
enum: [true],
|
|
14084
|
+
type: 'boolean',
|
|
14085
|
+
},
|
|
14086
|
+
message: {
|
|
14087
|
+
description:
|
|
14088
|
+
'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
14089
|
+
type: 'string',
|
|
14090
|
+
},
|
|
13566
14091
|
},
|
|
13567
14092
|
required: ['message', 'is_access_code_error', 'error_code'],
|
|
13568
14093
|
type: 'object',
|
|
@@ -13571,15 +14096,29 @@ export default {
|
|
|
13571
14096
|
description:
|
|
13572
14097
|
'An attempt to modify this access code was prevented.',
|
|
13573
14098
|
properties: {
|
|
13574
|
-
created_at: {
|
|
14099
|
+
created_at: {
|
|
14100
|
+
description:
|
|
14101
|
+
'Date and time at which Seam created the error.',
|
|
14102
|
+
format: 'date-time',
|
|
14103
|
+
type: 'string',
|
|
14104
|
+
},
|
|
13575
14105
|
error_code: {
|
|
13576
14106
|
description:
|
|
13577
14107
|
'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
13578
14108
|
enum: ['duplicate_code_attempt_prevented'],
|
|
13579
14109
|
type: 'string',
|
|
13580
14110
|
},
|
|
13581
|
-
is_access_code_error: {
|
|
13582
|
-
|
|
14111
|
+
is_access_code_error: {
|
|
14112
|
+
description:
|
|
14113
|
+
'Indicates that this is an access code error.',
|
|
14114
|
+
enum: [true],
|
|
14115
|
+
type: 'boolean',
|
|
14116
|
+
},
|
|
14117
|
+
message: {
|
|
14118
|
+
description:
|
|
14119
|
+
'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
14120
|
+
type: 'string',
|
|
14121
|
+
},
|
|
13583
14122
|
},
|
|
13584
14123
|
required: ['message', 'is_access_code_error', 'error_code'],
|
|
13585
14124
|
type: 'object',
|
|
@@ -13588,15 +14127,29 @@ export default {
|
|
|
13588
14127
|
description:
|
|
13589
14128
|
'Igloohome bridge has too many pending jobs in the queue.',
|
|
13590
14129
|
properties: {
|
|
13591
|
-
created_at: {
|
|
14130
|
+
created_at: {
|
|
14131
|
+
description:
|
|
14132
|
+
'Date and time at which Seam created the error.',
|
|
14133
|
+
format: 'date-time',
|
|
14134
|
+
type: 'string',
|
|
14135
|
+
},
|
|
13592
14136
|
error_code: {
|
|
13593
14137
|
description:
|
|
13594
14138
|
'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
13595
14139
|
enum: ['igloohome_bridge_too_many_pending_jobs'],
|
|
13596
14140
|
type: 'string',
|
|
13597
14141
|
},
|
|
13598
|
-
is_access_code_error: {
|
|
13599
|
-
|
|
14142
|
+
is_access_code_error: {
|
|
14143
|
+
description:
|
|
14144
|
+
'Indicates that this is an access code error.',
|
|
14145
|
+
enum: [true],
|
|
14146
|
+
type: 'boolean',
|
|
14147
|
+
},
|
|
14148
|
+
message: {
|
|
14149
|
+
description:
|
|
14150
|
+
'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
14151
|
+
type: 'string',
|
|
14152
|
+
},
|
|
13600
14153
|
},
|
|
13601
14154
|
required: ['message', 'is_access_code_error', 'error_code'],
|
|
13602
14155
|
type: 'object',
|
|
@@ -13604,23 +14157,42 @@ export default {
|
|
|
13604
14157
|
{
|
|
13605
14158
|
description: 'Igloohome bridge is offline.',
|
|
13606
14159
|
properties: {
|
|
13607
|
-
created_at: {
|
|
14160
|
+
created_at: {
|
|
14161
|
+
description:
|
|
14162
|
+
'Date and time at which Seam created the error.',
|
|
14163
|
+
format: 'date-time',
|
|
14164
|
+
type: 'string',
|
|
14165
|
+
},
|
|
13608
14166
|
error_code: {
|
|
13609
14167
|
description:
|
|
13610
14168
|
'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
13611
14169
|
enum: ['igloohome_bridge_offline'],
|
|
13612
14170
|
type: 'string',
|
|
13613
14171
|
},
|
|
13614
|
-
is_access_code_error: {
|
|
13615
|
-
|
|
14172
|
+
is_access_code_error: {
|
|
14173
|
+
description:
|
|
14174
|
+
'Indicates that this is an access code error.',
|
|
14175
|
+
enum: [true],
|
|
14176
|
+
type: 'boolean',
|
|
14177
|
+
},
|
|
14178
|
+
message: {
|
|
14179
|
+
description:
|
|
14180
|
+
'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
14181
|
+
type: 'string',
|
|
14182
|
+
},
|
|
13616
14183
|
},
|
|
13617
14184
|
required: ['message', 'is_access_code_error', 'error_code'],
|
|
13618
14185
|
type: 'object',
|
|
13619
14186
|
},
|
|
13620
14187
|
{
|
|
13621
|
-
description: 'Lock
|
|
14188
|
+
description: 'Lock has reached maximum amount of codes.',
|
|
13622
14189
|
properties: {
|
|
13623
|
-
created_at: {
|
|
14190
|
+
created_at: {
|
|
14191
|
+
description:
|
|
14192
|
+
'Date and time at which Seam created the error.',
|
|
14193
|
+
format: 'date-time',
|
|
14194
|
+
type: 'string',
|
|
14195
|
+
},
|
|
13624
14196
|
error_code: {
|
|
13625
14197
|
description:
|
|
13626
14198
|
'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
@@ -13629,25 +14201,48 @@ export default {
|
|
|
13629
14201
|
],
|
|
13630
14202
|
type: 'string',
|
|
13631
14203
|
},
|
|
13632
|
-
is_access_code_error: {
|
|
13633
|
-
|
|
14204
|
+
is_access_code_error: {
|
|
14205
|
+
description:
|
|
14206
|
+
'Indicates that this is an access code error.',
|
|
14207
|
+
enum: [true],
|
|
14208
|
+
type: 'boolean',
|
|
14209
|
+
},
|
|
14210
|
+
message: {
|
|
14211
|
+
description:
|
|
14212
|
+
'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
14213
|
+
type: 'string',
|
|
14214
|
+
},
|
|
13634
14215
|
},
|
|
13635
14216
|
required: ['message', 'is_access_code_error', 'error_code'],
|
|
13636
14217
|
type: 'object',
|
|
13637
14218
|
},
|
|
13638
14219
|
{
|
|
13639
14220
|
description:
|
|
13640
|
-
'Unable to confirm the access code is set on Kwikset device.',
|
|
14221
|
+
'Unable to confirm that the access code is set on Kwikset device.',
|
|
13641
14222
|
properties: {
|
|
13642
|
-
created_at: {
|
|
14223
|
+
created_at: {
|
|
14224
|
+
description:
|
|
14225
|
+
'Date and time at which Seam created the error.',
|
|
14226
|
+
format: 'date-time',
|
|
14227
|
+
type: 'string',
|
|
14228
|
+
},
|
|
13643
14229
|
error_code: {
|
|
13644
14230
|
description:
|
|
13645
14231
|
'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
13646
14232
|
enum: ['kwikset_unable_to_confirm_code'],
|
|
13647
14233
|
type: 'string',
|
|
13648
14234
|
},
|
|
13649
|
-
is_access_code_error: {
|
|
13650
|
-
|
|
14235
|
+
is_access_code_error: {
|
|
14236
|
+
description:
|
|
14237
|
+
'Indicates that this is an access code error.',
|
|
14238
|
+
enum: [true],
|
|
14239
|
+
type: 'boolean',
|
|
14240
|
+
},
|
|
14241
|
+
message: {
|
|
14242
|
+
description:
|
|
14243
|
+
'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
14244
|
+
type: 'string',
|
|
14245
|
+
},
|
|
13651
14246
|
},
|
|
13652
14247
|
required: ['message', 'is_access_code_error', 'error_code'],
|
|
13653
14248
|
type: 'object',
|
|
@@ -13656,15 +14251,29 @@ export default {
|
|
|
13656
14251
|
description:
|
|
13657
14252
|
'Unable to confirm the deletion of the access code on Kwikset device.',
|
|
13658
14253
|
properties: {
|
|
13659
|
-
created_at: {
|
|
14254
|
+
created_at: {
|
|
14255
|
+
description:
|
|
14256
|
+
'Date and time at which Seam created the error.',
|
|
14257
|
+
format: 'date-time',
|
|
14258
|
+
type: 'string',
|
|
14259
|
+
},
|
|
13660
14260
|
error_code: {
|
|
13661
14261
|
description:
|
|
13662
14262
|
'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
13663
14263
|
enum: ['kwikset_unable_to_confirm_deletion'],
|
|
13664
14264
|
type: 'string',
|
|
13665
14265
|
},
|
|
13666
|
-
is_access_code_error: {
|
|
13667
|
-
|
|
14266
|
+
is_access_code_error: {
|
|
14267
|
+
description:
|
|
14268
|
+
'Indicates that this is an access code error.',
|
|
14269
|
+
enum: [true],
|
|
14270
|
+
type: 'boolean',
|
|
14271
|
+
},
|
|
14272
|
+
message: {
|
|
14273
|
+
description:
|
|
14274
|
+
'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
14275
|
+
type: 'string',
|
|
14276
|
+
},
|
|
13668
14277
|
},
|
|
13669
14278
|
required: ['message', 'is_access_code_error', 'error_code'],
|
|
13670
14279
|
type: 'object',
|
|
@@ -13673,15 +14282,29 @@ export default {
|
|
|
13673
14282
|
description:
|
|
13674
14283
|
'Code was modified or removed externally after Seam successfully set it on the device.',
|
|
13675
14284
|
properties: {
|
|
13676
|
-
created_at: {
|
|
14285
|
+
created_at: {
|
|
14286
|
+
description:
|
|
14287
|
+
'Date and time at which Seam created the error.',
|
|
14288
|
+
format: 'date-time',
|
|
14289
|
+
type: 'string',
|
|
14290
|
+
},
|
|
13677
14291
|
error_code: {
|
|
13678
14292
|
description:
|
|
13679
14293
|
'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
13680
14294
|
enum: ['code_modified_external_to_seam'],
|
|
13681
14295
|
type: 'string',
|
|
13682
14296
|
},
|
|
13683
|
-
is_access_code_error: {
|
|
13684
|
-
|
|
14297
|
+
is_access_code_error: {
|
|
14298
|
+
description:
|
|
14299
|
+
'Indicates that this is an access code error.',
|
|
14300
|
+
enum: [true],
|
|
14301
|
+
type: 'boolean',
|
|
14302
|
+
},
|
|
14303
|
+
message: {
|
|
14304
|
+
description:
|
|
14305
|
+
'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
14306
|
+
type: 'string',
|
|
14307
|
+
},
|
|
13685
14308
|
},
|
|
13686
14309
|
required: ['message', 'is_access_code_error', 'error_code'],
|
|
13687
14310
|
type: 'object',
|
|
@@ -13689,15 +14312,29 @@ export default {
|
|
|
13689
14312
|
{
|
|
13690
14313
|
description: 'Invalid code length for August lock.',
|
|
13691
14314
|
properties: {
|
|
13692
|
-
created_at: {
|
|
14315
|
+
created_at: {
|
|
14316
|
+
description:
|
|
14317
|
+
'Date and time at which Seam created the error.',
|
|
14318
|
+
format: 'date-time',
|
|
14319
|
+
type: 'string',
|
|
14320
|
+
},
|
|
13693
14321
|
error_code: {
|
|
13694
14322
|
description:
|
|
13695
14323
|
'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
13696
14324
|
enum: ['august_lock_invalid_code_length'],
|
|
13697
14325
|
type: 'string',
|
|
13698
14326
|
},
|
|
13699
|
-
is_access_code_error: {
|
|
13700
|
-
|
|
14327
|
+
is_access_code_error: {
|
|
14328
|
+
description:
|
|
14329
|
+
'Indicates that this is an access code error.',
|
|
14330
|
+
enum: [true],
|
|
14331
|
+
type: 'boolean',
|
|
14332
|
+
},
|
|
14333
|
+
message: {
|
|
14334
|
+
description:
|
|
14335
|
+
'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
14336
|
+
type: 'string',
|
|
14337
|
+
},
|
|
13701
14338
|
},
|
|
13702
14339
|
required: ['message', 'is_access_code_error', 'error_code'],
|
|
13703
14340
|
type: 'object',
|
|
@@ -13706,15 +14343,29 @@ export default {
|
|
|
13706
14343
|
description:
|
|
13707
14344
|
'Access code has not yet been fully moved to the device.',
|
|
13708
14345
|
properties: {
|
|
13709
|
-
created_at: {
|
|
14346
|
+
created_at: {
|
|
14347
|
+
description:
|
|
14348
|
+
'Date and time at which Seam created the error.',
|
|
14349
|
+
format: 'date-time',
|
|
14350
|
+
type: 'string',
|
|
14351
|
+
},
|
|
13710
14352
|
error_code: {
|
|
13711
14353
|
description:
|
|
13712
14354
|
'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
13713
14355
|
enum: ['august_device_programming_delay'],
|
|
13714
14356
|
type: 'string',
|
|
13715
14357
|
},
|
|
13716
|
-
is_access_code_error: {
|
|
13717
|
-
|
|
14358
|
+
is_access_code_error: {
|
|
14359
|
+
description:
|
|
14360
|
+
'Indicates that this is an access code error.',
|
|
14361
|
+
enum: [true],
|
|
14362
|
+
type: 'boolean',
|
|
14363
|
+
},
|
|
14364
|
+
message: {
|
|
14365
|
+
description:
|
|
14366
|
+
'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
14367
|
+
type: 'string',
|
|
14368
|
+
},
|
|
13718
14369
|
},
|
|
13719
14370
|
required: ['message', 'is_access_code_error', 'error_code'],
|
|
13720
14371
|
type: 'object',
|
|
@@ -13722,15 +14373,29 @@ export default {
|
|
|
13722
14373
|
{
|
|
13723
14374
|
description: 'All access code slots on the device are full.',
|
|
13724
14375
|
properties: {
|
|
13725
|
-
created_at: {
|
|
14376
|
+
created_at: {
|
|
14377
|
+
description:
|
|
14378
|
+
'Date and time at which Seam created the error.',
|
|
14379
|
+
format: 'date-time',
|
|
14380
|
+
type: 'string',
|
|
14381
|
+
},
|
|
13726
14382
|
error_code: {
|
|
13727
14383
|
description:
|
|
13728
14384
|
'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
13729
14385
|
enum: ['august_device_slots_full'],
|
|
13730
14386
|
type: 'string',
|
|
13731
14387
|
},
|
|
13732
|
-
is_access_code_error: {
|
|
13733
|
-
|
|
14388
|
+
is_access_code_error: {
|
|
14389
|
+
description:
|
|
14390
|
+
'Indicates that this is an access code error.',
|
|
14391
|
+
enum: [true],
|
|
14392
|
+
type: 'boolean',
|
|
14393
|
+
},
|
|
14394
|
+
message: {
|
|
14395
|
+
description:
|
|
14396
|
+
'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
14397
|
+
type: 'string',
|
|
14398
|
+
},
|
|
13734
14399
|
},
|
|
13735
14400
|
required: ['message', 'is_access_code_error', 'error_code'],
|
|
13736
14401
|
type: 'object',
|
|
@@ -13738,15 +14403,29 @@ export default {
|
|
|
13738
14403
|
{
|
|
13739
14404
|
description: 'August lock is missing a keypad.',
|
|
13740
14405
|
properties: {
|
|
13741
|
-
created_at: {
|
|
14406
|
+
created_at: {
|
|
14407
|
+
description:
|
|
14408
|
+
'Date and time at which Seam created the error.',
|
|
14409
|
+
format: 'date-time',
|
|
14410
|
+
type: 'string',
|
|
14411
|
+
},
|
|
13742
14412
|
error_code: {
|
|
13743
14413
|
description:
|
|
13744
14414
|
'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
13745
14415
|
enum: ['august_lock_missing_keypad'],
|
|
13746
14416
|
type: 'string',
|
|
13747
14417
|
},
|
|
13748
|
-
is_access_code_error: {
|
|
13749
|
-
|
|
14418
|
+
is_access_code_error: {
|
|
14419
|
+
description:
|
|
14420
|
+
'Indicates that this is an access code error.',
|
|
14421
|
+
enum: [true],
|
|
14422
|
+
type: 'boolean',
|
|
14423
|
+
},
|
|
14424
|
+
message: {
|
|
14425
|
+
description:
|
|
14426
|
+
'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
14427
|
+
type: 'string',
|
|
14428
|
+
},
|
|
13750
14429
|
},
|
|
13751
14430
|
required: ['message', 'is_access_code_error', 'error_code'],
|
|
13752
14431
|
type: 'object',
|
|
@@ -13754,15 +14433,29 @@ export default {
|
|
|
13754
14433
|
{
|
|
13755
14434
|
description: 'August lock is temporarily offline.',
|
|
13756
14435
|
properties: {
|
|
13757
|
-
created_at: {
|
|
14436
|
+
created_at: {
|
|
14437
|
+
description:
|
|
14438
|
+
'Date and time at which Seam created the error.',
|
|
14439
|
+
format: 'date-time',
|
|
14440
|
+
type: 'string',
|
|
14441
|
+
},
|
|
13758
14442
|
error_code: {
|
|
13759
14443
|
description:
|
|
13760
14444
|
'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
13761
14445
|
enum: ['august_lock_temporarily_offline'],
|
|
13762
14446
|
type: 'string',
|
|
13763
14447
|
},
|
|
13764
|
-
is_access_code_error: {
|
|
13765
|
-
|
|
14448
|
+
is_access_code_error: {
|
|
14449
|
+
description:
|
|
14450
|
+
'Indicates that this is an access code error.',
|
|
14451
|
+
enum: [true],
|
|
14452
|
+
type: 'boolean',
|
|
14453
|
+
},
|
|
14454
|
+
message: {
|
|
14455
|
+
description:
|
|
14456
|
+
'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
14457
|
+
type: 'string',
|
|
14458
|
+
},
|
|
13766
14459
|
},
|
|
13767
14460
|
required: ['message', 'is_access_code_error', 'error_code'],
|
|
13768
14461
|
type: 'object',
|
|
@@ -13770,15 +14463,29 @@ export default {
|
|
|
13770
14463
|
{
|
|
13771
14464
|
description: 'Salto site user is not subscribed.',
|
|
13772
14465
|
properties: {
|
|
13773
|
-
created_at: {
|
|
14466
|
+
created_at: {
|
|
14467
|
+
description:
|
|
14468
|
+
'Date and time at which Seam created the error.',
|
|
14469
|
+
format: 'date-time',
|
|
14470
|
+
type: 'string',
|
|
14471
|
+
},
|
|
13774
14472
|
error_code: {
|
|
13775
14473
|
description:
|
|
13776
14474
|
'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
13777
14475
|
enum: ['salto_ks_user_not_subscribed'],
|
|
13778
14476
|
type: 'string',
|
|
13779
14477
|
},
|
|
13780
|
-
is_access_code_error: {
|
|
13781
|
-
|
|
14478
|
+
is_access_code_error: {
|
|
14479
|
+
description:
|
|
14480
|
+
'Indicates that this is an access code error.',
|
|
14481
|
+
enum: [true],
|
|
14482
|
+
type: 'boolean',
|
|
14483
|
+
},
|
|
14484
|
+
message: {
|
|
14485
|
+
description:
|
|
14486
|
+
'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
14487
|
+
type: 'string',
|
|
14488
|
+
},
|
|
13782
14489
|
},
|
|
13783
14490
|
required: ['message', 'is_access_code_error', 'error_code'],
|
|
13784
14491
|
type: 'object',
|
|
@@ -13787,15 +14494,29 @@ export default {
|
|
|
13787
14494
|
description:
|
|
13788
14495
|
'Access code has not yet been fully moved to the device.',
|
|
13789
14496
|
properties: {
|
|
13790
|
-
created_at: {
|
|
14497
|
+
created_at: {
|
|
14498
|
+
description:
|
|
14499
|
+
'Date and time at which Seam created the error.',
|
|
14500
|
+
format: 'date-time',
|
|
14501
|
+
type: 'string',
|
|
14502
|
+
},
|
|
13791
14503
|
error_code: {
|
|
13792
14504
|
description:
|
|
13793
14505
|
'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
13794
14506
|
enum: ['hubitat_device_programming_delay'],
|
|
13795
14507
|
type: 'string',
|
|
13796
14508
|
},
|
|
13797
|
-
is_access_code_error: {
|
|
13798
|
-
|
|
14509
|
+
is_access_code_error: {
|
|
14510
|
+
description:
|
|
14511
|
+
'Indicates that this is an access code error.',
|
|
14512
|
+
enum: [true],
|
|
14513
|
+
type: 'boolean',
|
|
14514
|
+
},
|
|
14515
|
+
message: {
|
|
14516
|
+
description:
|
|
14517
|
+
'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
14518
|
+
type: 'string',
|
|
14519
|
+
},
|
|
13799
14520
|
},
|
|
13800
14521
|
required: ['message', 'is_access_code_error', 'error_code'],
|
|
13801
14522
|
type: 'object',
|
|
@@ -13803,15 +14524,29 @@ export default {
|
|
|
13803
14524
|
{
|
|
13804
14525
|
description: 'No free positions available on the device.',
|
|
13805
14526
|
properties: {
|
|
13806
|
-
created_at: {
|
|
14527
|
+
created_at: {
|
|
14528
|
+
description:
|
|
14529
|
+
'Date and time at which Seam created the error.',
|
|
14530
|
+
format: 'date-time',
|
|
14531
|
+
type: 'string',
|
|
14532
|
+
},
|
|
13807
14533
|
error_code: {
|
|
13808
14534
|
description:
|
|
13809
14535
|
'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
13810
14536
|
enum: ['hubitat_no_free_positions_available'],
|
|
13811
14537
|
type: 'string',
|
|
13812
14538
|
},
|
|
13813
|
-
is_access_code_error: {
|
|
13814
|
-
|
|
14539
|
+
is_access_code_error: {
|
|
14540
|
+
description:
|
|
14541
|
+
'Indicates that this is an access code error.',
|
|
14542
|
+
enum: [true],
|
|
14543
|
+
type: 'boolean',
|
|
14544
|
+
},
|
|
14545
|
+
message: {
|
|
14546
|
+
description:
|
|
14547
|
+
'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
14548
|
+
type: 'string',
|
|
14549
|
+
},
|
|
13815
14550
|
},
|
|
13816
14551
|
required: ['message', 'is_access_code_error', 'error_code'],
|
|
13817
14552
|
type: 'object',
|
|
@@ -13819,15 +14554,29 @@ export default {
|
|
|
13819
14554
|
{
|
|
13820
14555
|
description: 'Duplicate access code name detected.',
|
|
13821
14556
|
properties: {
|
|
13822
|
-
created_at: {
|
|
14557
|
+
created_at: {
|
|
14558
|
+
description:
|
|
14559
|
+
'Date and time at which Seam created the error.',
|
|
14560
|
+
format: 'date-time',
|
|
14561
|
+
type: 'string',
|
|
14562
|
+
},
|
|
13823
14563
|
error_code: {
|
|
13824
14564
|
description:
|
|
13825
14565
|
'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
13826
14566
|
enum: ['wyze_duplicate_code_name'],
|
|
13827
14567
|
type: 'string',
|
|
13828
14568
|
},
|
|
13829
|
-
is_access_code_error: {
|
|
13830
|
-
|
|
14569
|
+
is_access_code_error: {
|
|
14570
|
+
description:
|
|
14571
|
+
'Indicates that this is an access code error.',
|
|
14572
|
+
enum: [true],
|
|
14573
|
+
type: 'boolean',
|
|
14574
|
+
},
|
|
14575
|
+
message: {
|
|
14576
|
+
description:
|
|
14577
|
+
'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
14578
|
+
type: 'string',
|
|
14579
|
+
},
|
|
13831
14580
|
},
|
|
13832
14581
|
required: ['message', 'is_access_code_error', 'error_code'],
|
|
13833
14582
|
type: 'object',
|
|
@@ -13835,15 +14584,29 @@ export default {
|
|
|
13835
14584
|
{
|
|
13836
14585
|
description: 'Potential duplicate access code detected.',
|
|
13837
14586
|
properties: {
|
|
13838
|
-
created_at: {
|
|
14587
|
+
created_at: {
|
|
14588
|
+
description:
|
|
14589
|
+
'Date and time at which Seam created the error.',
|
|
14590
|
+
format: 'date-time',
|
|
14591
|
+
type: 'string',
|
|
14592
|
+
},
|
|
13839
14593
|
error_code: {
|
|
13840
14594
|
description:
|
|
13841
14595
|
'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
13842
14596
|
enum: ['wyze_potential_duplicate_code'],
|
|
13843
14597
|
type: 'string',
|
|
13844
14598
|
},
|
|
13845
|
-
is_access_code_error: {
|
|
13846
|
-
|
|
14599
|
+
is_access_code_error: {
|
|
14600
|
+
description:
|
|
14601
|
+
'Indicates that this is an access code error.',
|
|
14602
|
+
enum: [true],
|
|
14603
|
+
type: 'boolean',
|
|
14604
|
+
},
|
|
14605
|
+
message: {
|
|
14606
|
+
description:
|
|
14607
|
+
'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
14608
|
+
type: 'string',
|
|
14609
|
+
},
|
|
13847
14610
|
},
|
|
13848
14611
|
required: ['message', 'is_access_code_error', 'error_code'],
|
|
13849
14612
|
type: 'object',
|
|
@@ -13851,15 +14614,29 @@ export default {
|
|
|
13851
14614
|
{
|
|
13852
14615
|
description: 'No valid user level for Oracode.',
|
|
13853
14616
|
properties: {
|
|
13854
|
-
created_at: {
|
|
14617
|
+
created_at: {
|
|
14618
|
+
description:
|
|
14619
|
+
'Date and time at which Seam created the error.',
|
|
14620
|
+
format: 'date-time',
|
|
14621
|
+
type: 'string',
|
|
14622
|
+
},
|
|
13855
14623
|
error_code: {
|
|
13856
14624
|
description:
|
|
13857
14625
|
'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
13858
14626
|
enum: ['dormakaba_oracode_no_valid_user_level'],
|
|
13859
14627
|
type: 'string',
|
|
13860
14628
|
},
|
|
13861
|
-
is_access_code_error: {
|
|
13862
|
-
|
|
14629
|
+
is_access_code_error: {
|
|
14630
|
+
description:
|
|
14631
|
+
'Indicates that this is an access code error.',
|
|
14632
|
+
enum: [true],
|
|
14633
|
+
type: 'boolean',
|
|
14634
|
+
},
|
|
14635
|
+
message: {
|
|
14636
|
+
description:
|
|
14637
|
+
'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
14638
|
+
type: 'string',
|
|
14639
|
+
},
|
|
13863
14640
|
},
|
|
13864
14641
|
required: ['message', 'is_access_code_error', 'error_code'],
|
|
13865
14642
|
type: 'object',
|
|
@@ -14196,7 +14973,11 @@ export default {
|
|
|
14196
14973
|
},
|
|
14197
14974
|
type: 'array',
|
|
14198
14975
|
},
|
|
14199
|
-
is_managed: {
|
|
14976
|
+
is_managed: {
|
|
14977
|
+
description: 'Indicates that Seam does not manage the access code.',
|
|
14978
|
+
enum: [false],
|
|
14979
|
+
type: 'boolean',
|
|
14980
|
+
},
|
|
14200
14981
|
name: {
|
|
14201
14982
|
description:
|
|
14202
14983
|
'Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.',
|
|
@@ -14210,24 +14991,40 @@ export default {
|
|
|
14210
14991
|
nullable: true,
|
|
14211
14992
|
type: 'string',
|
|
14212
14993
|
},
|
|
14213
|
-
status: {
|
|
14994
|
+
status: {
|
|
14995
|
+
description:
|
|
14996
|
+
'Current status of the access code within the operational lifecycle. `set` indicates that the code is active and operational.',
|
|
14997
|
+
enum: ['set'],
|
|
14998
|
+
type: 'string',
|
|
14999
|
+
},
|
|
14214
15000
|
type: {
|
|
14215
15001
|
description:
|
|
14216
|
-
'Nature of the access code. Values are
|
|
15002
|
+
'Nature of the access code. Values are `ongoing` for access codes that are active continuously until deactivated manually or `time_bound` for access codes that have a specific duration.',
|
|
14217
15003
|
enum: ['time_bound', 'ongoing'],
|
|
14218
15004
|
type: 'string',
|
|
14219
15005
|
},
|
|
14220
15006
|
warnings: {
|
|
14221
15007
|
description:
|
|
14222
|
-
'
|
|
15008
|
+
'Warnings associated with the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).',
|
|
14223
15009
|
items: {
|
|
15010
|
+
description:
|
|
15011
|
+
'Warnings associated with the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).',
|
|
14224
15012
|
discriminator: { propertyName: 'warning_code' },
|
|
14225
15013
|
oneOf: [
|
|
14226
15014
|
{
|
|
14227
|
-
description: 'Failed to set code on
|
|
15015
|
+
description: 'Failed to set code on SmartThings device.',
|
|
14228
15016
|
properties: {
|
|
14229
|
-
created_at: {
|
|
14230
|
-
|
|
15017
|
+
created_at: {
|
|
15018
|
+
description:
|
|
15019
|
+
'Date and time at which Seam created the warning.',
|
|
15020
|
+
format: 'date-time',
|
|
15021
|
+
type: 'string',
|
|
15022
|
+
},
|
|
15023
|
+
message: {
|
|
15024
|
+
description:
|
|
15025
|
+
'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
15026
|
+
type: 'string',
|
|
15027
|
+
},
|
|
14231
15028
|
warning_code: {
|
|
14232
15029
|
description:
|
|
14233
15030
|
'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
@@ -14241,8 +15038,17 @@ export default {
|
|
|
14241
15038
|
{
|
|
14242
15039
|
description: 'Duplicate access code detected.',
|
|
14243
15040
|
properties: {
|
|
14244
|
-
created_at: {
|
|
14245
|
-
|
|
15041
|
+
created_at: {
|
|
15042
|
+
description:
|
|
15043
|
+
'Date and time at which Seam created the warning.',
|
|
15044
|
+
format: 'date-time',
|
|
15045
|
+
type: 'string',
|
|
15046
|
+
},
|
|
15047
|
+
message: {
|
|
15048
|
+
description:
|
|
15049
|
+
'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
15050
|
+
type: 'string',
|
|
15051
|
+
},
|
|
14246
15052
|
warning_code: {
|
|
14247
15053
|
description:
|
|
14248
15054
|
'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
@@ -14257,8 +15063,17 @@ export default {
|
|
|
14257
15063
|
description:
|
|
14258
15064
|
'Received an error when attempting to create this code.',
|
|
14259
15065
|
properties: {
|
|
14260
|
-
created_at: {
|
|
14261
|
-
|
|
15066
|
+
created_at: {
|
|
15067
|
+
description:
|
|
15068
|
+
'Date and time at which Seam created the warning.',
|
|
15069
|
+
format: 'date-time',
|
|
15070
|
+
type: 'string',
|
|
15071
|
+
},
|
|
15072
|
+
message: {
|
|
15073
|
+
description:
|
|
15074
|
+
'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
15075
|
+
type: 'string',
|
|
15076
|
+
},
|
|
14262
15077
|
warning_code: {
|
|
14263
15078
|
description:
|
|
14264
15079
|
'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
@@ -14273,8 +15088,17 @@ export default {
|
|
|
14273
15088
|
description:
|
|
14274
15089
|
'Code was modified or removed externally after Seam successfully set it on the device.',
|
|
14275
15090
|
properties: {
|
|
14276
|
-
created_at: {
|
|
14277
|
-
|
|
15091
|
+
created_at: {
|
|
15092
|
+
description:
|
|
15093
|
+
'Date and time at which Seam created the warning.',
|
|
15094
|
+
format: 'date-time',
|
|
15095
|
+
type: 'string',
|
|
15096
|
+
},
|
|
15097
|
+
message: {
|
|
15098
|
+
description:
|
|
15099
|
+
'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
15100
|
+
type: 'string',
|
|
15101
|
+
},
|
|
14278
15102
|
warning_code: {
|
|
14279
15103
|
description:
|
|
14280
15104
|
'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
@@ -14288,8 +15112,17 @@ export default {
|
|
|
14288
15112
|
{
|
|
14289
15113
|
description: 'Delay in setting code on device.',
|
|
14290
15114
|
properties: {
|
|
14291
|
-
created_at: {
|
|
14292
|
-
|
|
15115
|
+
created_at: {
|
|
15116
|
+
description:
|
|
15117
|
+
'Date and time at which Seam created the warning.',
|
|
15118
|
+
format: 'date-time',
|
|
15119
|
+
type: 'string',
|
|
15120
|
+
},
|
|
15121
|
+
message: {
|
|
15122
|
+
description:
|
|
15123
|
+
'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
15124
|
+
type: 'string',
|
|
15125
|
+
},
|
|
14293
15126
|
warning_code: {
|
|
14294
15127
|
description:
|
|
14295
15128
|
'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
@@ -14303,8 +15136,17 @@ export default {
|
|
|
14303
15136
|
{
|
|
14304
15137
|
description: 'Delay in removing code from device.',
|
|
14305
15138
|
properties: {
|
|
14306
|
-
created_at: {
|
|
14307
|
-
|
|
15139
|
+
created_at: {
|
|
15140
|
+
description:
|
|
15141
|
+
'Date and time at which Seam created the warning.',
|
|
15142
|
+
format: 'date-time',
|
|
15143
|
+
type: 'string',
|
|
15144
|
+
},
|
|
15145
|
+
message: {
|
|
15146
|
+
description:
|
|
15147
|
+
'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
15148
|
+
type: 'string',
|
|
15149
|
+
},
|
|
14308
15150
|
warning_code: {
|
|
14309
15151
|
description:
|
|
14310
15152
|
'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
@@ -14317,10 +15159,19 @@ export default {
|
|
|
14317
15159
|
},
|
|
14318
15160
|
{
|
|
14319
15161
|
description:
|
|
14320
|
-
'Third
|
|
15162
|
+
'Third-party integration detected that may cause access codes to fail.',
|
|
14321
15163
|
properties: {
|
|
14322
|
-
created_at: {
|
|
14323
|
-
|
|
15164
|
+
created_at: {
|
|
15165
|
+
description:
|
|
15166
|
+
'Date and time at which Seam created the warning.',
|
|
15167
|
+
format: 'date-time',
|
|
15168
|
+
type: 'string',
|
|
15169
|
+
},
|
|
15170
|
+
message: {
|
|
15171
|
+
description:
|
|
15172
|
+
'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
15173
|
+
type: 'string',
|
|
15174
|
+
},
|
|
14324
15175
|
warning_code: {
|
|
14325
15176
|
description:
|
|
14326
15177
|
'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
@@ -14335,8 +15186,17 @@ export default {
|
|
|
14335
15186
|
description:
|
|
14336
15187
|
'Access code has not yet been fully moved to the device.',
|
|
14337
15188
|
properties: {
|
|
14338
|
-
created_at: {
|
|
14339
|
-
|
|
15189
|
+
created_at: {
|
|
15190
|
+
description:
|
|
15191
|
+
'Date and time at which Seam created the warning.',
|
|
15192
|
+
format: 'date-time',
|
|
15193
|
+
type: 'string',
|
|
15194
|
+
},
|
|
15195
|
+
message: {
|
|
15196
|
+
description:
|
|
15197
|
+
'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
15198
|
+
type: 'string',
|
|
15199
|
+
},
|
|
14340
15200
|
warning_code: {
|
|
14341
15201
|
description:
|
|
14342
15202
|
'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
@@ -14350,8 +15210,17 @@ export default {
|
|
|
14350
15210
|
{
|
|
14351
15211
|
description: 'August lock is temporarily offline.',
|
|
14352
15212
|
properties: {
|
|
14353
|
-
created_at: {
|
|
14354
|
-
|
|
15213
|
+
created_at: {
|
|
15214
|
+
description:
|
|
15215
|
+
'Date and time at which Seam created the warning.',
|
|
15216
|
+
format: 'date-time',
|
|
15217
|
+
type: 'string',
|
|
15218
|
+
},
|
|
15219
|
+
message: {
|
|
15220
|
+
description:
|
|
15221
|
+
'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
15222
|
+
type: 'string',
|
|
15223
|
+
},
|
|
14355
15224
|
warning_code: {
|
|
14356
15225
|
description:
|
|
14357
15226
|
'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
@@ -14365,8 +15234,17 @@ export default {
|
|
|
14365
15234
|
{
|
|
14366
15235
|
description: 'Algopins must be used within 24 hours.',
|
|
14367
15236
|
properties: {
|
|
14368
|
-
created_at: {
|
|
14369
|
-
|
|
15237
|
+
created_at: {
|
|
15238
|
+
description:
|
|
15239
|
+
'Date and time at which Seam created the warning.',
|
|
15240
|
+
format: 'date-time',
|
|
15241
|
+
type: 'string',
|
|
15242
|
+
},
|
|
15243
|
+
message: {
|
|
15244
|
+
description:
|
|
15245
|
+
'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
15246
|
+
type: 'string',
|
|
15247
|
+
},
|
|
14370
15248
|
warning_code: {
|
|
14371
15249
|
description:
|
|
14372
15250
|
'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
@@ -14381,8 +15259,17 @@ export default {
|
|
|
14381
15259
|
description:
|
|
14382
15260
|
'Management was transferred to another workspace.',
|
|
14383
15261
|
properties: {
|
|
14384
|
-
created_at: {
|
|
14385
|
-
|
|
15262
|
+
created_at: {
|
|
15263
|
+
description:
|
|
15264
|
+
'Date and time at which Seam created the warning.',
|
|
15265
|
+
format: 'date-time',
|
|
15266
|
+
type: 'string',
|
|
15267
|
+
},
|
|
15268
|
+
message: {
|
|
15269
|
+
description:
|
|
15270
|
+
'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
15271
|
+
type: 'string',
|
|
15272
|
+
},
|
|
14386
15273
|
warning_code: {
|
|
14387
15274
|
description:
|
|
14388
15275
|
'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
@@ -14395,10 +15282,19 @@ export default {
|
|
|
14395
15282
|
},
|
|
14396
15283
|
{
|
|
14397
15284
|
description:
|
|
14398
|
-
'Unable to confirm the access code is set on Kwikset device.',
|
|
15285
|
+
'Unable to confirm that the access code is set on Kwikset device.',
|
|
14399
15286
|
properties: {
|
|
14400
|
-
created_at: {
|
|
14401
|
-
|
|
15287
|
+
created_at: {
|
|
15288
|
+
description:
|
|
15289
|
+
'Date and time at which Seam created the warning.',
|
|
15290
|
+
format: 'date-time',
|
|
15291
|
+
type: 'string',
|
|
15292
|
+
},
|
|
15293
|
+
message: {
|
|
15294
|
+
description:
|
|
15295
|
+
'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
15296
|
+
type: 'string',
|
|
15297
|
+
},
|
|
14402
15298
|
warning_code: {
|
|
14403
15299
|
description:
|
|
14404
15300
|
'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
@@ -15128,23 +16024,30 @@ export default {
|
|
|
15128
16024
|
type: 'string',
|
|
15129
16025
|
'x-undocumented': 'Only used internally.',
|
|
15130
16026
|
},
|
|
15131
|
-
|
|
16027
|
+
pending_mutations: {
|
|
15132
16028
|
items: {
|
|
15133
|
-
discriminator: { propertyName: '
|
|
16029
|
+
discriminator: { propertyName: 'mutation_code' },
|
|
15134
16030
|
oneOf: [
|
|
15135
16031
|
{
|
|
15136
16032
|
properties: {
|
|
15137
16033
|
created_at: { format: 'date-time', type: 'string' },
|
|
15138
|
-
|
|
16034
|
+
mutation_code: { enum: ['creating'], type: 'string' },
|
|
16035
|
+
},
|
|
16036
|
+
required: ['created_at', 'mutation_code'],
|
|
16037
|
+
type: 'object',
|
|
16038
|
+
},
|
|
16039
|
+
{
|
|
16040
|
+
properties: {
|
|
16041
|
+
created_at: { format: 'date-time', type: 'string' },
|
|
16042
|
+
mutation_code: { enum: ['deleting'], type: 'string' },
|
|
15139
16043
|
},
|
|
15140
|
-
required: ['created_at', '
|
|
16044
|
+
required: ['created_at', 'mutation_code'],
|
|
15141
16045
|
type: 'object',
|
|
15142
16046
|
},
|
|
15143
16047
|
{
|
|
15144
16048
|
properties: {
|
|
15145
16049
|
created_at: { format: 'date-time', type: 'string' },
|
|
15146
|
-
|
|
15147
|
-
modified_from: {
|
|
16050
|
+
from: {
|
|
15148
16051
|
properties: {
|
|
15149
16052
|
email_address: {
|
|
15150
16053
|
format: 'email',
|
|
@@ -15156,7 +16059,11 @@ export default {
|
|
|
15156
16059
|
},
|
|
15157
16060
|
type: 'object',
|
|
15158
16061
|
},
|
|
15159
|
-
|
|
16062
|
+
mutation_code: {
|
|
16063
|
+
enum: ['updating_user_information'],
|
|
16064
|
+
type: 'string',
|
|
16065
|
+
},
|
|
16066
|
+
to: {
|
|
15160
16067
|
properties: {
|
|
15161
16068
|
email_address: {
|
|
15162
16069
|
format: 'email',
|
|
@@ -15169,22 +16076,13 @@ export default {
|
|
|
15169
16076
|
type: 'object',
|
|
15170
16077
|
},
|
|
15171
16078
|
},
|
|
15172
|
-
required: [
|
|
15173
|
-
'created_at',
|
|
15174
|
-
'modification_code',
|
|
15175
|
-
'modified_from',
|
|
15176
|
-
'modified_to',
|
|
15177
|
-
],
|
|
16079
|
+
required: ['created_at', 'mutation_code', 'from', 'to'],
|
|
15178
16080
|
type: 'object',
|
|
15179
16081
|
},
|
|
15180
16082
|
{
|
|
15181
16083
|
properties: {
|
|
15182
16084
|
created_at: { format: 'date-time', type: 'string' },
|
|
15183
|
-
|
|
15184
|
-
enum: ['access_schedule'],
|
|
15185
|
-
type: 'string',
|
|
15186
|
-
},
|
|
15187
|
-
modified_from: {
|
|
16085
|
+
from: {
|
|
15188
16086
|
properties: {
|
|
15189
16087
|
ends_at: {
|
|
15190
16088
|
description:
|
|
@@ -15203,7 +16101,11 @@ export default {
|
|
|
15203
16101
|
required: ['starts_at', 'ends_at'],
|
|
15204
16102
|
type: 'object',
|
|
15205
16103
|
},
|
|
15206
|
-
|
|
16104
|
+
mutation_code: {
|
|
16105
|
+
enum: ['updating_access_schedule'],
|
|
16106
|
+
type: 'string',
|
|
16107
|
+
},
|
|
16108
|
+
to: {
|
|
15207
16109
|
properties: {
|
|
15208
16110
|
ends_at: {
|
|
15209
16111
|
description:
|
|
@@ -15223,48 +16125,34 @@ export default {
|
|
|
15223
16125
|
type: 'object',
|
|
15224
16126
|
},
|
|
15225
16127
|
},
|
|
15226
|
-
required: [
|
|
15227
|
-
'created_at',
|
|
15228
|
-
'modification_code',
|
|
15229
|
-
'modified_from',
|
|
15230
|
-
'modified_to',
|
|
15231
|
-
],
|
|
16128
|
+
required: ['created_at', 'mutation_code', 'from', 'to'],
|
|
15232
16129
|
type: 'object',
|
|
15233
16130
|
},
|
|
15234
16131
|
{
|
|
15235
16132
|
properties: {
|
|
15236
16133
|
created_at: { format: 'date-time', type: 'string' },
|
|
15237
|
-
|
|
15238
|
-
enum: ['suspension_state'],
|
|
15239
|
-
type: 'string',
|
|
15240
|
-
},
|
|
15241
|
-
modified_from: {
|
|
16134
|
+
from: {
|
|
15242
16135
|
properties: { is_suspended: { type: 'boolean' } },
|
|
15243
16136
|
required: ['is_suspended'],
|
|
15244
16137
|
type: 'object',
|
|
15245
16138
|
},
|
|
15246
|
-
|
|
16139
|
+
mutation_code: {
|
|
16140
|
+
enum: ['updating_suspension_state'],
|
|
16141
|
+
type: 'string',
|
|
16142
|
+
},
|
|
16143
|
+
to: {
|
|
15247
16144
|
properties: { is_suspended: { type: 'boolean' } },
|
|
15248
16145
|
required: ['is_suspended'],
|
|
15249
16146
|
type: 'object',
|
|
15250
16147
|
},
|
|
15251
16148
|
},
|
|
15252
|
-
required: [
|
|
15253
|
-
'created_at',
|
|
15254
|
-
'modification_code',
|
|
15255
|
-
'modified_from',
|
|
15256
|
-
'modified_to',
|
|
15257
|
-
],
|
|
16149
|
+
required: ['created_at', 'mutation_code', 'from', 'to'],
|
|
15258
16150
|
type: 'object',
|
|
15259
16151
|
},
|
|
15260
16152
|
{
|
|
15261
16153
|
properties: {
|
|
15262
16154
|
created_at: { format: 'date-time', type: 'string' },
|
|
15263
|
-
|
|
15264
|
-
enum: ['acs_access_group_membership'],
|
|
15265
|
-
type: 'string',
|
|
15266
|
-
},
|
|
15267
|
-
modified_from: {
|
|
16155
|
+
from: {
|
|
15268
16156
|
properties: {
|
|
15269
16157
|
acs_access_group_id: {
|
|
15270
16158
|
format: 'uuid',
|
|
@@ -15275,7 +16163,11 @@ export default {
|
|
|
15275
16163
|
required: ['acs_access_group_id'],
|
|
15276
16164
|
type: 'object',
|
|
15277
16165
|
},
|
|
15278
|
-
|
|
16166
|
+
mutation_code: {
|
|
16167
|
+
enum: ['updating_group_membership'],
|
|
16168
|
+
type: 'string',
|
|
16169
|
+
},
|
|
16170
|
+
to: {
|
|
15279
16171
|
properties: {
|
|
15280
16172
|
acs_access_group_id: {
|
|
15281
16173
|
format: 'uuid',
|
|
@@ -15287,12 +16179,7 @@ export default {
|
|
|
15287
16179
|
type: 'object',
|
|
15288
16180
|
},
|
|
15289
16181
|
},
|
|
15290
|
-
required: [
|
|
15291
|
-
'created_at',
|
|
15292
|
-
'modification_code',
|
|
15293
|
-
'modified_from',
|
|
15294
|
-
'modified_to',
|
|
15295
|
-
],
|
|
16182
|
+
required: ['created_at', 'mutation_code', 'from', 'to'],
|
|
15296
16183
|
type: 'object',
|
|
15297
16184
|
},
|
|
15298
16185
|
],
|
|
@@ -16452,40 +17339,98 @@ export default {
|
|
|
16452
17339
|
paths: {
|
|
16453
17340
|
'/access_codes/create': {
|
|
16454
17341
|
post: {
|
|
17342
|
+
description:
|
|
17343
|
+
'Creates a new [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).',
|
|
16455
17344
|
operationId: 'accessCodesCreatePost',
|
|
16456
17345
|
requestBody: {
|
|
16457
17346
|
content: {
|
|
16458
17347
|
'application/json': {
|
|
16459
17348
|
schema: {
|
|
16460
17349
|
properties: {
|
|
16461
|
-
allow_external_modification: {
|
|
17350
|
+
allow_external_modification: {
|
|
17351
|
+
description:
|
|
17352
|
+
'Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`.',
|
|
17353
|
+
type: 'boolean',
|
|
17354
|
+
},
|
|
16462
17355
|
attempt_for_offline_device: {
|
|
16463
17356
|
default: true,
|
|
16464
17357
|
type: 'boolean',
|
|
16465
17358
|
},
|
|
16466
|
-
code: {
|
|
16467
|
-
|
|
16468
|
-
|
|
16469
|
-
|
|
17359
|
+
code: {
|
|
17360
|
+
description: 'Code to be used for access.',
|
|
17361
|
+
maxLength: 9,
|
|
17362
|
+
minLength: 4,
|
|
17363
|
+
pattern: '^\\d+$',
|
|
17364
|
+
type: 'string',
|
|
17365
|
+
},
|
|
17366
|
+
common_code_key: {
|
|
17367
|
+
description:
|
|
17368
|
+
'Key to identify access codes that should have the same code. Any two access codes with the same `common_code_key` are guaranteed to have the same `code`. See also [Creating and Updating Multiple Linked Access Codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/creating-and-updating-multiple-linked-access-codes).',
|
|
17369
|
+
type: 'string',
|
|
17370
|
+
},
|
|
17371
|
+
device_id: {
|
|
17372
|
+
description:
|
|
17373
|
+
'ID of the device for which to create the new access code.',
|
|
17374
|
+
format: 'uuid',
|
|
17375
|
+
type: 'string',
|
|
17376
|
+
},
|
|
17377
|
+
ends_at: {
|
|
17378
|
+
description:
|
|
17379
|
+
'Date and time at which the validity of the new access code ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`.',
|
|
16470
17380
|
type: 'string',
|
|
16471
17381
|
},
|
|
16472
|
-
|
|
16473
|
-
|
|
16474
|
-
|
|
16475
|
-
|
|
16476
|
-
|
|
16477
|
-
|
|
17382
|
+
is_external_modification_allowed: {
|
|
17383
|
+
description:
|
|
17384
|
+
'Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`.',
|
|
17385
|
+
type: 'boolean',
|
|
17386
|
+
},
|
|
17387
|
+
is_offline_access_code: {
|
|
17388
|
+
description:
|
|
17389
|
+
'Indicates whether the access code is an [offline access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes).',
|
|
17390
|
+
type: 'boolean',
|
|
17391
|
+
},
|
|
17392
|
+
is_one_time_use: {
|
|
17393
|
+
description:
|
|
17394
|
+
'Indicates whether the [offline access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes) is a single-use access code.',
|
|
17395
|
+
type: 'boolean',
|
|
17396
|
+
},
|
|
16478
17397
|
max_time_rounding: {
|
|
16479
17398
|
default: '1hour',
|
|
17399
|
+
description:
|
|
17400
|
+
'Maximum rounding adjustment. To create a daily-bound [offline access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes) for devices that support this feature, set this parameter to `1d`.',
|
|
16480
17401
|
enum: ['1hour', '1day', '1h', '1d'],
|
|
16481
17402
|
type: 'string',
|
|
16482
17403
|
},
|
|
16483
|
-
name: {
|
|
16484
|
-
|
|
16485
|
-
|
|
16486
|
-
|
|
16487
|
-
|
|
16488
|
-
|
|
17404
|
+
name: {
|
|
17405
|
+
description: 'Name of the new access code.',
|
|
17406
|
+
type: 'string',
|
|
17407
|
+
},
|
|
17408
|
+
prefer_native_scheduling: {
|
|
17409
|
+
description:
|
|
17410
|
+
'Indicates whether [native scheduling](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#native-scheduling) should be used for time-bound codes when supported by the provider. Default: `true`.',
|
|
17411
|
+
type: 'boolean',
|
|
17412
|
+
},
|
|
17413
|
+
preferred_code_length: {
|
|
17414
|
+
description:
|
|
17415
|
+
'Preferred code length. Only applicable if you do not specify a `code`. If the affected device does not support the preferred code length, Seam reverts to using the shortest supported code length.',
|
|
17416
|
+
format: 'float',
|
|
17417
|
+
type: 'number',
|
|
17418
|
+
},
|
|
17419
|
+
starts_at: {
|
|
17420
|
+
description:
|
|
17421
|
+
'Date and time at which the validity of the new access code starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.',
|
|
17422
|
+
type: 'string',
|
|
17423
|
+
},
|
|
17424
|
+
sync: {
|
|
17425
|
+
default: false,
|
|
17426
|
+
type: 'boolean',
|
|
17427
|
+
'x-undocumented': 'Only used internally.',
|
|
17428
|
+
},
|
|
17429
|
+
use_backup_access_code_pool: {
|
|
17430
|
+
description:
|
|
17431
|
+
'Indicates whether to use a [backup access code pool](https://docs.seam.co/latest/core-concepts/access-codes#backup-access-codes) provided by Seam. If `true`, you can use [`/access_codes/pull_backup_access_code`](https://docs.seam.co/latest/api-clients/access_codes/pull_backup_access_code).',
|
|
17432
|
+
type: 'boolean',
|
|
17433
|
+
},
|
|
16489
17434
|
use_offline_access_code: { type: 'boolean' },
|
|
16490
17435
|
},
|
|
16491
17436
|
required: ['device_id'],
|
|
@@ -16529,50 +17474,100 @@ export default {
|
|
|
16529
17474
|
'x-fern-sdk-method-name': 'create',
|
|
16530
17475
|
'x-fern-sdk-return-value': 'access_code',
|
|
16531
17476
|
'x-response-key': 'access_code',
|
|
17477
|
+
'x-title': 'Create an Access Code',
|
|
16532
17478
|
},
|
|
16533
17479
|
},
|
|
16534
17480
|
'/access_codes/create_multiple': {
|
|
16535
17481
|
post: {
|
|
17482
|
+
description:
|
|
17483
|
+
'Creates new [access codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) that share a common code across multiple devices.\n\nUsers with more than one door lock in a property may want to create groups of linked access codes, all of which have the same code (PIN). For example, a short-term rental host may want to provide guests the same PIN for both a front door lock and a back door lock.\n\nIf you specify a custom code, Seam assigns this custom code to each of the resulting access codes. However, in this case, Seam does not link these access codes together with a `common_code_key`. That is, `common_code_key` remains null for these access codes.\n\nIf you want to change these access codes that are not linked by a `common_code_key`, you cannot use `/access_codes/update_multiple`. However, you can update each of these access codes individually, using `/access_codes/update`.\n\nSee also [Creating and Updating Multiple Linked Access Codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/creating-and-updating-multiple-linked-access-codes).',
|
|
16536
17484
|
operationId: 'accessCodesCreateMultiplePost',
|
|
16537
17485
|
requestBody: {
|
|
16538
17486
|
content: {
|
|
16539
17487
|
'application/json': {
|
|
16540
17488
|
schema: {
|
|
16541
17489
|
properties: {
|
|
16542
|
-
allow_external_modification: {
|
|
17490
|
+
allow_external_modification: {
|
|
17491
|
+
description:
|
|
17492
|
+
'Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`.',
|
|
17493
|
+
type: 'boolean',
|
|
17494
|
+
},
|
|
16543
17495
|
attempt_for_offline_device: {
|
|
16544
17496
|
default: true,
|
|
16545
17497
|
type: 'boolean',
|
|
16546
17498
|
},
|
|
16547
17499
|
behavior_when_code_cannot_be_shared: {
|
|
16548
17500
|
default: 'throw',
|
|
17501
|
+
description:
|
|
17502
|
+
'Desired behavior if any device cannot share a code. If `throw` (default), no access codes will be created if any device cannot share a code. If `create_random_code`, a random code will be created on devices that cannot share a code.',
|
|
16549
17503
|
enum: ['throw', 'create_random_code'],
|
|
16550
17504
|
type: 'string',
|
|
16551
17505
|
},
|
|
16552
17506
|
code: {
|
|
17507
|
+
description: 'Code to be used for access.',
|
|
16553
17508
|
maxLength: 9,
|
|
16554
17509
|
minLength: 4,
|
|
16555
17510
|
pattern: '^\\d+$',
|
|
16556
17511
|
type: 'string',
|
|
16557
17512
|
},
|
|
16558
17513
|
device_ids: {
|
|
17514
|
+
description:
|
|
17515
|
+
'IDs of the devices for which to create the new access codes.',
|
|
16559
17516
|
items: { format: 'uuid', type: 'string' },
|
|
16560
17517
|
type: 'array',
|
|
16561
17518
|
},
|
|
16562
|
-
ends_at: {
|
|
16563
|
-
|
|
16564
|
-
|
|
16565
|
-
|
|
17519
|
+
ends_at: {
|
|
17520
|
+
description:
|
|
17521
|
+
'Date and time at which the validity of the new access code ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`.',
|
|
17522
|
+
type: 'string',
|
|
17523
|
+
},
|
|
17524
|
+
is_external_modification_allowed: {
|
|
17525
|
+
description:
|
|
17526
|
+
'Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`.',
|
|
17527
|
+
type: 'boolean',
|
|
17528
|
+
},
|
|
17529
|
+
is_offline_access_code: {
|
|
17530
|
+
description:
|
|
17531
|
+
'Indicates whether the access code is an [offline access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes).',
|
|
17532
|
+
type: 'boolean',
|
|
17533
|
+
},
|
|
17534
|
+
is_one_time_use: {
|
|
17535
|
+
description:
|
|
17536
|
+
'Indicates whether the [offline access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes) is a single-use access code.',
|
|
17537
|
+
type: 'boolean',
|
|
17538
|
+
},
|
|
16566
17539
|
max_time_rounding: {
|
|
16567
17540
|
default: '1hour',
|
|
17541
|
+
description:
|
|
17542
|
+
'Maximum rounding adjustment. To create a daily-bound [offline access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes) for devices that support this feature, set this parameter to `1d`.',
|
|
16568
17543
|
enum: ['1hour', '1day', '1h', '1d'],
|
|
16569
17544
|
type: 'string',
|
|
16570
17545
|
},
|
|
16571
|
-
name: {
|
|
16572
|
-
|
|
16573
|
-
|
|
16574
|
-
|
|
16575
|
-
|
|
17546
|
+
name: {
|
|
17547
|
+
description: 'Name of the new access code.',
|
|
17548
|
+
type: 'string',
|
|
17549
|
+
},
|
|
17550
|
+
prefer_native_scheduling: {
|
|
17551
|
+
description:
|
|
17552
|
+
'Indicates whether [native scheduling](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#native-scheduling) should be used for time-bound codes when supported by the provider. Default: `true`.',
|
|
17553
|
+
type: 'boolean',
|
|
17554
|
+
},
|
|
17555
|
+
preferred_code_length: {
|
|
17556
|
+
description:
|
|
17557
|
+
'Preferred code length. Only applicable if you do not specify a `code`. If the affected device does not support the preferred code length, Seam reverts to using the shortest supported code length.',
|
|
17558
|
+
format: 'float',
|
|
17559
|
+
type: 'number',
|
|
17560
|
+
},
|
|
17561
|
+
starts_at: {
|
|
17562
|
+
description:
|
|
17563
|
+
'Date and time at which the validity of the new access code starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.',
|
|
17564
|
+
type: 'string',
|
|
17565
|
+
},
|
|
17566
|
+
use_backup_access_code_pool: {
|
|
17567
|
+
description:
|
|
17568
|
+
'Indicates whether to use a [backup access code pool](https://docs.seam.co/latest/core-concepts/access-codes#backup-access-codes) provided by Seam. If `true`, you can use [`/access_codes/pull_backup_access_code`](https://docs.seam.co/latest/api-clients/access_codes/pull_backup_access_code).',
|
|
17569
|
+
type: 'boolean',
|
|
17570
|
+
},
|
|
16576
17571
|
use_offline_access_code: { type: 'boolean' },
|
|
16577
17572
|
},
|
|
16578
17573
|
required: ['device_ids'],
|
|
@@ -16615,48 +17610,98 @@ export default {
|
|
|
16615
17610
|
'x-fern-sdk-method-name': 'create_multiple',
|
|
16616
17611
|
'x-fern-sdk-return-value': 'access_codes',
|
|
16617
17612
|
'x-response-key': 'access_codes',
|
|
17613
|
+
'x-title': 'Create Multiple Linked Access Codes',
|
|
16618
17614
|
},
|
|
16619
17615
|
put: {
|
|
17616
|
+
description:
|
|
17617
|
+
'Creates new [access codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) that share a common code across multiple devices.\n\nUsers with more than one door lock in a property may want to create groups of linked access codes, all of which have the same code (PIN). For example, a short-term rental host may want to provide guests the same PIN for both a front door lock and a back door lock.\n\nIf you specify a custom code, Seam assigns this custom code to each of the resulting access codes. However, in this case, Seam does not link these access codes together with a `common_code_key`. That is, `common_code_key` remains null for these access codes.\n\nIf you want to change these access codes that are not linked by a `common_code_key`, you cannot use `/access_codes/update_multiple`. However, you can update each of these access codes individually, using `/access_codes/update`.\n\nSee also [Creating and Updating Multiple Linked Access Codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/creating-and-updating-multiple-linked-access-codes).',
|
|
16620
17618
|
operationId: 'accessCodesCreateMultiplePut',
|
|
16621
17619
|
requestBody: {
|
|
16622
17620
|
content: {
|
|
16623
17621
|
'application/json': {
|
|
16624
17622
|
schema: {
|
|
16625
17623
|
properties: {
|
|
16626
|
-
allow_external_modification: {
|
|
17624
|
+
allow_external_modification: {
|
|
17625
|
+
description:
|
|
17626
|
+
'Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`.',
|
|
17627
|
+
type: 'boolean',
|
|
17628
|
+
},
|
|
16627
17629
|
attempt_for_offline_device: {
|
|
16628
17630
|
default: true,
|
|
16629
17631
|
type: 'boolean',
|
|
16630
17632
|
},
|
|
16631
17633
|
behavior_when_code_cannot_be_shared: {
|
|
16632
17634
|
default: 'throw',
|
|
17635
|
+
description:
|
|
17636
|
+
'Desired behavior if any device cannot share a code. If `throw` (default), no access codes will be created if any device cannot share a code. If `create_random_code`, a random code will be created on devices that cannot share a code.',
|
|
16633
17637
|
enum: ['throw', 'create_random_code'],
|
|
16634
17638
|
type: 'string',
|
|
16635
17639
|
},
|
|
16636
17640
|
code: {
|
|
17641
|
+
description: 'Code to be used for access.',
|
|
16637
17642
|
maxLength: 9,
|
|
16638
17643
|
minLength: 4,
|
|
16639
17644
|
pattern: '^\\d+$',
|
|
16640
17645
|
type: 'string',
|
|
16641
17646
|
},
|
|
16642
17647
|
device_ids: {
|
|
17648
|
+
description:
|
|
17649
|
+
'IDs of the devices for which to create the new access codes.',
|
|
16643
17650
|
items: { format: 'uuid', type: 'string' },
|
|
16644
17651
|
type: 'array',
|
|
16645
17652
|
},
|
|
16646
|
-
ends_at: {
|
|
16647
|
-
|
|
16648
|
-
|
|
16649
|
-
|
|
17653
|
+
ends_at: {
|
|
17654
|
+
description:
|
|
17655
|
+
'Date and time at which the validity of the new access code ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`.',
|
|
17656
|
+
type: 'string',
|
|
17657
|
+
},
|
|
17658
|
+
is_external_modification_allowed: {
|
|
17659
|
+
description:
|
|
17660
|
+
'Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`.',
|
|
17661
|
+
type: 'boolean',
|
|
17662
|
+
},
|
|
17663
|
+
is_offline_access_code: {
|
|
17664
|
+
description:
|
|
17665
|
+
'Indicates whether the access code is an [offline access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes).',
|
|
17666
|
+
type: 'boolean',
|
|
17667
|
+
},
|
|
17668
|
+
is_one_time_use: {
|
|
17669
|
+
description:
|
|
17670
|
+
'Indicates whether the [offline access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes) is a single-use access code.',
|
|
17671
|
+
type: 'boolean',
|
|
17672
|
+
},
|
|
16650
17673
|
max_time_rounding: {
|
|
16651
17674
|
default: '1hour',
|
|
17675
|
+
description:
|
|
17676
|
+
'Maximum rounding adjustment. To create a daily-bound [offline access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes) for devices that support this feature, set this parameter to `1d`.',
|
|
16652
17677
|
enum: ['1hour', '1day', '1h', '1d'],
|
|
16653
17678
|
type: 'string',
|
|
16654
17679
|
},
|
|
16655
|
-
name: {
|
|
16656
|
-
|
|
16657
|
-
|
|
16658
|
-
|
|
16659
|
-
|
|
17680
|
+
name: {
|
|
17681
|
+
description: 'Name of the new access code.',
|
|
17682
|
+
type: 'string',
|
|
17683
|
+
},
|
|
17684
|
+
prefer_native_scheduling: {
|
|
17685
|
+
description:
|
|
17686
|
+
'Indicates whether [native scheduling](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#native-scheduling) should be used for time-bound codes when supported by the provider. Default: `true`.',
|
|
17687
|
+
type: 'boolean',
|
|
17688
|
+
},
|
|
17689
|
+
preferred_code_length: {
|
|
17690
|
+
description:
|
|
17691
|
+
'Preferred code length. Only applicable if you do not specify a `code`. If the affected device does not support the preferred code length, Seam reverts to using the shortest supported code length.',
|
|
17692
|
+
format: 'float',
|
|
17693
|
+
type: 'number',
|
|
17694
|
+
},
|
|
17695
|
+
starts_at: {
|
|
17696
|
+
description:
|
|
17697
|
+
'Date and time at which the validity of the new access code starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.',
|
|
17698
|
+
type: 'string',
|
|
17699
|
+
},
|
|
17700
|
+
use_backup_access_code_pool: {
|
|
17701
|
+
description:
|
|
17702
|
+
'Indicates whether to use a [backup access code pool](https://docs.seam.co/latest/core-concepts/access-codes#backup-access-codes) provided by Seam. If `true`, you can use [`/access_codes/pull_backup_access_code`](https://docs.seam.co/latest/api-clients/access_codes/pull_backup_access_code).',
|
|
17703
|
+
type: 'boolean',
|
|
17704
|
+
},
|
|
16660
17705
|
use_offline_access_code: { type: 'boolean' },
|
|
16661
17706
|
},
|
|
16662
17707
|
required: ['device_ids'],
|
|
@@ -16697,19 +17742,35 @@ export default {
|
|
|
16697
17742
|
tags: ['/access_codes'],
|
|
16698
17743
|
'x-fern-ignore': true,
|
|
16699
17744
|
'x-response-key': 'access_codes',
|
|
17745
|
+
'x-title': 'Create Multiple Linked Access Codes',
|
|
16700
17746
|
},
|
|
16701
17747
|
},
|
|
16702
17748
|
'/access_codes/delete': {
|
|
16703
17749
|
post: {
|
|
17750
|
+
description:
|
|
17751
|
+
'Deletes an [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).',
|
|
16704
17752
|
operationId: 'accessCodesDeletePost',
|
|
16705
17753
|
requestBody: {
|
|
16706
17754
|
content: {
|
|
16707
17755
|
'application/json': {
|
|
16708
17756
|
schema: {
|
|
16709
17757
|
properties: {
|
|
16710
|
-
access_code_id: {
|
|
16711
|
-
|
|
16712
|
-
|
|
17758
|
+
access_code_id: {
|
|
17759
|
+
description: 'ID of the access code to delete.',
|
|
17760
|
+
format: 'uuid',
|
|
17761
|
+
type: 'string',
|
|
17762
|
+
},
|
|
17763
|
+
device_id: {
|
|
17764
|
+
description:
|
|
17765
|
+
'ID of the device for which to delete the access code.',
|
|
17766
|
+
format: 'uuid',
|
|
17767
|
+
type: 'string',
|
|
17768
|
+
},
|
|
17769
|
+
sync: {
|
|
17770
|
+
default: false,
|
|
17771
|
+
type: 'boolean',
|
|
17772
|
+
'x-undocumented': 'Only used internally.',
|
|
17773
|
+
},
|
|
16713
17774
|
},
|
|
16714
17775
|
required: ['access_code_id'],
|
|
16715
17776
|
type: 'object',
|
|
@@ -16750,6 +17811,7 @@ export default {
|
|
|
16750
17811
|
'x-fern-sdk-group-name': ['access_codes'],
|
|
16751
17812
|
'x-fern-sdk-method-name': 'delete',
|
|
16752
17813
|
'x-response-key': null,
|
|
17814
|
+
'x-title': 'Delete an Access Code',
|
|
16753
17815
|
},
|
|
16754
17816
|
},
|
|
16755
17817
|
'/access_codes/generate_code': {
|
|
@@ -16803,15 +17865,31 @@ export default {
|
|
|
16803
17865
|
},
|
|
16804
17866
|
'/access_codes/get': {
|
|
16805
17867
|
post: {
|
|
17868
|
+
description:
|
|
17869
|
+
'Returns a specified [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).\n\nYou must specify either `access_code_id` or both `device_id` and `code`.',
|
|
16806
17870
|
operationId: 'accessCodesGetPost',
|
|
16807
17871
|
requestBody: {
|
|
16808
17872
|
content: {
|
|
16809
17873
|
'application/json': {
|
|
16810
17874
|
schema: {
|
|
16811
17875
|
properties: {
|
|
16812
|
-
access_code_id: {
|
|
16813
|
-
|
|
16814
|
-
|
|
17876
|
+
access_code_id: {
|
|
17877
|
+
description:
|
|
17878
|
+
'ID of the access code that you want to get. You must specify either `access_code_id` or both `device_id` and `code`.',
|
|
17879
|
+
format: 'uuid',
|
|
17880
|
+
type: 'string',
|
|
17881
|
+
},
|
|
17882
|
+
code: {
|
|
17883
|
+
description:
|
|
17884
|
+
'Code of the access code that you want to get. You must specify either `access_code_id` or both `device_id` and `code`.',
|
|
17885
|
+
type: 'string',
|
|
17886
|
+
},
|
|
17887
|
+
device_id: {
|
|
17888
|
+
description:
|
|
17889
|
+
'ID of the device containing the access code that you want to get. You must specify either `access_code_id` or both `device_id` and `code`.',
|
|
17890
|
+
format: 'uuid',
|
|
17891
|
+
type: 'string',
|
|
17892
|
+
},
|
|
16815
17893
|
},
|
|
16816
17894
|
type: 'object',
|
|
16817
17895
|
},
|
|
@@ -16849,10 +17927,13 @@ export default {
|
|
|
16849
17927
|
'x-fern-sdk-method-name': 'get',
|
|
16850
17928
|
'x-fern-sdk-return-value': 'access_code',
|
|
16851
17929
|
'x-response-key': 'access_code',
|
|
17930
|
+
'x-title': 'Get an Access Code',
|
|
16852
17931
|
},
|
|
16853
17932
|
},
|
|
16854
17933
|
'/access_codes/list': {
|
|
16855
17934
|
post: {
|
|
17935
|
+
description:
|
|
17936
|
+
'Returns a list of all [access codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).\n\nSpecify either `device_id` or `access_code_ids`.',
|
|
16856
17937
|
operationId: 'accessCodesListPost',
|
|
16857
17938
|
requestBody: {
|
|
16858
17939
|
content: {
|
|
@@ -16860,11 +17941,22 @@ export default {
|
|
|
16860
17941
|
schema: {
|
|
16861
17942
|
properties: {
|
|
16862
17943
|
access_code_ids: {
|
|
17944
|
+
description:
|
|
17945
|
+
'IDs of the access codes that you want to retrieve. Specify either `device_id` or `access_code_ids`.',
|
|
16863
17946
|
items: { format: 'uuid', type: 'string' },
|
|
16864
17947
|
type: 'array',
|
|
16865
17948
|
},
|
|
16866
|
-
device_id: {
|
|
16867
|
-
|
|
17949
|
+
device_id: {
|
|
17950
|
+
description:
|
|
17951
|
+
'ID of the device for which you want to list access codes. Specify either `device_id` or `access_code_ids`.',
|
|
17952
|
+
format: 'uuid',
|
|
17953
|
+
type: 'string',
|
|
17954
|
+
},
|
|
17955
|
+
user_identifier_key: {
|
|
17956
|
+
description:
|
|
17957
|
+
'Your user ID for the user by which to filter access codes.',
|
|
17958
|
+
type: 'string',
|
|
17959
|
+
},
|
|
16868
17960
|
},
|
|
16869
17961
|
type: 'object',
|
|
16870
17962
|
},
|
|
@@ -16905,19 +17997,25 @@ export default {
|
|
|
16905
17997
|
'x-fern-sdk-method-name': 'list',
|
|
16906
17998
|
'x-fern-sdk-return-value': 'access_codes',
|
|
16907
17999
|
'x-response-key': 'access_codes',
|
|
18000
|
+
'x-title': 'List Access Codes',
|
|
16908
18001
|
},
|
|
16909
18002
|
},
|
|
16910
18003
|
'/access_codes/pull_backup_access_code': {
|
|
16911
18004
|
post: {
|
|
16912
18005
|
description:
|
|
16913
|
-
|
|
18006
|
+
"Retrieves a backup access code for an [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). See also [Managing Backup Access Codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/backup-access-codes).\n\nA backup access code pool is a collection of pre-programmed access codes stored on a device, ready for use. These codes are programmed in addition to the regular access codes on Seam, serving as a safety net for any issues with the primary codes.\n\nIf there's ever a complication with a primary access code—be it due to intermittent connectivity, manual removal from a device, or provider outages—a backup code can be retrieved. Its end time can then be adjusted to align with the original code, facilitating seamless and uninterrupted access.\n\nYou can only pull backup access codes for time-bound access codes.\n\nBefore pulling a backup access code, make sure that the device's `properties.supports_backup_access_code_pool` is `true`. Then, to activate the backup pool, set `use_backup_access_code_pool` to `true` when creating an access code.",
|
|
16914
18007
|
operationId: 'accessCodesPullBackupAccessCodePost',
|
|
16915
18008
|
requestBody: {
|
|
16916
18009
|
content: {
|
|
16917
18010
|
'application/json': {
|
|
16918
18011
|
schema: {
|
|
16919
18012
|
properties: {
|
|
16920
|
-
access_code_id: {
|
|
18013
|
+
access_code_id: {
|
|
18014
|
+
description:
|
|
18015
|
+
'ID of the access code for which you want to pull a backup access code.',
|
|
18016
|
+
format: 'uuid',
|
|
18017
|
+
type: 'string',
|
|
18018
|
+
},
|
|
16921
18019
|
},
|
|
16922
18020
|
required: ['access_code_id'],
|
|
16923
18021
|
type: 'object',
|
|
@@ -16959,10 +18057,13 @@ export default {
|
|
|
16959
18057
|
'x-fern-sdk-method-name': 'pull_backup_access_code',
|
|
16960
18058
|
'x-fern-sdk-return-value': 'access_code',
|
|
16961
18059
|
'x-response-key': 'access_code',
|
|
18060
|
+
'x-title': 'Pull a Backup Access Code',
|
|
16962
18061
|
},
|
|
16963
18062
|
},
|
|
16964
18063
|
'/access_codes/simulate/create_unmanaged_access_code': {
|
|
16965
18064
|
post: {
|
|
18065
|
+
description:
|
|
18066
|
+
'Simulates the creation of an [unmanaged access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes) in a [sandbox workspace](https://docs.seam.co/latest/core-concepts/workspaces#sandbox-workspaces).',
|
|
16966
18067
|
operationId: 'accessCodesSimulateCreateUnmanagedAccessCodePost',
|
|
16967
18068
|
requestBody: {
|
|
16968
18069
|
content: {
|
|
@@ -16970,13 +18071,22 @@ export default {
|
|
|
16970
18071
|
schema: {
|
|
16971
18072
|
properties: {
|
|
16972
18073
|
code: {
|
|
18074
|
+
description: 'Code of the simulated unmanaged access code.',
|
|
16973
18075
|
maxLength: 8,
|
|
16974
18076
|
minLength: 4,
|
|
16975
18077
|
pattern: '^\\d+$',
|
|
16976
18078
|
type: 'string',
|
|
16977
18079
|
},
|
|
16978
|
-
device_id: {
|
|
16979
|
-
|
|
18080
|
+
device_id: {
|
|
18081
|
+
description:
|
|
18082
|
+
'ID of the device for which you want to simulate the creation of an unmanaged access code.',
|
|
18083
|
+
format: 'uuid',
|
|
18084
|
+
type: 'string',
|
|
18085
|
+
},
|
|
18086
|
+
name: {
|
|
18087
|
+
description: 'Name of the simulated unmanaged access code.',
|
|
18088
|
+
type: 'string',
|
|
18089
|
+
},
|
|
16980
18090
|
},
|
|
16981
18091
|
required: ['device_id', 'name', 'code'],
|
|
16982
18092
|
type: 'object',
|
|
@@ -17017,21 +18127,45 @@ export default {
|
|
|
17017
18127
|
'x-fern-sdk-method-name': 'create_unmanaged_access_code',
|
|
17018
18128
|
'x-fern-sdk-return-value': 'access_code',
|
|
17019
18129
|
'x-response-key': 'access_code',
|
|
18130
|
+
'x-title': 'Simulate Creating an Unmanaged Access Code',
|
|
17020
18131
|
},
|
|
17021
18132
|
},
|
|
17022
18133
|
'/access_codes/unmanaged/convert_to_managed': {
|
|
17023
18134
|
patch: {
|
|
18135
|
+
description:
|
|
18136
|
+
'Converts an [unmanaged access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes) to an [access code managed through Seam](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).\n\nAn unmanaged access code has a limited set of operations that you can perform on it. Once you convert an unmanaged access code to a managed access code, the full set of access code operations and lifecycle events becomes available for it.\n\nNote that not all device providers support converting an unmanaged access code to a managed access code.',
|
|
17024
18137
|
operationId: 'accessCodesUnmanagedConvertToManagedPatch',
|
|
17025
18138
|
requestBody: {
|
|
17026
18139
|
content: {
|
|
17027
18140
|
'application/json': {
|
|
17028
18141
|
schema: {
|
|
17029
18142
|
properties: {
|
|
17030
|
-
access_code_id: {
|
|
17031
|
-
|
|
17032
|
-
|
|
17033
|
-
|
|
17034
|
-
|
|
18143
|
+
access_code_id: {
|
|
18144
|
+
description:
|
|
18145
|
+
'ID of the unmanaged access code that you want to convert to a managed access code.',
|
|
18146
|
+
format: 'uuid',
|
|
18147
|
+
type: 'string',
|
|
18148
|
+
},
|
|
18149
|
+
allow_external_modification: {
|
|
18150
|
+
description:
|
|
18151
|
+
'Indicates whether external modification of the access code is allowed.',
|
|
18152
|
+
type: 'boolean',
|
|
18153
|
+
},
|
|
18154
|
+
force: {
|
|
18155
|
+
description:
|
|
18156
|
+
'Indicates whether to force the access code conversion. To switch management of an access code from one Seam workspace to another, set `force` to `true`.',
|
|
18157
|
+
type: 'boolean',
|
|
18158
|
+
},
|
|
18159
|
+
is_external_modification_allowed: {
|
|
18160
|
+
description:
|
|
18161
|
+
'Indicates whether external modification of the access code is allowed.',
|
|
18162
|
+
type: 'boolean',
|
|
18163
|
+
},
|
|
18164
|
+
sync: {
|
|
18165
|
+
default: false,
|
|
18166
|
+
type: 'boolean',
|
|
18167
|
+
'x-undocumented': 'Only used internally.',
|
|
18168
|
+
},
|
|
17035
18169
|
},
|
|
17036
18170
|
required: ['access_code_id'],
|
|
17037
18171
|
type: 'object',
|
|
@@ -17066,19 +18200,43 @@ export default {
|
|
|
17066
18200
|
'x-action-attempt-type': 'CONVERT_ACCESS_CODE_TO_MANAGED',
|
|
17067
18201
|
'x-fern-ignore': true,
|
|
17068
18202
|
'x-response-key': null,
|
|
18203
|
+
'x-title': 'Convert an Unmanaged Access Code',
|
|
17069
18204
|
},
|
|
17070
18205
|
post: {
|
|
18206
|
+
description:
|
|
18207
|
+
'Converts an [unmanaged access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes) to an [access code managed through Seam](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).\n\nAn unmanaged access code has a limited set of operations that you can perform on it. Once you convert an unmanaged access code to a managed access code, the full set of access code operations and lifecycle events becomes available for it.\n\nNote that not all device providers support converting an unmanaged access code to a managed access code.',
|
|
17071
18208
|
operationId: 'accessCodesUnmanagedConvertToManagedPost',
|
|
17072
18209
|
requestBody: {
|
|
17073
18210
|
content: {
|
|
17074
18211
|
'application/json': {
|
|
17075
18212
|
schema: {
|
|
17076
18213
|
properties: {
|
|
17077
|
-
access_code_id: {
|
|
17078
|
-
|
|
17079
|
-
|
|
17080
|
-
|
|
17081
|
-
|
|
18214
|
+
access_code_id: {
|
|
18215
|
+
description:
|
|
18216
|
+
'ID of the unmanaged access code that you want to convert to a managed access code.',
|
|
18217
|
+
format: 'uuid',
|
|
18218
|
+
type: 'string',
|
|
18219
|
+
},
|
|
18220
|
+
allow_external_modification: {
|
|
18221
|
+
description:
|
|
18222
|
+
'Indicates whether external modification of the access code is allowed.',
|
|
18223
|
+
type: 'boolean',
|
|
18224
|
+
},
|
|
18225
|
+
force: {
|
|
18226
|
+
description:
|
|
18227
|
+
'Indicates whether to force the access code conversion. To switch management of an access code from one Seam workspace to another, set `force` to `true`.',
|
|
18228
|
+
type: 'boolean',
|
|
18229
|
+
},
|
|
18230
|
+
is_external_modification_allowed: {
|
|
18231
|
+
description:
|
|
18232
|
+
'Indicates whether external modification of the access code is allowed.',
|
|
18233
|
+
type: 'boolean',
|
|
18234
|
+
},
|
|
18235
|
+
sync: {
|
|
18236
|
+
default: false,
|
|
18237
|
+
type: 'boolean',
|
|
18238
|
+
'x-undocumented': 'Only used internally.',
|
|
18239
|
+
},
|
|
17082
18240
|
},
|
|
17083
18241
|
required: ['access_code_id'],
|
|
17084
18242
|
type: 'object',
|
|
@@ -17114,18 +18272,29 @@ export default {
|
|
|
17114
18272
|
'x-fern-sdk-group-name': ['access_codes', 'unmanaged'],
|
|
17115
18273
|
'x-fern-sdk-method-name': 'convert_to_managed',
|
|
17116
18274
|
'x-response-key': null,
|
|
18275
|
+
'x-title': 'Convert an Unmanaged Access Code',
|
|
17117
18276
|
},
|
|
17118
18277
|
},
|
|
17119
18278
|
'/access_codes/unmanaged/delete': {
|
|
17120
18279
|
post: {
|
|
18280
|
+
description:
|
|
18281
|
+
'Deletes an [unmanaged access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes).',
|
|
17121
18282
|
operationId: 'accessCodesUnmanagedDeletePost',
|
|
17122
18283
|
requestBody: {
|
|
17123
18284
|
content: {
|
|
17124
18285
|
'application/json': {
|
|
17125
18286
|
schema: {
|
|
17126
18287
|
properties: {
|
|
17127
|
-
access_code_id: {
|
|
17128
|
-
|
|
18288
|
+
access_code_id: {
|
|
18289
|
+
description: 'ID of the unmanaged access code to delete.',
|
|
18290
|
+
format: 'uuid',
|
|
18291
|
+
type: 'string',
|
|
18292
|
+
},
|
|
18293
|
+
sync: {
|
|
18294
|
+
default: false,
|
|
18295
|
+
type: 'boolean',
|
|
18296
|
+
'x-undocumented': 'Only used internally.',
|
|
18297
|
+
},
|
|
17129
18298
|
},
|
|
17130
18299
|
required: ['access_code_id'],
|
|
17131
18300
|
type: 'object',
|
|
@@ -17166,19 +18335,36 @@ export default {
|
|
|
17166
18335
|
'x-fern-sdk-group-name': ['access_codes', 'unmanaged'],
|
|
17167
18336
|
'x-fern-sdk-method-name': 'delete',
|
|
17168
18337
|
'x-response-key': null,
|
|
18338
|
+
'x-title': 'Delete an Unmanaged Access Code',
|
|
17169
18339
|
},
|
|
17170
18340
|
},
|
|
17171
18341
|
'/access_codes/unmanaged/get': {
|
|
17172
18342
|
post: {
|
|
18343
|
+
description:
|
|
18344
|
+
'Returns a specified [unmanaged access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes).\n\nYou must specify either `access_code_id` or both `device_id` and `code`.',
|
|
17173
18345
|
operationId: 'accessCodesUnmanagedGetPost',
|
|
17174
18346
|
requestBody: {
|
|
17175
18347
|
content: {
|
|
17176
18348
|
'application/json': {
|
|
17177
18349
|
schema: {
|
|
17178
18350
|
properties: {
|
|
17179
|
-
access_code_id: {
|
|
17180
|
-
|
|
17181
|
-
|
|
18351
|
+
access_code_id: {
|
|
18352
|
+
description:
|
|
18353
|
+
'ID of the unmanaged access code that you want to get. You must specify either `access_code_id` or both `device_id` and `code`.',
|
|
18354
|
+
format: 'uuid',
|
|
18355
|
+
type: 'string',
|
|
18356
|
+
},
|
|
18357
|
+
code: {
|
|
18358
|
+
description:
|
|
18359
|
+
'Code of the unmanaged access code that you want to get. You must specify either `access_code_id` or both `device_id` and `code`.',
|
|
18360
|
+
type: 'string',
|
|
18361
|
+
},
|
|
18362
|
+
device_id: {
|
|
18363
|
+
description:
|
|
18364
|
+
'ID of the device containing the unmanaged access code that you want to get. You must specify either `access_code_id` or both `device_id` and `code`.',
|
|
18365
|
+
format: 'uuid',
|
|
18366
|
+
type: 'string',
|
|
18367
|
+
},
|
|
17182
18368
|
},
|
|
17183
18369
|
type: 'object',
|
|
17184
18370
|
},
|
|
@@ -17218,18 +18404,30 @@ export default {
|
|
|
17218
18404
|
'x-fern-sdk-method-name': 'get',
|
|
17219
18405
|
'x-fern-sdk-return-value': 'access_code',
|
|
17220
18406
|
'x-response-key': 'access_code',
|
|
18407
|
+
'x-title': 'Get an Unmanaged Access Code',
|
|
17221
18408
|
},
|
|
17222
18409
|
},
|
|
17223
18410
|
'/access_codes/unmanaged/list': {
|
|
17224
18411
|
post: {
|
|
18412
|
+
description:
|
|
18413
|
+
'Returns a list of all [unmanaged access codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes).',
|
|
17225
18414
|
operationId: 'accessCodesUnmanagedListPost',
|
|
17226
18415
|
requestBody: {
|
|
17227
18416
|
content: {
|
|
17228
18417
|
'application/json': {
|
|
17229
18418
|
schema: {
|
|
17230
18419
|
properties: {
|
|
17231
|
-
device_id: {
|
|
17232
|
-
|
|
18420
|
+
device_id: {
|
|
18421
|
+
description:
|
|
18422
|
+
'ID of the device for which you want to list unmanaged access codes.',
|
|
18423
|
+
format: 'uuid',
|
|
18424
|
+
type: 'string',
|
|
18425
|
+
},
|
|
18426
|
+
user_identifier_key: {
|
|
18427
|
+
description:
|
|
18428
|
+
'Your user ID for the user by which to filter unmanaged access codes.',
|
|
18429
|
+
type: 'string',
|
|
18430
|
+
},
|
|
17233
18431
|
},
|
|
17234
18432
|
required: ['device_id'],
|
|
17235
18433
|
type: 'object',
|
|
@@ -17273,20 +18471,40 @@ export default {
|
|
|
17273
18471
|
'x-fern-sdk-method-name': 'list',
|
|
17274
18472
|
'x-fern-sdk-return-value': 'access_codes',
|
|
17275
18473
|
'x-response-key': 'access_codes',
|
|
18474
|
+
'x-title': 'List Unmanaged Access Codes',
|
|
17276
18475
|
},
|
|
17277
18476
|
},
|
|
17278
18477
|
'/access_codes/unmanaged/update': {
|
|
17279
18478
|
patch: {
|
|
18479
|
+
description:
|
|
18480
|
+
'Updates a specified [unmanaged access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes).',
|
|
17280
18481
|
operationId: 'accessCodesUnmanagedUpdatePatch',
|
|
17281
18482
|
requestBody: {
|
|
17282
18483
|
content: {
|
|
17283
18484
|
'application/json': {
|
|
17284
18485
|
schema: {
|
|
17285
18486
|
properties: {
|
|
17286
|
-
access_code_id: {
|
|
17287
|
-
|
|
17288
|
-
|
|
17289
|
-
|
|
18487
|
+
access_code_id: {
|
|
18488
|
+
description:
|
|
18489
|
+
'ID of the unmanaged access code that you want to update.',
|
|
18490
|
+
format: 'uuid',
|
|
18491
|
+
type: 'string',
|
|
18492
|
+
},
|
|
18493
|
+
allow_external_modification: {
|
|
18494
|
+
description:
|
|
18495
|
+
'Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the code is allowed.',
|
|
18496
|
+
type: 'boolean',
|
|
18497
|
+
},
|
|
18498
|
+
force: {
|
|
18499
|
+
description:
|
|
18500
|
+
'Indicates whether to force the unmanaged access code update.',
|
|
18501
|
+
type: 'boolean',
|
|
18502
|
+
},
|
|
18503
|
+
is_external_modification_allowed: {
|
|
18504
|
+
description:
|
|
18505
|
+
'Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the code is allowed.',
|
|
18506
|
+
type: 'boolean',
|
|
18507
|
+
},
|
|
17290
18508
|
is_managed: { type: 'boolean' },
|
|
17291
18509
|
},
|
|
17292
18510
|
required: ['access_code_id', 'is_managed'],
|
|
@@ -17321,18 +18539,38 @@ export default {
|
|
|
17321
18539
|
tags: ['/access_codes'],
|
|
17322
18540
|
'x-fern-ignore': true,
|
|
17323
18541
|
'x-response-key': null,
|
|
18542
|
+
'x-title': 'Update an Unmanaged Access Code',
|
|
17324
18543
|
},
|
|
17325
18544
|
post: {
|
|
18545
|
+
description:
|
|
18546
|
+
'Updates a specified [unmanaged access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes).',
|
|
17326
18547
|
operationId: 'accessCodesUnmanagedUpdatePost',
|
|
17327
18548
|
requestBody: {
|
|
17328
18549
|
content: {
|
|
17329
18550
|
'application/json': {
|
|
17330
18551
|
schema: {
|
|
17331
18552
|
properties: {
|
|
17332
|
-
access_code_id: {
|
|
17333
|
-
|
|
17334
|
-
|
|
17335
|
-
|
|
18553
|
+
access_code_id: {
|
|
18554
|
+
description:
|
|
18555
|
+
'ID of the unmanaged access code that you want to update.',
|
|
18556
|
+
format: 'uuid',
|
|
18557
|
+
type: 'string',
|
|
18558
|
+
},
|
|
18559
|
+
allow_external_modification: {
|
|
18560
|
+
description:
|
|
18561
|
+
'Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the code is allowed.',
|
|
18562
|
+
type: 'boolean',
|
|
18563
|
+
},
|
|
18564
|
+
force: {
|
|
18565
|
+
description:
|
|
18566
|
+
'Indicates whether to force the unmanaged access code update.',
|
|
18567
|
+
type: 'boolean',
|
|
18568
|
+
},
|
|
18569
|
+
is_external_modification_allowed: {
|
|
18570
|
+
description:
|
|
18571
|
+
'Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the code is allowed.',
|
|
18572
|
+
type: 'boolean',
|
|
18573
|
+
},
|
|
17336
18574
|
is_managed: { type: 'boolean' },
|
|
17337
18575
|
},
|
|
17338
18576
|
required: ['access_code_id', 'is_managed'],
|
|
@@ -17368,46 +18606,115 @@ export default {
|
|
|
17368
18606
|
'x-fern-sdk-group-name': ['access_codes', 'unmanaged'],
|
|
17369
18607
|
'x-fern-sdk-method-name': 'update',
|
|
17370
18608
|
'x-response-key': null,
|
|
18609
|
+
'x-title': 'Update an Unmanaged Access Code',
|
|
17371
18610
|
},
|
|
17372
18611
|
},
|
|
17373
18612
|
'/access_codes/update': {
|
|
17374
18613
|
patch: {
|
|
18614
|
+
description:
|
|
18615
|
+
'Updates a specified active or upcoming [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).\n\nSee also [Modifying Access Codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/modifying-access-codes).',
|
|
17375
18616
|
operationId: 'accessCodesUpdatePatch',
|
|
17376
18617
|
requestBody: {
|
|
17377
18618
|
content: {
|
|
17378
18619
|
'application/json': {
|
|
17379
18620
|
schema: {
|
|
17380
18621
|
properties: {
|
|
17381
|
-
access_code_id: {
|
|
17382
|
-
|
|
18622
|
+
access_code_id: {
|
|
18623
|
+
description:
|
|
18624
|
+
'ID of the access code that you want to update.',
|
|
18625
|
+
format: 'uuid',
|
|
18626
|
+
type: 'string',
|
|
18627
|
+
},
|
|
18628
|
+
allow_external_modification: {
|
|
18629
|
+
description:
|
|
18630
|
+
'Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`.',
|
|
18631
|
+
type: 'boolean',
|
|
18632
|
+
},
|
|
17383
18633
|
attempt_for_offline_device: {
|
|
17384
18634
|
default: true,
|
|
17385
18635
|
type: 'boolean',
|
|
17386
18636
|
},
|
|
17387
18637
|
code: {
|
|
18638
|
+
description: 'Code to be used for access.',
|
|
17388
18639
|
maxLength: 9,
|
|
17389
18640
|
minLength: 4,
|
|
17390
18641
|
pattern: '^\\d+$',
|
|
17391
18642
|
type: 'string',
|
|
17392
18643
|
},
|
|
17393
|
-
device_id: {
|
|
17394
|
-
|
|
17395
|
-
|
|
17396
|
-
|
|
17397
|
-
|
|
17398
|
-
|
|
18644
|
+
device_id: {
|
|
18645
|
+
description:
|
|
18646
|
+
'ID of the device containing the access code that you want to update.',
|
|
18647
|
+
format: 'uuid',
|
|
18648
|
+
type: 'string',
|
|
18649
|
+
},
|
|
18650
|
+
ends_at: {
|
|
18651
|
+
description:
|
|
18652
|
+
'Date and time at which the validity of the new access code ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`.',
|
|
18653
|
+
type: 'string',
|
|
18654
|
+
},
|
|
18655
|
+
is_external_modification_allowed: {
|
|
18656
|
+
description:
|
|
18657
|
+
'Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`.',
|
|
18658
|
+
type: 'boolean',
|
|
18659
|
+
},
|
|
18660
|
+
is_managed: {
|
|
18661
|
+
description:
|
|
18662
|
+
'Indicates whether the access code is managed through Seam. Note that to convert an unmanaged access code into a managed access code, use `/access_codes/unmanaged/convert_to_managed`.',
|
|
18663
|
+
type: 'boolean',
|
|
18664
|
+
},
|
|
18665
|
+
is_offline_access_code: {
|
|
18666
|
+
description:
|
|
18667
|
+
'Indicates whether the access code is an [offline access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes).',
|
|
18668
|
+
type: 'boolean',
|
|
18669
|
+
},
|
|
18670
|
+
is_one_time_use: {
|
|
18671
|
+
description:
|
|
18672
|
+
'Indicates whether the [offline access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes) is a single-use access code.',
|
|
18673
|
+
type: 'boolean',
|
|
18674
|
+
},
|
|
17399
18675
|
max_time_rounding: {
|
|
17400
18676
|
default: '1hour',
|
|
18677
|
+
description:
|
|
18678
|
+
'Maximum rounding adjustment. To create a daily-bound [offline access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes) for devices that support this feature, set this parameter to `1d`.',
|
|
17401
18679
|
enum: ['1hour', '1day', '1h', '1d'],
|
|
17402
18680
|
type: 'string',
|
|
17403
18681
|
},
|
|
17404
|
-
name: {
|
|
17405
|
-
|
|
17406
|
-
|
|
17407
|
-
|
|
17408
|
-
|
|
17409
|
-
|
|
17410
|
-
|
|
18682
|
+
name: {
|
|
18683
|
+
description: 'Name of the new access code.',
|
|
18684
|
+
type: 'string',
|
|
18685
|
+
},
|
|
18686
|
+
prefer_native_scheduling: {
|
|
18687
|
+
description:
|
|
18688
|
+
'Indicates whether [native scheduling](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#native-scheduling) should be used for time-bound codes when supported by the provider. Default: `true`.',
|
|
18689
|
+
type: 'boolean',
|
|
18690
|
+
},
|
|
18691
|
+
preferred_code_length: {
|
|
18692
|
+
description:
|
|
18693
|
+
'Preferred code length. Only applicable if you do not specify a `code`. If the affected device does not support the preferred code length, Seam reverts to using the shortest supported code length.',
|
|
18694
|
+
format: 'float',
|
|
18695
|
+
type: 'number',
|
|
18696
|
+
},
|
|
18697
|
+
starts_at: {
|
|
18698
|
+
description:
|
|
18699
|
+
'Date and time at which the validity of the new access code starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.',
|
|
18700
|
+
type: 'string',
|
|
18701
|
+
},
|
|
18702
|
+
sync: {
|
|
18703
|
+
default: false,
|
|
18704
|
+
type: 'boolean',
|
|
18705
|
+
'x-undocumented': 'Only used internally.',
|
|
18706
|
+
},
|
|
18707
|
+
type: {
|
|
18708
|
+
description:
|
|
18709
|
+
'Type to which you want to convert the access code. To convert a time-bound access code to an ongoing access code, set `type` to `ongoing`. See also [Changing a time-bound access code to permanent access](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/modifying-access-codes#special-case-2-changing-a-time-bound-access-code-to-permanent-access).',
|
|
18710
|
+
enum: ['ongoing', 'time_bound'],
|
|
18711
|
+
type: 'string',
|
|
18712
|
+
},
|
|
18713
|
+
use_backup_access_code_pool: {
|
|
18714
|
+
description:
|
|
18715
|
+
'Indicates whether to use a [backup access code pool](https://docs.seam.co/latest/core-concepts/access-codes#backup-access-codes) provided by Seam. If `true`, you can use [`/access_codes/pull_backup_access_code`](https://docs.seam.co/latest/api-clients/access_codes/pull_backup_access_code).',
|
|
18716
|
+
type: 'boolean',
|
|
18717
|
+
},
|
|
17411
18718
|
use_offline_access_code: { type: 'boolean' },
|
|
17412
18719
|
},
|
|
17413
18720
|
required: ['access_code_id'],
|
|
@@ -17448,44 +18755,113 @@ export default {
|
|
|
17448
18755
|
'x-action-attempt-type': 'UPDATE_ACCESS_CODE',
|
|
17449
18756
|
'x-fern-ignore': true,
|
|
17450
18757
|
'x-response-key': null,
|
|
18758
|
+
'x-title': 'Update an Access Code',
|
|
17451
18759
|
},
|
|
17452
18760
|
post: {
|
|
18761
|
+
description:
|
|
18762
|
+
'Updates a specified active or upcoming [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).\n\nSee also [Modifying Access Codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/modifying-access-codes).',
|
|
17453
18763
|
operationId: 'accessCodesUpdatePost',
|
|
17454
18764
|
requestBody: {
|
|
17455
18765
|
content: {
|
|
17456
18766
|
'application/json': {
|
|
17457
18767
|
schema: {
|
|
17458
18768
|
properties: {
|
|
17459
|
-
access_code_id: {
|
|
17460
|
-
|
|
18769
|
+
access_code_id: {
|
|
18770
|
+
description:
|
|
18771
|
+
'ID of the access code that you want to update.',
|
|
18772
|
+
format: 'uuid',
|
|
18773
|
+
type: 'string',
|
|
18774
|
+
},
|
|
18775
|
+
allow_external_modification: {
|
|
18776
|
+
description:
|
|
18777
|
+
'Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`.',
|
|
18778
|
+
type: 'boolean',
|
|
18779
|
+
},
|
|
17461
18780
|
attempt_for_offline_device: {
|
|
17462
18781
|
default: true,
|
|
17463
18782
|
type: 'boolean',
|
|
17464
18783
|
},
|
|
17465
18784
|
code: {
|
|
18785
|
+
description: 'Code to be used for access.',
|
|
17466
18786
|
maxLength: 9,
|
|
17467
18787
|
minLength: 4,
|
|
17468
18788
|
pattern: '^\\d+$',
|
|
17469
18789
|
type: 'string',
|
|
17470
18790
|
},
|
|
17471
|
-
device_id: {
|
|
17472
|
-
|
|
17473
|
-
|
|
17474
|
-
|
|
17475
|
-
|
|
17476
|
-
|
|
18791
|
+
device_id: {
|
|
18792
|
+
description:
|
|
18793
|
+
'ID of the device containing the access code that you want to update.',
|
|
18794
|
+
format: 'uuid',
|
|
18795
|
+
type: 'string',
|
|
18796
|
+
},
|
|
18797
|
+
ends_at: {
|
|
18798
|
+
description:
|
|
18799
|
+
'Date and time at which the validity of the new access code ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`.',
|
|
18800
|
+
type: 'string',
|
|
18801
|
+
},
|
|
18802
|
+
is_external_modification_allowed: {
|
|
18803
|
+
description:
|
|
18804
|
+
'Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`.',
|
|
18805
|
+
type: 'boolean',
|
|
18806
|
+
},
|
|
18807
|
+
is_managed: {
|
|
18808
|
+
description:
|
|
18809
|
+
'Indicates whether the access code is managed through Seam. Note that to convert an unmanaged access code into a managed access code, use `/access_codes/unmanaged/convert_to_managed`.',
|
|
18810
|
+
type: 'boolean',
|
|
18811
|
+
},
|
|
18812
|
+
is_offline_access_code: {
|
|
18813
|
+
description:
|
|
18814
|
+
'Indicates whether the access code is an [offline access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes).',
|
|
18815
|
+
type: 'boolean',
|
|
18816
|
+
},
|
|
18817
|
+
is_one_time_use: {
|
|
18818
|
+
description:
|
|
18819
|
+
'Indicates whether the [offline access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes) is a single-use access code.',
|
|
18820
|
+
type: 'boolean',
|
|
18821
|
+
},
|
|
17477
18822
|
max_time_rounding: {
|
|
17478
18823
|
default: '1hour',
|
|
18824
|
+
description:
|
|
18825
|
+
'Maximum rounding adjustment. To create a daily-bound [offline access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes) for devices that support this feature, set this parameter to `1d`.',
|
|
17479
18826
|
enum: ['1hour', '1day', '1h', '1d'],
|
|
17480
18827
|
type: 'string',
|
|
17481
18828
|
},
|
|
17482
|
-
name: {
|
|
17483
|
-
|
|
17484
|
-
|
|
17485
|
-
|
|
17486
|
-
|
|
17487
|
-
|
|
17488
|
-
|
|
18829
|
+
name: {
|
|
18830
|
+
description: 'Name of the new access code.',
|
|
18831
|
+
type: 'string',
|
|
18832
|
+
},
|
|
18833
|
+
prefer_native_scheduling: {
|
|
18834
|
+
description:
|
|
18835
|
+
'Indicates whether [native scheduling](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#native-scheduling) should be used for time-bound codes when supported by the provider. Default: `true`.',
|
|
18836
|
+
type: 'boolean',
|
|
18837
|
+
},
|
|
18838
|
+
preferred_code_length: {
|
|
18839
|
+
description:
|
|
18840
|
+
'Preferred code length. Only applicable if you do not specify a `code`. If the affected device does not support the preferred code length, Seam reverts to using the shortest supported code length.',
|
|
18841
|
+
format: 'float',
|
|
18842
|
+
type: 'number',
|
|
18843
|
+
},
|
|
18844
|
+
starts_at: {
|
|
18845
|
+
description:
|
|
18846
|
+
'Date and time at which the validity of the new access code starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.',
|
|
18847
|
+
type: 'string',
|
|
18848
|
+
},
|
|
18849
|
+
sync: {
|
|
18850
|
+
default: false,
|
|
18851
|
+
type: 'boolean',
|
|
18852
|
+
'x-undocumented': 'Only used internally.',
|
|
18853
|
+
},
|
|
18854
|
+
type: {
|
|
18855
|
+
description:
|
|
18856
|
+
'Type to which you want to convert the access code. To convert a time-bound access code to an ongoing access code, set `type` to `ongoing`. See also [Changing a time-bound access code to permanent access](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/modifying-access-codes#special-case-2-changing-a-time-bound-access-code-to-permanent-access).',
|
|
18857
|
+
enum: ['ongoing', 'time_bound'],
|
|
18858
|
+
type: 'string',
|
|
18859
|
+
},
|
|
18860
|
+
use_backup_access_code_pool: {
|
|
18861
|
+
description:
|
|
18862
|
+
'Indicates whether to use a [backup access code pool](https://docs.seam.co/latest/core-concepts/access-codes#backup-access-codes) provided by Seam. If `true`, you can use [`/access_codes/pull_backup_access_code`](https://docs.seam.co/latest/api-clients/access_codes/pull_backup_access_code).',
|
|
18863
|
+
type: 'boolean',
|
|
18864
|
+
},
|
|
17489
18865
|
use_offline_access_code: { type: 'boolean' },
|
|
17490
18866
|
},
|
|
17491
18867
|
required: ['access_code_id'],
|
|
@@ -17527,44 +18903,113 @@ export default {
|
|
|
17527
18903
|
'x-fern-sdk-group-name': ['access_codes'],
|
|
17528
18904
|
'x-fern-sdk-method-name': 'update',
|
|
17529
18905
|
'x-response-key': null,
|
|
18906
|
+
'x-title': 'Update an Access Code',
|
|
17530
18907
|
},
|
|
17531
18908
|
put: {
|
|
18909
|
+
description:
|
|
18910
|
+
'Updates a specified active or upcoming [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).\n\nSee also [Modifying Access Codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/modifying-access-codes).',
|
|
17532
18911
|
operationId: 'accessCodesUpdatePut',
|
|
17533
18912
|
requestBody: {
|
|
17534
18913
|
content: {
|
|
17535
18914
|
'application/json': {
|
|
17536
18915
|
schema: {
|
|
17537
18916
|
properties: {
|
|
17538
|
-
access_code_id: {
|
|
17539
|
-
|
|
18917
|
+
access_code_id: {
|
|
18918
|
+
description:
|
|
18919
|
+
'ID of the access code that you want to update.',
|
|
18920
|
+
format: 'uuid',
|
|
18921
|
+
type: 'string',
|
|
18922
|
+
},
|
|
18923
|
+
allow_external_modification: {
|
|
18924
|
+
description:
|
|
18925
|
+
'Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`.',
|
|
18926
|
+
type: 'boolean',
|
|
18927
|
+
},
|
|
17540
18928
|
attempt_for_offline_device: {
|
|
17541
18929
|
default: true,
|
|
17542
18930
|
type: 'boolean',
|
|
17543
18931
|
},
|
|
17544
18932
|
code: {
|
|
18933
|
+
description: 'Code to be used for access.',
|
|
17545
18934
|
maxLength: 9,
|
|
17546
18935
|
minLength: 4,
|
|
17547
18936
|
pattern: '^\\d+$',
|
|
17548
18937
|
type: 'string',
|
|
17549
18938
|
},
|
|
17550
|
-
device_id: {
|
|
17551
|
-
|
|
17552
|
-
|
|
17553
|
-
|
|
17554
|
-
|
|
17555
|
-
|
|
18939
|
+
device_id: {
|
|
18940
|
+
description:
|
|
18941
|
+
'ID of the device containing the access code that you want to update.',
|
|
18942
|
+
format: 'uuid',
|
|
18943
|
+
type: 'string',
|
|
18944
|
+
},
|
|
18945
|
+
ends_at: {
|
|
18946
|
+
description:
|
|
18947
|
+
'Date and time at which the validity of the new access code ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`.',
|
|
18948
|
+
type: 'string',
|
|
18949
|
+
},
|
|
18950
|
+
is_external_modification_allowed: {
|
|
18951
|
+
description:
|
|
18952
|
+
'Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`.',
|
|
18953
|
+
type: 'boolean',
|
|
18954
|
+
},
|
|
18955
|
+
is_managed: {
|
|
18956
|
+
description:
|
|
18957
|
+
'Indicates whether the access code is managed through Seam. Note that to convert an unmanaged access code into a managed access code, use `/access_codes/unmanaged/convert_to_managed`.',
|
|
18958
|
+
type: 'boolean',
|
|
18959
|
+
},
|
|
18960
|
+
is_offline_access_code: {
|
|
18961
|
+
description:
|
|
18962
|
+
'Indicates whether the access code is an [offline access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes).',
|
|
18963
|
+
type: 'boolean',
|
|
18964
|
+
},
|
|
18965
|
+
is_one_time_use: {
|
|
18966
|
+
description:
|
|
18967
|
+
'Indicates whether the [offline access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes) is a single-use access code.',
|
|
18968
|
+
type: 'boolean',
|
|
18969
|
+
},
|
|
17556
18970
|
max_time_rounding: {
|
|
17557
18971
|
default: '1hour',
|
|
18972
|
+
description:
|
|
18973
|
+
'Maximum rounding adjustment. To create a daily-bound [offline access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes) for devices that support this feature, set this parameter to `1d`.',
|
|
17558
18974
|
enum: ['1hour', '1day', '1h', '1d'],
|
|
17559
18975
|
type: 'string',
|
|
17560
18976
|
},
|
|
17561
|
-
name: {
|
|
17562
|
-
|
|
17563
|
-
|
|
17564
|
-
|
|
17565
|
-
|
|
17566
|
-
|
|
17567
|
-
|
|
18977
|
+
name: {
|
|
18978
|
+
description: 'Name of the new access code.',
|
|
18979
|
+
type: 'string',
|
|
18980
|
+
},
|
|
18981
|
+
prefer_native_scheduling: {
|
|
18982
|
+
description:
|
|
18983
|
+
'Indicates whether [native scheduling](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#native-scheduling) should be used for time-bound codes when supported by the provider. Default: `true`.',
|
|
18984
|
+
type: 'boolean',
|
|
18985
|
+
},
|
|
18986
|
+
preferred_code_length: {
|
|
18987
|
+
description:
|
|
18988
|
+
'Preferred code length. Only applicable if you do not specify a `code`. If the affected device does not support the preferred code length, Seam reverts to using the shortest supported code length.',
|
|
18989
|
+
format: 'float',
|
|
18990
|
+
type: 'number',
|
|
18991
|
+
},
|
|
18992
|
+
starts_at: {
|
|
18993
|
+
description:
|
|
18994
|
+
'Date and time at which the validity of the new access code starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.',
|
|
18995
|
+
type: 'string',
|
|
18996
|
+
},
|
|
18997
|
+
sync: {
|
|
18998
|
+
default: false,
|
|
18999
|
+
type: 'boolean',
|
|
19000
|
+
'x-undocumented': 'Only used internally.',
|
|
19001
|
+
},
|
|
19002
|
+
type: {
|
|
19003
|
+
description:
|
|
19004
|
+
'Type to which you want to convert the access code. To convert a time-bound access code to an ongoing access code, set `type` to `ongoing`. See also [Changing a time-bound access code to permanent access](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/modifying-access-codes#special-case-2-changing-a-time-bound-access-code-to-permanent-access).',
|
|
19005
|
+
enum: ['ongoing', 'time_bound'],
|
|
19006
|
+
type: 'string',
|
|
19007
|
+
},
|
|
19008
|
+
use_backup_access_code_pool: {
|
|
19009
|
+
description:
|
|
19010
|
+
'Indicates whether to use a [backup access code pool](https://docs.seam.co/latest/core-concepts/access-codes#backup-access-codes) provided by Seam. If `true`, you can use [`/access_codes/pull_backup_access_code`](https://docs.seam.co/latest/api-clients/access_codes/pull_backup_access_code).',
|
|
19011
|
+
type: 'boolean',
|
|
19012
|
+
},
|
|
17568
19013
|
use_offline_access_code: { type: 'boolean' },
|
|
17569
19014
|
},
|
|
17570
19015
|
required: ['access_code_id'],
|
|
@@ -17605,20 +19050,38 @@ export default {
|
|
|
17605
19050
|
'x-action-attempt-type': 'UPDATE_ACCESS_CODE',
|
|
17606
19051
|
'x-fern-ignore': true,
|
|
17607
19052
|
'x-response-key': null,
|
|
19053
|
+
'x-title': 'Update an Access Code',
|
|
17608
19054
|
},
|
|
17609
19055
|
},
|
|
17610
19056
|
'/access_codes/update_multiple': {
|
|
17611
19057
|
patch: {
|
|
19058
|
+
description:
|
|
19059
|
+
'Updates [access codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) that share a common code across multiple devices.\n\nSpecify the `common_code_key` to identify the set of access codes that you want to update.\n\nSee also [Update Linked Access Codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/creating-and-updating-multiple-linked-access-codes#update-linked-access-codes).',
|
|
17612
19060
|
operationId: 'accessCodesUpdateMultiplePatch',
|
|
17613
19061
|
requestBody: {
|
|
17614
19062
|
content: {
|
|
17615
19063
|
'application/json': {
|
|
17616
19064
|
schema: {
|
|
17617
19065
|
properties: {
|
|
17618
|
-
common_code_key: {
|
|
17619
|
-
|
|
17620
|
-
|
|
17621
|
-
|
|
19066
|
+
common_code_key: {
|
|
19067
|
+
description:
|
|
19068
|
+
'Key that links the group of access codes, assigned on creation by `/access_codes/create_multiple`.',
|
|
19069
|
+
type: 'string',
|
|
19070
|
+
},
|
|
19071
|
+
ends_at: {
|
|
19072
|
+
description:
|
|
19073
|
+
'Date and time at which the validity of the new access code ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`.',
|
|
19074
|
+
type: 'string',
|
|
19075
|
+
},
|
|
19076
|
+
name: {
|
|
19077
|
+
description: 'Name of the new access code.',
|
|
19078
|
+
type: 'string',
|
|
19079
|
+
},
|
|
19080
|
+
starts_at: {
|
|
19081
|
+
description:
|
|
19082
|
+
'Date and time at which the validity of the new access code starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.',
|
|
19083
|
+
type: 'string',
|
|
19084
|
+
},
|
|
17622
19085
|
},
|
|
17623
19086
|
required: ['common_code_key'],
|
|
17624
19087
|
type: 'object',
|
|
@@ -17652,18 +19115,36 @@ export default {
|
|
|
17652
19115
|
tags: ['/access_codes'],
|
|
17653
19116
|
'x-fern-ignore': true,
|
|
17654
19117
|
'x-response-key': null,
|
|
19118
|
+
'x-title': 'Update Multiple Linked Access Codes',
|
|
17655
19119
|
},
|
|
17656
19120
|
post: {
|
|
19121
|
+
description:
|
|
19122
|
+
'Updates [access codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) that share a common code across multiple devices.\n\nSpecify the `common_code_key` to identify the set of access codes that you want to update.\n\nSee also [Update Linked Access Codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/creating-and-updating-multiple-linked-access-codes#update-linked-access-codes).',
|
|
17657
19123
|
operationId: 'accessCodesUpdateMultiplePost',
|
|
17658
19124
|
requestBody: {
|
|
17659
19125
|
content: {
|
|
17660
19126
|
'application/json': {
|
|
17661
19127
|
schema: {
|
|
17662
19128
|
properties: {
|
|
17663
|
-
common_code_key: {
|
|
17664
|
-
|
|
17665
|
-
|
|
17666
|
-
|
|
19129
|
+
common_code_key: {
|
|
19130
|
+
description:
|
|
19131
|
+
'Key that links the group of access codes, assigned on creation by `/access_codes/create_multiple`.',
|
|
19132
|
+
type: 'string',
|
|
19133
|
+
},
|
|
19134
|
+
ends_at: {
|
|
19135
|
+
description:
|
|
19136
|
+
'Date and time at which the validity of the new access code ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`.',
|
|
19137
|
+
type: 'string',
|
|
19138
|
+
},
|
|
19139
|
+
name: {
|
|
19140
|
+
description: 'Name of the new access code.',
|
|
19141
|
+
type: 'string',
|
|
19142
|
+
},
|
|
19143
|
+
starts_at: {
|
|
19144
|
+
description:
|
|
19145
|
+
'Date and time at which the validity of the new access code starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.',
|
|
19146
|
+
type: 'string',
|
|
19147
|
+
},
|
|
17667
19148
|
},
|
|
17668
19149
|
required: ['common_code_key'],
|
|
17669
19150
|
type: 'object',
|
|
@@ -17698,6 +19179,7 @@ export default {
|
|
|
17698
19179
|
'x-fern-sdk-group-name': ['access_codes'],
|
|
17699
19180
|
'x-fern-sdk-method-name': 'update_multiple',
|
|
17700
19181
|
'x-response-key': null,
|
|
19182
|
+
'x-title': 'Update Multiple Linked Access Codes',
|
|
17701
19183
|
},
|
|
17702
19184
|
},
|
|
17703
19185
|
'/acs/access_groups/add_user': {
|