@seamapi/types 1.376.0 → 1.378.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (25) hide show
  1. package/dist/connect.cjs +1669 -398
  2. package/dist/connect.cjs.map +1 -1
  3. package/dist/connect.d.cts +1461 -183
  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/models/acs/acs-users/acs-user.d.ts +28 -28
  9. package/lib/seam/connect/models/acs/acs-users/pending-mutations.d.ts +195 -10
  10. package/lib/seam/connect/models/acs/acs-users/pending-mutations.js +16 -3
  11. package/lib/seam/connect/models/acs/acs-users/pending-mutations.js.map +1 -1
  12. package/lib/seam/connect/models/bridges/bridge-client-session.d.ts +80 -80
  13. package/lib/seam/connect/models/bridges/bridge-client-session.js +5 -0
  14. package/lib/seam/connect/models/bridges/bridge-client-session.js.map +1 -1
  15. package/lib/seam/connect/openapi.d.ts +295 -10
  16. package/lib/seam/connect/openapi.js +1587 -347
  17. package/lib/seam/connect/openapi.js.map +1 -1
  18. package/lib/seam/connect/route-types.d.ts +1113 -120
  19. package/package.json +1 -1
  20. package/src/lib/seam/connect/models/access-codes/managed-access-code.ts +95 -60
  21. package/src/lib/seam/connect/models/access-codes/unmanaged-access-code.ts +15 -2
  22. package/src/lib/seam/connect/models/acs/acs-users/pending-mutations.ts +17 -3
  23. package/src/lib/seam/connect/models/bridges/bridge-client-session.ts +5 -0
  24. package/src/lib/seam/connect/openapi.ts +1923 -360
  25. package/src/lib/seam/connect/route-types.ts +1113 -120
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'],
@@ -2290,14 +2640,13 @@ export default {
2290
2640
  from: {
2291
2641
  properties: {
2292
2642
  ends_at: {
2293
- description: "Date and time at which the user's access ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.",
2294
2643
  format: 'date-time',
2295
2644
  nullable: true,
2296
2645
  type: 'string',
2297
2646
  },
2298
2647
  starts_at: {
2299
- description: "Date and time at which the user's access starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.",
2300
2648
  format: 'date-time',
2649
+ nullable: true,
2301
2650
  type: 'string',
2302
2651
  },
2303
2652
  },
@@ -2311,14 +2660,13 @@ export default {
2311
2660
  to: {
2312
2661
  properties: {
2313
2662
  ends_at: {
2314
- description: "Date and time at which the user's access ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.",
2315
2663
  format: 'date-time',
2316
2664
  nullable: true,
2317
2665
  type: 'string',
2318
2666
  },
2319
2667
  starts_at: {
2320
- description: "Date and time at which the user's access starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.",
2321
2668
  format: 'date-time',
2669
+ nullable: true,
2322
2670
  type: 'string',
2323
2671
  },
2324
2672
  },
@@ -12341,6 +12689,7 @@ export default {
12341
12689
  'x-route-path': '/thermostats/schedules',
12342
12690
  },
12343
12691
  unmanaged_access_code: {
12692
+ 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
12693
  properties: {
12345
12694
  access_code_id: {
12346
12695
  description: 'Unique identifier for the access code.',
@@ -12369,21 +12718,32 @@ export default {
12369
12718
  type: 'string',
12370
12719
  },
12371
12720
  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.',
12721
+ description: 'Errors associated with the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).',
12373
12722
  items: {
12374
12723
  discriminator: { propertyName: 'error_code' },
12375
12724
  oneOf: [
12376
12725
  {
12377
- description: 'Failed to set code on Smart Things device.',
12726
+ description: 'Failed to set code on SmartThings device.',
12378
12727
  properties: {
12379
- created_at: { format: 'date-time', type: 'string' },
12728
+ created_at: {
12729
+ description: 'Date and time at which Seam created the error.',
12730
+ format: 'date-time',
12731
+ type: 'string',
12732
+ },
12380
12733
  error_code: {
12381
12734
  description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
12382
12735
  enum: ['smartthings_failed_to_set_access_code'],
12383
12736
  type: 'string',
12384
12737
  },
12385
- is_access_code_error: { enum: [true], type: 'boolean' },
12386
- message: { type: 'string' },
12738
+ is_access_code_error: {
12739
+ description: 'Indicates that this is an access code error.',
12740
+ enum: [true],
12741
+ type: 'boolean',
12742
+ },
12743
+ message: {
12744
+ description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
12745
+ type: 'string',
12746
+ },
12387
12747
  },
12388
12748
  required: ['message', 'is_access_code_error', 'error_code'],
12389
12749
  type: 'object',
@@ -12391,7 +12751,11 @@ export default {
12391
12751
  {
12392
12752
  description: 'Failed to set code after multiple retries.',
12393
12753
  properties: {
12394
- created_at: { format: 'date-time', type: 'string' },
12754
+ created_at: {
12755
+ description: 'Date and time at which Seam created the error.',
12756
+ format: 'date-time',
12757
+ type: 'string',
12758
+ },
12395
12759
  error_code: {
12396
12760
  description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
12397
12761
  enum: [
@@ -12399,8 +12763,15 @@ export default {
12399
12763
  ],
12400
12764
  type: 'string',
12401
12765
  },
12402
- is_access_code_error: { enum: [true], type: 'boolean' },
12403
- message: { type: 'string' },
12766
+ is_access_code_error: {
12767
+ description: 'Indicates that this is an access code error.',
12768
+ enum: [true],
12769
+ type: 'boolean',
12770
+ },
12771
+ message: {
12772
+ description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
12773
+ type: 'string',
12774
+ },
12404
12775
  },
12405
12776
  required: ['message', 'is_access_code_error', 'error_code'],
12406
12777
  type: 'object',
@@ -12408,14 +12779,25 @@ export default {
12408
12779
  {
12409
12780
  description: 'No free slots available on the device.',
12410
12781
  properties: {
12411
- created_at: { format: 'date-time', type: 'string' },
12782
+ created_at: {
12783
+ description: 'Date and time at which Seam created the error.',
12784
+ format: 'date-time',
12785
+ type: 'string',
12786
+ },
12412
12787
  error_code: {
12413
12788
  description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
12414
12789
  enum: ['smartthings_no_free_slots_available'],
12415
12790
  type: 'string',
12416
12791
  },
12417
- is_access_code_error: { enum: [true], type: 'boolean' },
12418
- message: { type: 'string' },
12792
+ is_access_code_error: {
12793
+ description: 'Indicates that this is an access code error.',
12794
+ enum: [true],
12795
+ type: 'boolean',
12796
+ },
12797
+ message: {
12798
+ description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
12799
+ type: 'string',
12800
+ },
12419
12801
  },
12420
12802
  required: ['message', 'is_access_code_error', 'error_code'],
12421
12803
  type: 'object',
@@ -12423,14 +12805,25 @@ export default {
12423
12805
  {
12424
12806
  description: 'Failed to set code on device.',
12425
12807
  properties: {
12426
- created_at: { format: 'date-time', type: 'string' },
12808
+ created_at: {
12809
+ description: 'Date and time at which Seam created the error.',
12810
+ format: 'date-time',
12811
+ type: 'string',
12812
+ },
12427
12813
  error_code: {
12428
12814
  description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
12429
12815
  enum: ['failed_to_set_on_device'],
12430
12816
  type: 'string',
12431
12817
  },
12432
- is_access_code_error: { enum: [true], type: 'boolean' },
12433
- message: { type: 'string' },
12818
+ is_access_code_error: {
12819
+ description: 'Indicates that this is an access code error.',
12820
+ enum: [true],
12821
+ type: 'boolean',
12822
+ },
12823
+ message: {
12824
+ description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
12825
+ type: 'string',
12826
+ },
12434
12827
  },
12435
12828
  required: ['message', 'is_access_code_error', 'error_code'],
12436
12829
  type: 'object',
@@ -12438,14 +12831,25 @@ export default {
12438
12831
  {
12439
12832
  description: 'Failed to remove code from device.',
12440
12833
  properties: {
12441
- created_at: { format: 'date-time', type: 'string' },
12834
+ created_at: {
12835
+ description: 'Date and time at which Seam created the error.',
12836
+ format: 'date-time',
12837
+ type: 'string',
12838
+ },
12442
12839
  error_code: {
12443
12840
  description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
12444
12841
  enum: ['failed_to_remove_from_device'],
12445
12842
  type: 'string',
12446
12843
  },
12447
- is_access_code_error: { enum: [true], type: 'boolean' },
12448
- message: { type: 'string' },
12844
+ is_access_code_error: {
12845
+ description: 'Indicates that this is an access code error.',
12846
+ enum: [true],
12847
+ type: 'boolean',
12848
+ },
12849
+ message: {
12850
+ description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
12851
+ type: 'string',
12852
+ },
12449
12853
  },
12450
12854
  required: ['message', 'is_access_code_error', 'error_code'],
12451
12855
  type: 'object',
@@ -12453,14 +12857,25 @@ export default {
12453
12857
  {
12454
12858
  description: 'Duplicate access code detected on device.',
12455
12859
  properties: {
12456
- created_at: { format: 'date-time', type: 'string' },
12860
+ created_at: {
12861
+ description: 'Date and time at which Seam created the error.',
12862
+ format: 'date-time',
12863
+ type: 'string',
12864
+ },
12457
12865
  error_code: {
12458
12866
  description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
12459
12867
  enum: ['duplicate_code_on_device'],
12460
12868
  type: 'string',
12461
12869
  },
12462
- is_access_code_error: { enum: [true], type: 'boolean' },
12463
- message: { type: 'string' },
12870
+ is_access_code_error: {
12871
+ description: 'Indicates that this is an access code error.',
12872
+ enum: [true],
12873
+ type: 'boolean',
12874
+ },
12875
+ message: {
12876
+ description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
12877
+ type: 'string',
12878
+ },
12464
12879
  },
12465
12880
  required: ['message', 'is_access_code_error', 'error_code'],
12466
12881
  type: 'object',
@@ -12468,14 +12883,25 @@ export default {
12468
12883
  {
12469
12884
  description: 'An attempt to modify this access code was prevented.',
12470
12885
  properties: {
12471
- created_at: { format: 'date-time', type: 'string' },
12886
+ created_at: {
12887
+ description: 'Date and time at which Seam created the error.',
12888
+ format: 'date-time',
12889
+ type: 'string',
12890
+ },
12472
12891
  error_code: {
12473
12892
  description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
12474
12893
  enum: ['duplicate_code_attempt_prevented'],
12475
12894
  type: 'string',
12476
12895
  },
12477
- is_access_code_error: { enum: [true], type: 'boolean' },
12478
- message: { type: 'string' },
12896
+ is_access_code_error: {
12897
+ description: 'Indicates that this is an access code error.',
12898
+ enum: [true],
12899
+ type: 'boolean',
12900
+ },
12901
+ message: {
12902
+ description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
12903
+ type: 'string',
12904
+ },
12479
12905
  },
12480
12906
  required: ['message', 'is_access_code_error', 'error_code'],
12481
12907
  type: 'object',
@@ -12483,14 +12909,25 @@ export default {
12483
12909
  {
12484
12910
  description: 'Igloohome bridge has too many pending jobs in the queue.',
12485
12911
  properties: {
12486
- created_at: { format: 'date-time', type: 'string' },
12912
+ created_at: {
12913
+ description: 'Date and time at which Seam created the error.',
12914
+ format: 'date-time',
12915
+ type: 'string',
12916
+ },
12487
12917
  error_code: {
12488
12918
  description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
12489
12919
  enum: ['igloohome_bridge_too_many_pending_jobs'],
12490
12920
  type: 'string',
12491
12921
  },
12492
- is_access_code_error: { enum: [true], type: 'boolean' },
12493
- message: { type: 'string' },
12922
+ is_access_code_error: {
12923
+ description: 'Indicates that this is an access code error.',
12924
+ enum: [true],
12925
+ type: 'boolean',
12926
+ },
12927
+ message: {
12928
+ description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
12929
+ type: 'string',
12930
+ },
12494
12931
  },
12495
12932
  required: ['message', 'is_access_code_error', 'error_code'],
12496
12933
  type: 'object',
@@ -12498,22 +12935,37 @@ export default {
12498
12935
  {
12499
12936
  description: 'Igloohome bridge is offline.',
12500
12937
  properties: {
12501
- created_at: { format: 'date-time', type: 'string' },
12938
+ created_at: {
12939
+ description: 'Date and time at which Seam created the error.',
12940
+ format: 'date-time',
12941
+ type: 'string',
12942
+ },
12502
12943
  error_code: {
12503
12944
  description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
12504
12945
  enum: ['igloohome_bridge_offline'],
12505
12946
  type: 'string',
12506
12947
  },
12507
- is_access_code_error: { enum: [true], type: 'boolean' },
12508
- message: { type: 'string' },
12948
+ is_access_code_error: {
12949
+ description: 'Indicates that this is an access code error.',
12950
+ enum: [true],
12951
+ type: 'boolean',
12952
+ },
12953
+ message: {
12954
+ description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
12955
+ type: 'string',
12956
+ },
12509
12957
  },
12510
12958
  required: ['message', 'is_access_code_error', 'error_code'],
12511
12959
  type: 'object',
12512
12960
  },
12513
12961
  {
12514
- description: 'Lock as reached max amount of codes.',
12962
+ description: 'Lock has reached maximum amount of codes.',
12515
12963
  properties: {
12516
- created_at: { format: 'date-time', type: 'string' },
12964
+ created_at: {
12965
+ description: 'Date and time at which Seam created the error.',
12966
+ format: 'date-time',
12967
+ type: 'string',
12968
+ },
12517
12969
  error_code: {
12518
12970
  description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
12519
12971
  enum: [
@@ -12521,23 +12973,41 @@ export default {
12521
12973
  ],
12522
12974
  type: 'string',
12523
12975
  },
12524
- is_access_code_error: { enum: [true], type: 'boolean' },
12525
- message: { type: 'string' },
12976
+ is_access_code_error: {
12977
+ description: 'Indicates that this is an access code error.',
12978
+ enum: [true],
12979
+ type: 'boolean',
12980
+ },
12981
+ message: {
12982
+ description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
12983
+ type: 'string',
12984
+ },
12526
12985
  },
12527
12986
  required: ['message', 'is_access_code_error', 'error_code'],
12528
12987
  type: 'object',
12529
12988
  },
12530
12989
  {
12531
- description: 'Unable to confirm the access code is set on Kwikset device.',
12990
+ description: 'Unable to confirm that the access code is set on Kwikset device.',
12532
12991
  properties: {
12533
- created_at: { format: 'date-time', type: 'string' },
12992
+ created_at: {
12993
+ description: 'Date and time at which Seam created the error.',
12994
+ format: 'date-time',
12995
+ type: 'string',
12996
+ },
12534
12997
  error_code: {
12535
12998
  description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
12536
12999
  enum: ['kwikset_unable_to_confirm_code'],
12537
13000
  type: 'string',
12538
13001
  },
12539
- is_access_code_error: { enum: [true], type: 'boolean' },
12540
- message: { type: 'string' },
13002
+ is_access_code_error: {
13003
+ description: 'Indicates that this is an access code error.',
13004
+ enum: [true],
13005
+ type: 'boolean',
13006
+ },
13007
+ message: {
13008
+ description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
13009
+ type: 'string',
13010
+ },
12541
13011
  },
12542
13012
  required: ['message', 'is_access_code_error', 'error_code'],
12543
13013
  type: 'object',
@@ -12545,14 +13015,25 @@ export default {
12545
13015
  {
12546
13016
  description: 'Unable to confirm the deletion of the access code on Kwikset device.',
12547
13017
  properties: {
12548
- created_at: { format: 'date-time', type: 'string' },
13018
+ created_at: {
13019
+ description: 'Date and time at which Seam created the error.',
13020
+ format: 'date-time',
13021
+ type: 'string',
13022
+ },
12549
13023
  error_code: {
12550
13024
  description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
12551
13025
  enum: ['kwikset_unable_to_confirm_deletion'],
12552
13026
  type: 'string',
12553
13027
  },
12554
- is_access_code_error: { enum: [true], type: 'boolean' },
12555
- message: { type: 'string' },
13028
+ is_access_code_error: {
13029
+ description: 'Indicates that this is an access code error.',
13030
+ enum: [true],
13031
+ type: 'boolean',
13032
+ },
13033
+ message: {
13034
+ description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
13035
+ type: 'string',
13036
+ },
12556
13037
  },
12557
13038
  required: ['message', 'is_access_code_error', 'error_code'],
12558
13039
  type: 'object',
@@ -12560,14 +13041,25 @@ export default {
12560
13041
  {
12561
13042
  description: 'Code was modified or removed externally after Seam successfully set it on the device.',
12562
13043
  properties: {
12563
- created_at: { format: 'date-time', type: 'string' },
13044
+ created_at: {
13045
+ description: 'Date and time at which Seam created the error.',
13046
+ format: 'date-time',
13047
+ type: 'string',
13048
+ },
12564
13049
  error_code: {
12565
13050
  description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
12566
13051
  enum: ['code_modified_external_to_seam'],
12567
13052
  type: 'string',
12568
13053
  },
12569
- is_access_code_error: { enum: [true], type: 'boolean' },
12570
- message: { type: 'string' },
13054
+ is_access_code_error: {
13055
+ description: 'Indicates that this is an access code error.',
13056
+ enum: [true],
13057
+ type: 'boolean',
13058
+ },
13059
+ message: {
13060
+ description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
13061
+ type: 'string',
13062
+ },
12571
13063
  },
12572
13064
  required: ['message', 'is_access_code_error', 'error_code'],
12573
13065
  type: 'object',
@@ -12575,14 +13067,25 @@ export default {
12575
13067
  {
12576
13068
  description: 'Invalid code length for August lock.',
12577
13069
  properties: {
12578
- created_at: { format: 'date-time', type: 'string' },
13070
+ created_at: {
13071
+ description: 'Date and time at which Seam created the error.',
13072
+ format: 'date-time',
13073
+ type: 'string',
13074
+ },
12579
13075
  error_code: {
12580
13076
  description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
12581
13077
  enum: ['august_lock_invalid_code_length'],
12582
13078
  type: 'string',
12583
13079
  },
12584
- is_access_code_error: { enum: [true], type: 'boolean' },
12585
- message: { type: 'string' },
13080
+ is_access_code_error: {
13081
+ description: 'Indicates that this is an access code error.',
13082
+ enum: [true],
13083
+ type: 'boolean',
13084
+ },
13085
+ message: {
13086
+ description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
13087
+ type: 'string',
13088
+ },
12586
13089
  },
12587
13090
  required: ['message', 'is_access_code_error', 'error_code'],
12588
13091
  type: 'object',
@@ -12590,14 +13093,25 @@ export default {
12590
13093
  {
12591
13094
  description: 'Access code has not yet been fully moved to the device.',
12592
13095
  properties: {
12593
- created_at: { format: 'date-time', type: 'string' },
13096
+ created_at: {
13097
+ description: 'Date and time at which Seam created the error.',
13098
+ format: 'date-time',
13099
+ type: 'string',
13100
+ },
12594
13101
  error_code: {
12595
13102
  description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
12596
13103
  enum: ['august_device_programming_delay'],
12597
13104
  type: 'string',
12598
13105
  },
12599
- is_access_code_error: { enum: [true], type: 'boolean' },
12600
- message: { type: 'string' },
13106
+ is_access_code_error: {
13107
+ description: 'Indicates that this is an access code error.',
13108
+ enum: [true],
13109
+ type: 'boolean',
13110
+ },
13111
+ message: {
13112
+ description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
13113
+ type: 'string',
13114
+ },
12601
13115
  },
12602
13116
  required: ['message', 'is_access_code_error', 'error_code'],
12603
13117
  type: 'object',
@@ -12605,14 +13119,25 @@ export default {
12605
13119
  {
12606
13120
  description: 'All access code slots on the device are full.',
12607
13121
  properties: {
12608
- created_at: { format: 'date-time', type: 'string' },
13122
+ created_at: {
13123
+ description: 'Date and time at which Seam created the error.',
13124
+ format: 'date-time',
13125
+ type: 'string',
13126
+ },
12609
13127
  error_code: {
12610
13128
  description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
12611
13129
  enum: ['august_device_slots_full'],
12612
13130
  type: 'string',
12613
13131
  },
12614
- is_access_code_error: { enum: [true], type: 'boolean' },
12615
- message: { type: 'string' },
13132
+ is_access_code_error: {
13133
+ description: 'Indicates that this is an access code error.',
13134
+ enum: [true],
13135
+ type: 'boolean',
13136
+ },
13137
+ message: {
13138
+ description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
13139
+ type: 'string',
13140
+ },
12616
13141
  },
12617
13142
  required: ['message', 'is_access_code_error', 'error_code'],
12618
13143
  type: 'object',
@@ -12620,14 +13145,25 @@ export default {
12620
13145
  {
12621
13146
  description: 'August lock is missing a keypad.',
12622
13147
  properties: {
12623
- created_at: { format: 'date-time', type: 'string' },
13148
+ created_at: {
13149
+ description: 'Date and time at which Seam created the error.',
13150
+ format: 'date-time',
13151
+ type: 'string',
13152
+ },
12624
13153
  error_code: {
12625
13154
  description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
12626
13155
  enum: ['august_lock_missing_keypad'],
12627
13156
  type: 'string',
12628
13157
  },
12629
- is_access_code_error: { enum: [true], type: 'boolean' },
12630
- message: { type: 'string' },
13158
+ is_access_code_error: {
13159
+ description: 'Indicates that this is an access code error.',
13160
+ enum: [true],
13161
+ type: 'boolean',
13162
+ },
13163
+ message: {
13164
+ description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
13165
+ type: 'string',
13166
+ },
12631
13167
  },
12632
13168
  required: ['message', 'is_access_code_error', 'error_code'],
12633
13169
  type: 'object',
@@ -12635,14 +13171,25 @@ export default {
12635
13171
  {
12636
13172
  description: 'August lock is temporarily offline.',
12637
13173
  properties: {
12638
- created_at: { format: 'date-time', type: 'string' },
13174
+ created_at: {
13175
+ description: 'Date and time at which Seam created the error.',
13176
+ format: 'date-time',
13177
+ type: 'string',
13178
+ },
12639
13179
  error_code: {
12640
13180
  description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
12641
13181
  enum: ['august_lock_temporarily_offline'],
12642
13182
  type: 'string',
12643
13183
  },
12644
- is_access_code_error: { enum: [true], type: 'boolean' },
12645
- message: { type: 'string' },
13184
+ is_access_code_error: {
13185
+ description: 'Indicates that this is an access code error.',
13186
+ enum: [true],
13187
+ type: 'boolean',
13188
+ },
13189
+ message: {
13190
+ description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
13191
+ type: 'string',
13192
+ },
12646
13193
  },
12647
13194
  required: ['message', 'is_access_code_error', 'error_code'],
12648
13195
  type: 'object',
@@ -12650,14 +13197,25 @@ export default {
12650
13197
  {
12651
13198
  description: 'Salto site user is not subscribed.',
12652
13199
  properties: {
12653
- created_at: { format: 'date-time', type: 'string' },
13200
+ created_at: {
13201
+ description: 'Date and time at which Seam created the error.',
13202
+ format: 'date-time',
13203
+ type: 'string',
13204
+ },
12654
13205
  error_code: {
12655
13206
  description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
12656
13207
  enum: ['salto_ks_user_not_subscribed'],
12657
13208
  type: 'string',
12658
13209
  },
12659
- is_access_code_error: { enum: [true], type: 'boolean' },
12660
- message: { type: 'string' },
13210
+ is_access_code_error: {
13211
+ description: 'Indicates that this is an access code error.',
13212
+ enum: [true],
13213
+ type: 'boolean',
13214
+ },
13215
+ message: {
13216
+ description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
13217
+ type: 'string',
13218
+ },
12661
13219
  },
12662
13220
  required: ['message', 'is_access_code_error', 'error_code'],
12663
13221
  type: 'object',
@@ -12665,14 +13223,25 @@ export default {
12665
13223
  {
12666
13224
  description: 'Access code has not yet been fully moved to the device.',
12667
13225
  properties: {
12668
- created_at: { format: 'date-time', type: 'string' },
13226
+ created_at: {
13227
+ description: 'Date and time at which Seam created the error.',
13228
+ format: 'date-time',
13229
+ type: 'string',
13230
+ },
12669
13231
  error_code: {
12670
13232
  description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
12671
13233
  enum: ['hubitat_device_programming_delay'],
12672
13234
  type: 'string',
12673
13235
  },
12674
- is_access_code_error: { enum: [true], type: 'boolean' },
12675
- message: { type: 'string' },
13236
+ is_access_code_error: {
13237
+ description: 'Indicates that this is an access code error.',
13238
+ enum: [true],
13239
+ type: 'boolean',
13240
+ },
13241
+ message: {
13242
+ description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
13243
+ type: 'string',
13244
+ },
12676
13245
  },
12677
13246
  required: ['message', 'is_access_code_error', 'error_code'],
12678
13247
  type: 'object',
@@ -12680,14 +13249,25 @@ export default {
12680
13249
  {
12681
13250
  description: 'No free positions available on the device.',
12682
13251
  properties: {
12683
- created_at: { format: 'date-time', type: 'string' },
13252
+ created_at: {
13253
+ description: 'Date and time at which Seam created the error.',
13254
+ format: 'date-time',
13255
+ type: 'string',
13256
+ },
12684
13257
  error_code: {
12685
13258
  description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
12686
13259
  enum: ['hubitat_no_free_positions_available'],
12687
13260
  type: 'string',
12688
13261
  },
12689
- is_access_code_error: { enum: [true], type: 'boolean' },
12690
- message: { type: 'string' },
13262
+ is_access_code_error: {
13263
+ description: 'Indicates that this is an access code error.',
13264
+ enum: [true],
13265
+ type: 'boolean',
13266
+ },
13267
+ message: {
13268
+ description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
13269
+ type: 'string',
13270
+ },
12691
13271
  },
12692
13272
  required: ['message', 'is_access_code_error', 'error_code'],
12693
13273
  type: 'object',
@@ -12695,14 +13275,25 @@ export default {
12695
13275
  {
12696
13276
  description: 'Duplicate access code name detected.',
12697
13277
  properties: {
12698
- created_at: { format: 'date-time', type: 'string' },
13278
+ created_at: {
13279
+ description: 'Date and time at which Seam created the error.',
13280
+ format: 'date-time',
13281
+ type: 'string',
13282
+ },
12699
13283
  error_code: {
12700
13284
  description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
12701
13285
  enum: ['wyze_duplicate_code_name'],
12702
13286
  type: 'string',
12703
13287
  },
12704
- is_access_code_error: { enum: [true], type: 'boolean' },
12705
- message: { type: 'string' },
13288
+ is_access_code_error: {
13289
+ description: 'Indicates that this is an access code error.',
13290
+ enum: [true],
13291
+ type: 'boolean',
13292
+ },
13293
+ message: {
13294
+ description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
13295
+ type: 'string',
13296
+ },
12706
13297
  },
12707
13298
  required: ['message', 'is_access_code_error', 'error_code'],
12708
13299
  type: 'object',
@@ -12710,14 +13301,25 @@ export default {
12710
13301
  {
12711
13302
  description: 'Potential duplicate access code detected.',
12712
13303
  properties: {
12713
- created_at: { format: 'date-time', type: 'string' },
13304
+ created_at: {
13305
+ description: 'Date and time at which Seam created the error.',
13306
+ format: 'date-time',
13307
+ type: 'string',
13308
+ },
12714
13309
  error_code: {
12715
13310
  description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
12716
13311
  enum: ['wyze_potential_duplicate_code'],
12717
13312
  type: 'string',
12718
13313
  },
12719
- is_access_code_error: { enum: [true], type: 'boolean' },
12720
- message: { type: 'string' },
13314
+ is_access_code_error: {
13315
+ description: 'Indicates that this is an access code error.',
13316
+ enum: [true],
13317
+ type: 'boolean',
13318
+ },
13319
+ message: {
13320
+ description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
13321
+ type: 'string',
13322
+ },
12721
13323
  },
12722
13324
  required: ['message', 'is_access_code_error', 'error_code'],
12723
13325
  type: 'object',
@@ -12725,14 +13327,25 @@ export default {
12725
13327
  {
12726
13328
  description: 'No valid user level for Oracode.',
12727
13329
  properties: {
12728
- created_at: { format: 'date-time', type: 'string' },
13330
+ created_at: {
13331
+ description: 'Date and time at which Seam created the error.',
13332
+ format: 'date-time',
13333
+ type: 'string',
13334
+ },
12729
13335
  error_code: {
12730
13336
  description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
12731
13337
  enum: ['dormakaba_oracode_no_valid_user_level'],
12732
13338
  type: 'string',
12733
13339
  },
12734
- is_access_code_error: { enum: [true], type: 'boolean' },
12735
- message: { type: 'string' },
13340
+ is_access_code_error: {
13341
+ description: 'Indicates that this is an access code error.',
13342
+ enum: [true],
13343
+ type: 'boolean',
13344
+ },
13345
+ message: {
13346
+ description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
13347
+ type: 'string',
13348
+ },
12736
13349
  },
12737
13350
  required: ['message', 'is_access_code_error', 'error_code'],
12738
13351
  type: 'object',
@@ -13051,7 +13664,11 @@ export default {
13051
13664
  },
13052
13665
  type: 'array',
13053
13666
  },
13054
- is_managed: { enum: [false], type: 'boolean' },
13667
+ is_managed: {
13668
+ description: 'Indicates that Seam does not manage the access code.',
13669
+ enum: [false],
13670
+ type: 'boolean',
13671
+ },
13055
13672
  name: {
13056
13673
  description: 'Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.',
13057
13674
  nullable: true,
@@ -13063,22 +13680,34 @@ export default {
13063
13680
  nullable: true,
13064
13681
  type: 'string',
13065
13682
  },
13066
- status: { enum: ['set'], type: 'string' },
13683
+ status: {
13684
+ description: 'Current status of the access code within the operational lifecycle. `set` indicates that the code is active and operational.',
13685
+ enum: ['set'],
13686
+ type: 'string',
13687
+ },
13067
13688
  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.',
13689
+ 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
13690
  enum: ['time_bound', 'ongoing'],
13070
13691
  type: 'string',
13071
13692
  },
13072
13693
  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.',
13694
+ description: 'Warnings associated with the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).',
13074
13695
  items: {
13696
+ description: 'Warnings associated with the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).',
13075
13697
  discriminator: { propertyName: 'warning_code' },
13076
13698
  oneOf: [
13077
13699
  {
13078
- description: 'Failed to set code on Smart Things device.',
13700
+ description: 'Failed to set code on SmartThings device.',
13079
13701
  properties: {
13080
- created_at: { format: 'date-time', type: 'string' },
13081
- message: { type: 'string' },
13702
+ created_at: {
13703
+ description: 'Date and time at which Seam created the warning.',
13704
+ format: 'date-time',
13705
+ type: 'string',
13706
+ },
13707
+ message: {
13708
+ description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
13709
+ type: 'string',
13710
+ },
13082
13711
  warning_code: {
13083
13712
  description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
13084
13713
  enum: ['smartthings_failed_to_set_access_code'],
@@ -13091,8 +13720,15 @@ export default {
13091
13720
  {
13092
13721
  description: 'Duplicate access code detected.',
13093
13722
  properties: {
13094
- created_at: { format: 'date-time', type: 'string' },
13095
- message: { type: 'string' },
13723
+ created_at: {
13724
+ description: 'Date and time at which Seam created the warning.',
13725
+ format: 'date-time',
13726
+ type: 'string',
13727
+ },
13728
+ message: {
13729
+ description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
13730
+ type: 'string',
13731
+ },
13096
13732
  warning_code: {
13097
13733
  description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
13098
13734
  enum: ['schlage_detected_duplicate'],
@@ -13105,8 +13741,15 @@ export default {
13105
13741
  {
13106
13742
  description: 'Received an error when attempting to create this code.',
13107
13743
  properties: {
13108
- created_at: { format: 'date-time', type: 'string' },
13109
- message: { type: 'string' },
13744
+ created_at: {
13745
+ description: 'Date and time at which Seam created the warning.',
13746
+ format: 'date-time',
13747
+ type: 'string',
13748
+ },
13749
+ message: {
13750
+ description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
13751
+ type: 'string',
13752
+ },
13110
13753
  warning_code: {
13111
13754
  description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
13112
13755
  enum: ['schlage_creation_outage'],
@@ -13119,8 +13762,15 @@ export default {
13119
13762
  {
13120
13763
  description: 'Code was modified or removed externally after Seam successfully set it on the device.',
13121
13764
  properties: {
13122
- created_at: { format: 'date-time', type: 'string' },
13123
- message: { type: 'string' },
13765
+ created_at: {
13766
+ description: 'Date and time at which Seam created the warning.',
13767
+ format: 'date-time',
13768
+ type: 'string',
13769
+ },
13770
+ message: {
13771
+ description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
13772
+ type: 'string',
13773
+ },
13124
13774
  warning_code: {
13125
13775
  description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
13126
13776
  enum: ['code_modified_external_to_seam'],
@@ -13133,8 +13783,15 @@ export default {
13133
13783
  {
13134
13784
  description: 'Delay in setting code on device.',
13135
13785
  properties: {
13136
- created_at: { format: 'date-time', type: 'string' },
13137
- message: { type: 'string' },
13786
+ created_at: {
13787
+ description: 'Date and time at which Seam created the warning.',
13788
+ format: 'date-time',
13789
+ type: 'string',
13790
+ },
13791
+ message: {
13792
+ description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
13793
+ type: 'string',
13794
+ },
13138
13795
  warning_code: {
13139
13796
  description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
13140
13797
  enum: ['delay_in_setting_on_device'],
@@ -13147,8 +13804,15 @@ export default {
13147
13804
  {
13148
13805
  description: 'Delay in removing code from device.',
13149
13806
  properties: {
13150
- created_at: { format: 'date-time', type: 'string' },
13151
- message: { type: 'string' },
13807
+ created_at: {
13808
+ description: 'Date and time at which Seam created the warning.',
13809
+ format: 'date-time',
13810
+ type: 'string',
13811
+ },
13812
+ message: {
13813
+ description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
13814
+ type: 'string',
13815
+ },
13152
13816
  warning_code: {
13153
13817
  description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
13154
13818
  enum: ['delay_in_removing_from_device'],
@@ -13159,10 +13823,17 @@ export default {
13159
13823
  type: 'object',
13160
13824
  },
13161
13825
  {
13162
- description: 'Third party integration detected that may cause access codes to fail.',
13826
+ description: 'Third-party integration detected that may cause access codes to fail.',
13163
13827
  properties: {
13164
- created_at: { format: 'date-time', type: 'string' },
13165
- message: { type: 'string' },
13828
+ created_at: {
13829
+ description: 'Date and time at which Seam created the warning.',
13830
+ format: 'date-time',
13831
+ type: 'string',
13832
+ },
13833
+ message: {
13834
+ description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
13835
+ type: 'string',
13836
+ },
13166
13837
  warning_code: {
13167
13838
  description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
13168
13839
  enum: ['third_party_integration_detected'],
@@ -13175,8 +13846,15 @@ export default {
13175
13846
  {
13176
13847
  description: 'Access code has not yet been fully moved to the device.',
13177
13848
  properties: {
13178
- created_at: { format: 'date-time', type: 'string' },
13179
- message: { type: 'string' },
13849
+ created_at: {
13850
+ description: 'Date and time at which Seam created the warning.',
13851
+ format: 'date-time',
13852
+ type: 'string',
13853
+ },
13854
+ message: {
13855
+ description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
13856
+ type: 'string',
13857
+ },
13180
13858
  warning_code: {
13181
13859
  description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
13182
13860
  enum: ['august_device_programming_delay'],
@@ -13189,8 +13867,15 @@ export default {
13189
13867
  {
13190
13868
  description: 'August lock is temporarily offline.',
13191
13869
  properties: {
13192
- created_at: { format: 'date-time', type: 'string' },
13193
- message: { type: 'string' },
13870
+ created_at: {
13871
+ description: 'Date and time at which Seam created the warning.',
13872
+ format: 'date-time',
13873
+ type: 'string',
13874
+ },
13875
+ message: {
13876
+ description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
13877
+ type: 'string',
13878
+ },
13194
13879
  warning_code: {
13195
13880
  description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
13196
13881
  enum: ['august_lock_temporarily_offline'],
@@ -13203,8 +13888,15 @@ export default {
13203
13888
  {
13204
13889
  description: 'Algopins must be used within 24 hours.',
13205
13890
  properties: {
13206
- created_at: { format: 'date-time', type: 'string' },
13207
- message: { type: 'string' },
13891
+ created_at: {
13892
+ description: 'Date and time at which Seam created the warning.',
13893
+ format: 'date-time',
13894
+ type: 'string',
13895
+ },
13896
+ message: {
13897
+ description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
13898
+ type: 'string',
13899
+ },
13208
13900
  warning_code: {
13209
13901
  description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
13210
13902
  enum: ['igloo_algopin_must_be_used_within_24_hours'],
@@ -13217,8 +13909,15 @@ export default {
13217
13909
  {
13218
13910
  description: 'Management was transferred to another workspace.',
13219
13911
  properties: {
13220
- created_at: { format: 'date-time', type: 'string' },
13221
- message: { type: 'string' },
13912
+ created_at: {
13913
+ description: 'Date and time at which Seam created the warning.',
13914
+ format: 'date-time',
13915
+ type: 'string',
13916
+ },
13917
+ message: {
13918
+ description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
13919
+ type: 'string',
13920
+ },
13222
13921
  warning_code: {
13223
13922
  description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
13224
13923
  enum: ['management_transferred'],
@@ -13229,10 +13928,17 @@ export default {
13229
13928
  type: 'object',
13230
13929
  },
13231
13930
  {
13232
- description: 'Unable to confirm the access code is set on Kwikset device.',
13931
+ description: 'Unable to confirm that the access code is set on Kwikset device.',
13233
13932
  properties: {
13234
- created_at: { format: 'date-time', type: 'string' },
13235
- message: { type: 'string' },
13933
+ created_at: {
13934
+ description: 'Date and time at which Seam created the warning.',
13935
+ format: 'date-time',
13936
+ type: 'string',
13937
+ },
13938
+ message: {
13939
+ description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
13940
+ type: 'string',
13941
+ },
13236
13942
  warning_code: {
13237
13943
  description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
13238
13944
  enum: ['kwikset_unable_to_confirm_code'],
@@ -13935,14 +14641,13 @@ export default {
13935
14641
  from: {
13936
14642
  properties: {
13937
14643
  ends_at: {
13938
- description: "Date and time at which the user's access ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.",
13939
14644
  format: 'date-time',
13940
14645
  nullable: true,
13941
14646
  type: 'string',
13942
14647
  },
13943
14648
  starts_at: {
13944
- description: "Date and time at which the user's access starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.",
13945
14649
  format: 'date-time',
14650
+ nullable: true,
13946
14651
  type: 'string',
13947
14652
  },
13948
14653
  },
@@ -13956,14 +14661,13 @@ export default {
13956
14661
  to: {
13957
14662
  properties: {
13958
14663
  ends_at: {
13959
- description: "Date and time at which the user's access ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.",
13960
14664
  format: 'date-time',
13961
14665
  nullable: true,
13962
14666
  type: 'string',
13963
14667
  },
13964
14668
  starts_at: {
13965
- description: "Date and time at which the user's access starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.",
13966
14669
  format: 'date-time',
14670
+ nullable: true,
13967
14671
  type: 'string',
13968
14672
  },
13969
14673
  },
@@ -15107,40 +15811,85 @@ export default {
15107
15811
  paths: {
15108
15812
  '/access_codes/create': {
15109
15813
  post: {
15814
+ description: 'Creates a new [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).',
15110
15815
  operationId: 'accessCodesCreatePost',
15111
15816
  requestBody: {
15112
15817
  content: {
15113
15818
  'application/json': {
15114
15819
  schema: {
15115
15820
  properties: {
15116
- allow_external_modification: { type: 'boolean' },
15821
+ allow_external_modification: {
15822
+ description: 'Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`.',
15823
+ type: 'boolean',
15824
+ },
15117
15825
  attempt_for_offline_device: {
15118
15826
  default: true,
15119
15827
  type: 'boolean',
15120
15828
  },
15121
15829
  code: {
15830
+ description: 'Code to be used for access.',
15122
15831
  maxLength: 9,
15123
15832
  minLength: 4,
15124
15833
  pattern: '^\\d+$',
15125
15834
  type: 'string',
15126
15835
  },
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' },
15836
+ common_code_key: {
15837
+ 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).',
15838
+ type: 'string',
15839
+ },
15840
+ device_id: {
15841
+ description: 'ID of the device for which to create the new access code.',
15842
+ format: 'uuid',
15843
+ type: 'string',
15844
+ },
15845
+ ends_at: {
15846
+ 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`.',
15847
+ type: 'string',
15848
+ },
15849
+ is_external_modification_allowed: {
15850
+ description: 'Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`.',
15851
+ type: 'boolean',
15852
+ },
15853
+ is_offline_access_code: {
15854
+ 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).',
15855
+ type: 'boolean',
15856
+ },
15857
+ is_one_time_use: {
15858
+ 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.',
15859
+ type: 'boolean',
15860
+ },
15133
15861
  max_time_rounding: {
15134
15862
  default: '1hour',
15863
+ 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
15864
  enum: ['1hour', '1day', '1h', '1d'],
15136
15865
  type: 'string',
15137
15866
  },
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' },
15867
+ name: {
15868
+ description: 'Name of the new access code.',
15869
+ type: 'string',
15870
+ },
15871
+ prefer_native_scheduling: {
15872
+ 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`.',
15873
+ type: 'boolean',
15874
+ },
15875
+ preferred_code_length: {
15876
+ 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.',
15877
+ format: 'float',
15878
+ type: 'number',
15879
+ },
15880
+ starts_at: {
15881
+ 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.',
15882
+ type: 'string',
15883
+ },
15884
+ sync: {
15885
+ default: false,
15886
+ type: 'boolean',
15887
+ 'x-undocumented': 'Only used internally.',
15888
+ },
15889
+ use_backup_access_code_pool: {
15890
+ 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).',
15891
+ type: 'boolean',
15892
+ },
15144
15893
  use_offline_access_code: { type: 'boolean' },
15145
15894
  },
15146
15895
  required: ['device_id'],
@@ -15184,50 +15933,87 @@ export default {
15184
15933
  'x-fern-sdk-method-name': 'create',
15185
15934
  'x-fern-sdk-return-value': 'access_code',
15186
15935
  'x-response-key': 'access_code',
15936
+ 'x-title': 'Create an Access Code',
15187
15937
  },
15188
15938
  },
15189
15939
  '/access_codes/create_multiple': {
15190
15940
  post: {
15941
+ 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
15942
  operationId: 'accessCodesCreateMultiplePost',
15192
15943
  requestBody: {
15193
15944
  content: {
15194
15945
  'application/json': {
15195
15946
  schema: {
15196
15947
  properties: {
15197
- allow_external_modification: { type: 'boolean' },
15948
+ allow_external_modification: {
15949
+ description: 'Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`.',
15950
+ type: 'boolean',
15951
+ },
15198
15952
  attempt_for_offline_device: {
15199
15953
  default: true,
15200
15954
  type: 'boolean',
15201
15955
  },
15202
15956
  behavior_when_code_cannot_be_shared: {
15203
15957
  default: 'throw',
15958
+ 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
15959
  enum: ['throw', 'create_random_code'],
15205
15960
  type: 'string',
15206
15961
  },
15207
15962
  code: {
15963
+ description: 'Code to be used for access.',
15208
15964
  maxLength: 9,
15209
15965
  minLength: 4,
15210
15966
  pattern: '^\\d+$',
15211
15967
  type: 'string',
15212
15968
  },
15213
15969
  device_ids: {
15970
+ description: 'IDs of the devices for which to create the new access codes.',
15214
15971
  items: { format: 'uuid', type: 'string' },
15215
15972
  type: 'array',
15216
15973
  },
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' },
15974
+ ends_at: {
15975
+ 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`.',
15976
+ type: 'string',
15977
+ },
15978
+ is_external_modification_allowed: {
15979
+ description: 'Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`.',
15980
+ type: 'boolean',
15981
+ },
15982
+ is_offline_access_code: {
15983
+ 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).',
15984
+ type: 'boolean',
15985
+ },
15986
+ is_one_time_use: {
15987
+ 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.',
15988
+ type: 'boolean',
15989
+ },
15221
15990
  max_time_rounding: {
15222
15991
  default: '1hour',
15992
+ 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
15993
  enum: ['1hour', '1day', '1h', '1d'],
15224
15994
  type: 'string',
15225
15995
  },
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' },
15996
+ name: {
15997
+ description: 'Name of the new access code.',
15998
+ type: 'string',
15999
+ },
16000
+ prefer_native_scheduling: {
16001
+ 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`.',
16002
+ type: 'boolean',
16003
+ },
16004
+ preferred_code_length: {
16005
+ 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.',
16006
+ format: 'float',
16007
+ type: 'number',
16008
+ },
16009
+ starts_at: {
16010
+ 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.',
16011
+ type: 'string',
16012
+ },
16013
+ use_backup_access_code_pool: {
16014
+ 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).',
16015
+ type: 'boolean',
16016
+ },
15231
16017
  use_offline_access_code: { type: 'boolean' },
15232
16018
  },
15233
16019
  required: ['device_ids'],
@@ -15270,48 +16056,85 @@ export default {
15270
16056
  'x-fern-sdk-method-name': 'create_multiple',
15271
16057
  'x-fern-sdk-return-value': 'access_codes',
15272
16058
  'x-response-key': 'access_codes',
16059
+ 'x-title': 'Create Multiple Linked Access Codes',
15273
16060
  },
15274
16061
  put: {
16062
+ 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
16063
  operationId: 'accessCodesCreateMultiplePut',
15276
16064
  requestBody: {
15277
16065
  content: {
15278
16066
  'application/json': {
15279
16067
  schema: {
15280
16068
  properties: {
15281
- allow_external_modification: { type: 'boolean' },
16069
+ allow_external_modification: {
16070
+ description: 'Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`.',
16071
+ type: 'boolean',
16072
+ },
15282
16073
  attempt_for_offline_device: {
15283
16074
  default: true,
15284
16075
  type: 'boolean',
15285
16076
  },
15286
16077
  behavior_when_code_cannot_be_shared: {
15287
16078
  default: 'throw',
16079
+ 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
16080
  enum: ['throw', 'create_random_code'],
15289
16081
  type: 'string',
15290
16082
  },
15291
16083
  code: {
16084
+ description: 'Code to be used for access.',
15292
16085
  maxLength: 9,
15293
16086
  minLength: 4,
15294
16087
  pattern: '^\\d+$',
15295
16088
  type: 'string',
15296
16089
  },
15297
16090
  device_ids: {
16091
+ description: 'IDs of the devices for which to create the new access codes.',
15298
16092
  items: { format: 'uuid', type: 'string' },
15299
16093
  type: 'array',
15300
16094
  },
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' },
16095
+ ends_at: {
16096
+ 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`.',
16097
+ type: 'string',
16098
+ },
16099
+ is_external_modification_allowed: {
16100
+ description: 'Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`.',
16101
+ type: 'boolean',
16102
+ },
16103
+ is_offline_access_code: {
16104
+ 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).',
16105
+ type: 'boolean',
16106
+ },
16107
+ is_one_time_use: {
16108
+ 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.',
16109
+ type: 'boolean',
16110
+ },
15305
16111
  max_time_rounding: {
15306
16112
  default: '1hour',
16113
+ 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
16114
  enum: ['1hour', '1day', '1h', '1d'],
15308
16115
  type: 'string',
15309
16116
  },
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' },
16117
+ name: {
16118
+ description: 'Name of the new access code.',
16119
+ type: 'string',
16120
+ },
16121
+ prefer_native_scheduling: {
16122
+ 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`.',
16123
+ type: 'boolean',
16124
+ },
16125
+ preferred_code_length: {
16126
+ 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.',
16127
+ format: 'float',
16128
+ type: 'number',
16129
+ },
16130
+ starts_at: {
16131
+ 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.',
16132
+ type: 'string',
16133
+ },
16134
+ use_backup_access_code_pool: {
16135
+ 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).',
16136
+ type: 'boolean',
16137
+ },
15315
16138
  use_offline_access_code: { type: 'boolean' },
15316
16139
  },
15317
16140
  required: ['device_ids'],
@@ -15352,19 +16175,33 @@ export default {
15352
16175
  tags: ['/access_codes'],
15353
16176
  'x-fern-ignore': true,
15354
16177
  'x-response-key': 'access_codes',
16178
+ 'x-title': 'Create Multiple Linked Access Codes',
15355
16179
  },
15356
16180
  },
15357
16181
  '/access_codes/delete': {
15358
16182
  post: {
16183
+ description: 'Deletes an [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).',
15359
16184
  operationId: 'accessCodesDeletePost',
15360
16185
  requestBody: {
15361
16186
  content: {
15362
16187
  'application/json': {
15363
16188
  schema: {
15364
16189
  properties: {
15365
- access_code_id: { format: 'uuid', type: 'string' },
15366
- device_id: { format: 'uuid', type: 'string' },
15367
- sync: { default: false, type: 'boolean' },
16190
+ access_code_id: {
16191
+ description: 'ID of the access code to delete.',
16192
+ format: 'uuid',
16193
+ type: 'string',
16194
+ },
16195
+ device_id: {
16196
+ description: 'ID of the device for which to delete the access code.',
16197
+ format: 'uuid',
16198
+ type: 'string',
16199
+ },
16200
+ sync: {
16201
+ default: false,
16202
+ type: 'boolean',
16203
+ 'x-undocumented': 'Only used internally.',
16204
+ },
15368
16205
  },
15369
16206
  required: ['access_code_id'],
15370
16207
  type: 'object',
@@ -15405,6 +16242,7 @@ export default {
15405
16242
  'x-fern-sdk-group-name': ['access_codes'],
15406
16243
  'x-fern-sdk-method-name': 'delete',
15407
16244
  'x-response-key': null,
16245
+ 'x-title': 'Delete an Access Code',
15408
16246
  },
15409
16247
  },
15410
16248
  '/access_codes/generate_code': {
@@ -15458,15 +16296,27 @@ export default {
15458
16296
  },
15459
16297
  '/access_codes/get': {
15460
16298
  post: {
16299
+ 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
16300
  operationId: 'accessCodesGetPost',
15462
16301
  requestBody: {
15463
16302
  content: {
15464
16303
  'application/json': {
15465
16304
  schema: {
15466
16305
  properties: {
15467
- access_code_id: { format: 'uuid', type: 'string' },
15468
- code: { type: 'string' },
15469
- device_id: { format: 'uuid', type: 'string' },
16306
+ access_code_id: {
16307
+ description: 'ID of the access code that you want to get. You must specify either `access_code_id` or both `device_id` and `code`.',
16308
+ format: 'uuid',
16309
+ type: 'string',
16310
+ },
16311
+ code: {
16312
+ description: 'Code of the access code that you want to get. You must specify either `access_code_id` or both `device_id` and `code`.',
16313
+ type: 'string',
16314
+ },
16315
+ device_id: {
16316
+ 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`.',
16317
+ format: 'uuid',
16318
+ type: 'string',
16319
+ },
15470
16320
  },
15471
16321
  type: 'object',
15472
16322
  },
@@ -15504,10 +16354,12 @@ export default {
15504
16354
  'x-fern-sdk-method-name': 'get',
15505
16355
  'x-fern-sdk-return-value': 'access_code',
15506
16356
  'x-response-key': 'access_code',
16357
+ 'x-title': 'Get an Access Code',
15507
16358
  },
15508
16359
  },
15509
16360
  '/access_codes/list': {
15510
16361
  post: {
16362
+ 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
16363
  operationId: 'accessCodesListPost',
15512
16364
  requestBody: {
15513
16365
  content: {
@@ -15515,11 +16367,19 @@ export default {
15515
16367
  schema: {
15516
16368
  properties: {
15517
16369
  access_code_ids: {
16370
+ description: 'IDs of the access codes that you want to retrieve. Specify either `device_id` or `access_code_ids`.',
15518
16371
  items: { format: 'uuid', type: 'string' },
15519
16372
  type: 'array',
15520
16373
  },
15521
- device_id: { format: 'uuid', type: 'string' },
15522
- user_identifier_key: { type: 'string' },
16374
+ device_id: {
16375
+ description: 'ID of the device for which you want to list access codes. Specify either `device_id` or `access_code_ids`.',
16376
+ format: 'uuid',
16377
+ type: 'string',
16378
+ },
16379
+ user_identifier_key: {
16380
+ description: 'Your user ID for the user by which to filter access codes.',
16381
+ type: 'string',
16382
+ },
15523
16383
  },
15524
16384
  type: 'object',
15525
16385
  },
@@ -15560,18 +16420,23 @@ export default {
15560
16420
  'x-fern-sdk-method-name': 'list',
15561
16421
  'x-fern-sdk-return-value': 'access_codes',
15562
16422
  'x-response-key': 'access_codes',
16423
+ 'x-title': 'List Access Codes',
15563
16424
  },
15564
16425
  },
15565
16426
  '/access_codes/pull_backup_access_code': {
15566
16427
  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).',
16428
+ 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
16429
  operationId: 'accessCodesPullBackupAccessCodePost',
15569
16430
  requestBody: {
15570
16431
  content: {
15571
16432
  'application/json': {
15572
16433
  schema: {
15573
16434
  properties: {
15574
- access_code_id: { format: 'uuid', type: 'string' },
16435
+ access_code_id: {
16436
+ description: 'ID of the access code for which you want to pull a backup access code.',
16437
+ format: 'uuid',
16438
+ type: 'string',
16439
+ },
15575
16440
  },
15576
16441
  required: ['access_code_id'],
15577
16442
  type: 'object',
@@ -15613,10 +16478,12 @@ export default {
15613
16478
  'x-fern-sdk-method-name': 'pull_backup_access_code',
15614
16479
  'x-fern-sdk-return-value': 'access_code',
15615
16480
  'x-response-key': 'access_code',
16481
+ 'x-title': 'Pull a Backup Access Code',
15616
16482
  },
15617
16483
  },
15618
16484
  '/access_codes/simulate/create_unmanaged_access_code': {
15619
16485
  post: {
16486
+ 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
16487
  operationId: 'accessCodesSimulateCreateUnmanagedAccessCodePost',
15621
16488
  requestBody: {
15622
16489
  content: {
@@ -15624,13 +16491,21 @@ export default {
15624
16491
  schema: {
15625
16492
  properties: {
15626
16493
  code: {
16494
+ description: 'Code of the simulated unmanaged access code.',
15627
16495
  maxLength: 8,
15628
16496
  minLength: 4,
15629
16497
  pattern: '^\\d+$',
15630
16498
  type: 'string',
15631
16499
  },
15632
- device_id: { format: 'uuid', type: 'string' },
15633
- name: { type: 'string' },
16500
+ device_id: {
16501
+ description: 'ID of the device for which you want to simulate the creation of an unmanaged access code.',
16502
+ format: 'uuid',
16503
+ type: 'string',
16504
+ },
16505
+ name: {
16506
+ description: 'Name of the simulated unmanaged access code.',
16507
+ type: 'string',
16508
+ },
15634
16509
  },
15635
16510
  required: ['device_id', 'name', 'code'],
15636
16511
  type: 'object',
@@ -15671,21 +16546,40 @@ export default {
15671
16546
  'x-fern-sdk-method-name': 'create_unmanaged_access_code',
15672
16547
  'x-fern-sdk-return-value': 'access_code',
15673
16548
  'x-response-key': 'access_code',
16549
+ 'x-title': 'Simulate Creating an Unmanaged Access Code',
15674
16550
  },
15675
16551
  },
15676
16552
  '/access_codes/unmanaged/convert_to_managed': {
15677
16553
  patch: {
16554
+ 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
16555
  operationId: 'accessCodesUnmanagedConvertToManagedPatch',
15679
16556
  requestBody: {
15680
16557
  content: {
15681
16558
  'application/json': {
15682
16559
  schema: {
15683
16560
  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' },
16561
+ access_code_id: {
16562
+ description: 'ID of the unmanaged access code that you want to convert to a managed access code.',
16563
+ format: 'uuid',
16564
+ type: 'string',
16565
+ },
16566
+ allow_external_modification: {
16567
+ description: 'Indicates whether external modification of the access code is allowed.',
16568
+ type: 'boolean',
16569
+ },
16570
+ force: {
16571
+ 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`.',
16572
+ type: 'boolean',
16573
+ },
16574
+ is_external_modification_allowed: {
16575
+ description: 'Indicates whether external modification of the access code is allowed.',
16576
+ type: 'boolean',
16577
+ },
16578
+ sync: {
16579
+ default: false,
16580
+ type: 'boolean',
16581
+ 'x-undocumented': 'Only used internally.',
16582
+ },
15689
16583
  },
15690
16584
  required: ['access_code_id'],
15691
16585
  type: 'object',
@@ -15720,19 +16614,38 @@ export default {
15720
16614
  'x-action-attempt-type': 'CONVERT_ACCESS_CODE_TO_MANAGED',
15721
16615
  'x-fern-ignore': true,
15722
16616
  'x-response-key': null,
16617
+ 'x-title': 'Convert an Unmanaged Access Code',
15723
16618
  },
15724
16619
  post: {
16620
+ 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
16621
  operationId: 'accessCodesUnmanagedConvertToManagedPost',
15726
16622
  requestBody: {
15727
16623
  content: {
15728
16624
  'application/json': {
15729
16625
  schema: {
15730
16626
  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' },
16627
+ access_code_id: {
16628
+ description: 'ID of the unmanaged access code that you want to convert to a managed access code.',
16629
+ format: 'uuid',
16630
+ type: 'string',
16631
+ },
16632
+ allow_external_modification: {
16633
+ description: 'Indicates whether external modification of the access code is allowed.',
16634
+ type: 'boolean',
16635
+ },
16636
+ force: {
16637
+ 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`.',
16638
+ type: 'boolean',
16639
+ },
16640
+ is_external_modification_allowed: {
16641
+ description: 'Indicates whether external modification of the access code is allowed.',
16642
+ type: 'boolean',
16643
+ },
16644
+ sync: {
16645
+ default: false,
16646
+ type: 'boolean',
16647
+ 'x-undocumented': 'Only used internally.',
16648
+ },
15736
16649
  },
15737
16650
  required: ['access_code_id'],
15738
16651
  type: 'object',
@@ -15768,18 +16681,28 @@ export default {
15768
16681
  'x-fern-sdk-group-name': ['access_codes', 'unmanaged'],
15769
16682
  'x-fern-sdk-method-name': 'convert_to_managed',
15770
16683
  'x-response-key': null,
16684
+ 'x-title': 'Convert an Unmanaged Access Code',
15771
16685
  },
15772
16686
  },
15773
16687
  '/access_codes/unmanaged/delete': {
15774
16688
  post: {
16689
+ description: 'Deletes an [unmanaged access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes).',
15775
16690
  operationId: 'accessCodesUnmanagedDeletePost',
15776
16691
  requestBody: {
15777
16692
  content: {
15778
16693
  'application/json': {
15779
16694
  schema: {
15780
- properties: {
15781
- access_code_id: { format: 'uuid', type: 'string' },
15782
- sync: { default: false, type: 'boolean' },
16695
+ properties: {
16696
+ access_code_id: {
16697
+ description: 'ID of the unmanaged access code to delete.',
16698
+ format: 'uuid',
16699
+ type: 'string',
16700
+ },
16701
+ sync: {
16702
+ default: false,
16703
+ type: 'boolean',
16704
+ 'x-undocumented': 'Only used internally.',
16705
+ },
15783
16706
  },
15784
16707
  required: ['access_code_id'],
15785
16708
  type: 'object',
@@ -15820,19 +16743,32 @@ export default {
15820
16743
  'x-fern-sdk-group-name': ['access_codes', 'unmanaged'],
15821
16744
  'x-fern-sdk-method-name': 'delete',
15822
16745
  'x-response-key': null,
16746
+ 'x-title': 'Delete an Unmanaged Access Code',
15823
16747
  },
15824
16748
  },
15825
16749
  '/access_codes/unmanaged/get': {
15826
16750
  post: {
16751
+ 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
16752
  operationId: 'accessCodesUnmanagedGetPost',
15828
16753
  requestBody: {
15829
16754
  content: {
15830
16755
  'application/json': {
15831
16756
  schema: {
15832
16757
  properties: {
15833
- access_code_id: { format: 'uuid', type: 'string' },
15834
- code: { type: 'string' },
15835
- device_id: { format: 'uuid', type: 'string' },
16758
+ access_code_id: {
16759
+ 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`.',
16760
+ format: 'uuid',
16761
+ type: 'string',
16762
+ },
16763
+ code: {
16764
+ 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`.',
16765
+ type: 'string',
16766
+ },
16767
+ device_id: {
16768
+ 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`.',
16769
+ format: 'uuid',
16770
+ type: 'string',
16771
+ },
15836
16772
  },
15837
16773
  type: 'object',
15838
16774
  },
@@ -15872,18 +16808,27 @@ export default {
15872
16808
  'x-fern-sdk-method-name': 'get',
15873
16809
  'x-fern-sdk-return-value': 'access_code',
15874
16810
  'x-response-key': 'access_code',
16811
+ 'x-title': 'Get an Unmanaged Access Code',
15875
16812
  },
15876
16813
  },
15877
16814
  '/access_codes/unmanaged/list': {
15878
16815
  post: {
16816
+ 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
16817
  operationId: 'accessCodesUnmanagedListPost',
15880
16818
  requestBody: {
15881
16819
  content: {
15882
16820
  'application/json': {
15883
16821
  schema: {
15884
16822
  properties: {
15885
- device_id: { format: 'uuid', type: 'string' },
15886
- user_identifier_key: { type: 'string' },
16823
+ device_id: {
16824
+ description: 'ID of the device for which you want to list unmanaged access codes.',
16825
+ format: 'uuid',
16826
+ type: 'string',
16827
+ },
16828
+ user_identifier_key: {
16829
+ description: 'Your user ID for the user by which to filter unmanaged access codes.',
16830
+ type: 'string',
16831
+ },
15887
16832
  },
15888
16833
  required: ['device_id'],
15889
16834
  type: 'object',
@@ -15927,20 +16872,35 @@ export default {
15927
16872
  'x-fern-sdk-method-name': 'list',
15928
16873
  'x-fern-sdk-return-value': 'access_codes',
15929
16874
  'x-response-key': 'access_codes',
16875
+ 'x-title': 'List Unmanaged Access Codes',
15930
16876
  },
15931
16877
  },
15932
16878
  '/access_codes/unmanaged/update': {
15933
16879
  patch: {
16880
+ description: 'Updates a specified [unmanaged access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes).',
15934
16881
  operationId: 'accessCodesUnmanagedUpdatePatch',
15935
16882
  requestBody: {
15936
16883
  content: {
15937
16884
  'application/json': {
15938
16885
  schema: {
15939
16886
  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' },
16887
+ access_code_id: {
16888
+ description: 'ID of the unmanaged access code that you want to update.',
16889
+ format: 'uuid',
16890
+ type: 'string',
16891
+ },
16892
+ allow_external_modification: {
16893
+ description: 'Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the code is allowed.',
16894
+ type: 'boolean',
16895
+ },
16896
+ force: {
16897
+ description: 'Indicates whether to force the unmanaged access code update.',
16898
+ type: 'boolean',
16899
+ },
16900
+ is_external_modification_allowed: {
16901
+ description: 'Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the code is allowed.',
16902
+ type: 'boolean',
16903
+ },
15944
16904
  is_managed: { type: 'boolean' },
15945
16905
  },
15946
16906
  required: ['access_code_id', 'is_managed'],
@@ -15975,18 +16935,33 @@ export default {
15975
16935
  tags: ['/access_codes'],
15976
16936
  'x-fern-ignore': true,
15977
16937
  'x-response-key': null,
16938
+ 'x-title': 'Update an Unmanaged Access Code',
15978
16939
  },
15979
16940
  post: {
16941
+ description: 'Updates a specified [unmanaged access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes).',
15980
16942
  operationId: 'accessCodesUnmanagedUpdatePost',
15981
16943
  requestBody: {
15982
16944
  content: {
15983
16945
  'application/json': {
15984
16946
  schema: {
15985
16947
  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' },
16948
+ access_code_id: {
16949
+ description: 'ID of the unmanaged access code that you want to update.',
16950
+ format: 'uuid',
16951
+ type: 'string',
16952
+ },
16953
+ allow_external_modification: {
16954
+ description: 'Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the code is allowed.',
16955
+ type: 'boolean',
16956
+ },
16957
+ force: {
16958
+ description: 'Indicates whether to force the unmanaged access code update.',
16959
+ type: 'boolean',
16960
+ },
16961
+ is_external_modification_allowed: {
16962
+ description: 'Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the code is allowed.',
16963
+ type: 'boolean',
16964
+ },
15990
16965
  is_managed: { type: 'boolean' },
15991
16966
  },
15992
16967
  required: ['access_code_id', 'is_managed'],
@@ -16022,46 +16997,100 @@ export default {
16022
16997
  'x-fern-sdk-group-name': ['access_codes', 'unmanaged'],
16023
16998
  'x-fern-sdk-method-name': 'update',
16024
16999
  'x-response-key': null,
17000
+ 'x-title': 'Update an Unmanaged Access Code',
16025
17001
  },
16026
17002
  },
16027
17003
  '/access_codes/update': {
16028
17004
  patch: {
17005
+ 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
17006
  operationId: 'accessCodesUpdatePatch',
16030
17007
  requestBody: {
16031
17008
  content: {
16032
17009
  'application/json': {
16033
17010
  schema: {
16034
17011
  properties: {
16035
- access_code_id: { format: 'uuid', type: 'string' },
16036
- allow_external_modification: { type: 'boolean' },
17012
+ access_code_id: {
17013
+ description: 'ID of the access code that you want to update.',
17014
+ format: 'uuid',
17015
+ type: 'string',
17016
+ },
17017
+ allow_external_modification: {
17018
+ description: 'Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`.',
17019
+ type: 'boolean',
17020
+ },
16037
17021
  attempt_for_offline_device: {
16038
17022
  default: true,
16039
17023
  type: 'boolean',
16040
17024
  },
16041
17025
  code: {
17026
+ description: 'Code to be used for access.',
16042
17027
  maxLength: 9,
16043
17028
  minLength: 4,
16044
17029
  pattern: '^\\d+$',
16045
17030
  type: 'string',
16046
17031
  },
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' },
17032
+ device_id: {
17033
+ description: 'ID of the device containing the access code that you want to update.',
17034
+ format: 'uuid',
17035
+ type: 'string',
17036
+ },
17037
+ ends_at: {
17038
+ 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`.',
17039
+ type: 'string',
17040
+ },
17041
+ is_external_modification_allowed: {
17042
+ description: 'Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`.',
17043
+ type: 'boolean',
17044
+ },
17045
+ is_managed: {
17046
+ 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`.',
17047
+ type: 'boolean',
17048
+ },
17049
+ is_offline_access_code: {
17050
+ 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).',
17051
+ type: 'boolean',
17052
+ },
17053
+ is_one_time_use: {
17054
+ 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.',
17055
+ type: 'boolean',
17056
+ },
16053
17057
  max_time_rounding: {
16054
17058
  default: '1hour',
17059
+ 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
17060
  enum: ['1hour', '1day', '1h', '1d'],
16056
17061
  type: 'string',
16057
17062
  },
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' },
17063
+ name: {
17064
+ description: 'Name of the new access code.',
17065
+ type: 'string',
17066
+ },
17067
+ prefer_native_scheduling: {
17068
+ 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`.',
17069
+ type: 'boolean',
17070
+ },
17071
+ preferred_code_length: {
17072
+ 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.',
17073
+ format: 'float',
17074
+ type: 'number',
17075
+ },
17076
+ starts_at: {
17077
+ 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.',
17078
+ type: 'string',
17079
+ },
17080
+ sync: {
17081
+ default: false,
17082
+ type: 'boolean',
17083
+ 'x-undocumented': 'Only used internally.',
17084
+ },
17085
+ type: {
17086
+ 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).',
17087
+ enum: ['ongoing', 'time_bound'],
17088
+ type: 'string',
17089
+ },
17090
+ use_backup_access_code_pool: {
17091
+ 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).',
17092
+ type: 'boolean',
17093
+ },
16065
17094
  use_offline_access_code: { type: 'boolean' },
16066
17095
  },
16067
17096
  required: ['access_code_id'],
@@ -16102,44 +17131,98 @@ export default {
16102
17131
  'x-action-attempt-type': 'UPDATE_ACCESS_CODE',
16103
17132
  'x-fern-ignore': true,
16104
17133
  'x-response-key': null,
17134
+ 'x-title': 'Update an Access Code',
16105
17135
  },
16106
17136
  post: {
17137
+ 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
17138
  operationId: 'accessCodesUpdatePost',
16108
17139
  requestBody: {
16109
17140
  content: {
16110
17141
  'application/json': {
16111
17142
  schema: {
16112
17143
  properties: {
16113
- access_code_id: { format: 'uuid', type: 'string' },
16114
- allow_external_modification: { type: 'boolean' },
17144
+ access_code_id: {
17145
+ description: 'ID of the access code that you want to update.',
17146
+ format: 'uuid',
17147
+ type: 'string',
17148
+ },
17149
+ allow_external_modification: {
17150
+ description: 'Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`.',
17151
+ type: 'boolean',
17152
+ },
16115
17153
  attempt_for_offline_device: {
16116
17154
  default: true,
16117
17155
  type: 'boolean',
16118
17156
  },
16119
17157
  code: {
17158
+ description: 'Code to be used for access.',
16120
17159
  maxLength: 9,
16121
17160
  minLength: 4,
16122
17161
  pattern: '^\\d+$',
16123
17162
  type: 'string',
16124
17163
  },
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' },
17164
+ device_id: {
17165
+ description: 'ID of the device containing the access code that you want to update.',
17166
+ format: 'uuid',
17167
+ type: 'string',
17168
+ },
17169
+ ends_at: {
17170
+ 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`.',
17171
+ type: 'string',
17172
+ },
17173
+ is_external_modification_allowed: {
17174
+ description: 'Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`.',
17175
+ type: 'boolean',
17176
+ },
17177
+ is_managed: {
17178
+ 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`.',
17179
+ type: 'boolean',
17180
+ },
17181
+ is_offline_access_code: {
17182
+ 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).',
17183
+ type: 'boolean',
17184
+ },
17185
+ is_one_time_use: {
17186
+ 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.',
17187
+ type: 'boolean',
17188
+ },
16131
17189
  max_time_rounding: {
16132
17190
  default: '1hour',
17191
+ 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
17192
  enum: ['1hour', '1day', '1h', '1d'],
16134
17193
  type: 'string',
16135
17194
  },
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' },
17195
+ name: {
17196
+ description: 'Name of the new access code.',
17197
+ type: 'string',
17198
+ },
17199
+ prefer_native_scheduling: {
17200
+ 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`.',
17201
+ type: 'boolean',
17202
+ },
17203
+ preferred_code_length: {
17204
+ 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.',
17205
+ format: 'float',
17206
+ type: 'number',
17207
+ },
17208
+ starts_at: {
17209
+ 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.',
17210
+ type: 'string',
17211
+ },
17212
+ sync: {
17213
+ default: false,
17214
+ type: 'boolean',
17215
+ 'x-undocumented': 'Only used internally.',
17216
+ },
17217
+ type: {
17218
+ 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).',
17219
+ enum: ['ongoing', 'time_bound'],
17220
+ type: 'string',
17221
+ },
17222
+ use_backup_access_code_pool: {
17223
+ 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).',
17224
+ type: 'boolean',
17225
+ },
16143
17226
  use_offline_access_code: { type: 'boolean' },
16144
17227
  },
16145
17228
  required: ['access_code_id'],
@@ -16181,44 +17264,98 @@ export default {
16181
17264
  'x-fern-sdk-group-name': ['access_codes'],
16182
17265
  'x-fern-sdk-method-name': 'update',
16183
17266
  'x-response-key': null,
17267
+ 'x-title': 'Update an Access Code',
16184
17268
  },
16185
17269
  put: {
17270
+ 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
17271
  operationId: 'accessCodesUpdatePut',
16187
17272
  requestBody: {
16188
17273
  content: {
16189
17274
  'application/json': {
16190
17275
  schema: {
16191
17276
  properties: {
16192
- access_code_id: { format: 'uuid', type: 'string' },
16193
- allow_external_modification: { type: 'boolean' },
17277
+ access_code_id: {
17278
+ description: 'ID of the access code that you want to update.',
17279
+ format: 'uuid',
17280
+ type: 'string',
17281
+ },
17282
+ allow_external_modification: {
17283
+ description: 'Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`.',
17284
+ type: 'boolean',
17285
+ },
16194
17286
  attempt_for_offline_device: {
16195
17287
  default: true,
16196
17288
  type: 'boolean',
16197
17289
  },
16198
17290
  code: {
17291
+ description: 'Code to be used for access.',
16199
17292
  maxLength: 9,
16200
17293
  minLength: 4,
16201
17294
  pattern: '^\\d+$',
16202
17295
  type: 'string',
16203
17296
  },
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' },
17297
+ device_id: {
17298
+ description: 'ID of the device containing the access code that you want to update.',
17299
+ format: 'uuid',
17300
+ type: 'string',
17301
+ },
17302
+ ends_at: {
17303
+ 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`.',
17304
+ type: 'string',
17305
+ },
17306
+ is_external_modification_allowed: {
17307
+ description: 'Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`.',
17308
+ type: 'boolean',
17309
+ },
17310
+ is_managed: {
17311
+ 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`.',
17312
+ type: 'boolean',
17313
+ },
17314
+ is_offline_access_code: {
17315
+ 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).',
17316
+ type: 'boolean',
17317
+ },
17318
+ is_one_time_use: {
17319
+ 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.',
17320
+ type: 'boolean',
17321
+ },
16210
17322
  max_time_rounding: {
16211
17323
  default: '1hour',
17324
+ 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
17325
  enum: ['1hour', '1day', '1h', '1d'],
16213
17326
  type: 'string',
16214
17327
  },
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' },
17328
+ name: {
17329
+ description: 'Name of the new access code.',
17330
+ type: 'string',
17331
+ },
17332
+ prefer_native_scheduling: {
17333
+ 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`.',
17334
+ type: 'boolean',
17335
+ },
17336
+ preferred_code_length: {
17337
+ 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.',
17338
+ format: 'float',
17339
+ type: 'number',
17340
+ },
17341
+ starts_at: {
17342
+ 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.',
17343
+ type: 'string',
17344
+ },
17345
+ sync: {
17346
+ default: false,
17347
+ type: 'boolean',
17348
+ 'x-undocumented': 'Only used internally.',
17349
+ },
17350
+ type: {
17351
+ 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).',
17352
+ enum: ['ongoing', 'time_bound'],
17353
+ type: 'string',
17354
+ },
17355
+ use_backup_access_code_pool: {
17356
+ 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).',
17357
+ type: 'boolean',
17358
+ },
16222
17359
  use_offline_access_code: { type: 'boolean' },
16223
17360
  },
16224
17361
  required: ['access_code_id'],
@@ -16259,20 +17396,34 @@ export default {
16259
17396
  'x-action-attempt-type': 'UPDATE_ACCESS_CODE',
16260
17397
  'x-fern-ignore': true,
16261
17398
  'x-response-key': null,
17399
+ 'x-title': 'Update an Access Code',
16262
17400
  },
16263
17401
  },
16264
17402
  '/access_codes/update_multiple': {
16265
17403
  patch: {
17404
+ 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
17405
  operationId: 'accessCodesUpdateMultiplePatch',
16267
17406
  requestBody: {
16268
17407
  content: {
16269
17408
  'application/json': {
16270
17409
  schema: {
16271
17410
  properties: {
16272
- common_code_key: { type: 'string' },
16273
- ends_at: { type: 'string' },
16274
- name: { type: 'string' },
16275
- starts_at: { type: 'string' },
17411
+ common_code_key: {
17412
+ description: 'Key that links the group of access codes, assigned on creation by `/access_codes/create_multiple`.',
17413
+ type: 'string',
17414
+ },
17415
+ ends_at: {
17416
+ 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`.',
17417
+ type: 'string',
17418
+ },
17419
+ name: {
17420
+ description: 'Name of the new access code.',
17421
+ type: 'string',
17422
+ },
17423
+ starts_at: {
17424
+ 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.',
17425
+ type: 'string',
17426
+ },
16276
17427
  },
16277
17428
  required: ['common_code_key'],
16278
17429
  type: 'object',
@@ -16306,18 +17457,32 @@ export default {
16306
17457
  tags: ['/access_codes'],
16307
17458
  'x-fern-ignore': true,
16308
17459
  'x-response-key': null,
17460
+ 'x-title': 'Update Multiple Linked Access Codes',
16309
17461
  },
16310
17462
  post: {
17463
+ 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
17464
  operationId: 'accessCodesUpdateMultiplePost',
16312
17465
  requestBody: {
16313
17466
  content: {
16314
17467
  'application/json': {
16315
17468
  schema: {
16316
17469
  properties: {
16317
- common_code_key: { type: 'string' },
16318
- ends_at: { type: 'string' },
16319
- name: { type: 'string' },
16320
- starts_at: { type: 'string' },
17470
+ common_code_key: {
17471
+ description: 'Key that links the group of access codes, assigned on creation by `/access_codes/create_multiple`.',
17472
+ type: 'string',
17473
+ },
17474
+ ends_at: {
17475
+ 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`.',
17476
+ type: 'string',
17477
+ },
17478
+ name: {
17479
+ description: 'Name of the new access code.',
17480
+ type: 'string',
17481
+ },
17482
+ starts_at: {
17483
+ 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.',
17484
+ type: 'string',
17485
+ },
16321
17486
  },
16322
17487
  required: ['common_code_key'],
16323
17488
  type: 'object',
@@ -16352,6 +17517,7 @@ export default {
16352
17517
  'x-fern-sdk-group-name': ['access_codes'],
16353
17518
  'x-fern-sdk-method-name': 'update_multiple',
16354
17519
  'x-response-key': null,
17520
+ 'x-title': 'Update Multiple Linked Access Codes',
16355
17521
  },
16356
17522
  },
16357
17523
  '/acs/access_groups/add_user': {
@@ -18076,6 +19242,60 @@ export default {
18076
19242
  'x-title': 'Encode a Credential',
18077
19243
  },
18078
19244
  },
19245
+ '/acs/encoders/get': {
19246
+ post: {
19247
+ description: 'Returns a specified [encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners).',
19248
+ operationId: 'acsEncodersGetPost',
19249
+ requestBody: {
19250
+ content: {
19251
+ 'application/json': {
19252
+ schema: {
19253
+ properties: {
19254
+ acs_encoder_id: {
19255
+ description: 'ID of the desired encoder.',
19256
+ format: 'uuid',
19257
+ type: 'string',
19258
+ },
19259
+ },
19260
+ required: ['acs_encoder_id'],
19261
+ type: 'object',
19262
+ },
19263
+ },
19264
+ },
19265
+ },
19266
+ responses: {
19267
+ 200: {
19268
+ content: {
19269
+ 'application/json': {
19270
+ schema: {
19271
+ properties: {
19272
+ acs_encoder: { $ref: '#/components/schemas/acs_encoder' },
19273
+ ok: { type: 'boolean' },
19274
+ },
19275
+ required: ['acs_encoder', 'ok'],
19276
+ type: 'object',
19277
+ },
19278
+ },
19279
+ },
19280
+ description: 'OK',
19281
+ },
19282
+ 400: { description: 'Bad Request' },
19283
+ 401: { description: 'Unauthorized' },
19284
+ },
19285
+ security: [
19286
+ { pat_with_workspace: [] },
19287
+ { console_session_with_workspace: [] },
19288
+ { api_key: [] },
19289
+ ],
19290
+ summary: '/acs/encoders/get',
19291
+ tags: ['/acs'],
19292
+ 'x-fern-sdk-group-name': ['acs', 'encoders'],
19293
+ 'x-fern-sdk-method-name': 'get',
19294
+ 'x-fern-sdk-return-value': 'acs_encoder',
19295
+ 'x-response-key': 'acs_encoder',
19296
+ 'x-title': 'Get an Encoder',
19297
+ },
19298
+ },
18079
19299
  '/acs/encoders/list': {
18080
19300
  post: {
18081
19301
  description: 'Returns a list of all [encoders](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners).',
@@ -24044,10 +25264,12 @@ export default {
24044
25264
  properties: {
24045
25265
  can_tailscale_proxy_reach_bridge: {
24046
25266
  description: 'Tailscale proxy cannot reach the bridge',
25267
+ nullable: true,
24047
25268
  type: 'boolean',
24048
25269
  },
24049
25270
  can_tailscale_proxy_reach_tailscale_network: {
24050
25271
  description: 'Tailscale proxy cannot reach the Tailscale network',
25272
+ nullable: true,
24051
25273
  type: 'boolean',
24052
25274
  },
24053
25275
  created_at: {
@@ -24061,14 +25283,17 @@ export default {
24061
25283
  },
24062
25284
  is_bridge_socks_server_healthy: {
24063
25285
  description: "Bridge's SOCKS server is unhealthy",
25286
+ nullable: true,
24064
25287
  type: 'boolean',
24065
25288
  },
24066
25289
  is_tailscale_proxy_reachable: {
24067
25290
  description: 'Seam cannot reach the tailscale proxy',
25291
+ nullable: true,
24068
25292
  type: 'boolean',
24069
25293
  },
24070
25294
  is_tailscale_proxy_socks_server_healthy: {
24071
25295
  description: "Tailscale proxy's SOCKS server is unhealthy",
25296
+ nullable: true,
24072
25297
  type: 'boolean',
24073
25298
  },
24074
25299
  message: { type: 'string' },
@@ -24200,10 +25425,12 @@ export default {
24200
25425
  properties: {
24201
25426
  can_tailscale_proxy_reach_bridge: {
24202
25427
  description: 'Tailscale proxy cannot reach the bridge',
25428
+ nullable: true,
24203
25429
  type: 'boolean',
24204
25430
  },
24205
25431
  can_tailscale_proxy_reach_tailscale_network: {
24206
25432
  description: 'Tailscale proxy cannot reach the Tailscale network',
25433
+ nullable: true,
24207
25434
  type: 'boolean',
24208
25435
  },
24209
25436
  created_at: {
@@ -24217,14 +25444,17 @@ export default {
24217
25444
  },
24218
25445
  is_bridge_socks_server_healthy: {
24219
25446
  description: "Bridge's SOCKS server is unhealthy",
25447
+ nullable: true,
24220
25448
  type: 'boolean',
24221
25449
  },
24222
25450
  is_tailscale_proxy_reachable: {
24223
25451
  description: 'Seam cannot reach the tailscale proxy',
25452
+ nullable: true,
24224
25453
  type: 'boolean',
24225
25454
  },
24226
25455
  is_tailscale_proxy_socks_server_healthy: {
24227
25456
  description: "Tailscale proxy's SOCKS server is unhealthy",
25457
+ nullable: true,
24228
25458
  type: 'boolean',
24229
25459
  },
24230
25460
  message: { type: 'string' },
@@ -24347,10 +25577,12 @@ export default {
24347
25577
  properties: {
24348
25578
  can_tailscale_proxy_reach_bridge: {
24349
25579
  description: 'Tailscale proxy cannot reach the bridge',
25580
+ nullable: true,
24350
25581
  type: 'boolean',
24351
25582
  },
24352
25583
  can_tailscale_proxy_reach_tailscale_network: {
24353
25584
  description: 'Tailscale proxy cannot reach the Tailscale network',
25585
+ nullable: true,
24354
25586
  type: 'boolean',
24355
25587
  },
24356
25588
  created_at: {
@@ -24364,14 +25596,17 @@ export default {
24364
25596
  },
24365
25597
  is_bridge_socks_server_healthy: {
24366
25598
  description: "Bridge's SOCKS server is unhealthy",
25599
+ nullable: true,
24367
25600
  type: 'boolean',
24368
25601
  },
24369
25602
  is_tailscale_proxy_reachable: {
24370
25603
  description: 'Seam cannot reach the tailscale proxy',
25604
+ nullable: true,
24371
25605
  type: 'boolean',
24372
25606
  },
24373
25607
  is_tailscale_proxy_socks_server_healthy: {
24374
25608
  description: "Tailscale proxy's SOCKS server is unhealthy",
25609
+ nullable: true,
24375
25610
  type: 'boolean',
24376
25611
  },
24377
25612
  message: { type: 'string' },
@@ -24503,10 +25738,12 @@ export default {
24503
25738
  properties: {
24504
25739
  can_tailscale_proxy_reach_bridge: {
24505
25740
  description: 'Tailscale proxy cannot reach the bridge',
25741
+ nullable: true,
24506
25742
  type: 'boolean',
24507
25743
  },
24508
25744
  can_tailscale_proxy_reach_tailscale_network: {
24509
25745
  description: 'Tailscale proxy cannot reach the Tailscale network',
25746
+ nullable: true,
24510
25747
  type: 'boolean',
24511
25748
  },
24512
25749
  created_at: {
@@ -24520,14 +25757,17 @@ export default {
24520
25757
  },
24521
25758
  is_bridge_socks_server_healthy: {
24522
25759
  description: "Bridge's SOCKS server is unhealthy",
25760
+ nullable: true,
24523
25761
  type: 'boolean',
24524
25762
  },
24525
25763
  is_tailscale_proxy_reachable: {
24526
25764
  description: 'Seam cannot reach the tailscale proxy',
25765
+ nullable: true,
24527
25766
  type: 'boolean',
24528
25767
  },
24529
25768
  is_tailscale_proxy_socks_server_healthy: {
24530
25769
  description: "Tailscale proxy's SOCKS server is unhealthy",
25770
+ nullable: true,
24531
25771
  type: 'boolean',
24532
25772
  },
24533
25773
  message: { type: 'string' },