@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.
- package/lib/seam/connect/models/access-codes/managed-access-code.d.ts +329 -0
- package/lib/seam/connect/models/access-codes/managed-access-code.js +61 -0
- package/lib/seam/connect/models/access-codes/managed-access-code.js.map +1 -1
- package/lib/seam/connect/models/access-codes/unmanaged-access-code.d.ts +120 -0
- package/lib/seam/connect/models/access-grants/access-method.d.ts +10 -10
- package/lib/seam/connect/models/devices/unmanaged-device.d.ts +3 -1
- package/lib/seam/connect/models/devices/unmanaged-device.js +1 -0
- package/lib/seam/connect/models/devices/unmanaged-device.js.map +1 -1
- package/lib/seam/connect/models/events/access-codes.d.ts +2327 -463
- package/lib/seam/connect/models/events/access-codes.js +71 -0
- package/lib/seam/connect/models/events/access-codes.js.map +1 -1
- package/lib/seam/connect/models/events/seam-event.d.ts +927 -1
- package/lib/seam/connect/openapi.js +1522 -11
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +2247 -78
- package/package.json +1 -1
- package/src/lib/seam/connect/models/access-codes/managed-access-code.ts +66 -0
- package/src/lib/seam/connect/models/devices/unmanaged-device.ts +1 -0
- package/src/lib/seam/connect/models/events/access-codes.ts +99 -0
- package/src/lib/seam/connect/openapi.ts +1726 -12
- package/src/lib/seam/connect/route-types.ts +2591 -223
|
@@ -336,6 +336,90 @@ const openapi = {
|
|
|
336
336
|
type: 'object',
|
|
337
337
|
'x-resource-type': 'access_code',
|
|
338
338
|
},
|
|
339
|
+
{
|
|
340
|
+
description: '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.',
|
|
341
|
+
properties: {
|
|
342
|
+
created_at: {
|
|
343
|
+
description: 'Date and time at which Seam created the error.',
|
|
344
|
+
format: 'date-time',
|
|
345
|
+
type: 'string',
|
|
346
|
+
},
|
|
347
|
+
error_code: {
|
|
348
|
+
description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
349
|
+
enum: ['failed_to_issue'],
|
|
350
|
+
type: 'string',
|
|
351
|
+
},
|
|
352
|
+
is_access_code_error: {
|
|
353
|
+
description: 'Indicates that this is an access code error.',
|
|
354
|
+
enum: [true],
|
|
355
|
+
type: 'boolean',
|
|
356
|
+
},
|
|
357
|
+
message: {
|
|
358
|
+
description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
359
|
+
type: 'string',
|
|
360
|
+
},
|
|
361
|
+
},
|
|
362
|
+
required: ['message', 'is_access_code_error', 'error_code'],
|
|
363
|
+
type: 'object',
|
|
364
|
+
'x-resource-type': 'access_code',
|
|
365
|
+
'x-undocumented': 'Unreleased.',
|
|
366
|
+
},
|
|
367
|
+
{
|
|
368
|
+
description: "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.",
|
|
369
|
+
properties: {
|
|
370
|
+
created_at: {
|
|
371
|
+
description: 'Date and time at which Seam created the error.',
|
|
372
|
+
format: 'date-time',
|
|
373
|
+
type: 'string',
|
|
374
|
+
},
|
|
375
|
+
error_code: {
|
|
376
|
+
description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
377
|
+
enum: ['failed_to_apply_mutations'],
|
|
378
|
+
type: 'string',
|
|
379
|
+
},
|
|
380
|
+
is_access_code_error: {
|
|
381
|
+
description: 'Indicates that this is an access code error.',
|
|
382
|
+
enum: [true],
|
|
383
|
+
type: 'boolean',
|
|
384
|
+
},
|
|
385
|
+
message: {
|
|
386
|
+
description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
387
|
+
type: 'string',
|
|
388
|
+
},
|
|
389
|
+
},
|
|
390
|
+
required: ['message', 'is_access_code_error', 'error_code'],
|
|
391
|
+
type: 'object',
|
|
392
|
+
'x-resource-type': 'access_code',
|
|
393
|
+
'x-undocumented': 'Unreleased.',
|
|
394
|
+
},
|
|
395
|
+
{
|
|
396
|
+
description: '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.',
|
|
397
|
+
properties: {
|
|
398
|
+
created_at: {
|
|
399
|
+
description: 'Date and time at which Seam created the error.',
|
|
400
|
+
format: 'date-time',
|
|
401
|
+
type: 'string',
|
|
402
|
+
},
|
|
403
|
+
error_code: {
|
|
404
|
+
description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
405
|
+
enum: ['failed_to_expire'],
|
|
406
|
+
type: 'string',
|
|
407
|
+
},
|
|
408
|
+
is_access_code_error: {
|
|
409
|
+
description: 'Indicates that this is an access code error.',
|
|
410
|
+
enum: [true],
|
|
411
|
+
type: 'boolean',
|
|
412
|
+
},
|
|
413
|
+
message: {
|
|
414
|
+
description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
415
|
+
type: 'string',
|
|
416
|
+
},
|
|
417
|
+
},
|
|
418
|
+
required: ['message', 'is_access_code_error', 'error_code'],
|
|
419
|
+
type: 'object',
|
|
420
|
+
'x-resource-type': 'access_code',
|
|
421
|
+
'x-undocumented': 'Unreleased.',
|
|
422
|
+
},
|
|
339
423
|
{
|
|
340
424
|
description: 'Indicates that the account is disconnected.',
|
|
341
425
|
properties: {
|
|
@@ -1277,6 +1361,50 @@ const openapi = {
|
|
|
1277
1361
|
type: 'object',
|
|
1278
1362
|
'x-deprecated': 'Seam no longer sets this warning. Use the `failed_to_remove_from_device` error instead.',
|
|
1279
1363
|
},
|
|
1364
|
+
{
|
|
1365
|
+
description: '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.',
|
|
1366
|
+
properties: {
|
|
1367
|
+
created_at: {
|
|
1368
|
+
description: 'Date and time at which Seam created the warning.',
|
|
1369
|
+
format: 'date-time',
|
|
1370
|
+
type: 'string',
|
|
1371
|
+
},
|
|
1372
|
+
message: {
|
|
1373
|
+
description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
1374
|
+
type: 'string',
|
|
1375
|
+
},
|
|
1376
|
+
warning_code: {
|
|
1377
|
+
description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
1378
|
+
enum: ['delay_in_issuing'],
|
|
1379
|
+
type: 'string',
|
|
1380
|
+
},
|
|
1381
|
+
},
|
|
1382
|
+
required: ['message', 'warning_code'],
|
|
1383
|
+
type: 'object',
|
|
1384
|
+
'x-undocumented': 'Unreleased.',
|
|
1385
|
+
},
|
|
1386
|
+
{
|
|
1387
|
+
description: "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.",
|
|
1388
|
+
properties: {
|
|
1389
|
+
created_at: {
|
|
1390
|
+
description: 'Date and time at which Seam created the warning.',
|
|
1391
|
+
format: 'date-time',
|
|
1392
|
+
type: 'string',
|
|
1393
|
+
},
|
|
1394
|
+
message: {
|
|
1395
|
+
description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
1396
|
+
type: 'string',
|
|
1397
|
+
},
|
|
1398
|
+
warning_code: {
|
|
1399
|
+
description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
1400
|
+
enum: ['delay_in_applying_mutations'],
|
|
1401
|
+
type: 'string',
|
|
1402
|
+
},
|
|
1403
|
+
},
|
|
1404
|
+
required: ['message', 'warning_code'],
|
|
1405
|
+
type: 'object',
|
|
1406
|
+
'x-undocumented': 'Unreleased.',
|
|
1407
|
+
},
|
|
1280
1408
|
{
|
|
1281
1409
|
description: 'Third-party integration detected that may cause access codes to fail.',
|
|
1282
1410
|
properties: {
|
|
@@ -17206,7 +17334,7 @@ const openapi = {
|
|
|
17206
17334
|
'x-route-path': '/access_codes',
|
|
17207
17335
|
},
|
|
17208
17336
|
{
|
|
17209
|
-
description: 'An [access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes) was
|
|
17337
|
+
description: 'An [access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes) was issued.',
|
|
17210
17338
|
properties: {
|
|
17211
17339
|
access_code_id: {
|
|
17212
17340
|
description: 'ID of the affected access code.',
|
|
@@ -17215,7 +17343,6 @@ const openapi = {
|
|
|
17215
17343
|
},
|
|
17216
17344
|
code: {
|
|
17217
17345
|
description: 'Code for the affected access code.',
|
|
17218
|
-
nullable: true,
|
|
17219
17346
|
type: 'string',
|
|
17220
17347
|
},
|
|
17221
17348
|
connected_account_custom_metadata: {
|
|
@@ -17256,7 +17383,7 @@ const openapi = {
|
|
|
17256
17383
|
format: 'uuid',
|
|
17257
17384
|
type: 'string',
|
|
17258
17385
|
},
|
|
17259
|
-
event_type: { enum: ['access_code.
|
|
17386
|
+
event_type: { enum: ['access_code.issued'], type: 'string' },
|
|
17260
17387
|
occurred_at: {
|
|
17261
17388
|
description: 'Date and time at which the event occurred.',
|
|
17262
17389
|
format: 'date-time',
|
|
@@ -17281,10 +17408,10 @@ const openapi = {
|
|
|
17281
17408
|
],
|
|
17282
17409
|
type: 'object',
|
|
17283
17410
|
'x-route-path': '/access_codes',
|
|
17411
|
+
'x-undocumented': 'Unreleased.',
|
|
17284
17412
|
},
|
|
17285
17413
|
{
|
|
17286
|
-
|
|
17287
|
-
description: '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.',
|
|
17414
|
+
description: '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.',
|
|
17288
17415
|
properties: {
|
|
17289
17416
|
access_code_errors: {
|
|
17290
17417
|
description: 'Errors associated with the access code.',
|
|
@@ -17474,7 +17601,7 @@ const openapi = {
|
|
|
17474
17601
|
type: 'string',
|
|
17475
17602
|
},
|
|
17476
17603
|
event_type: {
|
|
17477
|
-
enum: ['access_code.
|
|
17604
|
+
enum: ['access_code.delay_in_issuing'],
|
|
17478
17605
|
type: 'string',
|
|
17479
17606
|
},
|
|
17480
17607
|
occurred_at: {
|
|
@@ -17505,11 +17632,11 @@ const openapi = {
|
|
|
17505
17632
|
'access_code_warnings',
|
|
17506
17633
|
],
|
|
17507
17634
|
type: 'object',
|
|
17508
|
-
'x-deprecated': 'Seam no longer emits this event. Use `access_code.failed_to_remove_from_device` instead.',
|
|
17509
17635
|
'x-route-path': '/access_codes',
|
|
17636
|
+
'x-undocumented': 'Unreleased.',
|
|
17510
17637
|
},
|
|
17511
17638
|
{
|
|
17512
|
-
description: '
|
|
17639
|
+
description: '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.',
|
|
17513
17640
|
properties: {
|
|
17514
17641
|
access_code_errors: {
|
|
17515
17642
|
description: 'Errors associated with the access code.',
|
|
@@ -17699,7 +17826,7 @@ const openapi = {
|
|
|
17699
17826
|
type: 'string',
|
|
17700
17827
|
},
|
|
17701
17828
|
event_type: {
|
|
17702
|
-
enum: ['access_code.
|
|
17829
|
+
enum: ['access_code.failed_to_issue'],
|
|
17703
17830
|
type: 'string',
|
|
17704
17831
|
},
|
|
17705
17832
|
occurred_at: {
|
|
@@ -17731,15 +17858,64 @@ const openapi = {
|
|
|
17731
17858
|
],
|
|
17732
17859
|
type: 'object',
|
|
17733
17860
|
'x-route-path': '/access_codes',
|
|
17861
|
+
'x-undocumented': 'Unreleased.',
|
|
17734
17862
|
},
|
|
17735
17863
|
{
|
|
17736
|
-
description:
|
|
17864
|
+
description: "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.",
|
|
17737
17865
|
properties: {
|
|
17866
|
+
access_code_errors: {
|
|
17867
|
+
description: 'Errors associated with the access code.',
|
|
17868
|
+
items: {
|
|
17869
|
+
description: 'Error associated with the resource, including the error code, message, and creation timestamp.',
|
|
17870
|
+
properties: {
|
|
17871
|
+
created_at: {
|
|
17872
|
+
description: 'Date and time at which Seam created the error.',
|
|
17873
|
+
format: 'date-time',
|
|
17874
|
+
type: 'string',
|
|
17875
|
+
},
|
|
17876
|
+
error_code: {
|
|
17877
|
+
description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
17878
|
+
type: 'string',
|
|
17879
|
+
},
|
|
17880
|
+
message: {
|
|
17881
|
+
description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
17882
|
+
type: 'string',
|
|
17883
|
+
},
|
|
17884
|
+
},
|
|
17885
|
+
required: ['created_at', 'message', 'error_code'],
|
|
17886
|
+
type: 'object',
|
|
17887
|
+
},
|
|
17888
|
+
type: 'array',
|
|
17889
|
+
},
|
|
17738
17890
|
access_code_id: {
|
|
17739
17891
|
description: 'ID of the affected access code.',
|
|
17740
17892
|
format: 'uuid',
|
|
17741
17893
|
type: 'string',
|
|
17742
17894
|
},
|
|
17895
|
+
access_code_warnings: {
|
|
17896
|
+
description: 'Warnings associated with the access code.',
|
|
17897
|
+
items: {
|
|
17898
|
+
description: 'Warning associated with the resource, including the warning code, message, and creation timestamp.',
|
|
17899
|
+
properties: {
|
|
17900
|
+
created_at: {
|
|
17901
|
+
description: 'Date and time at which Seam created the warning.',
|
|
17902
|
+
format: 'date-time',
|
|
17903
|
+
type: 'string',
|
|
17904
|
+
},
|
|
17905
|
+
message: {
|
|
17906
|
+
description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
17907
|
+
type: 'string',
|
|
17908
|
+
},
|
|
17909
|
+
warning_code: {
|
|
17910
|
+
description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
17911
|
+
type: 'string',
|
|
17912
|
+
},
|
|
17913
|
+
},
|
|
17914
|
+
required: ['created_at', 'message', 'warning_code'],
|
|
17915
|
+
type: 'object',
|
|
17916
|
+
},
|
|
17917
|
+
type: 'array',
|
|
17918
|
+
},
|
|
17743
17919
|
connected_account_custom_metadata: {
|
|
17744
17920
|
additionalProperties: {
|
|
17745
17921
|
oneOf: [{ type: 'string' }, { type: 'boolean' }],
|
|
@@ -17747,11 +17923,59 @@ const openapi = {
|
|
|
17747
17923
|
description: 'Custom metadata of the connected account, present when connected_account_id is provided.',
|
|
17748
17924
|
type: 'object',
|
|
17749
17925
|
},
|
|
17926
|
+
connected_account_errors: {
|
|
17927
|
+
description: 'Errors associated with the connected account.',
|
|
17928
|
+
items: {
|
|
17929
|
+
description: 'Error associated with the resource, including the error code, message, and creation timestamp.',
|
|
17930
|
+
properties: {
|
|
17931
|
+
created_at: {
|
|
17932
|
+
description: 'Date and time at which Seam created the error.',
|
|
17933
|
+
format: 'date-time',
|
|
17934
|
+
type: 'string',
|
|
17935
|
+
},
|
|
17936
|
+
error_code: {
|
|
17937
|
+
description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
17938
|
+
type: 'string',
|
|
17939
|
+
},
|
|
17940
|
+
message: {
|
|
17941
|
+
description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
17942
|
+
type: 'string',
|
|
17943
|
+
},
|
|
17944
|
+
},
|
|
17945
|
+
required: ['created_at', 'message', 'error_code'],
|
|
17946
|
+
type: 'object',
|
|
17947
|
+
},
|
|
17948
|
+
type: 'array',
|
|
17949
|
+
},
|
|
17750
17950
|
connected_account_id: {
|
|
17751
17951
|
description: 'ID of the connected account associated with the affected access code.',
|
|
17752
17952
|
format: 'uuid',
|
|
17753
17953
|
type: 'string',
|
|
17754
17954
|
},
|
|
17955
|
+
connected_account_warnings: {
|
|
17956
|
+
description: 'Warnings associated with the connected account.',
|
|
17957
|
+
items: {
|
|
17958
|
+
description: 'Warning associated with the resource, including the warning code, message, and creation timestamp.',
|
|
17959
|
+
properties: {
|
|
17960
|
+
created_at: {
|
|
17961
|
+
description: 'Date and time at which Seam created the warning.',
|
|
17962
|
+
format: 'date-time',
|
|
17963
|
+
type: 'string',
|
|
17964
|
+
},
|
|
17965
|
+
message: {
|
|
17966
|
+
description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
17967
|
+
type: 'string',
|
|
17968
|
+
},
|
|
17969
|
+
warning_code: {
|
|
17970
|
+
description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
17971
|
+
type: 'string',
|
|
17972
|
+
},
|
|
17973
|
+
},
|
|
17974
|
+
required: ['created_at', 'message', 'warning_code'],
|
|
17975
|
+
type: 'object',
|
|
17976
|
+
},
|
|
17977
|
+
type: 'array',
|
|
17978
|
+
},
|
|
17755
17979
|
created_at: {
|
|
17756
17980
|
description: 'Date and time at which the event was created.',
|
|
17757
17981
|
format: 'date-time',
|
|
@@ -17764,11 +17988,59 @@ const openapi = {
|
|
|
17764
17988
|
description: 'Custom metadata of the device, present when device_id is provided.',
|
|
17765
17989
|
type: 'object',
|
|
17766
17990
|
},
|
|
17991
|
+
device_errors: {
|
|
17992
|
+
description: 'Errors associated with the device.',
|
|
17993
|
+
items: {
|
|
17994
|
+
description: 'Error associated with the resource, including the error code, message, and creation timestamp.',
|
|
17995
|
+
properties: {
|
|
17996
|
+
created_at: {
|
|
17997
|
+
description: 'Date and time at which Seam created the error.',
|
|
17998
|
+
format: 'date-time',
|
|
17999
|
+
type: 'string',
|
|
18000
|
+
},
|
|
18001
|
+
error_code: {
|
|
18002
|
+
description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
18003
|
+
type: 'string',
|
|
18004
|
+
},
|
|
18005
|
+
message: {
|
|
18006
|
+
description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
18007
|
+
type: 'string',
|
|
18008
|
+
},
|
|
18009
|
+
},
|
|
18010
|
+
required: ['created_at', 'message', 'error_code'],
|
|
18011
|
+
type: 'object',
|
|
18012
|
+
},
|
|
18013
|
+
type: 'array',
|
|
18014
|
+
},
|
|
17767
18015
|
device_id: {
|
|
17768
18016
|
description: 'ID of the device associated with the affected access code.',
|
|
17769
18017
|
format: 'uuid',
|
|
17770
18018
|
type: 'string',
|
|
17771
18019
|
},
|
|
18020
|
+
device_warnings: {
|
|
18021
|
+
description: 'Warnings associated with the device.',
|
|
18022
|
+
items: {
|
|
18023
|
+
description: 'Warning associated with the resource, including the warning code, message, and creation timestamp.',
|
|
18024
|
+
properties: {
|
|
18025
|
+
created_at: {
|
|
18026
|
+
description: 'Date and time at which Seam created the warning.',
|
|
18027
|
+
format: 'date-time',
|
|
18028
|
+
type: 'string',
|
|
18029
|
+
},
|
|
18030
|
+
message: {
|
|
18031
|
+
description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
18032
|
+
type: 'string',
|
|
18033
|
+
},
|
|
18034
|
+
warning_code: {
|
|
18035
|
+
description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
18036
|
+
type: 'string',
|
|
18037
|
+
},
|
|
18038
|
+
},
|
|
18039
|
+
required: ['created_at', 'message', 'warning_code'],
|
|
18040
|
+
type: 'object',
|
|
18041
|
+
},
|
|
18042
|
+
type: 'array',
|
|
18043
|
+
},
|
|
17772
18044
|
event_description: {
|
|
17773
18045
|
description: '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.',
|
|
17774
18046
|
type: 'string',
|
|
@@ -17779,7 +18051,1065 @@ const openapi = {
|
|
|
17779
18051
|
type: 'string',
|
|
17780
18052
|
},
|
|
17781
18053
|
event_type: {
|
|
17782
|
-
enum: ['access_code.
|
|
18054
|
+
enum: ['access_code.delay_in_applying_mutations'],
|
|
18055
|
+
type: 'string',
|
|
18056
|
+
},
|
|
18057
|
+
occurred_at: {
|
|
18058
|
+
description: 'Date and time at which the event occurred.',
|
|
18059
|
+
format: 'date-time',
|
|
18060
|
+
type: 'string',
|
|
18061
|
+
},
|
|
18062
|
+
workspace_id: {
|
|
18063
|
+
description: 'ID of the workspace associated with the event.',
|
|
18064
|
+
format: 'uuid',
|
|
18065
|
+
type: 'string',
|
|
18066
|
+
},
|
|
18067
|
+
},
|
|
18068
|
+
required: [
|
|
18069
|
+
'event_id',
|
|
18070
|
+
'workspace_id',
|
|
18071
|
+
'created_at',
|
|
18072
|
+
'occurred_at',
|
|
18073
|
+
'access_code_id',
|
|
18074
|
+
'device_id',
|
|
18075
|
+
'connected_account_id',
|
|
18076
|
+
'event_type',
|
|
18077
|
+
'connected_account_errors',
|
|
18078
|
+
'connected_account_warnings',
|
|
18079
|
+
'device_errors',
|
|
18080
|
+
'device_warnings',
|
|
18081
|
+
'access_code_errors',
|
|
18082
|
+
'access_code_warnings',
|
|
18083
|
+
],
|
|
18084
|
+
type: 'object',
|
|
18085
|
+
'x-route-path': '/access_codes',
|
|
18086
|
+
'x-undocumented': 'Unreleased.',
|
|
18087
|
+
},
|
|
18088
|
+
{
|
|
18089
|
+
description: "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.",
|
|
18090
|
+
properties: {
|
|
18091
|
+
access_code_errors: {
|
|
18092
|
+
description: 'Errors associated with the access code.',
|
|
18093
|
+
items: {
|
|
18094
|
+
description: 'Error associated with the resource, including the error code, message, and creation timestamp.',
|
|
18095
|
+
properties: {
|
|
18096
|
+
created_at: {
|
|
18097
|
+
description: 'Date and time at which Seam created the error.',
|
|
18098
|
+
format: 'date-time',
|
|
18099
|
+
type: 'string',
|
|
18100
|
+
},
|
|
18101
|
+
error_code: {
|
|
18102
|
+
description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
18103
|
+
type: 'string',
|
|
18104
|
+
},
|
|
18105
|
+
message: {
|
|
18106
|
+
description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
18107
|
+
type: 'string',
|
|
18108
|
+
},
|
|
18109
|
+
},
|
|
18110
|
+
required: ['created_at', 'message', 'error_code'],
|
|
18111
|
+
type: 'object',
|
|
18112
|
+
},
|
|
18113
|
+
type: 'array',
|
|
18114
|
+
},
|
|
18115
|
+
access_code_id: {
|
|
18116
|
+
description: 'ID of the affected access code.',
|
|
18117
|
+
format: 'uuid',
|
|
18118
|
+
type: 'string',
|
|
18119
|
+
},
|
|
18120
|
+
access_code_warnings: {
|
|
18121
|
+
description: 'Warnings associated with the access code.',
|
|
18122
|
+
items: {
|
|
18123
|
+
description: 'Warning associated with the resource, including the warning code, message, and creation timestamp.',
|
|
18124
|
+
properties: {
|
|
18125
|
+
created_at: {
|
|
18126
|
+
description: 'Date and time at which Seam created the warning.',
|
|
18127
|
+
format: 'date-time',
|
|
18128
|
+
type: 'string',
|
|
18129
|
+
},
|
|
18130
|
+
message: {
|
|
18131
|
+
description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
18132
|
+
type: 'string',
|
|
18133
|
+
},
|
|
18134
|
+
warning_code: {
|
|
18135
|
+
description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
18136
|
+
type: 'string',
|
|
18137
|
+
},
|
|
18138
|
+
},
|
|
18139
|
+
required: ['created_at', 'message', 'warning_code'],
|
|
18140
|
+
type: 'object',
|
|
18141
|
+
},
|
|
18142
|
+
type: 'array',
|
|
18143
|
+
},
|
|
18144
|
+
connected_account_custom_metadata: {
|
|
18145
|
+
additionalProperties: {
|
|
18146
|
+
oneOf: [{ type: 'string' }, { type: 'boolean' }],
|
|
18147
|
+
},
|
|
18148
|
+
description: 'Custom metadata of the connected account, present when connected_account_id is provided.',
|
|
18149
|
+
type: 'object',
|
|
18150
|
+
},
|
|
18151
|
+
connected_account_errors: {
|
|
18152
|
+
description: 'Errors associated with the connected account.',
|
|
18153
|
+
items: {
|
|
18154
|
+
description: 'Error associated with the resource, including the error code, message, and creation timestamp.',
|
|
18155
|
+
properties: {
|
|
18156
|
+
created_at: {
|
|
18157
|
+
description: 'Date and time at which Seam created the error.',
|
|
18158
|
+
format: 'date-time',
|
|
18159
|
+
type: 'string',
|
|
18160
|
+
},
|
|
18161
|
+
error_code: {
|
|
18162
|
+
description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
18163
|
+
type: 'string',
|
|
18164
|
+
},
|
|
18165
|
+
message: {
|
|
18166
|
+
description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
18167
|
+
type: 'string',
|
|
18168
|
+
},
|
|
18169
|
+
},
|
|
18170
|
+
required: ['created_at', 'message', 'error_code'],
|
|
18171
|
+
type: 'object',
|
|
18172
|
+
},
|
|
18173
|
+
type: 'array',
|
|
18174
|
+
},
|
|
18175
|
+
connected_account_id: {
|
|
18176
|
+
description: 'ID of the connected account associated with the affected access code.',
|
|
18177
|
+
format: 'uuid',
|
|
18178
|
+
type: 'string',
|
|
18179
|
+
},
|
|
18180
|
+
connected_account_warnings: {
|
|
18181
|
+
description: 'Warnings associated with the connected account.',
|
|
18182
|
+
items: {
|
|
18183
|
+
description: 'Warning associated with the resource, including the warning code, message, and creation timestamp.',
|
|
18184
|
+
properties: {
|
|
18185
|
+
created_at: {
|
|
18186
|
+
description: 'Date and time at which Seam created the warning.',
|
|
18187
|
+
format: 'date-time',
|
|
18188
|
+
type: 'string',
|
|
18189
|
+
},
|
|
18190
|
+
message: {
|
|
18191
|
+
description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
18192
|
+
type: 'string',
|
|
18193
|
+
},
|
|
18194
|
+
warning_code: {
|
|
18195
|
+
description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
18196
|
+
type: 'string',
|
|
18197
|
+
},
|
|
18198
|
+
},
|
|
18199
|
+
required: ['created_at', 'message', 'warning_code'],
|
|
18200
|
+
type: 'object',
|
|
18201
|
+
},
|
|
18202
|
+
type: 'array',
|
|
18203
|
+
},
|
|
18204
|
+
created_at: {
|
|
18205
|
+
description: 'Date and time at which the event was created.',
|
|
18206
|
+
format: 'date-time',
|
|
18207
|
+
type: 'string',
|
|
18208
|
+
},
|
|
18209
|
+
device_custom_metadata: {
|
|
18210
|
+
additionalProperties: {
|
|
18211
|
+
oneOf: [{ type: 'string' }, { type: 'boolean' }],
|
|
18212
|
+
},
|
|
18213
|
+
description: 'Custom metadata of the device, present when device_id is provided.',
|
|
18214
|
+
type: 'object',
|
|
18215
|
+
},
|
|
18216
|
+
device_errors: {
|
|
18217
|
+
description: 'Errors associated with the device.',
|
|
18218
|
+
items: {
|
|
18219
|
+
description: 'Error associated with the resource, including the error code, message, and creation timestamp.',
|
|
18220
|
+
properties: {
|
|
18221
|
+
created_at: {
|
|
18222
|
+
description: 'Date and time at which Seam created the error.',
|
|
18223
|
+
format: 'date-time',
|
|
18224
|
+
type: 'string',
|
|
18225
|
+
},
|
|
18226
|
+
error_code: {
|
|
18227
|
+
description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
18228
|
+
type: 'string',
|
|
18229
|
+
},
|
|
18230
|
+
message: {
|
|
18231
|
+
description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
18232
|
+
type: 'string',
|
|
18233
|
+
},
|
|
18234
|
+
},
|
|
18235
|
+
required: ['created_at', 'message', 'error_code'],
|
|
18236
|
+
type: 'object',
|
|
18237
|
+
},
|
|
18238
|
+
type: 'array',
|
|
18239
|
+
},
|
|
18240
|
+
device_id: {
|
|
18241
|
+
description: 'ID of the device associated with the affected access code.',
|
|
18242
|
+
format: 'uuid',
|
|
18243
|
+
type: 'string',
|
|
18244
|
+
},
|
|
18245
|
+
device_warnings: {
|
|
18246
|
+
description: 'Warnings associated with the device.',
|
|
18247
|
+
items: {
|
|
18248
|
+
description: 'Warning associated with the resource, including the warning code, message, and creation timestamp.',
|
|
18249
|
+
properties: {
|
|
18250
|
+
created_at: {
|
|
18251
|
+
description: 'Date and time at which Seam created the warning.',
|
|
18252
|
+
format: 'date-time',
|
|
18253
|
+
type: 'string',
|
|
18254
|
+
},
|
|
18255
|
+
message: {
|
|
18256
|
+
description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
18257
|
+
type: 'string',
|
|
18258
|
+
},
|
|
18259
|
+
warning_code: {
|
|
18260
|
+
description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
18261
|
+
type: 'string',
|
|
18262
|
+
},
|
|
18263
|
+
},
|
|
18264
|
+
required: ['created_at', 'message', 'warning_code'],
|
|
18265
|
+
type: 'object',
|
|
18266
|
+
},
|
|
18267
|
+
type: 'array',
|
|
18268
|
+
},
|
|
18269
|
+
event_description: {
|
|
18270
|
+
description: '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.',
|
|
18271
|
+
type: 'string',
|
|
18272
|
+
},
|
|
18273
|
+
event_id: {
|
|
18274
|
+
description: 'ID of the event.',
|
|
18275
|
+
format: 'uuid',
|
|
18276
|
+
type: 'string',
|
|
18277
|
+
},
|
|
18278
|
+
event_type: {
|
|
18279
|
+
enum: ['access_code.failed_to_apply_mutations'],
|
|
18280
|
+
type: 'string',
|
|
18281
|
+
},
|
|
18282
|
+
occurred_at: {
|
|
18283
|
+
description: 'Date and time at which the event occurred.',
|
|
18284
|
+
format: 'date-time',
|
|
18285
|
+
type: 'string',
|
|
18286
|
+
},
|
|
18287
|
+
workspace_id: {
|
|
18288
|
+
description: 'ID of the workspace associated with the event.',
|
|
18289
|
+
format: 'uuid',
|
|
18290
|
+
type: 'string',
|
|
18291
|
+
},
|
|
18292
|
+
},
|
|
18293
|
+
required: [
|
|
18294
|
+
'event_id',
|
|
18295
|
+
'workspace_id',
|
|
18296
|
+
'created_at',
|
|
18297
|
+
'occurred_at',
|
|
18298
|
+
'access_code_id',
|
|
18299
|
+
'device_id',
|
|
18300
|
+
'connected_account_id',
|
|
18301
|
+
'event_type',
|
|
18302
|
+
'connected_account_errors',
|
|
18303
|
+
'connected_account_warnings',
|
|
18304
|
+
'device_errors',
|
|
18305
|
+
'device_warnings',
|
|
18306
|
+
'access_code_errors',
|
|
18307
|
+
'access_code_warnings',
|
|
18308
|
+
],
|
|
18309
|
+
type: 'object',
|
|
18310
|
+
'x-route-path': '/access_codes',
|
|
18311
|
+
'x-undocumented': 'Unreleased.',
|
|
18312
|
+
},
|
|
18313
|
+
{
|
|
18314
|
+
description: '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.',
|
|
18315
|
+
properties: {
|
|
18316
|
+
access_code_errors: {
|
|
18317
|
+
description: 'Errors associated with the access code.',
|
|
18318
|
+
items: {
|
|
18319
|
+
description: 'Error associated with the resource, including the error code, message, and creation timestamp.',
|
|
18320
|
+
properties: {
|
|
18321
|
+
created_at: {
|
|
18322
|
+
description: 'Date and time at which Seam created the error.',
|
|
18323
|
+
format: 'date-time',
|
|
18324
|
+
type: 'string',
|
|
18325
|
+
},
|
|
18326
|
+
error_code: {
|
|
18327
|
+
description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
18328
|
+
type: 'string',
|
|
18329
|
+
},
|
|
18330
|
+
message: {
|
|
18331
|
+
description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
18332
|
+
type: 'string',
|
|
18333
|
+
},
|
|
18334
|
+
},
|
|
18335
|
+
required: ['created_at', 'message', 'error_code'],
|
|
18336
|
+
type: 'object',
|
|
18337
|
+
},
|
|
18338
|
+
type: 'array',
|
|
18339
|
+
},
|
|
18340
|
+
access_code_id: {
|
|
18341
|
+
description: 'ID of the affected access code.',
|
|
18342
|
+
format: 'uuid',
|
|
18343
|
+
type: 'string',
|
|
18344
|
+
},
|
|
18345
|
+
access_code_warnings: {
|
|
18346
|
+
description: 'Warnings associated with the access code.',
|
|
18347
|
+
items: {
|
|
18348
|
+
description: 'Warning associated with the resource, including the warning code, message, and creation timestamp.',
|
|
18349
|
+
properties: {
|
|
18350
|
+
created_at: {
|
|
18351
|
+
description: 'Date and time at which Seam created the warning.',
|
|
18352
|
+
format: 'date-time',
|
|
18353
|
+
type: 'string',
|
|
18354
|
+
},
|
|
18355
|
+
message: {
|
|
18356
|
+
description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
18357
|
+
type: 'string',
|
|
18358
|
+
},
|
|
18359
|
+
warning_code: {
|
|
18360
|
+
description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
18361
|
+
type: 'string',
|
|
18362
|
+
},
|
|
18363
|
+
},
|
|
18364
|
+
required: ['created_at', 'message', 'warning_code'],
|
|
18365
|
+
type: 'object',
|
|
18366
|
+
},
|
|
18367
|
+
type: 'array',
|
|
18368
|
+
},
|
|
18369
|
+
connected_account_custom_metadata: {
|
|
18370
|
+
additionalProperties: {
|
|
18371
|
+
oneOf: [{ type: 'string' }, { type: 'boolean' }],
|
|
18372
|
+
},
|
|
18373
|
+
description: 'Custom metadata of the connected account, present when connected_account_id is provided.',
|
|
18374
|
+
type: 'object',
|
|
18375
|
+
},
|
|
18376
|
+
connected_account_errors: {
|
|
18377
|
+
description: 'Errors associated with the connected account.',
|
|
18378
|
+
items: {
|
|
18379
|
+
description: 'Error associated with the resource, including the error code, message, and creation timestamp.',
|
|
18380
|
+
properties: {
|
|
18381
|
+
created_at: {
|
|
18382
|
+
description: 'Date and time at which Seam created the error.',
|
|
18383
|
+
format: 'date-time',
|
|
18384
|
+
type: 'string',
|
|
18385
|
+
},
|
|
18386
|
+
error_code: {
|
|
18387
|
+
description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
18388
|
+
type: 'string',
|
|
18389
|
+
},
|
|
18390
|
+
message: {
|
|
18391
|
+
description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
18392
|
+
type: 'string',
|
|
18393
|
+
},
|
|
18394
|
+
},
|
|
18395
|
+
required: ['created_at', 'message', 'error_code'],
|
|
18396
|
+
type: 'object',
|
|
18397
|
+
},
|
|
18398
|
+
type: 'array',
|
|
18399
|
+
},
|
|
18400
|
+
connected_account_id: {
|
|
18401
|
+
description: 'ID of the connected account associated with the affected access code.',
|
|
18402
|
+
format: 'uuid',
|
|
18403
|
+
type: 'string',
|
|
18404
|
+
},
|
|
18405
|
+
connected_account_warnings: {
|
|
18406
|
+
description: 'Warnings associated with the connected account.',
|
|
18407
|
+
items: {
|
|
18408
|
+
description: 'Warning associated with the resource, including the warning code, message, and creation timestamp.',
|
|
18409
|
+
properties: {
|
|
18410
|
+
created_at: {
|
|
18411
|
+
description: 'Date and time at which Seam created the warning.',
|
|
18412
|
+
format: 'date-time',
|
|
18413
|
+
type: 'string',
|
|
18414
|
+
},
|
|
18415
|
+
message: {
|
|
18416
|
+
description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
18417
|
+
type: 'string',
|
|
18418
|
+
},
|
|
18419
|
+
warning_code: {
|
|
18420
|
+
description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
18421
|
+
type: 'string',
|
|
18422
|
+
},
|
|
18423
|
+
},
|
|
18424
|
+
required: ['created_at', 'message', 'warning_code'],
|
|
18425
|
+
type: 'object',
|
|
18426
|
+
},
|
|
18427
|
+
type: 'array',
|
|
18428
|
+
},
|
|
18429
|
+
created_at: {
|
|
18430
|
+
description: 'Date and time at which the event was created.',
|
|
18431
|
+
format: 'date-time',
|
|
18432
|
+
type: 'string',
|
|
18433
|
+
},
|
|
18434
|
+
device_custom_metadata: {
|
|
18435
|
+
additionalProperties: {
|
|
18436
|
+
oneOf: [{ type: 'string' }, { type: 'boolean' }],
|
|
18437
|
+
},
|
|
18438
|
+
description: 'Custom metadata of the device, present when device_id is provided.',
|
|
18439
|
+
type: 'object',
|
|
18440
|
+
},
|
|
18441
|
+
device_errors: {
|
|
18442
|
+
description: 'Errors associated with the device.',
|
|
18443
|
+
items: {
|
|
18444
|
+
description: 'Error associated with the resource, including the error code, message, and creation timestamp.',
|
|
18445
|
+
properties: {
|
|
18446
|
+
created_at: {
|
|
18447
|
+
description: 'Date and time at which Seam created the error.',
|
|
18448
|
+
format: 'date-time',
|
|
18449
|
+
type: 'string',
|
|
18450
|
+
},
|
|
18451
|
+
error_code: {
|
|
18452
|
+
description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
18453
|
+
type: 'string',
|
|
18454
|
+
},
|
|
18455
|
+
message: {
|
|
18456
|
+
description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
18457
|
+
type: 'string',
|
|
18458
|
+
},
|
|
18459
|
+
},
|
|
18460
|
+
required: ['created_at', 'message', 'error_code'],
|
|
18461
|
+
type: 'object',
|
|
18462
|
+
},
|
|
18463
|
+
type: 'array',
|
|
18464
|
+
},
|
|
18465
|
+
device_id: {
|
|
18466
|
+
description: 'ID of the device associated with the affected access code.',
|
|
18467
|
+
format: 'uuid',
|
|
18468
|
+
type: 'string',
|
|
18469
|
+
},
|
|
18470
|
+
device_warnings: {
|
|
18471
|
+
description: 'Warnings associated with the device.',
|
|
18472
|
+
items: {
|
|
18473
|
+
description: 'Warning associated with the resource, including the warning code, message, and creation timestamp.',
|
|
18474
|
+
properties: {
|
|
18475
|
+
created_at: {
|
|
18476
|
+
description: 'Date and time at which Seam created the warning.',
|
|
18477
|
+
format: 'date-time',
|
|
18478
|
+
type: 'string',
|
|
18479
|
+
},
|
|
18480
|
+
message: {
|
|
18481
|
+
description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
18482
|
+
type: 'string',
|
|
18483
|
+
},
|
|
18484
|
+
warning_code: {
|
|
18485
|
+
description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
18486
|
+
type: 'string',
|
|
18487
|
+
},
|
|
18488
|
+
},
|
|
18489
|
+
required: ['created_at', 'message', 'warning_code'],
|
|
18490
|
+
type: 'object',
|
|
18491
|
+
},
|
|
18492
|
+
type: 'array',
|
|
18493
|
+
},
|
|
18494
|
+
event_description: {
|
|
18495
|
+
description: '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.',
|
|
18496
|
+
type: 'string',
|
|
18497
|
+
},
|
|
18498
|
+
event_id: {
|
|
18499
|
+
description: 'ID of the event.',
|
|
18500
|
+
format: 'uuid',
|
|
18501
|
+
type: 'string',
|
|
18502
|
+
},
|
|
18503
|
+
event_type: {
|
|
18504
|
+
enum: ['access_code.failed_to_expire'],
|
|
18505
|
+
type: 'string',
|
|
18506
|
+
},
|
|
18507
|
+
occurred_at: {
|
|
18508
|
+
description: 'Date and time at which the event occurred.',
|
|
18509
|
+
format: 'date-time',
|
|
18510
|
+
type: 'string',
|
|
18511
|
+
},
|
|
18512
|
+
workspace_id: {
|
|
18513
|
+
description: 'ID of the workspace associated with the event.',
|
|
18514
|
+
format: 'uuid',
|
|
18515
|
+
type: 'string',
|
|
18516
|
+
},
|
|
18517
|
+
},
|
|
18518
|
+
required: [
|
|
18519
|
+
'event_id',
|
|
18520
|
+
'workspace_id',
|
|
18521
|
+
'created_at',
|
|
18522
|
+
'occurred_at',
|
|
18523
|
+
'access_code_id',
|
|
18524
|
+
'device_id',
|
|
18525
|
+
'connected_account_id',
|
|
18526
|
+
'event_type',
|
|
18527
|
+
'connected_account_errors',
|
|
18528
|
+
'connected_account_warnings',
|
|
18529
|
+
'device_errors',
|
|
18530
|
+
'device_warnings',
|
|
18531
|
+
'access_code_errors',
|
|
18532
|
+
'access_code_warnings',
|
|
18533
|
+
],
|
|
18534
|
+
type: 'object',
|
|
18535
|
+
'x-route-path': '/access_codes',
|
|
18536
|
+
'x-undocumented': 'Unreleased.',
|
|
18537
|
+
},
|
|
18538
|
+
{
|
|
18539
|
+
description: 'An [access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes) was deleted.',
|
|
18540
|
+
properties: {
|
|
18541
|
+
access_code_id: {
|
|
18542
|
+
description: 'ID of the affected access code.',
|
|
18543
|
+
format: 'uuid',
|
|
18544
|
+
type: 'string',
|
|
18545
|
+
},
|
|
18546
|
+
code: {
|
|
18547
|
+
description: 'Code for the affected access code.',
|
|
18548
|
+
nullable: true,
|
|
18549
|
+
type: 'string',
|
|
18550
|
+
},
|
|
18551
|
+
connected_account_custom_metadata: {
|
|
18552
|
+
additionalProperties: {
|
|
18553
|
+
oneOf: [{ type: 'string' }, { type: 'boolean' }],
|
|
18554
|
+
},
|
|
18555
|
+
description: 'Custom metadata of the connected account, present when connected_account_id is provided.',
|
|
18556
|
+
type: 'object',
|
|
18557
|
+
},
|
|
18558
|
+
connected_account_id: {
|
|
18559
|
+
description: 'ID of the connected account associated with the affected access code.',
|
|
18560
|
+
format: 'uuid',
|
|
18561
|
+
type: 'string',
|
|
18562
|
+
},
|
|
18563
|
+
created_at: {
|
|
18564
|
+
description: 'Date and time at which the event was created.',
|
|
18565
|
+
format: 'date-time',
|
|
18566
|
+
type: 'string',
|
|
18567
|
+
},
|
|
18568
|
+
device_custom_metadata: {
|
|
18569
|
+
additionalProperties: {
|
|
18570
|
+
oneOf: [{ type: 'string' }, { type: 'boolean' }],
|
|
18571
|
+
},
|
|
18572
|
+
description: 'Custom metadata of the device, present when device_id is provided.',
|
|
18573
|
+
type: 'object',
|
|
18574
|
+
},
|
|
18575
|
+
device_id: {
|
|
18576
|
+
description: 'ID of the device associated with the affected access code.',
|
|
18577
|
+
format: 'uuid',
|
|
18578
|
+
type: 'string',
|
|
18579
|
+
},
|
|
18580
|
+
event_description: {
|
|
18581
|
+
description: '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.',
|
|
18582
|
+
type: 'string',
|
|
18583
|
+
},
|
|
18584
|
+
event_id: {
|
|
18585
|
+
description: 'ID of the event.',
|
|
18586
|
+
format: 'uuid',
|
|
18587
|
+
type: 'string',
|
|
18588
|
+
},
|
|
18589
|
+
event_type: { enum: ['access_code.deleted'], type: 'string' },
|
|
18590
|
+
occurred_at: {
|
|
18591
|
+
description: 'Date and time at which the event occurred.',
|
|
18592
|
+
format: 'date-time',
|
|
18593
|
+
type: 'string',
|
|
18594
|
+
},
|
|
18595
|
+
workspace_id: {
|
|
18596
|
+
description: 'ID of the workspace associated with the event.',
|
|
18597
|
+
format: 'uuid',
|
|
18598
|
+
type: 'string',
|
|
18599
|
+
},
|
|
18600
|
+
},
|
|
18601
|
+
required: [
|
|
18602
|
+
'event_id',
|
|
18603
|
+
'workspace_id',
|
|
18604
|
+
'created_at',
|
|
18605
|
+
'occurred_at',
|
|
18606
|
+
'access_code_id',
|
|
18607
|
+
'device_id',
|
|
18608
|
+
'connected_account_id',
|
|
18609
|
+
'event_type',
|
|
18610
|
+
'code',
|
|
18611
|
+
],
|
|
18612
|
+
type: 'object',
|
|
18613
|
+
'x-route-path': '/access_codes',
|
|
18614
|
+
},
|
|
18615
|
+
{
|
|
18616
|
+
deprecated: true,
|
|
18617
|
+
description: '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.',
|
|
18618
|
+
properties: {
|
|
18619
|
+
access_code_errors: {
|
|
18620
|
+
description: 'Errors associated with the access code.',
|
|
18621
|
+
items: {
|
|
18622
|
+
description: 'Error associated with the resource, including the error code, message, and creation timestamp.',
|
|
18623
|
+
properties: {
|
|
18624
|
+
created_at: {
|
|
18625
|
+
description: 'Date and time at which Seam created the error.',
|
|
18626
|
+
format: 'date-time',
|
|
18627
|
+
type: 'string',
|
|
18628
|
+
},
|
|
18629
|
+
error_code: {
|
|
18630
|
+
description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
18631
|
+
type: 'string',
|
|
18632
|
+
},
|
|
18633
|
+
message: {
|
|
18634
|
+
description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
18635
|
+
type: 'string',
|
|
18636
|
+
},
|
|
18637
|
+
},
|
|
18638
|
+
required: ['created_at', 'message', 'error_code'],
|
|
18639
|
+
type: 'object',
|
|
18640
|
+
},
|
|
18641
|
+
type: 'array',
|
|
18642
|
+
},
|
|
18643
|
+
access_code_id: {
|
|
18644
|
+
description: 'ID of the affected access code.',
|
|
18645
|
+
format: 'uuid',
|
|
18646
|
+
type: 'string',
|
|
18647
|
+
},
|
|
18648
|
+
access_code_warnings: {
|
|
18649
|
+
description: 'Warnings associated with the access code.',
|
|
18650
|
+
items: {
|
|
18651
|
+
description: 'Warning associated with the resource, including the warning code, message, and creation timestamp.',
|
|
18652
|
+
properties: {
|
|
18653
|
+
created_at: {
|
|
18654
|
+
description: 'Date and time at which Seam created the warning.',
|
|
18655
|
+
format: 'date-time',
|
|
18656
|
+
type: 'string',
|
|
18657
|
+
},
|
|
18658
|
+
message: {
|
|
18659
|
+
description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
18660
|
+
type: 'string',
|
|
18661
|
+
},
|
|
18662
|
+
warning_code: {
|
|
18663
|
+
description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
18664
|
+
type: 'string',
|
|
18665
|
+
},
|
|
18666
|
+
},
|
|
18667
|
+
required: ['created_at', 'message', 'warning_code'],
|
|
18668
|
+
type: 'object',
|
|
18669
|
+
},
|
|
18670
|
+
type: 'array',
|
|
18671
|
+
},
|
|
18672
|
+
connected_account_custom_metadata: {
|
|
18673
|
+
additionalProperties: {
|
|
18674
|
+
oneOf: [{ type: 'string' }, { type: 'boolean' }],
|
|
18675
|
+
},
|
|
18676
|
+
description: 'Custom metadata of the connected account, present when connected_account_id is provided.',
|
|
18677
|
+
type: 'object',
|
|
18678
|
+
},
|
|
18679
|
+
connected_account_errors: {
|
|
18680
|
+
description: 'Errors associated with the connected account.',
|
|
18681
|
+
items: {
|
|
18682
|
+
description: 'Error associated with the resource, including the error code, message, and creation timestamp.',
|
|
18683
|
+
properties: {
|
|
18684
|
+
created_at: {
|
|
18685
|
+
description: 'Date and time at which Seam created the error.',
|
|
18686
|
+
format: 'date-time',
|
|
18687
|
+
type: 'string',
|
|
18688
|
+
},
|
|
18689
|
+
error_code: {
|
|
18690
|
+
description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
18691
|
+
type: 'string',
|
|
18692
|
+
},
|
|
18693
|
+
message: {
|
|
18694
|
+
description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
18695
|
+
type: 'string',
|
|
18696
|
+
},
|
|
18697
|
+
},
|
|
18698
|
+
required: ['created_at', 'message', 'error_code'],
|
|
18699
|
+
type: 'object',
|
|
18700
|
+
},
|
|
18701
|
+
type: 'array',
|
|
18702
|
+
},
|
|
18703
|
+
connected_account_id: {
|
|
18704
|
+
description: 'ID of the connected account associated with the affected access code.',
|
|
18705
|
+
format: 'uuid',
|
|
18706
|
+
type: 'string',
|
|
18707
|
+
},
|
|
18708
|
+
connected_account_warnings: {
|
|
18709
|
+
description: 'Warnings associated with the connected account.',
|
|
18710
|
+
items: {
|
|
18711
|
+
description: 'Warning associated with the resource, including the warning code, message, and creation timestamp.',
|
|
18712
|
+
properties: {
|
|
18713
|
+
created_at: {
|
|
18714
|
+
description: 'Date and time at which Seam created the warning.',
|
|
18715
|
+
format: 'date-time',
|
|
18716
|
+
type: 'string',
|
|
18717
|
+
},
|
|
18718
|
+
message: {
|
|
18719
|
+
description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
18720
|
+
type: 'string',
|
|
18721
|
+
},
|
|
18722
|
+
warning_code: {
|
|
18723
|
+
description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
18724
|
+
type: 'string',
|
|
18725
|
+
},
|
|
18726
|
+
},
|
|
18727
|
+
required: ['created_at', 'message', 'warning_code'],
|
|
18728
|
+
type: 'object',
|
|
18729
|
+
},
|
|
18730
|
+
type: 'array',
|
|
18731
|
+
},
|
|
18732
|
+
created_at: {
|
|
18733
|
+
description: 'Date and time at which the event was created.',
|
|
18734
|
+
format: 'date-time',
|
|
18735
|
+
type: 'string',
|
|
18736
|
+
},
|
|
18737
|
+
device_custom_metadata: {
|
|
18738
|
+
additionalProperties: {
|
|
18739
|
+
oneOf: [{ type: 'string' }, { type: 'boolean' }],
|
|
18740
|
+
},
|
|
18741
|
+
description: 'Custom metadata of the device, present when device_id is provided.',
|
|
18742
|
+
type: 'object',
|
|
18743
|
+
},
|
|
18744
|
+
device_errors: {
|
|
18745
|
+
description: 'Errors associated with the device.',
|
|
18746
|
+
items: {
|
|
18747
|
+
description: 'Error associated with the resource, including the error code, message, and creation timestamp.',
|
|
18748
|
+
properties: {
|
|
18749
|
+
created_at: {
|
|
18750
|
+
description: 'Date and time at which Seam created the error.',
|
|
18751
|
+
format: 'date-time',
|
|
18752
|
+
type: 'string',
|
|
18753
|
+
},
|
|
18754
|
+
error_code: {
|
|
18755
|
+
description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
18756
|
+
type: 'string',
|
|
18757
|
+
},
|
|
18758
|
+
message: {
|
|
18759
|
+
description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
18760
|
+
type: 'string',
|
|
18761
|
+
},
|
|
18762
|
+
},
|
|
18763
|
+
required: ['created_at', 'message', 'error_code'],
|
|
18764
|
+
type: 'object',
|
|
18765
|
+
},
|
|
18766
|
+
type: 'array',
|
|
18767
|
+
},
|
|
18768
|
+
device_id: {
|
|
18769
|
+
description: 'ID of the device associated with the affected access code.',
|
|
18770
|
+
format: 'uuid',
|
|
18771
|
+
type: 'string',
|
|
18772
|
+
},
|
|
18773
|
+
device_warnings: {
|
|
18774
|
+
description: 'Warnings associated with the device.',
|
|
18775
|
+
items: {
|
|
18776
|
+
description: 'Warning associated with the resource, including the warning code, message, and creation timestamp.',
|
|
18777
|
+
properties: {
|
|
18778
|
+
created_at: {
|
|
18779
|
+
description: 'Date and time at which Seam created the warning.',
|
|
18780
|
+
format: 'date-time',
|
|
18781
|
+
type: 'string',
|
|
18782
|
+
},
|
|
18783
|
+
message: {
|
|
18784
|
+
description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
18785
|
+
type: 'string',
|
|
18786
|
+
},
|
|
18787
|
+
warning_code: {
|
|
18788
|
+
description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
18789
|
+
type: 'string',
|
|
18790
|
+
},
|
|
18791
|
+
},
|
|
18792
|
+
required: ['created_at', 'message', 'warning_code'],
|
|
18793
|
+
type: 'object',
|
|
18794
|
+
},
|
|
18795
|
+
type: 'array',
|
|
18796
|
+
},
|
|
18797
|
+
event_description: {
|
|
18798
|
+
description: '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.',
|
|
18799
|
+
type: 'string',
|
|
18800
|
+
},
|
|
18801
|
+
event_id: {
|
|
18802
|
+
description: 'ID of the event.',
|
|
18803
|
+
format: 'uuid',
|
|
18804
|
+
type: 'string',
|
|
18805
|
+
},
|
|
18806
|
+
event_type: {
|
|
18807
|
+
enum: ['access_code.delay_in_removing_from_device'],
|
|
18808
|
+
type: 'string',
|
|
18809
|
+
},
|
|
18810
|
+
occurred_at: {
|
|
18811
|
+
description: 'Date and time at which the event occurred.',
|
|
18812
|
+
format: 'date-time',
|
|
18813
|
+
type: 'string',
|
|
18814
|
+
},
|
|
18815
|
+
workspace_id: {
|
|
18816
|
+
description: 'ID of the workspace associated with the event.',
|
|
18817
|
+
format: 'uuid',
|
|
18818
|
+
type: 'string',
|
|
18819
|
+
},
|
|
18820
|
+
},
|
|
18821
|
+
required: [
|
|
18822
|
+
'event_id',
|
|
18823
|
+
'workspace_id',
|
|
18824
|
+
'created_at',
|
|
18825
|
+
'occurred_at',
|
|
18826
|
+
'access_code_id',
|
|
18827
|
+
'device_id',
|
|
18828
|
+
'connected_account_id',
|
|
18829
|
+
'event_type',
|
|
18830
|
+
'connected_account_errors',
|
|
18831
|
+
'connected_account_warnings',
|
|
18832
|
+
'device_errors',
|
|
18833
|
+
'device_warnings',
|
|
18834
|
+
'access_code_errors',
|
|
18835
|
+
'access_code_warnings',
|
|
18836
|
+
],
|
|
18837
|
+
type: 'object',
|
|
18838
|
+
'x-deprecated': 'Seam no longer emits this event. Use `access_code.failed_to_remove_from_device` instead.',
|
|
18839
|
+
'x-route-path': '/access_codes',
|
|
18840
|
+
},
|
|
18841
|
+
{
|
|
18842
|
+
description: 'An [access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes) failed to be removed from a device.',
|
|
18843
|
+
properties: {
|
|
18844
|
+
access_code_errors: {
|
|
18845
|
+
description: 'Errors associated with the access code.',
|
|
18846
|
+
items: {
|
|
18847
|
+
description: 'Error associated with the resource, including the error code, message, and creation timestamp.',
|
|
18848
|
+
properties: {
|
|
18849
|
+
created_at: {
|
|
18850
|
+
description: 'Date and time at which Seam created the error.',
|
|
18851
|
+
format: 'date-time',
|
|
18852
|
+
type: 'string',
|
|
18853
|
+
},
|
|
18854
|
+
error_code: {
|
|
18855
|
+
description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
18856
|
+
type: 'string',
|
|
18857
|
+
},
|
|
18858
|
+
message: {
|
|
18859
|
+
description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
18860
|
+
type: 'string',
|
|
18861
|
+
},
|
|
18862
|
+
},
|
|
18863
|
+
required: ['created_at', 'message', 'error_code'],
|
|
18864
|
+
type: 'object',
|
|
18865
|
+
},
|
|
18866
|
+
type: 'array',
|
|
18867
|
+
},
|
|
18868
|
+
access_code_id: {
|
|
18869
|
+
description: 'ID of the affected access code.',
|
|
18870
|
+
format: 'uuid',
|
|
18871
|
+
type: 'string',
|
|
18872
|
+
},
|
|
18873
|
+
access_code_warnings: {
|
|
18874
|
+
description: 'Warnings associated with the access code.',
|
|
18875
|
+
items: {
|
|
18876
|
+
description: 'Warning associated with the resource, including the warning code, message, and creation timestamp.',
|
|
18877
|
+
properties: {
|
|
18878
|
+
created_at: {
|
|
18879
|
+
description: 'Date and time at which Seam created the warning.',
|
|
18880
|
+
format: 'date-time',
|
|
18881
|
+
type: 'string',
|
|
18882
|
+
},
|
|
18883
|
+
message: {
|
|
18884
|
+
description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
18885
|
+
type: 'string',
|
|
18886
|
+
},
|
|
18887
|
+
warning_code: {
|
|
18888
|
+
description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
18889
|
+
type: 'string',
|
|
18890
|
+
},
|
|
18891
|
+
},
|
|
18892
|
+
required: ['created_at', 'message', 'warning_code'],
|
|
18893
|
+
type: 'object',
|
|
18894
|
+
},
|
|
18895
|
+
type: 'array',
|
|
18896
|
+
},
|
|
18897
|
+
connected_account_custom_metadata: {
|
|
18898
|
+
additionalProperties: {
|
|
18899
|
+
oneOf: [{ type: 'string' }, { type: 'boolean' }],
|
|
18900
|
+
},
|
|
18901
|
+
description: 'Custom metadata of the connected account, present when connected_account_id is provided.',
|
|
18902
|
+
type: 'object',
|
|
18903
|
+
},
|
|
18904
|
+
connected_account_errors: {
|
|
18905
|
+
description: 'Errors associated with the connected account.',
|
|
18906
|
+
items: {
|
|
18907
|
+
description: 'Error associated with the resource, including the error code, message, and creation timestamp.',
|
|
18908
|
+
properties: {
|
|
18909
|
+
created_at: {
|
|
18910
|
+
description: 'Date and time at which Seam created the error.',
|
|
18911
|
+
format: 'date-time',
|
|
18912
|
+
type: 'string',
|
|
18913
|
+
},
|
|
18914
|
+
error_code: {
|
|
18915
|
+
description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
18916
|
+
type: 'string',
|
|
18917
|
+
},
|
|
18918
|
+
message: {
|
|
18919
|
+
description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
18920
|
+
type: 'string',
|
|
18921
|
+
},
|
|
18922
|
+
},
|
|
18923
|
+
required: ['created_at', 'message', 'error_code'],
|
|
18924
|
+
type: 'object',
|
|
18925
|
+
},
|
|
18926
|
+
type: 'array',
|
|
18927
|
+
},
|
|
18928
|
+
connected_account_id: {
|
|
18929
|
+
description: 'ID of the connected account associated with the affected access code.',
|
|
18930
|
+
format: 'uuid',
|
|
18931
|
+
type: 'string',
|
|
18932
|
+
},
|
|
18933
|
+
connected_account_warnings: {
|
|
18934
|
+
description: 'Warnings associated with the connected account.',
|
|
18935
|
+
items: {
|
|
18936
|
+
description: 'Warning associated with the resource, including the warning code, message, and creation timestamp.',
|
|
18937
|
+
properties: {
|
|
18938
|
+
created_at: {
|
|
18939
|
+
description: 'Date and time at which Seam created the warning.',
|
|
18940
|
+
format: 'date-time',
|
|
18941
|
+
type: 'string',
|
|
18942
|
+
},
|
|
18943
|
+
message: {
|
|
18944
|
+
description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
18945
|
+
type: 'string',
|
|
18946
|
+
},
|
|
18947
|
+
warning_code: {
|
|
18948
|
+
description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
18949
|
+
type: 'string',
|
|
18950
|
+
},
|
|
18951
|
+
},
|
|
18952
|
+
required: ['created_at', 'message', 'warning_code'],
|
|
18953
|
+
type: 'object',
|
|
18954
|
+
},
|
|
18955
|
+
type: 'array',
|
|
18956
|
+
},
|
|
18957
|
+
created_at: {
|
|
18958
|
+
description: 'Date and time at which the event was created.',
|
|
18959
|
+
format: 'date-time',
|
|
18960
|
+
type: 'string',
|
|
18961
|
+
},
|
|
18962
|
+
device_custom_metadata: {
|
|
18963
|
+
additionalProperties: {
|
|
18964
|
+
oneOf: [{ type: 'string' }, { type: 'boolean' }],
|
|
18965
|
+
},
|
|
18966
|
+
description: 'Custom metadata of the device, present when device_id is provided.',
|
|
18967
|
+
type: 'object',
|
|
18968
|
+
},
|
|
18969
|
+
device_errors: {
|
|
18970
|
+
description: 'Errors associated with the device.',
|
|
18971
|
+
items: {
|
|
18972
|
+
description: 'Error associated with the resource, including the error code, message, and creation timestamp.',
|
|
18973
|
+
properties: {
|
|
18974
|
+
created_at: {
|
|
18975
|
+
description: 'Date and time at which Seam created the error.',
|
|
18976
|
+
format: 'date-time',
|
|
18977
|
+
type: 'string',
|
|
18978
|
+
},
|
|
18979
|
+
error_code: {
|
|
18980
|
+
description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
18981
|
+
type: 'string',
|
|
18982
|
+
},
|
|
18983
|
+
message: {
|
|
18984
|
+
description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
18985
|
+
type: 'string',
|
|
18986
|
+
},
|
|
18987
|
+
},
|
|
18988
|
+
required: ['created_at', 'message', 'error_code'],
|
|
18989
|
+
type: 'object',
|
|
18990
|
+
},
|
|
18991
|
+
type: 'array',
|
|
18992
|
+
},
|
|
18993
|
+
device_id: {
|
|
18994
|
+
description: 'ID of the device associated with the affected access code.',
|
|
18995
|
+
format: 'uuid',
|
|
18996
|
+
type: 'string',
|
|
18997
|
+
},
|
|
18998
|
+
device_warnings: {
|
|
18999
|
+
description: 'Warnings associated with the device.',
|
|
19000
|
+
items: {
|
|
19001
|
+
description: 'Warning associated with the resource, including the warning code, message, and creation timestamp.',
|
|
19002
|
+
properties: {
|
|
19003
|
+
created_at: {
|
|
19004
|
+
description: 'Date and time at which Seam created the warning.',
|
|
19005
|
+
format: 'date-time',
|
|
19006
|
+
type: 'string',
|
|
19007
|
+
},
|
|
19008
|
+
message: {
|
|
19009
|
+
description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
19010
|
+
type: 'string',
|
|
19011
|
+
},
|
|
19012
|
+
warning_code: {
|
|
19013
|
+
description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
19014
|
+
type: 'string',
|
|
19015
|
+
},
|
|
19016
|
+
},
|
|
19017
|
+
required: ['created_at', 'message', 'warning_code'],
|
|
19018
|
+
type: 'object',
|
|
19019
|
+
},
|
|
19020
|
+
type: 'array',
|
|
19021
|
+
},
|
|
19022
|
+
event_description: {
|
|
19023
|
+
description: '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.',
|
|
19024
|
+
type: 'string',
|
|
19025
|
+
},
|
|
19026
|
+
event_id: {
|
|
19027
|
+
description: 'ID of the event.',
|
|
19028
|
+
format: 'uuid',
|
|
19029
|
+
type: 'string',
|
|
19030
|
+
},
|
|
19031
|
+
event_type: {
|
|
19032
|
+
enum: ['access_code.failed_to_remove_from_device'],
|
|
19033
|
+
type: 'string',
|
|
19034
|
+
},
|
|
19035
|
+
occurred_at: {
|
|
19036
|
+
description: 'Date and time at which the event occurred.',
|
|
19037
|
+
format: 'date-time',
|
|
19038
|
+
type: 'string',
|
|
19039
|
+
},
|
|
19040
|
+
workspace_id: {
|
|
19041
|
+
description: 'ID of the workspace associated with the event.',
|
|
19042
|
+
format: 'uuid',
|
|
19043
|
+
type: 'string',
|
|
19044
|
+
},
|
|
19045
|
+
},
|
|
19046
|
+
required: [
|
|
19047
|
+
'event_id',
|
|
19048
|
+
'workspace_id',
|
|
19049
|
+
'created_at',
|
|
19050
|
+
'occurred_at',
|
|
19051
|
+
'access_code_id',
|
|
19052
|
+
'device_id',
|
|
19053
|
+
'connected_account_id',
|
|
19054
|
+
'event_type',
|
|
19055
|
+
'connected_account_errors',
|
|
19056
|
+
'connected_account_warnings',
|
|
19057
|
+
'device_errors',
|
|
19058
|
+
'device_warnings',
|
|
19059
|
+
'access_code_errors',
|
|
19060
|
+
'access_code_warnings',
|
|
19061
|
+
],
|
|
19062
|
+
type: 'object',
|
|
19063
|
+
'x-route-path': '/access_codes',
|
|
19064
|
+
},
|
|
19065
|
+
{
|
|
19066
|
+
description: 'An [access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes) was modified outside of Seam.',
|
|
19067
|
+
properties: {
|
|
19068
|
+
access_code_id: {
|
|
19069
|
+
description: 'ID of the affected access code.',
|
|
19070
|
+
format: 'uuid',
|
|
19071
|
+
type: 'string',
|
|
19072
|
+
},
|
|
19073
|
+
connected_account_custom_metadata: {
|
|
19074
|
+
additionalProperties: {
|
|
19075
|
+
oneOf: [{ type: 'string' }, { type: 'boolean' }],
|
|
19076
|
+
},
|
|
19077
|
+
description: 'Custom metadata of the connected account, present when connected_account_id is provided.',
|
|
19078
|
+
type: 'object',
|
|
19079
|
+
},
|
|
19080
|
+
connected_account_id: {
|
|
19081
|
+
description: 'ID of the connected account associated with the affected access code.',
|
|
19082
|
+
format: 'uuid',
|
|
19083
|
+
type: 'string',
|
|
19084
|
+
},
|
|
19085
|
+
created_at: {
|
|
19086
|
+
description: 'Date and time at which the event was created.',
|
|
19087
|
+
format: 'date-time',
|
|
19088
|
+
type: 'string',
|
|
19089
|
+
},
|
|
19090
|
+
device_custom_metadata: {
|
|
19091
|
+
additionalProperties: {
|
|
19092
|
+
oneOf: [{ type: 'string' }, { type: 'boolean' }],
|
|
19093
|
+
},
|
|
19094
|
+
description: 'Custom metadata of the device, present when device_id is provided.',
|
|
19095
|
+
type: 'object',
|
|
19096
|
+
},
|
|
19097
|
+
device_id: {
|
|
19098
|
+
description: 'ID of the device associated with the affected access code.',
|
|
19099
|
+
format: 'uuid',
|
|
19100
|
+
type: 'string',
|
|
19101
|
+
},
|
|
19102
|
+
event_description: {
|
|
19103
|
+
description: '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.',
|
|
19104
|
+
type: 'string',
|
|
19105
|
+
},
|
|
19106
|
+
event_id: {
|
|
19107
|
+
description: 'ID of the event.',
|
|
19108
|
+
format: 'uuid',
|
|
19109
|
+
type: 'string',
|
|
19110
|
+
},
|
|
19111
|
+
event_type: {
|
|
19112
|
+
enum: ['access_code.modified_external_to_seam'],
|
|
17783
19113
|
type: 'string',
|
|
17784
19114
|
},
|
|
17785
19115
|
occurred_at: {
|
|
@@ -27358,6 +28688,90 @@ const openapi = {
|
|
|
27358
28688
|
type: 'object',
|
|
27359
28689
|
'x-resource-type': 'access_code',
|
|
27360
28690
|
},
|
|
28691
|
+
{
|
|
28692
|
+
description: '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.',
|
|
28693
|
+
properties: {
|
|
28694
|
+
created_at: {
|
|
28695
|
+
description: 'Date and time at which Seam created the error.',
|
|
28696
|
+
format: 'date-time',
|
|
28697
|
+
type: 'string',
|
|
28698
|
+
},
|
|
28699
|
+
error_code: {
|
|
28700
|
+
description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
28701
|
+
enum: ['failed_to_issue'],
|
|
28702
|
+
type: 'string',
|
|
28703
|
+
},
|
|
28704
|
+
is_access_code_error: {
|
|
28705
|
+
description: 'Indicates that this is an access code error.',
|
|
28706
|
+
enum: [true],
|
|
28707
|
+
type: 'boolean',
|
|
28708
|
+
},
|
|
28709
|
+
message: {
|
|
28710
|
+
description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
28711
|
+
type: 'string',
|
|
28712
|
+
},
|
|
28713
|
+
},
|
|
28714
|
+
required: ['message', 'is_access_code_error', 'error_code'],
|
|
28715
|
+
type: 'object',
|
|
28716
|
+
'x-resource-type': 'access_code',
|
|
28717
|
+
'x-undocumented': 'Unreleased.',
|
|
28718
|
+
},
|
|
28719
|
+
{
|
|
28720
|
+
description: "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.",
|
|
28721
|
+
properties: {
|
|
28722
|
+
created_at: {
|
|
28723
|
+
description: 'Date and time at which Seam created the error.',
|
|
28724
|
+
format: 'date-time',
|
|
28725
|
+
type: 'string',
|
|
28726
|
+
},
|
|
28727
|
+
error_code: {
|
|
28728
|
+
description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
28729
|
+
enum: ['failed_to_apply_mutations'],
|
|
28730
|
+
type: 'string',
|
|
28731
|
+
},
|
|
28732
|
+
is_access_code_error: {
|
|
28733
|
+
description: 'Indicates that this is an access code error.',
|
|
28734
|
+
enum: [true],
|
|
28735
|
+
type: 'boolean',
|
|
28736
|
+
},
|
|
28737
|
+
message: {
|
|
28738
|
+
description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
28739
|
+
type: 'string',
|
|
28740
|
+
},
|
|
28741
|
+
},
|
|
28742
|
+
required: ['message', 'is_access_code_error', 'error_code'],
|
|
28743
|
+
type: 'object',
|
|
28744
|
+
'x-resource-type': 'access_code',
|
|
28745
|
+
'x-undocumented': 'Unreleased.',
|
|
28746
|
+
},
|
|
28747
|
+
{
|
|
28748
|
+
description: '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.',
|
|
28749
|
+
properties: {
|
|
28750
|
+
created_at: {
|
|
28751
|
+
description: 'Date and time at which Seam created the error.',
|
|
28752
|
+
format: 'date-time',
|
|
28753
|
+
type: 'string',
|
|
28754
|
+
},
|
|
28755
|
+
error_code: {
|
|
28756
|
+
description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
28757
|
+
enum: ['failed_to_expire'],
|
|
28758
|
+
type: 'string',
|
|
28759
|
+
},
|
|
28760
|
+
is_access_code_error: {
|
|
28761
|
+
description: 'Indicates that this is an access code error.',
|
|
28762
|
+
enum: [true],
|
|
28763
|
+
type: 'boolean',
|
|
28764
|
+
},
|
|
28765
|
+
message: {
|
|
28766
|
+
description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
28767
|
+
type: 'string',
|
|
28768
|
+
},
|
|
28769
|
+
},
|
|
28770
|
+
required: ['message', 'is_access_code_error', 'error_code'],
|
|
28771
|
+
type: 'object',
|
|
28772
|
+
'x-resource-type': 'access_code',
|
|
28773
|
+
'x-undocumented': 'Unreleased.',
|
|
28774
|
+
},
|
|
27361
28775
|
{
|
|
27362
28776
|
description: 'Indicates that the account is disconnected.',
|
|
27363
28777
|
properties: {
|
|
@@ -28016,6 +29430,50 @@ const openapi = {
|
|
|
28016
29430
|
type: 'object',
|
|
28017
29431
|
'x-deprecated': 'Seam no longer sets this warning. Use the `failed_to_remove_from_device` error instead.',
|
|
28018
29432
|
},
|
|
29433
|
+
{
|
|
29434
|
+
description: '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.',
|
|
29435
|
+
properties: {
|
|
29436
|
+
created_at: {
|
|
29437
|
+
description: 'Date and time at which Seam created the warning.',
|
|
29438
|
+
format: 'date-time',
|
|
29439
|
+
type: 'string',
|
|
29440
|
+
},
|
|
29441
|
+
message: {
|
|
29442
|
+
description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
29443
|
+
type: 'string',
|
|
29444
|
+
},
|
|
29445
|
+
warning_code: {
|
|
29446
|
+
description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
29447
|
+
enum: ['delay_in_issuing'],
|
|
29448
|
+
type: 'string',
|
|
29449
|
+
},
|
|
29450
|
+
},
|
|
29451
|
+
required: ['message', 'warning_code'],
|
|
29452
|
+
type: 'object',
|
|
29453
|
+
'x-undocumented': 'Unreleased.',
|
|
29454
|
+
},
|
|
29455
|
+
{
|
|
29456
|
+
description: "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.",
|
|
29457
|
+
properties: {
|
|
29458
|
+
created_at: {
|
|
29459
|
+
description: 'Date and time at which Seam created the warning.',
|
|
29460
|
+
format: 'date-time',
|
|
29461
|
+
type: 'string',
|
|
29462
|
+
},
|
|
29463
|
+
message: {
|
|
29464
|
+
description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
29465
|
+
type: 'string',
|
|
29466
|
+
},
|
|
29467
|
+
warning_code: {
|
|
29468
|
+
description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
29469
|
+
enum: ['delay_in_applying_mutations'],
|
|
29470
|
+
type: 'string',
|
|
29471
|
+
},
|
|
29472
|
+
},
|
|
29473
|
+
required: ['message', 'warning_code'],
|
|
29474
|
+
type: 'object',
|
|
29475
|
+
'x-undocumented': 'Unreleased.',
|
|
29476
|
+
},
|
|
28019
29477
|
{
|
|
28020
29478
|
description: 'Third-party integration detected that may cause access codes to fail.',
|
|
28021
29479
|
properties: {
|
|
@@ -31051,6 +32509,10 @@ const openapi = {
|
|
|
31051
32509
|
},
|
|
31052
32510
|
],
|
|
31053
32511
|
},
|
|
32512
|
+
display_name: {
|
|
32513
|
+
description: '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.',
|
|
32514
|
+
type: 'string',
|
|
32515
|
+
},
|
|
31054
32516
|
errors: {
|
|
31055
32517
|
description: '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.',
|
|
31056
32518
|
items: {
|
|
@@ -32363,6 +33825,7 @@ const openapi = {
|
|
|
32363
33825
|
'warnings',
|
|
32364
33826
|
'created_at',
|
|
32365
33827
|
'custom_metadata',
|
|
33828
|
+
'display_name',
|
|
32366
33829
|
'is_managed',
|
|
32367
33830
|
'properties',
|
|
32368
33831
|
],
|
|
@@ -54262,6 +55725,12 @@ const openapi = {
|
|
|
54262
55725
|
'access_code.removed_from_device',
|
|
54263
55726
|
'access_code.delay_in_setting_on_device',
|
|
54264
55727
|
'access_code.failed_to_set_on_device',
|
|
55728
|
+
'access_code.issued',
|
|
55729
|
+
'access_code.delay_in_issuing',
|
|
55730
|
+
'access_code.failed_to_issue',
|
|
55731
|
+
'access_code.delay_in_applying_mutations',
|
|
55732
|
+
'access_code.failed_to_apply_mutations',
|
|
55733
|
+
'access_code.failed_to_expire',
|
|
54265
55734
|
'access_code.deleted',
|
|
54266
55735
|
'access_code.delay_in_removing_from_device',
|
|
54267
55736
|
'access_code.failed_to_remove_from_device',
|
|
@@ -54382,6 +55851,12 @@ const openapi = {
|
|
|
54382
55851
|
'access_code.removed_from_device',
|
|
54383
55852
|
'access_code.delay_in_setting_on_device',
|
|
54384
55853
|
'access_code.failed_to_set_on_device',
|
|
55854
|
+
'access_code.issued',
|
|
55855
|
+
'access_code.delay_in_issuing',
|
|
55856
|
+
'access_code.failed_to_issue',
|
|
55857
|
+
'access_code.delay_in_applying_mutations',
|
|
55858
|
+
'access_code.failed_to_apply_mutations',
|
|
55859
|
+
'access_code.failed_to_expire',
|
|
54385
55860
|
'access_code.deleted',
|
|
54386
55861
|
'access_code.delay_in_removing_from_device',
|
|
54387
55862
|
'access_code.failed_to_remove_from_device',
|
|
@@ -54801,6 +56276,12 @@ const openapi = {
|
|
|
54801
56276
|
'access_code.removed_from_device',
|
|
54802
56277
|
'access_code.delay_in_setting_on_device',
|
|
54803
56278
|
'access_code.failed_to_set_on_device',
|
|
56279
|
+
'access_code.issued',
|
|
56280
|
+
'access_code.delay_in_issuing',
|
|
56281
|
+
'access_code.failed_to_issue',
|
|
56282
|
+
'access_code.delay_in_applying_mutations',
|
|
56283
|
+
'access_code.failed_to_apply_mutations',
|
|
56284
|
+
'access_code.failed_to_expire',
|
|
54804
56285
|
'access_code.deleted',
|
|
54805
56286
|
'access_code.delay_in_removing_from_device',
|
|
54806
56287
|
'access_code.failed_to_remove_from_device',
|
|
@@ -54917,6 +56398,12 @@ const openapi = {
|
|
|
54917
56398
|
'access_code.removed_from_device',
|
|
54918
56399
|
'access_code.delay_in_setting_on_device',
|
|
54919
56400
|
'access_code.failed_to_set_on_device',
|
|
56401
|
+
'access_code.issued',
|
|
56402
|
+
'access_code.delay_in_issuing',
|
|
56403
|
+
'access_code.failed_to_issue',
|
|
56404
|
+
'access_code.delay_in_applying_mutations',
|
|
56405
|
+
'access_code.failed_to_apply_mutations',
|
|
56406
|
+
'access_code.failed_to_expire',
|
|
54920
56407
|
'access_code.deleted',
|
|
54921
56408
|
'access_code.delay_in_removing_from_device',
|
|
54922
56409
|
'access_code.failed_to_remove_from_device',
|
|
@@ -66925,6 +68412,12 @@ const openapi = {
|
|
|
66925
68412
|
'access_code.removed_from_device',
|
|
66926
68413
|
'access_code.delay_in_setting_on_device',
|
|
66927
68414
|
'access_code.failed_to_set_on_device',
|
|
68415
|
+
'access_code.issued',
|
|
68416
|
+
'access_code.delay_in_issuing',
|
|
68417
|
+
'access_code.failed_to_issue',
|
|
68418
|
+
'access_code.delay_in_applying_mutations',
|
|
68419
|
+
'access_code.failed_to_apply_mutations',
|
|
68420
|
+
'access_code.failed_to_expire',
|
|
66928
68421
|
'access_code.deleted',
|
|
66929
68422
|
'access_code.delay_in_removing_from_device',
|
|
66930
68423
|
'access_code.failed_to_remove_from_device',
|
|
@@ -67046,6 +68539,12 @@ const openapi = {
|
|
|
67046
68539
|
'access_code.removed_from_device',
|
|
67047
68540
|
'access_code.delay_in_setting_on_device',
|
|
67048
68541
|
'access_code.failed_to_set_on_device',
|
|
68542
|
+
'access_code.issued',
|
|
68543
|
+
'access_code.delay_in_issuing',
|
|
68544
|
+
'access_code.failed_to_issue',
|
|
68545
|
+
'access_code.delay_in_applying_mutations',
|
|
68546
|
+
'access_code.failed_to_apply_mutations',
|
|
68547
|
+
'access_code.failed_to_expire',
|
|
67049
68548
|
'access_code.deleted',
|
|
67050
68549
|
'access_code.delay_in_removing_from_device',
|
|
67051
68550
|
'access_code.failed_to_remove_from_device',
|
|
@@ -67226,6 +68725,12 @@ const openapi = {
|
|
|
67226
68725
|
'access_code.removed_from_device',
|
|
67227
68726
|
'access_code.delay_in_setting_on_device',
|
|
67228
68727
|
'access_code.failed_to_set_on_device',
|
|
68728
|
+
'access_code.issued',
|
|
68729
|
+
'access_code.delay_in_issuing',
|
|
68730
|
+
'access_code.failed_to_issue',
|
|
68731
|
+
'access_code.delay_in_applying_mutations',
|
|
68732
|
+
'access_code.failed_to_apply_mutations',
|
|
68733
|
+
'access_code.failed_to_expire',
|
|
67229
68734
|
'access_code.deleted',
|
|
67230
68735
|
'access_code.delay_in_removing_from_device',
|
|
67231
68736
|
'access_code.failed_to_remove_from_device',
|
|
@@ -67342,6 +68847,12 @@ const openapi = {
|
|
|
67342
68847
|
'access_code.removed_from_device',
|
|
67343
68848
|
'access_code.delay_in_setting_on_device',
|
|
67344
68849
|
'access_code.failed_to_set_on_device',
|
|
68850
|
+
'access_code.issued',
|
|
68851
|
+
'access_code.delay_in_issuing',
|
|
68852
|
+
'access_code.failed_to_issue',
|
|
68853
|
+
'access_code.delay_in_applying_mutations',
|
|
68854
|
+
'access_code.failed_to_apply_mutations',
|
|
68855
|
+
'access_code.failed_to_expire',
|
|
67345
68856
|
'access_code.deleted',
|
|
67346
68857
|
'access_code.delay_in_removing_from_device',
|
|
67347
68858
|
'access_code.failed_to_remove_from_device',
|