@seamapi/types 1.1026.0 → 1.1028.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.
@@ -399,6 +399,105 @@ const openapi: OpenAPISpec = {
399
399
  type: 'object',
400
400
  'x-resource-type': 'access_code',
401
401
  },
402
+ {
403
+ description:
404
+ 'Seam was unable to issue this access code before its start time, so the recipient may be unable to unlock the device. This usually points to a problem that needs attention, such as an offline or disconnected device. Seam keeps retrying, and this error clears automatically if the access code is eventually issued.',
405
+ properties: {
406
+ created_at: {
407
+ description:
408
+ 'Date and time at which Seam created the error.',
409
+ format: 'date-time',
410
+ type: 'string',
411
+ },
412
+ error_code: {
413
+ description:
414
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
415
+ enum: ['failed_to_issue'],
416
+ type: 'string',
417
+ },
418
+ is_access_code_error: {
419
+ description:
420
+ 'Indicates that this is an access code error.',
421
+ enum: [true],
422
+ type: 'boolean',
423
+ },
424
+ message: {
425
+ description:
426
+ 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
427
+ type: 'string',
428
+ },
429
+ },
430
+ required: ['message', 'is_access_code_error', 'error_code'],
431
+ type: 'object',
432
+ 'x-resource-type': 'access_code',
433
+ 'x-undocumented': 'Unreleased.',
434
+ },
435
+ {
436
+ description:
437
+ "Seam was unable to apply this access code's pending mutations to the device, so the code on the device does not match its requested state. Seam keeps retrying, and this error clears automatically once the mutations are applied.",
438
+ properties: {
439
+ created_at: {
440
+ description:
441
+ 'Date and time at which Seam created the error.',
442
+ format: 'date-time',
443
+ type: 'string',
444
+ },
445
+ error_code: {
446
+ description:
447
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
448
+ enum: ['failed_to_apply_mutations'],
449
+ type: 'string',
450
+ },
451
+ is_access_code_error: {
452
+ description:
453
+ 'Indicates that this is an access code error.',
454
+ enum: [true],
455
+ type: 'boolean',
456
+ },
457
+ message: {
458
+ description:
459
+ 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
460
+ type: 'string',
461
+ },
462
+ },
463
+ required: ['message', 'is_access_code_error', 'error_code'],
464
+ type: 'object',
465
+ 'x-resource-type': 'access_code',
466
+ 'x-undocumented': 'Unreleased.',
467
+ },
468
+ {
469
+ description:
470
+ 'This access code is still active on the device even though its `ends_at` has passed, so the recipient may still be able to unlock the device after their access window ended. Seam is attempting to remove it, and this error clears automatically once the access code is no longer active.',
471
+ properties: {
472
+ created_at: {
473
+ description:
474
+ 'Date and time at which Seam created the error.',
475
+ format: 'date-time',
476
+ type: 'string',
477
+ },
478
+ error_code: {
479
+ description:
480
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
481
+ enum: ['failed_to_expire'],
482
+ type: 'string',
483
+ },
484
+ is_access_code_error: {
485
+ description:
486
+ 'Indicates that this is an access code error.',
487
+ enum: [true],
488
+ type: 'boolean',
489
+ },
490
+ message: {
491
+ description:
492
+ 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
493
+ type: 'string',
494
+ },
495
+ },
496
+ required: ['message', 'is_access_code_error', 'error_code'],
497
+ type: 'object',
498
+ 'x-resource-type': 'access_code',
499
+ 'x-undocumented': 'Unreleased.',
500
+ },
402
501
  {
403
502
  description: 'Indicates that the account is disconnected.',
404
503
  properties: {
@@ -1464,6 +1563,58 @@ const openapi: OpenAPISpec = {
1464
1563
  'x-deprecated':
1465
1564
  'Seam no longer sets this warning. Use the `failed_to_remove_from_device` error instead.',
1466
1565
  },
1566
+ {
1567
+ description:
1568
+ 'Seam has not yet issued this access code, even though its start time is approaching, so access may not be ready when the recipient arrives. Seam is still attempting to issue it, and this warning clears automatically once issuance succeeds.',
1569
+ properties: {
1570
+ created_at: {
1571
+ description:
1572
+ 'Date and time at which Seam created the warning.',
1573
+ format: 'date-time',
1574
+ type: 'string',
1575
+ },
1576
+ message: {
1577
+ description:
1578
+ 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
1579
+ type: 'string',
1580
+ },
1581
+ warning_code: {
1582
+ description:
1583
+ 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
1584
+ enum: ['delay_in_issuing'],
1585
+ type: 'string',
1586
+ },
1587
+ },
1588
+ required: ['message', 'warning_code'],
1589
+ type: 'object',
1590
+ 'x-undocumented': 'Unreleased.',
1591
+ },
1592
+ {
1593
+ description:
1594
+ "Seam has not yet applied this access code's pending mutations to the device, so the code on the device does not yet match its requested state. Seam is still attempting to apply them, and this warning clears automatically once the mutations are applied.",
1595
+ properties: {
1596
+ created_at: {
1597
+ description:
1598
+ 'Date and time at which Seam created the warning.',
1599
+ format: 'date-time',
1600
+ type: 'string',
1601
+ },
1602
+ message: {
1603
+ description:
1604
+ 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
1605
+ type: 'string',
1606
+ },
1607
+ warning_code: {
1608
+ description:
1609
+ 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
1610
+ enum: ['delay_in_applying_mutations'],
1611
+ type: 'string',
1612
+ },
1613
+ },
1614
+ required: ['message', 'warning_code'],
1615
+ type: 'object',
1616
+ 'x-undocumented': 'Unreleased.',
1617
+ },
1467
1618
  {
1468
1619
  description:
1469
1620
  'Third-party integration detected that may cause access codes to fail.',
@@ -19427,7 +19578,7 @@ const openapi: OpenAPISpec = {
19427
19578
  },
19428
19579
  {
19429
19580
  description:
19430
- 'An [access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes) was deleted.',
19581
+ 'An [access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes) was issued.',
19431
19582
  properties: {
19432
19583
  access_code_id: {
19433
19584
  description: 'ID of the affected access code.',
@@ -19436,7 +19587,6 @@ const openapi: OpenAPISpec = {
19436
19587
  },
19437
19588
  code: {
19438
19589
  description: 'Code for the affected access code.',
19439
- nullable: true,
19440
19590
  type: 'string',
19441
19591
  },
19442
19592
  connected_account_custom_metadata: {
@@ -19482,7 +19632,7 @@ const openapi: OpenAPISpec = {
19482
19632
  format: 'uuid',
19483
19633
  type: 'string',
19484
19634
  },
19485
- event_type: { enum: ['access_code.deleted'], type: 'string' },
19635
+ event_type: { enum: ['access_code.issued'], type: 'string' },
19486
19636
  occurred_at: {
19487
19637
  description: 'Date and time at which the event occurred.',
19488
19638
  format: 'date-time',
@@ -19507,11 +19657,11 @@ const openapi: OpenAPISpec = {
19507
19657
  ],
19508
19658
  type: 'object',
19509
19659
  'x-route-path': '/access_codes',
19660
+ 'x-undocumented': 'Unreleased.',
19510
19661
  },
19511
19662
  {
19512
- deprecated: true,
19513
19663
  description:
19514
- 'There was an unusually long delay in removing an [access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes) from a device.',
19664
+ 'Seam has not yet issued this [access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes), even though its start time is approaching, so access may not be ready when the recipient arrives. Seam is still attempting to issue it, and the accompanying `delay_in_issuing` warning clears automatically once issuance succeeds.',
19515
19665
  properties: {
19516
19666
  access_code_errors: {
19517
19667
  description: 'Errors associated with the access code.',
@@ -19730,7 +19880,7 @@ const openapi: OpenAPISpec = {
19730
19880
  type: 'string',
19731
19881
  },
19732
19882
  event_type: {
19733
- enum: ['access_code.delay_in_removing_from_device'],
19883
+ enum: ['access_code.delay_in_issuing'],
19734
19884
  type: 'string',
19735
19885
  },
19736
19886
  occurred_at: {
@@ -19761,13 +19911,12 @@ const openapi: OpenAPISpec = {
19761
19911
  'access_code_warnings',
19762
19912
  ],
19763
19913
  type: 'object',
19764
- 'x-deprecated':
19765
- 'Seam no longer emits this event. Use `access_code.failed_to_remove_from_device` instead.',
19766
19914
  'x-route-path': '/access_codes',
19915
+ 'x-undocumented': 'Unreleased.',
19767
19916
  },
19768
19917
  {
19769
19918
  description:
19770
- 'An [access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes) failed to be removed from a device.',
19919
+ 'Seam was unable to issue this [access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes) before its start time, so the recipient may be unable to unlock the device. This usually points to a problem that needs attention, such as an offline or disconnected device. Seam keeps retrying, and the accompanying `failed_to_issue` error clears automatically if the access code is eventually issued.',
19771
19920
  properties: {
19772
19921
  access_code_errors: {
19773
19922
  description: 'Errors associated with the access code.',
@@ -19986,7 +20135,7 @@ const openapi: OpenAPISpec = {
19986
20135
  type: 'string',
19987
20136
  },
19988
20137
  event_type: {
19989
- enum: ['access_code.failed_to_remove_from_device'],
20138
+ enum: ['access_code.failed_to_issue'],
19990
20139
  type: 'string',
19991
20140
  },
19992
20141
  occurred_at: {
@@ -20018,16 +20167,73 @@ const openapi: OpenAPISpec = {
20018
20167
  ],
20019
20168
  type: 'object',
20020
20169
  'x-route-path': '/access_codes',
20170
+ 'x-undocumented': 'Unreleased.',
20021
20171
  },
20022
20172
  {
20023
20173
  description:
20024
- 'An [access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes) was modified outside of Seam.',
20174
+ "Seam has not yet applied this [access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes)'s pending mutations to the device, so the code on the device does not yet match its requested state. Seam is still attempting to apply them, and the accompanying `delay_in_applying_mutations` warning clears automatically once the mutations are applied.",
20025
20175
  properties: {
20176
+ access_code_errors: {
20177
+ description: 'Errors associated with the access code.',
20178
+ items: {
20179
+ description:
20180
+ 'Error associated with the resource, including the error code, message, and creation timestamp.',
20181
+ properties: {
20182
+ created_at: {
20183
+ description:
20184
+ 'Date and time at which Seam created the error.',
20185
+ format: 'date-time',
20186
+ type: 'string',
20187
+ },
20188
+ error_code: {
20189
+ description:
20190
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
20191
+ type: 'string',
20192
+ },
20193
+ message: {
20194
+ description:
20195
+ 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
20196
+ type: 'string',
20197
+ },
20198
+ },
20199
+ required: ['created_at', 'message', 'error_code'],
20200
+ type: 'object',
20201
+ },
20202
+ type: 'array',
20203
+ },
20026
20204
  access_code_id: {
20027
20205
  description: 'ID of the affected access code.',
20028
20206
  format: 'uuid',
20029
20207
  type: 'string',
20030
20208
  },
20209
+ access_code_warnings: {
20210
+ description: 'Warnings associated with the access code.',
20211
+ items: {
20212
+ description:
20213
+ 'Warning associated with the resource, including the warning code, message, and creation timestamp.',
20214
+ properties: {
20215
+ created_at: {
20216
+ description:
20217
+ 'Date and time at which Seam created the warning.',
20218
+ format: 'date-time',
20219
+ type: 'string',
20220
+ },
20221
+ message: {
20222
+ description:
20223
+ 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
20224
+ type: 'string',
20225
+ },
20226
+ warning_code: {
20227
+ description:
20228
+ 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
20229
+ type: 'string',
20230
+ },
20231
+ },
20232
+ required: ['created_at', 'message', 'warning_code'],
20233
+ type: 'object',
20234
+ },
20235
+ type: 'array',
20236
+ },
20031
20237
  connected_account_custom_metadata: {
20032
20238
  additionalProperties: {
20033
20239
  oneOf: [{ type: 'string' }, { type: 'boolean' }],
@@ -20036,12 +20242,68 @@ const openapi: OpenAPISpec = {
20036
20242
  'Custom metadata of the connected account, present when connected_account_id is provided.',
20037
20243
  type: 'object',
20038
20244
  },
20245
+ connected_account_errors: {
20246
+ description: 'Errors associated with the connected account.',
20247
+ items: {
20248
+ description:
20249
+ 'Error associated with the resource, including the error code, message, and creation timestamp.',
20250
+ properties: {
20251
+ created_at: {
20252
+ description:
20253
+ 'Date and time at which Seam created the error.',
20254
+ format: 'date-time',
20255
+ type: 'string',
20256
+ },
20257
+ error_code: {
20258
+ description:
20259
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
20260
+ type: 'string',
20261
+ },
20262
+ message: {
20263
+ description:
20264
+ 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
20265
+ type: 'string',
20266
+ },
20267
+ },
20268
+ required: ['created_at', 'message', 'error_code'],
20269
+ type: 'object',
20270
+ },
20271
+ type: 'array',
20272
+ },
20039
20273
  connected_account_id: {
20040
20274
  description:
20041
20275
  'ID of the connected account associated with the affected access code.',
20042
20276
  format: 'uuid',
20043
20277
  type: 'string',
20044
20278
  },
20279
+ connected_account_warnings: {
20280
+ description: 'Warnings associated with the connected account.',
20281
+ items: {
20282
+ description:
20283
+ 'Warning associated with the resource, including the warning code, message, and creation timestamp.',
20284
+ properties: {
20285
+ created_at: {
20286
+ description:
20287
+ 'Date and time at which Seam created the warning.',
20288
+ format: 'date-time',
20289
+ type: 'string',
20290
+ },
20291
+ message: {
20292
+ description:
20293
+ 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
20294
+ type: 'string',
20295
+ },
20296
+ warning_code: {
20297
+ description:
20298
+ 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
20299
+ type: 'string',
20300
+ },
20301
+ },
20302
+ required: ['created_at', 'message', 'warning_code'],
20303
+ type: 'object',
20304
+ },
20305
+ type: 'array',
20306
+ },
20045
20307
  created_at: {
20046
20308
  description: 'Date and time at which the event was created.',
20047
20309
  format: 'date-time',
@@ -20055,12 +20317,68 @@ const openapi: OpenAPISpec = {
20055
20317
  'Custom metadata of the device, present when device_id is provided.',
20056
20318
  type: 'object',
20057
20319
  },
20320
+ device_errors: {
20321
+ description: 'Errors associated with the device.',
20322
+ items: {
20323
+ description:
20324
+ 'Error associated with the resource, including the error code, message, and creation timestamp.',
20325
+ properties: {
20326
+ created_at: {
20327
+ description:
20328
+ 'Date and time at which Seam created the error.',
20329
+ format: 'date-time',
20330
+ type: 'string',
20331
+ },
20332
+ error_code: {
20333
+ description:
20334
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
20335
+ type: 'string',
20336
+ },
20337
+ message: {
20338
+ description:
20339
+ 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
20340
+ type: 'string',
20341
+ },
20342
+ },
20343
+ required: ['created_at', 'message', 'error_code'],
20344
+ type: 'object',
20345
+ },
20346
+ type: 'array',
20347
+ },
20058
20348
  device_id: {
20059
20349
  description:
20060
20350
  'ID of the device associated with the affected access code.',
20061
20351
  format: 'uuid',
20062
20352
  type: 'string',
20063
20353
  },
20354
+ device_warnings: {
20355
+ description: 'Warnings associated with the device.',
20356
+ items: {
20357
+ description:
20358
+ 'Warning associated with the resource, including the warning code, message, and creation timestamp.',
20359
+ properties: {
20360
+ created_at: {
20361
+ description:
20362
+ 'Date and time at which Seam created the warning.',
20363
+ format: 'date-time',
20364
+ type: 'string',
20365
+ },
20366
+ message: {
20367
+ description:
20368
+ 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
20369
+ type: 'string',
20370
+ },
20371
+ warning_code: {
20372
+ description:
20373
+ 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
20374
+ type: 'string',
20375
+ },
20376
+ },
20377
+ required: ['created_at', 'message', 'warning_code'],
20378
+ type: 'object',
20379
+ },
20380
+ type: 'array',
20381
+ },
20064
20382
  event_description: {
20065
20383
  description:
20066
20384
  'Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.',
@@ -20072,7 +20390,1198 @@ const openapi: OpenAPISpec = {
20072
20390
  type: 'string',
20073
20391
  },
20074
20392
  event_type: {
20075
- enum: ['access_code.modified_external_to_seam'],
20393
+ enum: ['access_code.delay_in_applying_mutations'],
20394
+ type: 'string',
20395
+ },
20396
+ occurred_at: {
20397
+ description: 'Date and time at which the event occurred.',
20398
+ format: 'date-time',
20399
+ type: 'string',
20400
+ },
20401
+ workspace_id: {
20402
+ description: 'ID of the workspace associated with the event.',
20403
+ format: 'uuid',
20404
+ type: 'string',
20405
+ },
20406
+ },
20407
+ required: [
20408
+ 'event_id',
20409
+ 'workspace_id',
20410
+ 'created_at',
20411
+ 'occurred_at',
20412
+ 'access_code_id',
20413
+ 'device_id',
20414
+ 'connected_account_id',
20415
+ 'event_type',
20416
+ 'connected_account_errors',
20417
+ 'connected_account_warnings',
20418
+ 'device_errors',
20419
+ 'device_warnings',
20420
+ 'access_code_errors',
20421
+ 'access_code_warnings',
20422
+ ],
20423
+ type: 'object',
20424
+ 'x-route-path': '/access_codes',
20425
+ 'x-undocumented': 'Unreleased.',
20426
+ },
20427
+ {
20428
+ description:
20429
+ "Seam was unable to apply this [access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes)'s pending mutations to the device, so the code on the device does not match its requested state. Seam keeps retrying, and the accompanying `failed_to_apply_mutations` error clears automatically once the mutations are applied.",
20430
+ properties: {
20431
+ access_code_errors: {
20432
+ description: 'Errors associated with the access code.',
20433
+ items: {
20434
+ description:
20435
+ 'Error associated with the resource, including the error code, message, and creation timestamp.',
20436
+ properties: {
20437
+ created_at: {
20438
+ description:
20439
+ 'Date and time at which Seam created the error.',
20440
+ format: 'date-time',
20441
+ type: 'string',
20442
+ },
20443
+ error_code: {
20444
+ description:
20445
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
20446
+ type: 'string',
20447
+ },
20448
+ message: {
20449
+ description:
20450
+ 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
20451
+ type: 'string',
20452
+ },
20453
+ },
20454
+ required: ['created_at', 'message', 'error_code'],
20455
+ type: 'object',
20456
+ },
20457
+ type: 'array',
20458
+ },
20459
+ access_code_id: {
20460
+ description: 'ID of the affected access code.',
20461
+ format: 'uuid',
20462
+ type: 'string',
20463
+ },
20464
+ access_code_warnings: {
20465
+ description: 'Warnings associated with the access code.',
20466
+ items: {
20467
+ description:
20468
+ 'Warning associated with the resource, including the warning code, message, and creation timestamp.',
20469
+ properties: {
20470
+ created_at: {
20471
+ description:
20472
+ 'Date and time at which Seam created the warning.',
20473
+ format: 'date-time',
20474
+ type: 'string',
20475
+ },
20476
+ message: {
20477
+ description:
20478
+ 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
20479
+ type: 'string',
20480
+ },
20481
+ warning_code: {
20482
+ description:
20483
+ 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
20484
+ type: 'string',
20485
+ },
20486
+ },
20487
+ required: ['created_at', 'message', 'warning_code'],
20488
+ type: 'object',
20489
+ },
20490
+ type: 'array',
20491
+ },
20492
+ connected_account_custom_metadata: {
20493
+ additionalProperties: {
20494
+ oneOf: [{ type: 'string' }, { type: 'boolean' }],
20495
+ },
20496
+ description:
20497
+ 'Custom metadata of the connected account, present when connected_account_id is provided.',
20498
+ type: 'object',
20499
+ },
20500
+ connected_account_errors: {
20501
+ description: 'Errors associated with the connected account.',
20502
+ items: {
20503
+ description:
20504
+ 'Error associated with the resource, including the error code, message, and creation timestamp.',
20505
+ properties: {
20506
+ created_at: {
20507
+ description:
20508
+ 'Date and time at which Seam created the error.',
20509
+ format: 'date-time',
20510
+ type: 'string',
20511
+ },
20512
+ error_code: {
20513
+ description:
20514
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
20515
+ type: 'string',
20516
+ },
20517
+ message: {
20518
+ description:
20519
+ 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
20520
+ type: 'string',
20521
+ },
20522
+ },
20523
+ required: ['created_at', 'message', 'error_code'],
20524
+ type: 'object',
20525
+ },
20526
+ type: 'array',
20527
+ },
20528
+ connected_account_id: {
20529
+ description:
20530
+ 'ID of the connected account associated with the affected access code.',
20531
+ format: 'uuid',
20532
+ type: 'string',
20533
+ },
20534
+ connected_account_warnings: {
20535
+ description: 'Warnings associated with the connected account.',
20536
+ items: {
20537
+ description:
20538
+ 'Warning associated with the resource, including the warning code, message, and creation timestamp.',
20539
+ properties: {
20540
+ created_at: {
20541
+ description:
20542
+ 'Date and time at which Seam created the warning.',
20543
+ format: 'date-time',
20544
+ type: 'string',
20545
+ },
20546
+ message: {
20547
+ description:
20548
+ 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
20549
+ type: 'string',
20550
+ },
20551
+ warning_code: {
20552
+ description:
20553
+ 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
20554
+ type: 'string',
20555
+ },
20556
+ },
20557
+ required: ['created_at', 'message', 'warning_code'],
20558
+ type: 'object',
20559
+ },
20560
+ type: 'array',
20561
+ },
20562
+ created_at: {
20563
+ description: 'Date and time at which the event was created.',
20564
+ format: 'date-time',
20565
+ type: 'string',
20566
+ },
20567
+ device_custom_metadata: {
20568
+ additionalProperties: {
20569
+ oneOf: [{ type: 'string' }, { type: 'boolean' }],
20570
+ },
20571
+ description:
20572
+ 'Custom metadata of the device, present when device_id is provided.',
20573
+ type: 'object',
20574
+ },
20575
+ device_errors: {
20576
+ description: 'Errors associated with the device.',
20577
+ items: {
20578
+ description:
20579
+ 'Error associated with the resource, including the error code, message, and creation timestamp.',
20580
+ properties: {
20581
+ created_at: {
20582
+ description:
20583
+ 'Date and time at which Seam created the error.',
20584
+ format: 'date-time',
20585
+ type: 'string',
20586
+ },
20587
+ error_code: {
20588
+ description:
20589
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
20590
+ type: 'string',
20591
+ },
20592
+ message: {
20593
+ description:
20594
+ 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
20595
+ type: 'string',
20596
+ },
20597
+ },
20598
+ required: ['created_at', 'message', 'error_code'],
20599
+ type: 'object',
20600
+ },
20601
+ type: 'array',
20602
+ },
20603
+ device_id: {
20604
+ description:
20605
+ 'ID of the device associated with the affected access code.',
20606
+ format: 'uuid',
20607
+ type: 'string',
20608
+ },
20609
+ device_warnings: {
20610
+ description: 'Warnings associated with the device.',
20611
+ items: {
20612
+ description:
20613
+ 'Warning associated with the resource, including the warning code, message, and creation timestamp.',
20614
+ properties: {
20615
+ created_at: {
20616
+ description:
20617
+ 'Date and time at which Seam created the warning.',
20618
+ format: 'date-time',
20619
+ type: 'string',
20620
+ },
20621
+ message: {
20622
+ description:
20623
+ 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
20624
+ type: 'string',
20625
+ },
20626
+ warning_code: {
20627
+ description:
20628
+ 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
20629
+ type: 'string',
20630
+ },
20631
+ },
20632
+ required: ['created_at', 'message', 'warning_code'],
20633
+ type: 'object',
20634
+ },
20635
+ type: 'array',
20636
+ },
20637
+ event_description: {
20638
+ description:
20639
+ 'Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.',
20640
+ type: 'string',
20641
+ },
20642
+ event_id: {
20643
+ description: 'ID of the event.',
20644
+ format: 'uuid',
20645
+ type: 'string',
20646
+ },
20647
+ event_type: {
20648
+ enum: ['access_code.failed_to_apply_mutations'],
20649
+ type: 'string',
20650
+ },
20651
+ occurred_at: {
20652
+ description: 'Date and time at which the event occurred.',
20653
+ format: 'date-time',
20654
+ type: 'string',
20655
+ },
20656
+ workspace_id: {
20657
+ description: 'ID of the workspace associated with the event.',
20658
+ format: 'uuid',
20659
+ type: 'string',
20660
+ },
20661
+ },
20662
+ required: [
20663
+ 'event_id',
20664
+ 'workspace_id',
20665
+ 'created_at',
20666
+ 'occurred_at',
20667
+ 'access_code_id',
20668
+ 'device_id',
20669
+ 'connected_account_id',
20670
+ 'event_type',
20671
+ 'connected_account_errors',
20672
+ 'connected_account_warnings',
20673
+ 'device_errors',
20674
+ 'device_warnings',
20675
+ 'access_code_errors',
20676
+ 'access_code_warnings',
20677
+ ],
20678
+ type: 'object',
20679
+ 'x-route-path': '/access_codes',
20680
+ 'x-undocumented': 'Unreleased.',
20681
+ },
20682
+ {
20683
+ description:
20684
+ 'An [access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes) is still active on the device even though its `ends_at` has passed, so the recipient may still be able to unlock the device after their access window ended. Seam is attempting to remove it, and the accompanying `failed_to_expire` error clears automatically once the access code is no longer active.',
20685
+ properties: {
20686
+ access_code_errors: {
20687
+ description: 'Errors associated with the access code.',
20688
+ items: {
20689
+ description:
20690
+ 'Error associated with the resource, including the error code, message, and creation timestamp.',
20691
+ properties: {
20692
+ created_at: {
20693
+ description:
20694
+ 'Date and time at which Seam created the error.',
20695
+ format: 'date-time',
20696
+ type: 'string',
20697
+ },
20698
+ error_code: {
20699
+ description:
20700
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
20701
+ type: 'string',
20702
+ },
20703
+ message: {
20704
+ description:
20705
+ 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
20706
+ type: 'string',
20707
+ },
20708
+ },
20709
+ required: ['created_at', 'message', 'error_code'],
20710
+ type: 'object',
20711
+ },
20712
+ type: 'array',
20713
+ },
20714
+ access_code_id: {
20715
+ description: 'ID of the affected access code.',
20716
+ format: 'uuid',
20717
+ type: 'string',
20718
+ },
20719
+ access_code_warnings: {
20720
+ description: 'Warnings associated with the access code.',
20721
+ items: {
20722
+ description:
20723
+ 'Warning associated with the resource, including the warning code, message, and creation timestamp.',
20724
+ properties: {
20725
+ created_at: {
20726
+ description:
20727
+ 'Date and time at which Seam created the warning.',
20728
+ format: 'date-time',
20729
+ type: 'string',
20730
+ },
20731
+ message: {
20732
+ description:
20733
+ 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
20734
+ type: 'string',
20735
+ },
20736
+ warning_code: {
20737
+ description:
20738
+ 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
20739
+ type: 'string',
20740
+ },
20741
+ },
20742
+ required: ['created_at', 'message', 'warning_code'],
20743
+ type: 'object',
20744
+ },
20745
+ type: 'array',
20746
+ },
20747
+ connected_account_custom_metadata: {
20748
+ additionalProperties: {
20749
+ oneOf: [{ type: 'string' }, { type: 'boolean' }],
20750
+ },
20751
+ description:
20752
+ 'Custom metadata of the connected account, present when connected_account_id is provided.',
20753
+ type: 'object',
20754
+ },
20755
+ connected_account_errors: {
20756
+ description: 'Errors associated with the connected account.',
20757
+ items: {
20758
+ description:
20759
+ 'Error associated with the resource, including the error code, message, and creation timestamp.',
20760
+ properties: {
20761
+ created_at: {
20762
+ description:
20763
+ 'Date and time at which Seam created the error.',
20764
+ format: 'date-time',
20765
+ type: 'string',
20766
+ },
20767
+ error_code: {
20768
+ description:
20769
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
20770
+ type: 'string',
20771
+ },
20772
+ message: {
20773
+ description:
20774
+ 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
20775
+ type: 'string',
20776
+ },
20777
+ },
20778
+ required: ['created_at', 'message', 'error_code'],
20779
+ type: 'object',
20780
+ },
20781
+ type: 'array',
20782
+ },
20783
+ connected_account_id: {
20784
+ description:
20785
+ 'ID of the connected account associated with the affected access code.',
20786
+ format: 'uuid',
20787
+ type: 'string',
20788
+ },
20789
+ connected_account_warnings: {
20790
+ description: 'Warnings associated with the connected account.',
20791
+ items: {
20792
+ description:
20793
+ 'Warning associated with the resource, including the warning code, message, and creation timestamp.',
20794
+ properties: {
20795
+ created_at: {
20796
+ description:
20797
+ 'Date and time at which Seam created the warning.',
20798
+ format: 'date-time',
20799
+ type: 'string',
20800
+ },
20801
+ message: {
20802
+ description:
20803
+ 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
20804
+ type: 'string',
20805
+ },
20806
+ warning_code: {
20807
+ description:
20808
+ 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
20809
+ type: 'string',
20810
+ },
20811
+ },
20812
+ required: ['created_at', 'message', 'warning_code'],
20813
+ type: 'object',
20814
+ },
20815
+ type: 'array',
20816
+ },
20817
+ created_at: {
20818
+ description: 'Date and time at which the event was created.',
20819
+ format: 'date-time',
20820
+ type: 'string',
20821
+ },
20822
+ device_custom_metadata: {
20823
+ additionalProperties: {
20824
+ oneOf: [{ type: 'string' }, { type: 'boolean' }],
20825
+ },
20826
+ description:
20827
+ 'Custom metadata of the device, present when device_id is provided.',
20828
+ type: 'object',
20829
+ },
20830
+ device_errors: {
20831
+ description: 'Errors associated with the device.',
20832
+ items: {
20833
+ description:
20834
+ 'Error associated with the resource, including the error code, message, and creation timestamp.',
20835
+ properties: {
20836
+ created_at: {
20837
+ description:
20838
+ 'Date and time at which Seam created the error.',
20839
+ format: 'date-time',
20840
+ type: 'string',
20841
+ },
20842
+ error_code: {
20843
+ description:
20844
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
20845
+ type: 'string',
20846
+ },
20847
+ message: {
20848
+ description:
20849
+ 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
20850
+ type: 'string',
20851
+ },
20852
+ },
20853
+ required: ['created_at', 'message', 'error_code'],
20854
+ type: 'object',
20855
+ },
20856
+ type: 'array',
20857
+ },
20858
+ device_id: {
20859
+ description:
20860
+ 'ID of the device associated with the affected access code.',
20861
+ format: 'uuid',
20862
+ type: 'string',
20863
+ },
20864
+ device_warnings: {
20865
+ description: 'Warnings associated with the device.',
20866
+ items: {
20867
+ description:
20868
+ 'Warning associated with the resource, including the warning code, message, and creation timestamp.',
20869
+ properties: {
20870
+ created_at: {
20871
+ description:
20872
+ 'Date and time at which Seam created the warning.',
20873
+ format: 'date-time',
20874
+ type: 'string',
20875
+ },
20876
+ message: {
20877
+ description:
20878
+ 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
20879
+ type: 'string',
20880
+ },
20881
+ warning_code: {
20882
+ description:
20883
+ 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
20884
+ type: 'string',
20885
+ },
20886
+ },
20887
+ required: ['created_at', 'message', 'warning_code'],
20888
+ type: 'object',
20889
+ },
20890
+ type: 'array',
20891
+ },
20892
+ event_description: {
20893
+ description:
20894
+ 'Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.',
20895
+ type: 'string',
20896
+ },
20897
+ event_id: {
20898
+ description: 'ID of the event.',
20899
+ format: 'uuid',
20900
+ type: 'string',
20901
+ },
20902
+ event_type: {
20903
+ enum: ['access_code.failed_to_expire'],
20904
+ type: 'string',
20905
+ },
20906
+ occurred_at: {
20907
+ description: 'Date and time at which the event occurred.',
20908
+ format: 'date-time',
20909
+ type: 'string',
20910
+ },
20911
+ workspace_id: {
20912
+ description: 'ID of the workspace associated with the event.',
20913
+ format: 'uuid',
20914
+ type: 'string',
20915
+ },
20916
+ },
20917
+ required: [
20918
+ 'event_id',
20919
+ 'workspace_id',
20920
+ 'created_at',
20921
+ 'occurred_at',
20922
+ 'access_code_id',
20923
+ 'device_id',
20924
+ 'connected_account_id',
20925
+ 'event_type',
20926
+ 'connected_account_errors',
20927
+ 'connected_account_warnings',
20928
+ 'device_errors',
20929
+ 'device_warnings',
20930
+ 'access_code_errors',
20931
+ 'access_code_warnings',
20932
+ ],
20933
+ type: 'object',
20934
+ 'x-route-path': '/access_codes',
20935
+ 'x-undocumented': 'Unreleased.',
20936
+ },
20937
+ {
20938
+ description:
20939
+ 'An [access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes) was deleted.',
20940
+ properties: {
20941
+ access_code_id: {
20942
+ description: 'ID of the affected access code.',
20943
+ format: 'uuid',
20944
+ type: 'string',
20945
+ },
20946
+ code: {
20947
+ description: 'Code for the affected access code.',
20948
+ nullable: true,
20949
+ type: 'string',
20950
+ },
20951
+ connected_account_custom_metadata: {
20952
+ additionalProperties: {
20953
+ oneOf: [{ type: 'string' }, { type: 'boolean' }],
20954
+ },
20955
+ description:
20956
+ 'Custom metadata of the connected account, present when connected_account_id is provided.',
20957
+ type: 'object',
20958
+ },
20959
+ connected_account_id: {
20960
+ description:
20961
+ 'ID of the connected account associated with the affected access code.',
20962
+ format: 'uuid',
20963
+ type: 'string',
20964
+ },
20965
+ created_at: {
20966
+ description: 'Date and time at which the event was created.',
20967
+ format: 'date-time',
20968
+ type: 'string',
20969
+ },
20970
+ device_custom_metadata: {
20971
+ additionalProperties: {
20972
+ oneOf: [{ type: 'string' }, { type: 'boolean' }],
20973
+ },
20974
+ description:
20975
+ 'Custom metadata of the device, present when device_id is provided.',
20976
+ type: 'object',
20977
+ },
20978
+ device_id: {
20979
+ description:
20980
+ 'ID of the device associated with the affected access code.',
20981
+ format: 'uuid',
20982
+ type: 'string',
20983
+ },
20984
+ event_description: {
20985
+ description:
20986
+ 'Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.',
20987
+ type: 'string',
20988
+ },
20989
+ event_id: {
20990
+ description: 'ID of the event.',
20991
+ format: 'uuid',
20992
+ type: 'string',
20993
+ },
20994
+ event_type: { enum: ['access_code.deleted'], type: 'string' },
20995
+ occurred_at: {
20996
+ description: 'Date and time at which the event occurred.',
20997
+ format: 'date-time',
20998
+ type: 'string',
20999
+ },
21000
+ workspace_id: {
21001
+ description: 'ID of the workspace associated with the event.',
21002
+ format: 'uuid',
21003
+ type: 'string',
21004
+ },
21005
+ },
21006
+ required: [
21007
+ 'event_id',
21008
+ 'workspace_id',
21009
+ 'created_at',
21010
+ 'occurred_at',
21011
+ 'access_code_id',
21012
+ 'device_id',
21013
+ 'connected_account_id',
21014
+ 'event_type',
21015
+ 'code',
21016
+ ],
21017
+ type: 'object',
21018
+ 'x-route-path': '/access_codes',
21019
+ },
21020
+ {
21021
+ deprecated: true,
21022
+ description:
21023
+ 'There was an unusually long delay in removing an [access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes) from a device.',
21024
+ properties: {
21025
+ access_code_errors: {
21026
+ description: 'Errors associated with the access code.',
21027
+ items: {
21028
+ description:
21029
+ 'Error associated with the resource, including the error code, message, and creation timestamp.',
21030
+ properties: {
21031
+ created_at: {
21032
+ description:
21033
+ 'Date and time at which Seam created the error.',
21034
+ format: 'date-time',
21035
+ type: 'string',
21036
+ },
21037
+ error_code: {
21038
+ description:
21039
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
21040
+ type: 'string',
21041
+ },
21042
+ message: {
21043
+ description:
21044
+ 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
21045
+ type: 'string',
21046
+ },
21047
+ },
21048
+ required: ['created_at', 'message', 'error_code'],
21049
+ type: 'object',
21050
+ },
21051
+ type: 'array',
21052
+ },
21053
+ access_code_id: {
21054
+ description: 'ID of the affected access code.',
21055
+ format: 'uuid',
21056
+ type: 'string',
21057
+ },
21058
+ access_code_warnings: {
21059
+ description: 'Warnings associated with the access code.',
21060
+ items: {
21061
+ description:
21062
+ 'Warning associated with the resource, including the warning code, message, and creation timestamp.',
21063
+ properties: {
21064
+ created_at: {
21065
+ description:
21066
+ 'Date and time at which Seam created the warning.',
21067
+ format: 'date-time',
21068
+ type: 'string',
21069
+ },
21070
+ message: {
21071
+ description:
21072
+ 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
21073
+ type: 'string',
21074
+ },
21075
+ warning_code: {
21076
+ description:
21077
+ 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
21078
+ type: 'string',
21079
+ },
21080
+ },
21081
+ required: ['created_at', 'message', 'warning_code'],
21082
+ type: 'object',
21083
+ },
21084
+ type: 'array',
21085
+ },
21086
+ connected_account_custom_metadata: {
21087
+ additionalProperties: {
21088
+ oneOf: [{ type: 'string' }, { type: 'boolean' }],
21089
+ },
21090
+ description:
21091
+ 'Custom metadata of the connected account, present when connected_account_id is provided.',
21092
+ type: 'object',
21093
+ },
21094
+ connected_account_errors: {
21095
+ description: 'Errors associated with the connected account.',
21096
+ items: {
21097
+ description:
21098
+ 'Error associated with the resource, including the error code, message, and creation timestamp.',
21099
+ properties: {
21100
+ created_at: {
21101
+ description:
21102
+ 'Date and time at which Seam created the error.',
21103
+ format: 'date-time',
21104
+ type: 'string',
21105
+ },
21106
+ error_code: {
21107
+ description:
21108
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
21109
+ type: 'string',
21110
+ },
21111
+ message: {
21112
+ description:
21113
+ 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
21114
+ type: 'string',
21115
+ },
21116
+ },
21117
+ required: ['created_at', 'message', 'error_code'],
21118
+ type: 'object',
21119
+ },
21120
+ type: 'array',
21121
+ },
21122
+ connected_account_id: {
21123
+ description:
21124
+ 'ID of the connected account associated with the affected access code.',
21125
+ format: 'uuid',
21126
+ type: 'string',
21127
+ },
21128
+ connected_account_warnings: {
21129
+ description: 'Warnings associated with the connected account.',
21130
+ items: {
21131
+ description:
21132
+ 'Warning associated with the resource, including the warning code, message, and creation timestamp.',
21133
+ properties: {
21134
+ created_at: {
21135
+ description:
21136
+ 'Date and time at which Seam created the warning.',
21137
+ format: 'date-time',
21138
+ type: 'string',
21139
+ },
21140
+ message: {
21141
+ description:
21142
+ 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
21143
+ type: 'string',
21144
+ },
21145
+ warning_code: {
21146
+ description:
21147
+ 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
21148
+ type: 'string',
21149
+ },
21150
+ },
21151
+ required: ['created_at', 'message', 'warning_code'],
21152
+ type: 'object',
21153
+ },
21154
+ type: 'array',
21155
+ },
21156
+ created_at: {
21157
+ description: 'Date and time at which the event was created.',
21158
+ format: 'date-time',
21159
+ type: 'string',
21160
+ },
21161
+ device_custom_metadata: {
21162
+ additionalProperties: {
21163
+ oneOf: [{ type: 'string' }, { type: 'boolean' }],
21164
+ },
21165
+ description:
21166
+ 'Custom metadata of the device, present when device_id is provided.',
21167
+ type: 'object',
21168
+ },
21169
+ device_errors: {
21170
+ description: 'Errors associated with the device.',
21171
+ items: {
21172
+ description:
21173
+ 'Error associated with the resource, including the error code, message, and creation timestamp.',
21174
+ properties: {
21175
+ created_at: {
21176
+ description:
21177
+ 'Date and time at which Seam created the error.',
21178
+ format: 'date-time',
21179
+ type: 'string',
21180
+ },
21181
+ error_code: {
21182
+ description:
21183
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
21184
+ type: 'string',
21185
+ },
21186
+ message: {
21187
+ description:
21188
+ 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
21189
+ type: 'string',
21190
+ },
21191
+ },
21192
+ required: ['created_at', 'message', 'error_code'],
21193
+ type: 'object',
21194
+ },
21195
+ type: 'array',
21196
+ },
21197
+ device_id: {
21198
+ description:
21199
+ 'ID of the device associated with the affected access code.',
21200
+ format: 'uuid',
21201
+ type: 'string',
21202
+ },
21203
+ device_warnings: {
21204
+ description: 'Warnings associated with the device.',
21205
+ items: {
21206
+ description:
21207
+ 'Warning associated with the resource, including the warning code, message, and creation timestamp.',
21208
+ properties: {
21209
+ created_at: {
21210
+ description:
21211
+ 'Date and time at which Seam created the warning.',
21212
+ format: 'date-time',
21213
+ type: 'string',
21214
+ },
21215
+ message: {
21216
+ description:
21217
+ 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
21218
+ type: 'string',
21219
+ },
21220
+ warning_code: {
21221
+ description:
21222
+ 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
21223
+ type: 'string',
21224
+ },
21225
+ },
21226
+ required: ['created_at', 'message', 'warning_code'],
21227
+ type: 'object',
21228
+ },
21229
+ type: 'array',
21230
+ },
21231
+ event_description: {
21232
+ description:
21233
+ 'Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.',
21234
+ type: 'string',
21235
+ },
21236
+ event_id: {
21237
+ description: 'ID of the event.',
21238
+ format: 'uuid',
21239
+ type: 'string',
21240
+ },
21241
+ event_type: {
21242
+ enum: ['access_code.delay_in_removing_from_device'],
21243
+ type: 'string',
21244
+ },
21245
+ occurred_at: {
21246
+ description: 'Date and time at which the event occurred.',
21247
+ format: 'date-time',
21248
+ type: 'string',
21249
+ },
21250
+ workspace_id: {
21251
+ description: 'ID of the workspace associated with the event.',
21252
+ format: 'uuid',
21253
+ type: 'string',
21254
+ },
21255
+ },
21256
+ required: [
21257
+ 'event_id',
21258
+ 'workspace_id',
21259
+ 'created_at',
21260
+ 'occurred_at',
21261
+ 'access_code_id',
21262
+ 'device_id',
21263
+ 'connected_account_id',
21264
+ 'event_type',
21265
+ 'connected_account_errors',
21266
+ 'connected_account_warnings',
21267
+ 'device_errors',
21268
+ 'device_warnings',
21269
+ 'access_code_errors',
21270
+ 'access_code_warnings',
21271
+ ],
21272
+ type: 'object',
21273
+ 'x-deprecated':
21274
+ 'Seam no longer emits this event. Use `access_code.failed_to_remove_from_device` instead.',
21275
+ 'x-route-path': '/access_codes',
21276
+ },
21277
+ {
21278
+ description:
21279
+ 'An [access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes) failed to be removed from a device.',
21280
+ properties: {
21281
+ access_code_errors: {
21282
+ description: 'Errors associated with the access code.',
21283
+ items: {
21284
+ description:
21285
+ 'Error associated with the resource, including the error code, message, and creation timestamp.',
21286
+ properties: {
21287
+ created_at: {
21288
+ description:
21289
+ 'Date and time at which Seam created the error.',
21290
+ format: 'date-time',
21291
+ type: 'string',
21292
+ },
21293
+ error_code: {
21294
+ description:
21295
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
21296
+ type: 'string',
21297
+ },
21298
+ message: {
21299
+ description:
21300
+ 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
21301
+ type: 'string',
21302
+ },
21303
+ },
21304
+ required: ['created_at', 'message', 'error_code'],
21305
+ type: 'object',
21306
+ },
21307
+ type: 'array',
21308
+ },
21309
+ access_code_id: {
21310
+ description: 'ID of the affected access code.',
21311
+ format: 'uuid',
21312
+ type: 'string',
21313
+ },
21314
+ access_code_warnings: {
21315
+ description: 'Warnings associated with the access code.',
21316
+ items: {
21317
+ description:
21318
+ 'Warning associated with the resource, including the warning code, message, and creation timestamp.',
21319
+ properties: {
21320
+ created_at: {
21321
+ description:
21322
+ 'Date and time at which Seam created the warning.',
21323
+ format: 'date-time',
21324
+ type: 'string',
21325
+ },
21326
+ message: {
21327
+ description:
21328
+ 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
21329
+ type: 'string',
21330
+ },
21331
+ warning_code: {
21332
+ description:
21333
+ 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
21334
+ type: 'string',
21335
+ },
21336
+ },
21337
+ required: ['created_at', 'message', 'warning_code'],
21338
+ type: 'object',
21339
+ },
21340
+ type: 'array',
21341
+ },
21342
+ connected_account_custom_metadata: {
21343
+ additionalProperties: {
21344
+ oneOf: [{ type: 'string' }, { type: 'boolean' }],
21345
+ },
21346
+ description:
21347
+ 'Custom metadata of the connected account, present when connected_account_id is provided.',
21348
+ type: 'object',
21349
+ },
21350
+ connected_account_errors: {
21351
+ description: 'Errors associated with the connected account.',
21352
+ items: {
21353
+ description:
21354
+ 'Error associated with the resource, including the error code, message, and creation timestamp.',
21355
+ properties: {
21356
+ created_at: {
21357
+ description:
21358
+ 'Date and time at which Seam created the error.',
21359
+ format: 'date-time',
21360
+ type: 'string',
21361
+ },
21362
+ error_code: {
21363
+ description:
21364
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
21365
+ type: 'string',
21366
+ },
21367
+ message: {
21368
+ description:
21369
+ 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
21370
+ type: 'string',
21371
+ },
21372
+ },
21373
+ required: ['created_at', 'message', 'error_code'],
21374
+ type: 'object',
21375
+ },
21376
+ type: 'array',
21377
+ },
21378
+ connected_account_id: {
21379
+ description:
21380
+ 'ID of the connected account associated with the affected access code.',
21381
+ format: 'uuid',
21382
+ type: 'string',
21383
+ },
21384
+ connected_account_warnings: {
21385
+ description: 'Warnings associated with the connected account.',
21386
+ items: {
21387
+ description:
21388
+ 'Warning associated with the resource, including the warning code, message, and creation timestamp.',
21389
+ properties: {
21390
+ created_at: {
21391
+ description:
21392
+ 'Date and time at which Seam created the warning.',
21393
+ format: 'date-time',
21394
+ type: 'string',
21395
+ },
21396
+ message: {
21397
+ description:
21398
+ 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
21399
+ type: 'string',
21400
+ },
21401
+ warning_code: {
21402
+ description:
21403
+ 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
21404
+ type: 'string',
21405
+ },
21406
+ },
21407
+ required: ['created_at', 'message', 'warning_code'],
21408
+ type: 'object',
21409
+ },
21410
+ type: 'array',
21411
+ },
21412
+ created_at: {
21413
+ description: 'Date and time at which the event was created.',
21414
+ format: 'date-time',
21415
+ type: 'string',
21416
+ },
21417
+ device_custom_metadata: {
21418
+ additionalProperties: {
21419
+ oneOf: [{ type: 'string' }, { type: 'boolean' }],
21420
+ },
21421
+ description:
21422
+ 'Custom metadata of the device, present when device_id is provided.',
21423
+ type: 'object',
21424
+ },
21425
+ device_errors: {
21426
+ description: 'Errors associated with the device.',
21427
+ items: {
21428
+ description:
21429
+ 'Error associated with the resource, including the error code, message, and creation timestamp.',
21430
+ properties: {
21431
+ created_at: {
21432
+ description:
21433
+ 'Date and time at which Seam created the error.',
21434
+ format: 'date-time',
21435
+ type: 'string',
21436
+ },
21437
+ error_code: {
21438
+ description:
21439
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
21440
+ type: 'string',
21441
+ },
21442
+ message: {
21443
+ description:
21444
+ 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
21445
+ type: 'string',
21446
+ },
21447
+ },
21448
+ required: ['created_at', 'message', 'error_code'],
21449
+ type: 'object',
21450
+ },
21451
+ type: 'array',
21452
+ },
21453
+ device_id: {
21454
+ description:
21455
+ 'ID of the device associated with the affected access code.',
21456
+ format: 'uuid',
21457
+ type: 'string',
21458
+ },
21459
+ device_warnings: {
21460
+ description: 'Warnings associated with the device.',
21461
+ items: {
21462
+ description:
21463
+ 'Warning associated with the resource, including the warning code, message, and creation timestamp.',
21464
+ properties: {
21465
+ created_at: {
21466
+ description:
21467
+ 'Date and time at which Seam created the warning.',
21468
+ format: 'date-time',
21469
+ type: 'string',
21470
+ },
21471
+ message: {
21472
+ description:
21473
+ 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
21474
+ type: 'string',
21475
+ },
21476
+ warning_code: {
21477
+ description:
21478
+ 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
21479
+ type: 'string',
21480
+ },
21481
+ },
21482
+ required: ['created_at', 'message', 'warning_code'],
21483
+ type: 'object',
21484
+ },
21485
+ type: 'array',
21486
+ },
21487
+ event_description: {
21488
+ description:
21489
+ 'Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.',
21490
+ type: 'string',
21491
+ },
21492
+ event_id: {
21493
+ description: 'ID of the event.',
21494
+ format: 'uuid',
21495
+ type: 'string',
21496
+ },
21497
+ event_type: {
21498
+ enum: ['access_code.failed_to_remove_from_device'],
21499
+ type: 'string',
21500
+ },
21501
+ occurred_at: {
21502
+ description: 'Date and time at which the event occurred.',
21503
+ format: 'date-time',
21504
+ type: 'string',
21505
+ },
21506
+ workspace_id: {
21507
+ description: 'ID of the workspace associated with the event.',
21508
+ format: 'uuid',
21509
+ type: 'string',
21510
+ },
21511
+ },
21512
+ required: [
21513
+ 'event_id',
21514
+ 'workspace_id',
21515
+ 'created_at',
21516
+ 'occurred_at',
21517
+ 'access_code_id',
21518
+ 'device_id',
21519
+ 'connected_account_id',
21520
+ 'event_type',
21521
+ 'connected_account_errors',
21522
+ 'connected_account_warnings',
21523
+ 'device_errors',
21524
+ 'device_warnings',
21525
+ 'access_code_errors',
21526
+ 'access_code_warnings',
21527
+ ],
21528
+ type: 'object',
21529
+ 'x-route-path': '/access_codes',
21530
+ },
21531
+ {
21532
+ description:
21533
+ 'An [access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes) was modified outside of Seam.',
21534
+ properties: {
21535
+ access_code_id: {
21536
+ description: 'ID of the affected access code.',
21537
+ format: 'uuid',
21538
+ type: 'string',
21539
+ },
21540
+ connected_account_custom_metadata: {
21541
+ additionalProperties: {
21542
+ oneOf: [{ type: 'string' }, { type: 'boolean' }],
21543
+ },
21544
+ description:
21545
+ 'Custom metadata of the connected account, present when connected_account_id is provided.',
21546
+ type: 'object',
21547
+ },
21548
+ connected_account_id: {
21549
+ description:
21550
+ 'ID of the connected account associated with the affected access code.',
21551
+ format: 'uuid',
21552
+ type: 'string',
21553
+ },
21554
+ created_at: {
21555
+ description: 'Date and time at which the event was created.',
21556
+ format: 'date-time',
21557
+ type: 'string',
21558
+ },
21559
+ device_custom_metadata: {
21560
+ additionalProperties: {
21561
+ oneOf: [{ type: 'string' }, { type: 'boolean' }],
21562
+ },
21563
+ description:
21564
+ 'Custom metadata of the device, present when device_id is provided.',
21565
+ type: 'object',
21566
+ },
21567
+ device_id: {
21568
+ description:
21569
+ 'ID of the device associated with the affected access code.',
21570
+ format: 'uuid',
21571
+ type: 'string',
21572
+ },
21573
+ event_description: {
21574
+ description:
21575
+ 'Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.',
21576
+ type: 'string',
21577
+ },
21578
+ event_id: {
21579
+ description: 'ID of the event.',
21580
+ format: 'uuid',
21581
+ type: 'string',
21582
+ },
21583
+ event_type: {
21584
+ enum: ['access_code.modified_external_to_seam'],
20076
21585
  type: 'string',
20077
21586
  },
20078
21587
  occurred_at: {
@@ -30556,6 +32065,105 @@ const openapi: OpenAPISpec = {
30556
32065
  type: 'object',
30557
32066
  'x-resource-type': 'access_code',
30558
32067
  },
32068
+ {
32069
+ description:
32070
+ 'Seam was unable to issue this access code before its start time, so the recipient may be unable to unlock the device. This usually points to a problem that needs attention, such as an offline or disconnected device. Seam keeps retrying, and this error clears automatically if the access code is eventually issued.',
32071
+ properties: {
32072
+ created_at: {
32073
+ description:
32074
+ 'Date and time at which Seam created the error.',
32075
+ format: 'date-time',
32076
+ type: 'string',
32077
+ },
32078
+ error_code: {
32079
+ description:
32080
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
32081
+ enum: ['failed_to_issue'],
32082
+ type: 'string',
32083
+ },
32084
+ is_access_code_error: {
32085
+ description:
32086
+ 'Indicates that this is an access code error.',
32087
+ enum: [true],
32088
+ type: 'boolean',
32089
+ },
32090
+ message: {
32091
+ description:
32092
+ 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
32093
+ type: 'string',
32094
+ },
32095
+ },
32096
+ required: ['message', 'is_access_code_error', 'error_code'],
32097
+ type: 'object',
32098
+ 'x-resource-type': 'access_code',
32099
+ 'x-undocumented': 'Unreleased.',
32100
+ },
32101
+ {
32102
+ description:
32103
+ "Seam was unable to apply this access code's pending mutations to the device, so the code on the device does not match its requested state. Seam keeps retrying, and this error clears automatically once the mutations are applied.",
32104
+ properties: {
32105
+ created_at: {
32106
+ description:
32107
+ 'Date and time at which Seam created the error.',
32108
+ format: 'date-time',
32109
+ type: 'string',
32110
+ },
32111
+ error_code: {
32112
+ description:
32113
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
32114
+ enum: ['failed_to_apply_mutations'],
32115
+ type: 'string',
32116
+ },
32117
+ is_access_code_error: {
32118
+ description:
32119
+ 'Indicates that this is an access code error.',
32120
+ enum: [true],
32121
+ type: 'boolean',
32122
+ },
32123
+ message: {
32124
+ description:
32125
+ 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
32126
+ type: 'string',
32127
+ },
32128
+ },
32129
+ required: ['message', 'is_access_code_error', 'error_code'],
32130
+ type: 'object',
32131
+ 'x-resource-type': 'access_code',
32132
+ 'x-undocumented': 'Unreleased.',
32133
+ },
32134
+ {
32135
+ description:
32136
+ 'This access code is still active on the device even though its `ends_at` has passed, so the recipient may still be able to unlock the device after their access window ended. Seam is attempting to remove it, and this error clears automatically once the access code is no longer active.',
32137
+ properties: {
32138
+ created_at: {
32139
+ description:
32140
+ 'Date and time at which Seam created the error.',
32141
+ format: 'date-time',
32142
+ type: 'string',
32143
+ },
32144
+ error_code: {
32145
+ description:
32146
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
32147
+ enum: ['failed_to_expire'],
32148
+ type: 'string',
32149
+ },
32150
+ is_access_code_error: {
32151
+ description:
32152
+ 'Indicates that this is an access code error.',
32153
+ enum: [true],
32154
+ type: 'boolean',
32155
+ },
32156
+ message: {
32157
+ description:
32158
+ 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
32159
+ type: 'string',
32160
+ },
32161
+ },
32162
+ required: ['message', 'is_access_code_error', 'error_code'],
32163
+ type: 'object',
32164
+ 'x-resource-type': 'access_code',
32165
+ 'x-undocumented': 'Unreleased.',
32166
+ },
30559
32167
  {
30560
32168
  description: 'Indicates that the account is disconnected.',
30561
32169
  properties: {
@@ -31310,6 +32918,58 @@ const openapi: OpenAPISpec = {
31310
32918
  'x-deprecated':
31311
32919
  'Seam no longer sets this warning. Use the `failed_to_remove_from_device` error instead.',
31312
32920
  },
32921
+ {
32922
+ description:
32923
+ 'Seam has not yet issued this access code, even though its start time is approaching, so access may not be ready when the recipient arrives. Seam is still attempting to issue it, and this warning clears automatically once issuance succeeds.',
32924
+ properties: {
32925
+ created_at: {
32926
+ description:
32927
+ 'Date and time at which Seam created the warning.',
32928
+ format: 'date-time',
32929
+ type: 'string',
32930
+ },
32931
+ message: {
32932
+ description:
32933
+ 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
32934
+ type: 'string',
32935
+ },
32936
+ warning_code: {
32937
+ description:
32938
+ 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
32939
+ enum: ['delay_in_issuing'],
32940
+ type: 'string',
32941
+ },
32942
+ },
32943
+ required: ['message', 'warning_code'],
32944
+ type: 'object',
32945
+ 'x-undocumented': 'Unreleased.',
32946
+ },
32947
+ {
32948
+ description:
32949
+ "Seam has not yet applied this access code's pending mutations to the device, so the code on the device does not yet match its requested state. Seam is still attempting to apply them, and this warning clears automatically once the mutations are applied.",
32950
+ properties: {
32951
+ created_at: {
32952
+ description:
32953
+ 'Date and time at which Seam created the warning.',
32954
+ format: 'date-time',
32955
+ type: 'string',
32956
+ },
32957
+ message: {
32958
+ description:
32959
+ 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
32960
+ type: 'string',
32961
+ },
32962
+ warning_code: {
32963
+ description:
32964
+ 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
32965
+ enum: ['delay_in_applying_mutations'],
32966
+ type: 'string',
32967
+ },
32968
+ },
32969
+ required: ['message', 'warning_code'],
32970
+ type: 'object',
32971
+ 'x-undocumented': 'Unreleased.',
32972
+ },
31313
32973
  {
31314
32974
  description:
31315
32975
  'Third-party integration detected that may cause access codes to fail.',
@@ -34719,6 +36379,11 @@ const openapi: OpenAPISpec = {
34719
36379
  },
34720
36380
  ],
34721
36381
  },
36382
+ display_name: {
36383
+ description:
36384
+ 'Display name of the device, defaults to nickname (if it is set) or `properties.appearance.name`, otherwise. Enables administrators and users to identify the device easily, especially when there are numerous devices.',
36385
+ type: 'string',
36386
+ },
34722
36387
  errors: {
34723
36388
  description:
34724
36389
  'Array of errors associated with the device. Each error object within the array contains two fields: `error_code` and `message`. `error_code` is a string that uniquely identifies the type of error, enabling quick recognition and categorization of the issue. `message` provides a more detailed description of the error, offering insights into the issue and potentially how to rectify it.',
@@ -36227,6 +37892,7 @@ const openapi: OpenAPISpec = {
36227
37892
  'warnings',
36228
37893
  'created_at',
36229
37894
  'custom_metadata',
37895
+ 'display_name',
36230
37896
  'is_managed',
36231
37897
  'properties',
36232
37898
  ],
@@ -59442,6 +61108,12 @@ const openapi: OpenAPISpec = {
59442
61108
  'access_code.removed_from_device',
59443
61109
  'access_code.delay_in_setting_on_device',
59444
61110
  'access_code.failed_to_set_on_device',
61111
+ 'access_code.issued',
61112
+ 'access_code.delay_in_issuing',
61113
+ 'access_code.failed_to_issue',
61114
+ 'access_code.delay_in_applying_mutations',
61115
+ 'access_code.failed_to_apply_mutations',
61116
+ 'access_code.failed_to_expire',
59445
61117
  'access_code.deleted',
59446
61118
  'access_code.delay_in_removing_from_device',
59447
61119
  'access_code.failed_to_remove_from_device',
@@ -59562,6 +61234,12 @@ const openapi: OpenAPISpec = {
59562
61234
  'access_code.removed_from_device',
59563
61235
  'access_code.delay_in_setting_on_device',
59564
61236
  'access_code.failed_to_set_on_device',
61237
+ 'access_code.issued',
61238
+ 'access_code.delay_in_issuing',
61239
+ 'access_code.failed_to_issue',
61240
+ 'access_code.delay_in_applying_mutations',
61241
+ 'access_code.failed_to_apply_mutations',
61242
+ 'access_code.failed_to_expire',
59565
61243
  'access_code.deleted',
59566
61244
  'access_code.delay_in_removing_from_device',
59567
61245
  'access_code.failed_to_remove_from_device',
@@ -60014,6 +61692,12 @@ const openapi: OpenAPISpec = {
60014
61692
  'access_code.removed_from_device',
60015
61693
  'access_code.delay_in_setting_on_device',
60016
61694
  'access_code.failed_to_set_on_device',
61695
+ 'access_code.issued',
61696
+ 'access_code.delay_in_issuing',
61697
+ 'access_code.failed_to_issue',
61698
+ 'access_code.delay_in_applying_mutations',
61699
+ 'access_code.failed_to_apply_mutations',
61700
+ 'access_code.failed_to_expire',
60017
61701
  'access_code.deleted',
60018
61702
  'access_code.delay_in_removing_from_device',
60019
61703
  'access_code.failed_to_remove_from_device',
@@ -60130,6 +61814,12 @@ const openapi: OpenAPISpec = {
60130
61814
  'access_code.removed_from_device',
60131
61815
  'access_code.delay_in_setting_on_device',
60132
61816
  'access_code.failed_to_set_on_device',
61817
+ 'access_code.issued',
61818
+ 'access_code.delay_in_issuing',
61819
+ 'access_code.failed_to_issue',
61820
+ 'access_code.delay_in_applying_mutations',
61821
+ 'access_code.failed_to_apply_mutations',
61822
+ 'access_code.failed_to_expire',
60133
61823
  'access_code.deleted',
60134
61824
  'access_code.delay_in_removing_from_device',
60135
61825
  'access_code.failed_to_remove_from_device',
@@ -72444,6 +74134,12 @@ const openapi: OpenAPISpec = {
72444
74134
  'access_code.removed_from_device',
72445
74135
  'access_code.delay_in_setting_on_device',
72446
74136
  'access_code.failed_to_set_on_device',
74137
+ 'access_code.issued',
74138
+ 'access_code.delay_in_issuing',
74139
+ 'access_code.failed_to_issue',
74140
+ 'access_code.delay_in_applying_mutations',
74141
+ 'access_code.failed_to_apply_mutations',
74142
+ 'access_code.failed_to_expire',
72447
74143
  'access_code.deleted',
72448
74144
  'access_code.delay_in_removing_from_device',
72449
74145
  'access_code.failed_to_remove_from_device',
@@ -72565,6 +74261,12 @@ const openapi: OpenAPISpec = {
72565
74261
  'access_code.removed_from_device',
72566
74262
  'access_code.delay_in_setting_on_device',
72567
74263
  'access_code.failed_to_set_on_device',
74264
+ 'access_code.issued',
74265
+ 'access_code.delay_in_issuing',
74266
+ 'access_code.failed_to_issue',
74267
+ 'access_code.delay_in_applying_mutations',
74268
+ 'access_code.failed_to_apply_mutations',
74269
+ 'access_code.failed_to_expire',
72568
74270
  'access_code.deleted',
72569
74271
  'access_code.delay_in_removing_from_device',
72570
74272
  'access_code.failed_to_remove_from_device',
@@ -72747,6 +74449,12 @@ const openapi: OpenAPISpec = {
72747
74449
  'access_code.removed_from_device',
72748
74450
  'access_code.delay_in_setting_on_device',
72749
74451
  'access_code.failed_to_set_on_device',
74452
+ 'access_code.issued',
74453
+ 'access_code.delay_in_issuing',
74454
+ 'access_code.failed_to_issue',
74455
+ 'access_code.delay_in_applying_mutations',
74456
+ 'access_code.failed_to_apply_mutations',
74457
+ 'access_code.failed_to_expire',
72750
74458
  'access_code.deleted',
72751
74459
  'access_code.delay_in_removing_from_device',
72752
74460
  'access_code.failed_to_remove_from_device',
@@ -72863,6 +74571,12 @@ const openapi: OpenAPISpec = {
72863
74571
  'access_code.removed_from_device',
72864
74572
  'access_code.delay_in_setting_on_device',
72865
74573
  'access_code.failed_to_set_on_device',
74574
+ 'access_code.issued',
74575
+ 'access_code.delay_in_issuing',
74576
+ 'access_code.failed_to_issue',
74577
+ 'access_code.delay_in_applying_mutations',
74578
+ 'access_code.failed_to_apply_mutations',
74579
+ 'access_code.failed_to_expire',
72866
74580
  'access_code.deleted',
72867
74581
  'access_code.delay_in_removing_from_device',
72868
74582
  'access_code.failed_to_remove_from_device',