@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.
- 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/device-metadata.d.ts +0 -15
- package/lib/seam/connect/models/devices/device-metadata.js +0 -12
- package/lib/seam/connect/models/devices/device-metadata.js.map +1 -1
- package/lib/seam/connect/models/devices/device.d.ts +0 -21
- package/lib/seam/connect/models/devices/unmanaged-device.d.ts +0 -15
- 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 +1517 -32
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +2195 -134
- 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/device-metadata.ts +0 -18
- package/src/lib/seam/connect/models/events/access-codes.ts +99 -0
- package/src/lib/seam/connect/openapi.ts +1715 -31
- package/src/lib/seam/connect/route-types.ts +2493 -284
|
@@ -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: {
|
|
@@ -13693,27 +13821,6 @@ const openapi = {
|
|
|
13693
13821
|
description: 'Set to true when the device does not support the /dual-setpoints API endpoint.',
|
|
13694
13822
|
type: 'boolean',
|
|
13695
13823
|
},
|
|
13696
|
-
enforced_cooling_setpoint_range_celsius: {
|
|
13697
|
-
description: 'Enforced cooling setpoint range in Celsius for a Sensi device, derived from an OutOfRange API error.',
|
|
13698
|
-
items: { format: 'float', type: 'number' },
|
|
13699
|
-
maxItems: 2,
|
|
13700
|
-
minItems: 2,
|
|
13701
|
-
type: 'array',
|
|
13702
|
-
},
|
|
13703
|
-
enforced_heating_setpoint_range_celsius: {
|
|
13704
|
-
description: 'Enforced heating setpoint range in Celsius for a Sensi device, derived from an OutOfRange API error.',
|
|
13705
|
-
items: { format: 'float', type: 'number' },
|
|
13706
|
-
maxItems: 2,
|
|
13707
|
-
minItems: 2,
|
|
13708
|
-
type: 'array',
|
|
13709
|
-
},
|
|
13710
|
-
enforced_setpoint_range_celsius: {
|
|
13711
|
-
description: '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.',
|
|
13712
|
-
items: { format: 'float', type: 'number' },
|
|
13713
|
-
maxItems: 2,
|
|
13714
|
-
minItems: 2,
|
|
13715
|
-
type: 'array',
|
|
13716
|
-
},
|
|
13717
13824
|
product_type: {
|
|
13718
13825
|
description: 'Product type for a Sensi device.',
|
|
13719
13826
|
type: 'string',
|
|
@@ -17206,7 +17313,7 @@ const openapi = {
|
|
|
17206
17313
|
'x-route-path': '/access_codes',
|
|
17207
17314
|
},
|
|
17208
17315
|
{
|
|
17209
|
-
description: 'An [access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes) was
|
|
17316
|
+
description: 'An [access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes) was issued.',
|
|
17210
17317
|
properties: {
|
|
17211
17318
|
access_code_id: {
|
|
17212
17319
|
description: 'ID of the affected access code.',
|
|
@@ -17215,7 +17322,6 @@ const openapi = {
|
|
|
17215
17322
|
},
|
|
17216
17323
|
code: {
|
|
17217
17324
|
description: 'Code for the affected access code.',
|
|
17218
|
-
nullable: true,
|
|
17219
17325
|
type: 'string',
|
|
17220
17326
|
},
|
|
17221
17327
|
connected_account_custom_metadata: {
|
|
@@ -17256,7 +17362,7 @@ const openapi = {
|
|
|
17256
17362
|
format: 'uuid',
|
|
17257
17363
|
type: 'string',
|
|
17258
17364
|
},
|
|
17259
|
-
event_type: { enum: ['access_code.
|
|
17365
|
+
event_type: { enum: ['access_code.issued'], type: 'string' },
|
|
17260
17366
|
occurred_at: {
|
|
17261
17367
|
description: 'Date and time at which the event occurred.',
|
|
17262
17368
|
format: 'date-time',
|
|
@@ -17281,10 +17387,10 @@ const openapi = {
|
|
|
17281
17387
|
],
|
|
17282
17388
|
type: 'object',
|
|
17283
17389
|
'x-route-path': '/access_codes',
|
|
17390
|
+
'x-undocumented': 'Unreleased.',
|
|
17284
17391
|
},
|
|
17285
17392
|
{
|
|
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.',
|
|
17393
|
+
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
17394
|
properties: {
|
|
17289
17395
|
access_code_errors: {
|
|
17290
17396
|
description: 'Errors associated with the access code.',
|
|
@@ -17474,7 +17580,7 @@ const openapi = {
|
|
|
17474
17580
|
type: 'string',
|
|
17475
17581
|
},
|
|
17476
17582
|
event_type: {
|
|
17477
|
-
enum: ['access_code.
|
|
17583
|
+
enum: ['access_code.delay_in_issuing'],
|
|
17478
17584
|
type: 'string',
|
|
17479
17585
|
},
|
|
17480
17586
|
occurred_at: {
|
|
@@ -17505,11 +17611,11 @@ const openapi = {
|
|
|
17505
17611
|
'access_code_warnings',
|
|
17506
17612
|
],
|
|
17507
17613
|
type: 'object',
|
|
17508
|
-
'x-deprecated': 'Seam no longer emits this event. Use `access_code.failed_to_remove_from_device` instead.',
|
|
17509
17614
|
'x-route-path': '/access_codes',
|
|
17615
|
+
'x-undocumented': 'Unreleased.',
|
|
17510
17616
|
},
|
|
17511
17617
|
{
|
|
17512
|
-
description: '
|
|
17618
|
+
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
17619
|
properties: {
|
|
17514
17620
|
access_code_errors: {
|
|
17515
17621
|
description: 'Errors associated with the access code.',
|
|
@@ -17699,7 +17805,7 @@ const openapi = {
|
|
|
17699
17805
|
type: 'string',
|
|
17700
17806
|
},
|
|
17701
17807
|
event_type: {
|
|
17702
|
-
enum: ['access_code.
|
|
17808
|
+
enum: ['access_code.failed_to_issue'],
|
|
17703
17809
|
type: 'string',
|
|
17704
17810
|
},
|
|
17705
17811
|
occurred_at: {
|
|
@@ -17731,15 +17837,64 @@ const openapi = {
|
|
|
17731
17837
|
],
|
|
17732
17838
|
type: 'object',
|
|
17733
17839
|
'x-route-path': '/access_codes',
|
|
17840
|
+
'x-undocumented': 'Unreleased.',
|
|
17734
17841
|
},
|
|
17735
17842
|
{
|
|
17736
|
-
description:
|
|
17843
|
+
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
17844
|
properties: {
|
|
17845
|
+
access_code_errors: {
|
|
17846
|
+
description: 'Errors associated with the access code.',
|
|
17847
|
+
items: {
|
|
17848
|
+
description: 'Error associated with the resource, including the error code, message, and creation timestamp.',
|
|
17849
|
+
properties: {
|
|
17850
|
+
created_at: {
|
|
17851
|
+
description: 'Date and time at which Seam created the error.',
|
|
17852
|
+
format: 'date-time',
|
|
17853
|
+
type: 'string',
|
|
17854
|
+
},
|
|
17855
|
+
error_code: {
|
|
17856
|
+
description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
17857
|
+
type: 'string',
|
|
17858
|
+
},
|
|
17859
|
+
message: {
|
|
17860
|
+
description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
17861
|
+
type: 'string',
|
|
17862
|
+
},
|
|
17863
|
+
},
|
|
17864
|
+
required: ['created_at', 'message', 'error_code'],
|
|
17865
|
+
type: 'object',
|
|
17866
|
+
},
|
|
17867
|
+
type: 'array',
|
|
17868
|
+
},
|
|
17738
17869
|
access_code_id: {
|
|
17739
17870
|
description: 'ID of the affected access code.',
|
|
17740
17871
|
format: 'uuid',
|
|
17741
17872
|
type: 'string',
|
|
17742
17873
|
},
|
|
17874
|
+
access_code_warnings: {
|
|
17875
|
+
description: 'Warnings associated with the access code.',
|
|
17876
|
+
items: {
|
|
17877
|
+
description: 'Warning associated with the resource, including the warning code, message, and creation timestamp.',
|
|
17878
|
+
properties: {
|
|
17879
|
+
created_at: {
|
|
17880
|
+
description: 'Date and time at which Seam created the warning.',
|
|
17881
|
+
format: 'date-time',
|
|
17882
|
+
type: 'string',
|
|
17883
|
+
},
|
|
17884
|
+
message: {
|
|
17885
|
+
description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
17886
|
+
type: 'string',
|
|
17887
|
+
},
|
|
17888
|
+
warning_code: {
|
|
17889
|
+
description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
17890
|
+
type: 'string',
|
|
17891
|
+
},
|
|
17892
|
+
},
|
|
17893
|
+
required: ['created_at', 'message', 'warning_code'],
|
|
17894
|
+
type: 'object',
|
|
17895
|
+
},
|
|
17896
|
+
type: 'array',
|
|
17897
|
+
},
|
|
17743
17898
|
connected_account_custom_metadata: {
|
|
17744
17899
|
additionalProperties: {
|
|
17745
17900
|
oneOf: [{ type: 'string' }, { type: 'boolean' }],
|
|
@@ -17747,11 +17902,59 @@ const openapi = {
|
|
|
17747
17902
|
description: 'Custom metadata of the connected account, present when connected_account_id is provided.',
|
|
17748
17903
|
type: 'object',
|
|
17749
17904
|
},
|
|
17905
|
+
connected_account_errors: {
|
|
17906
|
+
description: 'Errors associated with the connected account.',
|
|
17907
|
+
items: {
|
|
17908
|
+
description: 'Error associated with the resource, including the error code, message, and creation timestamp.',
|
|
17909
|
+
properties: {
|
|
17910
|
+
created_at: {
|
|
17911
|
+
description: 'Date and time at which Seam created the error.',
|
|
17912
|
+
format: 'date-time',
|
|
17913
|
+
type: 'string',
|
|
17914
|
+
},
|
|
17915
|
+
error_code: {
|
|
17916
|
+
description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
17917
|
+
type: 'string',
|
|
17918
|
+
},
|
|
17919
|
+
message: {
|
|
17920
|
+
description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
17921
|
+
type: 'string',
|
|
17922
|
+
},
|
|
17923
|
+
},
|
|
17924
|
+
required: ['created_at', 'message', 'error_code'],
|
|
17925
|
+
type: 'object',
|
|
17926
|
+
},
|
|
17927
|
+
type: 'array',
|
|
17928
|
+
},
|
|
17750
17929
|
connected_account_id: {
|
|
17751
17930
|
description: 'ID of the connected account associated with the affected access code.',
|
|
17752
17931
|
format: 'uuid',
|
|
17753
17932
|
type: 'string',
|
|
17754
17933
|
},
|
|
17934
|
+
connected_account_warnings: {
|
|
17935
|
+
description: 'Warnings associated with the connected account.',
|
|
17936
|
+
items: {
|
|
17937
|
+
description: 'Warning associated with the resource, including the warning code, message, and creation timestamp.',
|
|
17938
|
+
properties: {
|
|
17939
|
+
created_at: {
|
|
17940
|
+
description: 'Date and time at which Seam created the warning.',
|
|
17941
|
+
format: 'date-time',
|
|
17942
|
+
type: 'string',
|
|
17943
|
+
},
|
|
17944
|
+
message: {
|
|
17945
|
+
description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
17946
|
+
type: 'string',
|
|
17947
|
+
},
|
|
17948
|
+
warning_code: {
|
|
17949
|
+
description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
17950
|
+
type: 'string',
|
|
17951
|
+
},
|
|
17952
|
+
},
|
|
17953
|
+
required: ['created_at', 'message', 'warning_code'],
|
|
17954
|
+
type: 'object',
|
|
17955
|
+
},
|
|
17956
|
+
type: 'array',
|
|
17957
|
+
},
|
|
17755
17958
|
created_at: {
|
|
17756
17959
|
description: 'Date and time at which the event was created.',
|
|
17757
17960
|
format: 'date-time',
|
|
@@ -17764,11 +17967,59 @@ const openapi = {
|
|
|
17764
17967
|
description: 'Custom metadata of the device, present when device_id is provided.',
|
|
17765
17968
|
type: 'object',
|
|
17766
17969
|
},
|
|
17970
|
+
device_errors: {
|
|
17971
|
+
description: 'Errors associated with the device.',
|
|
17972
|
+
items: {
|
|
17973
|
+
description: 'Error associated with the resource, including the error code, message, and creation timestamp.',
|
|
17974
|
+
properties: {
|
|
17975
|
+
created_at: {
|
|
17976
|
+
description: 'Date and time at which Seam created the error.',
|
|
17977
|
+
format: 'date-time',
|
|
17978
|
+
type: 'string',
|
|
17979
|
+
},
|
|
17980
|
+
error_code: {
|
|
17981
|
+
description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
17982
|
+
type: 'string',
|
|
17983
|
+
},
|
|
17984
|
+
message: {
|
|
17985
|
+
description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
17986
|
+
type: 'string',
|
|
17987
|
+
},
|
|
17988
|
+
},
|
|
17989
|
+
required: ['created_at', 'message', 'error_code'],
|
|
17990
|
+
type: 'object',
|
|
17991
|
+
},
|
|
17992
|
+
type: 'array',
|
|
17993
|
+
},
|
|
17767
17994
|
device_id: {
|
|
17768
17995
|
description: 'ID of the device associated with the affected access code.',
|
|
17769
17996
|
format: 'uuid',
|
|
17770
17997
|
type: 'string',
|
|
17771
17998
|
},
|
|
17999
|
+
device_warnings: {
|
|
18000
|
+
description: 'Warnings associated with the device.',
|
|
18001
|
+
items: {
|
|
18002
|
+
description: 'Warning associated with the resource, including the warning code, message, and creation timestamp.',
|
|
18003
|
+
properties: {
|
|
18004
|
+
created_at: {
|
|
18005
|
+
description: 'Date and time at which Seam created the warning.',
|
|
18006
|
+
format: 'date-time',
|
|
18007
|
+
type: 'string',
|
|
18008
|
+
},
|
|
18009
|
+
message: {
|
|
18010
|
+
description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
18011
|
+
type: 'string',
|
|
18012
|
+
},
|
|
18013
|
+
warning_code: {
|
|
18014
|
+
description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
18015
|
+
type: 'string',
|
|
18016
|
+
},
|
|
18017
|
+
},
|
|
18018
|
+
required: ['created_at', 'message', 'warning_code'],
|
|
18019
|
+
type: 'object',
|
|
18020
|
+
},
|
|
18021
|
+
type: 'array',
|
|
18022
|
+
},
|
|
17772
18023
|
event_description: {
|
|
17773
18024
|
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
18025
|
type: 'string',
|
|
@@ -17779,7 +18030,1065 @@ const openapi = {
|
|
|
17779
18030
|
type: 'string',
|
|
17780
18031
|
},
|
|
17781
18032
|
event_type: {
|
|
17782
|
-
enum: ['access_code.
|
|
18033
|
+
enum: ['access_code.delay_in_applying_mutations'],
|
|
18034
|
+
type: 'string',
|
|
18035
|
+
},
|
|
18036
|
+
occurred_at: {
|
|
18037
|
+
description: 'Date and time at which the event occurred.',
|
|
18038
|
+
format: 'date-time',
|
|
18039
|
+
type: 'string',
|
|
18040
|
+
},
|
|
18041
|
+
workspace_id: {
|
|
18042
|
+
description: 'ID of the workspace associated with the event.',
|
|
18043
|
+
format: 'uuid',
|
|
18044
|
+
type: 'string',
|
|
18045
|
+
},
|
|
18046
|
+
},
|
|
18047
|
+
required: [
|
|
18048
|
+
'event_id',
|
|
18049
|
+
'workspace_id',
|
|
18050
|
+
'created_at',
|
|
18051
|
+
'occurred_at',
|
|
18052
|
+
'access_code_id',
|
|
18053
|
+
'device_id',
|
|
18054
|
+
'connected_account_id',
|
|
18055
|
+
'event_type',
|
|
18056
|
+
'connected_account_errors',
|
|
18057
|
+
'connected_account_warnings',
|
|
18058
|
+
'device_errors',
|
|
18059
|
+
'device_warnings',
|
|
18060
|
+
'access_code_errors',
|
|
18061
|
+
'access_code_warnings',
|
|
18062
|
+
],
|
|
18063
|
+
type: 'object',
|
|
18064
|
+
'x-route-path': '/access_codes',
|
|
18065
|
+
'x-undocumented': 'Unreleased.',
|
|
18066
|
+
},
|
|
18067
|
+
{
|
|
18068
|
+
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.",
|
|
18069
|
+
properties: {
|
|
18070
|
+
access_code_errors: {
|
|
18071
|
+
description: 'Errors associated with the access code.',
|
|
18072
|
+
items: {
|
|
18073
|
+
description: 'Error associated with the resource, including the error code, message, and creation timestamp.',
|
|
18074
|
+
properties: {
|
|
18075
|
+
created_at: {
|
|
18076
|
+
description: 'Date and time at which Seam created the error.',
|
|
18077
|
+
format: 'date-time',
|
|
18078
|
+
type: 'string',
|
|
18079
|
+
},
|
|
18080
|
+
error_code: {
|
|
18081
|
+
description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
18082
|
+
type: 'string',
|
|
18083
|
+
},
|
|
18084
|
+
message: {
|
|
18085
|
+
description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
18086
|
+
type: 'string',
|
|
18087
|
+
},
|
|
18088
|
+
},
|
|
18089
|
+
required: ['created_at', 'message', 'error_code'],
|
|
18090
|
+
type: 'object',
|
|
18091
|
+
},
|
|
18092
|
+
type: 'array',
|
|
18093
|
+
},
|
|
18094
|
+
access_code_id: {
|
|
18095
|
+
description: 'ID of the affected access code.',
|
|
18096
|
+
format: 'uuid',
|
|
18097
|
+
type: 'string',
|
|
18098
|
+
},
|
|
18099
|
+
access_code_warnings: {
|
|
18100
|
+
description: 'Warnings associated with the access code.',
|
|
18101
|
+
items: {
|
|
18102
|
+
description: 'Warning associated with the resource, including the warning code, message, and creation timestamp.',
|
|
18103
|
+
properties: {
|
|
18104
|
+
created_at: {
|
|
18105
|
+
description: 'Date and time at which Seam created the warning.',
|
|
18106
|
+
format: 'date-time',
|
|
18107
|
+
type: 'string',
|
|
18108
|
+
},
|
|
18109
|
+
message: {
|
|
18110
|
+
description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
18111
|
+
type: 'string',
|
|
18112
|
+
},
|
|
18113
|
+
warning_code: {
|
|
18114
|
+
description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
18115
|
+
type: 'string',
|
|
18116
|
+
},
|
|
18117
|
+
},
|
|
18118
|
+
required: ['created_at', 'message', 'warning_code'],
|
|
18119
|
+
type: 'object',
|
|
18120
|
+
},
|
|
18121
|
+
type: 'array',
|
|
18122
|
+
},
|
|
18123
|
+
connected_account_custom_metadata: {
|
|
18124
|
+
additionalProperties: {
|
|
18125
|
+
oneOf: [{ type: 'string' }, { type: 'boolean' }],
|
|
18126
|
+
},
|
|
18127
|
+
description: 'Custom metadata of the connected account, present when connected_account_id is provided.',
|
|
18128
|
+
type: 'object',
|
|
18129
|
+
},
|
|
18130
|
+
connected_account_errors: {
|
|
18131
|
+
description: 'Errors associated with the connected account.',
|
|
18132
|
+
items: {
|
|
18133
|
+
description: 'Error associated with the resource, including the error code, message, and creation timestamp.',
|
|
18134
|
+
properties: {
|
|
18135
|
+
created_at: {
|
|
18136
|
+
description: 'Date and time at which Seam created the error.',
|
|
18137
|
+
format: 'date-time',
|
|
18138
|
+
type: 'string',
|
|
18139
|
+
},
|
|
18140
|
+
error_code: {
|
|
18141
|
+
description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
18142
|
+
type: 'string',
|
|
18143
|
+
},
|
|
18144
|
+
message: {
|
|
18145
|
+
description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
18146
|
+
type: 'string',
|
|
18147
|
+
},
|
|
18148
|
+
},
|
|
18149
|
+
required: ['created_at', 'message', 'error_code'],
|
|
18150
|
+
type: 'object',
|
|
18151
|
+
},
|
|
18152
|
+
type: 'array',
|
|
18153
|
+
},
|
|
18154
|
+
connected_account_id: {
|
|
18155
|
+
description: 'ID of the connected account associated with the affected access code.',
|
|
18156
|
+
format: 'uuid',
|
|
18157
|
+
type: 'string',
|
|
18158
|
+
},
|
|
18159
|
+
connected_account_warnings: {
|
|
18160
|
+
description: 'Warnings associated with the connected account.',
|
|
18161
|
+
items: {
|
|
18162
|
+
description: 'Warning associated with the resource, including the warning code, message, and creation timestamp.',
|
|
18163
|
+
properties: {
|
|
18164
|
+
created_at: {
|
|
18165
|
+
description: 'Date and time at which Seam created the warning.',
|
|
18166
|
+
format: 'date-time',
|
|
18167
|
+
type: 'string',
|
|
18168
|
+
},
|
|
18169
|
+
message: {
|
|
18170
|
+
description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
18171
|
+
type: 'string',
|
|
18172
|
+
},
|
|
18173
|
+
warning_code: {
|
|
18174
|
+
description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
18175
|
+
type: 'string',
|
|
18176
|
+
},
|
|
18177
|
+
},
|
|
18178
|
+
required: ['created_at', 'message', 'warning_code'],
|
|
18179
|
+
type: 'object',
|
|
18180
|
+
},
|
|
18181
|
+
type: 'array',
|
|
18182
|
+
},
|
|
18183
|
+
created_at: {
|
|
18184
|
+
description: 'Date and time at which the event was created.',
|
|
18185
|
+
format: 'date-time',
|
|
18186
|
+
type: 'string',
|
|
18187
|
+
},
|
|
18188
|
+
device_custom_metadata: {
|
|
18189
|
+
additionalProperties: {
|
|
18190
|
+
oneOf: [{ type: 'string' }, { type: 'boolean' }],
|
|
18191
|
+
},
|
|
18192
|
+
description: 'Custom metadata of the device, present when device_id is provided.',
|
|
18193
|
+
type: 'object',
|
|
18194
|
+
},
|
|
18195
|
+
device_errors: {
|
|
18196
|
+
description: 'Errors associated with the device.',
|
|
18197
|
+
items: {
|
|
18198
|
+
description: 'Error associated with the resource, including the error code, message, and creation timestamp.',
|
|
18199
|
+
properties: {
|
|
18200
|
+
created_at: {
|
|
18201
|
+
description: 'Date and time at which Seam created the error.',
|
|
18202
|
+
format: 'date-time',
|
|
18203
|
+
type: 'string',
|
|
18204
|
+
},
|
|
18205
|
+
error_code: {
|
|
18206
|
+
description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
18207
|
+
type: 'string',
|
|
18208
|
+
},
|
|
18209
|
+
message: {
|
|
18210
|
+
description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
18211
|
+
type: 'string',
|
|
18212
|
+
},
|
|
18213
|
+
},
|
|
18214
|
+
required: ['created_at', 'message', 'error_code'],
|
|
18215
|
+
type: 'object',
|
|
18216
|
+
},
|
|
18217
|
+
type: 'array',
|
|
18218
|
+
},
|
|
18219
|
+
device_id: {
|
|
18220
|
+
description: 'ID of the device associated with the affected access code.',
|
|
18221
|
+
format: 'uuid',
|
|
18222
|
+
type: 'string',
|
|
18223
|
+
},
|
|
18224
|
+
device_warnings: {
|
|
18225
|
+
description: 'Warnings associated with the device.',
|
|
18226
|
+
items: {
|
|
18227
|
+
description: 'Warning associated with the resource, including the warning code, message, and creation timestamp.',
|
|
18228
|
+
properties: {
|
|
18229
|
+
created_at: {
|
|
18230
|
+
description: 'Date and time at which Seam created the warning.',
|
|
18231
|
+
format: 'date-time',
|
|
18232
|
+
type: 'string',
|
|
18233
|
+
},
|
|
18234
|
+
message: {
|
|
18235
|
+
description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
18236
|
+
type: 'string',
|
|
18237
|
+
},
|
|
18238
|
+
warning_code: {
|
|
18239
|
+
description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
18240
|
+
type: 'string',
|
|
18241
|
+
},
|
|
18242
|
+
},
|
|
18243
|
+
required: ['created_at', 'message', 'warning_code'],
|
|
18244
|
+
type: 'object',
|
|
18245
|
+
},
|
|
18246
|
+
type: 'array',
|
|
18247
|
+
},
|
|
18248
|
+
event_description: {
|
|
18249
|
+
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.',
|
|
18250
|
+
type: 'string',
|
|
18251
|
+
},
|
|
18252
|
+
event_id: {
|
|
18253
|
+
description: 'ID of the event.',
|
|
18254
|
+
format: 'uuid',
|
|
18255
|
+
type: 'string',
|
|
18256
|
+
},
|
|
18257
|
+
event_type: {
|
|
18258
|
+
enum: ['access_code.failed_to_apply_mutations'],
|
|
18259
|
+
type: 'string',
|
|
18260
|
+
},
|
|
18261
|
+
occurred_at: {
|
|
18262
|
+
description: 'Date and time at which the event occurred.',
|
|
18263
|
+
format: 'date-time',
|
|
18264
|
+
type: 'string',
|
|
18265
|
+
},
|
|
18266
|
+
workspace_id: {
|
|
18267
|
+
description: 'ID of the workspace associated with the event.',
|
|
18268
|
+
format: 'uuid',
|
|
18269
|
+
type: 'string',
|
|
18270
|
+
},
|
|
18271
|
+
},
|
|
18272
|
+
required: [
|
|
18273
|
+
'event_id',
|
|
18274
|
+
'workspace_id',
|
|
18275
|
+
'created_at',
|
|
18276
|
+
'occurred_at',
|
|
18277
|
+
'access_code_id',
|
|
18278
|
+
'device_id',
|
|
18279
|
+
'connected_account_id',
|
|
18280
|
+
'event_type',
|
|
18281
|
+
'connected_account_errors',
|
|
18282
|
+
'connected_account_warnings',
|
|
18283
|
+
'device_errors',
|
|
18284
|
+
'device_warnings',
|
|
18285
|
+
'access_code_errors',
|
|
18286
|
+
'access_code_warnings',
|
|
18287
|
+
],
|
|
18288
|
+
type: 'object',
|
|
18289
|
+
'x-route-path': '/access_codes',
|
|
18290
|
+
'x-undocumented': 'Unreleased.',
|
|
18291
|
+
},
|
|
18292
|
+
{
|
|
18293
|
+
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.',
|
|
18294
|
+
properties: {
|
|
18295
|
+
access_code_errors: {
|
|
18296
|
+
description: 'Errors associated with the access code.',
|
|
18297
|
+
items: {
|
|
18298
|
+
description: 'Error associated with the resource, including the error code, message, and creation timestamp.',
|
|
18299
|
+
properties: {
|
|
18300
|
+
created_at: {
|
|
18301
|
+
description: 'Date and time at which Seam created the error.',
|
|
18302
|
+
format: 'date-time',
|
|
18303
|
+
type: 'string',
|
|
18304
|
+
},
|
|
18305
|
+
error_code: {
|
|
18306
|
+
description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
18307
|
+
type: 'string',
|
|
18308
|
+
},
|
|
18309
|
+
message: {
|
|
18310
|
+
description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
18311
|
+
type: 'string',
|
|
18312
|
+
},
|
|
18313
|
+
},
|
|
18314
|
+
required: ['created_at', 'message', 'error_code'],
|
|
18315
|
+
type: 'object',
|
|
18316
|
+
},
|
|
18317
|
+
type: 'array',
|
|
18318
|
+
},
|
|
18319
|
+
access_code_id: {
|
|
18320
|
+
description: 'ID of the affected access code.',
|
|
18321
|
+
format: 'uuid',
|
|
18322
|
+
type: 'string',
|
|
18323
|
+
},
|
|
18324
|
+
access_code_warnings: {
|
|
18325
|
+
description: 'Warnings associated with the access code.',
|
|
18326
|
+
items: {
|
|
18327
|
+
description: 'Warning associated with the resource, including the warning code, message, and creation timestamp.',
|
|
18328
|
+
properties: {
|
|
18329
|
+
created_at: {
|
|
18330
|
+
description: 'Date and time at which Seam created the warning.',
|
|
18331
|
+
format: 'date-time',
|
|
18332
|
+
type: 'string',
|
|
18333
|
+
},
|
|
18334
|
+
message: {
|
|
18335
|
+
description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
18336
|
+
type: 'string',
|
|
18337
|
+
},
|
|
18338
|
+
warning_code: {
|
|
18339
|
+
description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
18340
|
+
type: 'string',
|
|
18341
|
+
},
|
|
18342
|
+
},
|
|
18343
|
+
required: ['created_at', 'message', 'warning_code'],
|
|
18344
|
+
type: 'object',
|
|
18345
|
+
},
|
|
18346
|
+
type: 'array',
|
|
18347
|
+
},
|
|
18348
|
+
connected_account_custom_metadata: {
|
|
18349
|
+
additionalProperties: {
|
|
18350
|
+
oneOf: [{ type: 'string' }, { type: 'boolean' }],
|
|
18351
|
+
},
|
|
18352
|
+
description: 'Custom metadata of the connected account, present when connected_account_id is provided.',
|
|
18353
|
+
type: 'object',
|
|
18354
|
+
},
|
|
18355
|
+
connected_account_errors: {
|
|
18356
|
+
description: 'Errors associated with the connected account.',
|
|
18357
|
+
items: {
|
|
18358
|
+
description: 'Error associated with the resource, including the error code, message, and creation timestamp.',
|
|
18359
|
+
properties: {
|
|
18360
|
+
created_at: {
|
|
18361
|
+
description: 'Date and time at which Seam created the error.',
|
|
18362
|
+
format: 'date-time',
|
|
18363
|
+
type: 'string',
|
|
18364
|
+
},
|
|
18365
|
+
error_code: {
|
|
18366
|
+
description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
18367
|
+
type: 'string',
|
|
18368
|
+
},
|
|
18369
|
+
message: {
|
|
18370
|
+
description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
18371
|
+
type: 'string',
|
|
18372
|
+
},
|
|
18373
|
+
},
|
|
18374
|
+
required: ['created_at', 'message', 'error_code'],
|
|
18375
|
+
type: 'object',
|
|
18376
|
+
},
|
|
18377
|
+
type: 'array',
|
|
18378
|
+
},
|
|
18379
|
+
connected_account_id: {
|
|
18380
|
+
description: 'ID of the connected account associated with the affected access code.',
|
|
18381
|
+
format: 'uuid',
|
|
18382
|
+
type: 'string',
|
|
18383
|
+
},
|
|
18384
|
+
connected_account_warnings: {
|
|
18385
|
+
description: 'Warnings associated with the connected account.',
|
|
18386
|
+
items: {
|
|
18387
|
+
description: 'Warning associated with the resource, including the warning code, message, and creation timestamp.',
|
|
18388
|
+
properties: {
|
|
18389
|
+
created_at: {
|
|
18390
|
+
description: 'Date and time at which Seam created the warning.',
|
|
18391
|
+
format: 'date-time',
|
|
18392
|
+
type: 'string',
|
|
18393
|
+
},
|
|
18394
|
+
message: {
|
|
18395
|
+
description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
18396
|
+
type: 'string',
|
|
18397
|
+
},
|
|
18398
|
+
warning_code: {
|
|
18399
|
+
description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
18400
|
+
type: 'string',
|
|
18401
|
+
},
|
|
18402
|
+
},
|
|
18403
|
+
required: ['created_at', 'message', 'warning_code'],
|
|
18404
|
+
type: 'object',
|
|
18405
|
+
},
|
|
18406
|
+
type: 'array',
|
|
18407
|
+
},
|
|
18408
|
+
created_at: {
|
|
18409
|
+
description: 'Date and time at which the event was created.',
|
|
18410
|
+
format: 'date-time',
|
|
18411
|
+
type: 'string',
|
|
18412
|
+
},
|
|
18413
|
+
device_custom_metadata: {
|
|
18414
|
+
additionalProperties: {
|
|
18415
|
+
oneOf: [{ type: 'string' }, { type: 'boolean' }],
|
|
18416
|
+
},
|
|
18417
|
+
description: 'Custom metadata of the device, present when device_id is provided.',
|
|
18418
|
+
type: 'object',
|
|
18419
|
+
},
|
|
18420
|
+
device_errors: {
|
|
18421
|
+
description: 'Errors associated with the device.',
|
|
18422
|
+
items: {
|
|
18423
|
+
description: 'Error associated with the resource, including the error code, message, and creation timestamp.',
|
|
18424
|
+
properties: {
|
|
18425
|
+
created_at: {
|
|
18426
|
+
description: 'Date and time at which Seam created the error.',
|
|
18427
|
+
format: 'date-time',
|
|
18428
|
+
type: 'string',
|
|
18429
|
+
},
|
|
18430
|
+
error_code: {
|
|
18431
|
+
description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
18432
|
+
type: 'string',
|
|
18433
|
+
},
|
|
18434
|
+
message: {
|
|
18435
|
+
description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
18436
|
+
type: 'string',
|
|
18437
|
+
},
|
|
18438
|
+
},
|
|
18439
|
+
required: ['created_at', 'message', 'error_code'],
|
|
18440
|
+
type: 'object',
|
|
18441
|
+
},
|
|
18442
|
+
type: 'array',
|
|
18443
|
+
},
|
|
18444
|
+
device_id: {
|
|
18445
|
+
description: 'ID of the device associated with the affected access code.',
|
|
18446
|
+
format: 'uuid',
|
|
18447
|
+
type: 'string',
|
|
18448
|
+
},
|
|
18449
|
+
device_warnings: {
|
|
18450
|
+
description: 'Warnings associated with the device.',
|
|
18451
|
+
items: {
|
|
18452
|
+
description: 'Warning associated with the resource, including the warning code, message, and creation timestamp.',
|
|
18453
|
+
properties: {
|
|
18454
|
+
created_at: {
|
|
18455
|
+
description: 'Date and time at which Seam created the warning.',
|
|
18456
|
+
format: 'date-time',
|
|
18457
|
+
type: 'string',
|
|
18458
|
+
},
|
|
18459
|
+
message: {
|
|
18460
|
+
description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
18461
|
+
type: 'string',
|
|
18462
|
+
},
|
|
18463
|
+
warning_code: {
|
|
18464
|
+
description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
18465
|
+
type: 'string',
|
|
18466
|
+
},
|
|
18467
|
+
},
|
|
18468
|
+
required: ['created_at', 'message', 'warning_code'],
|
|
18469
|
+
type: 'object',
|
|
18470
|
+
},
|
|
18471
|
+
type: 'array',
|
|
18472
|
+
},
|
|
18473
|
+
event_description: {
|
|
18474
|
+
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.',
|
|
18475
|
+
type: 'string',
|
|
18476
|
+
},
|
|
18477
|
+
event_id: {
|
|
18478
|
+
description: 'ID of the event.',
|
|
18479
|
+
format: 'uuid',
|
|
18480
|
+
type: 'string',
|
|
18481
|
+
},
|
|
18482
|
+
event_type: {
|
|
18483
|
+
enum: ['access_code.failed_to_expire'],
|
|
18484
|
+
type: 'string',
|
|
18485
|
+
},
|
|
18486
|
+
occurred_at: {
|
|
18487
|
+
description: 'Date and time at which the event occurred.',
|
|
18488
|
+
format: 'date-time',
|
|
18489
|
+
type: 'string',
|
|
18490
|
+
},
|
|
18491
|
+
workspace_id: {
|
|
18492
|
+
description: 'ID of the workspace associated with the event.',
|
|
18493
|
+
format: 'uuid',
|
|
18494
|
+
type: 'string',
|
|
18495
|
+
},
|
|
18496
|
+
},
|
|
18497
|
+
required: [
|
|
18498
|
+
'event_id',
|
|
18499
|
+
'workspace_id',
|
|
18500
|
+
'created_at',
|
|
18501
|
+
'occurred_at',
|
|
18502
|
+
'access_code_id',
|
|
18503
|
+
'device_id',
|
|
18504
|
+
'connected_account_id',
|
|
18505
|
+
'event_type',
|
|
18506
|
+
'connected_account_errors',
|
|
18507
|
+
'connected_account_warnings',
|
|
18508
|
+
'device_errors',
|
|
18509
|
+
'device_warnings',
|
|
18510
|
+
'access_code_errors',
|
|
18511
|
+
'access_code_warnings',
|
|
18512
|
+
],
|
|
18513
|
+
type: 'object',
|
|
18514
|
+
'x-route-path': '/access_codes',
|
|
18515
|
+
'x-undocumented': 'Unreleased.',
|
|
18516
|
+
},
|
|
18517
|
+
{
|
|
18518
|
+
description: 'An [access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes) was deleted.',
|
|
18519
|
+
properties: {
|
|
18520
|
+
access_code_id: {
|
|
18521
|
+
description: 'ID of the affected access code.',
|
|
18522
|
+
format: 'uuid',
|
|
18523
|
+
type: 'string',
|
|
18524
|
+
},
|
|
18525
|
+
code: {
|
|
18526
|
+
description: 'Code for the affected access code.',
|
|
18527
|
+
nullable: true,
|
|
18528
|
+
type: 'string',
|
|
18529
|
+
},
|
|
18530
|
+
connected_account_custom_metadata: {
|
|
18531
|
+
additionalProperties: {
|
|
18532
|
+
oneOf: [{ type: 'string' }, { type: 'boolean' }],
|
|
18533
|
+
},
|
|
18534
|
+
description: 'Custom metadata of the connected account, present when connected_account_id is provided.',
|
|
18535
|
+
type: 'object',
|
|
18536
|
+
},
|
|
18537
|
+
connected_account_id: {
|
|
18538
|
+
description: 'ID of the connected account associated with the affected access code.',
|
|
18539
|
+
format: 'uuid',
|
|
18540
|
+
type: 'string',
|
|
18541
|
+
},
|
|
18542
|
+
created_at: {
|
|
18543
|
+
description: 'Date and time at which the event was created.',
|
|
18544
|
+
format: 'date-time',
|
|
18545
|
+
type: 'string',
|
|
18546
|
+
},
|
|
18547
|
+
device_custom_metadata: {
|
|
18548
|
+
additionalProperties: {
|
|
18549
|
+
oneOf: [{ type: 'string' }, { type: 'boolean' }],
|
|
18550
|
+
},
|
|
18551
|
+
description: 'Custom metadata of the device, present when device_id is provided.',
|
|
18552
|
+
type: 'object',
|
|
18553
|
+
},
|
|
18554
|
+
device_id: {
|
|
18555
|
+
description: 'ID of the device associated with the affected access code.',
|
|
18556
|
+
format: 'uuid',
|
|
18557
|
+
type: 'string',
|
|
18558
|
+
},
|
|
18559
|
+
event_description: {
|
|
18560
|
+
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.',
|
|
18561
|
+
type: 'string',
|
|
18562
|
+
},
|
|
18563
|
+
event_id: {
|
|
18564
|
+
description: 'ID of the event.',
|
|
18565
|
+
format: 'uuid',
|
|
18566
|
+
type: 'string',
|
|
18567
|
+
},
|
|
18568
|
+
event_type: { enum: ['access_code.deleted'], type: 'string' },
|
|
18569
|
+
occurred_at: {
|
|
18570
|
+
description: 'Date and time at which the event occurred.',
|
|
18571
|
+
format: 'date-time',
|
|
18572
|
+
type: 'string',
|
|
18573
|
+
},
|
|
18574
|
+
workspace_id: {
|
|
18575
|
+
description: 'ID of the workspace associated with the event.',
|
|
18576
|
+
format: 'uuid',
|
|
18577
|
+
type: 'string',
|
|
18578
|
+
},
|
|
18579
|
+
},
|
|
18580
|
+
required: [
|
|
18581
|
+
'event_id',
|
|
18582
|
+
'workspace_id',
|
|
18583
|
+
'created_at',
|
|
18584
|
+
'occurred_at',
|
|
18585
|
+
'access_code_id',
|
|
18586
|
+
'device_id',
|
|
18587
|
+
'connected_account_id',
|
|
18588
|
+
'event_type',
|
|
18589
|
+
'code',
|
|
18590
|
+
],
|
|
18591
|
+
type: 'object',
|
|
18592
|
+
'x-route-path': '/access_codes',
|
|
18593
|
+
},
|
|
18594
|
+
{
|
|
18595
|
+
deprecated: true,
|
|
18596
|
+
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.',
|
|
18597
|
+
properties: {
|
|
18598
|
+
access_code_errors: {
|
|
18599
|
+
description: 'Errors associated with the access code.',
|
|
18600
|
+
items: {
|
|
18601
|
+
description: 'Error associated with the resource, including the error code, message, and creation timestamp.',
|
|
18602
|
+
properties: {
|
|
18603
|
+
created_at: {
|
|
18604
|
+
description: 'Date and time at which Seam created the error.',
|
|
18605
|
+
format: 'date-time',
|
|
18606
|
+
type: 'string',
|
|
18607
|
+
},
|
|
18608
|
+
error_code: {
|
|
18609
|
+
description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
18610
|
+
type: 'string',
|
|
18611
|
+
},
|
|
18612
|
+
message: {
|
|
18613
|
+
description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
18614
|
+
type: 'string',
|
|
18615
|
+
},
|
|
18616
|
+
},
|
|
18617
|
+
required: ['created_at', 'message', 'error_code'],
|
|
18618
|
+
type: 'object',
|
|
18619
|
+
},
|
|
18620
|
+
type: 'array',
|
|
18621
|
+
},
|
|
18622
|
+
access_code_id: {
|
|
18623
|
+
description: 'ID of the affected access code.',
|
|
18624
|
+
format: 'uuid',
|
|
18625
|
+
type: 'string',
|
|
18626
|
+
},
|
|
18627
|
+
access_code_warnings: {
|
|
18628
|
+
description: 'Warnings associated with the access code.',
|
|
18629
|
+
items: {
|
|
18630
|
+
description: 'Warning associated with the resource, including the warning code, message, and creation timestamp.',
|
|
18631
|
+
properties: {
|
|
18632
|
+
created_at: {
|
|
18633
|
+
description: 'Date and time at which Seam created the warning.',
|
|
18634
|
+
format: 'date-time',
|
|
18635
|
+
type: 'string',
|
|
18636
|
+
},
|
|
18637
|
+
message: {
|
|
18638
|
+
description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
18639
|
+
type: 'string',
|
|
18640
|
+
},
|
|
18641
|
+
warning_code: {
|
|
18642
|
+
description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
18643
|
+
type: 'string',
|
|
18644
|
+
},
|
|
18645
|
+
},
|
|
18646
|
+
required: ['created_at', 'message', 'warning_code'],
|
|
18647
|
+
type: 'object',
|
|
18648
|
+
},
|
|
18649
|
+
type: 'array',
|
|
18650
|
+
},
|
|
18651
|
+
connected_account_custom_metadata: {
|
|
18652
|
+
additionalProperties: {
|
|
18653
|
+
oneOf: [{ type: 'string' }, { type: 'boolean' }],
|
|
18654
|
+
},
|
|
18655
|
+
description: 'Custom metadata of the connected account, present when connected_account_id is provided.',
|
|
18656
|
+
type: 'object',
|
|
18657
|
+
},
|
|
18658
|
+
connected_account_errors: {
|
|
18659
|
+
description: 'Errors associated with the connected account.',
|
|
18660
|
+
items: {
|
|
18661
|
+
description: 'Error associated with the resource, including the error code, message, and creation timestamp.',
|
|
18662
|
+
properties: {
|
|
18663
|
+
created_at: {
|
|
18664
|
+
description: 'Date and time at which Seam created the error.',
|
|
18665
|
+
format: 'date-time',
|
|
18666
|
+
type: 'string',
|
|
18667
|
+
},
|
|
18668
|
+
error_code: {
|
|
18669
|
+
description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
18670
|
+
type: 'string',
|
|
18671
|
+
},
|
|
18672
|
+
message: {
|
|
18673
|
+
description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
18674
|
+
type: 'string',
|
|
18675
|
+
},
|
|
18676
|
+
},
|
|
18677
|
+
required: ['created_at', 'message', 'error_code'],
|
|
18678
|
+
type: 'object',
|
|
18679
|
+
},
|
|
18680
|
+
type: 'array',
|
|
18681
|
+
},
|
|
18682
|
+
connected_account_id: {
|
|
18683
|
+
description: 'ID of the connected account associated with the affected access code.',
|
|
18684
|
+
format: 'uuid',
|
|
18685
|
+
type: 'string',
|
|
18686
|
+
},
|
|
18687
|
+
connected_account_warnings: {
|
|
18688
|
+
description: 'Warnings associated with the connected account.',
|
|
18689
|
+
items: {
|
|
18690
|
+
description: 'Warning associated with the resource, including the warning code, message, and creation timestamp.',
|
|
18691
|
+
properties: {
|
|
18692
|
+
created_at: {
|
|
18693
|
+
description: 'Date and time at which Seam created the warning.',
|
|
18694
|
+
format: 'date-time',
|
|
18695
|
+
type: 'string',
|
|
18696
|
+
},
|
|
18697
|
+
message: {
|
|
18698
|
+
description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
18699
|
+
type: 'string',
|
|
18700
|
+
},
|
|
18701
|
+
warning_code: {
|
|
18702
|
+
description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
18703
|
+
type: 'string',
|
|
18704
|
+
},
|
|
18705
|
+
},
|
|
18706
|
+
required: ['created_at', 'message', 'warning_code'],
|
|
18707
|
+
type: 'object',
|
|
18708
|
+
},
|
|
18709
|
+
type: 'array',
|
|
18710
|
+
},
|
|
18711
|
+
created_at: {
|
|
18712
|
+
description: 'Date and time at which the event was created.',
|
|
18713
|
+
format: 'date-time',
|
|
18714
|
+
type: 'string',
|
|
18715
|
+
},
|
|
18716
|
+
device_custom_metadata: {
|
|
18717
|
+
additionalProperties: {
|
|
18718
|
+
oneOf: [{ type: 'string' }, { type: 'boolean' }],
|
|
18719
|
+
},
|
|
18720
|
+
description: 'Custom metadata of the device, present when device_id is provided.',
|
|
18721
|
+
type: 'object',
|
|
18722
|
+
},
|
|
18723
|
+
device_errors: {
|
|
18724
|
+
description: 'Errors associated with the device.',
|
|
18725
|
+
items: {
|
|
18726
|
+
description: 'Error associated with the resource, including the error code, message, and creation timestamp.',
|
|
18727
|
+
properties: {
|
|
18728
|
+
created_at: {
|
|
18729
|
+
description: 'Date and time at which Seam created the error.',
|
|
18730
|
+
format: 'date-time',
|
|
18731
|
+
type: 'string',
|
|
18732
|
+
},
|
|
18733
|
+
error_code: {
|
|
18734
|
+
description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
18735
|
+
type: 'string',
|
|
18736
|
+
},
|
|
18737
|
+
message: {
|
|
18738
|
+
description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
18739
|
+
type: 'string',
|
|
18740
|
+
},
|
|
18741
|
+
},
|
|
18742
|
+
required: ['created_at', 'message', 'error_code'],
|
|
18743
|
+
type: 'object',
|
|
18744
|
+
},
|
|
18745
|
+
type: 'array',
|
|
18746
|
+
},
|
|
18747
|
+
device_id: {
|
|
18748
|
+
description: 'ID of the device associated with the affected access code.',
|
|
18749
|
+
format: 'uuid',
|
|
18750
|
+
type: 'string',
|
|
18751
|
+
},
|
|
18752
|
+
device_warnings: {
|
|
18753
|
+
description: 'Warnings associated with the device.',
|
|
18754
|
+
items: {
|
|
18755
|
+
description: 'Warning associated with the resource, including the warning code, message, and creation timestamp.',
|
|
18756
|
+
properties: {
|
|
18757
|
+
created_at: {
|
|
18758
|
+
description: 'Date and time at which Seam created the warning.',
|
|
18759
|
+
format: 'date-time',
|
|
18760
|
+
type: 'string',
|
|
18761
|
+
},
|
|
18762
|
+
message: {
|
|
18763
|
+
description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
18764
|
+
type: 'string',
|
|
18765
|
+
},
|
|
18766
|
+
warning_code: {
|
|
18767
|
+
description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
18768
|
+
type: 'string',
|
|
18769
|
+
},
|
|
18770
|
+
},
|
|
18771
|
+
required: ['created_at', 'message', 'warning_code'],
|
|
18772
|
+
type: 'object',
|
|
18773
|
+
},
|
|
18774
|
+
type: 'array',
|
|
18775
|
+
},
|
|
18776
|
+
event_description: {
|
|
18777
|
+
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.',
|
|
18778
|
+
type: 'string',
|
|
18779
|
+
},
|
|
18780
|
+
event_id: {
|
|
18781
|
+
description: 'ID of the event.',
|
|
18782
|
+
format: 'uuid',
|
|
18783
|
+
type: 'string',
|
|
18784
|
+
},
|
|
18785
|
+
event_type: {
|
|
18786
|
+
enum: ['access_code.delay_in_removing_from_device'],
|
|
18787
|
+
type: 'string',
|
|
18788
|
+
},
|
|
18789
|
+
occurred_at: {
|
|
18790
|
+
description: 'Date and time at which the event occurred.',
|
|
18791
|
+
format: 'date-time',
|
|
18792
|
+
type: 'string',
|
|
18793
|
+
},
|
|
18794
|
+
workspace_id: {
|
|
18795
|
+
description: 'ID of the workspace associated with the event.',
|
|
18796
|
+
format: 'uuid',
|
|
18797
|
+
type: 'string',
|
|
18798
|
+
},
|
|
18799
|
+
},
|
|
18800
|
+
required: [
|
|
18801
|
+
'event_id',
|
|
18802
|
+
'workspace_id',
|
|
18803
|
+
'created_at',
|
|
18804
|
+
'occurred_at',
|
|
18805
|
+
'access_code_id',
|
|
18806
|
+
'device_id',
|
|
18807
|
+
'connected_account_id',
|
|
18808
|
+
'event_type',
|
|
18809
|
+
'connected_account_errors',
|
|
18810
|
+
'connected_account_warnings',
|
|
18811
|
+
'device_errors',
|
|
18812
|
+
'device_warnings',
|
|
18813
|
+
'access_code_errors',
|
|
18814
|
+
'access_code_warnings',
|
|
18815
|
+
],
|
|
18816
|
+
type: 'object',
|
|
18817
|
+
'x-deprecated': 'Seam no longer emits this event. Use `access_code.failed_to_remove_from_device` instead.',
|
|
18818
|
+
'x-route-path': '/access_codes',
|
|
18819
|
+
},
|
|
18820
|
+
{
|
|
18821
|
+
description: 'An [access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes) failed to be removed from a device.',
|
|
18822
|
+
properties: {
|
|
18823
|
+
access_code_errors: {
|
|
18824
|
+
description: 'Errors associated with the access code.',
|
|
18825
|
+
items: {
|
|
18826
|
+
description: 'Error associated with the resource, including the error code, message, and creation timestamp.',
|
|
18827
|
+
properties: {
|
|
18828
|
+
created_at: {
|
|
18829
|
+
description: 'Date and time at which Seam created the error.',
|
|
18830
|
+
format: 'date-time',
|
|
18831
|
+
type: 'string',
|
|
18832
|
+
},
|
|
18833
|
+
error_code: {
|
|
18834
|
+
description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
18835
|
+
type: 'string',
|
|
18836
|
+
},
|
|
18837
|
+
message: {
|
|
18838
|
+
description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
18839
|
+
type: 'string',
|
|
18840
|
+
},
|
|
18841
|
+
},
|
|
18842
|
+
required: ['created_at', 'message', 'error_code'],
|
|
18843
|
+
type: 'object',
|
|
18844
|
+
},
|
|
18845
|
+
type: 'array',
|
|
18846
|
+
},
|
|
18847
|
+
access_code_id: {
|
|
18848
|
+
description: 'ID of the affected access code.',
|
|
18849
|
+
format: 'uuid',
|
|
18850
|
+
type: 'string',
|
|
18851
|
+
},
|
|
18852
|
+
access_code_warnings: {
|
|
18853
|
+
description: 'Warnings associated with the access code.',
|
|
18854
|
+
items: {
|
|
18855
|
+
description: 'Warning associated with the resource, including the warning code, message, and creation timestamp.',
|
|
18856
|
+
properties: {
|
|
18857
|
+
created_at: {
|
|
18858
|
+
description: 'Date and time at which Seam created the warning.',
|
|
18859
|
+
format: 'date-time',
|
|
18860
|
+
type: 'string',
|
|
18861
|
+
},
|
|
18862
|
+
message: {
|
|
18863
|
+
description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
18864
|
+
type: 'string',
|
|
18865
|
+
},
|
|
18866
|
+
warning_code: {
|
|
18867
|
+
description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
18868
|
+
type: 'string',
|
|
18869
|
+
},
|
|
18870
|
+
},
|
|
18871
|
+
required: ['created_at', 'message', 'warning_code'],
|
|
18872
|
+
type: 'object',
|
|
18873
|
+
},
|
|
18874
|
+
type: 'array',
|
|
18875
|
+
},
|
|
18876
|
+
connected_account_custom_metadata: {
|
|
18877
|
+
additionalProperties: {
|
|
18878
|
+
oneOf: [{ type: 'string' }, { type: 'boolean' }],
|
|
18879
|
+
},
|
|
18880
|
+
description: 'Custom metadata of the connected account, present when connected_account_id is provided.',
|
|
18881
|
+
type: 'object',
|
|
18882
|
+
},
|
|
18883
|
+
connected_account_errors: {
|
|
18884
|
+
description: 'Errors associated with the connected account.',
|
|
18885
|
+
items: {
|
|
18886
|
+
description: 'Error associated with the resource, including the error code, message, and creation timestamp.',
|
|
18887
|
+
properties: {
|
|
18888
|
+
created_at: {
|
|
18889
|
+
description: 'Date and time at which Seam created the error.',
|
|
18890
|
+
format: 'date-time',
|
|
18891
|
+
type: 'string',
|
|
18892
|
+
},
|
|
18893
|
+
error_code: {
|
|
18894
|
+
description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
18895
|
+
type: 'string',
|
|
18896
|
+
},
|
|
18897
|
+
message: {
|
|
18898
|
+
description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
18899
|
+
type: 'string',
|
|
18900
|
+
},
|
|
18901
|
+
},
|
|
18902
|
+
required: ['created_at', 'message', 'error_code'],
|
|
18903
|
+
type: 'object',
|
|
18904
|
+
},
|
|
18905
|
+
type: 'array',
|
|
18906
|
+
},
|
|
18907
|
+
connected_account_id: {
|
|
18908
|
+
description: 'ID of the connected account associated with the affected access code.',
|
|
18909
|
+
format: 'uuid',
|
|
18910
|
+
type: 'string',
|
|
18911
|
+
},
|
|
18912
|
+
connected_account_warnings: {
|
|
18913
|
+
description: 'Warnings associated with the connected account.',
|
|
18914
|
+
items: {
|
|
18915
|
+
description: 'Warning associated with the resource, including the warning code, message, and creation timestamp.',
|
|
18916
|
+
properties: {
|
|
18917
|
+
created_at: {
|
|
18918
|
+
description: 'Date and time at which Seam created the warning.',
|
|
18919
|
+
format: 'date-time',
|
|
18920
|
+
type: 'string',
|
|
18921
|
+
},
|
|
18922
|
+
message: {
|
|
18923
|
+
description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
18924
|
+
type: 'string',
|
|
18925
|
+
},
|
|
18926
|
+
warning_code: {
|
|
18927
|
+
description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
18928
|
+
type: 'string',
|
|
18929
|
+
},
|
|
18930
|
+
},
|
|
18931
|
+
required: ['created_at', 'message', 'warning_code'],
|
|
18932
|
+
type: 'object',
|
|
18933
|
+
},
|
|
18934
|
+
type: 'array',
|
|
18935
|
+
},
|
|
18936
|
+
created_at: {
|
|
18937
|
+
description: 'Date and time at which the event was created.',
|
|
18938
|
+
format: 'date-time',
|
|
18939
|
+
type: 'string',
|
|
18940
|
+
},
|
|
18941
|
+
device_custom_metadata: {
|
|
18942
|
+
additionalProperties: {
|
|
18943
|
+
oneOf: [{ type: 'string' }, { type: 'boolean' }],
|
|
18944
|
+
},
|
|
18945
|
+
description: 'Custom metadata of the device, present when device_id is provided.',
|
|
18946
|
+
type: 'object',
|
|
18947
|
+
},
|
|
18948
|
+
device_errors: {
|
|
18949
|
+
description: 'Errors associated with the device.',
|
|
18950
|
+
items: {
|
|
18951
|
+
description: 'Error associated with the resource, including the error code, message, and creation timestamp.',
|
|
18952
|
+
properties: {
|
|
18953
|
+
created_at: {
|
|
18954
|
+
description: 'Date and time at which Seam created the error.',
|
|
18955
|
+
format: 'date-time',
|
|
18956
|
+
type: 'string',
|
|
18957
|
+
},
|
|
18958
|
+
error_code: {
|
|
18959
|
+
description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
18960
|
+
type: 'string',
|
|
18961
|
+
},
|
|
18962
|
+
message: {
|
|
18963
|
+
description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
18964
|
+
type: 'string',
|
|
18965
|
+
},
|
|
18966
|
+
},
|
|
18967
|
+
required: ['created_at', 'message', 'error_code'],
|
|
18968
|
+
type: 'object',
|
|
18969
|
+
},
|
|
18970
|
+
type: 'array',
|
|
18971
|
+
},
|
|
18972
|
+
device_id: {
|
|
18973
|
+
description: 'ID of the device associated with the affected access code.',
|
|
18974
|
+
format: 'uuid',
|
|
18975
|
+
type: 'string',
|
|
18976
|
+
},
|
|
18977
|
+
device_warnings: {
|
|
18978
|
+
description: 'Warnings associated with the device.',
|
|
18979
|
+
items: {
|
|
18980
|
+
description: 'Warning associated with the resource, including the warning code, message, and creation timestamp.',
|
|
18981
|
+
properties: {
|
|
18982
|
+
created_at: {
|
|
18983
|
+
description: 'Date and time at which Seam created the warning.',
|
|
18984
|
+
format: 'date-time',
|
|
18985
|
+
type: 'string',
|
|
18986
|
+
},
|
|
18987
|
+
message: {
|
|
18988
|
+
description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
18989
|
+
type: 'string',
|
|
18990
|
+
},
|
|
18991
|
+
warning_code: {
|
|
18992
|
+
description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
18993
|
+
type: 'string',
|
|
18994
|
+
},
|
|
18995
|
+
},
|
|
18996
|
+
required: ['created_at', 'message', 'warning_code'],
|
|
18997
|
+
type: 'object',
|
|
18998
|
+
},
|
|
18999
|
+
type: 'array',
|
|
19000
|
+
},
|
|
19001
|
+
event_description: {
|
|
19002
|
+
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.',
|
|
19003
|
+
type: 'string',
|
|
19004
|
+
},
|
|
19005
|
+
event_id: {
|
|
19006
|
+
description: 'ID of the event.',
|
|
19007
|
+
format: 'uuid',
|
|
19008
|
+
type: 'string',
|
|
19009
|
+
},
|
|
19010
|
+
event_type: {
|
|
19011
|
+
enum: ['access_code.failed_to_remove_from_device'],
|
|
19012
|
+
type: 'string',
|
|
19013
|
+
},
|
|
19014
|
+
occurred_at: {
|
|
19015
|
+
description: 'Date and time at which the event occurred.',
|
|
19016
|
+
format: 'date-time',
|
|
19017
|
+
type: 'string',
|
|
19018
|
+
},
|
|
19019
|
+
workspace_id: {
|
|
19020
|
+
description: 'ID of the workspace associated with the event.',
|
|
19021
|
+
format: 'uuid',
|
|
19022
|
+
type: 'string',
|
|
19023
|
+
},
|
|
19024
|
+
},
|
|
19025
|
+
required: [
|
|
19026
|
+
'event_id',
|
|
19027
|
+
'workspace_id',
|
|
19028
|
+
'created_at',
|
|
19029
|
+
'occurred_at',
|
|
19030
|
+
'access_code_id',
|
|
19031
|
+
'device_id',
|
|
19032
|
+
'connected_account_id',
|
|
19033
|
+
'event_type',
|
|
19034
|
+
'connected_account_errors',
|
|
19035
|
+
'connected_account_warnings',
|
|
19036
|
+
'device_errors',
|
|
19037
|
+
'device_warnings',
|
|
19038
|
+
'access_code_errors',
|
|
19039
|
+
'access_code_warnings',
|
|
19040
|
+
],
|
|
19041
|
+
type: 'object',
|
|
19042
|
+
'x-route-path': '/access_codes',
|
|
19043
|
+
},
|
|
19044
|
+
{
|
|
19045
|
+
description: 'An [access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes) was modified outside of Seam.',
|
|
19046
|
+
properties: {
|
|
19047
|
+
access_code_id: {
|
|
19048
|
+
description: 'ID of the affected access code.',
|
|
19049
|
+
format: 'uuid',
|
|
19050
|
+
type: 'string',
|
|
19051
|
+
},
|
|
19052
|
+
connected_account_custom_metadata: {
|
|
19053
|
+
additionalProperties: {
|
|
19054
|
+
oneOf: [{ type: 'string' }, { type: 'boolean' }],
|
|
19055
|
+
},
|
|
19056
|
+
description: 'Custom metadata of the connected account, present when connected_account_id is provided.',
|
|
19057
|
+
type: 'object',
|
|
19058
|
+
},
|
|
19059
|
+
connected_account_id: {
|
|
19060
|
+
description: 'ID of the connected account associated with the affected access code.',
|
|
19061
|
+
format: 'uuid',
|
|
19062
|
+
type: 'string',
|
|
19063
|
+
},
|
|
19064
|
+
created_at: {
|
|
19065
|
+
description: 'Date and time at which the event was created.',
|
|
19066
|
+
format: 'date-time',
|
|
19067
|
+
type: 'string',
|
|
19068
|
+
},
|
|
19069
|
+
device_custom_metadata: {
|
|
19070
|
+
additionalProperties: {
|
|
19071
|
+
oneOf: [{ type: 'string' }, { type: 'boolean' }],
|
|
19072
|
+
},
|
|
19073
|
+
description: 'Custom metadata of the device, present when device_id is provided.',
|
|
19074
|
+
type: 'object',
|
|
19075
|
+
},
|
|
19076
|
+
device_id: {
|
|
19077
|
+
description: 'ID of the device associated with the affected access code.',
|
|
19078
|
+
format: 'uuid',
|
|
19079
|
+
type: 'string',
|
|
19080
|
+
},
|
|
19081
|
+
event_description: {
|
|
19082
|
+
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.',
|
|
19083
|
+
type: 'string',
|
|
19084
|
+
},
|
|
19085
|
+
event_id: {
|
|
19086
|
+
description: 'ID of the event.',
|
|
19087
|
+
format: 'uuid',
|
|
19088
|
+
type: 'string',
|
|
19089
|
+
},
|
|
19090
|
+
event_type: {
|
|
19091
|
+
enum: ['access_code.modified_external_to_seam'],
|
|
17783
19092
|
type: 'string',
|
|
17784
19093
|
},
|
|
17785
19094
|
occurred_at: {
|
|
@@ -27358,6 +28667,90 @@ const openapi = {
|
|
|
27358
28667
|
type: 'object',
|
|
27359
28668
|
'x-resource-type': 'access_code',
|
|
27360
28669
|
},
|
|
28670
|
+
{
|
|
28671
|
+
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.',
|
|
28672
|
+
properties: {
|
|
28673
|
+
created_at: {
|
|
28674
|
+
description: 'Date and time at which Seam created the error.',
|
|
28675
|
+
format: 'date-time',
|
|
28676
|
+
type: 'string',
|
|
28677
|
+
},
|
|
28678
|
+
error_code: {
|
|
28679
|
+
description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
28680
|
+
enum: ['failed_to_issue'],
|
|
28681
|
+
type: 'string',
|
|
28682
|
+
},
|
|
28683
|
+
is_access_code_error: {
|
|
28684
|
+
description: 'Indicates that this is an access code error.',
|
|
28685
|
+
enum: [true],
|
|
28686
|
+
type: 'boolean',
|
|
28687
|
+
},
|
|
28688
|
+
message: {
|
|
28689
|
+
description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
28690
|
+
type: 'string',
|
|
28691
|
+
},
|
|
28692
|
+
},
|
|
28693
|
+
required: ['message', 'is_access_code_error', 'error_code'],
|
|
28694
|
+
type: 'object',
|
|
28695
|
+
'x-resource-type': 'access_code',
|
|
28696
|
+
'x-undocumented': 'Unreleased.',
|
|
28697
|
+
},
|
|
28698
|
+
{
|
|
28699
|
+
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.",
|
|
28700
|
+
properties: {
|
|
28701
|
+
created_at: {
|
|
28702
|
+
description: 'Date and time at which Seam created the error.',
|
|
28703
|
+
format: 'date-time',
|
|
28704
|
+
type: 'string',
|
|
28705
|
+
},
|
|
28706
|
+
error_code: {
|
|
28707
|
+
description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
28708
|
+
enum: ['failed_to_apply_mutations'],
|
|
28709
|
+
type: 'string',
|
|
28710
|
+
},
|
|
28711
|
+
is_access_code_error: {
|
|
28712
|
+
description: 'Indicates that this is an access code error.',
|
|
28713
|
+
enum: [true],
|
|
28714
|
+
type: 'boolean',
|
|
28715
|
+
},
|
|
28716
|
+
message: {
|
|
28717
|
+
description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
28718
|
+
type: 'string',
|
|
28719
|
+
},
|
|
28720
|
+
},
|
|
28721
|
+
required: ['message', 'is_access_code_error', 'error_code'],
|
|
28722
|
+
type: 'object',
|
|
28723
|
+
'x-resource-type': 'access_code',
|
|
28724
|
+
'x-undocumented': 'Unreleased.',
|
|
28725
|
+
},
|
|
28726
|
+
{
|
|
28727
|
+
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.',
|
|
28728
|
+
properties: {
|
|
28729
|
+
created_at: {
|
|
28730
|
+
description: 'Date and time at which Seam created the error.',
|
|
28731
|
+
format: 'date-time',
|
|
28732
|
+
type: 'string',
|
|
28733
|
+
},
|
|
28734
|
+
error_code: {
|
|
28735
|
+
description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
28736
|
+
enum: ['failed_to_expire'],
|
|
28737
|
+
type: 'string',
|
|
28738
|
+
},
|
|
28739
|
+
is_access_code_error: {
|
|
28740
|
+
description: 'Indicates that this is an access code error.',
|
|
28741
|
+
enum: [true],
|
|
28742
|
+
type: 'boolean',
|
|
28743
|
+
},
|
|
28744
|
+
message: {
|
|
28745
|
+
description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
28746
|
+
type: 'string',
|
|
28747
|
+
},
|
|
28748
|
+
},
|
|
28749
|
+
required: ['message', 'is_access_code_error', 'error_code'],
|
|
28750
|
+
type: 'object',
|
|
28751
|
+
'x-resource-type': 'access_code',
|
|
28752
|
+
'x-undocumented': 'Unreleased.',
|
|
28753
|
+
},
|
|
27361
28754
|
{
|
|
27362
28755
|
description: 'Indicates that the account is disconnected.',
|
|
27363
28756
|
properties: {
|
|
@@ -28016,6 +29409,50 @@ const openapi = {
|
|
|
28016
29409
|
type: 'object',
|
|
28017
29410
|
'x-deprecated': 'Seam no longer sets this warning. Use the `failed_to_remove_from_device` error instead.',
|
|
28018
29411
|
},
|
|
29412
|
+
{
|
|
29413
|
+
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.',
|
|
29414
|
+
properties: {
|
|
29415
|
+
created_at: {
|
|
29416
|
+
description: 'Date and time at which Seam created the warning.',
|
|
29417
|
+
format: 'date-time',
|
|
29418
|
+
type: 'string',
|
|
29419
|
+
},
|
|
29420
|
+
message: {
|
|
29421
|
+
description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
29422
|
+
type: 'string',
|
|
29423
|
+
},
|
|
29424
|
+
warning_code: {
|
|
29425
|
+
description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
29426
|
+
enum: ['delay_in_issuing'],
|
|
29427
|
+
type: 'string',
|
|
29428
|
+
},
|
|
29429
|
+
},
|
|
29430
|
+
required: ['message', 'warning_code'],
|
|
29431
|
+
type: 'object',
|
|
29432
|
+
'x-undocumented': 'Unreleased.',
|
|
29433
|
+
},
|
|
29434
|
+
{
|
|
29435
|
+
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.",
|
|
29436
|
+
properties: {
|
|
29437
|
+
created_at: {
|
|
29438
|
+
description: 'Date and time at which Seam created the warning.',
|
|
29439
|
+
format: 'date-time',
|
|
29440
|
+
type: 'string',
|
|
29441
|
+
},
|
|
29442
|
+
message: {
|
|
29443
|
+
description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
29444
|
+
type: 'string',
|
|
29445
|
+
},
|
|
29446
|
+
warning_code: {
|
|
29447
|
+
description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
29448
|
+
enum: ['delay_in_applying_mutations'],
|
|
29449
|
+
type: 'string',
|
|
29450
|
+
},
|
|
29451
|
+
},
|
|
29452
|
+
required: ['message', 'warning_code'],
|
|
29453
|
+
type: 'object',
|
|
29454
|
+
'x-undocumented': 'Unreleased.',
|
|
29455
|
+
},
|
|
28019
29456
|
{
|
|
28020
29457
|
description: 'Third-party integration detected that may cause access codes to fail.',
|
|
28021
29458
|
properties: {
|
|
@@ -54267,6 +55704,12 @@ const openapi = {
|
|
|
54267
55704
|
'access_code.removed_from_device',
|
|
54268
55705
|
'access_code.delay_in_setting_on_device',
|
|
54269
55706
|
'access_code.failed_to_set_on_device',
|
|
55707
|
+
'access_code.issued',
|
|
55708
|
+
'access_code.delay_in_issuing',
|
|
55709
|
+
'access_code.failed_to_issue',
|
|
55710
|
+
'access_code.delay_in_applying_mutations',
|
|
55711
|
+
'access_code.failed_to_apply_mutations',
|
|
55712
|
+
'access_code.failed_to_expire',
|
|
54270
55713
|
'access_code.deleted',
|
|
54271
55714
|
'access_code.delay_in_removing_from_device',
|
|
54272
55715
|
'access_code.failed_to_remove_from_device',
|
|
@@ -54387,6 +55830,12 @@ const openapi = {
|
|
|
54387
55830
|
'access_code.removed_from_device',
|
|
54388
55831
|
'access_code.delay_in_setting_on_device',
|
|
54389
55832
|
'access_code.failed_to_set_on_device',
|
|
55833
|
+
'access_code.issued',
|
|
55834
|
+
'access_code.delay_in_issuing',
|
|
55835
|
+
'access_code.failed_to_issue',
|
|
55836
|
+
'access_code.delay_in_applying_mutations',
|
|
55837
|
+
'access_code.failed_to_apply_mutations',
|
|
55838
|
+
'access_code.failed_to_expire',
|
|
54390
55839
|
'access_code.deleted',
|
|
54391
55840
|
'access_code.delay_in_removing_from_device',
|
|
54392
55841
|
'access_code.failed_to_remove_from_device',
|
|
@@ -54806,6 +56255,12 @@ const openapi = {
|
|
|
54806
56255
|
'access_code.removed_from_device',
|
|
54807
56256
|
'access_code.delay_in_setting_on_device',
|
|
54808
56257
|
'access_code.failed_to_set_on_device',
|
|
56258
|
+
'access_code.issued',
|
|
56259
|
+
'access_code.delay_in_issuing',
|
|
56260
|
+
'access_code.failed_to_issue',
|
|
56261
|
+
'access_code.delay_in_applying_mutations',
|
|
56262
|
+
'access_code.failed_to_apply_mutations',
|
|
56263
|
+
'access_code.failed_to_expire',
|
|
54809
56264
|
'access_code.deleted',
|
|
54810
56265
|
'access_code.delay_in_removing_from_device',
|
|
54811
56266
|
'access_code.failed_to_remove_from_device',
|
|
@@ -54922,6 +56377,12 @@ const openapi = {
|
|
|
54922
56377
|
'access_code.removed_from_device',
|
|
54923
56378
|
'access_code.delay_in_setting_on_device',
|
|
54924
56379
|
'access_code.failed_to_set_on_device',
|
|
56380
|
+
'access_code.issued',
|
|
56381
|
+
'access_code.delay_in_issuing',
|
|
56382
|
+
'access_code.failed_to_issue',
|
|
56383
|
+
'access_code.delay_in_applying_mutations',
|
|
56384
|
+
'access_code.failed_to_apply_mutations',
|
|
56385
|
+
'access_code.failed_to_expire',
|
|
54925
56386
|
'access_code.deleted',
|
|
54926
56387
|
'access_code.delay_in_removing_from_device',
|
|
54927
56388
|
'access_code.failed_to_remove_from_device',
|
|
@@ -66930,6 +68391,12 @@ const openapi = {
|
|
|
66930
68391
|
'access_code.removed_from_device',
|
|
66931
68392
|
'access_code.delay_in_setting_on_device',
|
|
66932
68393
|
'access_code.failed_to_set_on_device',
|
|
68394
|
+
'access_code.issued',
|
|
68395
|
+
'access_code.delay_in_issuing',
|
|
68396
|
+
'access_code.failed_to_issue',
|
|
68397
|
+
'access_code.delay_in_applying_mutations',
|
|
68398
|
+
'access_code.failed_to_apply_mutations',
|
|
68399
|
+
'access_code.failed_to_expire',
|
|
66933
68400
|
'access_code.deleted',
|
|
66934
68401
|
'access_code.delay_in_removing_from_device',
|
|
66935
68402
|
'access_code.failed_to_remove_from_device',
|
|
@@ -67051,6 +68518,12 @@ const openapi = {
|
|
|
67051
68518
|
'access_code.removed_from_device',
|
|
67052
68519
|
'access_code.delay_in_setting_on_device',
|
|
67053
68520
|
'access_code.failed_to_set_on_device',
|
|
68521
|
+
'access_code.issued',
|
|
68522
|
+
'access_code.delay_in_issuing',
|
|
68523
|
+
'access_code.failed_to_issue',
|
|
68524
|
+
'access_code.delay_in_applying_mutations',
|
|
68525
|
+
'access_code.failed_to_apply_mutations',
|
|
68526
|
+
'access_code.failed_to_expire',
|
|
67054
68527
|
'access_code.deleted',
|
|
67055
68528
|
'access_code.delay_in_removing_from_device',
|
|
67056
68529
|
'access_code.failed_to_remove_from_device',
|
|
@@ -67231,6 +68704,12 @@ const openapi = {
|
|
|
67231
68704
|
'access_code.removed_from_device',
|
|
67232
68705
|
'access_code.delay_in_setting_on_device',
|
|
67233
68706
|
'access_code.failed_to_set_on_device',
|
|
68707
|
+
'access_code.issued',
|
|
68708
|
+
'access_code.delay_in_issuing',
|
|
68709
|
+
'access_code.failed_to_issue',
|
|
68710
|
+
'access_code.delay_in_applying_mutations',
|
|
68711
|
+
'access_code.failed_to_apply_mutations',
|
|
68712
|
+
'access_code.failed_to_expire',
|
|
67234
68713
|
'access_code.deleted',
|
|
67235
68714
|
'access_code.delay_in_removing_from_device',
|
|
67236
68715
|
'access_code.failed_to_remove_from_device',
|
|
@@ -67347,6 +68826,12 @@ const openapi = {
|
|
|
67347
68826
|
'access_code.removed_from_device',
|
|
67348
68827
|
'access_code.delay_in_setting_on_device',
|
|
67349
68828
|
'access_code.failed_to_set_on_device',
|
|
68829
|
+
'access_code.issued',
|
|
68830
|
+
'access_code.delay_in_issuing',
|
|
68831
|
+
'access_code.failed_to_issue',
|
|
68832
|
+
'access_code.delay_in_applying_mutations',
|
|
68833
|
+
'access_code.failed_to_apply_mutations',
|
|
68834
|
+
'access_code.failed_to_expire',
|
|
67350
68835
|
'access_code.deleted',
|
|
67351
68836
|
'access_code.delay_in_removing_from_device',
|
|
67352
68837
|
'access_code.failed_to_remove_from_device',
|