@seamapi/types 1.376.0 → 1.377.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (16) hide show
  1. package/dist/connect.cjs +1579 -385
  2. package/dist/connect.cjs.map +1 -1
  3. package/dist/connect.d.cts +1527 -355
  4. package/lib/seam/connect/models/access-codes/managed-access-code.js +48 -23
  5. package/lib/seam/connect/models/access-codes/managed-access-code.js.map +1 -1
  6. package/lib/seam/connect/models/access-codes/unmanaged-access-code.js +13 -2
  7. package/lib/seam/connect/models/access-codes/unmanaged-access-code.js.map +1 -1
  8. package/lib/seam/connect/openapi.d.ts +201 -2
  9. package/lib/seam/connect/openapi.js +1508 -338
  10. package/lib/seam/connect/openapi.js.map +1 -1
  11. package/lib/seam/connect/route-types.d.ts +1036 -63
  12. package/package.json +1 -1
  13. package/src/lib/seam/connect/models/access-codes/managed-access-code.ts +95 -60
  14. package/src/lib/seam/connect/models/access-codes/unmanaged-access-code.ts +15 -2
  15. package/src/lib/seam/connect/openapi.ts +1850 -350
  16. package/src/lib/seam/connect/route-types.ts +1036 -63
package/lib/seam/connect/openapi.js CHANGED
@@ -2,6 +2,7 @@ export default {
2
2
  components: {
3
3
  schemas: {
4
4
  access_code: {
5
+ description: 'Represents a smart lock [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).\n\nAn access code is a code used for a keypad or pinpad device. Unlike physical keys, which can easily be lost or duplicated, PIN codes can be customized, tracked, and altered on the fly. Using the Seam Access Code API, you can easily generate access codes on the hundreds of door lock models with which we integrate.\n\nSeam supports programming two types of access codes: [ongoing](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#ongoing-access-codes) and [time-bound](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#time-bound-access-codes). To differentiate between the two, refer to the `type` property of the access code. Ongoing codes display as `ongoing`, whereas time-bound codes are labeled `time_bound`.\n\nIn addition, for certain devices, Seam also supports [offline access codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#offline-access-codes). Offline access (PIN) codes are designed for door locks that might not always maintain an internet connection. For this type of access code, the device manufacturer uses encryption keys (tokens) to create server-based registries of algorithmically-generated offline PIN codes. Because the tokens remain synchronized with the managed devices, the locks do not require an active internet connection—and you do not need to be near the locks—to create an offline access code. Then, owners or managers can share these offline codes with users through a variety of mechanisms, such as messaging applications. That is, lock users do not need to install a smartphone application to receive an offline access code.',
5
6
  properties: {
6
7
  access_code_id: {
7
8
  description: 'Unique identifier for the access code.',
@@ -35,21 +36,32 @@ export default {
35
36
  type: 'string',
36
37
  },
37
38
  errors: {
38
- description: 'Collection of errors associated with the access code, structured in a dictionary format. A unique "error_code" keys each error. Each error entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the error. "created_at" is a date that indicates when the error was generated. This structure enables detailed tracking and timely response to critical issues.',
39
+ description: 'Errors associated with the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).',
39
40
  items: {
40
41
  discriminator: { propertyName: 'error_code' },
41
42
  oneOf: [
42
43
  {
43
- description: 'Failed to set code on Smart Things device.',
44
+ description: 'Failed to set code on SmartThings device.',
44
45
  properties: {
45
- created_at: { format: 'date-time', type: 'string' },
46
+ created_at: {
47
+ description: 'Date and time at which Seam created the error.',
48
+ format: 'date-time',
49
+ type: 'string',
50
+ },
46
51
  error_code: {
47
52
  description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
48
53
  enum: ['smartthings_failed_to_set_access_code'],
49
54
  type: 'string',
50
55
  },
51
- is_access_code_error: { enum: [true], type: 'boolean' },
52
- message: { type: 'string' },
56
+ is_access_code_error: {
57
+ description: 'Indicates that this is an access code error.',
58
+ enum: [true],
59
+ type: 'boolean',
60
+ },
61
+ message: {
62
+ description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
63
+ type: 'string',
64
+ },
53
65
  },
54
66
  required: ['message', 'is_access_code_error', 'error_code'],
55
67
  type: 'object',
@@ -57,7 +69,11 @@ export default {
57
69
  {
58
70
  description: 'Failed to set code after multiple retries.',
59
71
  properties: {
60
- created_at: { format: 'date-time', type: 'string' },
72
+ created_at: {
73
+ description: 'Date and time at which Seam created the error.',
74
+ format: 'date-time',
75
+ type: 'string',
76
+ },
61
77
  error_code: {
62
78
  description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
63
79
  enum: [
@@ -65,8 +81,15 @@ export default {
65
81
  ],
66
82
  type: 'string',
67
83
  },
68
- is_access_code_error: { enum: [true], type: 'boolean' },
69
- message: { type: 'string' },
84
+ is_access_code_error: {
85
+ description: 'Indicates that this is an access code error.',
86
+ enum: [true],
87
+ type: 'boolean',
88
+ },
89
+ message: {
90
+ description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
91
+ type: 'string',
92
+ },
70
93
  },
71
94
  required: ['message', 'is_access_code_error', 'error_code'],
72
95
  type: 'object',
@@ -74,14 +97,25 @@ export default {
74
97
  {
75
98
  description: 'No free slots available on the device.',
76
99
  properties: {
77
- created_at: { format: 'date-time', type: 'string' },
100
+ created_at: {
101
+ description: 'Date and time at which Seam created the error.',
102
+ format: 'date-time',
103
+ type: 'string',
104
+ },
78
105
  error_code: {
79
106
  description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
80
107
  enum: ['smartthings_no_free_slots_available'],
81
108
  type: 'string',
82
109
  },
83
- is_access_code_error: { enum: [true], type: 'boolean' },
84
- message: { type: 'string' },
110
+ is_access_code_error: {
111
+ description: 'Indicates that this is an access code error.',
112
+ enum: [true],
113
+ type: 'boolean',
114
+ },
115
+ message: {
116
+ description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
117
+ type: 'string',
118
+ },
85
119
  },
86
120
  required: ['message', 'is_access_code_error', 'error_code'],
87
121
  type: 'object',
@@ -89,14 +123,25 @@ export default {
89
123
  {
90
124
  description: 'Failed to set code on device.',
91
125
  properties: {
92
- created_at: { format: 'date-time', type: 'string' },
126
+ created_at: {
127
+ description: 'Date and time at which Seam created the error.',
128
+ format: 'date-time',
129
+ type: 'string',
130
+ },
93
131
  error_code: {
94
132
  description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
95
133
  enum: ['failed_to_set_on_device'],
96
134
  type: 'string',
97
135
  },
98
- is_access_code_error: { enum: [true], type: 'boolean' },
99
- message: { type: 'string' },
136
+ is_access_code_error: {
137
+ description: 'Indicates that this is an access code error.',
138
+ enum: [true],
139
+ type: 'boolean',
140
+ },
141
+ message: {
142
+ description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
143
+ type: 'string',
144
+ },
100
145
  },
101
146
  required: ['message', 'is_access_code_error', 'error_code'],
102
147
  type: 'object',
@@ -104,14 +149,25 @@ export default {
104
149
  {
105
150
  description: 'Failed to remove code from device.',
106
151
  properties: {
107
- created_at: { format: 'date-time', type: 'string' },
152
+ created_at: {
153
+ description: 'Date and time at which Seam created the error.',
154
+ format: 'date-time',
155
+ type: 'string',
156
+ },
108
157
  error_code: {
109
158
  description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
110
159
  enum: ['failed_to_remove_from_device'],
111
160
  type: 'string',
112
161
  },
113
- is_access_code_error: { enum: [true], type: 'boolean' },
114
- message: { type: 'string' },
162
+ is_access_code_error: {
163
+ description: 'Indicates that this is an access code error.',
164
+ enum: [true],
165
+ type: 'boolean',
166
+ },
167
+ message: {
168
+ description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
169
+ type: 'string',
170
+ },
115
171
  },
116
172
  required: ['message', 'is_access_code_error', 'error_code'],
117
173
  type: 'object',
@@ -119,14 +175,25 @@ export default {
119
175
  {
120
176
  description: 'Duplicate access code detected on device.',
121
177
  properties: {
122
- created_at: { format: 'date-time', type: 'string' },
178
+ created_at: {
179
+ description: 'Date and time at which Seam created the error.',
180
+ format: 'date-time',
181
+ type: 'string',
182
+ },
123
183
  error_code: {
124
184
  description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
125
185
  enum: ['duplicate_code_on_device'],
126
186
  type: 'string',
127
187
  },
128
- is_access_code_error: { enum: [true], type: 'boolean' },
129
- message: { type: 'string' },
188
+ is_access_code_error: {
189
+ description: 'Indicates that this is an access code error.',
190
+ enum: [true],
191
+ type: 'boolean',
192
+ },
193
+ message: {
194
+ description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
195
+ type: 'string',
196
+ },
130
197
  },
131
198
  required: ['message', 'is_access_code_error', 'error_code'],
132
199
  type: 'object',
@@ -134,14 +201,25 @@ export default {
134
201
  {
135
202
  description: 'An attempt to modify this access code was prevented.',
136
203
  properties: {
137
- created_at: { format: 'date-time', type: 'string' },
204
+ created_at: {
205
+ description: 'Date and time at which Seam created the error.',
206
+ format: 'date-time',
207
+ type: 'string',
208
+ },
138
209
  error_code: {
139
210
  description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
140
211
  enum: ['duplicate_code_attempt_prevented'],
141
212
  type: 'string',
142
213
  },
143
- is_access_code_error: { enum: [true], type: 'boolean' },
144
- message: { type: 'string' },
214
+ is_access_code_error: {
215
+ description: 'Indicates that this is an access code error.',
216
+ enum: [true],
217
+ type: 'boolean',
218
+ },
219
+ message: {
220
+ description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
221
+ type: 'string',
222
+ },
145
223
  },
146
224
  required: ['message', 'is_access_code_error', 'error_code'],
147
225
  type: 'object',
@@ -149,14 +227,25 @@ export default {
149
227
  {
150
228
  description: 'Igloohome bridge has too many pending jobs in the queue.',
151
229
  properties: {
152
- created_at: { format: 'date-time', type: 'string' },
230
+ created_at: {
231
+ description: 'Date and time at which Seam created the error.',
232
+ format: 'date-time',
233
+ type: 'string',
234
+ },
153
235
  error_code: {
154
236
  description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
155
237
  enum: ['igloohome_bridge_too_many_pending_jobs'],
156
238
  type: 'string',
157
239
  },
158
- is_access_code_error: { enum: [true], type: 'boolean' },
159
- message: { type: 'string' },
240
+ is_access_code_error: {
241
+ description: 'Indicates that this is an access code error.',
242
+ enum: [true],
243
+ type: 'boolean',
244
+ },
245
+ message: {
246
+ description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
247
+ type: 'string',
248
+ },
160
249
  },
161
250
  required: ['message', 'is_access_code_error', 'error_code'],
162
251
  type: 'object',
@@ -164,22 +253,37 @@ export default {
164
253
  {
165
254
  description: 'Igloohome bridge is offline.',
166
255
  properties: {
167
- created_at: { format: 'date-time', type: 'string' },
256
+ created_at: {
257
+ description: 'Date and time at which Seam created the error.',
258
+ format: 'date-time',
259
+ type: 'string',
260
+ },
168
261
  error_code: {
169
262
  description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
170
263
  enum: ['igloohome_bridge_offline'],
171
264
  type: 'string',
172
265
  },
173
- is_access_code_error: { enum: [true], type: 'boolean' },
174
- message: { type: 'string' },
266
+ is_access_code_error: {
267
+ description: 'Indicates that this is an access code error.',
268
+ enum: [true],
269
+ type: 'boolean',
270
+ },
271
+ message: {
272
+ description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
273
+ type: 'string',
274
+ },
175
275
  },
176
276
  required: ['message', 'is_access_code_error', 'error_code'],
177
277
  type: 'object',
178
278
  },
179
279
  {
180
- description: 'Lock as reached max amount of codes.',
280
+ description: 'Lock has reached maximum amount of codes.',
181
281
  properties: {
182
- created_at: { format: 'date-time', type: 'string' },
282
+ created_at: {
283
+ description: 'Date and time at which Seam created the error.',
284
+ format: 'date-time',
285
+ type: 'string',
286
+ },
183
287
  error_code: {
184
288
  description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
185
289
  enum: [
@@ -187,23 +291,41 @@ export default {
187
291
  ],
188
292
  type: 'string',
189
293
  },
190
- is_access_code_error: { enum: [true], type: 'boolean' },
191
- message: { type: 'string' },
294
+ is_access_code_error: {
295
+ description: 'Indicates that this is an access code error.',
296
+ enum: [true],
297
+ type: 'boolean',
298
+ },
299
+ message: {
300
+ description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
301
+ type: 'string',
302
+ },
192
303
  },
193
304
  required: ['message', 'is_access_code_error', 'error_code'],
194
305
  type: 'object',
195
306
  },
196
307
  {
197
- description: 'Unable to confirm the access code is set on Kwikset device.',
308
+ description: 'Unable to confirm that the access code is set on Kwikset device.',
198
309
  properties: {
199
- created_at: { format: 'date-time', type: 'string' },
310
+ created_at: {
311
+ description: 'Date and time at which Seam created the error.',
312
+ format: 'date-time',
313
+ type: 'string',
314
+ },
200
315
  error_code: {
201
316
  description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
202
317
  enum: ['kwikset_unable_to_confirm_code'],
203
318
  type: 'string',
204
319
  },
205
- is_access_code_error: { enum: [true], type: 'boolean' },
206
- message: { type: 'string' },
320
+ is_access_code_error: {
321
+ description: 'Indicates that this is an access code error.',
322
+ enum: [true],
323
+ type: 'boolean',
324
+ },
325
+ message: {
326
+ description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
327
+ type: 'string',
328
+ },
207
329
  },
208
330
  required: ['message', 'is_access_code_error', 'error_code'],
209
331
  type: 'object',
@@ -211,14 +333,25 @@ export default {
211
333
  {
212
334
  description: 'Unable to confirm the deletion of the access code on Kwikset device.',
213
335
  properties: {
214
- created_at: { format: 'date-time', type: 'string' },
336
+ created_at: {
337
+ description: 'Date and time at which Seam created the error.',
338
+ format: 'date-time',
339
+ type: 'string',
340
+ },
215
341
  error_code: {
216
342
  description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
217
343
  enum: ['kwikset_unable_to_confirm_deletion'],
218
344
  type: 'string',
219
345
  },
220
- is_access_code_error: { enum: [true], type: 'boolean' },
221
- message: { type: 'string' },
346
+ is_access_code_error: {
347
+ description: 'Indicates that this is an access code error.',
348
+ enum: [true],
349
+ type: 'boolean',
350
+ },
351
+ message: {
352
+ description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
353
+ type: 'string',
354
+ },
222
355
  },
223
356
  required: ['message', 'is_access_code_error', 'error_code'],
224
357
  type: 'object',
@@ -226,14 +359,25 @@ export default {
226
359
  {
227
360
  description: 'Code was modified or removed externally after Seam successfully set it on the device.',
228
361
  properties: {
229
- created_at: { format: 'date-time', type: 'string' },
362
+ created_at: {
363
+ description: 'Date and time at which Seam created the error.',
364
+ format: 'date-time',
365
+ type: 'string',
366
+ },
230
367
  error_code: {
231
368
  description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
232
369
  enum: ['code_modified_external_to_seam'],
233
370
  type: 'string',
234
371
  },
235
- is_access_code_error: { enum: [true], type: 'boolean' },
236
- message: { type: 'string' },
372
+ is_access_code_error: {
373
+ description: 'Indicates that this is an access code error.',
374
+ enum: [true],
375
+ type: 'boolean',
376
+ },
377
+ message: {
378
+ description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
379
+ type: 'string',
380
+ },
237
381
  },
238
382
  required: ['message', 'is_access_code_error', 'error_code'],
239
383
  type: 'object',
@@ -241,14 +385,25 @@ export default {
241
385
  {
242
386
  description: 'Invalid code length for August lock.',
243
387
  properties: {
244
- created_at: { format: 'date-time', type: 'string' },
388
+ created_at: {
389
+ description: 'Date and time at which Seam created the error.',
390
+ format: 'date-time',
391
+ type: 'string',
392
+ },
245
393
  error_code: {
246
394
  description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
247
395
  enum: ['august_lock_invalid_code_length'],
248
396
  type: 'string',
249
397
  },
250
- is_access_code_error: { enum: [true], type: 'boolean' },
251
- message: { type: 'string' },
398
+ is_access_code_error: {
399
+ description: 'Indicates that this is an access code error.',
400
+ enum: [true],
401
+ type: 'boolean',
402
+ },
403
+ message: {
404
+ description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
405
+ type: 'string',
406
+ },
252
407
  },
253
408
  required: ['message', 'is_access_code_error', 'error_code'],
254
409
  type: 'object',
@@ -256,14 +411,25 @@ export default {
256
411
  {
257
412
  description: 'Access code has not yet been fully moved to the device.',
258
413
  properties: {
259
- created_at: { format: 'date-time', type: 'string' },
414
+ created_at: {
415
+ description: 'Date and time at which Seam created the error.',
416
+ format: 'date-time',
417
+ type: 'string',
418
+ },
260
419
  error_code: {
261
420
  description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
262
421
  enum: ['august_device_programming_delay'],
263
422
  type: 'string',
264
423
  },
265
- is_access_code_error: { enum: [true], type: 'boolean' },
266
- message: { type: 'string' },
424
+ is_access_code_error: {
425
+ description: 'Indicates that this is an access code error.',
426
+ enum: [true],
427
+ type: 'boolean',
428
+ },
429
+ message: {
430
+ description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
431
+ type: 'string',
432
+ },
267
433
  },
268
434
  required: ['message', 'is_access_code_error', 'error_code'],
269
435
  type: 'object',
@@ -271,14 +437,25 @@ export default {
271
437
  {
272
438
  description: 'All access code slots on the device are full.',
273
439
  properties: {
274
- created_at: { format: 'date-time', type: 'string' },
440
+ created_at: {
441
+ description: 'Date and time at which Seam created the error.',
442
+ format: 'date-time',
443
+ type: 'string',
444
+ },
275
445
  error_code: {
276
446
  description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
277
447
  enum: ['august_device_slots_full'],
278
448
  type: 'string',
279
449
  },
280
- is_access_code_error: { enum: [true], type: 'boolean' },
281
- message: { type: 'string' },
450
+ is_access_code_error: {
451
+ description: 'Indicates that this is an access code error.',
452
+ enum: [true],
453
+ type: 'boolean',
454
+ },
455
+ message: {
456
+ description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
457
+ type: 'string',
458
+ },
282
459
  },
283
460
  required: ['message', 'is_access_code_error', 'error_code'],
284
461
  type: 'object',
@@ -286,14 +463,25 @@ export default {
286
463
  {
287
464
  description: 'August lock is missing a keypad.',
288
465
  properties: {
289
- created_at: { format: 'date-time', type: 'string' },
466
+ created_at: {
467
+ description: 'Date and time at which Seam created the error.',
468
+ format: 'date-time',
469
+ type: 'string',
470
+ },
290
471
  error_code: {
291
472
  description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
292
473
  enum: ['august_lock_missing_keypad'],
293
474
  type: 'string',
294
475
  },
295
- is_access_code_error: { enum: [true], type: 'boolean' },
296
- message: { type: 'string' },
476
+ is_access_code_error: {
477
+ description: 'Indicates that this is an access code error.',
478
+ enum: [true],
479
+ type: 'boolean',
480
+ },
481
+ message: {
482
+ description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
483
+ type: 'string',
484
+ },
297
485
  },
298
486
  required: ['message', 'is_access_code_error', 'error_code'],
299
487
  type: 'object',
@@ -301,14 +489,25 @@ export default {
301
489
  {
302
490
  description: 'August lock is temporarily offline.',
303
491
  properties: {
304
- created_at: { format: 'date-time', type: 'string' },
492
+ created_at: {
493
+ description: 'Date and time at which Seam created the error.',
494
+ format: 'date-time',
495
+ type: 'string',
496
+ },
305
497
  error_code: {
306
498
  description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
307
499
  enum: ['august_lock_temporarily_offline'],
308
500
  type: 'string',
309
501
  },
310
- is_access_code_error: { enum: [true], type: 'boolean' },
311
- message: { type: 'string' },
502
+ is_access_code_error: {
503
+ description: 'Indicates that this is an access code error.',
504
+ enum: [true],
505
+ type: 'boolean',
506
+ },
507
+ message: {
508
+ description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
509
+ type: 'string',
510
+ },
312
511
  },
313
512
  required: ['message', 'is_access_code_error', 'error_code'],
314
513
  type: 'object',
@@ -316,14 +515,25 @@ export default {
316
515
  {
317
516
  description: 'Salto site user is not subscribed.',
318
517
  properties: {
319
- created_at: { format: 'date-time', type: 'string' },
518
+ created_at: {
519
+ description: 'Date and time at which Seam created the error.',
520
+ format: 'date-time',
521
+ type: 'string',
522
+ },
320
523
  error_code: {
321
524
  description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
322
525
  enum: ['salto_ks_user_not_subscribed'],
323
526
  type: 'string',
324
527
  },
325
- is_access_code_error: { enum: [true], type: 'boolean' },
326
- message: { type: 'string' },
528
+ is_access_code_error: {
529
+ description: 'Indicates that this is an access code error.',
530
+ enum: [true],
531
+ type: 'boolean',
532
+ },
533
+ message: {
534
+ description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
535
+ type: 'string',
536
+ },
327
537
  },
328
538
  required: ['message', 'is_access_code_error', 'error_code'],
329
539
  type: 'object',
@@ -331,14 +541,25 @@ export default {
331
541
  {
332
542
  description: 'Access code has not yet been fully moved to the device.',
333
543
  properties: {
334
- created_at: { format: 'date-time', type: 'string' },
544
+ created_at: {
545
+ description: 'Date and time at which Seam created the error.',
546
+ format: 'date-time',
547
+ type: 'string',
548
+ },
335
549
  error_code: {
336
550
  description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
337
551
  enum: ['hubitat_device_programming_delay'],
338
552
  type: 'string',
339
553
  },
340
- is_access_code_error: { enum: [true], type: 'boolean' },
341
- message: { type: 'string' },
554
+ is_access_code_error: {
555
+ description: 'Indicates that this is an access code error.',
556
+ enum: [true],
557
+ type: 'boolean',
558
+ },
559
+ message: {
560
+ description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
561
+ type: 'string',
562
+ },
342
563
  },
343
564
  required: ['message', 'is_access_code_error', 'error_code'],
344
565
  type: 'object',
@@ -346,14 +567,25 @@ export default {
346
567
  {
347
568
  description: 'No free positions available on the device.',
348
569
  properties: {
349
- created_at: { format: 'date-time', type: 'string' },
570
+ created_at: {
571
+ description: 'Date and time at which Seam created the error.',
572
+ format: 'date-time',
573
+ type: 'string',
574
+ },
350
575
  error_code: {
351
576
  description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
352
577
  enum: ['hubitat_no_free_positions_available'],
353
578
  type: 'string',
354
579
  },
355
- is_access_code_error: { enum: [true], type: 'boolean' },
356
- message: { type: 'string' },
580
+ is_access_code_error: {
581
+ description: 'Indicates that this is an access code error.',
582
+ enum: [true],
583
+ type: 'boolean',
584
+ },
585
+ message: {
586
+ description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
587
+ type: 'string',
588
+ },
357
589
  },
358
590
  required: ['message', 'is_access_code_error', 'error_code'],
359
591
  type: 'object',
@@ -361,14 +593,25 @@ export default {
361
593
  {
362
594
  description: 'Duplicate access code name detected.',
363
595
  properties: {
364
- created_at: { format: 'date-time', type: 'string' },
596
+ created_at: {
597
+ description: 'Date and time at which Seam created the error.',
598
+ format: 'date-time',
599
+ type: 'string',
600
+ },
365
601
  error_code: {
366
602
  description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
367
603
  enum: ['wyze_duplicate_code_name'],
368
604
  type: 'string',
369
605
  },
370
- is_access_code_error: { enum: [true], type: 'boolean' },
371
- message: { type: 'string' },
606
+ is_access_code_error: {
607
+ description: 'Indicates that this is an access code error.',
608
+ enum: [true],
609
+ type: 'boolean',
610
+ },
611
+ message: {
612
+ description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
613
+ type: 'string',
614
+ },
372
615
  },
373
616
  required: ['message', 'is_access_code_error', 'error_code'],
374
617
  type: 'object',
@@ -376,14 +619,25 @@ export default {
376
619
  {
377
620
  description: 'Potential duplicate access code detected.',
378
621
  properties: {
379
- created_at: { format: 'date-time', type: 'string' },
622
+ created_at: {
623
+ description: 'Date and time at which Seam created the error.',
624
+ format: 'date-time',
625
+ type: 'string',
626
+ },
380
627
  error_code: {
381
628
  description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
382
629
  enum: ['wyze_potential_duplicate_code'],
383
630
  type: 'string',
384
631
  },
385
- is_access_code_error: { enum: [true], type: 'boolean' },
386
- message: { type: 'string' },
632
+ is_access_code_error: {
633
+ description: 'Indicates that this is an access code error.',
634
+ enum: [true],
635
+ type: 'boolean',
636
+ },
637
+ message: {
638
+ description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
639
+ type: 'string',
640
+ },
387
641
  },
388
642
  required: ['message', 'is_access_code_error', 'error_code'],
389
643
  type: 'object',
@@ -391,14 +645,25 @@ export default {
391
645
  {
392
646
  description: 'No valid user level for Oracode.',
393
647
  properties: {
394
- created_at: { format: 'date-time', type: 'string' },
648
+ created_at: {
649
+ description: 'Date and time at which Seam created the error.',
650
+ format: 'date-time',
651
+ type: 'string',
652
+ },
395
653
  error_code: {
396
654
  description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
397
655
  enum: ['dormakaba_oracode_no_valid_user_level'],
398
656
  type: 'string',
399
657
  },
400
- is_access_code_error: { enum: [true], type: 'boolean' },
401
- message: { type: 'string' },
658
+ is_access_code_error: {
659
+ description: 'Indicates that this is an access code error.',
660
+ enum: [true],
661
+ type: 'boolean',
662
+ },
663
+ message: {
664
+ description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
665
+ type: 'string',
666
+ },
402
667
  },
403
668
  required: ['message', 'is_access_code_error', 'error_code'],
404
669
  type: 'object',
@@ -735,11 +1000,11 @@ export default {
735
1000
  type: 'boolean',
736
1001
  },
737
1002
  is_offline_access_code: {
738
- description: 'Indicates whether the access code is intended for use in offline scenarios. If "true," this code can be created on a device without a network connection.',
1003
+ description: 'Indicates whether the access code is intended for use in offline scenarios. If `true`, this code can be created on a device without a network connection.',
739
1004
  type: 'boolean',
740
1005
  },
741
1006
  is_one_time_use: {
742
- description: 'Indicates whether the access code can only be used once. If "true," the code becomes invalid after the first use.',
1007
+ description: 'Indicates whether the access code can only be used once. If `true`, the code becomes invalid after the first use.',
743
1008
  type: 'boolean',
744
1009
  },
745
1010
  is_scheduled_on_device: {
@@ -768,25 +1033,33 @@ export default {
768
1033
  type: 'string',
769
1034
  },
770
1035
  status: {
771
- description: '\n 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.\n ',
1036
+ description: 'Current status of the access code within the operational lifecycle. Values are `setting`, a transitional phase that indicates that the code is being configured or activated; `set`, which indicates that the code is active and operational; `unset`, which indicates a deactivated or unused state, either before activation or after deliberate deactivation; `removing`, which indicates a transitional period in which the code is being deleted or made inactive; and `unknown`, which indicates an indeterminate state, due to reasons such as system errors or incomplete data, that highlights a potential need for system review or troubleshooting.',
772
1037
  enum: ['setting', 'set', 'unset', 'removing', 'unknown'],
773
1038
  type: 'string',
774
1039
  },
775
1040
  type: {
776
- description: 'Nature of the access code. Values are "ongoing" for access codes that are active continuously until deactivated manually or "time_bound" for access codes that have a specific duration.',
1041
+ description: 'Nature of the access code. Values are `ongoing` for access codes that are active continuously until deactivated manually or `time_bound` for access codes that have a specific duration.',
777
1042
  enum: ['time_bound', 'ongoing'],
778
1043
  type: 'string',
779
1044
  },
780
1045
  warnings: {
781
- description: 'Collection of warnings associated with the access code, structured in a dictionary format. A unique "warning_code" keys each warning. Each warning entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the warning. "created_at" is a date that indicates when the warning was generated. This structure enables detailed tracking and timely response to potential issues that are not critical but that may require attention.',
1046
+ description: 'Warnings associated with the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).',
782
1047
  items: {
1048
+ description: 'Warnings associated with the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).',
783
1049
  discriminator: { propertyName: 'warning_code' },
784
1050
  oneOf: [
785
1051
  {
786
- description: 'Failed to set code on Smart Things device.',
1052
+ description: 'Failed to set code on SmartThings device.',
787
1053
  properties: {
788
- created_at: { format: 'date-time', type: 'string' },
789
- message: { type: 'string' },
1054
+ created_at: {
1055
+ description: 'Date and time at which Seam created the warning.',
1056
+ format: 'date-time',
1057
+ type: 'string',
1058
+ },
1059
+ message: {
1060
+ description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
1061
+ type: 'string',
1062
+ },
790
1063
  warning_code: {
791
1064
  description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
792
1065
  enum: ['smartthings_failed_to_set_access_code'],
@@ -799,8 +1072,15 @@ export default {
799
1072
  {
800
1073
  description: 'Duplicate access code detected.',
801
1074
  properties: {
802
- created_at: { format: 'date-time', type: 'string' },
803
- message: { type: 'string' },
1075
+ created_at: {
1076
+ description: 'Date and time at which Seam created the warning.',
1077
+ format: 'date-time',
1078
+ type: 'string',
1079
+ },
1080
+ message: {
1081
+ description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
1082
+ type: 'string',
1083
+ },
804
1084
  warning_code: {
805
1085
  description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
806
1086
  enum: ['schlage_detected_duplicate'],
@@ -813,8 +1093,15 @@ export default {
813
1093
  {
814
1094
  description: 'Received an error when attempting to create this code.',
815
1095
  properties: {
816
- created_at: { format: 'date-time', type: 'string' },
817
- message: { type: 'string' },
1096
+ created_at: {
1097
+ description: 'Date and time at which Seam created the warning.',
1098
+ format: 'date-time',
1099
+ type: 'string',
1100
+ },
1101
+ message: {
1102
+ description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
1103
+ type: 'string',
1104
+ },
818
1105
  warning_code: {
819
1106
  description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
820
1107
  enum: ['schlage_creation_outage'],
@@ -827,8 +1114,15 @@ export default {
827
1114
  {
828
1115
  description: 'Code was modified or removed externally after Seam successfully set it on the device.',
829
1116
  properties: {
830
- created_at: { format: 'date-time', type: 'string' },
831
- message: { type: 'string' },
1117
+ created_at: {
1118
+ description: 'Date and time at which Seam created the warning.',
1119
+ format: 'date-time',
1120
+ type: 'string',
1121
+ },
1122
+ message: {
1123
+ description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
1124
+ type: 'string',
1125
+ },
832
1126
  warning_code: {
833
1127
  description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
834
1128
  enum: ['code_modified_external_to_seam'],
@@ -841,8 +1135,15 @@ export default {
841
1135
  {
842
1136
  description: 'Delay in setting code on device.',
843
1137
  properties: {
844
- created_at: { format: 'date-time', type: 'string' },
845
- message: { type: 'string' },
1138
+ created_at: {
1139
+ description: 'Date and time at which Seam created the warning.',
1140
+ format: 'date-time',
1141
+ type: 'string',
1142
+ },
1143
+ message: {
1144
+ description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
1145
+ type: 'string',
1146
+ },
846
1147
  warning_code: {
847
1148
  description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
848
1149
  enum: ['delay_in_setting_on_device'],
@@ -855,8 +1156,15 @@ export default {
855
1156
  {
856
1157
  description: 'Delay in removing code from device.',
857
1158
  properties: {
858
- created_at: { format: 'date-time', type: 'string' },
859
- message: { type: 'string' },
1159
+ created_at: {
1160
+ description: 'Date and time at which Seam created the warning.',
1161
+ format: 'date-time',
1162
+ type: 'string',
1163
+ },
1164
+ message: {
1165
+ description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
1166
+ type: 'string',
1167
+ },
860
1168
  warning_code: {
861
1169
  description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
862
1170
  enum: ['delay_in_removing_from_device'],
@@ -867,10 +1175,17 @@ export default {
867
1175
  type: 'object',
868
1176
  },
869
1177
  {
870
- description: 'Third party integration detected that may cause access codes to fail.',
1178
+ description: 'Third-party integration detected that may cause access codes to fail.',
871
1179
  properties: {
872
- created_at: { format: 'date-time', type: 'string' },
873
- message: { type: 'string' },
1180
+ created_at: {
1181
+ description: 'Date and time at which Seam created the warning.',
1182
+ format: 'date-time',
1183
+ type: 'string',
1184
+ },
1185
+ message: {
1186
+ description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
1187
+ type: 'string',
1188
+ },
874
1189
  warning_code: {
875
1190
  description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
876
1191
  enum: ['third_party_integration_detected'],
@@ -883,8 +1198,15 @@ export default {
883
1198
  {
884
1199
  description: 'Access code has not yet been fully moved to the device.',
885
1200
  properties: {
886
- created_at: { format: 'date-time', type: 'string' },
887
- message: { type: 'string' },
1201
+ created_at: {
1202
+ description: 'Date and time at which Seam created the warning.',
1203
+ format: 'date-time',
1204
+ type: 'string',
1205
+ },
1206
+ message: {
1207
+ description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
1208
+ type: 'string',
1209
+ },
888
1210
  warning_code: {
889
1211
  description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
890
1212
  enum: ['august_device_programming_delay'],
@@ -897,8 +1219,15 @@ export default {
897
1219
  {
898
1220
  description: 'August lock is temporarily offline.',
899
1221
  properties: {
900
- created_at: { format: 'date-time', type: 'string' },
901
- message: { type: 'string' },
1222
+ created_at: {
1223
+ description: 'Date and time at which Seam created the warning.',
1224
+ format: 'date-time',
1225
+ type: 'string',
1226
+ },
1227
+ message: {
1228
+ description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
1229
+ type: 'string',
1230
+ },
902
1231
  warning_code: {
903
1232
  description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
904
1233
  enum: ['august_lock_temporarily_offline'],
@@ -911,8 +1240,15 @@ export default {
911
1240
  {
912
1241
  description: 'Algopins must be used within 24 hours.',
913
1242
  properties: {
914
- created_at: { format: 'date-time', type: 'string' },
915
- message: { type: 'string' },
1243
+ created_at: {
1244
+ description: 'Date and time at which Seam created the warning.',
1245
+ format: 'date-time',
1246
+ type: 'string',
1247
+ },
1248
+ message: {
1249
+ description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
1250
+ type: 'string',
1251
+ },
916
1252
  warning_code: {
917
1253
  description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
918
1254
  enum: ['igloo_algopin_must_be_used_within_24_hours'],
@@ -925,8 +1261,15 @@ export default {
925
1261
  {
926
1262
  description: 'Management was transferred to another workspace.',
927
1263
  properties: {
928
- created_at: { format: 'date-time', type: 'string' },
929
- message: { type: 'string' },
1264
+ created_at: {
1265
+ description: 'Date and time at which Seam created the warning.',
1266
+ format: 'date-time',
1267
+ type: 'string',
1268
+ },
1269
+ message: {
1270
+ description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
1271
+ type: 'string',
1272
+ },
930
1273
  warning_code: {
931
1274
  description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
932
1275
  enum: ['management_transferred'],
@@ -937,10 +1280,17 @@ export default {
937
1280
  type: 'object',
938
1281
  },
939
1282
  {
940
- description: 'Unable to confirm the access code is set on Kwikset device.',
1283
+ description: 'Unable to confirm that the access code is set on Kwikset device.',
941
1284
  properties: {
942
- created_at: { format: 'date-time', type: 'string' },
943
- message: { type: 'string' },
1285
+ created_at: {
1286
+ description: 'Date and time at which Seam created the warning.',
1287
+ format: 'date-time',
1288
+ type: 'string',
1289
+ },
1290
+ message: {
1291
+ description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
1292
+ type: 'string',
1293
+ },
944
1294
  warning_code: {
945
1295
  description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
946
1296
  enum: ['kwikset_unable_to_confirm_code'],
@@ -12341,6 +12691,7 @@ export default {
12341
12691
  'x-route-path': '/thermostats/schedules',
12342
12692
  },
12343
12693
  unmanaged_access_code: {
12694
+ description: 'Represents an [unmanaged smart lock access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes).\n\nAn access code is a code used for a keypad or pinpad device. Unlike physical keys, which can easily be lost or duplicated, PIN codes can be customized, tracked, and altered on the fly.\n\nWhen you create an access code on a device in Seam, it is created as a managed access code. Access codes that exist on a device that were not created through Seam are considered unmanaged codes. We strictly limit the operations that can be performed on unmanaged codes.\n\nPrior to using Seam to manage your devices, you may have used another lock management system to manage the access codes on your devices. Where possible, we help you keep any existing access codes on devices and transition those codes to ones managed by your Seam workspace.',
12344
12695
  properties: {
12345
12696
  access_code_id: {
12346
12697
  description: 'Unique identifier for the access code.',
@@ -12369,21 +12720,32 @@ export default {
12369
12720
  type: 'string',
12370
12721
  },
12371
12722
  errors: {
12372
- description: 'Collection of errors associated with the access code, structured in a dictionary format. A unique "error_code" keys each error. Each error entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the error. "created_at" is a date that indicates when the error was generated. This structure enables detailed tracking and timely response to critical issues.',
12723
+ description: 'Errors associated with the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).',
12373
12724
  items: {
12374
12725
  discriminator: { propertyName: 'error_code' },
12375
12726
  oneOf: [
12376
12727
  {
12377
- description: 'Failed to set code on Smart Things device.',
12728
+ description: 'Failed to set code on SmartThings device.',
12378
12729
  properties: {
12379
- created_at: { format: 'date-time', type: 'string' },
12730
+ created_at: {
12731
+ description: 'Date and time at which Seam created the error.',
12732
+ format: 'date-time',
12733
+ type: 'string',
12734
+ },
12380
12735
  error_code: {
12381
12736
  description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
12382
12737
  enum: ['smartthings_failed_to_set_access_code'],
12383
12738
  type: 'string',
12384
12739
  },
12385
- is_access_code_error: { enum: [true], type: 'boolean' },
12386
- message: { type: 'string' },
12740
+ is_access_code_error: {
12741
+ description: 'Indicates that this is an access code error.',
12742
+ enum: [true],
12743
+ type: 'boolean',
12744
+ },
12745
+ message: {
12746
+ description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
12747
+ type: 'string',
12748
+ },
12387
12749
  },
12388
12750
  required: ['message', 'is_access_code_error', 'error_code'],
12389
12751
  type: 'object',
@@ -12391,7 +12753,11 @@ export default {
12391
12753
  {
12392
12754
  description: 'Failed to set code after multiple retries.',
12393
12755
  properties: {
12394
- created_at: { format: 'date-time', type: 'string' },
12756
+ created_at: {
12757
+ description: 'Date and time at which Seam created the error.',
12758
+ format: 'date-time',
12759
+ type: 'string',
12760
+ },
12395
12761
  error_code: {
12396
12762
  description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
12397
12763
  enum: [
@@ -12399,8 +12765,15 @@ export default {
12399
12765
  ],
12400
12766
  type: 'string',
12401
12767
  },
12402
- is_access_code_error: { enum: [true], type: 'boolean' },
12403
- message: { type: 'string' },
12768
+ is_access_code_error: {
12769
+ description: 'Indicates that this is an access code error.',
12770
+ enum: [true],
12771
+ type: 'boolean',
12772
+ },
12773
+ message: {
12774
+ description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
12775
+ type: 'string',
12776
+ },
12404
12777
  },
12405
12778
  required: ['message', 'is_access_code_error', 'error_code'],
12406
12779
  type: 'object',
@@ -12408,14 +12781,25 @@ export default {
12408
12781
  {
12409
12782
  description: 'No free slots available on the device.',
12410
12783
  properties: {
12411
- created_at: { format: 'date-time', type: 'string' },
12784
+ created_at: {
12785
+ description: 'Date and time at which Seam created the error.',
12786
+ format: 'date-time',
12787
+ type: 'string',
12788
+ },
12412
12789
  error_code: {
12413
12790
  description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
12414
12791
  enum: ['smartthings_no_free_slots_available'],
12415
12792
  type: 'string',
12416
12793
  },
12417
- is_access_code_error: { enum: [true], type: 'boolean' },
12418
- message: { type: 'string' },
12794
+ is_access_code_error: {
12795
+ description: 'Indicates that this is an access code error.',
12796
+ enum: [true],
12797
+ type: 'boolean',
12798
+ },
12799
+ message: {
12800
+ description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
12801
+ type: 'string',
12802
+ },
12419
12803
  },
12420
12804
  required: ['message', 'is_access_code_error', 'error_code'],
12421
12805
  type: 'object',
@@ -12423,14 +12807,25 @@ export default {
12423
12807
  {
12424
12808
  description: 'Failed to set code on device.',
12425
12809
  properties: {
12426
- created_at: { format: 'date-time', type: 'string' },
12810
+ created_at: {
12811
+ description: 'Date and time at which Seam created the error.',
12812
+ format: 'date-time',
12813
+ type: 'string',
12814
+ },
12427
12815
  error_code: {
12428
12816
  description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
12429
12817
  enum: ['failed_to_set_on_device'],
12430
12818
  type: 'string',
12431
12819
  },
12432
- is_access_code_error: { enum: [true], type: 'boolean' },
12433
- message: { type: 'string' },
12820
+ is_access_code_error: {
12821
+ description: 'Indicates that this is an access code error.',
12822
+ enum: [true],
12823
+ type: 'boolean',
12824
+ },
12825
+ message: {
12826
+ description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
12827
+ type: 'string',
12828
+ },
12434
12829
  },
12435
12830
  required: ['message', 'is_access_code_error', 'error_code'],
12436
12831
  type: 'object',
@@ -12438,14 +12833,25 @@ export default {
12438
12833
  {
12439
12834
  description: 'Failed to remove code from device.',
12440
12835
  properties: {
12441
- created_at: { format: 'date-time', type: 'string' },
12836
+ created_at: {
12837
+ description: 'Date and time at which Seam created the error.',
12838
+ format: 'date-time',
12839
+ type: 'string',
12840
+ },
12442
12841
  error_code: {
12443
12842
  description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
12444
12843
  enum: ['failed_to_remove_from_device'],
12445
12844
  type: 'string',
12446
12845
  },
12447
- is_access_code_error: { enum: [true], type: 'boolean' },
12448
- message: { type: 'string' },
12846
+ is_access_code_error: {
12847
+ description: 'Indicates that this is an access code error.',
12848
+ enum: [true],
12849
+ type: 'boolean',
12850
+ },
12851
+ message: {
12852
+ description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
12853
+ type: 'string',
12854
+ },
12449
12855
  },
12450
12856
  required: ['message', 'is_access_code_error', 'error_code'],
12451
12857
  type: 'object',
@@ -12453,14 +12859,25 @@ export default {
12453
12859
  {
12454
12860
  description: 'Duplicate access code detected on device.',
12455
12861
  properties: {
12456
- created_at: { format: 'date-time', type: 'string' },
12862
+ created_at: {
12863
+ description: 'Date and time at which Seam created the error.',
12864
+ format: 'date-time',
12865
+ type: 'string',
12866
+ },
12457
12867
  error_code: {
12458
12868
  description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
12459
12869
  enum: ['duplicate_code_on_device'],
12460
12870
  type: 'string',
12461
12871
  },
12462
- is_access_code_error: { enum: [true], type: 'boolean' },
12463
- message: { type: 'string' },
12872
+ is_access_code_error: {
12873
+ description: 'Indicates that this is an access code error.',
12874
+ enum: [true],
12875
+ type: 'boolean',
12876
+ },
12877
+ message: {
12878
+ description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
12879
+ type: 'string',
12880
+ },
12464
12881
  },
12465
12882
  required: ['message', 'is_access_code_error', 'error_code'],
12466
12883
  type: 'object',
@@ -12468,14 +12885,25 @@ export default {
12468
12885
  {
12469
12886
  description: 'An attempt to modify this access code was prevented.',
12470
12887
  properties: {
12471
- created_at: { format: 'date-time', type: 'string' },
12888
+ created_at: {
12889
+ description: 'Date and time at which Seam created the error.',
12890
+ format: 'date-time',
12891
+ type: 'string',
12892
+ },
12472
12893
  error_code: {
12473
12894
  description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
12474
12895
  enum: ['duplicate_code_attempt_prevented'],
12475
12896
  type: 'string',
12476
12897
  },
12477
- is_access_code_error: { enum: [true], type: 'boolean' },
12478
- message: { type: 'string' },
12898
+ is_access_code_error: {
12899
+ description: 'Indicates that this is an access code error.',
12900
+ enum: [true],
12901
+ type: 'boolean',
12902
+ },
12903
+ message: {
12904
+ description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
12905
+ type: 'string',
12906
+ },
12479
12907
  },
12480
12908
  required: ['message', 'is_access_code_error', 'error_code'],
12481
12909
  type: 'object',
@@ -12483,14 +12911,25 @@ export default {
12483
12911
  {
12484
12912
  description: 'Igloohome bridge has too many pending jobs in the queue.',
12485
12913
  properties: {
12486
- created_at: { format: 'date-time', type: 'string' },
12914
+ created_at: {
12915
+ description: 'Date and time at which Seam created the error.',
12916
+ format: 'date-time',
12917
+ type: 'string',
12918
+ },
12487
12919
  error_code: {
12488
12920
  description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
12489
12921
  enum: ['igloohome_bridge_too_many_pending_jobs'],
12490
12922
  type: 'string',
12491
12923
  },
12492
- is_access_code_error: { enum: [true], type: 'boolean' },
12493
- message: { type: 'string' },
12924
+ is_access_code_error: {
12925
+ description: 'Indicates that this is an access code error.',
12926
+ enum: [true],
12927
+ type: 'boolean',
12928
+ },
12929
+ message: {
12930
+ description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
12931
+ type: 'string',
12932
+ },
12494
12933
  },
12495
12934
  required: ['message', 'is_access_code_error', 'error_code'],
12496
12935
  type: 'object',
@@ -12498,22 +12937,37 @@ export default {
12498
12937
  {
12499
12938
  description: 'Igloohome bridge is offline.',
12500
12939
  properties: {
12501
- created_at: { format: 'date-time', type: 'string' },
12940
+ created_at: {
12941
+ description: 'Date and time at which Seam created the error.',
12942
+ format: 'date-time',
12943
+ type: 'string',
12944
+ },
12502
12945
  error_code: {
12503
12946
  description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
12504
12947
  enum: ['igloohome_bridge_offline'],
12505
12948
  type: 'string',
12506
12949
  },
12507
- is_access_code_error: { enum: [true], type: 'boolean' },
12508
- message: { type: 'string' },
12950
+ is_access_code_error: {
12951
+ description: 'Indicates that this is an access code error.',
12952
+ enum: [true],
12953
+ type: 'boolean',
12954
+ },
12955
+ message: {
12956
+ description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
12957
+ type: 'string',
12958
+ },
12509
12959
  },
12510
12960
  required: ['message', 'is_access_code_error', 'error_code'],
12511
12961
  type: 'object',
12512
12962
  },
12513
12963
  {
12514
- description: 'Lock as reached max amount of codes.',
12964
+ description: 'Lock has reached maximum amount of codes.',
12515
12965
  properties: {
12516
- created_at: { format: 'date-time', type: 'string' },
12966
+ created_at: {
12967
+ description: 'Date and time at which Seam created the error.',
12968
+ format: 'date-time',
12969
+ type: 'string',
12970
+ },
12517
12971
  error_code: {
12518
12972
  description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
12519
12973
  enum: [
@@ -12521,23 +12975,41 @@ export default {
12521
12975
  ],
12522
12976
  type: 'string',
12523
12977
  },
12524
- is_access_code_error: { enum: [true], type: 'boolean' },
12525
- message: { type: 'string' },
12978
+ is_access_code_error: {
12979
+ description: 'Indicates that this is an access code error.',
12980
+ enum: [true],
12981
+ type: 'boolean',
12982
+ },
12983
+ message: {
12984
+ description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
12985
+ type: 'string',
12986
+ },
12526
12987
  },
12527
12988
  required: ['message', 'is_access_code_error', 'error_code'],
12528
12989
  type: 'object',
12529
12990
  },
12530
12991
  {
12531
- description: 'Unable to confirm the access code is set on Kwikset device.',
12992
+ description: 'Unable to confirm that the access code is set on Kwikset device.',
12532
12993
  properties: {
12533
- created_at: { format: 'date-time', type: 'string' },
12994
+ created_at: {
12995
+ description: 'Date and time at which Seam created the error.',
12996
+ format: 'date-time',
12997
+ type: 'string',
12998
+ },
12534
12999
  error_code: {
12535
13000
  description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
12536
13001
  enum: ['kwikset_unable_to_confirm_code'],
12537
13002
  type: 'string',
12538
13003
  },
12539
- is_access_code_error: { enum: [true], type: 'boolean' },
12540
- message: { type: 'string' },
13004
+ is_access_code_error: {
13005
+ description: 'Indicates that this is an access code error.',
13006
+ enum: [true],
13007
+ type: 'boolean',
13008
+ },
13009
+ message: {
13010
+ description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
13011
+ type: 'string',
13012
+ },
12541
13013
  },
12542
13014
  required: ['message', 'is_access_code_error', 'error_code'],
12543
13015
  type: 'object',
@@ -12545,14 +13017,25 @@ export default {
12545
13017
  {
12546
13018
  description: 'Unable to confirm the deletion of the access code on Kwikset device.',
12547
13019
  properties: {
12548
- created_at: { format: 'date-time', type: 'string' },
13020
+ created_at: {
13021
+ description: 'Date and time at which Seam created the error.',
13022
+ format: 'date-time',
13023
+ type: 'string',
13024
+ },
12549
13025
  error_code: {
12550
13026
  description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
12551
13027
  enum: ['kwikset_unable_to_confirm_deletion'],
12552
13028
  type: 'string',
12553
13029
  },
12554
- is_access_code_error: { enum: [true], type: 'boolean' },
12555
- message: { type: 'string' },
13030
+ is_access_code_error: {
13031
+ description: 'Indicates that this is an access code error.',
13032
+ enum: [true],
13033
+ type: 'boolean',
13034
+ },
13035
+ message: {
13036
+ description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
13037
+ type: 'string',
13038
+ },
12556
13039
  },
12557
13040
  required: ['message', 'is_access_code_error', 'error_code'],
12558
13041
  type: 'object',
@@ -12560,14 +13043,25 @@ export default {
12560
13043
  {
12561
13044
  description: 'Code was modified or removed externally after Seam successfully set it on the device.',
12562
13045
  properties: {
12563
- created_at: { format: 'date-time', type: 'string' },
13046
+ created_at: {
13047
+ description: 'Date and time at which Seam created the error.',
13048
+ format: 'date-time',
13049
+ type: 'string',
13050
+ },
12564
13051
  error_code: {
12565
13052
  description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
12566
13053
  enum: ['code_modified_external_to_seam'],
12567
13054
  type: 'string',
12568
13055
  },
12569
- is_access_code_error: { enum: [true], type: 'boolean' },
12570
- message: { type: 'string' },
13056
+ is_access_code_error: {
13057
+ description: 'Indicates that this is an access code error.',
13058
+ enum: [true],
13059
+ type: 'boolean',
13060
+ },
13061
+ message: {
13062
+ description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
13063
+ type: 'string',
13064
+ },
12571
13065
  },
12572
13066
  required: ['message', 'is_access_code_error', 'error_code'],
12573
13067
  type: 'object',
@@ -12575,14 +13069,25 @@ export default {
12575
13069
  {
12576
13070
  description: 'Invalid code length for August lock.',
12577
13071
  properties: {
12578
- created_at: { format: 'date-time', type: 'string' },
13072
+ created_at: {
13073
+ description: 'Date and time at which Seam created the error.',
13074
+ format: 'date-time',
13075
+ type: 'string',
13076
+ },
12579
13077
  error_code: {
12580
13078
  description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
12581
13079
  enum: ['august_lock_invalid_code_length'],
12582
13080
  type: 'string',
12583
13081
  },
12584
- is_access_code_error: { enum: [true], type: 'boolean' },
12585
- message: { type: 'string' },
13082
+ is_access_code_error: {
13083
+ description: 'Indicates that this is an access code error.',
13084
+ enum: [true],
13085
+ type: 'boolean',
13086
+ },
13087
+ message: {
13088
+ description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
13089
+ type: 'string',
13090
+ },
12586
13091
  },
12587
13092
  required: ['message', 'is_access_code_error', 'error_code'],
12588
13093
  type: 'object',
@@ -12590,14 +13095,25 @@ export default {
12590
13095
  {
12591
13096
  description: 'Access code has not yet been fully moved to the device.',
12592
13097
  properties: {
12593
- created_at: { format: 'date-time', type: 'string' },
13098
+ created_at: {
13099
+ description: 'Date and time at which Seam created the error.',
13100
+ format: 'date-time',
13101
+ type: 'string',
13102
+ },
12594
13103
  error_code: {
12595
13104
  description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
12596
13105
  enum: ['august_device_programming_delay'],
12597
13106
  type: 'string',
12598
13107
  },
12599
- is_access_code_error: { enum: [true], type: 'boolean' },
12600
- message: { type: 'string' },
13108
+ is_access_code_error: {
13109
+ description: 'Indicates that this is an access code error.',
13110
+ enum: [true],
13111
+ type: 'boolean',
13112
+ },
13113
+ message: {
13114
+ description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
13115
+ type: 'string',
13116
+ },
12601
13117
  },
12602
13118
  required: ['message', 'is_access_code_error', 'error_code'],
12603
13119
  type: 'object',
@@ -12605,14 +13121,25 @@ export default {
12605
13121
  {
12606
13122
  description: 'All access code slots on the device are full.',
12607
13123
  properties: {
12608
- created_at: { format: 'date-time', type: 'string' },
13124
+ created_at: {
13125
+ description: 'Date and time at which Seam created the error.',
13126
+ format: 'date-time',
13127
+ type: 'string',
13128
+ },
12609
13129
  error_code: {
12610
13130
  description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
12611
13131
  enum: ['august_device_slots_full'],
12612
13132
  type: 'string',
12613
13133
  },
12614
- is_access_code_error: { enum: [true], type: 'boolean' },
12615
- message: { type: 'string' },
13134
+ is_access_code_error: {
13135
+ description: 'Indicates that this is an access code error.',
13136
+ enum: [true],
13137
+ type: 'boolean',
13138
+ },
13139
+ message: {
13140
+ description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
13141
+ type: 'string',
13142
+ },
12616
13143
  },
12617
13144
  required: ['message', 'is_access_code_error', 'error_code'],
12618
13145
  type: 'object',
@@ -12620,14 +13147,25 @@ export default {
12620
13147
  {
12621
13148
  description: 'August lock is missing a keypad.',
12622
13149
  properties: {
12623
- created_at: { format: 'date-time', type: 'string' },
13150
+ created_at: {
13151
+ description: 'Date and time at which Seam created the error.',
13152
+ format: 'date-time',
13153
+ type: 'string',
13154
+ },
12624
13155
  error_code: {
12625
13156
  description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
12626
13157
  enum: ['august_lock_missing_keypad'],
12627
13158
  type: 'string',
12628
13159
  },
12629
- is_access_code_error: { enum: [true], type: 'boolean' },
12630
- message: { type: 'string' },
13160
+ is_access_code_error: {
13161
+ description: 'Indicates that this is an access code error.',
13162
+ enum: [true],
13163
+ type: 'boolean',
13164
+ },
13165
+ message: {
13166
+ description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
13167
+ type: 'string',
13168
+ },
12631
13169
  },
12632
13170
  required: ['message', 'is_access_code_error', 'error_code'],
12633
13171
  type: 'object',
@@ -12635,14 +13173,25 @@ export default {
12635
13173
  {
12636
13174
  description: 'August lock is temporarily offline.',
12637
13175
  properties: {
12638
- created_at: { format: 'date-time', type: 'string' },
13176
+ created_at: {
13177
+ description: 'Date and time at which Seam created the error.',
13178
+ format: 'date-time',
13179
+ type: 'string',
13180
+ },
12639
13181
  error_code: {
12640
13182
  description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
12641
13183
  enum: ['august_lock_temporarily_offline'],
12642
13184
  type: 'string',
12643
13185
  },
12644
- is_access_code_error: { enum: [true], type: 'boolean' },
12645
- message: { type: 'string' },
13186
+ is_access_code_error: {
13187
+ description: 'Indicates that this is an access code error.',
13188
+ enum: [true],
13189
+ type: 'boolean',
13190
+ },
13191
+ message: {
13192
+ description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
13193
+ type: 'string',
13194
+ },
12646
13195
  },
12647
13196
  required: ['message', 'is_access_code_error', 'error_code'],
12648
13197
  type: 'object',
@@ -12650,14 +13199,25 @@ export default {
12650
13199
  {
12651
13200
  description: 'Salto site user is not subscribed.',
12652
13201
  properties: {
12653
- created_at: { format: 'date-time', type: 'string' },
13202
+ created_at: {
13203
+ description: 'Date and time at which Seam created the error.',
13204
+ format: 'date-time',
13205
+ type: 'string',
13206
+ },
12654
13207
  error_code: {
12655
13208
  description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
12656
13209
  enum: ['salto_ks_user_not_subscribed'],
12657
13210
  type: 'string',
12658
13211
  },
12659
- is_access_code_error: { enum: [true], type: 'boolean' },
12660
- message: { type: 'string' },
13212
+ is_access_code_error: {
13213
+ description: 'Indicates that this is an access code error.',
13214
+ enum: [true],
13215
+ type: 'boolean',
13216
+ },
13217
+ message: {
13218
+ description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
13219
+ type: 'string',
13220
+ },
12661
13221
  },
12662
13222
  required: ['message', 'is_access_code_error', 'error_code'],
12663
13223
  type: 'object',
@@ -12665,14 +13225,25 @@ export default {
12665
13225
  {
12666
13226
  description: 'Access code has not yet been fully moved to the device.',
12667
13227
  properties: {
12668
- created_at: { format: 'date-time', type: 'string' },
13228
+ created_at: {
13229
+ description: 'Date and time at which Seam created the error.',
13230
+ format: 'date-time',
13231
+ type: 'string',
13232
+ },
12669
13233
  error_code: {
12670
13234
  description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
12671
13235
  enum: ['hubitat_device_programming_delay'],
12672
13236
  type: 'string',
12673
13237
  },
12674
- is_access_code_error: { enum: [true], type: 'boolean' },
12675
- message: { type: 'string' },
13238
+ is_access_code_error: {
13239
+ description: 'Indicates that this is an access code error.',
13240
+ enum: [true],
13241
+ type: 'boolean',
13242
+ },
13243
+ message: {
13244
+ description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
13245
+ type: 'string',
13246
+ },
12676
13247
  },
12677
13248
  required: ['message', 'is_access_code_error', 'error_code'],
12678
13249
  type: 'object',
@@ -12680,14 +13251,25 @@ export default {
12680
13251
  {
12681
13252
  description: 'No free positions available on the device.',
12682
13253
  properties: {
12683
- created_at: { format: 'date-time', type: 'string' },
13254
+ created_at: {
13255
+ description: 'Date and time at which Seam created the error.',
13256
+ format: 'date-time',
13257
+ type: 'string',
13258
+ },
12684
13259
  error_code: {
12685
13260
  description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
12686
13261
  enum: ['hubitat_no_free_positions_available'],
12687
13262
  type: 'string',
12688
13263
  },
12689
- is_access_code_error: { enum: [true], type: 'boolean' },
12690
- message: { type: 'string' },
13264
+ is_access_code_error: {
13265
+ description: 'Indicates that this is an access code error.',
13266
+ enum: [true],
13267
+ type: 'boolean',
13268
+ },
13269
+ message: {
13270
+ description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
13271
+ type: 'string',
13272
+ },
12691
13273
  },
12692
13274
  required: ['message', 'is_access_code_error', 'error_code'],
12693
13275
  type: 'object',
@@ -12695,14 +13277,25 @@ export default {
12695
13277
  {
12696
13278
  description: 'Duplicate access code name detected.',
12697
13279
  properties: {
12698
- created_at: { format: 'date-time', type: 'string' },
13280
+ created_at: {
13281
+ description: 'Date and time at which Seam created the error.',
13282
+ format: 'date-time',
13283
+ type: 'string',
13284
+ },
12699
13285
  error_code: {
12700
13286
  description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
12701
13287
  enum: ['wyze_duplicate_code_name'],
12702
13288
  type: 'string',
12703
13289
  },
12704
- is_access_code_error: { enum: [true], type: 'boolean' },
12705
- message: { type: 'string' },
13290
+ is_access_code_error: {
13291
+ description: 'Indicates that this is an access code error.',
13292
+ enum: [true],
13293
+ type: 'boolean',
13294
+ },
13295
+ message: {
13296
+ description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
13297
+ type: 'string',
13298
+ },
12706
13299
  },
12707
13300
  required: ['message', 'is_access_code_error', 'error_code'],
12708
13301
  type: 'object',
@@ -12710,14 +13303,25 @@ export default {
12710
13303
  {
12711
13304
  description: 'Potential duplicate access code detected.',
12712
13305
  properties: {
12713
- created_at: { format: 'date-time', type: 'string' },
13306
+ created_at: {
13307
+ description: 'Date and time at which Seam created the error.',
13308
+ format: 'date-time',
13309
+ type: 'string',
13310
+ },
12714
13311
  error_code: {
12715
13312
  description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
12716
13313
  enum: ['wyze_potential_duplicate_code'],
12717
13314
  type: 'string',
12718
13315
  },
12719
- is_access_code_error: { enum: [true], type: 'boolean' },
12720
- message: { type: 'string' },
13316
+ is_access_code_error: {
13317
+ description: 'Indicates that this is an access code error.',
13318
+ enum: [true],
13319
+ type: 'boolean',
13320
+ },
13321
+ message: {
13322
+ description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
13323
+ type: 'string',
13324
+ },
12721
13325
  },
12722
13326
  required: ['message', 'is_access_code_error', 'error_code'],
12723
13327
  type: 'object',
@@ -12725,14 +13329,25 @@ export default {
12725
13329
  {
12726
13330
  description: 'No valid user level for Oracode.',
12727
13331
  properties: {
12728
- created_at: { format: 'date-time', type: 'string' },
13332
+ created_at: {
13333
+ description: 'Date and time at which Seam created the error.',
13334
+ format: 'date-time',
13335
+ type: 'string',
13336
+ },
12729
13337
  error_code: {
12730
13338
  description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
12731
13339
  enum: ['dormakaba_oracode_no_valid_user_level'],
12732
13340
  type: 'string',
12733
13341
  },
12734
- is_access_code_error: { enum: [true], type: 'boolean' },
12735
- message: { type: 'string' },
13342
+ is_access_code_error: {
13343
+ description: 'Indicates that this is an access code error.',
13344
+ enum: [true],
13345
+ type: 'boolean',
13346
+ },
13347
+ message: {
13348
+ description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
13349
+ type: 'string',
13350
+ },
12736
13351
  },
12737
13352
  required: ['message', 'is_access_code_error', 'error_code'],
12738
13353
  type: 'object',
@@ -13051,7 +13666,11 @@ export default {
13051
13666
  },
13052
13667
  type: 'array',
13053
13668
  },
13054
- is_managed: { enum: [false], type: 'boolean' },
13669
+ is_managed: {
13670
+ description: 'Indicates that Seam does not manage the access code.',
13671
+ enum: [false],
13672
+ type: 'boolean',
13673
+ },
13055
13674
  name: {
13056
13675
  description: 'Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.',
13057
13676
  nullable: true,
@@ -13063,22 +13682,34 @@ export default {
13063
13682
  nullable: true,
13064
13683
  type: 'string',
13065
13684
  },
13066
- status: { enum: ['set'], type: 'string' },
13685
+ status: {
13686
+ description: 'Current status of the access code within the operational lifecycle. `set` indicates that the code is active and operational.',
13687
+ enum: ['set'],
13688
+ type: 'string',
13689
+ },
13067
13690
  type: {
13068
- description: 'Nature of the access code. Values are "ongoing" for access codes that are active continuously until deactivated manually or "time_bound" for access codes that have a specific duration.',
13691
+ description: 'Nature of the access code. Values are `ongoing` for access codes that are active continuously until deactivated manually or `time_bound` for access codes that have a specific duration.',
13069
13692
  enum: ['time_bound', 'ongoing'],
13070
13693
  type: 'string',
13071
13694
  },
13072
13695
  warnings: {
13073
- description: 'Collection of warnings associated with the access code, structured in a dictionary format. A unique "warning_code" keys each warning. Each warning entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the warning. "created_at" is a date that indicates when the warning was generated. This structure enables detailed tracking and timely response to potential issues that are not critical but that may require attention.',
13696
+ description: 'Warnings associated with the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).',
13074
13697
  items: {
13698
+ description: 'Warnings associated with the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).',
13075
13699
  discriminator: { propertyName: 'warning_code' },
13076
13700
  oneOf: [
13077
13701
  {
13078
- description: 'Failed to set code on Smart Things device.',
13702
+ description: 'Failed to set code on SmartThings device.',
13079
13703
  properties: {
13080
- created_at: { format: 'date-time', type: 'string' },
13081
- message: { type: 'string' },
13704
+ created_at: {
13705
+ description: 'Date and time at which Seam created the warning.',
13706
+ format: 'date-time',
13707
+ type: 'string',
13708
+ },
13709
+ message: {
13710
+ description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
13711
+ type: 'string',
13712
+ },
13082
13713
  warning_code: {
13083
13714
  description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
13084
13715
  enum: ['smartthings_failed_to_set_access_code'],
@@ -13091,8 +13722,15 @@ export default {
13091
13722
  {
13092
13723
  description: 'Duplicate access code detected.',
13093
13724
  properties: {
13094
- created_at: { format: 'date-time', type: 'string' },
13095
- message: { type: 'string' },
13725
+ created_at: {
13726
+ description: 'Date and time at which Seam created the warning.',
13727
+ format: 'date-time',
13728
+ type: 'string',
13729
+ },
13730
+ message: {
13731
+ description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
13732
+ type: 'string',
13733
+ },
13096
13734
  warning_code: {
13097
13735
  description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
13098
13736
  enum: ['schlage_detected_duplicate'],
@@ -13105,8 +13743,15 @@ export default {
13105
13743
  {
13106
13744
  description: 'Received an error when attempting to create this code.',
13107
13745
  properties: {
13108
- created_at: { format: 'date-time', type: 'string' },
13109
- message: { type: 'string' },
13746
+ created_at: {
13747
+ description: 'Date and time at which Seam created the warning.',
13748
+ format: 'date-time',
13749
+ type: 'string',
13750
+ },
13751
+ message: {
13752
+ description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
13753
+ type: 'string',
13754
+ },
13110
13755
  warning_code: {
13111
13756
  description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
13112
13757
  enum: ['schlage_creation_outage'],
@@ -13119,8 +13764,15 @@ export default {
13119
13764
  {
13120
13765
  description: 'Code was modified or removed externally after Seam successfully set it on the device.',
13121
13766
  properties: {
13122
- created_at: { format: 'date-time', type: 'string' },
13123
- message: { type: 'string' },
13767
+ created_at: {
13768
+ description: 'Date and time at which Seam created the warning.',
13769
+ format: 'date-time',
13770
+ type: 'string',
13771
+ },
13772
+ message: {
13773
+ description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
13774
+ type: 'string',
13775
+ },
13124
13776
  warning_code: {
13125
13777
  description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
13126
13778
  enum: ['code_modified_external_to_seam'],
@@ -13133,8 +13785,15 @@ export default {
13133
13785
  {
13134
13786
  description: 'Delay in setting code on device.',
13135
13787
  properties: {
13136
- created_at: { format: 'date-time', type: 'string' },
13137
- message: { type: 'string' },
13788
+ created_at: {
13789
+ description: 'Date and time at which Seam created the warning.',
13790
+ format: 'date-time',
13791
+ type: 'string',
13792
+ },
13793
+ message: {
13794
+ description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
13795
+ type: 'string',
13796
+ },
13138
13797
  warning_code: {
13139
13798
  description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
13140
13799
  enum: ['delay_in_setting_on_device'],
@@ -13147,8 +13806,15 @@ export default {
13147
13806
  {
13148
13807
  description: 'Delay in removing code from device.',
13149
13808
  properties: {
13150
- created_at: { format: 'date-time', type: 'string' },
13151
- message: { type: 'string' },
13809
+ created_at: {
13810
+ description: 'Date and time at which Seam created the warning.',
13811
+ format: 'date-time',
13812
+ type: 'string',
13813
+ },
13814
+ message: {
13815
+ description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
13816
+ type: 'string',
13817
+ },
13152
13818
  warning_code: {
13153
13819
  description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
13154
13820
  enum: ['delay_in_removing_from_device'],
@@ -13159,10 +13825,17 @@ export default {
13159
13825
  type: 'object',
13160
13826
  },
13161
13827
  {
13162
- description: 'Third party integration detected that may cause access codes to fail.',
13828
+ description: 'Third-party integration detected that may cause access codes to fail.',
13163
13829
  properties: {
13164
- created_at: { format: 'date-time', type: 'string' },
13165
- message: { type: 'string' },
13830
+ created_at: {
13831
+ description: 'Date and time at which Seam created the warning.',
13832
+ format: 'date-time',
13833
+ type: 'string',
13834
+ },
13835
+ message: {
13836
+ description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
13837
+ type: 'string',
13838
+ },
13166
13839
  warning_code: {
13167
13840
  description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
13168
13841
  enum: ['third_party_integration_detected'],
@@ -13175,8 +13848,15 @@ export default {
13175
13848
  {
13176
13849
  description: 'Access code has not yet been fully moved to the device.',
13177
13850
  properties: {
13178
- created_at: { format: 'date-time', type: 'string' },
13179
- message: { type: 'string' },
13851
+ created_at: {
13852
+ description: 'Date and time at which Seam created the warning.',
13853
+ format: 'date-time',
13854
+ type: 'string',
13855
+ },
13856
+ message: {
13857
+ description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
13858
+ type: 'string',
13859
+ },
13180
13860
  warning_code: {
13181
13861
  description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
13182
13862
  enum: ['august_device_programming_delay'],
@@ -13189,8 +13869,15 @@ export default {
13189
13869
  {
13190
13870
  description: 'August lock is temporarily offline.',
13191
13871
  properties: {
13192
- created_at: { format: 'date-time', type: 'string' },
13193
- message: { type: 'string' },
13872
+ created_at: {
13873
+ description: 'Date and time at which Seam created the warning.',
13874
+ format: 'date-time',
13875
+ type: 'string',
13876
+ },
13877
+ message: {
13878
+ description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
13879
+ type: 'string',
13880
+ },
13194
13881
  warning_code: {
13195
13882
  description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
13196
13883
  enum: ['august_lock_temporarily_offline'],
@@ -13203,8 +13890,15 @@ export default {
13203
13890
  {
13204
13891
  description: 'Algopins must be used within 24 hours.',
13205
13892
  properties: {
13206
- created_at: { format: 'date-time', type: 'string' },
13207
- message: { type: 'string' },
13893
+ created_at: {
13894
+ description: 'Date and time at which Seam created the warning.',
13895
+ format: 'date-time',
13896
+ type: 'string',
13897
+ },
13898
+ message: {
13899
+ description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
13900
+ type: 'string',
13901
+ },
13208
13902
  warning_code: {
13209
13903
  description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
13210
13904
  enum: ['igloo_algopin_must_be_used_within_24_hours'],
@@ -13217,8 +13911,15 @@ export default {
13217
13911
  {
13218
13912
  description: 'Management was transferred to another workspace.',
13219
13913
  properties: {
13220
- created_at: { format: 'date-time', type: 'string' },
13221
- message: { type: 'string' },
13914
+ created_at: {
13915
+ description: 'Date and time at which Seam created the warning.',
13916
+ format: 'date-time',
13917
+ type: 'string',
13918
+ },
13919
+ message: {
13920
+ description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
13921
+ type: 'string',
13922
+ },
13222
13923
  warning_code: {
13223
13924
  description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
13224
13925
  enum: ['management_transferred'],
@@ -13229,10 +13930,17 @@ export default {
13229
13930
  type: 'object',
13230
13931
  },
13231
13932
  {
13232
- description: 'Unable to confirm the access code is set on Kwikset device.',
13933
+ description: 'Unable to confirm that the access code is set on Kwikset device.',
13233
13934
  properties: {
13234
- created_at: { format: 'date-time', type: 'string' },
13235
- message: { type: 'string' },
13935
+ created_at: {
13936
+ description: 'Date and time at which Seam created the warning.',
13937
+ format: 'date-time',
13938
+ type: 'string',
13939
+ },
13940
+ message: {
13941
+ description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
13942
+ type: 'string',
13943
+ },
13236
13944
  warning_code: {
13237
13945
  description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
13238
13946
  enum: ['kwikset_unable_to_confirm_code'],
@@ -15107,40 +15815,85 @@ export default {
15107
15815
  paths: {
15108
15816
  '/access_codes/create': {
15109
15817
  post: {
15818
+ description: 'Creates a new [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).',
15110
15819
  operationId: 'accessCodesCreatePost',
15111
15820
  requestBody: {
15112
15821
  content: {
15113
15822
  'application/json': {
15114
15823
  schema: {
15115
15824
  properties: {
15116
- allow_external_modification: { type: 'boolean' },
15825
+ allow_external_modification: {
15826
+ description: 'Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`.',
15827
+ type: 'boolean',
15828
+ },
15117
15829
  attempt_for_offline_device: {
15118
15830
  default: true,
15119
15831
  type: 'boolean',
15120
15832
  },
15121
15833
  code: {
15834
+ description: 'Code to be used for access.',
15122
15835
  maxLength: 9,
15123
15836
  minLength: 4,
15124
15837
  pattern: '^\\d+$',
15125
15838
  type: 'string',
15126
15839
  },
15127
- common_code_key: { type: 'string' },
15128
- device_id: { format: 'uuid', type: 'string' },
15129
- ends_at: { type: 'string' },
15130
- is_external_modification_allowed: { type: 'boolean' },
15131
- is_offline_access_code: { type: 'boolean' },
15132
- is_one_time_use: { type: 'boolean' },
15840
+ common_code_key: {
15841
+ description: 'Key to identify access codes that should have the same code. Any two access codes with the same `common_code_key` are guaranteed to have the same `code`. See also [Creating and Updating Multiple Linked Access Codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/creating-and-updating-multiple-linked-access-codes).',
15842
+ type: 'string',
15843
+ },
15844
+ device_id: {
15845
+ description: 'ID of the device for which to create the new access code.',
15846
+ format: 'uuid',
15847
+ type: 'string',
15848
+ },
15849
+ ends_at: {
15850
+ description: 'Date and time at which the validity of the new access code ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`.',
15851
+ type: 'string',
15852
+ },
15853
+ is_external_modification_allowed: {
15854
+ description: 'Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`.',
15855
+ type: 'boolean',
15856
+ },
15857
+ is_offline_access_code: {
15858
+ description: 'Indicates whether the access code is an [offline access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes).',
15859
+ type: 'boolean',
15860
+ },
15861
+ is_one_time_use: {
15862
+ description: 'Indicates whether the [offline access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes) is a single-use access code.',
15863
+ type: 'boolean',
15864
+ },
15133
15865
  max_time_rounding: {
15134
15866
  default: '1hour',
15867
+ description: 'Maximum rounding adjustment. To create a daily-bound [offline access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes) for devices that support this feature, set this parameter to `1d`.',
15135
15868
  enum: ['1hour', '1day', '1h', '1d'],
15136
15869
  type: 'string',
15137
15870
  },
15138
- name: { type: 'string' },
15139
- prefer_native_scheduling: { type: 'boolean' },
15140
- preferred_code_length: { format: 'float', type: 'number' },
15141
- starts_at: { type: 'string' },
15142
- sync: { default: false, type: 'boolean' },
15143
- use_backup_access_code_pool: { type: 'boolean' },
15871
+ name: {
15872
+ description: 'Name of the new access code.',
15873
+ type: 'string',
15874
+ },
15875
+ prefer_native_scheduling: {
15876
+ description: 'Indicates whether [native scheduling](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#native-scheduling) should be used for time-bound codes when supported by the provider. Default: `true`.',
15877
+ type: 'boolean',
15878
+ },
15879
+ preferred_code_length: {
15880
+ description: 'Preferred code length. Only applicable if you do not specify a `code`. If the affected device does not support the preferred code length, Seam reverts to using the shortest supported code length.',
15881
+ format: 'float',
15882
+ type: 'number',
15883
+ },
15884
+ starts_at: {
15885
+ description: 'Date and time at which the validity of the new access code starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.',
15886
+ type: 'string',
15887
+ },
15888
+ sync: {
15889
+ default: false,
15890
+ type: 'boolean',
15891
+ 'x-undocumented': 'Only used internally.',
15892
+ },
15893
+ use_backup_access_code_pool: {
15894
+ description: 'Indicates whether to use a [backup access code pool](https://docs.seam.co/latest/core-concepts/access-codes#backup-access-codes) provided by Seam. If `true`, you can use [`/access_codes/pull_backup_access_code`](https://docs.seam.co/latest/api-clients/access_codes/pull_backup_access_code).',
15895
+ type: 'boolean',
15896
+ },
15144
15897
  use_offline_access_code: { type: 'boolean' },
15145
15898
  },
15146
15899
  required: ['device_id'],
@@ -15184,50 +15937,87 @@ export default {
15184
15937
  'x-fern-sdk-method-name': 'create',
15185
15938
  'x-fern-sdk-return-value': 'access_code',
15186
15939
  'x-response-key': 'access_code',
15940
+ 'x-title': 'Create an Access Code',
15187
15941
  },
15188
15942
  },
15189
15943
  '/access_codes/create_multiple': {
15190
15944
  post: {
15945
+ description: 'Creates new [access codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) that share a common code across multiple devices.\n\nUsers with more than one door lock in a property may want to create groups of linked access codes, all of which have the same code (PIN). For example, a short-term rental host may want to provide guests the same PIN for both a front door lock and a back door lock.\n\nIf you specify a custom code, Seam assigns this custom code to each of the resulting access codes. However, in this case, Seam does not link these access codes together with a `common_code_key`. That is, `common_code_key` remains null for these access codes.\n\nIf you want to change these access codes that are not linked by a `common_code_key`, you cannot use `/access_codes/update_multiple`. However, you can update each of these access codes individually, using `/access_codes/update`.\n\nSee also [Creating and Updating Multiple Linked Access Codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/creating-and-updating-multiple-linked-access-codes).',
15191
15946
  operationId: 'accessCodesCreateMultiplePost',
15192
15947
  requestBody: {
15193
15948
  content: {
15194
15949
  'application/json': {
15195
15950
  schema: {
15196
15951
  properties: {
15197
- allow_external_modification: { type: 'boolean' },
15952
+ allow_external_modification: {
15953
+ description: 'Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`.',
15954
+ type: 'boolean',
15955
+ },
15198
15956
  attempt_for_offline_device: {
15199
15957
  default: true,
15200
15958
  type: 'boolean',
15201
15959
  },
15202
15960
  behavior_when_code_cannot_be_shared: {
15203
15961
  default: 'throw',
15962
+ description: 'Desired behavior if any device cannot share a code. If `throw` (default), no access codes will be created if any device cannot share a code. If `create_random_code`, a random code will be created on devices that cannot share a code.',
15204
15963
  enum: ['throw', 'create_random_code'],
15205
15964
  type: 'string',
15206
15965
  },
15207
15966
  code: {
15967
+ description: 'Code to be used for access.',
15208
15968
  maxLength: 9,
15209
15969
  minLength: 4,
15210
15970
  pattern: '^\\d+$',
15211
15971
  type: 'string',
15212
15972
  },
15213
15973
  device_ids: {
15974
+ description: 'IDs of the devices for which to create the new access codes.',
15214
15975
  items: { format: 'uuid', type: 'string' },
15215
15976
  type: 'array',
15216
15977
  },
15217
- ends_at: { type: 'string' },
15218
- is_external_modification_allowed: { type: 'boolean' },
15219
- is_offline_access_code: { type: 'boolean' },
15220
- is_one_time_use: { type: 'boolean' },
15978
+ ends_at: {
15979
+ description: 'Date and time at which the validity of the new access code ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`.',
15980
+ type: 'string',
15981
+ },
15982
+ is_external_modification_allowed: {
15983
+ description: 'Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`.',
15984
+ type: 'boolean',
15985
+ },
15986
+ is_offline_access_code: {
15987
+ description: 'Indicates whether the access code is an [offline access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes).',
15988
+ type: 'boolean',
15989
+ },
15990
+ is_one_time_use: {
15991
+ description: 'Indicates whether the [offline access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes) is a single-use access code.',
15992
+ type: 'boolean',
15993
+ },
15221
15994
  max_time_rounding: {
15222
15995
  default: '1hour',
15996
+ description: 'Maximum rounding adjustment. To create a daily-bound [offline access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes) for devices that support this feature, set this parameter to `1d`.',
15223
15997
  enum: ['1hour', '1day', '1h', '1d'],
15224
15998
  type: 'string',
15225
15999
  },
15226
- name: { type: 'string' },
15227
- prefer_native_scheduling: { type: 'boolean' },
15228
- preferred_code_length: { format: 'float', type: 'number' },
15229
- starts_at: { type: 'string' },
15230
- use_backup_access_code_pool: { type: 'boolean' },
16000
+ name: {
16001
+ description: 'Name of the new access code.',
16002
+ type: 'string',
16003
+ },
16004
+ prefer_native_scheduling: {
16005
+ description: 'Indicates whether [native scheduling](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#native-scheduling) should be used for time-bound codes when supported by the provider. Default: `true`.',
16006
+ type: 'boolean',
16007
+ },
16008
+ preferred_code_length: {
16009
+ description: 'Preferred code length. Only applicable if you do not specify a `code`. If the affected device does not support the preferred code length, Seam reverts to using the shortest supported code length.',
16010
+ format: 'float',
16011
+ type: 'number',
16012
+ },
16013
+ starts_at: {
16014
+ description: 'Date and time at which the validity of the new access code starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.',
16015
+ type: 'string',
16016
+ },
16017
+ use_backup_access_code_pool: {
16018
+ description: 'Indicates whether to use a [backup access code pool](https://docs.seam.co/latest/core-concepts/access-codes#backup-access-codes) provided by Seam. If `true`, you can use [`/access_codes/pull_backup_access_code`](https://docs.seam.co/latest/api-clients/access_codes/pull_backup_access_code).',
16019
+ type: 'boolean',
16020
+ },
15231
16021
  use_offline_access_code: { type: 'boolean' },
15232
16022
  },
15233
16023
  required: ['device_ids'],
@@ -15270,48 +16060,85 @@ export default {
15270
16060
  'x-fern-sdk-method-name': 'create_multiple',
15271
16061
  'x-fern-sdk-return-value': 'access_codes',
15272
16062
  'x-response-key': 'access_codes',
16063
+ 'x-title': 'Create Multiple Linked Access Codes',
15273
16064
  },
15274
16065
  put: {
16066
+ description: 'Creates new [access codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) that share a common code across multiple devices.\n\nUsers with more than one door lock in a property may want to create groups of linked access codes, all of which have the same code (PIN). For example, a short-term rental host may want to provide guests the same PIN for both a front door lock and a back door lock.\n\nIf you specify a custom code, Seam assigns this custom code to each of the resulting access codes. However, in this case, Seam does not link these access codes together with a `common_code_key`. That is, `common_code_key` remains null for these access codes.\n\nIf you want to change these access codes that are not linked by a `common_code_key`, you cannot use `/access_codes/update_multiple`. However, you can update each of these access codes individually, using `/access_codes/update`.\n\nSee also [Creating and Updating Multiple Linked Access Codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/creating-and-updating-multiple-linked-access-codes).',
15275
16067
  operationId: 'accessCodesCreateMultiplePut',
15276
16068
  requestBody: {
15277
16069
  content: {
15278
16070
  'application/json': {
15279
16071
  schema: {
15280
16072
  properties: {
15281
- allow_external_modification: { type: 'boolean' },
16073
+ allow_external_modification: {
16074
+ description: 'Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`.',
16075
+ type: 'boolean',
16076
+ },
15282
16077
  attempt_for_offline_device: {
15283
16078
  default: true,
15284
16079
  type: 'boolean',
15285
16080
  },
15286
16081
  behavior_when_code_cannot_be_shared: {
15287
16082
  default: 'throw',
16083
+ description: 'Desired behavior if any device cannot share a code. If `throw` (default), no access codes will be created if any device cannot share a code. If `create_random_code`, a random code will be created on devices that cannot share a code.',
15288
16084
  enum: ['throw', 'create_random_code'],
15289
16085
  type: 'string',
15290
16086
  },
15291
16087
  code: {
16088
+ description: 'Code to be used for access.',
15292
16089
  maxLength: 9,
15293
16090
  minLength: 4,
15294
16091
  pattern: '^\\d+$',
15295
16092
  type: 'string',
15296
16093
  },
15297
16094
  device_ids: {
16095
+ description: 'IDs of the devices for which to create the new access codes.',
15298
16096
  items: { format: 'uuid', type: 'string' },
15299
16097
  type: 'array',
15300
16098
  },
15301
- ends_at: { type: 'string' },
15302
- is_external_modification_allowed: { type: 'boolean' },
15303
- is_offline_access_code: { type: 'boolean' },
15304
- is_one_time_use: { type: 'boolean' },
16099
+ ends_at: {
16100
+ description: 'Date and time at which the validity of the new access code ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`.',
16101
+ type: 'string',
16102
+ },
16103
+ is_external_modification_allowed: {
16104
+ description: 'Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`.',
16105
+ type: 'boolean',
16106
+ },
16107
+ is_offline_access_code: {
16108
+ description: 'Indicates whether the access code is an [offline access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes).',
16109
+ type: 'boolean',
16110
+ },
16111
+ is_one_time_use: {
16112
+ description: 'Indicates whether the [offline access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes) is a single-use access code.',
16113
+ type: 'boolean',
16114
+ },
15305
16115
  max_time_rounding: {
15306
16116
  default: '1hour',
16117
+ description: 'Maximum rounding adjustment. To create a daily-bound [offline access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes) for devices that support this feature, set this parameter to `1d`.',
15307
16118
  enum: ['1hour', '1day', '1h', '1d'],
15308
16119
  type: 'string',
15309
16120
  },
15310
- name: { type: 'string' },
15311
- prefer_native_scheduling: { type: 'boolean' },
15312
- preferred_code_length: { format: 'float', type: 'number' },
15313
- starts_at: { type: 'string' },
15314
- use_backup_access_code_pool: { type: 'boolean' },
16121
+ name: {
16122
+ description: 'Name of the new access code.',
16123
+ type: 'string',
16124
+ },
16125
+ prefer_native_scheduling: {
16126
+ description: 'Indicates whether [native scheduling](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#native-scheduling) should be used for time-bound codes when supported by the provider. Default: `true`.',
16127
+ type: 'boolean',
16128
+ },
16129
+ preferred_code_length: {
16130
+ description: 'Preferred code length. Only applicable if you do not specify a `code`. If the affected device does not support the preferred code length, Seam reverts to using the shortest supported code length.',
16131
+ format: 'float',
16132
+ type: 'number',
16133
+ },
16134
+ starts_at: {
16135
+ description: 'Date and time at which the validity of the new access code starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.',
16136
+ type: 'string',
16137
+ },
16138
+ use_backup_access_code_pool: {
16139
+ description: 'Indicates whether to use a [backup access code pool](https://docs.seam.co/latest/core-concepts/access-codes#backup-access-codes) provided by Seam. If `true`, you can use [`/access_codes/pull_backup_access_code`](https://docs.seam.co/latest/api-clients/access_codes/pull_backup_access_code).',
16140
+ type: 'boolean',
16141
+ },
15315
16142
  use_offline_access_code: { type: 'boolean' },
15316
16143
  },
15317
16144
  required: ['device_ids'],
@@ -15352,19 +16179,33 @@ export default {
15352
16179
  tags: ['/access_codes'],
15353
16180
  'x-fern-ignore': true,
15354
16181
  'x-response-key': 'access_codes',
16182
+ 'x-title': 'Create Multiple Linked Access Codes',
15355
16183
  },
15356
16184
  },
15357
16185
  '/access_codes/delete': {
15358
16186
  post: {
16187
+ description: 'Deletes an [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).',
15359
16188
  operationId: 'accessCodesDeletePost',
15360
16189
  requestBody: {
15361
16190
  content: {
15362
16191
  'application/json': {
15363
16192
  schema: {
15364
16193
  properties: {
15365
- access_code_id: { format: 'uuid', type: 'string' },
15366
- device_id: { format: 'uuid', type: 'string' },
15367
- sync: { default: false, type: 'boolean' },
16194
+ access_code_id: {
16195
+ description: 'ID of the access code to delete.',
16196
+ format: 'uuid',
16197
+ type: 'string',
16198
+ },
16199
+ device_id: {
16200
+ description: 'ID of the device for which to delete the access code.',
16201
+ format: 'uuid',
16202
+ type: 'string',
16203
+ },
16204
+ sync: {
16205
+ default: false,
16206
+ type: 'boolean',
16207
+ 'x-undocumented': 'Only used internally.',
16208
+ },
15368
16209
  },
15369
16210
  required: ['access_code_id'],
15370
16211
  type: 'object',
@@ -15405,6 +16246,7 @@ export default {
15405
16246
  'x-fern-sdk-group-name': ['access_codes'],
15406
16247
  'x-fern-sdk-method-name': 'delete',
15407
16248
  'x-response-key': null,
16249
+ 'x-title': 'Delete an Access Code',
15408
16250
  },
15409
16251
  },
15410
16252
  '/access_codes/generate_code': {
@@ -15458,15 +16300,27 @@ export default {
15458
16300
  },
15459
16301
  '/access_codes/get': {
15460
16302
  post: {
16303
+ description: 'Returns a specified [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).\n\nYou must specify either `access_code_id` or both `device_id` and `code`.',
15461
16304
  operationId: 'accessCodesGetPost',
15462
16305
  requestBody: {
15463
16306
  content: {
15464
16307
  'application/json': {
15465
16308
  schema: {
15466
16309
  properties: {
15467
- access_code_id: { format: 'uuid', type: 'string' },
15468
- code: { type: 'string' },
15469
- device_id: { format: 'uuid', type: 'string' },
16310
+ access_code_id: {
16311
+ description: 'ID of the access code that you want to get. You must specify either `access_code_id` or both `device_id` and `code`.',
16312
+ format: 'uuid',
16313
+ type: 'string',
16314
+ },
16315
+ code: {
16316
+ description: 'Code of the access code that you want to get. You must specify either `access_code_id` or both `device_id` and `code`.',
16317
+ type: 'string',
16318
+ },
16319
+ device_id: {
16320
+ description: 'ID of the device containing the access code that you want to get. You must specify either `access_code_id` or both `device_id` and `code`.',
16321
+ format: 'uuid',
16322
+ type: 'string',
16323
+ },
15470
16324
  },
15471
16325
  type: 'object',
15472
16326
  },
@@ -15504,10 +16358,12 @@ export default {
15504
16358
  'x-fern-sdk-method-name': 'get',
15505
16359
  'x-fern-sdk-return-value': 'access_code',
15506
16360
  'x-response-key': 'access_code',
16361
+ 'x-title': 'Get an Access Code',
15507
16362
  },
15508
16363
  },
15509
16364
  '/access_codes/list': {
15510
16365
  post: {
16366
+ description: 'Returns a list of all [access codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).\n\nSpecify either `device_id` or `access_code_ids`.',
15511
16367
  operationId: 'accessCodesListPost',
15512
16368
  requestBody: {
15513
16369
  content: {
@@ -15515,11 +16371,19 @@ export default {
15515
16371
  schema: {
15516
16372
  properties: {
15517
16373
  access_code_ids: {
16374
+ description: 'IDs of the access codes that you want to retrieve. Specify either `device_id` or `access_code_ids`.',
15518
16375
  items: { format: 'uuid', type: 'string' },
15519
16376
  type: 'array',
15520
16377
  },
15521
- device_id: { format: 'uuid', type: 'string' },
15522
- user_identifier_key: { type: 'string' },
16378
+ device_id: {
16379
+ description: 'ID of the device for which you want to list access codes. Specify either `device_id` or `access_code_ids`.',
16380
+ format: 'uuid',
16381
+ type: 'string',
16382
+ },
16383
+ user_identifier_key: {
16384
+ description: 'Your user ID for the user by which to filter access codes.',
16385
+ type: 'string',
16386
+ },
15523
16387
  },
15524
16388
  type: 'object',
15525
16389
  },
@@ -15560,18 +16424,23 @@ export default {
15560
16424
  'x-fern-sdk-method-name': 'list',
15561
16425
  'x-fern-sdk-return-value': 'access_codes',
15562
16426
  'x-response-key': 'access_codes',
16427
+ 'x-title': 'List Access Codes',
15563
16428
  },
15564
16429
  },
15565
16430
  '/access_codes/pull_backup_access_code': {
15566
16431
  post: {
15567
- description: 'Retrieves a backup access code for an access code. See also [Managing Backup Access Codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/backup-access-codes).',
16432
+ description: "Retrieves a backup access code for an [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). See also [Managing Backup Access Codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/backup-access-codes).\n\nA backup access code pool is a collection of pre-programmed access codes stored on a device, ready for use. These codes are programmed in addition to the regular access codes on Seam, serving as a safety net for any issues with the primary codes.\n\nIf there's ever a complication with a primary access code—be it due to intermittent connectivity, manual removal from a device, or provider outages—a backup code can be retrieved. Its end time can then be adjusted to align with the original code, facilitating seamless and uninterrupted access.\n\nYou can only pull backup access codes for time-bound access codes.\n\nBefore pulling a backup access code, make sure that the device's `properties.supports_backup_access_code_pool` is `true`. Then, to activate the backup pool, set `use_backup_access_code_pool` to `true` when creating an access code.",
15568
16433
  operationId: 'accessCodesPullBackupAccessCodePost',
15569
16434
  requestBody: {
15570
16435
  content: {
15571
16436
  'application/json': {
15572
16437
  schema: {
15573
16438
  properties: {
15574
- access_code_id: { format: 'uuid', type: 'string' },
16439
+ access_code_id: {
16440
+ description: 'ID of the access code for which you want to pull a backup access code.',
16441
+ format: 'uuid',
16442
+ type: 'string',
16443
+ },
15575
16444
  },
15576
16445
  required: ['access_code_id'],
15577
16446
  type: 'object',
@@ -15613,10 +16482,12 @@ export default {
15613
16482
  'x-fern-sdk-method-name': 'pull_backup_access_code',
15614
16483
  'x-fern-sdk-return-value': 'access_code',
15615
16484
  'x-response-key': 'access_code',
16485
+ 'x-title': 'Pull a Backup Access Code',
15616
16486
  },
15617
16487
  },
15618
16488
  '/access_codes/simulate/create_unmanaged_access_code': {
15619
16489
  post: {
16490
+ description: 'Simulates the creation of an [unmanaged access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes) in a [sandbox workspace](https://docs.seam.co/latest/core-concepts/workspaces#sandbox-workspaces).',
15620
16491
  operationId: 'accessCodesSimulateCreateUnmanagedAccessCodePost',
15621
16492
  requestBody: {
15622
16493
  content: {
@@ -15624,13 +16495,21 @@ export default {
15624
16495
  schema: {
15625
16496
  properties: {
15626
16497
  code: {
16498
+ description: 'Code of the simulated unmanaged access code.',
15627
16499
  maxLength: 8,
15628
16500
  minLength: 4,
15629
16501
  pattern: '^\\d+$',
15630
16502
  type: 'string',
15631
16503
  },
15632
- device_id: { format: 'uuid', type: 'string' },
15633
- name: { type: 'string' },
16504
+ device_id: {
16505
+ description: 'ID of the device for which you want to simulate the creation of an unmanaged access code.',
16506
+ format: 'uuid',
16507
+ type: 'string',
16508
+ },
16509
+ name: {
16510
+ description: 'Name of the simulated unmanaged access code.',
16511
+ type: 'string',
16512
+ },
15634
16513
  },
15635
16514
  required: ['device_id', 'name', 'code'],
15636
16515
  type: 'object',
@@ -15671,21 +16550,40 @@ export default {
15671
16550
  'x-fern-sdk-method-name': 'create_unmanaged_access_code',
15672
16551
  'x-fern-sdk-return-value': 'access_code',
15673
16552
  'x-response-key': 'access_code',
16553
+ 'x-title': 'Simulate Creating an Unmanaged Access Code',
15674
16554
  },
15675
16555
  },
15676
16556
  '/access_codes/unmanaged/convert_to_managed': {
15677
16557
  patch: {
16558
+ description: 'Converts an [unmanaged access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes) to an [access code managed through Seam](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).\n\nAn unmanaged access code has a limited set of operations that you can perform on it. Once you convert an unmanaged access code to a managed access code, the full set of access code operations and lifecycle events becomes available for it.\n\nNote that not all device providers support converting an unmanaged access code to a managed access code.',
15678
16559
  operationId: 'accessCodesUnmanagedConvertToManagedPatch',
15679
16560
  requestBody: {
15680
16561
  content: {
15681
16562
  'application/json': {
15682
16563
  schema: {
15683
16564
  properties: {
15684
- access_code_id: { format: 'uuid', type: 'string' },
15685
- allow_external_modification: { type: 'boolean' },
15686
- force: { type: 'boolean' },
15687
- is_external_modification_allowed: { type: 'boolean' },
15688
- sync: { default: false, type: 'boolean' },
16565
+ access_code_id: {
16566
+ description: 'ID of the unmanaged access code that you want to convert to a managed access code.',
16567
+ format: 'uuid',
16568
+ type: 'string',
16569
+ },
16570
+ allow_external_modification: {
16571
+ description: 'Indicates whether external modification of the access code is allowed.',
16572
+ type: 'boolean',
16573
+ },
16574
+ force: {
16575
+ description: 'Indicates whether to force the access code conversion. To switch management of an access code from one Seam workspace to another, set `force` to `true`.',
16576
+ type: 'boolean',
16577
+ },
16578
+ is_external_modification_allowed: {
16579
+ description: 'Indicates whether external modification of the access code is allowed.',
16580
+ type: 'boolean',
16581
+ },
16582
+ sync: {
16583
+ default: false,
16584
+ type: 'boolean',
16585
+ 'x-undocumented': 'Only used internally.',
16586
+ },
15689
16587
  },
15690
16588
  required: ['access_code_id'],
15691
16589
  type: 'object',
@@ -15720,19 +16618,38 @@ export default {
15720
16618
  'x-action-attempt-type': 'CONVERT_ACCESS_CODE_TO_MANAGED',
15721
16619
  'x-fern-ignore': true,
15722
16620
  'x-response-key': null,
16621
+ 'x-title': 'Convert an Unmanaged Access Code',
15723
16622
  },
15724
16623
  post: {
16624
+ description: 'Converts an [unmanaged access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes) to an [access code managed through Seam](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).\n\nAn unmanaged access code has a limited set of operations that you can perform on it. Once you convert an unmanaged access code to a managed access code, the full set of access code operations and lifecycle events becomes available for it.\n\nNote that not all device providers support converting an unmanaged access code to a managed access code.',
15725
16625
  operationId: 'accessCodesUnmanagedConvertToManagedPost',
15726
16626
  requestBody: {
15727
16627
  content: {
15728
16628
  'application/json': {
15729
16629
  schema: {
15730
16630
  properties: {
15731
- access_code_id: { format: 'uuid', type: 'string' },
15732
- allow_external_modification: { type: 'boolean' },
15733
- force: { type: 'boolean' },
15734
- is_external_modification_allowed: { type: 'boolean' },
15735
- sync: { default: false, type: 'boolean' },
16631
+ access_code_id: {
16632
+ description: 'ID of the unmanaged access code that you want to convert to a managed access code.',
16633
+ format: 'uuid',
16634
+ type: 'string',
16635
+ },
16636
+ allow_external_modification: {
16637
+ description: 'Indicates whether external modification of the access code is allowed.',
16638
+ type: 'boolean',
16639
+ },
16640
+ force: {
16641
+ description: 'Indicates whether to force the access code conversion. To switch management of an access code from one Seam workspace to another, set `force` to `true`.',
16642
+ type: 'boolean',
16643
+ },
16644
+ is_external_modification_allowed: {
16645
+ description: 'Indicates whether external modification of the access code is allowed.',
16646
+ type: 'boolean',
16647
+ },
16648
+ sync: {
16649
+ default: false,
16650
+ type: 'boolean',
16651
+ 'x-undocumented': 'Only used internally.',
16652
+ },
15736
16653
  },
15737
16654
  required: ['access_code_id'],
15738
16655
  type: 'object',
@@ -15768,18 +16685,28 @@ export default {
15768
16685
  'x-fern-sdk-group-name': ['access_codes', 'unmanaged'],
15769
16686
  'x-fern-sdk-method-name': 'convert_to_managed',
15770
16687
  'x-response-key': null,
16688
+ 'x-title': 'Convert an Unmanaged Access Code',
15771
16689
  },
15772
16690
  },
15773
16691
  '/access_codes/unmanaged/delete': {
15774
16692
  post: {
16693
+ description: 'Deletes an [unmanaged access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes).',
15775
16694
  operationId: 'accessCodesUnmanagedDeletePost',
15776
16695
  requestBody: {
15777
16696
  content: {
15778
16697
  'application/json': {
15779
16698
  schema: {
15780
16699
  properties: {
15781
- access_code_id: { format: 'uuid', type: 'string' },
15782
- sync: { default: false, type: 'boolean' },
16700
+ access_code_id: {
16701
+ description: 'ID of the unmanaged access code to delete.',
16702
+ format: 'uuid',
16703
+ type: 'string',
16704
+ },
16705
+ sync: {
16706
+ default: false,
16707
+ type: 'boolean',
16708
+ 'x-undocumented': 'Only used internally.',
16709
+ },
15783
16710
  },
15784
16711
  required: ['access_code_id'],
15785
16712
  type: 'object',
@@ -15820,19 +16747,32 @@ export default {
15820
16747
  'x-fern-sdk-group-name': ['access_codes', 'unmanaged'],
15821
16748
  'x-fern-sdk-method-name': 'delete',
15822
16749
  'x-response-key': null,
16750
+ 'x-title': 'Delete an Unmanaged Access Code',
15823
16751
  },
15824
16752
  },
15825
16753
  '/access_codes/unmanaged/get': {
15826
16754
  post: {
16755
+ description: 'Returns a specified [unmanaged access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes).\n\nYou must specify either `access_code_id` or both `device_id` and `code`.',
15827
16756
  operationId: 'accessCodesUnmanagedGetPost',
15828
16757
  requestBody: {
15829
16758
  content: {
15830
16759
  'application/json': {
15831
16760
  schema: {
15832
16761
  properties: {
15833
- access_code_id: { format: 'uuid', type: 'string' },
15834
- code: { type: 'string' },
15835
- device_id: { format: 'uuid', type: 'string' },
16762
+ access_code_id: {
16763
+ description: 'ID of the unmanaged access code that you want to get. You must specify either `access_code_id` or both `device_id` and `code`.',
16764
+ format: 'uuid',
16765
+ type: 'string',
16766
+ },
16767
+ code: {
16768
+ description: 'Code of the unmanaged access code that you want to get. You must specify either `access_code_id` or both `device_id` and `code`.',
16769
+ type: 'string',
16770
+ },
16771
+ device_id: {
16772
+ description: 'ID of the device containing the unmanaged access code that you want to get. You must specify either `access_code_id` or both `device_id` and `code`.',
16773
+ format: 'uuid',
16774
+ type: 'string',
16775
+ },
15836
16776
  },
15837
16777
  type: 'object',
15838
16778
  },
@@ -15872,18 +16812,27 @@ export default {
15872
16812
  'x-fern-sdk-method-name': 'get',
15873
16813
  'x-fern-sdk-return-value': 'access_code',
15874
16814
  'x-response-key': 'access_code',
16815
+ 'x-title': 'Get an Unmanaged Access Code',
15875
16816
  },
15876
16817
  },
15877
16818
  '/access_codes/unmanaged/list': {
15878
16819
  post: {
16820
+ description: 'Returns a list of all [unmanaged access codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes).',
15879
16821
  operationId: 'accessCodesUnmanagedListPost',
15880
16822
  requestBody: {
15881
16823
  content: {
15882
16824
  'application/json': {
15883
16825
  schema: {
15884
16826
  properties: {
15885
- device_id: { format: 'uuid', type: 'string' },
15886
- user_identifier_key: { type: 'string' },
16827
+ device_id: {
16828
+ description: 'ID of the device for which you want to list unmanaged access codes.',
16829
+ format: 'uuid',
16830
+ type: 'string',
16831
+ },
16832
+ user_identifier_key: {
16833
+ description: 'Your user ID for the user by which to filter unmanaged access codes.',
16834
+ type: 'string',
16835
+ },
15887
16836
  },
15888
16837
  required: ['device_id'],
15889
16838
  type: 'object',
@@ -15927,20 +16876,35 @@ export default {
15927
16876
  'x-fern-sdk-method-name': 'list',
15928
16877
  'x-fern-sdk-return-value': 'access_codes',
15929
16878
  'x-response-key': 'access_codes',
16879
+ 'x-title': 'List Unmanaged Access Codes',
15930
16880
  },
15931
16881
  },
15932
16882
  '/access_codes/unmanaged/update': {
15933
16883
  patch: {
16884
+ description: 'Updates a specified [unmanaged access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes).',
15934
16885
  operationId: 'accessCodesUnmanagedUpdatePatch',
15935
16886
  requestBody: {
15936
16887
  content: {
15937
16888
  'application/json': {
15938
16889
  schema: {
15939
16890
  properties: {
15940
- access_code_id: { format: 'uuid', type: 'string' },
15941
- allow_external_modification: { type: 'boolean' },
15942
- force: { type: 'boolean' },
15943
- is_external_modification_allowed: { type: 'boolean' },
16891
+ access_code_id: {
16892
+ description: 'ID of the unmanaged access code that you want to update.',
16893
+ format: 'uuid',
16894
+ type: 'string',
16895
+ },
16896
+ allow_external_modification: {
16897
+ description: 'Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the code is allowed.',
16898
+ type: 'boolean',
16899
+ },
16900
+ force: {
16901
+ description: 'Indicates whether to force the unmanaged access code update.',
16902
+ type: 'boolean',
16903
+ },
16904
+ is_external_modification_allowed: {
16905
+ description: 'Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the code is allowed.',
16906
+ type: 'boolean',
16907
+ },
15944
16908
  is_managed: { type: 'boolean' },
15945
16909
  },
15946
16910
  required: ['access_code_id', 'is_managed'],
@@ -15975,18 +16939,33 @@ export default {
15975
16939
  tags: ['/access_codes'],
15976
16940
  'x-fern-ignore': true,
15977
16941
  'x-response-key': null,
16942
+ 'x-title': 'Update an Unmanaged Access Code',
15978
16943
  },
15979
16944
  post: {
16945
+ description: 'Updates a specified [unmanaged access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes).',
15980
16946
  operationId: 'accessCodesUnmanagedUpdatePost',
15981
16947
  requestBody: {
15982
16948
  content: {
15983
16949
  'application/json': {
15984
16950
  schema: {
15985
16951
  properties: {
15986
- access_code_id: { format: 'uuid', type: 'string' },
15987
- allow_external_modification: { type: 'boolean' },
15988
- force: { type: 'boolean' },
15989
- is_external_modification_allowed: { type: 'boolean' },
16952
+ access_code_id: {
16953
+ description: 'ID of the unmanaged access code that you want to update.',
16954
+ format: 'uuid',
16955
+ type: 'string',
16956
+ },
16957
+ allow_external_modification: {
16958
+ description: 'Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the code is allowed.',
16959
+ type: 'boolean',
16960
+ },
16961
+ force: {
16962
+ description: 'Indicates whether to force the unmanaged access code update.',
16963
+ type: 'boolean',
16964
+ },
16965
+ is_external_modification_allowed: {
16966
+ description: 'Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the code is allowed.',
16967
+ type: 'boolean',
16968
+ },
15990
16969
  is_managed: { type: 'boolean' },
15991
16970
  },
15992
16971
  required: ['access_code_id', 'is_managed'],
@@ -16022,46 +17001,100 @@ export default {
16022
17001
  'x-fern-sdk-group-name': ['access_codes', 'unmanaged'],
16023
17002
  'x-fern-sdk-method-name': 'update',
16024
17003
  'x-response-key': null,
17004
+ 'x-title': 'Update an Unmanaged Access Code',
16025
17005
  },
16026
17006
  },
16027
17007
  '/access_codes/update': {
16028
17008
  patch: {
17009
+ description: 'Updates a specified active or upcoming [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).\n\nSee also [Modifying Access Codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/modifying-access-codes).',
16029
17010
  operationId: 'accessCodesUpdatePatch',
16030
17011
  requestBody: {
16031
17012
  content: {
16032
17013
  'application/json': {
16033
17014
  schema: {
16034
17015
  properties: {
16035
- access_code_id: { format: 'uuid', type: 'string' },
16036
- allow_external_modification: { type: 'boolean' },
17016
+ access_code_id: {
17017
+ description: 'ID of the access code that you want to update.',
17018
+ format: 'uuid',
17019
+ type: 'string',
17020
+ },
17021
+ allow_external_modification: {
17022
+ description: 'Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`.',
17023
+ type: 'boolean',
17024
+ },
16037
17025
  attempt_for_offline_device: {
16038
17026
  default: true,
16039
17027
  type: 'boolean',
16040
17028
  },
16041
17029
  code: {
17030
+ description: 'Code to be used for access.',
16042
17031
  maxLength: 9,
16043
17032
  minLength: 4,
16044
17033
  pattern: '^\\d+$',
16045
17034
  type: 'string',
16046
17035
  },
16047
- device_id: { format: 'uuid', type: 'string' },
16048
- ends_at: { type: 'string' },
16049
- is_external_modification_allowed: { type: 'boolean' },
16050
- is_managed: { type: 'boolean' },
16051
- is_offline_access_code: { type: 'boolean' },
16052
- is_one_time_use: { type: 'boolean' },
17036
+ device_id: {
17037
+ description: 'ID of the device containing the access code that you want to update.',
17038
+ format: 'uuid',
17039
+ type: 'string',
17040
+ },
17041
+ ends_at: {
17042
+ description: 'Date and time at which the validity of the new access code ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`.',
17043
+ type: 'string',
17044
+ },
17045
+ is_external_modification_allowed: {
17046
+ description: 'Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`.',
17047
+ type: 'boolean',
17048
+ },
17049
+ is_managed: {
17050
+ description: 'Indicates whether the access code is managed through Seam. Note that to convert an unmanaged access code into a managed access code, use `/access_codes/unmanaged/convert_to_managed`.',
17051
+ type: 'boolean',
17052
+ },
17053
+ is_offline_access_code: {
17054
+ description: 'Indicates whether the access code is an [offline access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes).',
17055
+ type: 'boolean',
17056
+ },
17057
+ is_one_time_use: {
17058
+ description: 'Indicates whether the [offline access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes) is a single-use access code.',
17059
+ type: 'boolean',
17060
+ },
16053
17061
  max_time_rounding: {
16054
17062
  default: '1hour',
17063
+ description: 'Maximum rounding adjustment. To create a daily-bound [offline access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes) for devices that support this feature, set this parameter to `1d`.',
16055
17064
  enum: ['1hour', '1day', '1h', '1d'],
16056
17065
  type: 'string',
16057
17066
  },
16058
- name: { type: 'string' },
16059
- prefer_native_scheduling: { type: 'boolean' },
16060
- preferred_code_length: { format: 'float', type: 'number' },
16061
- starts_at: { type: 'string' },
16062
- sync: { default: false, type: 'boolean' },
16063
- type: { enum: ['ongoing', 'time_bound'], type: 'string' },
16064
- use_backup_access_code_pool: { type: 'boolean' },
17067
+ name: {
17068
+ description: 'Name of the new access code.',
17069
+ type: 'string',
17070
+ },
17071
+ prefer_native_scheduling: {
17072
+ description: 'Indicates whether [native scheduling](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#native-scheduling) should be used for time-bound codes when supported by the provider. Default: `true`.',
17073
+ type: 'boolean',
17074
+ },
17075
+ preferred_code_length: {
17076
+ description: 'Preferred code length. Only applicable if you do not specify a `code`. If the affected device does not support the preferred code length, Seam reverts to using the shortest supported code length.',
17077
+ format: 'float',
17078
+ type: 'number',
17079
+ },
17080
+ starts_at: {
17081
+ description: 'Date and time at which the validity of the new access code starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.',
17082
+ type: 'string',
17083
+ },
17084
+ sync: {
17085
+ default: false,
17086
+ type: 'boolean',
17087
+ 'x-undocumented': 'Only used internally.',
17088
+ },
17089
+ type: {
17090
+ description: 'Type to which you want to convert the access code. To convert a time-bound access code to an ongoing access code, set `type` to `ongoing`. See also [Changing a time-bound access code to permanent access](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/modifying-access-codes#special-case-2-changing-a-time-bound-access-code-to-permanent-access).',
17091
+ enum: ['ongoing', 'time_bound'],
17092
+ type: 'string',
17093
+ },
17094
+ use_backup_access_code_pool: {
17095
+ description: 'Indicates whether to use a [backup access code pool](https://docs.seam.co/latest/core-concepts/access-codes#backup-access-codes) provided by Seam. If `true`, you can use [`/access_codes/pull_backup_access_code`](https://docs.seam.co/latest/api-clients/access_codes/pull_backup_access_code).',
17096
+ type: 'boolean',
17097
+ },
16065
17098
  use_offline_access_code: { type: 'boolean' },
16066
17099
  },
16067
17100
  required: ['access_code_id'],
@@ -16102,44 +17135,98 @@ export default {
16102
17135
  'x-action-attempt-type': 'UPDATE_ACCESS_CODE',
16103
17136
  'x-fern-ignore': true,
16104
17137
  'x-response-key': null,
17138
+ 'x-title': 'Update an Access Code',
16105
17139
  },
16106
17140
  post: {
17141
+ description: 'Updates a specified active or upcoming [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).\n\nSee also [Modifying Access Codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/modifying-access-codes).',
16107
17142
  operationId: 'accessCodesUpdatePost',
16108
17143
  requestBody: {
16109
17144
  content: {
16110
17145
  'application/json': {
16111
17146
  schema: {
16112
17147
  properties: {
16113
- access_code_id: { format: 'uuid', type: 'string' },
16114
- allow_external_modification: { type: 'boolean' },
17148
+ access_code_id: {
17149
+ description: 'ID of the access code that you want to update.',
17150
+ format: 'uuid',
17151
+ type: 'string',
17152
+ },
17153
+ allow_external_modification: {
17154
+ description: 'Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`.',
17155
+ type: 'boolean',
17156
+ },
16115
17157
  attempt_for_offline_device: {
16116
17158
  default: true,
16117
17159
  type: 'boolean',
16118
17160
  },
16119
17161
  code: {
17162
+ description: 'Code to be used for access.',
16120
17163
  maxLength: 9,
16121
17164
  minLength: 4,
16122
17165
  pattern: '^\\d+$',
16123
17166
  type: 'string',
16124
17167
  },
16125
- device_id: { format: 'uuid', type: 'string' },
16126
- ends_at: { type: 'string' },
16127
- is_external_modification_allowed: { type: 'boolean' },
16128
- is_managed: { type: 'boolean' },
16129
- is_offline_access_code: { type: 'boolean' },
16130
- is_one_time_use: { type: 'boolean' },
17168
+ device_id: {
17169
+ description: 'ID of the device containing the access code that you want to update.',
17170
+ format: 'uuid',
17171
+ type: 'string',
17172
+ },
17173
+ ends_at: {
17174
+ description: 'Date and time at which the validity of the new access code ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`.',
17175
+ type: 'string',
17176
+ },
17177
+ is_external_modification_allowed: {
17178
+ description: 'Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`.',
17179
+ type: 'boolean',
17180
+ },
17181
+ is_managed: {
17182
+ description: 'Indicates whether the access code is managed through Seam. Note that to convert an unmanaged access code into a managed access code, use `/access_codes/unmanaged/convert_to_managed`.',
17183
+ type: 'boolean',
17184
+ },
17185
+ is_offline_access_code: {
17186
+ description: 'Indicates whether the access code is an [offline access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes).',
17187
+ type: 'boolean',
17188
+ },
17189
+ is_one_time_use: {
17190
+ description: 'Indicates whether the [offline access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes) is a single-use access code.',
17191
+ type: 'boolean',
17192
+ },
16131
17193
  max_time_rounding: {
16132
17194
  default: '1hour',
17195
+ description: 'Maximum rounding adjustment. To create a daily-bound [offline access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes) for devices that support this feature, set this parameter to `1d`.',
16133
17196
  enum: ['1hour', '1day', '1h', '1d'],
16134
17197
  type: 'string',
16135
17198
  },
16136
- name: { type: 'string' },
16137
- prefer_native_scheduling: { type: 'boolean' },
16138
- preferred_code_length: { format: 'float', type: 'number' },
16139
- starts_at: { type: 'string' },
16140
- sync: { default: false, type: 'boolean' },
16141
- type: { enum: ['ongoing', 'time_bound'], type: 'string' },
16142
- use_backup_access_code_pool: { type: 'boolean' },
17199
+ name: {
17200
+ description: 'Name of the new access code.',
17201
+ type: 'string',
17202
+ },
17203
+ prefer_native_scheduling: {
17204
+ description: 'Indicates whether [native scheduling](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#native-scheduling) should be used for time-bound codes when supported by the provider. Default: `true`.',
17205
+ type: 'boolean',
17206
+ },
17207
+ preferred_code_length: {
17208
+ description: 'Preferred code length. Only applicable if you do not specify a `code`. If the affected device does not support the preferred code length, Seam reverts to using the shortest supported code length.',
17209
+ format: 'float',
17210
+ type: 'number',
17211
+ },
17212
+ starts_at: {
17213
+ description: 'Date and time at which the validity of the new access code starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.',
17214
+ type: 'string',
17215
+ },
17216
+ sync: {
17217
+ default: false,
17218
+ type: 'boolean',
17219
+ 'x-undocumented': 'Only used internally.',
17220
+ },
17221
+ type: {
17222
+ description: 'Type to which you want to convert the access code. To convert a time-bound access code to an ongoing access code, set `type` to `ongoing`. See also [Changing a time-bound access code to permanent access](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/modifying-access-codes#special-case-2-changing-a-time-bound-access-code-to-permanent-access).',
17223
+ enum: ['ongoing', 'time_bound'],
17224
+ type: 'string',
17225
+ },
17226
+ use_backup_access_code_pool: {
17227
+ description: 'Indicates whether to use a [backup access code pool](https://docs.seam.co/latest/core-concepts/access-codes#backup-access-codes) provided by Seam. If `true`, you can use [`/access_codes/pull_backup_access_code`](https://docs.seam.co/latest/api-clients/access_codes/pull_backup_access_code).',
17228
+ type: 'boolean',
17229
+ },
16143
17230
  use_offline_access_code: { type: 'boolean' },
16144
17231
  },
16145
17232
  required: ['access_code_id'],
@@ -16181,44 +17268,98 @@ export default {
16181
17268
  'x-fern-sdk-group-name': ['access_codes'],
16182
17269
  'x-fern-sdk-method-name': 'update',
16183
17270
  'x-response-key': null,
17271
+ 'x-title': 'Update an Access Code',
16184
17272
  },
16185
17273
  put: {
17274
+ description: 'Updates a specified active or upcoming [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).\n\nSee also [Modifying Access Codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/modifying-access-codes).',
16186
17275
  operationId: 'accessCodesUpdatePut',
16187
17276
  requestBody: {
16188
17277
  content: {
16189
17278
  'application/json': {
16190
17279
  schema: {
16191
17280
  properties: {
16192
- access_code_id: { format: 'uuid', type: 'string' },
16193
- allow_external_modification: { type: 'boolean' },
17281
+ access_code_id: {
17282
+ description: 'ID of the access code that you want to update.',
17283
+ format: 'uuid',
17284
+ type: 'string',
17285
+ },
17286
+ allow_external_modification: {
17287
+ description: 'Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`.',
17288
+ type: 'boolean',
17289
+ },
16194
17290
  attempt_for_offline_device: {
16195
17291
  default: true,
16196
17292
  type: 'boolean',
16197
17293
  },
16198
17294
  code: {
17295
+ description: 'Code to be used for access.',
16199
17296
  maxLength: 9,
16200
17297
  minLength: 4,
16201
17298
  pattern: '^\\d+$',
16202
17299
  type: 'string',
16203
17300
  },
16204
- device_id: { format: 'uuid', type: 'string' },
16205
- ends_at: { type: 'string' },
16206
- is_external_modification_allowed: { type: 'boolean' },
16207
- is_managed: { type: 'boolean' },
16208
- is_offline_access_code: { type: 'boolean' },
16209
- is_one_time_use: { type: 'boolean' },
17301
+ device_id: {
17302
+ description: 'ID of the device containing the access code that you want to update.',
17303
+ format: 'uuid',
17304
+ type: 'string',
17305
+ },
17306
+ ends_at: {
17307
+ description: 'Date and time at which the validity of the new access code ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`.',
17308
+ type: 'string',
17309
+ },
17310
+ is_external_modification_allowed: {
17311
+ description: 'Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`.',
17312
+ type: 'boolean',
17313
+ },
17314
+ is_managed: {
17315
+ description: 'Indicates whether the access code is managed through Seam. Note that to convert an unmanaged access code into a managed access code, use `/access_codes/unmanaged/convert_to_managed`.',
17316
+ type: 'boolean',
17317
+ },
17318
+ is_offline_access_code: {
17319
+ description: 'Indicates whether the access code is an [offline access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes).',
17320
+ type: 'boolean',
17321
+ },
17322
+ is_one_time_use: {
17323
+ description: 'Indicates whether the [offline access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes) is a single-use access code.',
17324
+ type: 'boolean',
17325
+ },
16210
17326
  max_time_rounding: {
16211
17327
  default: '1hour',
17328
+ description: 'Maximum rounding adjustment. To create a daily-bound [offline access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes) for devices that support this feature, set this parameter to `1d`.',
16212
17329
  enum: ['1hour', '1day', '1h', '1d'],
16213
17330
  type: 'string',
16214
17331
  },
16215
- name: { type: 'string' },
16216
- prefer_native_scheduling: { type: 'boolean' },
16217
- preferred_code_length: { format: 'float', type: 'number' },
16218
- starts_at: { type: 'string' },
16219
- sync: { default: false, type: 'boolean' },
16220
- type: { enum: ['ongoing', 'time_bound'], type: 'string' },
16221
- use_backup_access_code_pool: { type: 'boolean' },
17332
+ name: {
17333
+ description: 'Name of the new access code.',
17334
+ type: 'string',
17335
+ },
17336
+ prefer_native_scheduling: {
17337
+ description: 'Indicates whether [native scheduling](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#native-scheduling) should be used for time-bound codes when supported by the provider. Default: `true`.',
17338
+ type: 'boolean',
17339
+ },
17340
+ preferred_code_length: {
17341
+ description: 'Preferred code length. Only applicable if you do not specify a `code`. If the affected device does not support the preferred code length, Seam reverts to using the shortest supported code length.',
17342
+ format: 'float',
17343
+ type: 'number',
17344
+ },
17345
+ starts_at: {
17346
+ description: 'Date and time at which the validity of the new access code starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.',
17347
+ type: 'string',
17348
+ },
17349
+ sync: {
17350
+ default: false,
17351
+ type: 'boolean',
17352
+ 'x-undocumented': 'Only used internally.',
17353
+ },
17354
+ type: {
17355
+ description: 'Type to which you want to convert the access code. To convert a time-bound access code to an ongoing access code, set `type` to `ongoing`. See also [Changing a time-bound access code to permanent access](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/modifying-access-codes#special-case-2-changing-a-time-bound-access-code-to-permanent-access).',
17356
+ enum: ['ongoing', 'time_bound'],
17357
+ type: 'string',
17358
+ },
17359
+ use_backup_access_code_pool: {
17360
+ description: 'Indicates whether to use a [backup access code pool](https://docs.seam.co/latest/core-concepts/access-codes#backup-access-codes) provided by Seam. If `true`, you can use [`/access_codes/pull_backup_access_code`](https://docs.seam.co/latest/api-clients/access_codes/pull_backup_access_code).',
17361
+ type: 'boolean',
17362
+ },
16222
17363
  use_offline_access_code: { type: 'boolean' },
16223
17364
  },
16224
17365
  required: ['access_code_id'],
@@ -16259,20 +17400,34 @@ export default {
16259
17400
  'x-action-attempt-type': 'UPDATE_ACCESS_CODE',
16260
17401
  'x-fern-ignore': true,
16261
17402
  'x-response-key': null,
17403
+ 'x-title': 'Update an Access Code',
16262
17404
  },
16263
17405
  },
16264
17406
  '/access_codes/update_multiple': {
16265
17407
  patch: {
17408
+ description: 'Updates [access codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) that share a common code across multiple devices.\n\nSpecify the `common_code_key` to identify the set of access codes that you want to update.\n\nSee also [Update Linked Access Codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/creating-and-updating-multiple-linked-access-codes#update-linked-access-codes).',
16266
17409
  operationId: 'accessCodesUpdateMultiplePatch',
16267
17410
  requestBody: {
16268
17411
  content: {
16269
17412
  'application/json': {
16270
17413
  schema: {
16271
17414
  properties: {
16272
- common_code_key: { type: 'string' },
16273
- ends_at: { type: 'string' },
16274
- name: { type: 'string' },
16275
- starts_at: { type: 'string' },
17415
+ common_code_key: {
17416
+ description: 'Key that links the group of access codes, assigned on creation by `/access_codes/create_multiple`.',
17417
+ type: 'string',
17418
+ },
17419
+ ends_at: {
17420
+ description: 'Date and time at which the validity of the new access code ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`.',
17421
+ type: 'string',
17422
+ },
17423
+ name: {
17424
+ description: 'Name of the new access code.',
17425
+ type: 'string',
17426
+ },
17427
+ starts_at: {
17428
+ description: 'Date and time at which the validity of the new access code starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.',
17429
+ type: 'string',
17430
+ },
16276
17431
  },
16277
17432
  required: ['common_code_key'],
16278
17433
  type: 'object',
@@ -16306,18 +17461,32 @@ export default {
16306
17461
  tags: ['/access_codes'],
16307
17462
  'x-fern-ignore': true,
16308
17463
  'x-response-key': null,
17464
+ 'x-title': 'Update Multiple Linked Access Codes',
16309
17465
  },
16310
17466
  post: {
17467
+ description: 'Updates [access codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) that share a common code across multiple devices.\n\nSpecify the `common_code_key` to identify the set of access codes that you want to update.\n\nSee also [Update Linked Access Codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/creating-and-updating-multiple-linked-access-codes#update-linked-access-codes).',
16311
17468
  operationId: 'accessCodesUpdateMultiplePost',
16312
17469
  requestBody: {
16313
17470
  content: {
16314
17471
  'application/json': {
16315
17472
  schema: {
16316
17473
  properties: {
16317
- common_code_key: { type: 'string' },
16318
- ends_at: { type: 'string' },
16319
- name: { type: 'string' },
16320
- starts_at: { type: 'string' },
17474
+ common_code_key: {
17475
+ description: 'Key that links the group of access codes, assigned on creation by `/access_codes/create_multiple`.',
17476
+ type: 'string',
17477
+ },
17478
+ ends_at: {
17479
+ description: 'Date and time at which the validity of the new access code ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`.',
17480
+ type: 'string',
17481
+ },
17482
+ name: {
17483
+ description: 'Name of the new access code.',
17484
+ type: 'string',
17485
+ },
17486
+ starts_at: {
17487
+ description: 'Date and time at which the validity of the new access code starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.',
17488
+ type: 'string',
17489
+ },
16321
17490
  },
16322
17491
  required: ['common_code_key'],
16323
17492
  type: 'object',
@@ -16352,6 +17521,7 @@ export default {
16352
17521
  'x-fern-sdk-group-name': ['access_codes'],
16353
17522
  'x-fern-sdk-method-name': 'update_multiple',
16354
17523
  'x-response-key': null,
17524
+ 'x-title': 'Update Multiple Linked Access Codes',
16355
17525
  },
16356
17526
  },
16357
17527
  '/acs/access_groups/add_user': {