@seamapi/types 1.404.1 → 1.404.3
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 +416 -138
- package/dist/connect.cjs.map +1 -1
- package/dist/connect.d.cts +448 -122
- package/lib/seam/connect/models/access-codes/managed-access-code.js +2 -8
- package/lib/seam/connect/models/access-codes/managed-access-code.js.map +1 -1
- package/lib/seam/connect/models/connected-accounts/connected-account.js +121 -41
- package/lib/seam/connect/models/connected-accounts/connected-account.js.map +1 -1
- package/lib/seam/connect/models/devices/device-provider.d.ts +1 -1
- package/lib/seam/connect/models/devices/device-provider.js +0 -1
- package/lib/seam/connect/models/devices/device-provider.js.map +1 -1
- package/lib/seam/connect/openapi.d.ts +125 -9
- package/lib/seam/connect/openapi.js +328 -90
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +323 -113
- package/package.json +1 -1
- package/src/lib/seam/connect/models/access-codes/managed-access-code.ts +2 -8
- package/src/lib/seam/connect/models/connected-accounts/connected-account.ts +172 -44
- package/src/lib/seam/connect/models/devices/device-provider.ts +0 -1
- package/src/lib/seam/connect/openapi.ts +404 -90
- package/src/lib/seam/connect/route-types.ts +330 -113
package/dist/connect.d.cts
CHANGED
|
@@ -21448,6 +21448,7 @@ declare const _default: {
|
|
|
21448
21448
|
is_connected_account_error: {
|
|
21449
21449
|
enum: boolean[];
|
|
21450
21450
|
type: string;
|
|
21451
|
+
description?: never;
|
|
21451
21452
|
};
|
|
21452
21453
|
is_device_error: {
|
|
21453
21454
|
enum: boolean[];
|
|
@@ -21503,15 +21504,17 @@ declare const _default: {
|
|
|
21503
21504
|
type: string;
|
|
21504
21505
|
};
|
|
21505
21506
|
is_bridge_error: {
|
|
21507
|
+
description: string;
|
|
21506
21508
|
type: string;
|
|
21507
21509
|
};
|
|
21508
21510
|
is_connected_account_error: {
|
|
21511
|
+
description: string;
|
|
21509
21512
|
type: string;
|
|
21510
21513
|
enum?: never;
|
|
21511
21514
|
};
|
|
21512
21515
|
message: {
|
|
21516
|
+
description: string;
|
|
21513
21517
|
type: string;
|
|
21514
|
-
description?: never;
|
|
21515
21518
|
};
|
|
21516
21519
|
is_access_code_error?: never;
|
|
21517
21520
|
is_device_error?: never;
|
|
@@ -24392,19 +24395,24 @@ declare const _default: {
|
|
|
24392
24395
|
description: string;
|
|
24393
24396
|
properties: {
|
|
24394
24397
|
account_type: {
|
|
24398
|
+
description: string;
|
|
24395
24399
|
type: string;
|
|
24396
24400
|
};
|
|
24397
24401
|
account_type_display_name: {
|
|
24402
|
+
description: string;
|
|
24398
24403
|
type: string;
|
|
24399
24404
|
};
|
|
24400
24405
|
automatically_manage_new_devices: {
|
|
24406
|
+
description: string;
|
|
24401
24407
|
type: string;
|
|
24402
24408
|
};
|
|
24403
24409
|
connected_account_id: {
|
|
24410
|
+
description: string;
|
|
24404
24411
|
format: string;
|
|
24405
24412
|
type: string;
|
|
24406
24413
|
};
|
|
24407
24414
|
created_at: {
|
|
24415
|
+
description: string;
|
|
24408
24416
|
format: string;
|
|
24409
24417
|
type: string;
|
|
24410
24418
|
};
|
|
@@ -24418,6 +24426,7 @@ declare const _default: {
|
|
|
24418
24426
|
type: string;
|
|
24419
24427
|
};
|
|
24420
24428
|
errors: {
|
|
24429
|
+
description: string;
|
|
24421
24430
|
items: {
|
|
24422
24431
|
discriminator: {
|
|
24423
24432
|
propertyName: string;
|
|
@@ -24436,12 +24445,15 @@ declare const _default: {
|
|
|
24436
24445
|
type: string;
|
|
24437
24446
|
};
|
|
24438
24447
|
is_bridge_error: {
|
|
24448
|
+
description: string;
|
|
24439
24449
|
type: string;
|
|
24440
24450
|
};
|
|
24441
24451
|
is_connected_account_error: {
|
|
24452
|
+
description: string;
|
|
24442
24453
|
type: string;
|
|
24443
24454
|
};
|
|
24444
24455
|
message: {
|
|
24456
|
+
description: string;
|
|
24445
24457
|
type: string;
|
|
24446
24458
|
};
|
|
24447
24459
|
salto_ks_metadata?: never;
|
|
@@ -24462,30 +24474,40 @@ declare const _default: {
|
|
|
24462
24474
|
type: string;
|
|
24463
24475
|
};
|
|
24464
24476
|
is_bridge_error: {
|
|
24477
|
+
description: string;
|
|
24465
24478
|
type: string;
|
|
24466
24479
|
};
|
|
24467
24480
|
is_connected_account_error: {
|
|
24481
|
+
description: string;
|
|
24468
24482
|
type: string;
|
|
24469
24483
|
};
|
|
24470
24484
|
message: {
|
|
24485
|
+
description: string;
|
|
24471
24486
|
type: string;
|
|
24472
24487
|
};
|
|
24473
24488
|
salto_ks_metadata: {
|
|
24489
|
+
description: string;
|
|
24474
24490
|
properties: {
|
|
24475
24491
|
sites: {
|
|
24492
|
+
description: string;
|
|
24476
24493
|
items: {
|
|
24494
|
+
description: string;
|
|
24477
24495
|
properties: {
|
|
24478
24496
|
site_id: {
|
|
24497
|
+
description: string;
|
|
24479
24498
|
type: string;
|
|
24480
24499
|
};
|
|
24481
24500
|
site_name: {
|
|
24501
|
+
description: string;
|
|
24482
24502
|
type: string;
|
|
24483
24503
|
};
|
|
24484
24504
|
site_user_subscription_limit: {
|
|
24505
|
+
description: string;
|
|
24485
24506
|
minimum: number;
|
|
24486
24507
|
type: string;
|
|
24487
24508
|
};
|
|
24488
24509
|
subscribed_site_user_count: {
|
|
24510
|
+
description: string;
|
|
24489
24511
|
minimum: number;
|
|
24490
24512
|
type: string;
|
|
24491
24513
|
};
|
|
@@ -24507,26 +24529,33 @@ declare const _default: {
|
|
|
24507
24529
|
type: string;
|
|
24508
24530
|
};
|
|
24509
24531
|
user_identifier: {
|
|
24532
|
+
description: string;
|
|
24510
24533
|
properties: {
|
|
24511
24534
|
api_url: {
|
|
24535
|
+
description: string;
|
|
24512
24536
|
type: string;
|
|
24513
24537
|
};
|
|
24514
24538
|
email: {
|
|
24539
|
+
description: string;
|
|
24515
24540
|
type: string;
|
|
24516
24541
|
};
|
|
24517
24542
|
exclusive: {
|
|
24543
|
+
description: string;
|
|
24518
24544
|
type: string;
|
|
24519
24545
|
};
|
|
24520
24546
|
phone: {
|
|
24547
|
+
description: string;
|
|
24521
24548
|
type: string;
|
|
24522
24549
|
};
|
|
24523
24550
|
username: {
|
|
24551
|
+
description: string;
|
|
24524
24552
|
type: string;
|
|
24525
24553
|
};
|
|
24526
24554
|
};
|
|
24527
24555
|
type: string;
|
|
24528
24556
|
};
|
|
24529
24557
|
warnings: {
|
|
24558
|
+
description: string;
|
|
24530
24559
|
items: {
|
|
24531
24560
|
description: string;
|
|
24532
24561
|
discriminator: {
|
|
@@ -24541,6 +24570,7 @@ declare const _default: {
|
|
|
24541
24570
|
type: string;
|
|
24542
24571
|
};
|
|
24543
24572
|
message: {
|
|
24573
|
+
description: string;
|
|
24544
24574
|
type: string;
|
|
24545
24575
|
};
|
|
24546
24576
|
warning_code: {
|
|
@@ -24561,24 +24591,32 @@ declare const _default: {
|
|
|
24561
24591
|
type: string;
|
|
24562
24592
|
};
|
|
24563
24593
|
message: {
|
|
24594
|
+
description: string;
|
|
24564
24595
|
type: string;
|
|
24565
24596
|
};
|
|
24566
24597
|
salto_ks_metadata: {
|
|
24598
|
+
description: string;
|
|
24567
24599
|
properties: {
|
|
24568
24600
|
sites: {
|
|
24601
|
+
description: string;
|
|
24569
24602
|
items: {
|
|
24603
|
+
description: string;
|
|
24570
24604
|
properties: {
|
|
24571
24605
|
site_id: {
|
|
24606
|
+
description: string;
|
|
24572
24607
|
type: string;
|
|
24573
24608
|
};
|
|
24574
24609
|
site_name: {
|
|
24610
|
+
description: string;
|
|
24575
24611
|
type: string;
|
|
24576
24612
|
};
|
|
24577
24613
|
site_user_subscription_limit: {
|
|
24614
|
+
description: string;
|
|
24578
24615
|
minimum: number;
|
|
24579
24616
|
type: string;
|
|
24580
24617
|
};
|
|
24581
24618
|
subscribed_site_user_count: {
|
|
24619
|
+
description: string;
|
|
24582
24620
|
minimum: number;
|
|
24583
24621
|
type: string;
|
|
24584
24622
|
};
|
|
@@ -24715,6 +24753,7 @@ declare const _default: {
|
|
|
24715
24753
|
is_connected_account_error: {
|
|
24716
24754
|
enum: boolean[];
|
|
24717
24755
|
type: string;
|
|
24756
|
+
description?: never;
|
|
24718
24757
|
};
|
|
24719
24758
|
is_device_error: {
|
|
24720
24759
|
enum: boolean[];
|
|
@@ -24722,6 +24761,7 @@ declare const _default: {
|
|
|
24722
24761
|
};
|
|
24723
24762
|
message: {
|
|
24724
24763
|
type: string;
|
|
24764
|
+
description?: never;
|
|
24725
24765
|
};
|
|
24726
24766
|
is_bridge_error?: never;
|
|
24727
24767
|
};
|
|
@@ -24746,6 +24786,7 @@ declare const _default: {
|
|
|
24746
24786
|
};
|
|
24747
24787
|
message: {
|
|
24748
24788
|
type: string;
|
|
24789
|
+
description?: never;
|
|
24749
24790
|
};
|
|
24750
24791
|
is_connected_account_error?: never;
|
|
24751
24792
|
is_bridge_error?: never;
|
|
@@ -24766,13 +24807,16 @@ declare const _default: {
|
|
|
24766
24807
|
type: string;
|
|
24767
24808
|
};
|
|
24768
24809
|
is_bridge_error: {
|
|
24810
|
+
description: string;
|
|
24769
24811
|
type: string;
|
|
24770
24812
|
};
|
|
24771
24813
|
is_connected_account_error: {
|
|
24814
|
+
description: string;
|
|
24772
24815
|
type: string;
|
|
24773
24816
|
enum?: never;
|
|
24774
24817
|
};
|
|
24775
24818
|
message: {
|
|
24819
|
+
description: string;
|
|
24776
24820
|
type: string;
|
|
24777
24821
|
};
|
|
24778
24822
|
is_device_error?: never;
|
|
@@ -30484,6 +30528,7 @@ declare const _default: {
|
|
|
30484
30528
|
is_connected_account_error: {
|
|
30485
30529
|
enum: boolean[];
|
|
30486
30530
|
type: string;
|
|
30531
|
+
description?: never;
|
|
30487
30532
|
};
|
|
30488
30533
|
is_device_error: {
|
|
30489
30534
|
enum: boolean[];
|
|
@@ -30539,15 +30584,17 @@ declare const _default: {
|
|
|
30539
30584
|
type: string;
|
|
30540
30585
|
};
|
|
30541
30586
|
is_bridge_error: {
|
|
30587
|
+
description: string;
|
|
30542
30588
|
type: string;
|
|
30543
30589
|
};
|
|
30544
30590
|
is_connected_account_error: {
|
|
30591
|
+
description: string;
|
|
30545
30592
|
type: string;
|
|
30546
30593
|
enum?: never;
|
|
30547
30594
|
};
|
|
30548
30595
|
message: {
|
|
30596
|
+
description: string;
|
|
30549
30597
|
type: string;
|
|
30550
|
-
description?: never;
|
|
30551
30598
|
};
|
|
30552
30599
|
is_access_code_error?: never;
|
|
30553
30600
|
is_device_error?: never;
|
|
@@ -31475,6 +31522,7 @@ declare const _default: {
|
|
|
31475
31522
|
is_connected_account_error: {
|
|
31476
31523
|
enum: boolean[];
|
|
31477
31524
|
type: string;
|
|
31525
|
+
description?: never;
|
|
31478
31526
|
};
|
|
31479
31527
|
is_device_error: {
|
|
31480
31528
|
enum: boolean[];
|
|
@@ -31482,6 +31530,7 @@ declare const _default: {
|
|
|
31482
31530
|
};
|
|
31483
31531
|
message: {
|
|
31484
31532
|
type: string;
|
|
31533
|
+
description?: never;
|
|
31485
31534
|
};
|
|
31486
31535
|
is_bridge_error?: never;
|
|
31487
31536
|
};
|
|
@@ -31506,6 +31555,7 @@ declare const _default: {
|
|
|
31506
31555
|
};
|
|
31507
31556
|
message: {
|
|
31508
31557
|
type: string;
|
|
31558
|
+
description?: never;
|
|
31509
31559
|
};
|
|
31510
31560
|
is_connected_account_error?: never;
|
|
31511
31561
|
is_bridge_error?: never;
|
|
@@ -31526,13 +31576,16 @@ declare const _default: {
|
|
|
31526
31576
|
type: string;
|
|
31527
31577
|
};
|
|
31528
31578
|
is_bridge_error: {
|
|
31579
|
+
description: string;
|
|
31529
31580
|
type: string;
|
|
31530
31581
|
};
|
|
31531
31582
|
is_connected_account_error: {
|
|
31583
|
+
description: string;
|
|
31532
31584
|
type: string;
|
|
31533
31585
|
enum?: never;
|
|
31534
31586
|
};
|
|
31535
31587
|
message: {
|
|
31588
|
+
description: string;
|
|
31536
31589
|
type: string;
|
|
31537
31590
|
};
|
|
31538
31591
|
is_device_error?: never;
|
|
@@ -37992,13 +38045,22 @@ declare const _default: {
|
|
|
37992
38045
|
'application/json': {
|
|
37993
38046
|
schema: {
|
|
37994
38047
|
properties: {
|
|
38048
|
+
acs_system_id: {
|
|
38049
|
+
description: string;
|
|
38050
|
+
format: string;
|
|
38051
|
+
type: string;
|
|
38052
|
+
};
|
|
37995
38053
|
acs_user_id: {
|
|
37996
38054
|
description: string;
|
|
37997
38055
|
format: string;
|
|
37998
38056
|
type: string;
|
|
37999
38057
|
};
|
|
38058
|
+
user_identity_id: {
|
|
38059
|
+
description: string;
|
|
38060
|
+
format: string;
|
|
38061
|
+
type: string;
|
|
38062
|
+
};
|
|
38000
38063
|
};
|
|
38001
|
-
required: string[];
|
|
38002
38064
|
type: string;
|
|
38003
38065
|
};
|
|
38004
38066
|
};
|
|
@@ -38058,13 +38120,22 @@ declare const _default: {
|
|
|
38058
38120
|
'application/json': {
|
|
38059
38121
|
schema: {
|
|
38060
38122
|
properties: {
|
|
38123
|
+
acs_system_id: {
|
|
38124
|
+
description: string;
|
|
38125
|
+
format: string;
|
|
38126
|
+
type: string;
|
|
38127
|
+
};
|
|
38061
38128
|
acs_user_id: {
|
|
38062
38129
|
description: string;
|
|
38063
38130
|
format: string;
|
|
38064
38131
|
type: string;
|
|
38065
38132
|
};
|
|
38133
|
+
user_identity_id: {
|
|
38134
|
+
description: string;
|
|
38135
|
+
format: string;
|
|
38136
|
+
type: string;
|
|
38137
|
+
};
|
|
38066
38138
|
};
|
|
38067
|
-
required: string[];
|
|
38068
38139
|
type: string;
|
|
38069
38140
|
};
|
|
38070
38141
|
};
|
|
@@ -38412,13 +38483,22 @@ declare const _default: {
|
|
|
38412
38483
|
'application/json': {
|
|
38413
38484
|
schema: {
|
|
38414
38485
|
properties: {
|
|
38486
|
+
acs_system_id: {
|
|
38487
|
+
description: string;
|
|
38488
|
+
format: string;
|
|
38489
|
+
type: string;
|
|
38490
|
+
};
|
|
38415
38491
|
acs_user_id: {
|
|
38416
38492
|
description: string;
|
|
38417
38493
|
format: string;
|
|
38418
38494
|
type: string;
|
|
38419
38495
|
};
|
|
38496
|
+
user_identity_id: {
|
|
38497
|
+
description: string;
|
|
38498
|
+
format: string;
|
|
38499
|
+
type: string;
|
|
38500
|
+
};
|
|
38420
38501
|
};
|
|
38421
|
-
required: string[];
|
|
38422
38502
|
type: string;
|
|
38423
38503
|
};
|
|
38424
38504
|
};
|
|
@@ -38478,13 +38558,22 @@ declare const _default: {
|
|
|
38478
38558
|
'application/json': {
|
|
38479
38559
|
schema: {
|
|
38480
38560
|
properties: {
|
|
38561
|
+
acs_system_id: {
|
|
38562
|
+
description: string;
|
|
38563
|
+
format: string;
|
|
38564
|
+
type: string;
|
|
38565
|
+
};
|
|
38481
38566
|
acs_user_id: {
|
|
38482
38567
|
description: string;
|
|
38483
38568
|
format: string;
|
|
38484
38569
|
type: string;
|
|
38485
38570
|
};
|
|
38571
|
+
user_identity_id: {
|
|
38572
|
+
description: string;
|
|
38573
|
+
format: string;
|
|
38574
|
+
type: string;
|
|
38575
|
+
};
|
|
38486
38576
|
};
|
|
38487
|
-
required: string[];
|
|
38488
38577
|
type: string;
|
|
38489
38578
|
};
|
|
38490
38579
|
};
|
|
@@ -38707,13 +38796,22 @@ declare const _default: {
|
|
|
38707
38796
|
'application/json': {
|
|
38708
38797
|
schema: {
|
|
38709
38798
|
properties: {
|
|
38799
|
+
acs_system_id: {
|
|
38800
|
+
description: string;
|
|
38801
|
+
format: string;
|
|
38802
|
+
type: string;
|
|
38803
|
+
};
|
|
38710
38804
|
acs_user_id: {
|
|
38711
38805
|
description: string;
|
|
38712
38806
|
format: string;
|
|
38713
38807
|
type: string;
|
|
38714
38808
|
};
|
|
38809
|
+
user_identity_id: {
|
|
38810
|
+
description: string;
|
|
38811
|
+
format: string;
|
|
38812
|
+
type: string;
|
|
38813
|
+
};
|
|
38715
38814
|
};
|
|
38716
|
-
required: string[];
|
|
38717
38815
|
type: string;
|
|
38718
38816
|
};
|
|
38719
38817
|
};
|
|
@@ -38791,6 +38889,11 @@ declare const _default: {
|
|
|
38791
38889
|
required: string[];
|
|
38792
38890
|
type: string;
|
|
38793
38891
|
};
|
|
38892
|
+
acs_system_id: {
|
|
38893
|
+
description: string;
|
|
38894
|
+
format: string;
|
|
38895
|
+
type: string;
|
|
38896
|
+
};
|
|
38794
38897
|
acs_user_id: {
|
|
38795
38898
|
description: string;
|
|
38796
38899
|
format: string;
|
|
@@ -38820,8 +38923,12 @@ declare const _default: {
|
|
|
38820
38923
|
description: string;
|
|
38821
38924
|
type: string;
|
|
38822
38925
|
};
|
|
38926
|
+
user_identity_id: {
|
|
38927
|
+
description: string;
|
|
38928
|
+
format: string;
|
|
38929
|
+
type: string;
|
|
38930
|
+
};
|
|
38823
38931
|
};
|
|
38824
|
-
required: string[];
|
|
38825
38932
|
type: string;
|
|
38826
38933
|
};
|
|
38827
38934
|
};
|
|
@@ -38896,6 +39003,11 @@ declare const _default: {
|
|
|
38896
39003
|
required: string[];
|
|
38897
39004
|
type: string;
|
|
38898
39005
|
};
|
|
39006
|
+
acs_system_id: {
|
|
39007
|
+
description: string;
|
|
39008
|
+
format: string;
|
|
39009
|
+
type: string;
|
|
39010
|
+
};
|
|
38899
39011
|
acs_user_id: {
|
|
38900
39012
|
description: string;
|
|
38901
39013
|
format: string;
|
|
@@ -38925,8 +39037,12 @@ declare const _default: {
|
|
|
38925
39037
|
description: string;
|
|
38926
39038
|
type: string;
|
|
38927
39039
|
};
|
|
39040
|
+
user_identity_id: {
|
|
39041
|
+
description: string;
|
|
39042
|
+
format: string;
|
|
39043
|
+
type: string;
|
|
39044
|
+
};
|
|
38928
39045
|
};
|
|
38929
|
-
required: string[];
|
|
38930
39046
|
type: string;
|
|
38931
39047
|
};
|
|
38932
39048
|
};
|
|
@@ -53298,13 +53414,7 @@ interface Routes {
|
|
|
53298
53414
|
jsonBody: {
|
|
53299
53415
|
/** ID of the device for which you want to create the new access code. */
|
|
53300
53416
|
device_id: string;
|
|
53301
|
-
/** Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.
|
|
53302
|
-
|
|
53303
|
-
Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`.
|
|
53304
|
-
|
|
53305
|
-
To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints.
|
|
53306
|
-
|
|
53307
|
-
To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components). */
|
|
53417
|
+
/** Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`. To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints. To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components). */
|
|
53308
53418
|
name?: string | undefined;
|
|
53309
53419
|
/** Date and time at which the validity of the new access code starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
|
|
53310
53420
|
starts_at?: string | undefined;
|
|
@@ -54461,13 +54571,7 @@ interface Routes {
|
|
|
54461
54571
|
access_code_id: string;
|
|
54462
54572
|
/** Unique identifier for the device associated with the access code. */
|
|
54463
54573
|
device_id: string;
|
|
54464
|
-
/** Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.
|
|
54465
|
-
|
|
54466
|
-
Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`.
|
|
54467
|
-
|
|
54468
|
-
To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints.
|
|
54469
|
-
|
|
54470
|
-
To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components). */
|
|
54574
|
+
/** Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`. To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints. To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components). */
|
|
54471
54575
|
name: string | null;
|
|
54472
54576
|
/** Code used for access. Typically, a numeric or alphanumeric string. */
|
|
54473
54577
|
code: string | null;
|
|
@@ -54782,16 +54886,22 @@ interface Routes {
|
|
|
54782
54886
|
} | {
|
|
54783
54887
|
/** Date and time at which Seam created the error. */
|
|
54784
54888
|
created_at: string;
|
|
54889
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
54785
54890
|
message: string;
|
|
54891
|
+
/** Indicates whether the error is related specifically to the connected account. */
|
|
54786
54892
|
is_connected_account_error?: boolean | undefined;
|
|
54893
|
+
/** Indicates whether the error is related to Seam Bridge. */
|
|
54787
54894
|
is_bridge_error?: boolean | undefined;
|
|
54788
54895
|
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
54789
54896
|
error_code: 'invalid_credentials';
|
|
54790
54897
|
} | {
|
|
54791
54898
|
/** Date and time at which Seam created the error. */
|
|
54792
54899
|
created_at: string;
|
|
54900
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
54793
54901
|
message: string;
|
|
54902
|
+
/** Indicates whether the error is related specifically to the connected account. */
|
|
54794
54903
|
is_connected_account_error?: boolean | undefined;
|
|
54904
|
+
/** Indicates whether the error is related to Seam Bridge. */
|
|
54795
54905
|
is_bridge_error?: boolean | undefined;
|
|
54796
54906
|
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
54797
54907
|
error_code: 'bridge_disconnected';
|
|
@@ -54888,7 +54998,7 @@ interface Routes {
|
|
|
54888
54998
|
starts_at?: (string | null) | undefined;
|
|
54889
54999
|
/** Date and time after which the time-bound access code becomes inactive. */
|
|
54890
55000
|
ends_at?: (string | null) | undefined;
|
|
54891
|
-
/** Current status of the access code within the operational lifecycle. Values are `setting`, a transitional phase that indicates that the code is being configured or activated; `set`, which indicates that the code is active and operational; `unset`, which indicates a deactivated or unused state, either before activation or after deliberate deactivation; `removing`, which indicates a transitional period in which the code is being deleted or made inactive; and `unknown`, which indicates an indeterminate state, due to reasons such as system errors or incomplete data, that highlights a potential need for system review or troubleshooting. */
|
|
55001
|
+
/** Current status of the access code within the operational lifecycle. Values are `setting`, a transitional phase that indicates that the code is being configured or activated; `set`, which indicates that the code is active and operational; `unset`, which indicates a deactivated or unused state, either before activation or after deliberate deactivation; `removing`, which indicates a transitional period in which the code is being deleted or made inactive; and `unknown`, which indicates an indeterminate state, due to reasons such as system errors or incomplete data, that highlights a potential need for system review or troubleshooting. See also [Lifecycle of Access Codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/lifecycle-of-access-codes). */
|
|
54892
55002
|
status: 'setting' | 'set' | 'unset' | 'removing' | 'unknown';
|
|
54893
55003
|
/** Indicates whether a backup access code is available for use if the primary access code is lost or compromised. */
|
|
54894
55004
|
is_backup_access_code_available: boolean;
|
|
@@ -54916,13 +55026,7 @@ interface Routes {
|
|
|
54916
55026
|
behavior_when_code_cannot_be_shared?: 'throw' | 'create_random_code';
|
|
54917
55027
|
/** Preferred code length. Only applicable if you do not specify a `code`. If the affected device does not support the preferred code length, Seam reverts to using the shortest supported code length. */
|
|
54918
55028
|
preferred_code_length?: number | undefined;
|
|
54919
|
-
/** Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.
|
|
54920
|
-
|
|
54921
|
-
Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`.
|
|
54922
|
-
|
|
54923
|
-
To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints.
|
|
54924
|
-
|
|
54925
|
-
To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components). */
|
|
55029
|
+
/** Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`. To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints. To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components). */
|
|
54926
55030
|
name?: string | undefined;
|
|
54927
55031
|
/** Date and time at which the validity of the new access code starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
|
|
54928
55032
|
starts_at?: string | undefined;
|
|
@@ -54963,13 +55067,7 @@ interface Routes {
|
|
|
54963
55067
|
access_code_id: string;
|
|
54964
55068
|
/** Unique identifier for the device associated with the access code. */
|
|
54965
55069
|
device_id: string;
|
|
54966
|
-
/** Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.
|
|
54967
|
-
|
|
54968
|
-
Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`.
|
|
54969
|
-
|
|
54970
|
-
To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints.
|
|
54971
|
-
|
|
54972
|
-
To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components). */
|
|
55070
|
+
/** Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`. To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints. To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components). */
|
|
54973
55071
|
name: string | null;
|
|
54974
55072
|
/** Code used for access. Typically, a numeric or alphanumeric string. */
|
|
54975
55073
|
code: string | null;
|
|
@@ -55284,16 +55382,22 @@ interface Routes {
|
|
|
55284
55382
|
} | {
|
|
55285
55383
|
/** Date and time at which Seam created the error. */
|
|
55286
55384
|
created_at: string;
|
|
55385
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
55287
55386
|
message: string;
|
|
55387
|
+
/** Indicates whether the error is related specifically to the connected account. */
|
|
55288
55388
|
is_connected_account_error?: boolean | undefined;
|
|
55389
|
+
/** Indicates whether the error is related to Seam Bridge. */
|
|
55289
55390
|
is_bridge_error?: boolean | undefined;
|
|
55290
55391
|
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
55291
55392
|
error_code: 'invalid_credentials';
|
|
55292
55393
|
} | {
|
|
55293
55394
|
/** Date and time at which Seam created the error. */
|
|
55294
55395
|
created_at: string;
|
|
55396
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
55295
55397
|
message: string;
|
|
55398
|
+
/** Indicates whether the error is related specifically to the connected account. */
|
|
55296
55399
|
is_connected_account_error?: boolean | undefined;
|
|
55400
|
+
/** Indicates whether the error is related to Seam Bridge. */
|
|
55297
55401
|
is_bridge_error?: boolean | undefined;
|
|
55298
55402
|
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
55299
55403
|
error_code: 'bridge_disconnected';
|
|
@@ -55390,7 +55494,7 @@ interface Routes {
|
|
|
55390
55494
|
starts_at?: (string | null) | undefined;
|
|
55391
55495
|
/** Date and time after which the time-bound access code becomes inactive. */
|
|
55392
55496
|
ends_at?: (string | null) | undefined;
|
|
55393
|
-
/** Current status of the access code within the operational lifecycle. Values are `setting`, a transitional phase that indicates that the code is being configured or activated; `set`, which indicates that the code is active and operational; `unset`, which indicates a deactivated or unused state, either before activation or after deliberate deactivation; `removing`, which indicates a transitional period in which the code is being deleted or made inactive; and `unknown`, which indicates an indeterminate state, due to reasons such as system errors or incomplete data, that highlights a potential need for system review or troubleshooting. */
|
|
55497
|
+
/** Current status of the access code within the operational lifecycle. Values are `setting`, a transitional phase that indicates that the code is being configured or activated; `set`, which indicates that the code is active and operational; `unset`, which indicates a deactivated or unused state, either before activation or after deliberate deactivation; `removing`, which indicates a transitional period in which the code is being deleted or made inactive; and `unknown`, which indicates an indeterminate state, due to reasons such as system errors or incomplete data, that highlights a potential need for system review or troubleshooting. See also [Lifecycle of Access Codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/lifecycle-of-access-codes). */
|
|
55394
55498
|
status: 'setting' | 'set' | 'unset' | 'removing' | 'unknown';
|
|
55395
55499
|
/** Indicates whether a backup access code is available for use if the primary access code is lost or compromised. */
|
|
55396
55500
|
is_backup_access_code_available: boolean;
|
|
@@ -56579,13 +56683,7 @@ interface Routes {
|
|
|
56579
56683
|
access_code_id: string;
|
|
56580
56684
|
/** Unique identifier for the device associated with the access code. */
|
|
56581
56685
|
device_id: string;
|
|
56582
|
-
/** Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.
|
|
56583
|
-
|
|
56584
|
-
Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`.
|
|
56585
|
-
|
|
56586
|
-
To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints.
|
|
56587
|
-
|
|
56588
|
-
To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components). */
|
|
56686
|
+
/** Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`. To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints. To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components). */
|
|
56589
56687
|
name: string | null;
|
|
56590
56688
|
/** Code used for access. Typically, a numeric or alphanumeric string. */
|
|
56591
56689
|
code: string | null;
|
|
@@ -56900,16 +56998,22 @@ interface Routes {
|
|
|
56900
56998
|
} | {
|
|
56901
56999
|
/** Date and time at which Seam created the error. */
|
|
56902
57000
|
created_at: string;
|
|
57001
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
56903
57002
|
message: string;
|
|
57003
|
+
/** Indicates whether the error is related specifically to the connected account. */
|
|
56904
57004
|
is_connected_account_error?: boolean | undefined;
|
|
57005
|
+
/** Indicates whether the error is related to Seam Bridge. */
|
|
56905
57006
|
is_bridge_error?: boolean | undefined;
|
|
56906
57007
|
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
56907
57008
|
error_code: 'invalid_credentials';
|
|
56908
57009
|
} | {
|
|
56909
57010
|
/** Date and time at which Seam created the error. */
|
|
56910
57011
|
created_at: string;
|
|
57012
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
56911
57013
|
message: string;
|
|
57014
|
+
/** Indicates whether the error is related specifically to the connected account. */
|
|
56912
57015
|
is_connected_account_error?: boolean | undefined;
|
|
57016
|
+
/** Indicates whether the error is related to Seam Bridge. */
|
|
56913
57017
|
is_bridge_error?: boolean | undefined;
|
|
56914
57018
|
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
56915
57019
|
error_code: 'bridge_disconnected';
|
|
@@ -57006,7 +57110,7 @@ interface Routes {
|
|
|
57006
57110
|
starts_at?: (string | null) | undefined;
|
|
57007
57111
|
/** Date and time after which the time-bound access code becomes inactive. */
|
|
57008
57112
|
ends_at?: (string | null) | undefined;
|
|
57009
|
-
/** Current status of the access code within the operational lifecycle. Values are `setting`, a transitional phase that indicates that the code is being configured or activated; `set`, which indicates that the code is active and operational; `unset`, which indicates a deactivated or unused state, either before activation or after deliberate deactivation; `removing`, which indicates a transitional period in which the code is being deleted or made inactive; and `unknown`, which indicates an indeterminate state, due to reasons such as system errors or incomplete data, that highlights a potential need for system review or troubleshooting. */
|
|
57113
|
+
/** Current status of the access code within the operational lifecycle. Values are `setting`, a transitional phase that indicates that the code is being configured or activated; `set`, which indicates that the code is active and operational; `unset`, which indicates a deactivated or unused state, either before activation or after deliberate deactivation; `removing`, which indicates a transitional period in which the code is being deleted or made inactive; and `unknown`, which indicates an indeterminate state, due to reasons such as system errors or incomplete data, that highlights a potential need for system review or troubleshooting. See also [Lifecycle of Access Codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/lifecycle-of-access-codes). */
|
|
57010
57114
|
status: 'setting' | 'set' | 'unset' | 'removing' | 'unknown';
|
|
57011
57115
|
/** Indicates whether a backup access code is available for use if the primary access code is lost or compromised. */
|
|
57012
57116
|
is_backup_access_code_available: boolean;
|
|
@@ -57055,13 +57159,7 @@ interface Routes {
|
|
|
57055
57159
|
access_code_id: string;
|
|
57056
57160
|
/** Unique identifier for the device associated with the access code. */
|
|
57057
57161
|
device_id: string;
|
|
57058
|
-
/** Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.
|
|
57059
|
-
|
|
57060
|
-
Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`.
|
|
57061
|
-
|
|
57062
|
-
To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints.
|
|
57063
|
-
|
|
57064
|
-
To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components). */
|
|
57162
|
+
/** Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`. To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints. To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components). */
|
|
57065
57163
|
name: string | null;
|
|
57066
57164
|
/** Code used for access. Typically, a numeric or alphanumeric string. */
|
|
57067
57165
|
code: string | null;
|
|
@@ -57376,16 +57474,22 @@ interface Routes {
|
|
|
57376
57474
|
} | {
|
|
57377
57475
|
/** Date and time at which Seam created the error. */
|
|
57378
57476
|
created_at: string;
|
|
57477
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
57379
57478
|
message: string;
|
|
57479
|
+
/** Indicates whether the error is related specifically to the connected account. */
|
|
57380
57480
|
is_connected_account_error?: boolean | undefined;
|
|
57481
|
+
/** Indicates whether the error is related to Seam Bridge. */
|
|
57381
57482
|
is_bridge_error?: boolean | undefined;
|
|
57382
57483
|
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
57383
57484
|
error_code: 'invalid_credentials';
|
|
57384
57485
|
} | {
|
|
57385
57486
|
/** Date and time at which Seam created the error. */
|
|
57386
57487
|
created_at: string;
|
|
57488
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
57387
57489
|
message: string;
|
|
57490
|
+
/** Indicates whether the error is related specifically to the connected account. */
|
|
57388
57491
|
is_connected_account_error?: boolean | undefined;
|
|
57492
|
+
/** Indicates whether the error is related to Seam Bridge. */
|
|
57389
57493
|
is_bridge_error?: boolean | undefined;
|
|
57390
57494
|
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
57391
57495
|
error_code: 'bridge_disconnected';
|
|
@@ -57482,7 +57586,7 @@ interface Routes {
|
|
|
57482
57586
|
starts_at?: (string | null) | undefined;
|
|
57483
57587
|
/** Date and time after which the time-bound access code becomes inactive. */
|
|
57484
57588
|
ends_at?: (string | null) | undefined;
|
|
57485
|
-
/** Current status of the access code within the operational lifecycle. Values are `setting`, a transitional phase that indicates that the code is being configured or activated; `set`, which indicates that the code is active and operational; `unset`, which indicates a deactivated or unused state, either before activation or after deliberate deactivation; `removing`, which indicates a transitional period in which the code is being deleted or made inactive; and `unknown`, which indicates an indeterminate state, due to reasons such as system errors or incomplete data, that highlights a potential need for system review or troubleshooting. */
|
|
57589
|
+
/** Current status of the access code within the operational lifecycle. Values are `setting`, a transitional phase that indicates that the code is being configured or activated; `set`, which indicates that the code is active and operational; `unset`, which indicates a deactivated or unused state, either before activation or after deliberate deactivation; `removing`, which indicates a transitional period in which the code is being deleted or made inactive; and `unknown`, which indicates an indeterminate state, due to reasons such as system errors or incomplete data, that highlights a potential need for system review or troubleshooting. See also [Lifecycle of Access Codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/lifecycle-of-access-codes). */
|
|
57486
57590
|
status: 'setting' | 'set' | 'unset' | 'removing' | 'unknown';
|
|
57487
57591
|
/** Indicates whether a backup access code is available for use if the primary access code is lost or compromised. */
|
|
57488
57592
|
is_backup_access_code_available: boolean;
|
|
@@ -57539,13 +57643,7 @@ interface Routes {
|
|
|
57539
57643
|
access_code_id: string;
|
|
57540
57644
|
/** Unique identifier for the device associated with the access code. */
|
|
57541
57645
|
device_id: string;
|
|
57542
|
-
/** Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.
|
|
57543
|
-
|
|
57544
|
-
Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`.
|
|
57545
|
-
|
|
57546
|
-
To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints.
|
|
57547
|
-
|
|
57548
|
-
To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components). */
|
|
57646
|
+
/** Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`. To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints. To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components). */
|
|
57549
57647
|
name: string | null;
|
|
57550
57648
|
/** Code used for access. Typically, a numeric or alphanumeric string. */
|
|
57551
57649
|
code: string | null;
|
|
@@ -57860,16 +57958,22 @@ interface Routes {
|
|
|
57860
57958
|
} | {
|
|
57861
57959
|
/** Date and time at which Seam created the error. */
|
|
57862
57960
|
created_at: string;
|
|
57961
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
57863
57962
|
message: string;
|
|
57963
|
+
/** Indicates whether the error is related specifically to the connected account. */
|
|
57864
57964
|
is_connected_account_error?: boolean | undefined;
|
|
57965
|
+
/** Indicates whether the error is related to Seam Bridge. */
|
|
57865
57966
|
is_bridge_error?: boolean | undefined;
|
|
57866
57967
|
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
57867
57968
|
error_code: 'invalid_credentials';
|
|
57868
57969
|
} | {
|
|
57869
57970
|
/** Date and time at which Seam created the error. */
|
|
57870
57971
|
created_at: string;
|
|
57972
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
57871
57973
|
message: string;
|
|
57974
|
+
/** Indicates whether the error is related specifically to the connected account. */
|
|
57872
57975
|
is_connected_account_error?: boolean | undefined;
|
|
57976
|
+
/** Indicates whether the error is related to Seam Bridge. */
|
|
57873
57977
|
is_bridge_error?: boolean | undefined;
|
|
57874
57978
|
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
57875
57979
|
error_code: 'bridge_disconnected';
|
|
@@ -57966,7 +58070,7 @@ interface Routes {
|
|
|
57966
58070
|
starts_at?: (string | null) | undefined;
|
|
57967
58071
|
/** Date and time after which the time-bound access code becomes inactive. */
|
|
57968
58072
|
ends_at?: (string | null) | undefined;
|
|
57969
|
-
/** Current status of the access code within the operational lifecycle. Values are `setting`, a transitional phase that indicates that the code is being configured or activated; `set`, which indicates that the code is active and operational; `unset`, which indicates a deactivated or unused state, either before activation or after deliberate deactivation; `removing`, which indicates a transitional period in which the code is being deleted or made inactive; and `unknown`, which indicates an indeterminate state, due to reasons such as system errors or incomplete data, that highlights a potential need for system review or troubleshooting. */
|
|
58073
|
+
/** Current status of the access code within the operational lifecycle. Values are `setting`, a transitional phase that indicates that the code is being configured or activated; `set`, which indicates that the code is active and operational; `unset`, which indicates a deactivated or unused state, either before activation or after deliberate deactivation; `removing`, which indicates a transitional period in which the code is being deleted or made inactive; and `unknown`, which indicates an indeterminate state, due to reasons such as system errors or incomplete data, that highlights a potential need for system review or troubleshooting. See also [Lifecycle of Access Codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/lifecycle-of-access-codes). */
|
|
57970
58074
|
status: 'setting' | 'set' | 'unset' | 'removing' | 'unknown';
|
|
57971
58075
|
/** Indicates whether a backup access code is available for use if the primary access code is lost or compromised. */
|
|
57972
58076
|
is_backup_access_code_available: boolean;
|
|
@@ -58001,13 +58105,7 @@ interface Routes {
|
|
|
58001
58105
|
access_code_id: string;
|
|
58002
58106
|
/** Unique identifier for the device associated with the access code. */
|
|
58003
58107
|
device_id: string;
|
|
58004
|
-
/** Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.
|
|
58005
|
-
|
|
58006
|
-
Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`.
|
|
58007
|
-
|
|
58008
|
-
To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints.
|
|
58009
|
-
|
|
58010
|
-
To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components). */
|
|
58108
|
+
/** Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`. To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints. To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components). */
|
|
58011
58109
|
name: string | null;
|
|
58012
58110
|
/** Code used for access. Typically, a numeric or alphanumeric string. */
|
|
58013
58111
|
code: string | null;
|
|
@@ -58322,16 +58420,22 @@ interface Routes {
|
|
|
58322
58420
|
} | {
|
|
58323
58421
|
/** Date and time at which Seam created the error. */
|
|
58324
58422
|
created_at: string;
|
|
58423
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
58325
58424
|
message: string;
|
|
58425
|
+
/** Indicates whether the error is related specifically to the connected account. */
|
|
58326
58426
|
is_connected_account_error?: boolean | undefined;
|
|
58427
|
+
/** Indicates whether the error is related to Seam Bridge. */
|
|
58327
58428
|
is_bridge_error?: boolean | undefined;
|
|
58328
58429
|
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
58329
58430
|
error_code: 'invalid_credentials';
|
|
58330
58431
|
} | {
|
|
58331
58432
|
/** Date and time at which Seam created the error. */
|
|
58332
58433
|
created_at: string;
|
|
58434
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
58333
58435
|
message: string;
|
|
58436
|
+
/** Indicates whether the error is related specifically to the connected account. */
|
|
58334
58437
|
is_connected_account_error?: boolean | undefined;
|
|
58438
|
+
/** Indicates whether the error is related to Seam Bridge. */
|
|
58335
58439
|
is_bridge_error?: boolean | undefined;
|
|
58336
58440
|
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
58337
58441
|
error_code: 'bridge_disconnected';
|
|
@@ -58428,7 +58532,7 @@ interface Routes {
|
|
|
58428
58532
|
starts_at?: (string | null) | undefined;
|
|
58429
58533
|
/** Date and time after which the time-bound access code becomes inactive. */
|
|
58430
58534
|
ends_at?: (string | null) | undefined;
|
|
58431
|
-
/** Current status of the access code within the operational lifecycle. Values are `setting`, a transitional phase that indicates that the code is being configured or activated; `set`, which indicates that the code is active and operational; `unset`, which indicates a deactivated or unused state, either before activation or after deliberate deactivation; `removing`, which indicates a transitional period in which the code is being deleted or made inactive; and `unknown`, which indicates an indeterminate state, due to reasons such as system errors or incomplete data, that highlights a potential need for system review or troubleshooting. */
|
|
58535
|
+
/** Current status of the access code within the operational lifecycle. Values are `setting`, a transitional phase that indicates that the code is being configured or activated; `set`, which indicates that the code is active and operational; `unset`, which indicates a deactivated or unused state, either before activation or after deliberate deactivation; `removing`, which indicates a transitional period in which the code is being deleted or made inactive; and `unknown`, which indicates an indeterminate state, due to reasons such as system errors or incomplete data, that highlights a potential need for system review or troubleshooting. See also [Lifecycle of Access Codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/lifecycle-of-access-codes). */
|
|
58432
58536
|
status: 'setting' | 'set' | 'unset' | 'removing' | 'unknown';
|
|
58433
58537
|
/** Indicates whether a backup access code is available for use if the primary access code is lost or compromised. */
|
|
58434
58538
|
is_backup_access_code_available: boolean;
|
|
@@ -58496,13 +58600,7 @@ interface Routes {
|
|
|
58496
58600
|
access_code_id: string;
|
|
58497
58601
|
/** Unique identifier for the device associated with the access code. */
|
|
58498
58602
|
device_id: string;
|
|
58499
|
-
/** Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.
|
|
58500
|
-
|
|
58501
|
-
Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`.
|
|
58502
|
-
|
|
58503
|
-
To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints.
|
|
58504
|
-
|
|
58505
|
-
To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components). */
|
|
58603
|
+
/** Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`. To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints. To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components). */
|
|
58506
58604
|
name: string | null;
|
|
58507
58605
|
/** Code used for access. Typically, a numeric or alphanumeric string. */
|
|
58508
58606
|
code: string | null;
|
|
@@ -58817,16 +58915,22 @@ interface Routes {
|
|
|
58817
58915
|
} | {
|
|
58818
58916
|
/** Date and time at which Seam created the error. */
|
|
58819
58917
|
created_at: string;
|
|
58918
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
58820
58919
|
message: string;
|
|
58920
|
+
/** Indicates whether the error is related specifically to the connected account. */
|
|
58821
58921
|
is_connected_account_error?: boolean | undefined;
|
|
58922
|
+
/** Indicates whether the error is related to Seam Bridge. */
|
|
58822
58923
|
is_bridge_error?: boolean | undefined;
|
|
58823
58924
|
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
58824
58925
|
error_code: 'invalid_credentials';
|
|
58825
58926
|
} | {
|
|
58826
58927
|
/** Date and time at which Seam created the error. */
|
|
58827
58928
|
created_at: string;
|
|
58929
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
58828
58930
|
message: string;
|
|
58931
|
+
/** Indicates whether the error is related specifically to the connected account. */
|
|
58829
58932
|
is_connected_account_error?: boolean | undefined;
|
|
58933
|
+
/** Indicates whether the error is related to Seam Bridge. */
|
|
58830
58934
|
is_bridge_error?: boolean | undefined;
|
|
58831
58935
|
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
58832
58936
|
error_code: 'bridge_disconnected';
|
|
@@ -60099,13 +60203,7 @@ interface Routes {
|
|
|
60099
60203
|
access_code_id: string;
|
|
60100
60204
|
/** Unique identifier for the device associated with the access code. */
|
|
60101
60205
|
device_id: string;
|
|
60102
|
-
/** Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.
|
|
60103
|
-
|
|
60104
|
-
Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`.
|
|
60105
|
-
|
|
60106
|
-
To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints.
|
|
60107
|
-
|
|
60108
|
-
To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components). */
|
|
60206
|
+
/** Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`. To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints. To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components). */
|
|
60109
60207
|
name: string | null;
|
|
60110
60208
|
/** Code used for access. Typically, a numeric or alphanumeric string. */
|
|
60111
60209
|
code: string | null;
|
|
@@ -60420,16 +60518,22 @@ interface Routes {
|
|
|
60420
60518
|
} | {
|
|
60421
60519
|
/** Date and time at which Seam created the error. */
|
|
60422
60520
|
created_at: string;
|
|
60521
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
60423
60522
|
message: string;
|
|
60523
|
+
/** Indicates whether the error is related specifically to the connected account. */
|
|
60424
60524
|
is_connected_account_error?: boolean | undefined;
|
|
60525
|
+
/** Indicates whether the error is related to Seam Bridge. */
|
|
60425
60526
|
is_bridge_error?: boolean | undefined;
|
|
60426
60527
|
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
60427
60528
|
error_code: 'invalid_credentials';
|
|
60428
60529
|
} | {
|
|
60429
60530
|
/** Date and time at which Seam created the error. */
|
|
60430
60531
|
created_at: string;
|
|
60532
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
60431
60533
|
message: string;
|
|
60534
|
+
/** Indicates whether the error is related specifically to the connected account. */
|
|
60432
60535
|
is_connected_account_error?: boolean | undefined;
|
|
60536
|
+
/** Indicates whether the error is related to Seam Bridge. */
|
|
60433
60537
|
is_bridge_error?: boolean | undefined;
|
|
60434
60538
|
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
60435
60539
|
error_code: 'bridge_disconnected';
|
|
@@ -60551,13 +60655,7 @@ interface Routes {
|
|
|
60551
60655
|
access_code_id: string;
|
|
60552
60656
|
/** Unique identifier for the device associated with the access code. */
|
|
60553
60657
|
device_id: string;
|
|
60554
|
-
/** Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.
|
|
60555
|
-
|
|
60556
|
-
Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`.
|
|
60557
|
-
|
|
60558
|
-
To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints.
|
|
60559
|
-
|
|
60560
|
-
To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components). */
|
|
60658
|
+
/** Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`. To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints. To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components). */
|
|
60561
60659
|
name: string | null;
|
|
60562
60660
|
/** Code used for access. Typically, a numeric or alphanumeric string. */
|
|
60563
60661
|
code: string | null;
|
|
@@ -60872,16 +60970,22 @@ interface Routes {
|
|
|
60872
60970
|
} | {
|
|
60873
60971
|
/** Date and time at which Seam created the error. */
|
|
60874
60972
|
created_at: string;
|
|
60973
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
60875
60974
|
message: string;
|
|
60975
|
+
/** Indicates whether the error is related specifically to the connected account. */
|
|
60876
60976
|
is_connected_account_error?: boolean | undefined;
|
|
60977
|
+
/** Indicates whether the error is related to Seam Bridge. */
|
|
60877
60978
|
is_bridge_error?: boolean | undefined;
|
|
60878
60979
|
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
60879
60980
|
error_code: 'invalid_credentials';
|
|
60880
60981
|
} | {
|
|
60881
60982
|
/** Date and time at which Seam created the error. */
|
|
60882
60983
|
created_at: string;
|
|
60984
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
60883
60985
|
message: string;
|
|
60986
|
+
/** Indicates whether the error is related specifically to the connected account. */
|
|
60884
60987
|
is_connected_account_error?: boolean | undefined;
|
|
60988
|
+
/** Indicates whether the error is related to Seam Bridge. */
|
|
60885
60989
|
is_bridge_error?: boolean | undefined;
|
|
60886
60990
|
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
60887
60991
|
error_code: 'bridge_disconnected';
|
|
@@ -61007,13 +61111,7 @@ interface Routes {
|
|
|
61007
61111
|
method: 'POST' | 'PATCH' | 'PUT';
|
|
61008
61112
|
queryParams: {};
|
|
61009
61113
|
jsonBody: {
|
|
61010
|
-
/** Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.
|
|
61011
|
-
|
|
61012
|
-
Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`.
|
|
61013
|
-
|
|
61014
|
-
To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints.
|
|
61015
|
-
|
|
61016
|
-
To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components). */
|
|
61114
|
+
/** Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`. To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints. To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components). */
|
|
61017
61115
|
name?: string | undefined;
|
|
61018
61116
|
/** Date and time at which the validity of the new access code starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
|
|
61019
61117
|
starts_at?: string | undefined;
|
|
@@ -62167,13 +62265,7 @@ interface Routes {
|
|
|
62167
62265
|
ends_at?: string | undefined;
|
|
62168
62266
|
/** Date and time at which the validity of the new access code starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
|
|
62169
62267
|
starts_at?: string | undefined;
|
|
62170
|
-
/** Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.
|
|
62171
|
-
|
|
62172
|
-
Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`.
|
|
62173
|
-
|
|
62174
|
-
To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints.
|
|
62175
|
-
|
|
62176
|
-
To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components). */
|
|
62268
|
+
/** Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`. To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints. To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components). */
|
|
62177
62269
|
name?: string | undefined;
|
|
62178
62270
|
/** Key that links the group of access codes, assigned on creation by `/access_codes/create_multiple`. */
|
|
62179
62271
|
common_code_key: string;
|
|
@@ -68584,8 +68676,12 @@ interface Routes {
|
|
|
68584
68676
|
queryParams: {};
|
|
68585
68677
|
jsonBody: {};
|
|
68586
68678
|
commonParams: {
|
|
68587
|
-
/** ID of the access system user that you want to delete. */
|
|
68588
|
-
acs_user_id
|
|
68679
|
+
/** ID of the access system user that you want to delete. You must provide either acs_user_id or user_identity_id */
|
|
68680
|
+
acs_user_id?: string | undefined;
|
|
68681
|
+
/** ID of the user identity that you want to delete. You must provide either acs_user_id or user_identity_id. If you provide user_identity_id, you must also provide acs_system_id. */
|
|
68682
|
+
user_identity_id?: string | undefined;
|
|
68683
|
+
/** ID of the access system that you want to delete. You must provide acs_system_id with user_identity_id. */
|
|
68684
|
+
acs_system_id?: string | undefined;
|
|
68589
68685
|
};
|
|
68590
68686
|
formData: {};
|
|
68591
68687
|
jsonResponse: {};
|
|
@@ -68596,8 +68692,12 @@ interface Routes {
|
|
|
68596
68692
|
queryParams: {};
|
|
68597
68693
|
jsonBody: {};
|
|
68598
68694
|
commonParams: {
|
|
68599
|
-
/** ID of the access system user that you want to get. */
|
|
68600
|
-
acs_user_id
|
|
68695
|
+
/** ID of the access system user that you want to get. You can only provide acs_user_id or user_identity_id. */
|
|
68696
|
+
acs_user_id?: string | undefined;
|
|
68697
|
+
/** ID of the user identity that you want to get. You can only provide acs_user_id or user_identity_id. */
|
|
68698
|
+
user_identity_id?: string | undefined;
|
|
68699
|
+
/** ID of the access system that you want to get. You can only provide acs_user_id or user_identity_id. */
|
|
68700
|
+
acs_system_id?: string | undefined;
|
|
68601
68701
|
};
|
|
68602
68702
|
formData: {};
|
|
68603
68703
|
jsonResponse: {
|
|
@@ -69108,8 +69208,12 @@ interface Routes {
|
|
|
69108
69208
|
method: 'POST';
|
|
69109
69209
|
queryParams: {};
|
|
69110
69210
|
jsonBody: {
|
|
69111
|
-
/** ID of the access system user for whom you want to revoke access. */
|
|
69112
|
-
acs_user_id
|
|
69211
|
+
/** ID of the access system user for whom you want to revoke access. You can only provide acs_user_id or user_identity_id. */
|
|
69212
|
+
acs_user_id?: string | undefined;
|
|
69213
|
+
/** ID of the user identity for whom you want to revoke access. You can only provide acs_user_id or user_identity_id. */
|
|
69214
|
+
user_identity_id?: string | undefined;
|
|
69215
|
+
/** ID of the access system for which you want to revoke access. You can only provide acs_system_id with user_identity_id. */
|
|
69216
|
+
acs_system_id?: string | undefined;
|
|
69113
69217
|
};
|
|
69114
69218
|
commonParams: {};
|
|
69115
69219
|
formData: {};
|
|
@@ -69121,8 +69225,12 @@ interface Routes {
|
|
|
69121
69225
|
queryParams: {};
|
|
69122
69226
|
jsonBody: {};
|
|
69123
69227
|
commonParams: {
|
|
69124
|
-
/** ID of the access system user that you want to suspend. */
|
|
69125
|
-
acs_user_id
|
|
69228
|
+
/** ID of the access system user that you want to suspend. You can only provide acs_user_id or the combination of acs_system_id and user_identity_id. */
|
|
69229
|
+
acs_user_id?: string | undefined;
|
|
69230
|
+
/** ID of the user identity that you want to suspend. You can only provide acs_user_id or the combination of acs_system_id and user_identity_id. */
|
|
69231
|
+
user_identity_id?: string | undefined;
|
|
69232
|
+
/** ID of the access system that you want to suspend. You can only provide acs_user_id or the combination of acs_system_id and user_identity_id. */
|
|
69233
|
+
acs_system_id?: string | undefined;
|
|
69126
69234
|
};
|
|
69127
69235
|
formData: {};
|
|
69128
69236
|
jsonResponse: {};
|
|
@@ -69532,8 +69640,12 @@ interface Routes {
|
|
|
69532
69640
|
queryParams: {};
|
|
69533
69641
|
jsonBody: {};
|
|
69534
69642
|
commonParams: {
|
|
69535
|
-
/** ID of the access system user that you want to unsuspend. */
|
|
69536
|
-
acs_user_id
|
|
69643
|
+
/** ID of the access system user that you want to unsuspend. You can only provide acs_user_id or the combination of acs_system_id and user_identity_id. */
|
|
69644
|
+
acs_user_id?: string | undefined;
|
|
69645
|
+
/** ID of the user identity that you want to unsuspend. You can only provide acs_user_id or the combination of acs_system_id and user_identity_id. */
|
|
69646
|
+
user_identity_id?: string | undefined;
|
|
69647
|
+
/** ID of the access system of the user that you want to unsuspend. You can only provide acs_system_id with user_identity_id. */
|
|
69648
|
+
acs_system_id?: string | undefined;
|
|
69537
69649
|
};
|
|
69538
69650
|
formData: {};
|
|
69539
69651
|
jsonResponse: {};
|
|
@@ -69550,8 +69662,12 @@ interface Routes {
|
|
|
69550
69662
|
/** Ending timestamp for the access system user's access. */
|
|
69551
69663
|
ends_at: string;
|
|
69552
69664
|
} | null) | undefined;
|
|
69553
|
-
/** ID of the
|
|
69554
|
-
acs_user_id
|
|
69665
|
+
/** ID of the access system user that you want to update. You can only provide acs_user_id or user_identity_id. */
|
|
69666
|
+
acs_user_id?: string | undefined;
|
|
69667
|
+
/** ID of the user identity that you want to update. You can only provide acs_user_id or user_identity_id. If you provide user_identity_id, you must also provide acs_system_id. */
|
|
69668
|
+
user_identity_id?: string | undefined;
|
|
69669
|
+
/** ID of the access system that you want to update. You can only provide acs_system_id with user_identity_id. */
|
|
69670
|
+
acs_system_id?: string | undefined;
|
|
69555
69671
|
/** Full name of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). */
|
|
69556
69672
|
full_name?: string | undefined;
|
|
69557
69673
|
/**
|
|
@@ -72295,87 +72411,127 @@ interface Routes {
|
|
|
72295
72411
|
jsonResponse: {
|
|
72296
72412
|
/** Represents a [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts). A connected account is an external third-party account to which your user has authorized Seam to get access, for example, an August account with a list of door locks. */
|
|
72297
72413
|
connected_account: {
|
|
72414
|
+
/** Unique identifier for the connected account. */
|
|
72298
72415
|
connected_account_id?: string | undefined;
|
|
72416
|
+
/** Date and time at which the connected account was created. */
|
|
72299
72417
|
created_at?: string | undefined;
|
|
72418
|
+
/** User identifier associated with the connected account. */
|
|
72300
72419
|
user_identifier?: {
|
|
72420
|
+
/** Username of the user identifier associated with the connected account. */
|
|
72301
72421
|
username?: string | undefined;
|
|
72422
|
+
/** API URL for the user identifier associated with the connected account. */
|
|
72302
72423
|
api_url?: string | undefined;
|
|
72424
|
+
/** Email address of the user identifier associated with the connected account. */
|
|
72303
72425
|
email?: string | undefined;
|
|
72426
|
+
/** Phone number of the user identifier associated with the connected account. */
|
|
72304
72427
|
phone?: string | undefined;
|
|
72428
|
+
/** Indicates whether the user identifier associated with the connected account is exclusive. */
|
|
72305
72429
|
exclusive?: boolean | undefined;
|
|
72306
72430
|
} | undefined;
|
|
72431
|
+
/** Type of connected account. */
|
|
72307
72432
|
account_type?: string | undefined;
|
|
72433
|
+
/** Display name for the connected account type. */
|
|
72308
72434
|
account_type_display_name: string;
|
|
72435
|
+
/** Errors associated with the connected account. */
|
|
72309
72436
|
errors: Array<{
|
|
72310
72437
|
/** Date and time at which Seam created the error. */
|
|
72311
72438
|
created_at: string;
|
|
72439
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
72312
72440
|
message: string;
|
|
72441
|
+
/** Indicates whether the error is related specifically to the connected account. */
|
|
72313
72442
|
is_connected_account_error?: boolean | undefined;
|
|
72443
|
+
/** Indicates whether the error is related to Seam Bridge. */
|
|
72314
72444
|
is_bridge_error?: boolean | undefined;
|
|
72315
72445
|
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
72316
72446
|
error_code: 'account_disconnected';
|
|
72317
72447
|
} | {
|
|
72318
72448
|
/** Date and time at which Seam created the error. */
|
|
72319
72449
|
created_at: string;
|
|
72450
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
72320
72451
|
message: string;
|
|
72452
|
+
/** Indicates whether the error is related specifically to the connected account. */
|
|
72321
72453
|
is_connected_account_error?: boolean | undefined;
|
|
72454
|
+
/** Indicates whether the error is related to Seam Bridge. */
|
|
72322
72455
|
is_bridge_error?: boolean | undefined;
|
|
72323
72456
|
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
72324
72457
|
error_code: 'invalid_credentials';
|
|
72325
72458
|
} | {
|
|
72326
72459
|
/** Date and time at which Seam created the error. */
|
|
72327
72460
|
created_at: string;
|
|
72461
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
72328
72462
|
message: string;
|
|
72463
|
+
/** Indicates whether the error is related specifically to the connected account. */
|
|
72329
72464
|
is_connected_account_error?: boolean | undefined;
|
|
72465
|
+
/** Indicates whether the error is related to Seam Bridge. */
|
|
72330
72466
|
is_bridge_error?: boolean | undefined;
|
|
72331
72467
|
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
72332
72468
|
error_code: 'bridge_disconnected';
|
|
72333
72469
|
} | {
|
|
72334
72470
|
/** Date and time at which Seam created the error. */
|
|
72335
72471
|
created_at: string;
|
|
72472
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
72336
72473
|
message: string;
|
|
72474
|
+
/** Indicates whether the error is related specifically to the connected account. */
|
|
72337
72475
|
is_connected_account_error?: boolean | undefined;
|
|
72476
|
+
/** Indicates whether the error is related to Seam Bridge. */
|
|
72338
72477
|
is_bridge_error?: boolean | undefined;
|
|
72339
72478
|
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
72340
72479
|
error_code: 'salto_ks_subscription_limit_exceeded';
|
|
72480
|
+
/** Salto KS metadata associated with the connected account that has an error. */
|
|
72341
72481
|
salto_ks_metadata: {
|
|
72482
|
+
/** Salto sites associated with the connected account that has an error. */
|
|
72342
72483
|
sites: Array<{
|
|
72484
|
+
/** ID of a Salto site associated with the connected account that has an error. */
|
|
72343
72485
|
site_id: string;
|
|
72486
|
+
/** Name of a Salto site associated with the connected account that has an error. */
|
|
72344
72487
|
site_name: string;
|
|
72488
|
+
/** Count of subscribed site users for a Salto site associated with the connected account that has an error. */
|
|
72345
72489
|
subscribed_site_user_count: number;
|
|
72490
|
+
/** Subscription limit of site users for a Salto site associated with the connected account that has an error. */
|
|
72346
72491
|
site_user_subscription_limit: number;
|
|
72347
72492
|
}>;
|
|
72348
72493
|
};
|
|
72349
72494
|
}>;
|
|
72495
|
+
/** Warnings associated with the connected account. */
|
|
72350
72496
|
warnings: Array<{
|
|
72351
72497
|
/** Date and time at which Seam created the warning. */
|
|
72352
72498
|
created_at: string;
|
|
72499
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
72353
72500
|
message: string;
|
|
72354
72501
|
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
72355
72502
|
warning_code: 'scheduled_maintenance_window';
|
|
72356
72503
|
} | {
|
|
72357
72504
|
/** Date and time at which Seam created the warning. */
|
|
72358
72505
|
created_at: string;
|
|
72506
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
72359
72507
|
message: string;
|
|
72360
72508
|
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
72361
72509
|
warning_code: 'unknown_issue_with_connected_account';
|
|
72362
72510
|
} | {
|
|
72363
72511
|
/** Date and time at which Seam created the warning. */
|
|
72364
72512
|
created_at: string;
|
|
72513
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
72365
72514
|
message: string;
|
|
72366
72515
|
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
72367
72516
|
warning_code: 'salto_ks_subscription_limit_almost_reached';
|
|
72517
|
+
/** Salto KS metadata associated with the connected account that has a warning. */
|
|
72368
72518
|
salto_ks_metadata: {
|
|
72519
|
+
/** Salto sites associated with the connected account that has a warning. */
|
|
72369
72520
|
sites: Array<{
|
|
72521
|
+
/** ID of a Salto site associated with the connected account that has a warning. */
|
|
72370
72522
|
site_id: string;
|
|
72523
|
+
/** Name of a Salto site associated with the connected account that has a warning. */
|
|
72371
72524
|
site_name: string;
|
|
72525
|
+
/** Subscription limit of site users for a Salto site associated with the connected account that has a warning. */
|
|
72372
72526
|
site_user_subscription_limit: number;
|
|
72527
|
+
/** Count of subscribed site users for a Salto site associated with the connected account that has a warning. */
|
|
72373
72528
|
subscribed_site_user_count: number;
|
|
72374
72529
|
}>;
|
|
72375
72530
|
};
|
|
72376
72531
|
}>;
|
|
72377
72532
|
/** Set of key:value pairs. Adding custom metadata to a resource, such as a [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview), [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account), or [device](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device), enables you to store custom information, like customer details or internal IDs from your application. */
|
|
72378
72533
|
custom_metadata: Record<string, string | boolean>;
|
|
72534
|
+
/** Indicates whether Seam should [import all new devices](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#automatically_manage_new_devices) for the connected account to make these devices available for use and management by the Seam API. */
|
|
72379
72535
|
automatically_manage_new_devices: boolean;
|
|
72380
72536
|
};
|
|
72381
72537
|
};
|
|
@@ -72399,87 +72555,127 @@ interface Routes {
|
|
|
72399
72555
|
formData: {};
|
|
72400
72556
|
jsonResponse: {
|
|
72401
72557
|
connected_accounts: Array<{
|
|
72558
|
+
/** Unique identifier for the connected account. */
|
|
72402
72559
|
connected_account_id?: string | undefined;
|
|
72560
|
+
/** Date and time at which the connected account was created. */
|
|
72403
72561
|
created_at?: string | undefined;
|
|
72562
|
+
/** User identifier associated with the connected account. */
|
|
72404
72563
|
user_identifier?: {
|
|
72564
|
+
/** Username of the user identifier associated with the connected account. */
|
|
72405
72565
|
username?: string | undefined;
|
|
72566
|
+
/** API URL for the user identifier associated with the connected account. */
|
|
72406
72567
|
api_url?: string | undefined;
|
|
72568
|
+
/** Email address of the user identifier associated with the connected account. */
|
|
72407
72569
|
email?: string | undefined;
|
|
72570
|
+
/** Phone number of the user identifier associated with the connected account. */
|
|
72408
72571
|
phone?: string | undefined;
|
|
72572
|
+
/** Indicates whether the user identifier associated with the connected account is exclusive. */
|
|
72409
72573
|
exclusive?: boolean | undefined;
|
|
72410
72574
|
} | undefined;
|
|
72575
|
+
/** Type of connected account. */
|
|
72411
72576
|
account_type?: string | undefined;
|
|
72577
|
+
/** Display name for the connected account type. */
|
|
72412
72578
|
account_type_display_name: string;
|
|
72579
|
+
/** Errors associated with the connected account. */
|
|
72413
72580
|
errors: Array<{
|
|
72414
72581
|
/** Date and time at which Seam created the error. */
|
|
72415
72582
|
created_at: string;
|
|
72583
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
72416
72584
|
message: string;
|
|
72585
|
+
/** Indicates whether the error is related specifically to the connected account. */
|
|
72417
72586
|
is_connected_account_error?: boolean | undefined;
|
|
72587
|
+
/** Indicates whether the error is related to Seam Bridge. */
|
|
72418
72588
|
is_bridge_error?: boolean | undefined;
|
|
72419
72589
|
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
72420
72590
|
error_code: 'account_disconnected';
|
|
72421
72591
|
} | {
|
|
72422
72592
|
/** Date and time at which Seam created the error. */
|
|
72423
72593
|
created_at: string;
|
|
72594
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
72424
72595
|
message: string;
|
|
72596
|
+
/** Indicates whether the error is related specifically to the connected account. */
|
|
72425
72597
|
is_connected_account_error?: boolean | undefined;
|
|
72598
|
+
/** Indicates whether the error is related to Seam Bridge. */
|
|
72426
72599
|
is_bridge_error?: boolean | undefined;
|
|
72427
72600
|
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
72428
72601
|
error_code: 'invalid_credentials';
|
|
72429
72602
|
} | {
|
|
72430
72603
|
/** Date and time at which Seam created the error. */
|
|
72431
72604
|
created_at: string;
|
|
72605
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
72432
72606
|
message: string;
|
|
72607
|
+
/** Indicates whether the error is related specifically to the connected account. */
|
|
72433
72608
|
is_connected_account_error?: boolean | undefined;
|
|
72609
|
+
/** Indicates whether the error is related to Seam Bridge. */
|
|
72434
72610
|
is_bridge_error?: boolean | undefined;
|
|
72435
72611
|
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
72436
72612
|
error_code: 'bridge_disconnected';
|
|
72437
72613
|
} | {
|
|
72438
72614
|
/** Date and time at which Seam created the error. */
|
|
72439
72615
|
created_at: string;
|
|
72616
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
72440
72617
|
message: string;
|
|
72618
|
+
/** Indicates whether the error is related specifically to the connected account. */
|
|
72441
72619
|
is_connected_account_error?: boolean | undefined;
|
|
72620
|
+
/** Indicates whether the error is related to Seam Bridge. */
|
|
72442
72621
|
is_bridge_error?: boolean | undefined;
|
|
72443
72622
|
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
72444
72623
|
error_code: 'salto_ks_subscription_limit_exceeded';
|
|
72624
|
+
/** Salto KS metadata associated with the connected account that has an error. */
|
|
72445
72625
|
salto_ks_metadata: {
|
|
72626
|
+
/** Salto sites associated with the connected account that has an error. */
|
|
72446
72627
|
sites: Array<{
|
|
72628
|
+
/** ID of a Salto site associated with the connected account that has an error. */
|
|
72447
72629
|
site_id: string;
|
|
72630
|
+
/** Name of a Salto site associated with the connected account that has an error. */
|
|
72448
72631
|
site_name: string;
|
|
72632
|
+
/** Count of subscribed site users for a Salto site associated with the connected account that has an error. */
|
|
72449
72633
|
subscribed_site_user_count: number;
|
|
72634
|
+
/** Subscription limit of site users for a Salto site associated with the connected account that has an error. */
|
|
72450
72635
|
site_user_subscription_limit: number;
|
|
72451
72636
|
}>;
|
|
72452
72637
|
};
|
|
72453
72638
|
}>;
|
|
72639
|
+
/** Warnings associated with the connected account. */
|
|
72454
72640
|
warnings: Array<{
|
|
72455
72641
|
/** Date and time at which Seam created the warning. */
|
|
72456
72642
|
created_at: string;
|
|
72643
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
72457
72644
|
message: string;
|
|
72458
72645
|
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
72459
72646
|
warning_code: 'scheduled_maintenance_window';
|
|
72460
72647
|
} | {
|
|
72461
72648
|
/** Date and time at which Seam created the warning. */
|
|
72462
72649
|
created_at: string;
|
|
72650
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
72463
72651
|
message: string;
|
|
72464
72652
|
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
72465
72653
|
warning_code: 'unknown_issue_with_connected_account';
|
|
72466
72654
|
} | {
|
|
72467
72655
|
/** Date and time at which Seam created the warning. */
|
|
72468
72656
|
created_at: string;
|
|
72657
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
72469
72658
|
message: string;
|
|
72470
72659
|
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
72471
72660
|
warning_code: 'salto_ks_subscription_limit_almost_reached';
|
|
72661
|
+
/** Salto KS metadata associated with the connected account that has a warning. */
|
|
72472
72662
|
salto_ks_metadata: {
|
|
72663
|
+
/** Salto sites associated with the connected account that has a warning. */
|
|
72473
72664
|
sites: Array<{
|
|
72665
|
+
/** ID of a Salto site associated with the connected account that has a warning. */
|
|
72474
72666
|
site_id: string;
|
|
72667
|
+
/** Name of a Salto site associated with the connected account that has a warning. */
|
|
72475
72668
|
site_name: string;
|
|
72669
|
+
/** Subscription limit of site users for a Salto site associated with the connected account that has a warning. */
|
|
72476
72670
|
site_user_subscription_limit: number;
|
|
72671
|
+
/** Count of subscribed site users for a Salto site associated with the connected account that has a warning. */
|
|
72477
72672
|
subscribed_site_user_count: number;
|
|
72478
72673
|
}>;
|
|
72479
72674
|
};
|
|
72480
72675
|
}>;
|
|
72481
72676
|
/** Set of key:value pairs. Adding custom metadata to a resource, such as a [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview), [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account), or [device](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device), enables you to store custom information, like customer details or internal IDs from your application. */
|
|
72482
72677
|
custom_metadata: Record<string, string | boolean>;
|
|
72678
|
+
/** Indicates whether Seam should [import all new devices](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#automatically_manage_new_devices) for the connected account to make these devices available for use and management by the Seam API. */
|
|
72483
72679
|
automatically_manage_new_devices: boolean;
|
|
72484
72680
|
}>;
|
|
72485
72681
|
/** Information about the current page of results. */
|
|
@@ -72510,87 +72706,127 @@ interface Routes {
|
|
|
72510
72706
|
jsonResponse: {
|
|
72511
72707
|
/** Represents a [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts). A connected account is an external third-party account to which your user has authorized Seam to get access, for example, an August account with a list of door locks. */
|
|
72512
72708
|
connected_account: {
|
|
72709
|
+
/** Unique identifier for the connected account. */
|
|
72513
72710
|
connected_account_id?: string | undefined;
|
|
72711
|
+
/** Date and time at which the connected account was created. */
|
|
72514
72712
|
created_at?: string | undefined;
|
|
72713
|
+
/** User identifier associated with the connected account. */
|
|
72515
72714
|
user_identifier?: {
|
|
72715
|
+
/** Username of the user identifier associated with the connected account. */
|
|
72516
72716
|
username?: string | undefined;
|
|
72717
|
+
/** API URL for the user identifier associated with the connected account. */
|
|
72517
72718
|
api_url?: string | undefined;
|
|
72719
|
+
/** Email address of the user identifier associated with the connected account. */
|
|
72518
72720
|
email?: string | undefined;
|
|
72721
|
+
/** Phone number of the user identifier associated with the connected account. */
|
|
72519
72722
|
phone?: string | undefined;
|
|
72723
|
+
/** Indicates whether the user identifier associated with the connected account is exclusive. */
|
|
72520
72724
|
exclusive?: boolean | undefined;
|
|
72521
72725
|
} | undefined;
|
|
72726
|
+
/** Type of connected account. */
|
|
72522
72727
|
account_type?: string | undefined;
|
|
72728
|
+
/** Display name for the connected account type. */
|
|
72523
72729
|
account_type_display_name: string;
|
|
72730
|
+
/** Errors associated with the connected account. */
|
|
72524
72731
|
errors: Array<{
|
|
72525
72732
|
/** Date and time at which Seam created the error. */
|
|
72526
72733
|
created_at: string;
|
|
72734
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
72527
72735
|
message: string;
|
|
72736
|
+
/** Indicates whether the error is related specifically to the connected account. */
|
|
72528
72737
|
is_connected_account_error?: boolean | undefined;
|
|
72738
|
+
/** Indicates whether the error is related to Seam Bridge. */
|
|
72529
72739
|
is_bridge_error?: boolean | undefined;
|
|
72530
72740
|
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
72531
72741
|
error_code: 'account_disconnected';
|
|
72532
72742
|
} | {
|
|
72533
72743
|
/** Date and time at which Seam created the error. */
|
|
72534
72744
|
created_at: string;
|
|
72745
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
72535
72746
|
message: string;
|
|
72747
|
+
/** Indicates whether the error is related specifically to the connected account. */
|
|
72536
72748
|
is_connected_account_error?: boolean | undefined;
|
|
72749
|
+
/** Indicates whether the error is related to Seam Bridge. */
|
|
72537
72750
|
is_bridge_error?: boolean | undefined;
|
|
72538
72751
|
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
72539
72752
|
error_code: 'invalid_credentials';
|
|
72540
72753
|
} | {
|
|
72541
72754
|
/** Date and time at which Seam created the error. */
|
|
72542
72755
|
created_at: string;
|
|
72756
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
72543
72757
|
message: string;
|
|
72758
|
+
/** Indicates whether the error is related specifically to the connected account. */
|
|
72544
72759
|
is_connected_account_error?: boolean | undefined;
|
|
72760
|
+
/** Indicates whether the error is related to Seam Bridge. */
|
|
72545
72761
|
is_bridge_error?: boolean | undefined;
|
|
72546
72762
|
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
72547
72763
|
error_code: 'bridge_disconnected';
|
|
72548
72764
|
} | {
|
|
72549
72765
|
/** Date and time at which Seam created the error. */
|
|
72550
72766
|
created_at: string;
|
|
72767
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
72551
72768
|
message: string;
|
|
72769
|
+
/** Indicates whether the error is related specifically to the connected account. */
|
|
72552
72770
|
is_connected_account_error?: boolean | undefined;
|
|
72771
|
+
/** Indicates whether the error is related to Seam Bridge. */
|
|
72553
72772
|
is_bridge_error?: boolean | undefined;
|
|
72554
72773
|
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
72555
72774
|
error_code: 'salto_ks_subscription_limit_exceeded';
|
|
72775
|
+
/** Salto KS metadata associated with the connected account that has an error. */
|
|
72556
72776
|
salto_ks_metadata: {
|
|
72777
|
+
/** Salto sites associated with the connected account that has an error. */
|
|
72557
72778
|
sites: Array<{
|
|
72779
|
+
/** ID of a Salto site associated with the connected account that has an error. */
|
|
72558
72780
|
site_id: string;
|
|
72781
|
+
/** Name of a Salto site associated with the connected account that has an error. */
|
|
72559
72782
|
site_name: string;
|
|
72783
|
+
/** Count of subscribed site users for a Salto site associated with the connected account that has an error. */
|
|
72560
72784
|
subscribed_site_user_count: number;
|
|
72785
|
+
/** Subscription limit of site users for a Salto site associated with the connected account that has an error. */
|
|
72561
72786
|
site_user_subscription_limit: number;
|
|
72562
72787
|
}>;
|
|
72563
72788
|
};
|
|
72564
72789
|
}>;
|
|
72790
|
+
/** Warnings associated with the connected account. */
|
|
72565
72791
|
warnings: Array<{
|
|
72566
72792
|
/** Date and time at which Seam created the warning. */
|
|
72567
72793
|
created_at: string;
|
|
72794
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
72568
72795
|
message: string;
|
|
72569
72796
|
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
72570
72797
|
warning_code: 'scheduled_maintenance_window';
|
|
72571
72798
|
} | {
|
|
72572
72799
|
/** Date and time at which Seam created the warning. */
|
|
72573
72800
|
created_at: string;
|
|
72801
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
72574
72802
|
message: string;
|
|
72575
72803
|
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
72576
72804
|
warning_code: 'unknown_issue_with_connected_account';
|
|
72577
72805
|
} | {
|
|
72578
72806
|
/** Date and time at which Seam created the warning. */
|
|
72579
72807
|
created_at: string;
|
|
72808
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
72580
72809
|
message: string;
|
|
72581
72810
|
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
72582
72811
|
warning_code: 'salto_ks_subscription_limit_almost_reached';
|
|
72812
|
+
/** Salto KS metadata associated with the connected account that has a warning. */
|
|
72583
72813
|
salto_ks_metadata: {
|
|
72814
|
+
/** Salto sites associated with the connected account that has a warning. */
|
|
72584
72815
|
sites: Array<{
|
|
72816
|
+
/** ID of a Salto site associated with the connected account that has a warning. */
|
|
72585
72817
|
site_id: string;
|
|
72818
|
+
/** Name of a Salto site associated with the connected account that has a warning. */
|
|
72586
72819
|
site_name: string;
|
|
72820
|
+
/** Subscription limit of site users for a Salto site associated with the connected account that has a warning. */
|
|
72587
72821
|
site_user_subscription_limit: number;
|
|
72822
|
+
/** Count of subscribed site users for a Salto site associated with the connected account that has a warning. */
|
|
72588
72823
|
subscribed_site_user_count: number;
|
|
72589
72824
|
}>;
|
|
72590
72825
|
};
|
|
72591
72826
|
}>;
|
|
72592
72827
|
/** Set of key:value pairs. Adding custom metadata to a resource, such as a [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview), [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account), or [device](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device), enables you to store custom information, like customer details or internal IDs from your application. */
|
|
72593
72828
|
custom_metadata: Record<string, string | boolean>;
|
|
72829
|
+
/** Indicates whether Seam should [import all new devices](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#automatically_manage_new_devices) for the connected account to make these devices available for use and management by the Seam API. */
|
|
72594
72830
|
automatically_manage_new_devices: boolean;
|
|
72595
72831
|
};
|
|
72596
72832
|
};
|
|
@@ -73256,16 +73492,22 @@ interface Routes {
|
|
|
73256
73492
|
} | {
|
|
73257
73493
|
/** Date and time at which Seam created the error. */
|
|
73258
73494
|
created_at: string;
|
|
73495
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
73259
73496
|
message: string;
|
|
73497
|
+
/** Indicates whether the error is related specifically to the connected account. */
|
|
73260
73498
|
is_connected_account_error?: boolean | undefined;
|
|
73499
|
+
/** Indicates whether the error is related to Seam Bridge. */
|
|
73261
73500
|
is_bridge_error?: boolean | undefined;
|
|
73262
73501
|
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
73263
73502
|
error_code: 'invalid_credentials';
|
|
73264
73503
|
} | {
|
|
73265
73504
|
/** Date and time at which Seam created the error. */
|
|
73266
73505
|
created_at: string;
|
|
73506
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
73267
73507
|
message: string;
|
|
73508
|
+
/** Indicates whether the error is related specifically to the connected account. */
|
|
73268
73509
|
is_connected_account_error?: boolean | undefined;
|
|
73510
|
+
/** Indicates whether the error is related to Seam Bridge. */
|
|
73269
73511
|
is_bridge_error?: boolean | undefined;
|
|
73270
73512
|
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
73271
73513
|
error_code: 'bridge_disconnected';
|
|
@@ -73395,7 +73637,7 @@ interface Routes {
|
|
|
73395
73637
|
/** Array of device types for which you want to list devices. */
|
|
73396
73638
|
device_types?: Array<('akuvox_lock' | 'august_lock' | 'brivo_access_point' | 'butterflymx_panel' | 'avigilon_alta_entry' | 'doorking_lock' | 'genie_door' | 'igloo_lock' | 'linear_lock' | 'lockly_lock' | 'kwikset_lock' | 'nuki_lock' | 'salto_lock' | 'schlage_lock' | 'seam_relay' | 'smartthings_lock' | 'wyze_lock' | 'yale_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'hubitat_lock' | 'four_suites_door' | 'dormakaba_oracode_door' | 'tedee_lock' | 'akiles_lock') | ('noiseaware_activity_zone' | 'minut_sensor') | ('ecobee_thermostat' | 'nest_thermostat' | 'honeywell_resideo_thermostat' | 'tado_thermostat' | 'sensi_thermostat' | 'smartthings_thermostat') | ('ios_phone' | 'android_phone')> | undefined;
|
|
73397
73639
|
/** Manufacturer for which you want to list devices. */
|
|
73398
|
-
manufacturer?: ('akuvox' | 'august' | 'avigilon_alta' | 'brivo' | 'butterflymx' | 'doorking' | 'four_suites' | 'genie' | 'igloo' | 'keywe' | 'kwikset' | 'linear' | 'lockly' | 'nuki' | 'philia' | 'salto' | 'samsung' | 'schlage' | 'seam' | 'unknown' | 'wyze' | 'yale' | 'two_n' | 'ttlock' | 'igloohome' | 'hubitat' | 'controlbyweb' | '
|
|
73640
|
+
manufacturer?: ('akuvox' | 'august' | 'avigilon_alta' | 'brivo' | 'butterflymx' | 'doorking' | 'four_suites' | 'genie' | 'igloo' | 'keywe' | 'kwikset' | 'linear' | 'lockly' | 'nuki' | 'philia' | 'salto' | 'samsung' | 'schlage' | 'seam' | 'unknown' | 'wyze' | 'yale' | 'two_n' | 'ttlock' | 'igloohome' | 'hubitat' | 'controlbyweb' | 'dormakaba_oracode' | 'tedee' | 'akiles' | 'ecobee' | 'honeywell_resideo' | 'minut' | 'nest' | 'noiseaware' | 'tado' | 'sensi' | 'smartthings') | undefined;
|
|
73399
73641
|
/** Array of device IDs for which you want to list devices. */
|
|
73400
73642
|
device_ids?: string[] | undefined;
|
|
73401
73643
|
/** Numerical limit on the number of devices to return. */
|
|
@@ -74052,16 +74294,22 @@ interface Routes {
|
|
|
74052
74294
|
} | {
|
|
74053
74295
|
/** Date and time at which Seam created the error. */
|
|
74054
74296
|
created_at: string;
|
|
74297
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
74055
74298
|
message: string;
|
|
74299
|
+
/** Indicates whether the error is related specifically to the connected account. */
|
|
74056
74300
|
is_connected_account_error?: boolean | undefined;
|
|
74301
|
+
/** Indicates whether the error is related to Seam Bridge. */
|
|
74057
74302
|
is_bridge_error?: boolean | undefined;
|
|
74058
74303
|
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
74059
74304
|
error_code: 'invalid_credentials';
|
|
74060
74305
|
} | {
|
|
74061
74306
|
/** Date and time at which Seam created the error. */
|
|
74062
74307
|
created_at: string;
|
|
74308
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
74063
74309
|
message: string;
|
|
74310
|
+
/** Indicates whether the error is related specifically to the connected account. */
|
|
74064
74311
|
is_connected_account_error?: boolean | undefined;
|
|
74312
|
+
/** Indicates whether the error is related to Seam Bridge. */
|
|
74065
74313
|
is_bridge_error?: boolean | undefined;
|
|
74066
74314
|
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
74067
74315
|
error_code: 'bridge_disconnected';
|
|
@@ -74364,16 +74612,22 @@ interface Routes {
|
|
|
74364
74612
|
} | {
|
|
74365
74613
|
/** Date and time at which Seam created the error. */
|
|
74366
74614
|
created_at: string;
|
|
74615
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
74367
74616
|
message: string;
|
|
74617
|
+
/** Indicates whether the error is related specifically to the connected account. */
|
|
74368
74618
|
is_connected_account_error?: boolean | undefined;
|
|
74619
|
+
/** Indicates whether the error is related to Seam Bridge. */
|
|
74369
74620
|
is_bridge_error?: boolean | undefined;
|
|
74370
74621
|
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
74371
74622
|
error_code: 'invalid_credentials';
|
|
74372
74623
|
} | {
|
|
74373
74624
|
/** Date and time at which Seam created the error. */
|
|
74374
74625
|
created_at: string;
|
|
74626
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
74375
74627
|
message: string;
|
|
74628
|
+
/** Indicates whether the error is related specifically to the connected account. */
|
|
74376
74629
|
is_connected_account_error?: boolean | undefined;
|
|
74630
|
+
/** Indicates whether the error is related to Seam Bridge. */
|
|
74377
74631
|
is_bridge_error?: boolean | undefined;
|
|
74378
74632
|
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
74379
74633
|
error_code: 'bridge_disconnected';
|
|
@@ -74550,7 +74804,7 @@ interface Routes {
|
|
|
74550
74804
|
/** Array of device types for which you want to list devices. */
|
|
74551
74805
|
device_types?: Array<('akuvox_lock' | 'august_lock' | 'brivo_access_point' | 'butterflymx_panel' | 'avigilon_alta_entry' | 'doorking_lock' | 'genie_door' | 'igloo_lock' | 'linear_lock' | 'lockly_lock' | 'kwikset_lock' | 'nuki_lock' | 'salto_lock' | 'schlage_lock' | 'seam_relay' | 'smartthings_lock' | 'wyze_lock' | 'yale_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'hubitat_lock' | 'four_suites_door' | 'dormakaba_oracode_door' | 'tedee_lock' | 'akiles_lock') | ('noiseaware_activity_zone' | 'minut_sensor') | ('ecobee_thermostat' | 'nest_thermostat' | 'honeywell_resideo_thermostat' | 'tado_thermostat' | 'sensi_thermostat' | 'smartthings_thermostat') | ('ios_phone' | 'android_phone')> | undefined;
|
|
74552
74806
|
/** Manufacturer for which you want to list devices. */
|
|
74553
|
-
manufacturer?: ('akuvox' | 'august' | 'avigilon_alta' | 'brivo' | 'butterflymx' | 'doorking' | 'four_suites' | 'genie' | 'igloo' | 'keywe' | 'kwikset' | 'linear' | 'lockly' | 'nuki' | 'philia' | 'salto' | 'samsung' | 'schlage' | 'seam' | 'unknown' | 'wyze' | 'yale' | 'two_n' | 'ttlock' | 'igloohome' | 'hubitat' | 'controlbyweb' | '
|
|
74807
|
+
manufacturer?: ('akuvox' | 'august' | 'avigilon_alta' | 'brivo' | 'butterflymx' | 'doorking' | 'four_suites' | 'genie' | 'igloo' | 'keywe' | 'kwikset' | 'linear' | 'lockly' | 'nuki' | 'philia' | 'salto' | 'samsung' | 'schlage' | 'seam' | 'unknown' | 'wyze' | 'yale' | 'two_n' | 'ttlock' | 'igloohome' | 'hubitat' | 'controlbyweb' | 'dormakaba_oracode' | 'tedee' | 'akiles' | 'ecobee' | 'honeywell_resideo' | 'minut' | 'nest' | 'noiseaware' | 'tado' | 'sensi' | 'smartthings') | undefined;
|
|
74554
74808
|
/** Array of device IDs for which you want to list devices. */
|
|
74555
74809
|
device_ids?: string[] | undefined;
|
|
74556
74810
|
/** Numerical limit on the number of devices to return. */
|
|
@@ -74674,16 +74928,22 @@ interface Routes {
|
|
|
74674
74928
|
} | {
|
|
74675
74929
|
/** Date and time at which Seam created the error. */
|
|
74676
74930
|
created_at: string;
|
|
74931
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
74677
74932
|
message: string;
|
|
74933
|
+
/** Indicates whether the error is related specifically to the connected account. */
|
|
74678
74934
|
is_connected_account_error?: boolean | undefined;
|
|
74935
|
+
/** Indicates whether the error is related to Seam Bridge. */
|
|
74679
74936
|
is_bridge_error?: boolean | undefined;
|
|
74680
74937
|
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
74681
74938
|
error_code: 'invalid_credentials';
|
|
74682
74939
|
} | {
|
|
74683
74940
|
/** Date and time at which Seam created the error. */
|
|
74684
74941
|
created_at: string;
|
|
74942
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
74685
74943
|
message: string;
|
|
74944
|
+
/** Indicates whether the error is related specifically to the connected account. */
|
|
74686
74945
|
is_connected_account_error?: boolean | undefined;
|
|
74946
|
+
/** Indicates whether the error is related to Seam Bridge. */
|
|
74687
74947
|
is_bridge_error?: boolean | undefined;
|
|
74688
74948
|
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
74689
74949
|
error_code: 'bridge_disconnected';
|
|
@@ -78292,16 +78552,22 @@ interface Routes {
|
|
|
78292
78552
|
} | {
|
|
78293
78553
|
/** Date and time at which Seam created the error. */
|
|
78294
78554
|
created_at: string;
|
|
78555
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
78295
78556
|
message: string;
|
|
78557
|
+
/** Indicates whether the error is related specifically to the connected account. */
|
|
78296
78558
|
is_connected_account_error?: boolean | undefined;
|
|
78559
|
+
/** Indicates whether the error is related to Seam Bridge. */
|
|
78297
78560
|
is_bridge_error?: boolean | undefined;
|
|
78298
78561
|
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
78299
78562
|
error_code: 'invalid_credentials';
|
|
78300
78563
|
} | {
|
|
78301
78564
|
/** Date and time at which Seam created the error. */
|
|
78302
78565
|
created_at: string;
|
|
78566
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
78303
78567
|
message: string;
|
|
78568
|
+
/** Indicates whether the error is related specifically to the connected account. */
|
|
78304
78569
|
is_connected_account_error?: boolean | undefined;
|
|
78570
|
+
/** Indicates whether the error is related to Seam Bridge. */
|
|
78305
78571
|
is_bridge_error?: boolean | undefined;
|
|
78306
78572
|
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
78307
78573
|
error_code: 'bridge_disconnected';
|
|
@@ -79047,16 +79313,22 @@ interface Routes {
|
|
|
79047
79313
|
} | {
|
|
79048
79314
|
/** Date and time at which Seam created the error. */
|
|
79049
79315
|
created_at: string;
|
|
79316
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
79050
79317
|
message: string;
|
|
79318
|
+
/** Indicates whether the error is related specifically to the connected account. */
|
|
79051
79319
|
is_connected_account_error?: boolean | undefined;
|
|
79320
|
+
/** Indicates whether the error is related to Seam Bridge. */
|
|
79052
79321
|
is_bridge_error?: boolean | undefined;
|
|
79053
79322
|
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
79054
79323
|
error_code: 'invalid_credentials';
|
|
79055
79324
|
} | {
|
|
79056
79325
|
/** Date and time at which Seam created the error. */
|
|
79057
79326
|
created_at: string;
|
|
79327
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
79058
79328
|
message: string;
|
|
79329
|
+
/** Indicates whether the error is related specifically to the connected account. */
|
|
79059
79330
|
is_connected_account_error?: boolean | undefined;
|
|
79331
|
+
/** Indicates whether the error is related to Seam Bridge. */
|
|
79060
79332
|
is_bridge_error?: boolean | undefined;
|
|
79061
79333
|
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
79062
79334
|
error_code: 'bridge_disconnected';
|
|
@@ -79186,7 +79458,7 @@ interface Routes {
|
|
|
79186
79458
|
/** Array of device types by which to filter devices. */
|
|
79187
79459
|
device_types?: Array<'akuvox_lock' | 'august_lock' | 'brivo_access_point' | 'butterflymx_panel' | 'avigilon_alta_entry' | 'doorking_lock' | 'genie_door' | 'igloo_lock' | 'linear_lock' | 'lockly_lock' | 'kwikset_lock' | 'nuki_lock' | 'salto_lock' | 'schlage_lock' | 'seam_relay' | 'smartthings_lock' | 'wyze_lock' | 'yale_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'hubitat_lock' | 'four_suites_door' | 'dormakaba_oracode_door' | 'tedee_lock' | 'akiles_lock'> | undefined;
|
|
79188
79460
|
/** Manufacturer by which to filter devices. */
|
|
79189
|
-
manufacturer?: ('akuvox' | 'august' | 'brivo' | 'butterflymx' | 'avigilon_alta' | 'doorking' | 'genie' | 'igloo' | 'linear' | 'lockly' | 'kwikset' | 'nuki' | 'salto' | 'schlage' | 'seam' | '
|
|
79461
|
+
manufacturer?: ('akuvox' | 'august' | 'brivo' | 'butterflymx' | 'avigilon_alta' | 'doorking' | 'genie' | 'igloo' | 'linear' | 'lockly' | 'kwikset' | 'nuki' | 'salto' | 'schlage' | 'seam' | 'wyze' | 'yale' | 'two_n' | 'controlbyweb' | 'ttlock' | 'igloohome' | 'hubitat' | 'four_suites' | 'dormakaba_oracode' | 'tedee' | 'akiles' | 'smartthings') | undefined;
|
|
79190
79462
|
/** Array of device IDs for which you want to list devices. */
|
|
79191
79463
|
device_ids?: string[] | undefined;
|
|
79192
79464
|
/** Numerical limit on the number of devices to return. */
|
|
@@ -79843,16 +80115,22 @@ interface Routes {
|
|
|
79843
80115
|
} | {
|
|
79844
80116
|
/** Date and time at which Seam created the error. */
|
|
79845
80117
|
created_at: string;
|
|
80118
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
79846
80119
|
message: string;
|
|
80120
|
+
/** Indicates whether the error is related specifically to the connected account. */
|
|
79847
80121
|
is_connected_account_error?: boolean | undefined;
|
|
80122
|
+
/** Indicates whether the error is related to Seam Bridge. */
|
|
79848
80123
|
is_bridge_error?: boolean | undefined;
|
|
79849
80124
|
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
79850
80125
|
error_code: 'invalid_credentials';
|
|
79851
80126
|
} | {
|
|
79852
80127
|
/** Date and time at which Seam created the error. */
|
|
79853
80128
|
created_at: string;
|
|
80129
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
79854
80130
|
message: string;
|
|
80131
|
+
/** Indicates whether the error is related specifically to the connected account. */
|
|
79855
80132
|
is_connected_account_error?: boolean | undefined;
|
|
80133
|
+
/** Indicates whether the error is related to Seam Bridge. */
|
|
79856
80134
|
is_bridge_error?: boolean | undefined;
|
|
79857
80135
|
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
79858
80136
|
error_code: 'bridge_disconnected';
|
|
@@ -80597,16 +80875,22 @@ interface Routes {
|
|
|
80597
80875
|
} | {
|
|
80598
80876
|
/** Date and time at which Seam created the error. */
|
|
80599
80877
|
created_at: string;
|
|
80878
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
80600
80879
|
message: string;
|
|
80880
|
+
/** Indicates whether the error is related specifically to the connected account. */
|
|
80601
80881
|
is_connected_account_error?: boolean | undefined;
|
|
80882
|
+
/** Indicates whether the error is related to Seam Bridge. */
|
|
80602
80883
|
is_bridge_error?: boolean | undefined;
|
|
80603
80884
|
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
80604
80885
|
error_code: 'invalid_credentials';
|
|
80605
80886
|
} | {
|
|
80606
80887
|
/** Date and time at which Seam created the error. */
|
|
80607
80888
|
created_at: string;
|
|
80889
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
80608
80890
|
message: string;
|
|
80891
|
+
/** Indicates whether the error is related specifically to the connected account. */
|
|
80609
80892
|
is_connected_account_error?: boolean | undefined;
|
|
80893
|
+
/** Indicates whether the error is related to Seam Bridge. */
|
|
80610
80894
|
is_bridge_error?: boolean | undefined;
|
|
80611
80895
|
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
80612
80896
|
error_code: 'bridge_disconnected';
|
|
@@ -85891,16 +86175,22 @@ interface Routes {
|
|
|
85891
86175
|
} | {
|
|
85892
86176
|
/** Date and time at which Seam created the error. */
|
|
85893
86177
|
created_at: string;
|
|
86178
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
85894
86179
|
message: string;
|
|
86180
|
+
/** Indicates whether the error is related specifically to the connected account. */
|
|
85895
86181
|
is_connected_account_error?: boolean | undefined;
|
|
86182
|
+
/** Indicates whether the error is related to Seam Bridge. */
|
|
85896
86183
|
is_bridge_error?: boolean | undefined;
|
|
85897
86184
|
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
85898
86185
|
error_code: 'invalid_credentials';
|
|
85899
86186
|
} | {
|
|
85900
86187
|
/** Date and time at which Seam created the error. */
|
|
85901
86188
|
created_at: string;
|
|
86189
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
85902
86190
|
message: string;
|
|
86191
|
+
/** Indicates whether the error is related specifically to the connected account. */
|
|
85903
86192
|
is_connected_account_error?: boolean | undefined;
|
|
86193
|
+
/** Indicates whether the error is related to Seam Bridge. */
|
|
85904
86194
|
is_bridge_error?: boolean | undefined;
|
|
85905
86195
|
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
85906
86196
|
error_code: 'bridge_disconnected';
|
|
@@ -86645,16 +86935,22 @@ interface Routes {
|
|
|
86645
86935
|
} | {
|
|
86646
86936
|
/** Date and time at which Seam created the error. */
|
|
86647
86937
|
created_at: string;
|
|
86938
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
86648
86939
|
message: string;
|
|
86940
|
+
/** Indicates whether the error is related specifically to the connected account. */
|
|
86649
86941
|
is_connected_account_error?: boolean | undefined;
|
|
86942
|
+
/** Indicates whether the error is related to Seam Bridge. */
|
|
86650
86943
|
is_bridge_error?: boolean | undefined;
|
|
86651
86944
|
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
86652
86945
|
error_code: 'invalid_credentials';
|
|
86653
86946
|
} | {
|
|
86654
86947
|
/** Date and time at which Seam created the error. */
|
|
86655
86948
|
created_at: string;
|
|
86949
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
86656
86950
|
message: string;
|
|
86951
|
+
/** Indicates whether the error is related specifically to the connected account. */
|
|
86657
86952
|
is_connected_account_error?: boolean | undefined;
|
|
86953
|
+
/** Indicates whether the error is related to Seam Bridge. */
|
|
86658
86954
|
is_bridge_error?: boolean | undefined;
|
|
86659
86955
|
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
86660
86956
|
error_code: 'bridge_disconnected';
|
|
@@ -95111,16 +95407,22 @@ interface Routes {
|
|
|
95111
95407
|
} | {
|
|
95112
95408
|
/** Date and time at which Seam created the error. */
|
|
95113
95409
|
created_at: string;
|
|
95410
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
95114
95411
|
message: string;
|
|
95412
|
+
/** Indicates whether the error is related specifically to the connected account. */
|
|
95115
95413
|
is_connected_account_error?: boolean | undefined;
|
|
95414
|
+
/** Indicates whether the error is related to Seam Bridge. */
|
|
95116
95415
|
is_bridge_error?: boolean | undefined;
|
|
95117
95416
|
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
95118
95417
|
error_code: 'invalid_credentials';
|
|
95119
95418
|
} | {
|
|
95120
95419
|
/** Date and time at which Seam created the error. */
|
|
95121
95420
|
created_at: string;
|
|
95421
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
95122
95422
|
message: string;
|
|
95423
|
+
/** Indicates whether the error is related specifically to the connected account. */
|
|
95123
95424
|
is_connected_account_error?: boolean | undefined;
|
|
95425
|
+
/** Indicates whether the error is related to Seam Bridge. */
|
|
95124
95426
|
is_bridge_error?: boolean | undefined;
|
|
95125
95427
|
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
95126
95428
|
error_code: 'bridge_disconnected';
|
|
@@ -97498,7 +97800,7 @@ interface Routes {
|
|
|
97498
97800
|
/** Array of device types by which to filter thermostat devices. */
|
|
97499
97801
|
device_types?: Array<'ecobee_thermostat' | 'nest_thermostat' | 'honeywell_resideo_thermostat' | 'tado_thermostat' | 'sensi_thermostat' | 'smartthings_thermostat'> | undefined;
|
|
97500
97802
|
/** Manufacturer by which to filter thermostat devices. */
|
|
97501
|
-
manufacturer?: ('ecobee' | 'honeywell_resideo' | 'nest' | 'tado' | 'sensi') | undefined;
|
|
97803
|
+
manufacturer?: ('ecobee' | 'honeywell_resideo' | 'nest' | 'tado' | 'sensi' | 'smartthings') | undefined;
|
|
97502
97804
|
/** Array of device IDs for which you want to list devices. */
|
|
97503
97805
|
device_ids?: string[] | undefined;
|
|
97504
97806
|
/** Numerical limit on the number of devices to return. */
|
|
@@ -98155,16 +98457,22 @@ interface Routes {
|
|
|
98155
98457
|
} | {
|
|
98156
98458
|
/** Date and time at which Seam created the error. */
|
|
98157
98459
|
created_at: string;
|
|
98460
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
98158
98461
|
message: string;
|
|
98462
|
+
/** Indicates whether the error is related specifically to the connected account. */
|
|
98159
98463
|
is_connected_account_error?: boolean | undefined;
|
|
98464
|
+
/** Indicates whether the error is related to Seam Bridge. */
|
|
98160
98465
|
is_bridge_error?: boolean | undefined;
|
|
98161
98466
|
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
98162
98467
|
error_code: 'invalid_credentials';
|
|
98163
98468
|
} | {
|
|
98164
98469
|
/** Date and time at which Seam created the error. */
|
|
98165
98470
|
created_at: string;
|
|
98471
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
98166
98472
|
message: string;
|
|
98473
|
+
/** Indicates whether the error is related specifically to the connected account. */
|
|
98167
98474
|
is_connected_account_error?: boolean | undefined;
|
|
98475
|
+
/** Indicates whether the error is related to Seam Bridge. */
|
|
98168
98476
|
is_bridge_error?: boolean | undefined;
|
|
98169
98477
|
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
98170
98478
|
error_code: 'bridge_disconnected';
|
|
@@ -98909,16 +99217,22 @@ interface Routes {
|
|
|
98909
99217
|
} | {
|
|
98910
99218
|
/** Date and time at which Seam created the error. */
|
|
98911
99219
|
created_at: string;
|
|
99220
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
98912
99221
|
message: string;
|
|
99222
|
+
/** Indicates whether the error is related specifically to the connected account. */
|
|
98913
99223
|
is_connected_account_error?: boolean | undefined;
|
|
99224
|
+
/** Indicates whether the error is related to Seam Bridge. */
|
|
98914
99225
|
is_bridge_error?: boolean | undefined;
|
|
98915
99226
|
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
98916
99227
|
error_code: 'invalid_credentials';
|
|
98917
99228
|
} | {
|
|
98918
99229
|
/** Date and time at which Seam created the error. */
|
|
98919
99230
|
created_at: string;
|
|
99231
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
98920
99232
|
message: string;
|
|
99233
|
+
/** Indicates whether the error is related specifically to the connected account. */
|
|
98921
99234
|
is_connected_account_error?: boolean | undefined;
|
|
99235
|
+
/** Indicates whether the error is related to Seam Bridge. */
|
|
98922
99236
|
is_bridge_error?: boolean | undefined;
|
|
98923
99237
|
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
98924
99238
|
error_code: 'bridge_disconnected';
|
|
@@ -105202,16 +105516,22 @@ interface Routes {
|
|
|
105202
105516
|
} | {
|
|
105203
105517
|
/** Date and time at which Seam created the error. */
|
|
105204
105518
|
created_at: string;
|
|
105519
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
105205
105520
|
message: string;
|
|
105521
|
+
/** Indicates whether the error is related specifically to the connected account. */
|
|
105206
105522
|
is_connected_account_error?: boolean | undefined;
|
|
105523
|
+
/** Indicates whether the error is related to Seam Bridge. */
|
|
105207
105524
|
is_bridge_error?: boolean | undefined;
|
|
105208
105525
|
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
105209
105526
|
error_code: 'invalid_credentials';
|
|
105210
105527
|
} | {
|
|
105211
105528
|
/** Date and time at which Seam created the error. */
|
|
105212
105529
|
created_at: string;
|
|
105530
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
105213
105531
|
message: string;
|
|
105532
|
+
/** Indicates whether the error is related specifically to the connected account. */
|
|
105214
105533
|
is_connected_account_error?: boolean | undefined;
|
|
105534
|
+
/** Indicates whether the error is related to Seam Bridge. */
|
|
105215
105535
|
is_bridge_error?: boolean | undefined;
|
|
105216
105536
|
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
105217
105537
|
error_code: 'bridge_disconnected';
|
|
@@ -105958,16 +106278,22 @@ interface Routes {
|
|
|
105958
106278
|
} | {
|
|
105959
106279
|
/** Date and time at which Seam created the error. */
|
|
105960
106280
|
created_at: string;
|
|
106281
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
105961
106282
|
message: string;
|
|
106283
|
+
/** Indicates whether the error is related specifically to the connected account. */
|
|
105962
106284
|
is_connected_account_error?: boolean | undefined;
|
|
106285
|
+
/** Indicates whether the error is related to Seam Bridge. */
|
|
105963
106286
|
is_bridge_error?: boolean | undefined;
|
|
105964
106287
|
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
105965
106288
|
error_code: 'invalid_credentials';
|
|
105966
106289
|
} | {
|
|
105967
106290
|
/** Date and time at which Seam created the error. */
|
|
105968
106291
|
created_at: string;
|
|
106292
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
105969
106293
|
message: string;
|
|
106294
|
+
/** Indicates whether the error is related specifically to the connected account. */
|
|
105970
106295
|
is_connected_account_error?: boolean | undefined;
|
|
106296
|
+
/** Indicates whether the error is related to Seam Bridge. */
|
|
105971
106297
|
is_bridge_error?: boolean | undefined;
|
|
105972
106298
|
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
105973
106299
|
error_code: 'bridge_disconnected';
|