@seamapi/types 1.1027.0 → 1.1029.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.',
@@ -15462,30 +15613,6 @@ const openapi: OpenAPISpec = {
15462
15613
  'Set to true when the device does not support the /dual-setpoints API endpoint.',
15463
15614
  type: 'boolean',
15464
15615
  },
15465
- enforced_cooling_setpoint_range_celsius: {
15466
- description:
15467
- 'Enforced cooling setpoint range in Celsius for a Sensi device, derived from an OutOfRange API error.',
15468
- items: { format: 'float', type: 'number' },
15469
- maxItems: 2,
15470
- minItems: 2,
15471
- type: 'array',
15472
- },
15473
- enforced_heating_setpoint_range_celsius: {
15474
- description:
15475
- 'Enforced heating setpoint range in Celsius for a Sensi device, derived from an OutOfRange API error.',
15476
- items: { format: 'float', type: 'number' },
15477
- maxItems: 2,
15478
- minItems: 2,
15479
- type: 'array',
15480
- },
15481
- enforced_setpoint_range_celsius: {
15482
- description:
15483
- 'Legacy combined enforced setpoint range in Celsius for a Sensi device, derived from an OutOfRange API error. Read as a fallback for the per-mode ranges below; no longer written.',
15484
- items: { format: 'float', type: 'number' },
15485
- maxItems: 2,
15486
- minItems: 2,
15487
- type: 'array',
15488
- },
15489
15616
  product_type: {
15490
15617
  description: 'Product type for a Sensi device.',
15491
15618
  type: 'string',
@@ -18832,20 +18959,1257 @@ const openapi: OpenAPISpec = {
18832
18959
  'device_id',
18833
18960
  'connected_account_id',
18834
18961
  'event_type',
18835
- 'code',
18962
+ 'code',
18963
+ ],
18964
+ type: 'object',
18965
+ 'x-route-path': '/access_codes',
18966
+ },
18967
+ {
18968
+ description:
18969
+ 'An [access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes) was removed from a device.',
18970
+ properties: {
18971
+ access_code_id: {
18972
+ description: 'ID of the affected access code.',
18973
+ format: 'uuid',
18974
+ type: 'string',
18975
+ },
18976
+ connected_account_custom_metadata: {
18977
+ additionalProperties: {
18978
+ oneOf: [{ type: 'string' }, { type: 'boolean' }],
18979
+ },
18980
+ description:
18981
+ 'Custom metadata of the connected account, present when connected_account_id is provided.',
18982
+ type: 'object',
18983
+ },
18984
+ connected_account_id: {
18985
+ description:
18986
+ 'ID of the connected account associated with the affected access code.',
18987
+ format: 'uuid',
18988
+ type: 'string',
18989
+ },
18990
+ created_at: {
18991
+ description: 'Date and time at which the event was created.',
18992
+ format: 'date-time',
18993
+ type: 'string',
18994
+ },
18995
+ device_custom_metadata: {
18996
+ additionalProperties: {
18997
+ oneOf: [{ type: 'string' }, { type: 'boolean' }],
18998
+ },
18999
+ description:
19000
+ 'Custom metadata of the device, present when device_id is provided.',
19001
+ type: 'object',
19002
+ },
19003
+ device_id: {
19004
+ description:
19005
+ 'ID of the device associated with the affected access code.',
19006
+ format: 'uuid',
19007
+ type: 'string',
19008
+ },
19009
+ event_description: {
19010
+ description:
19011
+ '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.',
19012
+ type: 'string',
19013
+ },
19014
+ event_id: {
19015
+ description: 'ID of the event.',
19016
+ format: 'uuid',
19017
+ type: 'string',
19018
+ },
19019
+ event_type: {
19020
+ enum: ['access_code.removed_from_device'],
19021
+ type: 'string',
19022
+ },
19023
+ occurred_at: {
19024
+ description: 'Date and time at which the event occurred.',
19025
+ format: 'date-time',
19026
+ type: 'string',
19027
+ },
19028
+ workspace_id: {
19029
+ description: 'ID of the workspace associated with the event.',
19030
+ format: 'uuid',
19031
+ type: 'string',
19032
+ },
19033
+ },
19034
+ required: [
19035
+ 'event_id',
19036
+ 'workspace_id',
19037
+ 'created_at',
19038
+ 'occurred_at',
19039
+ 'access_code_id',
19040
+ 'device_id',
19041
+ 'connected_account_id',
19042
+ 'event_type',
19043
+ ],
19044
+ type: 'object',
19045
+ 'x-route-path': '/access_codes',
19046
+ },
19047
+ {
19048
+ description:
19049
+ 'There was an unusually long delay in setting an [access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes) on a device.',
19050
+ properties: {
19051
+ access_code_errors: {
19052
+ description: 'Errors associated with the access code.',
19053
+ items: {
19054
+ description:
19055
+ 'Error associated with the resource, including the error code, message, and creation timestamp.',
19056
+ properties: {
19057
+ created_at: {
19058
+ description:
19059
+ 'Date and time at which Seam created the error.',
19060
+ format: 'date-time',
19061
+ type: 'string',
19062
+ },
19063
+ error_code: {
19064
+ description:
19065
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
19066
+ type: 'string',
19067
+ },
19068
+ message: {
19069
+ description:
19070
+ 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
19071
+ type: 'string',
19072
+ },
19073
+ },
19074
+ required: ['created_at', 'message', 'error_code'],
19075
+ type: 'object',
19076
+ },
19077
+ type: 'array',
19078
+ },
19079
+ access_code_id: {
19080
+ description: 'ID of the affected access code.',
19081
+ format: 'uuid',
19082
+ type: 'string',
19083
+ },
19084
+ access_code_warnings: {
19085
+ description: 'Warnings associated with the access code.',
19086
+ items: {
19087
+ description:
19088
+ 'Warning associated with the resource, including the warning code, message, and creation timestamp.',
19089
+ properties: {
19090
+ created_at: {
19091
+ description:
19092
+ 'Date and time at which Seam created the warning.',
19093
+ format: 'date-time',
19094
+ type: 'string',
19095
+ },
19096
+ message: {
19097
+ description:
19098
+ 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
19099
+ type: 'string',
19100
+ },
19101
+ warning_code: {
19102
+ description:
19103
+ 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
19104
+ type: 'string',
19105
+ },
19106
+ },
19107
+ required: ['created_at', 'message', 'warning_code'],
19108
+ type: 'object',
19109
+ },
19110
+ type: 'array',
19111
+ },
19112
+ connected_account_custom_metadata: {
19113
+ additionalProperties: {
19114
+ oneOf: [{ type: 'string' }, { type: 'boolean' }],
19115
+ },
19116
+ description:
19117
+ 'Custom metadata of the connected account, present when connected_account_id is provided.',
19118
+ type: 'object',
19119
+ },
19120
+ connected_account_errors: {
19121
+ description: 'Errors associated with the connected account.',
19122
+ items: {
19123
+ description:
19124
+ 'Error associated with the resource, including the error code, message, and creation timestamp.',
19125
+ properties: {
19126
+ created_at: {
19127
+ description:
19128
+ 'Date and time at which Seam created the error.',
19129
+ format: 'date-time',
19130
+ type: 'string',
19131
+ },
19132
+ error_code: {
19133
+ description:
19134
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
19135
+ type: 'string',
19136
+ },
19137
+ message: {
19138
+ description:
19139
+ 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
19140
+ type: 'string',
19141
+ },
19142
+ },
19143
+ required: ['created_at', 'message', 'error_code'],
19144
+ type: 'object',
19145
+ },
19146
+ type: 'array',
19147
+ },
19148
+ connected_account_id: {
19149
+ description:
19150
+ 'ID of the connected account associated with the affected access code.',
19151
+ format: 'uuid',
19152
+ type: 'string',
19153
+ },
19154
+ connected_account_warnings: {
19155
+ description: 'Warnings associated with the connected account.',
19156
+ items: {
19157
+ description:
19158
+ 'Warning associated with the resource, including the warning code, message, and creation timestamp.',
19159
+ properties: {
19160
+ created_at: {
19161
+ description:
19162
+ 'Date and time at which Seam created the warning.',
19163
+ format: 'date-time',
19164
+ type: 'string',
19165
+ },
19166
+ message: {
19167
+ description:
19168
+ 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
19169
+ type: 'string',
19170
+ },
19171
+ warning_code: {
19172
+ description:
19173
+ 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
19174
+ type: 'string',
19175
+ },
19176
+ },
19177
+ required: ['created_at', 'message', 'warning_code'],
19178
+ type: 'object',
19179
+ },
19180
+ type: 'array',
19181
+ },
19182
+ created_at: {
19183
+ description: 'Date and time at which the event was created.',
19184
+ format: 'date-time',
19185
+ type: 'string',
19186
+ },
19187
+ device_custom_metadata: {
19188
+ additionalProperties: {
19189
+ oneOf: [{ type: 'string' }, { type: 'boolean' }],
19190
+ },
19191
+ description:
19192
+ 'Custom metadata of the device, present when device_id is provided.',
19193
+ type: 'object',
19194
+ },
19195
+ device_errors: {
19196
+ description: 'Errors associated with the device.',
19197
+ items: {
19198
+ description:
19199
+ 'Error associated with the resource, including the error code, message, and creation timestamp.',
19200
+ properties: {
19201
+ created_at: {
19202
+ description:
19203
+ 'Date and time at which Seam created the error.',
19204
+ format: 'date-time',
19205
+ type: 'string',
19206
+ },
19207
+ error_code: {
19208
+ description:
19209
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
19210
+ type: 'string',
19211
+ },
19212
+ message: {
19213
+ description:
19214
+ 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
19215
+ type: 'string',
19216
+ },
19217
+ },
19218
+ required: ['created_at', 'message', 'error_code'],
19219
+ type: 'object',
19220
+ },
19221
+ type: 'array',
19222
+ },
19223
+ device_id: {
19224
+ description:
19225
+ 'ID of the device associated with the affected access code.',
19226
+ format: 'uuid',
19227
+ type: 'string',
19228
+ },
19229
+ device_warnings: {
19230
+ description: 'Warnings associated with the device.',
19231
+ items: {
19232
+ description:
19233
+ 'Warning associated with the resource, including the warning code, message, and creation timestamp.',
19234
+ properties: {
19235
+ created_at: {
19236
+ description:
19237
+ 'Date and time at which Seam created the warning.',
19238
+ format: 'date-time',
19239
+ type: 'string',
19240
+ },
19241
+ message: {
19242
+ description:
19243
+ 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
19244
+ type: 'string',
19245
+ },
19246
+ warning_code: {
19247
+ description:
19248
+ 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
19249
+ type: 'string',
19250
+ },
19251
+ },
19252
+ required: ['created_at', 'message', 'warning_code'],
19253
+ type: 'object',
19254
+ },
19255
+ type: 'array',
19256
+ },
19257
+ event_description: {
19258
+ description:
19259
+ '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.',
19260
+ type: 'string',
19261
+ },
19262
+ event_id: {
19263
+ description: 'ID of the event.',
19264
+ format: 'uuid',
19265
+ type: 'string',
19266
+ },
19267
+ event_type: {
19268
+ enum: ['access_code.delay_in_setting_on_device'],
19269
+ type: 'string',
19270
+ },
19271
+ occurred_at: {
19272
+ description: 'Date and time at which the event occurred.',
19273
+ format: 'date-time',
19274
+ type: 'string',
19275
+ },
19276
+ workspace_id: {
19277
+ description: 'ID of the workspace associated with the event.',
19278
+ format: 'uuid',
19279
+ type: 'string',
19280
+ },
19281
+ },
19282
+ required: [
19283
+ 'event_id',
19284
+ 'workspace_id',
19285
+ 'created_at',
19286
+ 'occurred_at',
19287
+ 'access_code_id',
19288
+ 'device_id',
19289
+ 'connected_account_id',
19290
+ 'event_type',
19291
+ 'connected_account_errors',
19292
+ 'connected_account_warnings',
19293
+ 'device_errors',
19294
+ 'device_warnings',
19295
+ 'access_code_errors',
19296
+ 'access_code_warnings',
19297
+ ],
19298
+ type: 'object',
19299
+ 'x-route-path': '/access_codes',
19300
+ },
19301
+ {
19302
+ description:
19303
+ 'An [access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes) failed to be set on a device.',
19304
+ properties: {
19305
+ access_code_errors: {
19306
+ description: 'Errors associated with the access code.',
19307
+ items: {
19308
+ description:
19309
+ 'Error associated with the resource, including the error code, message, and creation timestamp.',
19310
+ properties: {
19311
+ created_at: {
19312
+ description:
19313
+ 'Date and time at which Seam created the error.',
19314
+ format: 'date-time',
19315
+ type: 'string',
19316
+ },
19317
+ error_code: {
19318
+ description:
19319
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
19320
+ type: 'string',
19321
+ },
19322
+ message: {
19323
+ description:
19324
+ 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
19325
+ type: 'string',
19326
+ },
19327
+ },
19328
+ required: ['created_at', 'message', 'error_code'],
19329
+ type: 'object',
19330
+ },
19331
+ type: 'array',
19332
+ },
19333
+ access_code_id: {
19334
+ description: 'ID of the affected access code.',
19335
+ format: 'uuid',
19336
+ type: 'string',
19337
+ },
19338
+ access_code_warnings: {
19339
+ description: 'Warnings associated with the access code.',
19340
+ items: {
19341
+ description:
19342
+ 'Warning associated with the resource, including the warning code, message, and creation timestamp.',
19343
+ properties: {
19344
+ created_at: {
19345
+ description:
19346
+ 'Date and time at which Seam created the warning.',
19347
+ format: 'date-time',
19348
+ type: 'string',
19349
+ },
19350
+ message: {
19351
+ description:
19352
+ 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
19353
+ type: 'string',
19354
+ },
19355
+ warning_code: {
19356
+ description:
19357
+ 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
19358
+ type: 'string',
19359
+ },
19360
+ },
19361
+ required: ['created_at', 'message', 'warning_code'],
19362
+ type: 'object',
19363
+ },
19364
+ type: 'array',
19365
+ },
19366
+ connected_account_custom_metadata: {
19367
+ additionalProperties: {
19368
+ oneOf: [{ type: 'string' }, { type: 'boolean' }],
19369
+ },
19370
+ description:
19371
+ 'Custom metadata of the connected account, present when connected_account_id is provided.',
19372
+ type: 'object',
19373
+ },
19374
+ connected_account_errors: {
19375
+ description: 'Errors associated with the connected account.',
19376
+ items: {
19377
+ description:
19378
+ 'Error associated with the resource, including the error code, message, and creation timestamp.',
19379
+ properties: {
19380
+ created_at: {
19381
+ description:
19382
+ 'Date and time at which Seam created the error.',
19383
+ format: 'date-time',
19384
+ type: 'string',
19385
+ },
19386
+ error_code: {
19387
+ description:
19388
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
19389
+ type: 'string',
19390
+ },
19391
+ message: {
19392
+ description:
19393
+ 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
19394
+ type: 'string',
19395
+ },
19396
+ },
19397
+ required: ['created_at', 'message', 'error_code'],
19398
+ type: 'object',
19399
+ },
19400
+ type: 'array',
19401
+ },
19402
+ connected_account_id: {
19403
+ description:
19404
+ 'ID of the connected account associated with the affected access code.',
19405
+ format: 'uuid',
19406
+ type: 'string',
19407
+ },
19408
+ connected_account_warnings: {
19409
+ description: 'Warnings associated with the connected account.',
19410
+ items: {
19411
+ description:
19412
+ 'Warning associated with the resource, including the warning code, message, and creation timestamp.',
19413
+ properties: {
19414
+ created_at: {
19415
+ description:
19416
+ 'Date and time at which Seam created the warning.',
19417
+ format: 'date-time',
19418
+ type: 'string',
19419
+ },
19420
+ message: {
19421
+ description:
19422
+ 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
19423
+ type: 'string',
19424
+ },
19425
+ warning_code: {
19426
+ description:
19427
+ 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
19428
+ type: 'string',
19429
+ },
19430
+ },
19431
+ required: ['created_at', 'message', 'warning_code'],
19432
+ type: 'object',
19433
+ },
19434
+ type: 'array',
19435
+ },
19436
+ created_at: {
19437
+ description: 'Date and time at which the event was created.',
19438
+ format: 'date-time',
19439
+ type: 'string',
19440
+ },
19441
+ device_custom_metadata: {
19442
+ additionalProperties: {
19443
+ oneOf: [{ type: 'string' }, { type: 'boolean' }],
19444
+ },
19445
+ description:
19446
+ 'Custom metadata of the device, present when device_id is provided.',
19447
+ type: 'object',
19448
+ },
19449
+ device_errors: {
19450
+ description: 'Errors associated with the device.',
19451
+ items: {
19452
+ description:
19453
+ 'Error associated with the resource, including the error code, message, and creation timestamp.',
19454
+ properties: {
19455
+ created_at: {
19456
+ description:
19457
+ 'Date and time at which Seam created the error.',
19458
+ format: 'date-time',
19459
+ type: 'string',
19460
+ },
19461
+ error_code: {
19462
+ description:
19463
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
19464
+ type: 'string',
19465
+ },
19466
+ message: {
19467
+ description:
19468
+ 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
19469
+ type: 'string',
19470
+ },
19471
+ },
19472
+ required: ['created_at', 'message', 'error_code'],
19473
+ type: 'object',
19474
+ },
19475
+ type: 'array',
19476
+ },
19477
+ device_id: {
19478
+ description:
19479
+ 'ID of the device associated with the affected access code.',
19480
+ format: 'uuid',
19481
+ type: 'string',
19482
+ },
19483
+ device_warnings: {
19484
+ description: 'Warnings associated with the device.',
19485
+ items: {
19486
+ description:
19487
+ 'Warning associated with the resource, including the warning code, message, and creation timestamp.',
19488
+ properties: {
19489
+ created_at: {
19490
+ description:
19491
+ 'Date and time at which Seam created the warning.',
19492
+ format: 'date-time',
19493
+ type: 'string',
19494
+ },
19495
+ message: {
19496
+ description:
19497
+ 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
19498
+ type: 'string',
19499
+ },
19500
+ warning_code: {
19501
+ description:
19502
+ 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
19503
+ type: 'string',
19504
+ },
19505
+ },
19506
+ required: ['created_at', 'message', 'warning_code'],
19507
+ type: 'object',
19508
+ },
19509
+ type: 'array',
19510
+ },
19511
+ event_description: {
19512
+ description:
19513
+ '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.',
19514
+ type: 'string',
19515
+ },
19516
+ event_id: {
19517
+ description: 'ID of the event.',
19518
+ format: 'uuid',
19519
+ type: 'string',
19520
+ },
19521
+ event_type: {
19522
+ enum: ['access_code.failed_to_set_on_device'],
19523
+ type: 'string',
19524
+ },
19525
+ occurred_at: {
19526
+ description: 'Date and time at which the event occurred.',
19527
+ format: 'date-time',
19528
+ type: 'string',
19529
+ },
19530
+ workspace_id: {
19531
+ description: 'ID of the workspace associated with the event.',
19532
+ format: 'uuid',
19533
+ type: 'string',
19534
+ },
19535
+ },
19536
+ required: [
19537
+ 'event_id',
19538
+ 'workspace_id',
19539
+ 'created_at',
19540
+ 'occurred_at',
19541
+ 'access_code_id',
19542
+ 'device_id',
19543
+ 'connected_account_id',
19544
+ 'event_type',
19545
+ 'connected_account_errors',
19546
+ 'connected_account_warnings',
19547
+ 'device_errors',
19548
+ 'device_warnings',
19549
+ 'access_code_errors',
19550
+ 'access_code_warnings',
19551
+ ],
19552
+ type: 'object',
19553
+ 'x-route-path': '/access_codes',
19554
+ },
19555
+ {
19556
+ description:
19557
+ 'An [access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes) was issued.',
19558
+ properties: {
19559
+ access_code_id: {
19560
+ description: 'ID of the affected access code.',
19561
+ format: 'uuid',
19562
+ type: 'string',
19563
+ },
19564
+ code: {
19565
+ description: 'Code for the affected access code.',
19566
+ type: 'string',
19567
+ },
19568
+ connected_account_custom_metadata: {
19569
+ additionalProperties: {
19570
+ oneOf: [{ type: 'string' }, { type: 'boolean' }],
19571
+ },
19572
+ description:
19573
+ 'Custom metadata of the connected account, present when connected_account_id is provided.',
19574
+ type: 'object',
19575
+ },
19576
+ connected_account_id: {
19577
+ description:
19578
+ 'ID of the connected account associated with the affected access code.',
19579
+ format: 'uuid',
19580
+ type: 'string',
19581
+ },
19582
+ created_at: {
19583
+ description: 'Date and time at which the event was created.',
19584
+ format: 'date-time',
19585
+ type: 'string',
19586
+ },
19587
+ device_custom_metadata: {
19588
+ additionalProperties: {
19589
+ oneOf: [{ type: 'string' }, { type: 'boolean' }],
19590
+ },
19591
+ description:
19592
+ 'Custom metadata of the device, present when device_id is provided.',
19593
+ type: 'object',
19594
+ },
19595
+ device_id: {
19596
+ description:
19597
+ 'ID of the device associated with the affected access code.',
19598
+ format: 'uuid',
19599
+ type: 'string',
19600
+ },
19601
+ event_description: {
19602
+ description:
19603
+ '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.',
19604
+ type: 'string',
19605
+ },
19606
+ event_id: {
19607
+ description: 'ID of the event.',
19608
+ format: 'uuid',
19609
+ type: 'string',
19610
+ },
19611
+ event_type: { enum: ['access_code.issued'], type: 'string' },
19612
+ occurred_at: {
19613
+ description: 'Date and time at which the event occurred.',
19614
+ format: 'date-time',
19615
+ type: 'string',
19616
+ },
19617
+ workspace_id: {
19618
+ description: 'ID of the workspace associated with the event.',
19619
+ format: 'uuid',
19620
+ type: 'string',
19621
+ },
19622
+ },
19623
+ required: [
19624
+ 'event_id',
19625
+ 'workspace_id',
19626
+ 'created_at',
19627
+ 'occurred_at',
19628
+ 'access_code_id',
19629
+ 'device_id',
19630
+ 'connected_account_id',
19631
+ 'event_type',
19632
+ 'code',
19633
+ ],
19634
+ type: 'object',
19635
+ 'x-route-path': '/access_codes',
19636
+ 'x-undocumented': 'Unreleased.',
19637
+ },
19638
+ {
19639
+ description:
19640
+ '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.',
19641
+ properties: {
19642
+ access_code_errors: {
19643
+ description: 'Errors associated with the access code.',
19644
+ items: {
19645
+ description:
19646
+ 'Error associated with the resource, including the error code, message, and creation timestamp.',
19647
+ properties: {
19648
+ created_at: {
19649
+ description:
19650
+ 'Date and time at which Seam created the error.',
19651
+ format: 'date-time',
19652
+ type: 'string',
19653
+ },
19654
+ error_code: {
19655
+ description:
19656
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
19657
+ type: 'string',
19658
+ },
19659
+ message: {
19660
+ description:
19661
+ 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
19662
+ type: 'string',
19663
+ },
19664
+ },
19665
+ required: ['created_at', 'message', 'error_code'],
19666
+ type: 'object',
19667
+ },
19668
+ type: 'array',
19669
+ },
19670
+ access_code_id: {
19671
+ description: 'ID of the affected access code.',
19672
+ format: 'uuid',
19673
+ type: 'string',
19674
+ },
19675
+ access_code_warnings: {
19676
+ description: 'Warnings associated with the access code.',
19677
+ items: {
19678
+ description:
19679
+ 'Warning associated with the resource, including the warning code, message, and creation timestamp.',
19680
+ properties: {
19681
+ created_at: {
19682
+ description:
19683
+ 'Date and time at which Seam created the warning.',
19684
+ format: 'date-time',
19685
+ type: 'string',
19686
+ },
19687
+ message: {
19688
+ description:
19689
+ 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
19690
+ type: 'string',
19691
+ },
19692
+ warning_code: {
19693
+ description:
19694
+ 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
19695
+ type: 'string',
19696
+ },
19697
+ },
19698
+ required: ['created_at', 'message', 'warning_code'],
19699
+ type: 'object',
19700
+ },
19701
+ type: 'array',
19702
+ },
19703
+ connected_account_custom_metadata: {
19704
+ additionalProperties: {
19705
+ oneOf: [{ type: 'string' }, { type: 'boolean' }],
19706
+ },
19707
+ description:
19708
+ 'Custom metadata of the connected account, present when connected_account_id is provided.',
19709
+ type: 'object',
19710
+ },
19711
+ connected_account_errors: {
19712
+ description: 'Errors associated with the connected account.',
19713
+ items: {
19714
+ description:
19715
+ 'Error associated with the resource, including the error code, message, and creation timestamp.',
19716
+ properties: {
19717
+ created_at: {
19718
+ description:
19719
+ 'Date and time at which Seam created the error.',
19720
+ format: 'date-time',
19721
+ type: 'string',
19722
+ },
19723
+ error_code: {
19724
+ description:
19725
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
19726
+ type: 'string',
19727
+ },
19728
+ message: {
19729
+ description:
19730
+ 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
19731
+ type: 'string',
19732
+ },
19733
+ },
19734
+ required: ['created_at', 'message', 'error_code'],
19735
+ type: 'object',
19736
+ },
19737
+ type: 'array',
19738
+ },
19739
+ connected_account_id: {
19740
+ description:
19741
+ 'ID of the connected account associated with the affected access code.',
19742
+ format: 'uuid',
19743
+ type: 'string',
19744
+ },
19745
+ connected_account_warnings: {
19746
+ description: 'Warnings associated with the connected account.',
19747
+ items: {
19748
+ description:
19749
+ 'Warning associated with the resource, including the warning code, message, and creation timestamp.',
19750
+ properties: {
19751
+ created_at: {
19752
+ description:
19753
+ 'Date and time at which Seam created the warning.',
19754
+ format: 'date-time',
19755
+ type: 'string',
19756
+ },
19757
+ message: {
19758
+ description:
19759
+ 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
19760
+ type: 'string',
19761
+ },
19762
+ warning_code: {
19763
+ description:
19764
+ 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
19765
+ type: 'string',
19766
+ },
19767
+ },
19768
+ required: ['created_at', 'message', 'warning_code'],
19769
+ type: 'object',
19770
+ },
19771
+ type: 'array',
19772
+ },
19773
+ created_at: {
19774
+ description: 'Date and time at which the event was created.',
19775
+ format: 'date-time',
19776
+ type: 'string',
19777
+ },
19778
+ device_custom_metadata: {
19779
+ additionalProperties: {
19780
+ oneOf: [{ type: 'string' }, { type: 'boolean' }],
19781
+ },
19782
+ description:
19783
+ 'Custom metadata of the device, present when device_id is provided.',
19784
+ type: 'object',
19785
+ },
19786
+ device_errors: {
19787
+ description: 'Errors associated with the device.',
19788
+ items: {
19789
+ description:
19790
+ 'Error associated with the resource, including the error code, message, and creation timestamp.',
19791
+ properties: {
19792
+ created_at: {
19793
+ description:
19794
+ 'Date and time at which Seam created the error.',
19795
+ format: 'date-time',
19796
+ type: 'string',
19797
+ },
19798
+ error_code: {
19799
+ description:
19800
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
19801
+ type: 'string',
19802
+ },
19803
+ message: {
19804
+ description:
19805
+ 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
19806
+ type: 'string',
19807
+ },
19808
+ },
19809
+ required: ['created_at', 'message', 'error_code'],
19810
+ type: 'object',
19811
+ },
19812
+ type: 'array',
19813
+ },
19814
+ device_id: {
19815
+ description:
19816
+ 'ID of the device associated with the affected access code.',
19817
+ format: 'uuid',
19818
+ type: 'string',
19819
+ },
19820
+ device_warnings: {
19821
+ description: 'Warnings associated with the device.',
19822
+ items: {
19823
+ description:
19824
+ 'Warning associated with the resource, including the warning code, message, and creation timestamp.',
19825
+ properties: {
19826
+ created_at: {
19827
+ description:
19828
+ 'Date and time at which Seam created the warning.',
19829
+ format: 'date-time',
19830
+ type: 'string',
19831
+ },
19832
+ message: {
19833
+ description:
19834
+ 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
19835
+ type: 'string',
19836
+ },
19837
+ warning_code: {
19838
+ description:
19839
+ 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
19840
+ type: 'string',
19841
+ },
19842
+ },
19843
+ required: ['created_at', 'message', 'warning_code'],
19844
+ type: 'object',
19845
+ },
19846
+ type: 'array',
19847
+ },
19848
+ event_description: {
19849
+ description:
19850
+ '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.',
19851
+ type: 'string',
19852
+ },
19853
+ event_id: {
19854
+ description: 'ID of the event.',
19855
+ format: 'uuid',
19856
+ type: 'string',
19857
+ },
19858
+ event_type: {
19859
+ enum: ['access_code.delay_in_issuing'],
19860
+ type: 'string',
19861
+ },
19862
+ occurred_at: {
19863
+ description: 'Date and time at which the event occurred.',
19864
+ format: 'date-time',
19865
+ type: 'string',
19866
+ },
19867
+ workspace_id: {
19868
+ description: 'ID of the workspace associated with the event.',
19869
+ format: 'uuid',
19870
+ type: 'string',
19871
+ },
19872
+ },
19873
+ required: [
19874
+ 'event_id',
19875
+ 'workspace_id',
19876
+ 'created_at',
19877
+ 'occurred_at',
19878
+ 'access_code_id',
19879
+ 'device_id',
19880
+ 'connected_account_id',
19881
+ 'event_type',
19882
+ 'connected_account_errors',
19883
+ 'connected_account_warnings',
19884
+ 'device_errors',
19885
+ 'device_warnings',
19886
+ 'access_code_errors',
19887
+ 'access_code_warnings',
19888
+ ],
19889
+ type: 'object',
19890
+ 'x-route-path': '/access_codes',
19891
+ 'x-undocumented': 'Unreleased.',
19892
+ },
19893
+ {
19894
+ description:
19895
+ '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.',
19896
+ properties: {
19897
+ access_code_errors: {
19898
+ description: 'Errors associated with the access code.',
19899
+ items: {
19900
+ description:
19901
+ 'Error associated with the resource, including the error code, message, and creation timestamp.',
19902
+ properties: {
19903
+ created_at: {
19904
+ description:
19905
+ 'Date and time at which Seam created the error.',
19906
+ format: 'date-time',
19907
+ type: 'string',
19908
+ },
19909
+ error_code: {
19910
+ description:
19911
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
19912
+ type: 'string',
19913
+ },
19914
+ message: {
19915
+ description:
19916
+ 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
19917
+ type: 'string',
19918
+ },
19919
+ },
19920
+ required: ['created_at', 'message', 'error_code'],
19921
+ type: 'object',
19922
+ },
19923
+ type: 'array',
19924
+ },
19925
+ access_code_id: {
19926
+ description: 'ID of the affected access code.',
19927
+ format: 'uuid',
19928
+ type: 'string',
19929
+ },
19930
+ access_code_warnings: {
19931
+ description: 'Warnings associated with the access code.',
19932
+ items: {
19933
+ description:
19934
+ 'Warning associated with the resource, including the warning code, message, and creation timestamp.',
19935
+ properties: {
19936
+ created_at: {
19937
+ description:
19938
+ 'Date and time at which Seam created the warning.',
19939
+ format: 'date-time',
19940
+ type: 'string',
19941
+ },
19942
+ message: {
19943
+ description:
19944
+ 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
19945
+ type: 'string',
19946
+ },
19947
+ warning_code: {
19948
+ description:
19949
+ 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
19950
+ type: 'string',
19951
+ },
19952
+ },
19953
+ required: ['created_at', 'message', 'warning_code'],
19954
+ type: 'object',
19955
+ },
19956
+ type: 'array',
19957
+ },
19958
+ connected_account_custom_metadata: {
19959
+ additionalProperties: {
19960
+ oneOf: [{ type: 'string' }, { type: 'boolean' }],
19961
+ },
19962
+ description:
19963
+ 'Custom metadata of the connected account, present when connected_account_id is provided.',
19964
+ type: 'object',
19965
+ },
19966
+ connected_account_errors: {
19967
+ description: 'Errors associated with the connected account.',
19968
+ items: {
19969
+ description:
19970
+ 'Error associated with the resource, including the error code, message, and creation timestamp.',
19971
+ properties: {
19972
+ created_at: {
19973
+ description:
19974
+ 'Date and time at which Seam created the error.',
19975
+ format: 'date-time',
19976
+ type: 'string',
19977
+ },
19978
+ error_code: {
19979
+ description:
19980
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
19981
+ type: 'string',
19982
+ },
19983
+ message: {
19984
+ description:
19985
+ 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
19986
+ type: 'string',
19987
+ },
19988
+ },
19989
+ required: ['created_at', 'message', 'error_code'],
19990
+ type: 'object',
19991
+ },
19992
+ type: 'array',
19993
+ },
19994
+ connected_account_id: {
19995
+ description:
19996
+ 'ID of the connected account associated with the affected access code.',
19997
+ format: 'uuid',
19998
+ type: 'string',
19999
+ },
20000
+ connected_account_warnings: {
20001
+ description: 'Warnings associated with the connected account.',
20002
+ items: {
20003
+ description:
20004
+ 'Warning associated with the resource, including the warning code, message, and creation timestamp.',
20005
+ properties: {
20006
+ created_at: {
20007
+ description:
20008
+ 'Date and time at which Seam created the warning.',
20009
+ format: 'date-time',
20010
+ type: 'string',
20011
+ },
20012
+ message: {
20013
+ description:
20014
+ 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
20015
+ type: 'string',
20016
+ },
20017
+ warning_code: {
20018
+ description:
20019
+ 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
20020
+ type: 'string',
20021
+ },
20022
+ },
20023
+ required: ['created_at', 'message', 'warning_code'],
20024
+ type: 'object',
20025
+ },
20026
+ type: 'array',
20027
+ },
20028
+ created_at: {
20029
+ description: 'Date and time at which the event was created.',
20030
+ format: 'date-time',
20031
+ type: 'string',
20032
+ },
20033
+ device_custom_metadata: {
20034
+ additionalProperties: {
20035
+ oneOf: [{ type: 'string' }, { type: 'boolean' }],
20036
+ },
20037
+ description:
20038
+ 'Custom metadata of the device, present when device_id is provided.',
20039
+ type: 'object',
20040
+ },
20041
+ device_errors: {
20042
+ description: 'Errors associated with the device.',
20043
+ items: {
20044
+ description:
20045
+ 'Error associated with the resource, including the error code, message, and creation timestamp.',
20046
+ properties: {
20047
+ created_at: {
20048
+ description:
20049
+ 'Date and time at which Seam created the error.',
20050
+ format: 'date-time',
20051
+ type: 'string',
20052
+ },
20053
+ error_code: {
20054
+ description:
20055
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
20056
+ type: 'string',
20057
+ },
20058
+ message: {
20059
+ description:
20060
+ 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
20061
+ type: 'string',
20062
+ },
20063
+ },
20064
+ required: ['created_at', 'message', 'error_code'],
20065
+ type: 'object',
20066
+ },
20067
+ type: 'array',
20068
+ },
20069
+ device_id: {
20070
+ description:
20071
+ 'ID of the device associated with the affected access code.',
20072
+ format: 'uuid',
20073
+ type: 'string',
20074
+ },
20075
+ device_warnings: {
20076
+ description: 'Warnings associated with the device.',
20077
+ items: {
20078
+ description:
20079
+ 'Warning associated with the resource, including the warning code, message, and creation timestamp.',
20080
+ properties: {
20081
+ created_at: {
20082
+ description:
20083
+ 'Date and time at which Seam created the warning.',
20084
+ format: 'date-time',
20085
+ type: 'string',
20086
+ },
20087
+ message: {
20088
+ description:
20089
+ 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
20090
+ type: 'string',
20091
+ },
20092
+ warning_code: {
20093
+ description:
20094
+ 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
20095
+ type: 'string',
20096
+ },
20097
+ },
20098
+ required: ['created_at', 'message', 'warning_code'],
20099
+ type: 'object',
20100
+ },
20101
+ type: 'array',
20102
+ },
20103
+ event_description: {
20104
+ description:
20105
+ '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.',
20106
+ type: 'string',
20107
+ },
20108
+ event_id: {
20109
+ description: 'ID of the event.',
20110
+ format: 'uuid',
20111
+ type: 'string',
20112
+ },
20113
+ event_type: {
20114
+ enum: ['access_code.failed_to_issue'],
20115
+ type: 'string',
20116
+ },
20117
+ occurred_at: {
20118
+ description: 'Date and time at which the event occurred.',
20119
+ format: 'date-time',
20120
+ type: 'string',
20121
+ },
20122
+ workspace_id: {
20123
+ description: 'ID of the workspace associated with the event.',
20124
+ format: 'uuid',
20125
+ type: 'string',
20126
+ },
20127
+ },
20128
+ required: [
20129
+ 'event_id',
20130
+ 'workspace_id',
20131
+ 'created_at',
20132
+ 'occurred_at',
20133
+ 'access_code_id',
20134
+ 'device_id',
20135
+ 'connected_account_id',
20136
+ 'event_type',
20137
+ 'connected_account_errors',
20138
+ 'connected_account_warnings',
20139
+ 'device_errors',
20140
+ 'device_warnings',
20141
+ 'access_code_errors',
20142
+ 'access_code_warnings',
18836
20143
  ],
18837
20144
  type: 'object',
18838
20145
  'x-route-path': '/access_codes',
20146
+ 'x-undocumented': 'Unreleased.',
18839
20147
  },
18840
20148
  {
18841
20149
  description:
18842
- 'An [access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes) was removed from a device.',
20150
+ "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.",
18843
20151
  properties: {
20152
+ access_code_errors: {
20153
+ description: 'Errors associated with the access code.',
20154
+ items: {
20155
+ description:
20156
+ 'Error associated with the resource, including the error code, message, and creation timestamp.',
20157
+ properties: {
20158
+ created_at: {
20159
+ description:
20160
+ 'Date and time at which Seam created the error.',
20161
+ format: 'date-time',
20162
+ type: 'string',
20163
+ },
20164
+ error_code: {
20165
+ description:
20166
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
20167
+ type: 'string',
20168
+ },
20169
+ message: {
20170
+ description:
20171
+ 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
20172
+ type: 'string',
20173
+ },
20174
+ },
20175
+ required: ['created_at', 'message', 'error_code'],
20176
+ type: 'object',
20177
+ },
20178
+ type: 'array',
20179
+ },
18844
20180
  access_code_id: {
18845
20181
  description: 'ID of the affected access code.',
18846
20182
  format: 'uuid',
18847
20183
  type: 'string',
18848
20184
  },
20185
+ access_code_warnings: {
20186
+ description: 'Warnings associated with the access code.',
20187
+ items: {
20188
+ description:
20189
+ 'Warning associated with the resource, including the warning code, message, and creation timestamp.',
20190
+ properties: {
20191
+ created_at: {
20192
+ description:
20193
+ 'Date and time at which Seam created the warning.',
20194
+ format: 'date-time',
20195
+ type: 'string',
20196
+ },
20197
+ message: {
20198
+ description:
20199
+ 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
20200
+ type: 'string',
20201
+ },
20202
+ warning_code: {
20203
+ description:
20204
+ 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
20205
+ type: 'string',
20206
+ },
20207
+ },
20208
+ required: ['created_at', 'message', 'warning_code'],
20209
+ type: 'object',
20210
+ },
20211
+ type: 'array',
20212
+ },
18849
20213
  connected_account_custom_metadata: {
18850
20214
  additionalProperties: {
18851
20215
  oneOf: [{ type: 'string' }, { type: 'boolean' }],
@@ -18854,12 +20218,68 @@ const openapi: OpenAPISpec = {
18854
20218
  'Custom metadata of the connected account, present when connected_account_id is provided.',
18855
20219
  type: 'object',
18856
20220
  },
20221
+ connected_account_errors: {
20222
+ description: 'Errors associated with the connected account.',
20223
+ items: {
20224
+ description:
20225
+ 'Error associated with the resource, including the error code, message, and creation timestamp.',
20226
+ properties: {
20227
+ created_at: {
20228
+ description:
20229
+ 'Date and time at which Seam created the error.',
20230
+ format: 'date-time',
20231
+ type: 'string',
20232
+ },
20233
+ error_code: {
20234
+ description:
20235
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
20236
+ type: 'string',
20237
+ },
20238
+ message: {
20239
+ description:
20240
+ 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
20241
+ type: 'string',
20242
+ },
20243
+ },
20244
+ required: ['created_at', 'message', 'error_code'],
20245
+ type: 'object',
20246
+ },
20247
+ type: 'array',
20248
+ },
18857
20249
  connected_account_id: {
18858
20250
  description:
18859
20251
  'ID of the connected account associated with the affected access code.',
18860
20252
  format: 'uuid',
18861
20253
  type: 'string',
18862
20254
  },
20255
+ connected_account_warnings: {
20256
+ description: 'Warnings associated with the connected account.',
20257
+ items: {
20258
+ description:
20259
+ 'Warning associated with the resource, including the warning code, message, and creation timestamp.',
20260
+ properties: {
20261
+ created_at: {
20262
+ description:
20263
+ 'Date and time at which Seam created the warning.',
20264
+ format: 'date-time',
20265
+ type: 'string',
20266
+ },
20267
+ message: {
20268
+ description:
20269
+ 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
20270
+ type: 'string',
20271
+ },
20272
+ warning_code: {
20273
+ description:
20274
+ 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
20275
+ type: 'string',
20276
+ },
20277
+ },
20278
+ required: ['created_at', 'message', 'warning_code'],
20279
+ type: 'object',
20280
+ },
20281
+ type: 'array',
20282
+ },
18863
20283
  created_at: {
18864
20284
  description: 'Date and time at which the event was created.',
18865
20285
  format: 'date-time',
@@ -18873,12 +20293,68 @@ const openapi: OpenAPISpec = {
18873
20293
  'Custom metadata of the device, present when device_id is provided.',
18874
20294
  type: 'object',
18875
20295
  },
20296
+ device_errors: {
20297
+ description: 'Errors associated with the device.',
20298
+ items: {
20299
+ description:
20300
+ 'Error associated with the resource, including the error code, message, and creation timestamp.',
20301
+ properties: {
20302
+ created_at: {
20303
+ description:
20304
+ 'Date and time at which Seam created the error.',
20305
+ format: 'date-time',
20306
+ type: 'string',
20307
+ },
20308
+ error_code: {
20309
+ description:
20310
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
20311
+ type: 'string',
20312
+ },
20313
+ message: {
20314
+ description:
20315
+ 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
20316
+ type: 'string',
20317
+ },
20318
+ },
20319
+ required: ['created_at', 'message', 'error_code'],
20320
+ type: 'object',
20321
+ },
20322
+ type: 'array',
20323
+ },
18876
20324
  device_id: {
18877
20325
  description:
18878
20326
  'ID of the device associated with the affected access code.',
18879
20327
  format: 'uuid',
18880
20328
  type: 'string',
18881
20329
  },
20330
+ device_warnings: {
20331
+ description: 'Warnings associated with the device.',
20332
+ items: {
20333
+ description:
20334
+ 'Warning associated with the resource, including the warning code, message, and creation timestamp.',
20335
+ properties: {
20336
+ created_at: {
20337
+ description:
20338
+ 'Date and time at which Seam created the warning.',
20339
+ format: 'date-time',
20340
+ type: 'string',
20341
+ },
20342
+ message: {
20343
+ description:
20344
+ 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
20345
+ type: 'string',
20346
+ },
20347
+ warning_code: {
20348
+ description:
20349
+ 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
20350
+ type: 'string',
20351
+ },
20352
+ },
20353
+ required: ['created_at', 'message', 'warning_code'],
20354
+ type: 'object',
20355
+ },
20356
+ type: 'array',
20357
+ },
18882
20358
  event_description: {
18883
20359
  description:
18884
20360
  '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.',
@@ -18890,7 +20366,7 @@ const openapi: OpenAPISpec = {
18890
20366
  type: 'string',
18891
20367
  },
18892
20368
  event_type: {
18893
- enum: ['access_code.removed_from_device'],
20369
+ enum: ['access_code.delay_in_applying_mutations'],
18894
20370
  type: 'string',
18895
20371
  },
18896
20372
  occurred_at: {
@@ -18913,13 +20389,20 @@ const openapi: OpenAPISpec = {
18913
20389
  'device_id',
18914
20390
  'connected_account_id',
18915
20391
  'event_type',
20392
+ 'connected_account_errors',
20393
+ 'connected_account_warnings',
20394
+ 'device_errors',
20395
+ 'device_warnings',
20396
+ 'access_code_errors',
20397
+ 'access_code_warnings',
18916
20398
  ],
18917
20399
  type: 'object',
18918
20400
  'x-route-path': '/access_codes',
20401
+ 'x-undocumented': 'Unreleased.',
18919
20402
  },
18920
20403
  {
18921
20404
  description:
18922
- 'There was an unusually long delay in setting an [access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes) on a device.',
20405
+ "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.",
18923
20406
  properties: {
18924
20407
  access_code_errors: {
18925
20408
  description: 'Errors associated with the access code.',
@@ -19138,7 +20621,7 @@ const openapi: OpenAPISpec = {
19138
20621
  type: 'string',
19139
20622
  },
19140
20623
  event_type: {
19141
- enum: ['access_code.delay_in_setting_on_device'],
20624
+ enum: ['access_code.failed_to_apply_mutations'],
19142
20625
  type: 'string',
19143
20626
  },
19144
20627
  occurred_at: {
@@ -19170,10 +20653,11 @@ const openapi: OpenAPISpec = {
19170
20653
  ],
19171
20654
  type: 'object',
19172
20655
  'x-route-path': '/access_codes',
20656
+ 'x-undocumented': 'Unreleased.',
19173
20657
  },
19174
20658
  {
19175
20659
  description:
19176
- 'An [access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes) failed to be set on a device.',
20660
+ '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.',
19177
20661
  properties: {
19178
20662
  access_code_errors: {
19179
20663
  description: 'Errors associated with the access code.',
@@ -19392,7 +20876,7 @@ const openapi: OpenAPISpec = {
19392
20876
  type: 'string',
19393
20877
  },
19394
20878
  event_type: {
19395
- enum: ['access_code.failed_to_set_on_device'],
20879
+ enum: ['access_code.failed_to_expire'],
19396
20880
  type: 'string',
19397
20881
  },
19398
20882
  occurred_at: {
@@ -19424,6 +20908,7 @@ const openapi: OpenAPISpec = {
19424
20908
  ],
19425
20909
  type: 'object',
19426
20910
  'x-route-path': '/access_codes',
20911
+ 'x-undocumented': 'Unreleased.',
19427
20912
  },
19428
20913
  {
19429
20914
  description:
@@ -30556,6 +32041,105 @@ const openapi: OpenAPISpec = {
30556
32041
  type: 'object',
30557
32042
  'x-resource-type': 'access_code',
30558
32043
  },
32044
+ {
32045
+ description:
32046
+ '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.',
32047
+ properties: {
32048
+ created_at: {
32049
+ description:
32050
+ 'Date and time at which Seam created the error.',
32051
+ format: 'date-time',
32052
+ type: 'string',
32053
+ },
32054
+ error_code: {
32055
+ description:
32056
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
32057
+ enum: ['failed_to_issue'],
32058
+ type: 'string',
32059
+ },
32060
+ is_access_code_error: {
32061
+ description:
32062
+ 'Indicates that this is an access code error.',
32063
+ enum: [true],
32064
+ type: 'boolean',
32065
+ },
32066
+ message: {
32067
+ description:
32068
+ 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
32069
+ type: 'string',
32070
+ },
32071
+ },
32072
+ required: ['message', 'is_access_code_error', 'error_code'],
32073
+ type: 'object',
32074
+ 'x-resource-type': 'access_code',
32075
+ 'x-undocumented': 'Unreleased.',
32076
+ },
32077
+ {
32078
+ description:
32079
+ "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.",
32080
+ properties: {
32081
+ created_at: {
32082
+ description:
32083
+ 'Date and time at which Seam created the error.',
32084
+ format: 'date-time',
32085
+ type: 'string',
32086
+ },
32087
+ error_code: {
32088
+ description:
32089
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
32090
+ enum: ['failed_to_apply_mutations'],
32091
+ type: 'string',
32092
+ },
32093
+ is_access_code_error: {
32094
+ description:
32095
+ 'Indicates that this is an access code error.',
32096
+ enum: [true],
32097
+ type: 'boolean',
32098
+ },
32099
+ message: {
32100
+ description:
32101
+ 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
32102
+ type: 'string',
32103
+ },
32104
+ },
32105
+ required: ['message', 'is_access_code_error', 'error_code'],
32106
+ type: 'object',
32107
+ 'x-resource-type': 'access_code',
32108
+ 'x-undocumented': 'Unreleased.',
32109
+ },
32110
+ {
32111
+ description:
32112
+ '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.',
32113
+ properties: {
32114
+ created_at: {
32115
+ description:
32116
+ 'Date and time at which Seam created the error.',
32117
+ format: 'date-time',
32118
+ type: 'string',
32119
+ },
32120
+ error_code: {
32121
+ description:
32122
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
32123
+ enum: ['failed_to_expire'],
32124
+ type: 'string',
32125
+ },
32126
+ is_access_code_error: {
32127
+ description:
32128
+ 'Indicates that this is an access code error.',
32129
+ enum: [true],
32130
+ type: 'boolean',
32131
+ },
32132
+ message: {
32133
+ description:
32134
+ 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
32135
+ type: 'string',
32136
+ },
32137
+ },
32138
+ required: ['message', 'is_access_code_error', 'error_code'],
32139
+ type: 'object',
32140
+ 'x-resource-type': 'access_code',
32141
+ 'x-undocumented': 'Unreleased.',
32142
+ },
30559
32143
  {
30560
32144
  description: 'Indicates that the account is disconnected.',
30561
32145
  properties: {
@@ -31310,6 +32894,58 @@ const openapi: OpenAPISpec = {
31310
32894
  'x-deprecated':
31311
32895
  'Seam no longer sets this warning. Use the `failed_to_remove_from_device` error instead.',
31312
32896
  },
32897
+ {
32898
+ description:
32899
+ '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.',
32900
+ properties: {
32901
+ created_at: {
32902
+ description:
32903
+ 'Date and time at which Seam created the warning.',
32904
+ format: 'date-time',
32905
+ type: 'string',
32906
+ },
32907
+ message: {
32908
+ description:
32909
+ 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
32910
+ type: 'string',
32911
+ },
32912
+ warning_code: {
32913
+ description:
32914
+ 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
32915
+ enum: ['delay_in_issuing'],
32916
+ type: 'string',
32917
+ },
32918
+ },
32919
+ required: ['message', 'warning_code'],
32920
+ type: 'object',
32921
+ 'x-undocumented': 'Unreleased.',
32922
+ },
32923
+ {
32924
+ description:
32925
+ "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.",
32926
+ properties: {
32927
+ created_at: {
32928
+ description:
32929
+ 'Date and time at which Seam created the warning.',
32930
+ format: 'date-time',
32931
+ type: 'string',
32932
+ },
32933
+ message: {
32934
+ description:
32935
+ 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
32936
+ type: 'string',
32937
+ },
32938
+ warning_code: {
32939
+ description:
32940
+ 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
32941
+ enum: ['delay_in_applying_mutations'],
32942
+ type: 'string',
32943
+ },
32944
+ },
32945
+ required: ['message', 'warning_code'],
32946
+ type: 'object',
32947
+ 'x-undocumented': 'Unreleased.',
32948
+ },
31313
32949
  {
31314
32950
  description:
31315
32951
  'Third-party integration detected that may cause access codes to fail.',
@@ -59448,6 +61084,12 @@ const openapi: OpenAPISpec = {
59448
61084
  'access_code.removed_from_device',
59449
61085
  'access_code.delay_in_setting_on_device',
59450
61086
  'access_code.failed_to_set_on_device',
61087
+ 'access_code.issued',
61088
+ 'access_code.delay_in_issuing',
61089
+ 'access_code.failed_to_issue',
61090
+ 'access_code.delay_in_applying_mutations',
61091
+ 'access_code.failed_to_apply_mutations',
61092
+ 'access_code.failed_to_expire',
59451
61093
  'access_code.deleted',
59452
61094
  'access_code.delay_in_removing_from_device',
59453
61095
  'access_code.failed_to_remove_from_device',
@@ -59568,6 +61210,12 @@ const openapi: OpenAPISpec = {
59568
61210
  'access_code.removed_from_device',
59569
61211
  'access_code.delay_in_setting_on_device',
59570
61212
  'access_code.failed_to_set_on_device',
61213
+ 'access_code.issued',
61214
+ 'access_code.delay_in_issuing',
61215
+ 'access_code.failed_to_issue',
61216
+ 'access_code.delay_in_applying_mutations',
61217
+ 'access_code.failed_to_apply_mutations',
61218
+ 'access_code.failed_to_expire',
59571
61219
  'access_code.deleted',
59572
61220
  'access_code.delay_in_removing_from_device',
59573
61221
  'access_code.failed_to_remove_from_device',
@@ -60020,6 +61668,12 @@ const openapi: OpenAPISpec = {
60020
61668
  'access_code.removed_from_device',
60021
61669
  'access_code.delay_in_setting_on_device',
60022
61670
  'access_code.failed_to_set_on_device',
61671
+ 'access_code.issued',
61672
+ 'access_code.delay_in_issuing',
61673
+ 'access_code.failed_to_issue',
61674
+ 'access_code.delay_in_applying_mutations',
61675
+ 'access_code.failed_to_apply_mutations',
61676
+ 'access_code.failed_to_expire',
60023
61677
  'access_code.deleted',
60024
61678
  'access_code.delay_in_removing_from_device',
60025
61679
  'access_code.failed_to_remove_from_device',
@@ -60136,6 +61790,12 @@ const openapi: OpenAPISpec = {
60136
61790
  'access_code.removed_from_device',
60137
61791
  'access_code.delay_in_setting_on_device',
60138
61792
  'access_code.failed_to_set_on_device',
61793
+ 'access_code.issued',
61794
+ 'access_code.delay_in_issuing',
61795
+ 'access_code.failed_to_issue',
61796
+ 'access_code.delay_in_applying_mutations',
61797
+ 'access_code.failed_to_apply_mutations',
61798
+ 'access_code.failed_to_expire',
60139
61799
  'access_code.deleted',
60140
61800
  'access_code.delay_in_removing_from_device',
60141
61801
  'access_code.failed_to_remove_from_device',
@@ -72450,6 +74110,12 @@ const openapi: OpenAPISpec = {
72450
74110
  'access_code.removed_from_device',
72451
74111
  'access_code.delay_in_setting_on_device',
72452
74112
  'access_code.failed_to_set_on_device',
74113
+ 'access_code.issued',
74114
+ 'access_code.delay_in_issuing',
74115
+ 'access_code.failed_to_issue',
74116
+ 'access_code.delay_in_applying_mutations',
74117
+ 'access_code.failed_to_apply_mutations',
74118
+ 'access_code.failed_to_expire',
72453
74119
  'access_code.deleted',
72454
74120
  'access_code.delay_in_removing_from_device',
72455
74121
  'access_code.failed_to_remove_from_device',
@@ -72571,6 +74237,12 @@ const openapi: OpenAPISpec = {
72571
74237
  'access_code.removed_from_device',
72572
74238
  'access_code.delay_in_setting_on_device',
72573
74239
  'access_code.failed_to_set_on_device',
74240
+ 'access_code.issued',
74241
+ 'access_code.delay_in_issuing',
74242
+ 'access_code.failed_to_issue',
74243
+ 'access_code.delay_in_applying_mutations',
74244
+ 'access_code.failed_to_apply_mutations',
74245
+ 'access_code.failed_to_expire',
72574
74246
  'access_code.deleted',
72575
74247
  'access_code.delay_in_removing_from_device',
72576
74248
  'access_code.failed_to_remove_from_device',
@@ -72753,6 +74425,12 @@ const openapi: OpenAPISpec = {
72753
74425
  'access_code.removed_from_device',
72754
74426
  'access_code.delay_in_setting_on_device',
72755
74427
  'access_code.failed_to_set_on_device',
74428
+ 'access_code.issued',
74429
+ 'access_code.delay_in_issuing',
74430
+ 'access_code.failed_to_issue',
74431
+ 'access_code.delay_in_applying_mutations',
74432
+ 'access_code.failed_to_apply_mutations',
74433
+ 'access_code.failed_to_expire',
72756
74434
  'access_code.deleted',
72757
74435
  'access_code.delay_in_removing_from_device',
72758
74436
  'access_code.failed_to_remove_from_device',
@@ -72869,6 +74547,12 @@ const openapi: OpenAPISpec = {
72869
74547
  'access_code.removed_from_device',
72870
74548
  'access_code.delay_in_setting_on_device',
72871
74549
  'access_code.failed_to_set_on_device',
74550
+ 'access_code.issued',
74551
+ 'access_code.delay_in_issuing',
74552
+ 'access_code.failed_to_issue',
74553
+ 'access_code.delay_in_applying_mutations',
74554
+ 'access_code.failed_to_apply_mutations',
74555
+ 'access_code.failed_to_expire',
72872
74556
  'access_code.deleted',
72873
74557
  'access_code.delay_in_removing_from_device',
72874
74558
  'access_code.failed_to_remove_from_device',