@seamapi/types 1.869.0 → 1.871.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/dist/connect.cjs +283 -11
- package/dist/connect.cjs.map +1 -1
- package/dist/connect.d.cts +1075 -0
- package/dist/index.cjs +283 -11
- package/dist/index.cjs.map +1 -1
- package/lib/seam/connect/models/access-codes/managed-access-code.d.ts +333 -0
- package/lib/seam/connect/models/access-codes/managed-access-code.js +61 -3
- 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 +123 -0
- package/lib/seam/connect/models/batch.d.ts +330 -0
- package/lib/seam/connect/openapi.js +222 -0
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +418 -0
- package/package.json +1 -1
- package/src/lib/seam/connect/models/access-codes/managed-access-code.ts +80 -3
- package/src/lib/seam/connect/openapi.ts +256 -0
- package/src/lib/seam/connect/route-types.ts +484 -0
|
@@ -277,6 +277,33 @@ const openapi = {
|
|
|
277
277
|
type: 'object',
|
|
278
278
|
},
|
|
279
279
|
{
|
|
280
|
+
description: 'Indicates that the provider cannot confirm whether the access code was set or removed on the device.',
|
|
281
|
+
properties: {
|
|
282
|
+
created_at: {
|
|
283
|
+
description: 'Date and time at which Seam created the error.',
|
|
284
|
+
format: 'date-time',
|
|
285
|
+
type: 'string',
|
|
286
|
+
},
|
|
287
|
+
error_code: {
|
|
288
|
+
description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
289
|
+
enum: ['access_code_state_unconfirmed'],
|
|
290
|
+
type: 'string',
|
|
291
|
+
},
|
|
292
|
+
is_access_code_error: {
|
|
293
|
+
description: 'Indicates that this is an access code error.',
|
|
294
|
+
enum: [true],
|
|
295
|
+
type: 'boolean',
|
|
296
|
+
},
|
|
297
|
+
message: {
|
|
298
|
+
description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
299
|
+
type: 'string',
|
|
300
|
+
},
|
|
301
|
+
},
|
|
302
|
+
required: ['message', 'is_access_code_error', 'error_code'],
|
|
303
|
+
type: 'object',
|
|
304
|
+
},
|
|
305
|
+
{
|
|
306
|
+
deprecated: true,
|
|
280
307
|
description: 'Unable to confirm that the access code is set on Kwikset device.',
|
|
281
308
|
properties: {
|
|
282
309
|
created_at: {
|
|
@@ -301,8 +328,10 @@ const openapi = {
|
|
|
301
328
|
},
|
|
302
329
|
required: ['message', 'is_access_code_error', 'error_code'],
|
|
303
330
|
type: 'object',
|
|
331
|
+
'x-deprecated': 'Use `access_code_state_unconfirmed` instead.',
|
|
304
332
|
},
|
|
305
333
|
{
|
|
334
|
+
deprecated: true,
|
|
306
335
|
description: 'Unable to confirm the deletion of the access code on Kwikset device.',
|
|
307
336
|
properties: {
|
|
308
337
|
created_at: {
|
|
@@ -327,10 +356,16 @@ const openapi = {
|
|
|
327
356
|
},
|
|
328
357
|
required: ['message', 'is_access_code_error', 'error_code'],
|
|
329
358
|
type: 'object',
|
|
359
|
+
'x-deprecated': 'Use `access_code_state_unconfirmed` instead.',
|
|
330
360
|
},
|
|
331
361
|
{
|
|
332
362
|
description: 'Code was modified or removed externally after Seam successfully set it on the device.',
|
|
333
363
|
properties: {
|
|
364
|
+
change_type: {
|
|
365
|
+
description: "Indicates the type of external modification. `modified` means the code's PIN or schedule was changed. `removed` means the code was deleted from the device.",
|
|
366
|
+
enum: ['modified', 'removed'],
|
|
367
|
+
type: 'string',
|
|
368
|
+
},
|
|
334
369
|
created_at: {
|
|
335
370
|
description: 'Date and time at which Seam created the error.',
|
|
336
371
|
format: 'date-time',
|
|
@@ -350,6 +385,30 @@ const openapi = {
|
|
|
350
385
|
description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
351
386
|
type: 'string',
|
|
352
387
|
},
|
|
388
|
+
modified_fields: {
|
|
389
|
+
description: 'List of fields that were changed externally, with their previous and new values.',
|
|
390
|
+
items: {
|
|
391
|
+
properties: {
|
|
392
|
+
field: {
|
|
393
|
+
description: 'The name of the field that was changed (e.g. `code`, `starts_at`, `ends_at`).',
|
|
394
|
+
type: 'string',
|
|
395
|
+
},
|
|
396
|
+
from: {
|
|
397
|
+
description: 'The previous value of the field.',
|
|
398
|
+
nullable: true,
|
|
399
|
+
type: 'string',
|
|
400
|
+
},
|
|
401
|
+
to: {
|
|
402
|
+
description: 'The new value of the field.',
|
|
403
|
+
nullable: true,
|
|
404
|
+
type: 'string',
|
|
405
|
+
},
|
|
406
|
+
},
|
|
407
|
+
required: ['field', 'from', 'to'],
|
|
408
|
+
type: 'object',
|
|
409
|
+
},
|
|
410
|
+
type: 'array',
|
|
411
|
+
},
|
|
353
412
|
},
|
|
354
413
|
required: ['message', 'is_access_code_error', 'error_code'],
|
|
355
414
|
type: 'object',
|
|
@@ -1523,6 +1582,11 @@ const openapi = {
|
|
|
1523
1582
|
{
|
|
1524
1583
|
description: 'Code was modified or removed externally after Seam successfully set it on the device.',
|
|
1525
1584
|
properties: {
|
|
1585
|
+
change_type: {
|
|
1586
|
+
description: "Indicates the type of external modification. `modified` means the code's PIN or schedule was changed. `removed` means the code was deleted from the device.",
|
|
1587
|
+
enum: ['modified', 'removed'],
|
|
1588
|
+
type: 'string',
|
|
1589
|
+
},
|
|
1526
1590
|
created_at: {
|
|
1527
1591
|
description: 'Date and time at which Seam created the warning.',
|
|
1528
1592
|
format: 'date-time',
|
|
@@ -1532,6 +1596,30 @@ const openapi = {
|
|
|
1532
1596
|
description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
1533
1597
|
type: 'string',
|
|
1534
1598
|
},
|
|
1599
|
+
modified_fields: {
|
|
1600
|
+
description: 'List of fields that were changed externally, with their previous and new values.',
|
|
1601
|
+
items: {
|
|
1602
|
+
properties: {
|
|
1603
|
+
field: {
|
|
1604
|
+
description: 'The name of the field that was changed (e.g. `code`, `starts_at`, `ends_at`).',
|
|
1605
|
+
type: 'string',
|
|
1606
|
+
},
|
|
1607
|
+
from: {
|
|
1608
|
+
description: 'The previous value of the field.',
|
|
1609
|
+
nullable: true,
|
|
1610
|
+
type: 'string',
|
|
1611
|
+
},
|
|
1612
|
+
to: {
|
|
1613
|
+
description: 'The new value of the field.',
|
|
1614
|
+
nullable: true,
|
|
1615
|
+
type: 'string',
|
|
1616
|
+
},
|
|
1617
|
+
},
|
|
1618
|
+
required: ['field', 'from', 'to'],
|
|
1619
|
+
type: 'object',
|
|
1620
|
+
},
|
|
1621
|
+
type: 'array',
|
|
1622
|
+
},
|
|
1535
1623
|
warning_code: {
|
|
1536
1624
|
description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
1537
1625
|
enum: ['code_modified_external_to_seam'],
|
|
@@ -1689,6 +1777,28 @@ const openapi = {
|
|
|
1689
1777
|
type: 'object',
|
|
1690
1778
|
},
|
|
1691
1779
|
{
|
|
1780
|
+
description: 'Indicates that the access code is disabled or inactive on the device. The code exists but will not grant access until re-enabled.',
|
|
1781
|
+
properties: {
|
|
1782
|
+
created_at: {
|
|
1783
|
+
description: 'Date and time at which Seam created the warning.',
|
|
1784
|
+
format: 'date-time',
|
|
1785
|
+
type: 'string',
|
|
1786
|
+
},
|
|
1787
|
+
message: {
|
|
1788
|
+
description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
1789
|
+
type: 'string',
|
|
1790
|
+
},
|
|
1791
|
+
warning_code: {
|
|
1792
|
+
description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
1793
|
+
enum: ['access_code_inactive'],
|
|
1794
|
+
type: 'string',
|
|
1795
|
+
},
|
|
1796
|
+
},
|
|
1797
|
+
required: ['message', 'warning_code'],
|
|
1798
|
+
type: 'object',
|
|
1799
|
+
},
|
|
1800
|
+
{
|
|
1801
|
+
deprecated: true,
|
|
1692
1802
|
description: 'Access code is disabled on Ultraloq device. Re-enable through the Ultraloq mobile app.',
|
|
1693
1803
|
properties: {
|
|
1694
1804
|
created_at: {
|
|
@@ -1708,6 +1818,7 @@ const openapi = {
|
|
|
1708
1818
|
},
|
|
1709
1819
|
required: ['message', 'warning_code'],
|
|
1710
1820
|
type: 'object',
|
|
1821
|
+
'x-deprecated': 'Use `access_code_inactive` instead.',
|
|
1711
1822
|
},
|
|
1712
1823
|
{
|
|
1713
1824
|
description: 'A backup access code has been pulled and is being used in place of this access code.',
|
|
@@ -24726,6 +24837,33 @@ const openapi = {
|
|
|
24726
24837
|
type: 'object',
|
|
24727
24838
|
},
|
|
24728
24839
|
{
|
|
24840
|
+
description: 'Indicates that the provider cannot confirm whether the access code was set or removed on the device.',
|
|
24841
|
+
properties: {
|
|
24842
|
+
created_at: {
|
|
24843
|
+
description: 'Date and time at which Seam created the error.',
|
|
24844
|
+
format: 'date-time',
|
|
24845
|
+
type: 'string',
|
|
24846
|
+
},
|
|
24847
|
+
error_code: {
|
|
24848
|
+
description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
24849
|
+
enum: ['access_code_state_unconfirmed'],
|
|
24850
|
+
type: 'string',
|
|
24851
|
+
},
|
|
24852
|
+
is_access_code_error: {
|
|
24853
|
+
description: 'Indicates that this is an access code error.',
|
|
24854
|
+
enum: [true],
|
|
24855
|
+
type: 'boolean',
|
|
24856
|
+
},
|
|
24857
|
+
message: {
|
|
24858
|
+
description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
24859
|
+
type: 'string',
|
|
24860
|
+
},
|
|
24861
|
+
},
|
|
24862
|
+
required: ['message', 'is_access_code_error', 'error_code'],
|
|
24863
|
+
type: 'object',
|
|
24864
|
+
},
|
|
24865
|
+
{
|
|
24866
|
+
deprecated: true,
|
|
24729
24867
|
description: 'Unable to confirm that the access code is set on Kwikset device.',
|
|
24730
24868
|
properties: {
|
|
24731
24869
|
created_at: {
|
|
@@ -24750,8 +24888,10 @@ const openapi = {
|
|
|
24750
24888
|
},
|
|
24751
24889
|
required: ['message', 'is_access_code_error', 'error_code'],
|
|
24752
24890
|
type: 'object',
|
|
24891
|
+
'x-deprecated': 'Use `access_code_state_unconfirmed` instead.',
|
|
24753
24892
|
},
|
|
24754
24893
|
{
|
|
24894
|
+
deprecated: true,
|
|
24755
24895
|
description: 'Unable to confirm the deletion of the access code on Kwikset device.',
|
|
24756
24896
|
properties: {
|
|
24757
24897
|
created_at: {
|
|
@@ -24776,10 +24916,16 @@ const openapi = {
|
|
|
24776
24916
|
},
|
|
24777
24917
|
required: ['message', 'is_access_code_error', 'error_code'],
|
|
24778
24918
|
type: 'object',
|
|
24919
|
+
'x-deprecated': 'Use `access_code_state_unconfirmed` instead.',
|
|
24779
24920
|
},
|
|
24780
24921
|
{
|
|
24781
24922
|
description: 'Code was modified or removed externally after Seam successfully set it on the device.',
|
|
24782
24923
|
properties: {
|
|
24924
|
+
change_type: {
|
|
24925
|
+
description: "Indicates the type of external modification. `modified` means the code's PIN or schedule was changed. `removed` means the code was deleted from the device.",
|
|
24926
|
+
enum: ['modified', 'removed'],
|
|
24927
|
+
type: 'string',
|
|
24928
|
+
},
|
|
24783
24929
|
created_at: {
|
|
24784
24930
|
description: 'Date and time at which Seam created the error.',
|
|
24785
24931
|
format: 'date-time',
|
|
@@ -24799,6 +24945,30 @@ const openapi = {
|
|
|
24799
24945
|
description: 'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
24800
24946
|
type: 'string',
|
|
24801
24947
|
},
|
|
24948
|
+
modified_fields: {
|
|
24949
|
+
description: 'List of fields that were changed externally, with their previous and new values.',
|
|
24950
|
+
items: {
|
|
24951
|
+
properties: {
|
|
24952
|
+
field: {
|
|
24953
|
+
description: 'The name of the field that was changed (e.g. `code`, `starts_at`, `ends_at`).',
|
|
24954
|
+
type: 'string',
|
|
24955
|
+
},
|
|
24956
|
+
from: {
|
|
24957
|
+
description: 'The previous value of the field.',
|
|
24958
|
+
nullable: true,
|
|
24959
|
+
type: 'string',
|
|
24960
|
+
},
|
|
24961
|
+
to: {
|
|
24962
|
+
description: 'The new value of the field.',
|
|
24963
|
+
nullable: true,
|
|
24964
|
+
type: 'string',
|
|
24965
|
+
},
|
|
24966
|
+
},
|
|
24967
|
+
required: ['field', 'from', 'to'],
|
|
24968
|
+
type: 'object',
|
|
24969
|
+
},
|
|
24970
|
+
type: 'array',
|
|
24971
|
+
},
|
|
24802
24972
|
},
|
|
24803
24973
|
required: ['message', 'is_access_code_error', 'error_code'],
|
|
24804
24974
|
type: 'object',
|
|
@@ -25689,6 +25859,11 @@ const openapi = {
|
|
|
25689
25859
|
{
|
|
25690
25860
|
description: 'Code was modified or removed externally after Seam successfully set it on the device.',
|
|
25691
25861
|
properties: {
|
|
25862
|
+
change_type: {
|
|
25863
|
+
description: "Indicates the type of external modification. `modified` means the code's PIN or schedule was changed. `removed` means the code was deleted from the device.",
|
|
25864
|
+
enum: ['modified', 'removed'],
|
|
25865
|
+
type: 'string',
|
|
25866
|
+
},
|
|
25692
25867
|
created_at: {
|
|
25693
25868
|
description: 'Date and time at which Seam created the warning.',
|
|
25694
25869
|
format: 'date-time',
|
|
@@ -25698,6 +25873,30 @@ const openapi = {
|
|
|
25698
25873
|
description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
25699
25874
|
type: 'string',
|
|
25700
25875
|
},
|
|
25876
|
+
modified_fields: {
|
|
25877
|
+
description: 'List of fields that were changed externally, with their previous and new values.',
|
|
25878
|
+
items: {
|
|
25879
|
+
properties: {
|
|
25880
|
+
field: {
|
|
25881
|
+
description: 'The name of the field that was changed (e.g. `code`, `starts_at`, `ends_at`).',
|
|
25882
|
+
type: 'string',
|
|
25883
|
+
},
|
|
25884
|
+
from: {
|
|
25885
|
+
description: 'The previous value of the field.',
|
|
25886
|
+
nullable: true,
|
|
25887
|
+
type: 'string',
|
|
25888
|
+
},
|
|
25889
|
+
to: {
|
|
25890
|
+
description: 'The new value of the field.',
|
|
25891
|
+
nullable: true,
|
|
25892
|
+
type: 'string',
|
|
25893
|
+
},
|
|
25894
|
+
},
|
|
25895
|
+
required: ['field', 'from', 'to'],
|
|
25896
|
+
type: 'object',
|
|
25897
|
+
},
|
|
25898
|
+
type: 'array',
|
|
25899
|
+
},
|
|
25701
25900
|
warning_code: {
|
|
25702
25901
|
description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
25703
25902
|
enum: ['code_modified_external_to_seam'],
|
|
@@ -25855,6 +26054,28 @@ const openapi = {
|
|
|
25855
26054
|
type: 'object',
|
|
25856
26055
|
},
|
|
25857
26056
|
{
|
|
26057
|
+
description: 'Indicates that the access code is disabled or inactive on the device. The code exists but will not grant access until re-enabled.',
|
|
26058
|
+
properties: {
|
|
26059
|
+
created_at: {
|
|
26060
|
+
description: 'Date and time at which Seam created the warning.',
|
|
26061
|
+
format: 'date-time',
|
|
26062
|
+
type: 'string',
|
|
26063
|
+
},
|
|
26064
|
+
message: {
|
|
26065
|
+
description: 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
26066
|
+
type: 'string',
|
|
26067
|
+
},
|
|
26068
|
+
warning_code: {
|
|
26069
|
+
description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
26070
|
+
enum: ['access_code_inactive'],
|
|
26071
|
+
type: 'string',
|
|
26072
|
+
},
|
|
26073
|
+
},
|
|
26074
|
+
required: ['message', 'warning_code'],
|
|
26075
|
+
type: 'object',
|
|
26076
|
+
},
|
|
26077
|
+
{
|
|
26078
|
+
deprecated: true,
|
|
25858
26079
|
description: 'Access code is disabled on Ultraloq device. Re-enable through the Ultraloq mobile app.',
|
|
25859
26080
|
properties: {
|
|
25860
26081
|
created_at: {
|
|
@@ -25874,6 +26095,7 @@ const openapi = {
|
|
|
25874
26095
|
},
|
|
25875
26096
|
required: ['message', 'warning_code'],
|
|
25876
26097
|
type: 'object',
|
|
26098
|
+
'x-deprecated': 'Use `access_code_inactive` instead.',
|
|
25877
26099
|
},
|
|
25878
26100
|
{
|
|
25879
26101
|
description: 'A backup access code has been pulled and is being used in place of this access code.',
|