@seamapi/types 1.399.0 → 1.400.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/connect.cjs +889 -297
- package/dist/connect.cjs.map +1 -1
- package/dist/connect.d.cts +848 -179
- package/lib/seam/connect/models/access-codes/managed-access-code.js +8 -2
- package/lib/seam/connect/models/access-codes/managed-access-code.js.map +1 -1
- package/lib/seam/connect/models/access-codes/unmanaged-access-code.js +4 -0
- package/lib/seam/connect/models/access-codes/unmanaged-access-code.js.map +1 -1
- package/lib/seam/connect/models/client-sessions/client-session.js +9 -0
- package/lib/seam/connect/models/client-sessions/client-session.js.map +1 -1
- package/lib/seam/connect/models/connect-webviews/connect-webview.js +13 -0
- package/lib/seam/connect/models/connect-webviews/connect-webview.js.map +1 -1
- package/lib/seam/connect/models/connected-accounts/connected-account.js +1 -0
- package/lib/seam/connect/models/connected-accounts/connected-account.js.map +1 -1
- package/lib/seam/connect/models/devices/capability-properties/access-code.js +4 -1
- package/lib/seam/connect/models/devices/capability-properties/access-code.js.map +1 -1
- package/lib/seam/connect/models/devices/device.js +5 -1
- package/lib/seam/connect/models/devices/device.js.map +1 -1
- package/lib/seam/connect/models/devices/unmanaged-device.js +1 -0
- package/lib/seam/connect/models/devices/unmanaged-device.js.map +1 -1
- package/lib/seam/connect/models/events/seam-event.js +3 -0
- package/lib/seam/connect/models/events/seam-event.js.map +1 -1
- package/lib/seam/connect/models/user-identities/user-identity.js +1 -1
- package/lib/seam/connect/models/workspaces/workspace.js +1 -0
- package/lib/seam/connect/models/workspaces/workspace.js.map +1 -1
- package/lib/seam/connect/openapi.d.ts +381 -0
- package/lib/seam/connect/openapi.js +807 -258
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +467 -179
- package/package.json +1 -1
- package/src/lib/seam/connect/models/access-codes/managed-access-code.ts +8 -2
- package/src/lib/seam/connect/models/access-codes/unmanaged-access-code.ts +4 -0
- package/src/lib/seam/connect/models/client-sessions/client-session.ts +9 -0
- package/src/lib/seam/connect/models/connect-webviews/connect-webview.ts +13 -0
- package/src/lib/seam/connect/models/connected-accounts/connected-account.ts +1 -0
- package/src/lib/seam/connect/models/devices/capability-properties/access-code.ts +6 -1
- package/src/lib/seam/connect/models/devices/device.ts +7 -1
- package/src/lib/seam/connect/models/devices/unmanaged-device.ts +1 -0
- package/src/lib/seam/connect/models/events/seam-event.ts +3 -0
- package/src/lib/seam/connect/models/user-identities/user-identity.ts +1 -1
- package/src/lib/seam/connect/models/workspaces/workspace.ts +1 -0
- package/src/lib/seam/connect/openapi.ts +1010 -258
- package/src/lib/seam/connect/route-types.ts +469 -179
package/dist/connect.d.cts
CHANGED
|
@@ -24220,6 +24220,7 @@ declare const _default: {
|
|
|
24220
24220
|
'x-route-path': string;
|
|
24221
24221
|
};
|
|
24222
24222
|
client_session: {
|
|
24223
|
+
description: string;
|
|
24223
24224
|
properties: {
|
|
24224
24225
|
client_session_id: {
|
|
24225
24226
|
format: string;
|
|
@@ -24275,6 +24276,7 @@ declare const _default: {
|
|
|
24275
24276
|
'x-route-path': string;
|
|
24276
24277
|
};
|
|
24277
24278
|
connect_webview: {
|
|
24279
|
+
description: string;
|
|
24278
24280
|
properties: {
|
|
24279
24281
|
accepted_devices: {
|
|
24280
24282
|
deprecated: boolean;
|
|
@@ -24283,6 +24285,7 @@ declare const _default: {
|
|
|
24283
24285
|
};
|
|
24284
24286
|
type: string;
|
|
24285
24287
|
'x-deprecated': string;
|
|
24288
|
+
'x-undocumented': string;
|
|
24286
24289
|
};
|
|
24287
24290
|
accepted_providers: {
|
|
24288
24291
|
items: {
|
|
@@ -24294,6 +24297,7 @@ declare const _default: {
|
|
|
24294
24297
|
deprecated: boolean;
|
|
24295
24298
|
type: string;
|
|
24296
24299
|
'x-deprecated': string;
|
|
24300
|
+
'x-undocumented': string;
|
|
24297
24301
|
};
|
|
24298
24302
|
any_provider_allowed: {
|
|
24299
24303
|
type: string;
|
|
@@ -24369,6 +24373,7 @@ declare const _default: {
|
|
|
24369
24373
|
'x-route-path': string;
|
|
24370
24374
|
};
|
|
24371
24375
|
connected_account: {
|
|
24376
|
+
description: string;
|
|
24372
24377
|
properties: {
|
|
24373
24378
|
account_type: {
|
|
24374
24379
|
type: string;
|
|
@@ -24588,6 +24593,7 @@ declare const _default: {
|
|
|
24588
24593
|
'x-route-path': string;
|
|
24589
24594
|
};
|
|
24590
24595
|
device: {
|
|
24596
|
+
description: string;
|
|
24591
24597
|
properties: {
|
|
24592
24598
|
can_hvac_cool: {
|
|
24593
24599
|
type: string;
|
|
@@ -25768,6 +25774,7 @@ declare const _default: {
|
|
|
25768
25774
|
type: string;
|
|
25769
25775
|
};
|
|
25770
25776
|
code_constraints: {
|
|
25777
|
+
description: string;
|
|
25771
25778
|
items: {
|
|
25772
25779
|
oneOf: ({
|
|
25773
25780
|
properties: {
|
|
@@ -26523,6 +26530,7 @@ declare const _default: {
|
|
|
26523
26530
|
'x-route-path': string;
|
|
26524
26531
|
};
|
|
26525
26532
|
event: {
|
|
26533
|
+
description: string;
|
|
26526
26534
|
discriminator: {
|
|
26527
26535
|
propertyName: string;
|
|
26528
26536
|
};
|
|
@@ -30888,6 +30896,7 @@ declare const _default: {
|
|
|
30888
30896
|
'x-route-path': string;
|
|
30889
30897
|
};
|
|
30890
30898
|
unmanaged_device: {
|
|
30899
|
+
description: string;
|
|
30891
30900
|
properties: {
|
|
30892
30901
|
can_hvac_cool: {
|
|
30893
30902
|
type: string;
|
|
@@ -31296,6 +31305,7 @@ declare const _default: {
|
|
|
31296
31305
|
'x-route-path': string;
|
|
31297
31306
|
};
|
|
31298
31307
|
workspace: {
|
|
31308
|
+
description: string;
|
|
31299
31309
|
properties: {
|
|
31300
31310
|
company_name: {
|
|
31301
31311
|
type: string;
|
|
@@ -31961,6 +31971,7 @@ declare const _default: {
|
|
|
31961
31971
|
};
|
|
31962
31972
|
'/access_codes/generate_code': {
|
|
31963
31973
|
post: {
|
|
31974
|
+
description: string;
|
|
31964
31975
|
operationId: string;
|
|
31965
31976
|
requestBody: {
|
|
31966
31977
|
content: {
|
|
@@ -31968,6 +31979,7 @@ declare const _default: {
|
|
|
31968
31979
|
schema: {
|
|
31969
31980
|
properties: {
|
|
31970
31981
|
device_id: {
|
|
31982
|
+
description: string;
|
|
31971
31983
|
format: string;
|
|
31972
31984
|
type: string;
|
|
31973
31985
|
};
|
|
@@ -32032,6 +32044,7 @@ declare const _default: {
|
|
|
32032
32044
|
'x-fern-sdk-method-name': string;
|
|
32033
32045
|
'x-fern-sdk-return-value': string;
|
|
32034
32046
|
'x-response-key': string;
|
|
32047
|
+
'x-title': string;
|
|
32035
32048
|
};
|
|
32036
32049
|
};
|
|
32037
32050
|
'/access_codes/get': {
|
|
@@ -33756,6 +33769,11 @@ declare const _default: {
|
|
|
33756
33769
|
format: string;
|
|
33757
33770
|
type: string;
|
|
33758
33771
|
};
|
|
33772
|
+
user_identity_id: {
|
|
33773
|
+
description: string;
|
|
33774
|
+
format: string;
|
|
33775
|
+
type: string;
|
|
33776
|
+
};
|
|
33759
33777
|
};
|
|
33760
33778
|
required: string[];
|
|
33761
33779
|
type: string;
|
|
@@ -33825,6 +33843,11 @@ declare const _default: {
|
|
|
33825
33843
|
format: string;
|
|
33826
33844
|
type: string;
|
|
33827
33845
|
};
|
|
33846
|
+
user_identity_id: {
|
|
33847
|
+
description: string;
|
|
33848
|
+
format: string;
|
|
33849
|
+
type: string;
|
|
33850
|
+
};
|
|
33828
33851
|
};
|
|
33829
33852
|
required: string[];
|
|
33830
33853
|
type: string;
|
|
@@ -34317,6 +34340,7 @@ declare const _default: {
|
|
|
34317
34340
|
'x-fern-sdk-method-name': string;
|
|
34318
34341
|
'x-fern-sdk-return-value': string;
|
|
34319
34342
|
'x-response-key': string;
|
|
34343
|
+
'x-title': string;
|
|
34320
34344
|
'x-undocumented': string;
|
|
34321
34345
|
};
|
|
34322
34346
|
};
|
|
@@ -34394,11 +34418,13 @@ declare const _default: {
|
|
|
34394
34418
|
'x-fern-sdk-method-name': string;
|
|
34395
34419
|
'x-fern-sdk-return-value': string;
|
|
34396
34420
|
'x-response-key': string;
|
|
34421
|
+
'x-title': string;
|
|
34397
34422
|
'x-undocumented': string;
|
|
34398
34423
|
};
|
|
34399
34424
|
};
|
|
34400
34425
|
'/acs/credential_pools/list': {
|
|
34401
34426
|
post: {
|
|
34427
|
+
description: string;
|
|
34402
34428
|
operationId: string;
|
|
34403
34429
|
requestBody: {
|
|
34404
34430
|
content: {
|
|
@@ -34406,6 +34432,7 @@ declare const _default: {
|
|
|
34406
34432
|
schema: {
|
|
34407
34433
|
properties: {
|
|
34408
34434
|
acs_system_id: {
|
|
34435
|
+
description: string;
|
|
34409
34436
|
format: string;
|
|
34410
34437
|
type: string;
|
|
34411
34438
|
};
|
|
@@ -34466,11 +34493,13 @@ declare const _default: {
|
|
|
34466
34493
|
'x-fern-sdk-method-name': string;
|
|
34467
34494
|
'x-fern-sdk-return-value': string;
|
|
34468
34495
|
'x-response-key': string;
|
|
34496
|
+
'x-title': string;
|
|
34469
34497
|
'x-undocumented': string;
|
|
34470
34498
|
};
|
|
34471
34499
|
};
|
|
34472
34500
|
'/acs/credential_provisioning_automations/launch': {
|
|
34473
34501
|
post: {
|
|
34502
|
+
description: string;
|
|
34474
34503
|
operationId: string;
|
|
34475
34504
|
requestBody: {
|
|
34476
34505
|
content: {
|
|
@@ -34478,21 +34507,26 @@ declare const _default: {
|
|
|
34478
34507
|
schema: {
|
|
34479
34508
|
properties: {
|
|
34480
34509
|
acs_credential_pool_id: {
|
|
34510
|
+
description: string;
|
|
34481
34511
|
format: string;
|
|
34482
34512
|
type: string;
|
|
34483
34513
|
};
|
|
34484
34514
|
create_credential_manager_user: {
|
|
34515
|
+
description: string;
|
|
34485
34516
|
type: string;
|
|
34486
34517
|
};
|
|
34487
34518
|
credential_manager_acs_system_id: {
|
|
34519
|
+
description: string;
|
|
34488
34520
|
format: string;
|
|
34489
34521
|
type: string;
|
|
34490
34522
|
};
|
|
34491
34523
|
credential_manager_acs_user_id: {
|
|
34524
|
+
description: string;
|
|
34492
34525
|
format: string;
|
|
34493
34526
|
type: string;
|
|
34494
34527
|
};
|
|
34495
34528
|
user_identity_id: {
|
|
34529
|
+
description: string;
|
|
34496
34530
|
format: string;
|
|
34497
34531
|
type: string;
|
|
34498
34532
|
};
|
|
@@ -34550,6 +34584,7 @@ declare const _default: {
|
|
|
34550
34584
|
'x-fern-sdk-method-name': string;
|
|
34551
34585
|
'x-fern-sdk-return-value': string;
|
|
34552
34586
|
'x-response-key': string;
|
|
34587
|
+
'x-title': string;
|
|
34553
34588
|
'x-undocumented': string;
|
|
34554
34589
|
};
|
|
34555
34590
|
};
|
|
@@ -34777,9 +34812,11 @@ declare const _default: {
|
|
|
34777
34812
|
description: string;
|
|
34778
34813
|
properties: {
|
|
34779
34814
|
assign_new_key: {
|
|
34815
|
+
description: string;
|
|
34780
34816
|
type: string;
|
|
34781
34817
|
};
|
|
34782
34818
|
update_current_key: {
|
|
34819
|
+
description: string;
|
|
34783
34820
|
type: string;
|
|
34784
34821
|
};
|
|
34785
34822
|
};
|
|
@@ -35574,6 +35611,7 @@ declare const _default: {
|
|
|
35574
35611
|
'application/json': {
|
|
35575
35612
|
schema: {
|
|
35576
35613
|
oneOf: ({
|
|
35614
|
+
description: string;
|
|
35577
35615
|
properties: {
|
|
35578
35616
|
acs_user_id: {
|
|
35579
35617
|
description: string;
|
|
@@ -35586,6 +35624,7 @@ declare const _default: {
|
|
|
35586
35624
|
required: string[];
|
|
35587
35625
|
type: string;
|
|
35588
35626
|
} | {
|
|
35627
|
+
description: string;
|
|
35589
35628
|
properties: {
|
|
35590
35629
|
acs_system_id: {
|
|
35591
35630
|
description: string;
|
|
@@ -35598,6 +35637,7 @@ declare const _default: {
|
|
|
35598
35637
|
required: string[];
|
|
35599
35638
|
type: string;
|
|
35600
35639
|
} | {
|
|
35640
|
+
description: string;
|
|
35601
35641
|
properties: {
|
|
35602
35642
|
acs_system_id: {
|
|
35603
35643
|
description: string;
|
|
@@ -35614,6 +35654,7 @@ declare const _default: {
|
|
|
35614
35654
|
required: string[];
|
|
35615
35655
|
type: string;
|
|
35616
35656
|
} | {
|
|
35657
|
+
description: string;
|
|
35617
35658
|
properties: {
|
|
35618
35659
|
user_identity_id: {
|
|
35619
35660
|
description: string;
|
|
@@ -36628,6 +36669,7 @@ declare const _default: {
|
|
|
36628
36669
|
schema: {
|
|
36629
36670
|
properties: {
|
|
36630
36671
|
acs_entrance_id: {
|
|
36672
|
+
description: string;
|
|
36631
36673
|
format: string;
|
|
36632
36674
|
type: string;
|
|
36633
36675
|
};
|
|
@@ -36697,6 +36739,7 @@ declare const _default: {
|
|
|
36697
36739
|
};
|
|
36698
36740
|
'/acs/entrances/grant_access': {
|
|
36699
36741
|
post: {
|
|
36742
|
+
description: string;
|
|
36700
36743
|
operationId: string;
|
|
36701
36744
|
requestBody: {
|
|
36702
36745
|
content: {
|
|
@@ -36704,10 +36747,12 @@ declare const _default: {
|
|
|
36704
36747
|
schema: {
|
|
36705
36748
|
properties: {
|
|
36706
36749
|
acs_entrance_id: {
|
|
36750
|
+
description: string;
|
|
36707
36751
|
format: string;
|
|
36708
36752
|
type: string;
|
|
36709
36753
|
};
|
|
36710
36754
|
acs_user_id: {
|
|
36755
|
+
description: string;
|
|
36711
36756
|
format: string;
|
|
36712
36757
|
type: string;
|
|
36713
36758
|
};
|
|
@@ -36773,14 +36818,17 @@ declare const _default: {
|
|
|
36773
36818
|
schema: {
|
|
36774
36819
|
properties: {
|
|
36775
36820
|
acs_credential_id: {
|
|
36821
|
+
description: string;
|
|
36776
36822
|
format: string;
|
|
36777
36823
|
type: string;
|
|
36778
36824
|
};
|
|
36779
36825
|
acs_system_id: {
|
|
36826
|
+
description: string;
|
|
36780
36827
|
format: string;
|
|
36781
36828
|
type: string;
|
|
36782
36829
|
};
|
|
36783
36830
|
location_id: {
|
|
36831
|
+
description: string;
|
|
36784
36832
|
format: string;
|
|
36785
36833
|
nullable: boolean;
|
|
36786
36834
|
type: string;
|
|
@@ -36862,10 +36910,12 @@ declare const _default: {
|
|
|
36862
36910
|
schema: {
|
|
36863
36911
|
properties: {
|
|
36864
36912
|
acs_entrance_id: {
|
|
36913
|
+
description: string;
|
|
36865
36914
|
format: string;
|
|
36866
36915
|
type: string;
|
|
36867
36916
|
};
|
|
36868
36917
|
include_if: {
|
|
36918
|
+
description: string;
|
|
36869
36919
|
items: {
|
|
36870
36920
|
enum: string[];
|
|
36871
36921
|
type: string;
|
|
@@ -37314,11 +37364,13 @@ declare const _default: {
|
|
|
37314
37364
|
description: string;
|
|
37315
37365
|
properties: {
|
|
37316
37366
|
ends_at: {
|
|
37367
|
+
description: string;
|
|
37317
37368
|
format: string;
|
|
37318
37369
|
nullable: boolean;
|
|
37319
37370
|
type: string;
|
|
37320
37371
|
};
|
|
37321
37372
|
starts_at: {
|
|
37373
|
+
description: string;
|
|
37322
37374
|
format: string;
|
|
37323
37375
|
type: string;
|
|
37324
37376
|
};
|
|
@@ -37570,6 +37622,7 @@ declare const _default: {
|
|
|
37570
37622
|
type: string;
|
|
37571
37623
|
};
|
|
37572
37624
|
created_before: {
|
|
37625
|
+
description: string;
|
|
37573
37626
|
format: string;
|
|
37574
37627
|
type: string;
|
|
37575
37628
|
};
|
|
@@ -37958,6 +38011,7 @@ declare const _default: {
|
|
|
37958
38011
|
};
|
|
37959
38012
|
'/acs/users/unmanaged/get': {
|
|
37960
38013
|
post: {
|
|
38014
|
+
description: string;
|
|
37961
38015
|
operationId: string;
|
|
37962
38016
|
requestBody: {
|
|
37963
38017
|
content: {
|
|
@@ -37965,6 +38019,7 @@ declare const _default: {
|
|
|
37965
38019
|
schema: {
|
|
37966
38020
|
properties: {
|
|
37967
38021
|
acs_user_id: {
|
|
38022
|
+
description: string;
|
|
37968
38023
|
format: string;
|
|
37969
38024
|
type: string;
|
|
37970
38025
|
};
|
|
@@ -38021,11 +38076,13 @@ declare const _default: {
|
|
|
38021
38076
|
'x-fern-sdk-method-name': string;
|
|
38022
38077
|
'x-fern-sdk-return-value': string;
|
|
38023
38078
|
'x-response-key': string;
|
|
38079
|
+
'x-title': string;
|
|
38024
38080
|
'x-undocumented': string;
|
|
38025
38081
|
};
|
|
38026
38082
|
};
|
|
38027
38083
|
'/acs/users/unmanaged/list': {
|
|
38028
38084
|
post: {
|
|
38085
|
+
description: string;
|
|
38029
38086
|
operationId: string;
|
|
38030
38087
|
requestBody: {
|
|
38031
38088
|
content: {
|
|
@@ -38033,22 +38090,27 @@ declare const _default: {
|
|
|
38033
38090
|
schema: {
|
|
38034
38091
|
properties: {
|
|
38035
38092
|
acs_system_id: {
|
|
38093
|
+
description: string;
|
|
38036
38094
|
format: string;
|
|
38037
38095
|
type: string;
|
|
38038
38096
|
};
|
|
38039
38097
|
limit: {
|
|
38040
38098
|
default: number;
|
|
38099
|
+
description: string;
|
|
38041
38100
|
format: string;
|
|
38042
38101
|
type: string;
|
|
38043
38102
|
};
|
|
38044
38103
|
user_identity_email_address: {
|
|
38104
|
+
description: string;
|
|
38045
38105
|
type: string;
|
|
38046
38106
|
};
|
|
38047
38107
|
user_identity_id: {
|
|
38108
|
+
description: string;
|
|
38048
38109
|
format: string;
|
|
38049
38110
|
type: string;
|
|
38050
38111
|
};
|
|
38051
38112
|
user_identity_phone_number: {
|
|
38113
|
+
description: string;
|
|
38052
38114
|
type: string;
|
|
38053
38115
|
};
|
|
38054
38116
|
};
|
|
@@ -38106,6 +38168,7 @@ declare const _default: {
|
|
|
38106
38168
|
'x-fern-sdk-method-name': string;
|
|
38107
38169
|
'x-fern-sdk-return-value': string;
|
|
38108
38170
|
'x-response-key': string;
|
|
38171
|
+
'x-title': string;
|
|
38109
38172
|
'x-undocumented': string;
|
|
38110
38173
|
};
|
|
38111
38174
|
};
|
|
@@ -38189,10 +38252,12 @@ declare const _default: {
|
|
|
38189
38252
|
nullable: boolean;
|
|
38190
38253
|
properties: {
|
|
38191
38254
|
ends_at: {
|
|
38255
|
+
description: string;
|
|
38192
38256
|
format: string;
|
|
38193
38257
|
type: string;
|
|
38194
38258
|
};
|
|
38195
38259
|
starts_at: {
|
|
38260
|
+
description: string;
|
|
38196
38261
|
format: string;
|
|
38197
38262
|
type: string;
|
|
38198
38263
|
};
|
|
@@ -38292,10 +38357,12 @@ declare const _default: {
|
|
|
38292
38357
|
nullable: boolean;
|
|
38293
38358
|
properties: {
|
|
38294
38359
|
ends_at: {
|
|
38360
|
+
description: string;
|
|
38295
38361
|
format: string;
|
|
38296
38362
|
type: string;
|
|
38297
38363
|
};
|
|
38298
38364
|
starts_at: {
|
|
38365
|
+
description: string;
|
|
38299
38366
|
format: string;
|
|
38300
38367
|
type: string;
|
|
38301
38368
|
};
|
|
@@ -38386,6 +38453,7 @@ declare const _default: {
|
|
|
38386
38453
|
};
|
|
38387
38454
|
'/action_attempts/get': {
|
|
38388
38455
|
post: {
|
|
38456
|
+
description: string;
|
|
38389
38457
|
operationId: string;
|
|
38390
38458
|
requestBody: {
|
|
38391
38459
|
content: {
|
|
@@ -38393,6 +38461,7 @@ declare const _default: {
|
|
|
38393
38461
|
schema: {
|
|
38394
38462
|
properties: {
|
|
38395
38463
|
action_attempt_id: {
|
|
38464
|
+
description: string;
|
|
38396
38465
|
format: string;
|
|
38397
38466
|
type: string;
|
|
38398
38467
|
};
|
|
@@ -38457,10 +38526,12 @@ declare const _default: {
|
|
|
38457
38526
|
'x-fern-sdk-method-name': string;
|
|
38458
38527
|
'x-fern-sdk-return-value': string;
|
|
38459
38528
|
'x-response-key': string;
|
|
38529
|
+
'x-title': string;
|
|
38460
38530
|
};
|
|
38461
38531
|
};
|
|
38462
38532
|
'/action_attempts/list': {
|
|
38463
38533
|
post: {
|
|
38534
|
+
description: string;
|
|
38464
38535
|
operationId: string;
|
|
38465
38536
|
requestBody: {
|
|
38466
38537
|
content: {
|
|
@@ -38468,6 +38539,7 @@ declare const _default: {
|
|
|
38468
38539
|
schema: {
|
|
38469
38540
|
properties: {
|
|
38470
38541
|
action_attempt_ids: {
|
|
38542
|
+
description: string;
|
|
38471
38543
|
items: {
|
|
38472
38544
|
format: string;
|
|
38473
38545
|
type: string;
|
|
@@ -38530,10 +38602,12 @@ declare const _default: {
|
|
|
38530
38602
|
'x-fern-sdk-method-name': string;
|
|
38531
38603
|
'x-fern-sdk-return-value': string;
|
|
38532
38604
|
'x-response-key': string;
|
|
38605
|
+
'x-title': string;
|
|
38533
38606
|
};
|
|
38534
38607
|
};
|
|
38535
38608
|
'/bridges/get': {
|
|
38536
38609
|
post: {
|
|
38610
|
+
description: string;
|
|
38537
38611
|
operationId: string;
|
|
38538
38612
|
requestBody: {
|
|
38539
38613
|
content: {
|
|
@@ -38541,6 +38615,7 @@ declare const _default: {
|
|
|
38541
38615
|
schema: {
|
|
38542
38616
|
properties: {
|
|
38543
38617
|
bridge_id: {
|
|
38618
|
+
description: string;
|
|
38544
38619
|
format: string;
|
|
38545
38620
|
type: string;
|
|
38546
38621
|
};
|
|
@@ -38614,10 +38689,13 @@ declare const _default: {
|
|
|
38614
38689
|
'x-fern-sdk-method-name': string;
|
|
38615
38690
|
'x-fern-sdk-return-value': string;
|
|
38616
38691
|
'x-response-key': string;
|
|
38692
|
+
'x-title': string;
|
|
38693
|
+
'x-undocumented': string;
|
|
38617
38694
|
};
|
|
38618
38695
|
};
|
|
38619
38696
|
'/bridges/list': {
|
|
38620
38697
|
post: {
|
|
38698
|
+
description: string;
|
|
38621
38699
|
operationId: string;
|
|
38622
38700
|
requestBody: {
|
|
38623
38701
|
content: {
|
|
@@ -38695,10 +38773,13 @@ declare const _default: {
|
|
|
38695
38773
|
'x-fern-sdk-method-name': string;
|
|
38696
38774
|
'x-fern-sdk-return-value': string;
|
|
38697
38775
|
'x-response-key': string;
|
|
38776
|
+
'x-title': string;
|
|
38777
|
+
'x-undocumented': string;
|
|
38698
38778
|
};
|
|
38699
38779
|
};
|
|
38700
38780
|
'/client_sessions/create': {
|
|
38701
38781
|
post: {
|
|
38782
|
+
description: string;
|
|
38702
38783
|
operationId: string;
|
|
38703
38784
|
requestBody: {
|
|
38704
38785
|
content: {
|
|
@@ -38706,26 +38787,31 @@ declare const _default: {
|
|
|
38706
38787
|
schema: {
|
|
38707
38788
|
properties: {
|
|
38708
38789
|
connect_webview_ids: {
|
|
38790
|
+
description: string;
|
|
38709
38791
|
items: {
|
|
38710
38792
|
type: string;
|
|
38711
38793
|
};
|
|
38712
38794
|
type: string;
|
|
38713
38795
|
};
|
|
38714
38796
|
connected_account_ids: {
|
|
38797
|
+
description: string;
|
|
38715
38798
|
items: {
|
|
38716
38799
|
type: string;
|
|
38717
38800
|
};
|
|
38718
38801
|
type: string;
|
|
38719
38802
|
};
|
|
38720
38803
|
expires_at: {
|
|
38804
|
+
description: string;
|
|
38721
38805
|
format: string;
|
|
38722
38806
|
type: string;
|
|
38723
38807
|
};
|
|
38724
38808
|
user_identifier_key: {
|
|
38809
|
+
description: string;
|
|
38725
38810
|
minLength: number;
|
|
38726
38811
|
type: string;
|
|
38727
38812
|
};
|
|
38728
38813
|
user_identity_ids: {
|
|
38814
|
+
description: string;
|
|
38729
38815
|
items: {
|
|
38730
38816
|
type: string;
|
|
38731
38817
|
};
|
|
@@ -38791,8 +38877,10 @@ declare const _default: {
|
|
|
38791
38877
|
'x-fern-sdk-method-name': string;
|
|
38792
38878
|
'x-fern-sdk-return-value': string;
|
|
38793
38879
|
'x-response-key': string;
|
|
38880
|
+
'x-title': string;
|
|
38794
38881
|
};
|
|
38795
38882
|
put: {
|
|
38883
|
+
description: string;
|
|
38796
38884
|
operationId: string;
|
|
38797
38885
|
requestBody: {
|
|
38798
38886
|
content: {
|
|
@@ -38800,26 +38888,31 @@ declare const _default: {
|
|
|
38800
38888
|
schema: {
|
|
38801
38889
|
properties: {
|
|
38802
38890
|
connect_webview_ids: {
|
|
38891
|
+
description: string;
|
|
38803
38892
|
items: {
|
|
38804
38893
|
type: string;
|
|
38805
38894
|
};
|
|
38806
38895
|
type: string;
|
|
38807
38896
|
};
|
|
38808
38897
|
connected_account_ids: {
|
|
38898
|
+
description: string;
|
|
38809
38899
|
items: {
|
|
38810
38900
|
type: string;
|
|
38811
38901
|
};
|
|
38812
38902
|
type: string;
|
|
38813
38903
|
};
|
|
38814
38904
|
expires_at: {
|
|
38905
|
+
description: string;
|
|
38815
38906
|
format: string;
|
|
38816
38907
|
type: string;
|
|
38817
38908
|
};
|
|
38818
38909
|
user_identifier_key: {
|
|
38910
|
+
description: string;
|
|
38819
38911
|
minLength: number;
|
|
38820
38912
|
type: string;
|
|
38821
38913
|
};
|
|
38822
38914
|
user_identity_ids: {
|
|
38915
|
+
description: string;
|
|
38823
38916
|
items: {
|
|
38824
38917
|
type: string;
|
|
38825
38918
|
};
|
|
@@ -38883,10 +38976,12 @@ declare const _default: {
|
|
|
38883
38976
|
tags: string[];
|
|
38884
38977
|
'x-fern-ignore': boolean;
|
|
38885
38978
|
'x-response-key': string;
|
|
38979
|
+
'x-title': string;
|
|
38886
38980
|
};
|
|
38887
38981
|
};
|
|
38888
38982
|
'/client_sessions/delete': {
|
|
38889
38983
|
post: {
|
|
38984
|
+
description: string;
|
|
38890
38985
|
operationId: string;
|
|
38891
38986
|
requestBody: {
|
|
38892
38987
|
content: {
|
|
@@ -38894,6 +38989,7 @@ declare const _default: {
|
|
|
38894
38989
|
schema: {
|
|
38895
38990
|
properties: {
|
|
38896
38991
|
client_session_id: {
|
|
38992
|
+
description: string;
|
|
38897
38993
|
format: string;
|
|
38898
38994
|
type: string;
|
|
38899
38995
|
};
|
|
@@ -38946,10 +39042,12 @@ declare const _default: {
|
|
|
38946
39042
|
'x-fern-sdk-group-name': string[];
|
|
38947
39043
|
'x-fern-sdk-method-name': string;
|
|
38948
39044
|
'x-response-key': null;
|
|
39045
|
+
'x-title': string;
|
|
38949
39046
|
};
|
|
38950
39047
|
};
|
|
38951
39048
|
'/client_sessions/get': {
|
|
38952
39049
|
post: {
|
|
39050
|
+
description: string;
|
|
38953
39051
|
operationId: string;
|
|
38954
39052
|
requestBody: {
|
|
38955
39053
|
content: {
|
|
@@ -38957,9 +39055,11 @@ declare const _default: {
|
|
|
38957
39055
|
schema: {
|
|
38958
39056
|
properties: {
|
|
38959
39057
|
client_session_id: {
|
|
39058
|
+
description: string;
|
|
38960
39059
|
type: string;
|
|
38961
39060
|
};
|
|
38962
39061
|
user_identifier_key: {
|
|
39062
|
+
description: string;
|
|
38963
39063
|
type: string;
|
|
38964
39064
|
};
|
|
38965
39065
|
};
|
|
@@ -39022,10 +39122,12 @@ declare const _default: {
|
|
|
39022
39122
|
'x-fern-sdk-method-name': string;
|
|
39023
39123
|
'x-fern-sdk-return-value': string;
|
|
39024
39124
|
'x-response-key': string;
|
|
39125
|
+
'x-title': string;
|
|
39025
39126
|
};
|
|
39026
39127
|
};
|
|
39027
39128
|
'/client_sessions/get_or_create': {
|
|
39028
39129
|
post: {
|
|
39130
|
+
description: string;
|
|
39029
39131
|
operationId: string;
|
|
39030
39132
|
requestBody: {
|
|
39031
39133
|
content: {
|
|
@@ -39033,26 +39135,31 @@ declare const _default: {
|
|
|
39033
39135
|
schema: {
|
|
39034
39136
|
properties: {
|
|
39035
39137
|
connect_webview_ids: {
|
|
39138
|
+
description: string;
|
|
39036
39139
|
items: {
|
|
39037
39140
|
type: string;
|
|
39038
39141
|
};
|
|
39039
39142
|
type: string;
|
|
39040
39143
|
};
|
|
39041
39144
|
connected_account_ids: {
|
|
39145
|
+
description: string;
|
|
39042
39146
|
items: {
|
|
39043
39147
|
type: string;
|
|
39044
39148
|
};
|
|
39045
39149
|
type: string;
|
|
39046
39150
|
};
|
|
39047
39151
|
expires_at: {
|
|
39152
|
+
description: string;
|
|
39048
39153
|
format: string;
|
|
39049
39154
|
type: string;
|
|
39050
39155
|
};
|
|
39051
39156
|
user_identifier_key: {
|
|
39157
|
+
description: string;
|
|
39052
39158
|
minLength: number;
|
|
39053
39159
|
type: string;
|
|
39054
39160
|
};
|
|
39055
39161
|
user_identity_ids: {
|
|
39162
|
+
description: string;
|
|
39056
39163
|
items: {
|
|
39057
39164
|
type: string;
|
|
39058
39165
|
};
|
|
@@ -39118,10 +39225,12 @@ declare const _default: {
|
|
|
39118
39225
|
'x-fern-sdk-method-name': string;
|
|
39119
39226
|
'x-fern-sdk-return-value': string;
|
|
39120
39227
|
'x-response-key': string;
|
|
39228
|
+
'x-title': string;
|
|
39121
39229
|
};
|
|
39122
39230
|
};
|
|
39123
39231
|
'/client_sessions/grant_access': {
|
|
39124
39232
|
patch: {
|
|
39233
|
+
description: string;
|
|
39125
39234
|
operationId: string;
|
|
39126
39235
|
requestBody: {
|
|
39127
39236
|
content: {
|
|
@@ -39129,24 +39238,29 @@ declare const _default: {
|
|
|
39129
39238
|
schema: {
|
|
39130
39239
|
properties: {
|
|
39131
39240
|
client_session_id: {
|
|
39241
|
+
description: string;
|
|
39132
39242
|
type: string;
|
|
39133
39243
|
};
|
|
39134
39244
|
connect_webview_ids: {
|
|
39245
|
+
description: string;
|
|
39135
39246
|
items: {
|
|
39136
39247
|
type: string;
|
|
39137
39248
|
};
|
|
39138
39249
|
type: string;
|
|
39139
39250
|
};
|
|
39140
39251
|
connected_account_ids: {
|
|
39252
|
+
description: string;
|
|
39141
39253
|
items: {
|
|
39142
39254
|
type: string;
|
|
39143
39255
|
};
|
|
39144
39256
|
type: string;
|
|
39145
39257
|
};
|
|
39146
39258
|
user_identifier_key: {
|
|
39259
|
+
description: string;
|
|
39147
39260
|
type: string;
|
|
39148
39261
|
};
|
|
39149
39262
|
user_identity_ids: {
|
|
39263
|
+
description: string;
|
|
39150
39264
|
items: {
|
|
39151
39265
|
type: string;
|
|
39152
39266
|
};
|
|
@@ -39202,8 +39316,10 @@ declare const _default: {
|
|
|
39202
39316
|
tags: string[];
|
|
39203
39317
|
'x-fern-ignore': boolean;
|
|
39204
39318
|
'x-response-key': null;
|
|
39319
|
+
'x-title': string;
|
|
39205
39320
|
};
|
|
39206
39321
|
post: {
|
|
39322
|
+
description: string;
|
|
39207
39323
|
operationId: string;
|
|
39208
39324
|
requestBody: {
|
|
39209
39325
|
content: {
|
|
@@ -39211,24 +39327,29 @@ declare const _default: {
|
|
|
39211
39327
|
schema: {
|
|
39212
39328
|
properties: {
|
|
39213
39329
|
client_session_id: {
|
|
39330
|
+
description: string;
|
|
39214
39331
|
type: string;
|
|
39215
39332
|
};
|
|
39216
39333
|
connect_webview_ids: {
|
|
39334
|
+
description: string;
|
|
39217
39335
|
items: {
|
|
39218
39336
|
type: string;
|
|
39219
39337
|
};
|
|
39220
39338
|
type: string;
|
|
39221
39339
|
};
|
|
39222
39340
|
connected_account_ids: {
|
|
39341
|
+
description: string;
|
|
39223
39342
|
items: {
|
|
39224
39343
|
type: string;
|
|
39225
39344
|
};
|
|
39226
39345
|
type: string;
|
|
39227
39346
|
};
|
|
39228
39347
|
user_identifier_key: {
|
|
39348
|
+
description: string;
|
|
39229
39349
|
type: string;
|
|
39230
39350
|
};
|
|
39231
39351
|
user_identity_ids: {
|
|
39352
|
+
description: string;
|
|
39232
39353
|
items: {
|
|
39233
39354
|
type: string;
|
|
39234
39355
|
};
|
|
@@ -39285,10 +39406,12 @@ declare const _default: {
|
|
|
39285
39406
|
'x-fern-sdk-group-name': string[];
|
|
39286
39407
|
'x-fern-sdk-method-name': string;
|
|
39287
39408
|
'x-response-key': null;
|
|
39409
|
+
'x-title': string;
|
|
39288
39410
|
};
|
|
39289
39411
|
};
|
|
39290
39412
|
'/client_sessions/list': {
|
|
39291
39413
|
post: {
|
|
39414
|
+
description: string;
|
|
39292
39415
|
operationId: string;
|
|
39293
39416
|
requestBody: {
|
|
39294
39417
|
content: {
|
|
@@ -39296,18 +39419,23 @@ declare const _default: {
|
|
|
39296
39419
|
schema: {
|
|
39297
39420
|
properties: {
|
|
39298
39421
|
client_session_id: {
|
|
39422
|
+
description: string;
|
|
39299
39423
|
type: string;
|
|
39300
39424
|
};
|
|
39301
39425
|
connect_webview_id: {
|
|
39426
|
+
description: string;
|
|
39302
39427
|
type: string;
|
|
39303
39428
|
};
|
|
39304
39429
|
user_identifier_key: {
|
|
39430
|
+
description: string;
|
|
39305
39431
|
type: string;
|
|
39306
39432
|
};
|
|
39307
39433
|
user_identity_id: {
|
|
39434
|
+
description: string;
|
|
39308
39435
|
type: string;
|
|
39309
39436
|
};
|
|
39310
39437
|
without_user_identifier_key: {
|
|
39438
|
+
description: string;
|
|
39311
39439
|
type: string;
|
|
39312
39440
|
};
|
|
39313
39441
|
};
|
|
@@ -39365,10 +39493,12 @@ declare const _default: {
|
|
|
39365
39493
|
'x-fern-sdk-method-name': string;
|
|
39366
39494
|
'x-fern-sdk-return-value': string;
|
|
39367
39495
|
'x-response-key': string;
|
|
39496
|
+
'x-title': string;
|
|
39368
39497
|
};
|
|
39369
39498
|
};
|
|
39370
39499
|
'/client_sessions/revoke': {
|
|
39371
39500
|
post: {
|
|
39501
|
+
description: string;
|
|
39372
39502
|
operationId: string;
|
|
39373
39503
|
requestBody: {
|
|
39374
39504
|
content: {
|
|
@@ -39376,6 +39506,7 @@ declare const _default: {
|
|
|
39376
39506
|
schema: {
|
|
39377
39507
|
properties: {
|
|
39378
39508
|
client_session_id: {
|
|
39509
|
+
description: string;
|
|
39379
39510
|
format: string;
|
|
39380
39511
|
type: string;
|
|
39381
39512
|
};
|
|
@@ -39428,10 +39559,12 @@ declare const _default: {
|
|
|
39428
39559
|
'x-fern-sdk-group-name': string[];
|
|
39429
39560
|
'x-fern-sdk-method-name': string;
|
|
39430
39561
|
'x-response-key': null;
|
|
39562
|
+
'x-title': string;
|
|
39431
39563
|
};
|
|
39432
39564
|
};
|
|
39433
39565
|
'/connect_webviews/create': {
|
|
39434
39566
|
post: {
|
|
39567
|
+
description: string;
|
|
39435
39568
|
operationId: string;
|
|
39436
39569
|
requestBody: {
|
|
39437
39570
|
content: {
|
|
@@ -39439,6 +39572,7 @@ declare const _default: {
|
|
|
39439
39572
|
schema: {
|
|
39440
39573
|
properties: {
|
|
39441
39574
|
accepted_providers: {
|
|
39575
|
+
description: string;
|
|
39442
39576
|
items: {
|
|
39443
39577
|
enum: string[];
|
|
39444
39578
|
type: string;
|
|
@@ -39447,6 +39581,7 @@ declare const _default: {
|
|
|
39447
39581
|
};
|
|
39448
39582
|
automatically_manage_new_devices: {
|
|
39449
39583
|
default: boolean;
|
|
39584
|
+
description: string;
|
|
39450
39585
|
type: string;
|
|
39451
39586
|
};
|
|
39452
39587
|
custom_metadata: {
|
|
@@ -39460,24 +39595,30 @@ declare const _default: {
|
|
|
39460
39595
|
maxLength?: never;
|
|
39461
39596
|
})[];
|
|
39462
39597
|
};
|
|
39598
|
+
description: string;
|
|
39463
39599
|
type: string;
|
|
39464
39600
|
};
|
|
39465
39601
|
custom_redirect_failure_url: {
|
|
39602
|
+
description: string;
|
|
39466
39603
|
type: string;
|
|
39467
39604
|
};
|
|
39468
39605
|
custom_redirect_url: {
|
|
39606
|
+
description: string;
|
|
39469
39607
|
type: string;
|
|
39470
39608
|
};
|
|
39471
39609
|
device_selection_mode: {
|
|
39472
39610
|
enum: string[];
|
|
39473
39611
|
type: string;
|
|
39612
|
+
'x-undocumented': string;
|
|
39474
39613
|
};
|
|
39475
39614
|
provider_category: {
|
|
39615
|
+
description: string;
|
|
39476
39616
|
enum: string[];
|
|
39477
39617
|
type: string;
|
|
39478
39618
|
};
|
|
39479
39619
|
wait_for_device_creation: {
|
|
39480
39620
|
default: boolean;
|
|
39621
|
+
description: string;
|
|
39481
39622
|
type: string;
|
|
39482
39623
|
};
|
|
39483
39624
|
};
|
|
@@ -39540,10 +39681,12 @@ declare const _default: {
|
|
|
39540
39681
|
'x-fern-sdk-method-name': string;
|
|
39541
39682
|
'x-fern-sdk-return-value': string;
|
|
39542
39683
|
'x-response-key': string;
|
|
39684
|
+
'x-title': string;
|
|
39543
39685
|
};
|
|
39544
39686
|
};
|
|
39545
39687
|
'/connect_webviews/delete': {
|
|
39546
39688
|
post: {
|
|
39689
|
+
description: string;
|
|
39547
39690
|
operationId: string;
|
|
39548
39691
|
requestBody: {
|
|
39549
39692
|
content: {
|
|
@@ -39551,6 +39694,7 @@ declare const _default: {
|
|
|
39551
39694
|
schema: {
|
|
39552
39695
|
properties: {
|
|
39553
39696
|
connect_webview_id: {
|
|
39697
|
+
description: string;
|
|
39554
39698
|
format: string;
|
|
39555
39699
|
type: string;
|
|
39556
39700
|
};
|
|
@@ -39603,10 +39747,12 @@ declare const _default: {
|
|
|
39603
39747
|
'x-fern-sdk-group-name': string[];
|
|
39604
39748
|
'x-fern-sdk-method-name': string;
|
|
39605
39749
|
'x-response-key': null;
|
|
39750
|
+
'x-title': string;
|
|
39606
39751
|
};
|
|
39607
39752
|
};
|
|
39608
39753
|
'/connect_webviews/get': {
|
|
39609
39754
|
post: {
|
|
39755
|
+
description: string;
|
|
39610
39756
|
operationId: string;
|
|
39611
39757
|
requestBody: {
|
|
39612
39758
|
content: {
|
|
@@ -39614,6 +39760,7 @@ declare const _default: {
|
|
|
39614
39760
|
schema: {
|
|
39615
39761
|
properties: {
|
|
39616
39762
|
connect_webview_id: {
|
|
39763
|
+
description: string;
|
|
39617
39764
|
format: string;
|
|
39618
39765
|
type: string;
|
|
39619
39766
|
};
|
|
@@ -39678,10 +39825,12 @@ declare const _default: {
|
|
|
39678
39825
|
'x-fern-sdk-method-name': string;
|
|
39679
39826
|
'x-fern-sdk-return-value': string;
|
|
39680
39827
|
'x-response-key': string;
|
|
39828
|
+
'x-title': string;
|
|
39681
39829
|
};
|
|
39682
39830
|
};
|
|
39683
39831
|
'/connect_webviews/list': {
|
|
39684
39832
|
post: {
|
|
39833
|
+
description: string;
|
|
39685
39834
|
operationId: string;
|
|
39686
39835
|
requestBody: {
|
|
39687
39836
|
content: {
|
|
@@ -39699,6 +39848,7 @@ declare const _default: {
|
|
|
39699
39848
|
};
|
|
39700
39849
|
limit: {
|
|
39701
39850
|
default: number;
|
|
39851
|
+
description: string;
|
|
39702
39852
|
format: string;
|
|
39703
39853
|
type: string;
|
|
39704
39854
|
};
|
|
@@ -39769,10 +39919,12 @@ declare const _default: {
|
|
|
39769
39919
|
'x-fern-sdk-method-name': string;
|
|
39770
39920
|
'x-fern-sdk-return-value': string;
|
|
39771
39921
|
'x-response-key': string;
|
|
39922
|
+
'x-title': string;
|
|
39772
39923
|
};
|
|
39773
39924
|
};
|
|
39774
39925
|
'/connected_accounts/delete': {
|
|
39775
39926
|
post: {
|
|
39927
|
+
description: string;
|
|
39776
39928
|
operationId: string;
|
|
39777
39929
|
requestBody: {
|
|
39778
39930
|
content: {
|
|
@@ -39780,12 +39932,14 @@ declare const _default: {
|
|
|
39780
39932
|
schema: {
|
|
39781
39933
|
properties: {
|
|
39782
39934
|
connected_account_id: {
|
|
39935
|
+
description: string;
|
|
39783
39936
|
format: string;
|
|
39784
39937
|
type: string;
|
|
39785
39938
|
};
|
|
39786
39939
|
sync: {
|
|
39787
39940
|
default: boolean;
|
|
39788
39941
|
type: string;
|
|
39942
|
+
'x-undocumented': string;
|
|
39789
39943
|
};
|
|
39790
39944
|
};
|
|
39791
39945
|
required: string[];
|
|
@@ -39841,6 +39995,7 @@ declare const _default: {
|
|
|
39841
39995
|
};
|
|
39842
39996
|
'/connected_accounts/get': {
|
|
39843
39997
|
post: {
|
|
39998
|
+
description: string;
|
|
39844
39999
|
operationId: string;
|
|
39845
40000
|
requestBody: {
|
|
39846
40001
|
content: {
|
|
@@ -39849,6 +40004,7 @@ declare const _default: {
|
|
|
39849
40004
|
oneOf: ({
|
|
39850
40005
|
properties: {
|
|
39851
40006
|
connected_account_id: {
|
|
40007
|
+
description: string;
|
|
39852
40008
|
format: string;
|
|
39853
40009
|
type: string;
|
|
39854
40010
|
};
|
|
@@ -39859,6 +40015,7 @@ declare const _default: {
|
|
|
39859
40015
|
} | {
|
|
39860
40016
|
properties: {
|
|
39861
40017
|
email: {
|
|
40018
|
+
description: string;
|
|
39862
40019
|
format: string;
|
|
39863
40020
|
type: string;
|
|
39864
40021
|
};
|
|
@@ -39930,6 +40087,7 @@ declare const _default: {
|
|
|
39930
40087
|
};
|
|
39931
40088
|
'/connected_accounts/list': {
|
|
39932
40089
|
post: {
|
|
40090
|
+
description: string;
|
|
39933
40091
|
operationId: string;
|
|
39934
40092
|
requestBody: {
|
|
39935
40093
|
content: {
|
|
@@ -40031,6 +40189,7 @@ declare const _default: {
|
|
|
40031
40189
|
};
|
|
40032
40190
|
'/connected_accounts/update': {
|
|
40033
40191
|
post: {
|
|
40192
|
+
description: string;
|
|
40034
40193
|
operationId: string;
|
|
40035
40194
|
requestBody: {
|
|
40036
40195
|
content: {
|
|
@@ -40038,9 +40197,11 @@ declare const _default: {
|
|
|
40038
40197
|
schema: {
|
|
40039
40198
|
properties: {
|
|
40040
40199
|
automatically_manage_new_devices: {
|
|
40200
|
+
description: string;
|
|
40041
40201
|
type: string;
|
|
40042
40202
|
};
|
|
40043
40203
|
connected_account_id: {
|
|
40204
|
+
description: string;
|
|
40044
40205
|
format: string;
|
|
40045
40206
|
type: string;
|
|
40046
40207
|
};
|
|
@@ -40055,6 +40216,7 @@ declare const _default: {
|
|
|
40055
40216
|
maxLength?: never;
|
|
40056
40217
|
})[];
|
|
40057
40218
|
};
|
|
40219
|
+
description: string;
|
|
40058
40220
|
type: string;
|
|
40059
40221
|
};
|
|
40060
40222
|
};
|
|
@@ -40114,6 +40276,7 @@ declare const _default: {
|
|
|
40114
40276
|
};
|
|
40115
40277
|
'/devices/delete': {
|
|
40116
40278
|
post: {
|
|
40279
|
+
description: string;
|
|
40117
40280
|
operationId: string;
|
|
40118
40281
|
requestBody: {
|
|
40119
40282
|
content: {
|
|
@@ -40121,6 +40284,7 @@ declare const _default: {
|
|
|
40121
40284
|
schema: {
|
|
40122
40285
|
properties: {
|
|
40123
40286
|
device_id: {
|
|
40287
|
+
description: string;
|
|
40124
40288
|
format: string;
|
|
40125
40289
|
type: string;
|
|
40126
40290
|
};
|
|
@@ -40174,11 +40338,13 @@ declare const _default: {
|
|
|
40174
40338
|
'x-fern-sdk-group-name': string[];
|
|
40175
40339
|
'x-fern-sdk-method-name': string;
|
|
40176
40340
|
'x-response-key': null;
|
|
40341
|
+
'x-title': string;
|
|
40177
40342
|
'x-undocumented': string;
|
|
40178
40343
|
};
|
|
40179
40344
|
};
|
|
40180
40345
|
'/devices/get': {
|
|
40181
40346
|
post: {
|
|
40347
|
+
description: string;
|
|
40182
40348
|
operationId: string;
|
|
40183
40349
|
requestBody: {
|
|
40184
40350
|
content: {
|
|
@@ -40186,10 +40352,12 @@ declare const _default: {
|
|
|
40186
40352
|
schema: {
|
|
40187
40353
|
properties: {
|
|
40188
40354
|
device_id: {
|
|
40355
|
+
description: string;
|
|
40189
40356
|
format: string;
|
|
40190
40357
|
type: string;
|
|
40191
40358
|
};
|
|
40192
40359
|
name: {
|
|
40360
|
+
description: string;
|
|
40193
40361
|
type: string;
|
|
40194
40362
|
};
|
|
40195
40363
|
};
|
|
@@ -40252,6 +40420,7 @@ declare const _default: {
|
|
|
40252
40420
|
'x-fern-sdk-method-name': string;
|
|
40253
40421
|
'x-fern-sdk-return-value': string;
|
|
40254
40422
|
'x-response-key': string;
|
|
40423
|
+
'x-title': string;
|
|
40255
40424
|
};
|
|
40256
40425
|
};
|
|
40257
40426
|
'/devices/list': {
|
|
@@ -40370,6 +40539,7 @@ declare const _default: {
|
|
|
40370
40539
|
type: string;
|
|
40371
40540
|
};
|
|
40372
40541
|
unstable_location_id: {
|
|
40542
|
+
description: string;
|
|
40373
40543
|
format: string;
|
|
40374
40544
|
nullable: boolean;
|
|
40375
40545
|
type: string;
|
|
@@ -40450,6 +40620,7 @@ declare const _default: {
|
|
|
40450
40620
|
};
|
|
40451
40621
|
'/devices/list_device_providers': {
|
|
40452
40622
|
post: {
|
|
40623
|
+
description: string;
|
|
40453
40624
|
operationId: string;
|
|
40454
40625
|
requestBody: {
|
|
40455
40626
|
content: {
|
|
@@ -40457,6 +40628,7 @@ declare const _default: {
|
|
|
40457
40628
|
schema: {
|
|
40458
40629
|
properties: {
|
|
40459
40630
|
provider_category: {
|
|
40631
|
+
description: string;
|
|
40460
40632
|
enum: string[];
|
|
40461
40633
|
type: string;
|
|
40462
40634
|
};
|
|
@@ -40523,10 +40695,12 @@ declare const _default: {
|
|
|
40523
40695
|
'x-fern-sdk-method-name': string;
|
|
40524
40696
|
'x-fern-sdk-return-value': string;
|
|
40525
40697
|
'x-response-key': string;
|
|
40698
|
+
'x-title': string;
|
|
40526
40699
|
};
|
|
40527
40700
|
};
|
|
40528
40701
|
'/devices/simulate/connect': {
|
|
40529
40702
|
post: {
|
|
40703
|
+
description: string;
|
|
40530
40704
|
operationId: string;
|
|
40531
40705
|
requestBody: {
|
|
40532
40706
|
content: {
|
|
@@ -40534,6 +40708,7 @@ declare const _default: {
|
|
|
40534
40708
|
schema: {
|
|
40535
40709
|
properties: {
|
|
40536
40710
|
device_id: {
|
|
40711
|
+
description: string;
|
|
40537
40712
|
format: string;
|
|
40538
40713
|
type: string;
|
|
40539
40714
|
};
|
|
@@ -40586,10 +40761,12 @@ declare const _default: {
|
|
|
40586
40761
|
'x-fern-sdk-group-name': string[];
|
|
40587
40762
|
'x-fern-sdk-method-name': string;
|
|
40588
40763
|
'x-response-key': null;
|
|
40764
|
+
'x-title': string;
|
|
40589
40765
|
};
|
|
40590
40766
|
};
|
|
40591
40767
|
'/devices/simulate/disconnect': {
|
|
40592
40768
|
post: {
|
|
40769
|
+
description: string;
|
|
40593
40770
|
operationId: string;
|
|
40594
40771
|
requestBody: {
|
|
40595
40772
|
content: {
|
|
@@ -40597,6 +40774,7 @@ declare const _default: {
|
|
|
40597
40774
|
schema: {
|
|
40598
40775
|
properties: {
|
|
40599
40776
|
device_id: {
|
|
40777
|
+
description: string;
|
|
40600
40778
|
format: string;
|
|
40601
40779
|
type: string;
|
|
40602
40780
|
};
|
|
@@ -40649,10 +40827,12 @@ declare const _default: {
|
|
|
40649
40827
|
'x-fern-sdk-group-name': string[];
|
|
40650
40828
|
'x-fern-sdk-method-name': string;
|
|
40651
40829
|
'x-response-key': null;
|
|
40830
|
+
'x-title': string;
|
|
40652
40831
|
};
|
|
40653
40832
|
};
|
|
40654
40833
|
'/devices/simulate/remove': {
|
|
40655
40834
|
post: {
|
|
40835
|
+
description: string;
|
|
40656
40836
|
operationId: string;
|
|
40657
40837
|
requestBody: {
|
|
40658
40838
|
content: {
|
|
@@ -40660,6 +40840,7 @@ declare const _default: {
|
|
|
40660
40840
|
schema: {
|
|
40661
40841
|
properties: {
|
|
40662
40842
|
device_id: {
|
|
40843
|
+
description: string;
|
|
40663
40844
|
format: string;
|
|
40664
40845
|
type: string;
|
|
40665
40846
|
};
|
|
@@ -40712,10 +40893,12 @@ declare const _default: {
|
|
|
40712
40893
|
'x-fern-sdk-group-name': string[];
|
|
40713
40894
|
'x-fern-sdk-method-name': string;
|
|
40714
40895
|
'x-response-key': null;
|
|
40896
|
+
'x-title': string;
|
|
40715
40897
|
};
|
|
40716
40898
|
};
|
|
40717
40899
|
'/devices/unmanaged/get': {
|
|
40718
40900
|
post: {
|
|
40901
|
+
description: string;
|
|
40719
40902
|
operationId: string;
|
|
40720
40903
|
requestBody: {
|
|
40721
40904
|
content: {
|
|
@@ -40723,10 +40906,12 @@ declare const _default: {
|
|
|
40723
40906
|
schema: {
|
|
40724
40907
|
properties: {
|
|
40725
40908
|
device_id: {
|
|
40909
|
+
description: string;
|
|
40726
40910
|
format: string;
|
|
40727
40911
|
type: string;
|
|
40728
40912
|
};
|
|
40729
40913
|
name: {
|
|
40914
|
+
description: string;
|
|
40730
40915
|
type: string;
|
|
40731
40916
|
};
|
|
40732
40917
|
};
|
|
@@ -40789,10 +40974,12 @@ declare const _default: {
|
|
|
40789
40974
|
'x-fern-sdk-method-name': string;
|
|
40790
40975
|
'x-fern-sdk-return-value': string;
|
|
40791
40976
|
'x-response-key': string;
|
|
40977
|
+
'x-title': string;
|
|
40792
40978
|
};
|
|
40793
40979
|
};
|
|
40794
40980
|
'/devices/unmanaged/list': {
|
|
40795
40981
|
post: {
|
|
40982
|
+
description: string;
|
|
40796
40983
|
operationId: string;
|
|
40797
40984
|
requestBody: {
|
|
40798
40985
|
content: {
|
|
@@ -40906,6 +41093,7 @@ declare const _default: {
|
|
|
40906
41093
|
type: string;
|
|
40907
41094
|
};
|
|
40908
41095
|
unstable_location_id: {
|
|
41096
|
+
description: string;
|
|
40909
41097
|
format: string;
|
|
40910
41098
|
nullable: boolean;
|
|
40911
41099
|
type: string;
|
|
@@ -40970,10 +41158,12 @@ declare const _default: {
|
|
|
40970
41158
|
'x-fern-sdk-method-name': string;
|
|
40971
41159
|
'x-fern-sdk-return-value': string;
|
|
40972
41160
|
'x-response-key': string;
|
|
41161
|
+
'x-title': string;
|
|
40973
41162
|
};
|
|
40974
41163
|
};
|
|
40975
41164
|
'/devices/unmanaged/update': {
|
|
40976
41165
|
patch: {
|
|
41166
|
+
description: string;
|
|
40977
41167
|
operationId: string;
|
|
40978
41168
|
requestBody: {
|
|
40979
41169
|
content: {
|
|
@@ -40981,10 +41171,12 @@ declare const _default: {
|
|
|
40981
41171
|
schema: {
|
|
40982
41172
|
properties: {
|
|
40983
41173
|
device_id: {
|
|
41174
|
+
description: string;
|
|
40984
41175
|
format: string;
|
|
40985
41176
|
type: string;
|
|
40986
41177
|
};
|
|
40987
41178
|
is_managed: {
|
|
41179
|
+
description: string;
|
|
40988
41180
|
enum: boolean[];
|
|
40989
41181
|
type: string;
|
|
40990
41182
|
};
|
|
@@ -41036,8 +41228,10 @@ declare const _default: {
|
|
|
41036
41228
|
tags: string[];
|
|
41037
41229
|
'x-fern-ignore': boolean;
|
|
41038
41230
|
'x-response-key': null;
|
|
41231
|
+
'x-title': string;
|
|
41039
41232
|
};
|
|
41040
41233
|
post: {
|
|
41234
|
+
description: string;
|
|
41041
41235
|
operationId: string;
|
|
41042
41236
|
requestBody: {
|
|
41043
41237
|
content: {
|
|
@@ -41045,10 +41239,12 @@ declare const _default: {
|
|
|
41045
41239
|
schema: {
|
|
41046
41240
|
properties: {
|
|
41047
41241
|
device_id: {
|
|
41242
|
+
description: string;
|
|
41048
41243
|
format: string;
|
|
41049
41244
|
type: string;
|
|
41050
41245
|
};
|
|
41051
41246
|
is_managed: {
|
|
41247
|
+
description: string;
|
|
41052
41248
|
enum: boolean[];
|
|
41053
41249
|
type: string;
|
|
41054
41250
|
};
|
|
@@ -41101,10 +41297,12 @@ declare const _default: {
|
|
|
41101
41297
|
'x-fern-sdk-group-name': string[];
|
|
41102
41298
|
'x-fern-sdk-method-name': string;
|
|
41103
41299
|
'x-response-key': null;
|
|
41300
|
+
'x-title': string;
|
|
41104
41301
|
};
|
|
41105
41302
|
};
|
|
41106
41303
|
'/devices/update': {
|
|
41107
41304
|
patch: {
|
|
41305
|
+
description: string;
|
|
41108
41306
|
operationId: string;
|
|
41109
41307
|
requestBody: {
|
|
41110
41308
|
content: {
|
|
@@ -41122,23 +41320,28 @@ declare const _default: {
|
|
|
41122
41320
|
maxLength?: never;
|
|
41123
41321
|
})[];
|
|
41124
41322
|
};
|
|
41323
|
+
description: string;
|
|
41125
41324
|
type: string;
|
|
41126
41325
|
};
|
|
41127
41326
|
device_id: {
|
|
41327
|
+
description: string;
|
|
41128
41328
|
format: string;
|
|
41129
41329
|
type: string;
|
|
41130
41330
|
};
|
|
41131
41331
|
is_managed: {
|
|
41132
41332
|
default: boolean;
|
|
41333
|
+
description: string;
|
|
41133
41334
|
type: string;
|
|
41134
41335
|
};
|
|
41135
41336
|
name: {
|
|
41337
|
+
description: string;
|
|
41136
41338
|
nullable: boolean;
|
|
41137
41339
|
type: string;
|
|
41138
41340
|
};
|
|
41139
41341
|
properties: {
|
|
41140
41342
|
properties: {
|
|
41141
41343
|
name: {
|
|
41344
|
+
description: string;
|
|
41142
41345
|
nullable: boolean;
|
|
41143
41346
|
type: string;
|
|
41144
41347
|
};
|
|
@@ -41201,8 +41404,10 @@ declare const _default: {
|
|
|
41201
41404
|
tags: string[];
|
|
41202
41405
|
'x-fern-ignore': boolean;
|
|
41203
41406
|
'x-response-key': null;
|
|
41407
|
+
'x-title': string;
|
|
41204
41408
|
};
|
|
41205
41409
|
post: {
|
|
41410
|
+
description: string;
|
|
41206
41411
|
operationId: string;
|
|
41207
41412
|
requestBody: {
|
|
41208
41413
|
content: {
|
|
@@ -41220,23 +41425,28 @@ declare const _default: {
|
|
|
41220
41425
|
maxLength?: never;
|
|
41221
41426
|
})[];
|
|
41222
41427
|
};
|
|
41428
|
+
description: string;
|
|
41223
41429
|
type: string;
|
|
41224
41430
|
};
|
|
41225
41431
|
device_id: {
|
|
41432
|
+
description: string;
|
|
41226
41433
|
format: string;
|
|
41227
41434
|
type: string;
|
|
41228
41435
|
};
|
|
41229
41436
|
is_managed: {
|
|
41230
41437
|
default: boolean;
|
|
41438
|
+
description: string;
|
|
41231
41439
|
type: string;
|
|
41232
41440
|
};
|
|
41233
41441
|
name: {
|
|
41442
|
+
description: string;
|
|
41234
41443
|
nullable: boolean;
|
|
41235
41444
|
type: string;
|
|
41236
41445
|
};
|
|
41237
41446
|
properties: {
|
|
41238
41447
|
properties: {
|
|
41239
41448
|
name: {
|
|
41449
|
+
description: string;
|
|
41240
41450
|
nullable: boolean;
|
|
41241
41451
|
type: string;
|
|
41242
41452
|
};
|
|
@@ -41300,10 +41510,12 @@ declare const _default: {
|
|
|
41300
41510
|
'x-fern-sdk-group-name': string[];
|
|
41301
41511
|
'x-fern-sdk-method-name': string;
|
|
41302
41512
|
'x-response-key': null;
|
|
41513
|
+
'x-title': string;
|
|
41303
41514
|
};
|
|
41304
41515
|
};
|
|
41305
41516
|
'/events/get': {
|
|
41306
41517
|
post: {
|
|
41518
|
+
description: string;
|
|
41307
41519
|
operationId: string;
|
|
41308
41520
|
requestBody: {
|
|
41309
41521
|
content: {
|
|
@@ -41384,10 +41596,12 @@ declare const _default: {
|
|
|
41384
41596
|
'x-fern-sdk-method-name': string;
|
|
41385
41597
|
'x-fern-sdk-return-value': string;
|
|
41386
41598
|
'x-response-key': string;
|
|
41599
|
+
'x-title': string;
|
|
41387
41600
|
};
|
|
41388
41601
|
};
|
|
41389
41602
|
'/events/list': {
|
|
41390
41603
|
post: {
|
|
41604
|
+
description: string;
|
|
41391
41605
|
operationId: string;
|
|
41392
41606
|
requestBody: {
|
|
41393
41607
|
content: {
|
|
@@ -41549,6 +41763,7 @@ declare const _default: {
|
|
|
41549
41763
|
'x-fern-sdk-method-name': string;
|
|
41550
41764
|
'x-fern-sdk-return-value': string;
|
|
41551
41765
|
'x-response-key': string;
|
|
41766
|
+
'x-title': string;
|
|
41552
41767
|
};
|
|
41553
41768
|
};
|
|
41554
41769
|
'/locks/get': {
|
|
@@ -41733,6 +41948,7 @@ declare const _default: {
|
|
|
41733
41948
|
type: string;
|
|
41734
41949
|
};
|
|
41735
41950
|
unstable_location_id: {
|
|
41951
|
+
description: string;
|
|
41736
41952
|
format: string;
|
|
41737
41953
|
nullable: boolean;
|
|
41738
41954
|
type: string;
|
|
@@ -42346,6 +42562,7 @@ declare const _default: {
|
|
|
42346
42562
|
type: string;
|
|
42347
42563
|
};
|
|
42348
42564
|
unstable_location_id: {
|
|
42565
|
+
description: string;
|
|
42349
42566
|
format: string;
|
|
42350
42567
|
nullable: boolean;
|
|
42351
42568
|
type: string;
|
|
@@ -45837,6 +46054,7 @@ declare const _default: {
|
|
|
45837
46054
|
type: string;
|
|
45838
46055
|
};
|
|
45839
46056
|
unstable_location_id: {
|
|
46057
|
+
description: string;
|
|
45840
46058
|
format: string;
|
|
45841
46059
|
nullable: boolean;
|
|
45842
46060
|
type: string;
|
|
@@ -49691,6 +49909,168 @@ declare const _default: {
|
|
|
49691
49909
|
'x-undocumented': string;
|
|
49692
49910
|
};
|
|
49693
49911
|
};
|
|
49912
|
+
'/unstable_partner/resources/push': {
|
|
49913
|
+
post: {
|
|
49914
|
+
description: string;
|
|
49915
|
+
operationId: string;
|
|
49916
|
+
requestBody: {
|
|
49917
|
+
content: {
|
|
49918
|
+
'application/json': {
|
|
49919
|
+
schema: {
|
|
49920
|
+
oneOf: ({
|
|
49921
|
+
items: {
|
|
49922
|
+
properties: {
|
|
49923
|
+
custom_metadata: {
|
|
49924
|
+
additionalProperties: {
|
|
49925
|
+
type: string;
|
|
49926
|
+
};
|
|
49927
|
+
type: string;
|
|
49928
|
+
};
|
|
49929
|
+
customer_key: {
|
|
49930
|
+
type: string;
|
|
49931
|
+
};
|
|
49932
|
+
description: {
|
|
49933
|
+
type: string;
|
|
49934
|
+
};
|
|
49935
|
+
email_address: {
|
|
49936
|
+
type: string;
|
|
49937
|
+
};
|
|
49938
|
+
ends_at: {
|
|
49939
|
+
type: string;
|
|
49940
|
+
};
|
|
49941
|
+
icon_url: {
|
|
49942
|
+
type: string;
|
|
49943
|
+
};
|
|
49944
|
+
location_keys: {
|
|
49945
|
+
items: {
|
|
49946
|
+
type: string;
|
|
49947
|
+
};
|
|
49948
|
+
type: string;
|
|
49949
|
+
};
|
|
49950
|
+
name: {
|
|
49951
|
+
type: string;
|
|
49952
|
+
};
|
|
49953
|
+
partner_resource_key: {
|
|
49954
|
+
type: string;
|
|
49955
|
+
};
|
|
49956
|
+
partner_resource_type: {
|
|
49957
|
+
type: string;
|
|
49958
|
+
};
|
|
49959
|
+
phone_number: {
|
|
49960
|
+
type: string;
|
|
49961
|
+
};
|
|
49962
|
+
starts_at: {
|
|
49963
|
+
type: string;
|
|
49964
|
+
};
|
|
49965
|
+
user_identity_key: {
|
|
49966
|
+
type: string;
|
|
49967
|
+
};
|
|
49968
|
+
};
|
|
49969
|
+
type: string;
|
|
49970
|
+
};
|
|
49971
|
+
type: string;
|
|
49972
|
+
properties?: never;
|
|
49973
|
+
} | {
|
|
49974
|
+
properties: {
|
|
49975
|
+
custom_metadata: {
|
|
49976
|
+
additionalProperties: {
|
|
49977
|
+
type: string;
|
|
49978
|
+
};
|
|
49979
|
+
type: string;
|
|
49980
|
+
};
|
|
49981
|
+
customer_key: {
|
|
49982
|
+
type: string;
|
|
49983
|
+
};
|
|
49984
|
+
description: {
|
|
49985
|
+
type: string;
|
|
49986
|
+
};
|
|
49987
|
+
email_address: {
|
|
49988
|
+
type: string;
|
|
49989
|
+
};
|
|
49990
|
+
ends_at: {
|
|
49991
|
+
type: string;
|
|
49992
|
+
};
|
|
49993
|
+
icon_url: {
|
|
49994
|
+
type: string;
|
|
49995
|
+
};
|
|
49996
|
+
location_keys: {
|
|
49997
|
+
items: {
|
|
49998
|
+
type: string;
|
|
49999
|
+
};
|
|
50000
|
+
type: string;
|
|
50001
|
+
};
|
|
50002
|
+
name: {
|
|
50003
|
+
type: string;
|
|
50004
|
+
};
|
|
50005
|
+
partner_resource_key: {
|
|
50006
|
+
type: string;
|
|
50007
|
+
};
|
|
50008
|
+
partner_resource_type: {
|
|
50009
|
+
type: string;
|
|
50010
|
+
};
|
|
50011
|
+
phone_number: {
|
|
50012
|
+
type: string;
|
|
50013
|
+
};
|
|
50014
|
+
starts_at: {
|
|
50015
|
+
type: string;
|
|
50016
|
+
};
|
|
50017
|
+
user_identity_key: {
|
|
50018
|
+
type: string;
|
|
50019
|
+
};
|
|
50020
|
+
};
|
|
50021
|
+
type: string;
|
|
50022
|
+
items?: never;
|
|
50023
|
+
})[];
|
|
50024
|
+
};
|
|
50025
|
+
};
|
|
50026
|
+
};
|
|
50027
|
+
};
|
|
50028
|
+
responses: {
|
|
50029
|
+
200: {
|
|
50030
|
+
content: {
|
|
50031
|
+
'application/json': {
|
|
50032
|
+
schema: {
|
|
50033
|
+
properties: {
|
|
50034
|
+
ok: {
|
|
50035
|
+
type: string;
|
|
50036
|
+
};
|
|
50037
|
+
};
|
|
50038
|
+
required: string[];
|
|
50039
|
+
type: string;
|
|
50040
|
+
};
|
|
50041
|
+
};
|
|
50042
|
+
};
|
|
50043
|
+
description: string;
|
|
50044
|
+
};
|
|
50045
|
+
400: {
|
|
50046
|
+
description: string;
|
|
50047
|
+
};
|
|
50048
|
+
401: {
|
|
50049
|
+
description: string;
|
|
50050
|
+
};
|
|
50051
|
+
};
|
|
50052
|
+
security: ({
|
|
50053
|
+
pat_with_workspace: never[];
|
|
50054
|
+
console_session_with_workspace?: never;
|
|
50055
|
+
api_key?: never;
|
|
50056
|
+
} | {
|
|
50057
|
+
console_session_with_workspace: never[];
|
|
50058
|
+
pat_with_workspace?: never;
|
|
50059
|
+
api_key?: never;
|
|
50060
|
+
} | {
|
|
50061
|
+
api_key: never[];
|
|
50062
|
+
pat_with_workspace?: never;
|
|
50063
|
+
console_session_with_workspace?: never;
|
|
50064
|
+
})[];
|
|
50065
|
+
summary: string;
|
|
50066
|
+
tags: never[];
|
|
50067
|
+
'x-fern-sdk-group-name': string[];
|
|
50068
|
+
'x-fern-sdk-method-name': string;
|
|
50069
|
+
'x-response-key': null;
|
|
50070
|
+
'x-title': string;
|
|
50071
|
+
'x-undocumented': string;
|
|
50072
|
+
};
|
|
50073
|
+
};
|
|
49694
50074
|
'/user_identities/add_acs_user': {
|
|
49695
50075
|
post: {
|
|
49696
50076
|
description: string;
|
|
@@ -52097,6 +52477,7 @@ declare const _default: {
|
|
|
52097
52477
|
};
|
|
52098
52478
|
'/workspaces/reset_sandbox': {
|
|
52099
52479
|
post: {
|
|
52480
|
+
description: string;
|
|
52100
52481
|
operationId: string;
|
|
52101
52482
|
responses: {
|
|
52102
52483
|
200: {
|
|
@@ -52312,9 +52693,15 @@ interface Routes {
|
|
|
52312
52693
|
method: 'POST';
|
|
52313
52694
|
queryParams: {};
|
|
52314
52695
|
jsonBody: {
|
|
52315
|
-
/** ID of the device for which to create the new access code. */
|
|
52696
|
+
/** ID of the device for which you want to create the new access code. */
|
|
52316
52697
|
device_id: string;
|
|
52317
|
-
/** Name of the new access code.
|
|
52698
|
+
/** Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.
|
|
52699
|
+
|
|
52700
|
+
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`.
|
|
52701
|
+
|
|
52702
|
+
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.
|
|
52703
|
+
|
|
52704
|
+
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). */
|
|
52318
52705
|
name?: string | undefined;
|
|
52319
52706
|
/** 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. */
|
|
52320
52707
|
starts_at?: string | undefined;
|
|
@@ -53455,7 +53842,7 @@ interface Routes {
|
|
|
53455
53842
|
|
|
53456
53843
|
An access code is a code used for a keypad or pinpad device. Unlike physical keys, which can easily be lost or duplicated, PIN codes can be customized, tracked, and altered on the fly. Using the Seam Access Code API, you can easily generate access codes on the hundreds of door lock models with which we integrate.
|
|
53457
53844
|
|
|
53458
|
-
Seam supports programming two types of access codes: [ongoing](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#ongoing-access-codes) and [time-bound](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#time-bound-access-codes). To differentiate between the two, refer to the `type` property of the access code. Ongoing codes display as `ongoing`, whereas time-bound codes are labeled `time_bound`.
|
|
53845
|
+
Seam supports programming two types of access codes: [ongoing](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#ongoing-access-codes) and [time-bound](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#time-bound-access-codes). To differentiate between the two, refer to the `type` property of the access code. Ongoing codes display as `ongoing`, whereas time-bound codes are labeled `time_bound`. An ongoing access code is active, until it has been removed from the device. To specify an ongoing access code, leave both `starts_at` and `ends_at` empty. A time-bound access code will be programmed at the `starts_at` time and removed at the `ends_at` time.
|
|
53459
53846
|
|
|
53460
53847
|
In addition, for certain devices, Seam also supports [offline access codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#offline-access-codes). Offline access (PIN) codes are designed for door locks that might not always maintain an internet connection. For this type of access code, the device manufacturer uses encryption keys (tokens) to create server-based registries of algorithmically-generated offline PIN codes. Because the tokens remain synchronized with the managed devices, the locks do not require an active internet connection—and you do not need to be near the locks—to create an offline access code. Then, owners or managers can share these offline codes with users through a variety of mechanisms, such as messaging applications. That is, lock users do not need to install a smartphone application to receive an offline access code. */
|
|
53461
53848
|
access_code: {
|
|
@@ -53471,7 +53858,13 @@ interface Routes {
|
|
|
53471
53858
|
access_code_id: string;
|
|
53472
53859
|
/** Unique identifier for the device associated with the access code. */
|
|
53473
53860
|
device_id: string;
|
|
53474
|
-
/** Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.
|
|
53861
|
+
/** Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.
|
|
53862
|
+
|
|
53863
|
+
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`.
|
|
53864
|
+
|
|
53865
|
+
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.
|
|
53866
|
+
|
|
53867
|
+
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). */
|
|
53475
53868
|
name: string | null;
|
|
53476
53869
|
/** Code used for access. Typically, a numeric or alphanumeric string. */
|
|
53477
53870
|
code: string | null;
|
|
@@ -53914,13 +54307,19 @@ interface Routes {
|
|
|
53914
54307
|
method: 'POST' | 'PUT';
|
|
53915
54308
|
queryParams: {};
|
|
53916
54309
|
jsonBody: {
|
|
53917
|
-
/** IDs of the devices for which to create the new access codes. */
|
|
54310
|
+
/** IDs of the devices for which you want to create the new access codes. */
|
|
53918
54311
|
device_ids: string[];
|
|
53919
54312
|
/** Desired behavior if any device cannot share a code. If `throw` (default), no access codes will be created if any device cannot share a code. If `create_random_code`, a random code will be created on devices that cannot share a code. */
|
|
53920
54313
|
behavior_when_code_cannot_be_shared?: 'throw' | 'create_random_code';
|
|
53921
54314
|
/** 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. */
|
|
53922
54315
|
preferred_code_length?: number | undefined;
|
|
53923
|
-
/** Name of the new access code.
|
|
54316
|
+
/** Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.
|
|
54317
|
+
|
|
54318
|
+
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`.
|
|
54319
|
+
|
|
54320
|
+
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.
|
|
54321
|
+
|
|
54322
|
+
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). */
|
|
53924
54323
|
name?: string | undefined;
|
|
53925
54324
|
/** 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. */
|
|
53926
54325
|
starts_at?: string | undefined;
|
|
@@ -53961,7 +54360,13 @@ interface Routes {
|
|
|
53961
54360
|
access_code_id: string;
|
|
53962
54361
|
/** Unique identifier for the device associated with the access code. */
|
|
53963
54362
|
device_id: string;
|
|
53964
|
-
/** Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.
|
|
54363
|
+
/** Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.
|
|
54364
|
+
|
|
54365
|
+
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`.
|
|
54366
|
+
|
|
54367
|
+
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.
|
|
54368
|
+
|
|
54369
|
+
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). */
|
|
53965
54370
|
name: string | null;
|
|
53966
54371
|
/** Code used for access. Typically, a numeric or alphanumeric string. */
|
|
53967
54372
|
code: string | null;
|
|
@@ -54405,9 +54810,9 @@ interface Routes {
|
|
|
54405
54810
|
queryParams: {};
|
|
54406
54811
|
jsonBody: {};
|
|
54407
54812
|
commonParams: {
|
|
54408
|
-
/** ID of the device for which to delete the access code. */
|
|
54813
|
+
/** ID of the device for which you want to delete the access code. */
|
|
54409
54814
|
device_id?: string | undefined;
|
|
54410
|
-
/** ID of the access code to delete. */
|
|
54815
|
+
/** ID of the access code that you want to delete. */
|
|
54411
54816
|
access_code_id: string;
|
|
54412
54817
|
/** */
|
|
54413
54818
|
sync?: boolean;
|
|
@@ -55525,6 +55930,7 @@ interface Routes {
|
|
|
55525
55930
|
queryParams: {};
|
|
55526
55931
|
jsonBody: {};
|
|
55527
55932
|
commonParams: {
|
|
55933
|
+
/** ID of the device for which you want to generate a code. */
|
|
55528
55934
|
device_id: string;
|
|
55529
55935
|
};
|
|
55530
55936
|
formData: {};
|
|
@@ -55554,7 +55960,7 @@ interface Routes {
|
|
|
55554
55960
|
|
|
55555
55961
|
An access code is a code used for a keypad or pinpad device. Unlike physical keys, which can easily be lost or duplicated, PIN codes can be customized, tracked, and altered on the fly. Using the Seam Access Code API, you can easily generate access codes on the hundreds of door lock models with which we integrate.
|
|
55556
55962
|
|
|
55557
|
-
Seam supports programming two types of access codes: [ongoing](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#ongoing-access-codes) and [time-bound](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#time-bound-access-codes). To differentiate between the two, refer to the `type` property of the access code. Ongoing codes display as `ongoing`, whereas time-bound codes are labeled `time_bound`.
|
|
55963
|
+
Seam supports programming two types of access codes: [ongoing](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#ongoing-access-codes) and [time-bound](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#time-bound-access-codes). To differentiate between the two, refer to the `type` property of the access code. Ongoing codes display as `ongoing`, whereas time-bound codes are labeled `time_bound`. An ongoing access code is active, until it has been removed from the device. To specify an ongoing access code, leave both `starts_at` and `ends_at` empty. A time-bound access code will be programmed at the `starts_at` time and removed at the `ends_at` time.
|
|
55558
55964
|
|
|
55559
55965
|
In addition, for certain devices, Seam also supports [offline access codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#offline-access-codes). Offline access (PIN) codes are designed for door locks that might not always maintain an internet connection. For this type of access code, the device manufacturer uses encryption keys (tokens) to create server-based registries of algorithmically-generated offline PIN codes. Because the tokens remain synchronized with the managed devices, the locks do not require an active internet connection—and you do not need to be near the locks—to create an offline access code. Then, owners or managers can share these offline codes with users through a variety of mechanisms, such as messaging applications. That is, lock users do not need to install a smartphone application to receive an offline access code. */
|
|
55560
55966
|
access_code: {
|
|
@@ -55570,7 +55976,13 @@ interface Routes {
|
|
|
55570
55976
|
access_code_id: string;
|
|
55571
55977
|
/** Unique identifier for the device associated with the access code. */
|
|
55572
55978
|
device_id: string;
|
|
55573
|
-
/** Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.
|
|
55979
|
+
/** Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.
|
|
55980
|
+
|
|
55981
|
+
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`.
|
|
55982
|
+
|
|
55983
|
+
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.
|
|
55984
|
+
|
|
55985
|
+
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). */
|
|
55574
55986
|
name: string | null;
|
|
55575
55987
|
/** Code used for access. Typically, a numeric or alphanumeric string. */
|
|
55576
55988
|
code: string | null;
|
|
@@ -56040,7 +56452,13 @@ interface Routes {
|
|
|
56040
56452
|
access_code_id: string;
|
|
56041
56453
|
/** Unique identifier for the device associated with the access code. */
|
|
56042
56454
|
device_id: string;
|
|
56043
|
-
/** Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.
|
|
56455
|
+
/** Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.
|
|
56456
|
+
|
|
56457
|
+
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`.
|
|
56458
|
+
|
|
56459
|
+
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.
|
|
56460
|
+
|
|
56461
|
+
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). */
|
|
56044
56462
|
name: string | null;
|
|
56045
56463
|
/** Code used for access. Typically, a numeric or alphanumeric string. */
|
|
56046
56464
|
code: string | null;
|
|
@@ -56502,7 +56920,7 @@ interface Routes {
|
|
|
56502
56920
|
|
|
56503
56921
|
An access code is a code used for a keypad or pinpad device. Unlike physical keys, which can easily be lost or duplicated, PIN codes can be customized, tracked, and altered on the fly. Using the Seam Access Code API, you can easily generate access codes on the hundreds of door lock models with which we integrate.
|
|
56504
56922
|
|
|
56505
|
-
Seam supports programming two types of access codes: [ongoing](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#ongoing-access-codes) and [time-bound](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#time-bound-access-codes). To differentiate between the two, refer to the `type` property of the access code. Ongoing codes display as `ongoing`, whereas time-bound codes are labeled `time_bound`.
|
|
56923
|
+
Seam supports programming two types of access codes: [ongoing](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#ongoing-access-codes) and [time-bound](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#time-bound-access-codes). To differentiate between the two, refer to the `type` property of the access code. Ongoing codes display as `ongoing`, whereas time-bound codes are labeled `time_bound`. An ongoing access code is active, until it has been removed from the device. To specify an ongoing access code, leave both `starts_at` and `ends_at` empty. A time-bound access code will be programmed at the `starts_at` time and removed at the `ends_at` time.
|
|
56506
56924
|
|
|
56507
56925
|
In addition, for certain devices, Seam also supports [offline access codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#offline-access-codes). Offline access (PIN) codes are designed for door locks that might not always maintain an internet connection. For this type of access code, the device manufacturer uses encryption keys (tokens) to create server-based registries of algorithmically-generated offline PIN codes. Because the tokens remain synchronized with the managed devices, the locks do not require an active internet connection—and you do not need to be near the locks—to create an offline access code. Then, owners or managers can share these offline codes with users through a variety of mechanisms, such as messaging applications. That is, lock users do not need to install a smartphone application to receive an offline access code. */
|
|
56508
56926
|
backup_access_code: {
|
|
@@ -56518,7 +56936,13 @@ interface Routes {
|
|
|
56518
56936
|
access_code_id: string;
|
|
56519
56937
|
/** Unique identifier for the device associated with the access code. */
|
|
56520
56938
|
device_id: string;
|
|
56521
|
-
/** Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.
|
|
56939
|
+
/** Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.
|
|
56940
|
+
|
|
56941
|
+
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`.
|
|
56942
|
+
|
|
56943
|
+
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.
|
|
56944
|
+
|
|
56945
|
+
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). */
|
|
56522
56946
|
name: string | null;
|
|
56523
56947
|
/** Code used for access. Typically, a numeric or alphanumeric string. */
|
|
56524
56948
|
code: string | null;
|
|
@@ -56958,7 +57382,7 @@ interface Routes {
|
|
|
56958
57382
|
|
|
56959
57383
|
An access code is a code used for a keypad or pinpad device. Unlike physical keys, which can easily be lost or duplicated, PIN codes can be customized, tracked, and altered on the fly. Using the Seam Access Code API, you can easily generate access codes on the hundreds of door lock models with which we integrate.
|
|
56960
57384
|
|
|
56961
|
-
Seam supports programming two types of access codes: [ongoing](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#ongoing-access-codes) and [time-bound](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#time-bound-access-codes). To differentiate between the two, refer to the `type` property of the access code. Ongoing codes display as `ongoing`, whereas time-bound codes are labeled `time_bound`.
|
|
57385
|
+
Seam supports programming two types of access codes: [ongoing](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#ongoing-access-codes) and [time-bound](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#time-bound-access-codes). To differentiate between the two, refer to the `type` property of the access code. Ongoing codes display as `ongoing`, whereas time-bound codes are labeled `time_bound`. An ongoing access code is active, until it has been removed from the device. To specify an ongoing access code, leave both `starts_at` and `ends_at` empty. A time-bound access code will be programmed at the `starts_at` time and removed at the `ends_at` time.
|
|
56962
57386
|
|
|
56963
57387
|
In addition, for certain devices, Seam also supports [offline access codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#offline-access-codes). Offline access (PIN) codes are designed for door locks that might not always maintain an internet connection. For this type of access code, the device manufacturer uses encryption keys (tokens) to create server-based registries of algorithmically-generated offline PIN codes. Because the tokens remain synchronized with the managed devices, the locks do not require an active internet connection—and you do not need to be near the locks—to create an offline access code. Then, owners or managers can share these offline codes with users through a variety of mechanisms, such as messaging applications. That is, lock users do not need to install a smartphone application to receive an offline access code. */
|
|
56964
57388
|
access_code: {
|
|
@@ -56974,7 +57398,13 @@ interface Routes {
|
|
|
56974
57398
|
access_code_id: string;
|
|
56975
57399
|
/** Unique identifier for the device associated with the access code. */
|
|
56976
57400
|
device_id: string;
|
|
56977
|
-
/** Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.
|
|
57401
|
+
/** Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.
|
|
57402
|
+
|
|
57403
|
+
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`.
|
|
57404
|
+
|
|
57405
|
+
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.
|
|
57406
|
+
|
|
57407
|
+
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). */
|
|
56978
57408
|
name: string | null;
|
|
56979
57409
|
/** Code used for access. Typically, a numeric or alphanumeric string. */
|
|
56980
57410
|
code: string | null;
|
|
@@ -57417,7 +57847,7 @@ interface Routes {
|
|
|
57417
57847
|
method: 'POST';
|
|
57418
57848
|
queryParams: {};
|
|
57419
57849
|
jsonBody: {
|
|
57420
|
-
/** ID of the device for which to report constraints. */
|
|
57850
|
+
/** ID of the device for which you want to report constraints. */
|
|
57421
57851
|
device_id: string;
|
|
57422
57852
|
/** Array of supported code lengths as integers between 4 and 20, inclusive. You can specify either `supported_code_lengths` or `min_code_length`/`max_code_length`. */
|
|
57423
57853
|
supported_code_lengths?: number[] | undefined;
|
|
@@ -57451,7 +57881,11 @@ interface Routes {
|
|
|
57451
57881
|
|
|
57452
57882
|
When you create an access code on a device in Seam, it is created as a managed access code. Access codes that exist on a device that were not created through Seam are considered unmanaged codes. We strictly limit the operations that can be performed on unmanaged codes.
|
|
57453
57883
|
|
|
57454
|
-
Prior to using Seam to manage your devices, you may have used another lock management system to manage the access codes on your devices. Where possible, we help you keep any existing access codes on devices and transition those codes to ones managed by your Seam workspace.
|
|
57884
|
+
Prior to using Seam to manage your devices, you may have used another lock management system to manage the access codes on your devices. Where possible, we help you keep any existing access codes on devices and transition those codes to ones managed by your Seam workspace.
|
|
57885
|
+
|
|
57886
|
+
Not all providers support unmanaged access codes. The following providers do not support unmanaged access codes:
|
|
57887
|
+
|
|
57888
|
+
- [Kwikset](https://docs.seam.co/latest/device-and-system-integration-guides/kwikset-locks) */
|
|
57455
57889
|
access_code: {
|
|
57456
57890
|
/** Nature of the access code. Values are `ongoing` for access codes that are active continuously until deactivated manually or `time_bound` for access codes that have a specific duration. */
|
|
57457
57891
|
type: 'time_bound' | 'ongoing';
|
|
@@ -57459,7 +57893,13 @@ interface Routes {
|
|
|
57459
57893
|
access_code_id: string;
|
|
57460
57894
|
/** Unique identifier for the device associated with the access code. */
|
|
57461
57895
|
device_id: string;
|
|
57462
|
-
/** Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.
|
|
57896
|
+
/** Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.
|
|
57897
|
+
|
|
57898
|
+
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`.
|
|
57899
|
+
|
|
57900
|
+
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.
|
|
57901
|
+
|
|
57902
|
+
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). */
|
|
57463
57903
|
name: string | null;
|
|
57464
57904
|
/** Code used for access. Typically, a numeric or alphanumeric string. */
|
|
57465
57905
|
code: string | null;
|
|
@@ -57893,9 +58333,9 @@ interface Routes {
|
|
|
57893
58333
|
commonParams: {
|
|
57894
58334
|
/** ID of the unmanaged access code that you want to convert to a managed access code. */
|
|
57895
58335
|
access_code_id: string;
|
|
57896
|
-
/** Indicates whether external modification of the access code is allowed. */
|
|
58336
|
+
/** Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the access code is allowed. */
|
|
57897
58337
|
is_external_modification_allowed?: boolean | undefined;
|
|
57898
|
-
/** Indicates whether external modification of the access code is allowed. */
|
|
58338
|
+
/** Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the access code is allowed. */
|
|
57899
58339
|
allow_external_modification?: boolean | undefined;
|
|
57900
58340
|
/** Indicates whether to force the access code conversion. To switch management of an access code from one Seam workspace to another, set `force` to `true`. */
|
|
57901
58341
|
force?: boolean | undefined;
|
|
@@ -57911,7 +58351,7 @@ interface Routes {
|
|
|
57911
58351
|
queryParams: {};
|
|
57912
58352
|
jsonBody: {};
|
|
57913
58353
|
commonParams: {
|
|
57914
|
-
/** ID of the unmanaged access code to delete. */
|
|
58354
|
+
/** ID of the unmanaged access code that you want to delete. */
|
|
57915
58355
|
access_code_id: string;
|
|
57916
58356
|
/** */
|
|
57917
58357
|
sync?: boolean;
|
|
@@ -59044,7 +59484,11 @@ interface Routes {
|
|
|
59044
59484
|
|
|
59045
59485
|
When you create an access code on a device in Seam, it is created as a managed access code. Access codes that exist on a device that were not created through Seam are considered unmanaged codes. We strictly limit the operations that can be performed on unmanaged codes.
|
|
59046
59486
|
|
|
59047
|
-
Prior to using Seam to manage your devices, you may have used another lock management system to manage the access codes on your devices. Where possible, we help you keep any existing access codes on devices and transition those codes to ones managed by your Seam workspace.
|
|
59487
|
+
Prior to using Seam to manage your devices, you may have used another lock management system to manage the access codes on your devices. Where possible, we help you keep any existing access codes on devices and transition those codes to ones managed by your Seam workspace.
|
|
59488
|
+
|
|
59489
|
+
Not all providers support unmanaged access codes. The following providers do not support unmanaged access codes:
|
|
59490
|
+
|
|
59491
|
+
- [Kwikset](https://docs.seam.co/latest/device-and-system-integration-guides/kwikset-locks) */
|
|
59048
59492
|
access_code: {
|
|
59049
59493
|
/** Nature of the access code. Values are `ongoing` for access codes that are active continuously until deactivated manually or `time_bound` for access codes that have a specific duration. */
|
|
59050
59494
|
type: 'time_bound' | 'ongoing';
|
|
@@ -59052,7 +59496,13 @@ interface Routes {
|
|
|
59052
59496
|
access_code_id: string;
|
|
59053
59497
|
/** Unique identifier for the device associated with the access code. */
|
|
59054
59498
|
device_id: string;
|
|
59055
|
-
/** Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.
|
|
59499
|
+
/** Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.
|
|
59500
|
+
|
|
59501
|
+
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`.
|
|
59502
|
+
|
|
59503
|
+
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.
|
|
59504
|
+
|
|
59505
|
+
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). */
|
|
59056
59506
|
name: string | null;
|
|
59057
59507
|
/** Code used for access. Typically, a numeric or alphanumeric string. */
|
|
59058
59508
|
code: string | null;
|
|
@@ -59498,7 +59948,13 @@ interface Routes {
|
|
|
59498
59948
|
access_code_id: string;
|
|
59499
59949
|
/** Unique identifier for the device associated with the access code. */
|
|
59500
59950
|
device_id: string;
|
|
59501
|
-
/** Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.
|
|
59951
|
+
/** Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.
|
|
59952
|
+
|
|
59953
|
+
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`.
|
|
59954
|
+
|
|
59955
|
+
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.
|
|
59956
|
+
|
|
59957
|
+
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). */
|
|
59502
59958
|
name: string | null;
|
|
59503
59959
|
/** Code used for access. Typically, a numeric or alphanumeric string. */
|
|
59504
59960
|
code: string | null;
|
|
@@ -59948,7 +60404,13 @@ interface Routes {
|
|
|
59948
60404
|
method: 'POST' | 'PATCH' | 'PUT';
|
|
59949
60405
|
queryParams: {};
|
|
59950
60406
|
jsonBody: {
|
|
59951
|
-
/** Name of the new access code.
|
|
60407
|
+
/** Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.
|
|
60408
|
+
|
|
60409
|
+
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`.
|
|
60410
|
+
|
|
60411
|
+
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.
|
|
60412
|
+
|
|
60413
|
+
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). */
|
|
59952
60414
|
name?: string | undefined;
|
|
59953
60415
|
/** 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. */
|
|
59954
60416
|
starts_at?: string | undefined;
|
|
@@ -61102,7 +61564,13 @@ interface Routes {
|
|
|
61102
61564
|
ends_at?: string | undefined;
|
|
61103
61565
|
/** 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. */
|
|
61104
61566
|
starts_at?: string | undefined;
|
|
61105
|
-
/** Name of the new access code.
|
|
61567
|
+
/** Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.
|
|
61568
|
+
|
|
61569
|
+
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`.
|
|
61570
|
+
|
|
61571
|
+
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.
|
|
61572
|
+
|
|
61573
|
+
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). */
|
|
61106
61574
|
name?: string | undefined;
|
|
61107
61575
|
/** Key that links the group of access codes, assigned on creation by `/access_codes/create_multiple`. */
|
|
61108
61576
|
common_code_key: string;
|
|
@@ -61117,10 +61585,12 @@ interface Routes {
|
|
|
61117
61585
|
queryParams: {};
|
|
61118
61586
|
jsonBody: {};
|
|
61119
61587
|
commonParams: {
|
|
61120
|
-
/** ID of the
|
|
61588
|
+
/** ID of the access group to which you want to add an access system user. */
|
|
61121
61589
|
acs_access_group_id: string;
|
|
61122
|
-
/** ID of the
|
|
61123
|
-
acs_user_id
|
|
61590
|
+
/** ID of the access system user that you want to add to an access group. You can only provide one of acs_user_id or user_identity_id. */
|
|
61591
|
+
acs_user_id?: string | undefined;
|
|
61592
|
+
/** ID of the desired user identity that you want to add to an access group. You can only provide one of acs_user_id or user_identity_id. If the ACS system contains an ACS user with the same `email_address` or `phone_number` as the user identity that you specify, they are linked, and the access group membership belongs to the ACS user. If the ACS system does not have a corresponding ACS user, one is created. */
|
|
61593
|
+
user_identity_id?: string | undefined;
|
|
61124
61594
|
};
|
|
61125
61595
|
formData: {};
|
|
61126
61596
|
jsonResponse: {};
|
|
@@ -61131,7 +61601,7 @@ interface Routes {
|
|
|
61131
61601
|
queryParams: {};
|
|
61132
61602
|
jsonBody: {};
|
|
61133
61603
|
commonParams: {
|
|
61134
|
-
/** ID of the
|
|
61604
|
+
/** ID of the access group that you want to get. */
|
|
61135
61605
|
acs_access_group_id: string;
|
|
61136
61606
|
};
|
|
61137
61607
|
formData: {};
|
|
@@ -61182,9 +61652,9 @@ interface Routes {
|
|
|
61182
61652
|
queryParams: {};
|
|
61183
61653
|
jsonBody: {};
|
|
61184
61654
|
commonParams: {
|
|
61185
|
-
/** ID of the access
|
|
61655
|
+
/** ID of the access system for which you want to retrieve all access groups. */
|
|
61186
61656
|
acs_system_id?: string | undefined;
|
|
61187
|
-
/** ID of the user for which you want to retrieve all access groups. */
|
|
61657
|
+
/** ID of the access system user for which you want to retrieve all access groups. */
|
|
61188
61658
|
acs_user_id?: string | undefined;
|
|
61189
61659
|
/** ID of the user identity for which you want to retrieve all access groups. */
|
|
61190
61660
|
user_identity_id?: string | undefined;
|
|
@@ -61307,7 +61777,7 @@ interface Routes {
|
|
|
61307
61777
|
queryParams: {};
|
|
61308
61778
|
jsonBody: {};
|
|
61309
61779
|
commonParams: {
|
|
61310
|
-
/** ID of the access group for which you want to retrieve all users. */
|
|
61780
|
+
/** ID of the access group for which you want to retrieve all access system users. */
|
|
61311
61781
|
acs_access_group_id: string;
|
|
61312
61782
|
};
|
|
61313
61783
|
formData: {};
|
|
@@ -61502,11 +61972,11 @@ interface Routes {
|
|
|
61502
61972
|
queryParams: {};
|
|
61503
61973
|
jsonBody: {};
|
|
61504
61974
|
commonParams: {
|
|
61505
|
-
/** ID of the
|
|
61975
|
+
/** ID of the access group from which you want to remove an access system user. */
|
|
61506
61976
|
acs_access_group_id: string;
|
|
61507
|
-
/** ID of the
|
|
61977
|
+
/** ID of the access system user that you want to remove from an access group. */
|
|
61508
61978
|
acs_user_id?: string | undefined;
|
|
61509
|
-
/** ID of the
|
|
61979
|
+
/** ID of the user identity associated with the user that you want to remove from an access group. */
|
|
61510
61980
|
user_identity_id?: string | undefined;
|
|
61511
61981
|
};
|
|
61512
61982
|
formData: {};
|
|
@@ -61518,7 +61988,7 @@ interface Routes {
|
|
|
61518
61988
|
queryParams: {};
|
|
61519
61989
|
jsonBody: {};
|
|
61520
61990
|
commonParams: {
|
|
61521
|
-
/** ID of the
|
|
61991
|
+
/** ID of the unmanaged access group that you want to get. */
|
|
61522
61992
|
acs_access_group_id: string;
|
|
61523
61993
|
};
|
|
61524
61994
|
formData: {};
|
|
@@ -61565,9 +62035,9 @@ interface Routes {
|
|
|
61565
62035
|
queryParams: {};
|
|
61566
62036
|
jsonBody: {};
|
|
61567
62037
|
commonParams: {
|
|
61568
|
-
/** ID of the access
|
|
62038
|
+
/** ID of the access system for which you want to retrieve all unmanaged access groups. */
|
|
61569
62039
|
acs_system_id?: string | undefined;
|
|
61570
|
-
/** ID of the user for which you want to retrieve all unmanaged access groups. */
|
|
62040
|
+
/** ID of the access system user for which you want to retrieve all unmanaged access groups. */
|
|
61571
62041
|
acs_user_id?: string | undefined;
|
|
61572
62042
|
};
|
|
61573
62043
|
formData: {};
|
|
@@ -61613,6 +62083,7 @@ interface Routes {
|
|
|
61613
62083
|
queryParams: {};
|
|
61614
62084
|
jsonBody: {};
|
|
61615
62085
|
commonParams: {
|
|
62086
|
+
/** ID of the access system for which you want to list credential pools. */
|
|
61616
62087
|
acs_system_id: string;
|
|
61617
62088
|
};
|
|
61618
62089
|
formData: {};
|
|
@@ -61634,10 +62105,15 @@ interface Routes {
|
|
|
61634
62105
|
queryParams: {};
|
|
61635
62106
|
jsonBody: {};
|
|
61636
62107
|
commonParams: {
|
|
62108
|
+
/** ID of the user identity for which you want to launch a credential provisioning automation. */
|
|
61637
62109
|
user_identity_id: string;
|
|
62110
|
+
/** Access system ID of the credential manager for which you want to launch a credential provisioning automation. */
|
|
61638
62111
|
credential_manager_acs_system_id: string;
|
|
62112
|
+
/** ID of the credential pool for which you want to launch a credential provisioning automation. */
|
|
61639
62113
|
acs_credential_pool_id?: string | undefined;
|
|
62114
|
+
/** Indicates whether to create an associated credential manager user. If you set `create_credential_manager_user` to `true`, you cannot specify a `credential_manager_acs_user_id`. */
|
|
61640
62115
|
create_credential_manager_user?: boolean | undefined;
|
|
62116
|
+
/** ID of the associated access system user within the credential manager. If you specify a `credential_manager_acs_user_id`, you cannot set `create_credential_manager_user` to `true`. */
|
|
61641
62117
|
credential_manager_acs_user_id?: string | undefined;
|
|
61642
62118
|
};
|
|
61643
62119
|
formData: {};
|
|
@@ -61657,9 +62133,9 @@ interface Routes {
|
|
|
61657
62133
|
method: 'PATCH' | 'POST';
|
|
61658
62134
|
queryParams: {};
|
|
61659
62135
|
jsonBody: {
|
|
61660
|
-
/** ID of the
|
|
62136
|
+
/** ID of the access system user to whom you want to assign a credential. */
|
|
61661
62137
|
acs_user_id: string;
|
|
61662
|
-
/** ID of the
|
|
62138
|
+
/** ID of the credential that you want to assign to an access system user. */
|
|
61663
62139
|
acs_credential_id: string;
|
|
61664
62140
|
};
|
|
61665
62141
|
commonParams: {};
|
|
@@ -61793,11 +62269,11 @@ interface Routes {
|
|
|
61793
62269
|
commonParams: {
|
|
61794
62270
|
/** ACS system ID of the credential manager for the new credential. */
|
|
61795
62271
|
credential_manager_acs_system_id?: string | undefined;
|
|
61796
|
-
/** ID of the
|
|
62272
|
+
/** ID of the access system user to whom the new credential belongs. You must provide either `acs_user_id` or the combination of `user_identity_id` and `acs_system_id`. */
|
|
61797
62273
|
acs_user_id?: string | undefined;
|
|
61798
|
-
/** ID of the user identity to whom the new credential belongs. You must provide either `acs_user_id` or the combination of `user_identity_id` and `acs_system_id`. If the
|
|
62274
|
+
/** ID of the user identity to whom the new credential belongs. You must provide either `acs_user_id` or the combination of `user_identity_id` and `acs_system_id`. If the access system contains a user with the same `email_address` or `phone_number` as the user identity that you specify, they are linked, and the credential belongs to the access system user. If the access system does not have a corresponding user, one is created. */
|
|
61799
62275
|
user_identity_id?: string | undefined;
|
|
61800
|
-
/** ID of the
|
|
62276
|
+
/** ID of the access system to which the new credential belongs. You must provide either `acs_user_id` or the combination of `user_identity_id` and `acs_system_id`. */
|
|
61801
62277
|
acs_system_id?: string | undefined;
|
|
61802
62278
|
/** Access method for the new credential. Supported values: `code`, `card`, `mobile_key`. */
|
|
61803
62279
|
access_method: 'code' | 'card' | 'mobile_key';
|
|
@@ -61830,7 +62306,9 @@ interface Routes {
|
|
|
61830
62306
|
} | undefined;
|
|
61831
62307
|
/** Salto Space-specific metadata for the new credential. */
|
|
61832
62308
|
salto_space_metadata?: {
|
|
62309
|
+
/** Indicates whether to assign a first, new card to a user. See also [Programming Salto Space Card-based Credentials](https://docs.seam.co/latest/device-and-system-integration-guides/salto-proaccess-space-access-system/programming-salto-space-card-based-credentials). */
|
|
61833
62310
|
assign_new_key?: boolean | undefined;
|
|
62311
|
+
/** Indicates whether to update the user's existing card. See also [Programming Salto Space Card-based Credentials](https://docs.seam.co/latest/device-and-system-integration-guides/salto-proaccess-space-access-system/programming-salto-space-card-based-credentials). */
|
|
61834
62312
|
update_current_key?: boolean | undefined;
|
|
61835
62313
|
} | undefined;
|
|
61836
62314
|
/** Date and time at which the validity of the new credential starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
|
|
@@ -61966,7 +62444,7 @@ interface Routes {
|
|
|
61966
62444
|
queryParams: {};
|
|
61967
62445
|
jsonBody: {};
|
|
61968
62446
|
commonParams: {
|
|
61969
|
-
/** ID of the
|
|
62447
|
+
/** ID of the access system user to whom the new credential belongs. */
|
|
61970
62448
|
acs_user_id: string;
|
|
61971
62449
|
/** IDs of the [`acs_entrance`s](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) for which the new credential grants access. */
|
|
61972
62450
|
allowed_acs_entrance_id: string;
|
|
@@ -62105,7 +62583,7 @@ interface Routes {
|
|
|
62105
62583
|
queryParams: {};
|
|
62106
62584
|
jsonBody: {};
|
|
62107
62585
|
commonParams: {
|
|
62108
|
-
/** ID of the
|
|
62586
|
+
/** ID of the credential that you want to delete. */
|
|
62109
62587
|
acs_credential_id: string;
|
|
62110
62588
|
};
|
|
62111
62589
|
formData: {};
|
|
@@ -62117,7 +62595,7 @@ interface Routes {
|
|
|
62117
62595
|
queryParams: {};
|
|
62118
62596
|
jsonBody: {};
|
|
62119
62597
|
commonParams: {
|
|
62120
|
-
/** ID of the
|
|
62598
|
+
/** ID of the credential that you want to get. */
|
|
62121
62599
|
acs_credential_id: string;
|
|
62122
62600
|
};
|
|
62123
62601
|
formData: {};
|
|
@@ -62248,15 +62726,15 @@ interface Routes {
|
|
|
62248
62726
|
queryParams: {};
|
|
62249
62727
|
jsonBody: {};
|
|
62250
62728
|
commonParams: ({
|
|
62251
|
-
/** ID of the
|
|
62729
|
+
/** ID of the access system user for which you want to retrieve all credentials. */
|
|
62252
62730
|
acs_user_id: string;
|
|
62253
62731
|
} | {
|
|
62254
|
-
/** ID of the access
|
|
62732
|
+
/** ID of the access system for which you want to retrieve all credentials. */
|
|
62255
62733
|
acs_system_id: string;
|
|
62256
62734
|
} | {
|
|
62257
|
-
/** ID of the
|
|
62735
|
+
/** ID of the access system user for which you want to retrieve all credentials. */
|
|
62258
62736
|
acs_user_id: string;
|
|
62259
|
-
/** ID of the access
|
|
62737
|
+
/** ID of the access system for which you want to retrieve all credentials. */
|
|
62260
62738
|
acs_system_id: string;
|
|
62261
62739
|
} | {
|
|
62262
62740
|
/** ID of the user identity for which you want to retrieve all credentials. */
|
|
@@ -62392,7 +62870,7 @@ interface Routes {
|
|
|
62392
62870
|
queryParams: {};
|
|
62393
62871
|
jsonBody: {};
|
|
62394
62872
|
commonParams: {
|
|
62395
|
-
/** ID of the credential for which you want to retrieve all entrances to which
|
|
62873
|
+
/** ID of the credential for which you want to retrieve all entrances to which the credential grants access. */
|
|
62396
62874
|
acs_credential_id: string;
|
|
62397
62875
|
};
|
|
62398
62876
|
formData: {};
|
|
@@ -62466,9 +62944,9 @@ interface Routes {
|
|
|
62466
62944
|
method: 'PATCH' | 'POST';
|
|
62467
62945
|
queryParams: {};
|
|
62468
62946
|
jsonBody: {
|
|
62469
|
-
/** ID of the
|
|
62947
|
+
/** ID of the access system user from which you want to unassign a credential. */
|
|
62470
62948
|
acs_user_id: string;
|
|
62471
|
-
/** ID of the
|
|
62949
|
+
/** ID of the credential that you want to unassign from an access system user. */
|
|
62472
62950
|
acs_credential_id: string;
|
|
62473
62951
|
};
|
|
62474
62952
|
commonParams: {};
|
|
@@ -62600,7 +63078,7 @@ interface Routes {
|
|
|
62600
63078
|
queryParams: {};
|
|
62601
63079
|
jsonBody: {};
|
|
62602
63080
|
commonParams: {
|
|
62603
|
-
/** ID of the
|
|
63081
|
+
/** ID of the unmanaged credential that you want to get. */
|
|
62604
63082
|
acs_credential_id: string;
|
|
62605
63083
|
};
|
|
62606
63084
|
formData: {};
|
|
@@ -62727,15 +63205,15 @@ interface Routes {
|
|
|
62727
63205
|
queryParams: {};
|
|
62728
63206
|
jsonBody: {};
|
|
62729
63207
|
commonParams: {
|
|
62730
|
-
/** ID of the
|
|
63208
|
+
/** ID of the access system user for which you want to retrieve all credentials. */
|
|
62731
63209
|
acs_user_id: string;
|
|
62732
63210
|
} | {
|
|
62733
|
-
/** ID of the access
|
|
63211
|
+
/** ID of the access system for which you want to retrieve all credentials. */
|
|
62734
63212
|
acs_system_id: string;
|
|
62735
63213
|
} | {
|
|
62736
|
-
/** ID of the
|
|
63214
|
+
/** ID of the access system user for which you want to retrieve all credentials. */
|
|
62737
63215
|
acs_user_id: string;
|
|
62738
|
-
/** ID of the access
|
|
63216
|
+
/** ID of the access system for which you want to retrieve all credentials. */
|
|
62739
63217
|
acs_system_id: string;
|
|
62740
63218
|
} | {
|
|
62741
63219
|
/** ID of the user identity for which you want to retrieve all credentials. */
|
|
@@ -62863,9 +63341,9 @@ interface Routes {
|
|
|
62863
63341
|
method: 'PATCH' | 'POST';
|
|
62864
63342
|
queryParams: {};
|
|
62865
63343
|
jsonBody: {
|
|
62866
|
-
/** ID of the
|
|
63344
|
+
/** ID of the credential that you want to update. */
|
|
62867
63345
|
acs_credential_id: string;
|
|
62868
|
-
/** Replacement access (PIN) code for the credential. */
|
|
63346
|
+
/** Replacement access (PIN) code for the credential that you want to update. */
|
|
62869
63347
|
code?: string | undefined;
|
|
62870
63348
|
/** Replacement date and time at which the validity of the credential ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after the `starts_at` value that you set when creating the credential. */
|
|
62871
63349
|
ends_at?: string | undefined;
|
|
@@ -65235,7 +65713,7 @@ interface Routes {
|
|
|
65235
65713
|
queryParams: {};
|
|
65236
65714
|
jsonBody: {};
|
|
65237
65715
|
commonParams: {
|
|
65238
|
-
/** ID of the
|
|
65716
|
+
/** ID of the encoder that you want to get. */
|
|
65239
65717
|
acs_encoder_id: string;
|
|
65240
65718
|
};
|
|
65241
65719
|
formData: {};
|
|
@@ -65283,19 +65761,19 @@ interface Routes {
|
|
|
65283
65761
|
queryParams: {};
|
|
65284
65762
|
jsonBody: {};
|
|
65285
65763
|
commonParams: {
|
|
65286
|
-
/** ID of the
|
|
65764
|
+
/** ID of the access system for which you want to retrieve all encoders. */
|
|
65287
65765
|
acs_system_id: string;
|
|
65288
|
-
/** Number of
|
|
65766
|
+
/** Number of encoders to return. */
|
|
65289
65767
|
limit?: number;
|
|
65290
65768
|
} | {
|
|
65291
|
-
/** IDs of the
|
|
65769
|
+
/** IDs of the access systems for which you want to retrieve all encoders. */
|
|
65292
65770
|
acs_system_ids: string[];
|
|
65293
|
-
/** Number of
|
|
65771
|
+
/** Number of encoders to return. */
|
|
65294
65772
|
limit?: number;
|
|
65295
65773
|
} | {
|
|
65296
|
-
/** IDs of the
|
|
65774
|
+
/** IDs of the encoders that you want to retrieve. */
|
|
65297
65775
|
acs_encoder_ids: string[];
|
|
65298
|
-
/** Number of
|
|
65776
|
+
/** Number of encoders to return. */
|
|
65299
65777
|
limit?: number;
|
|
65300
65778
|
};
|
|
65301
65779
|
formData: {};
|
|
@@ -65329,7 +65807,7 @@ interface Routes {
|
|
|
65329
65807
|
queryParams: {};
|
|
65330
65808
|
jsonBody: {};
|
|
65331
65809
|
commonParams: {
|
|
65332
|
-
/** ID of the
|
|
65810
|
+
/** ID of the encoder to use for the scan. */
|
|
65333
65811
|
acs_encoder_id: string;
|
|
65334
65812
|
};
|
|
65335
65813
|
formData: {};
|
|
@@ -66524,6 +67002,7 @@ interface Routes {
|
|
|
66524
67002
|
queryParams: {};
|
|
66525
67003
|
jsonBody: {};
|
|
66526
67004
|
commonParams: {
|
|
67005
|
+
/** ID of the entrance that you want to get. */
|
|
66527
67006
|
acs_entrance_id: string;
|
|
66528
67007
|
};
|
|
66529
67008
|
formData: {};
|
|
@@ -66600,7 +67079,9 @@ interface Routes {
|
|
|
66600
67079
|
method: 'POST';
|
|
66601
67080
|
queryParams: {};
|
|
66602
67081
|
jsonBody: {
|
|
67082
|
+
/** ID of the entrance to which you want to grant an access system user access. */
|
|
66603
67083
|
acs_entrance_id: string;
|
|
67084
|
+
/** ID of the access system user to whom you want to grant access to an entrance. */
|
|
66604
67085
|
acs_user_id: string;
|
|
66605
67086
|
};
|
|
66606
67087
|
commonParams: {};
|
|
@@ -66613,9 +67094,11 @@ interface Routes {
|
|
|
66613
67094
|
queryParams: {};
|
|
66614
67095
|
jsonBody: {};
|
|
66615
67096
|
commonParams: {
|
|
67097
|
+
/** ID of the access system for which you want to retrieve all entrances. */
|
|
66616
67098
|
acs_system_id?: string | undefined;
|
|
67099
|
+
/** ID of the credential for which you want to retrieve all entrances. */
|
|
66617
67100
|
acs_credential_id?: string | undefined;
|
|
66618
|
-
/**
|
|
67101
|
+
/** ID of the location for which you want to retrieve all entrances. */
|
|
66619
67102
|
location_id?: (string | null) | undefined;
|
|
66620
67103
|
};
|
|
66621
67104
|
formData: {};
|
|
@@ -66690,7 +67173,9 @@ interface Routes {
|
|
|
66690
67173
|
queryParams: {};
|
|
66691
67174
|
jsonBody: {};
|
|
66692
67175
|
commonParams: {
|
|
67176
|
+
/** ID of the entrance for which you want to list all credentials that grant access. */
|
|
66693
67177
|
acs_entrance_id: string;
|
|
67178
|
+
/** Conditions that credentials must meet to be included in the returned list. */
|
|
66694
67179
|
include_if?: Array<'visionline_metadata.is_valid'> | undefined;
|
|
66695
67180
|
};
|
|
66696
67181
|
formData: {};
|
|
@@ -66816,7 +67301,7 @@ interface Routes {
|
|
|
66816
67301
|
queryParams: {};
|
|
66817
67302
|
jsonBody: {};
|
|
66818
67303
|
commonParams: {
|
|
66819
|
-
/** ID of the
|
|
67304
|
+
/** ID of the access system that you want to get. */
|
|
66820
67305
|
acs_system_id: string;
|
|
66821
67306
|
};
|
|
66822
67307
|
formData: {};
|
|
@@ -66966,7 +67451,7 @@ interface Routes {
|
|
|
66966
67451
|
queryParams: {};
|
|
66967
67452
|
jsonBody: {};
|
|
66968
67453
|
commonParams: {
|
|
66969
|
-
/** ID of the connected account by which to filter the list of
|
|
67454
|
+
/** ID of the connected account by which you want to filter the list of access systems. */
|
|
66970
67455
|
connected_account_id?: string | undefined;
|
|
66971
67456
|
};
|
|
66972
67457
|
formData: {};
|
|
@@ -67111,7 +67596,7 @@ interface Routes {
|
|
|
67111
67596
|
queryParams: {};
|
|
67112
67597
|
jsonBody: {};
|
|
67113
67598
|
commonParams: {
|
|
67114
|
-
/** ID of the
|
|
67599
|
+
/** ID of the access system for which you want to retrieve all compatible credential manager systems. */
|
|
67115
67600
|
acs_system_id: string;
|
|
67116
67601
|
};
|
|
67117
67602
|
formData: {};
|
|
@@ -67256,9 +67741,9 @@ interface Routes {
|
|
|
67256
67741
|
queryParams: {};
|
|
67257
67742
|
jsonBody: {};
|
|
67258
67743
|
commonParams: {
|
|
67259
|
-
/** ID of the
|
|
67744
|
+
/** ID of the access system user that you want to add to an access group. */
|
|
67260
67745
|
acs_user_id: string;
|
|
67261
|
-
/** ID of the
|
|
67746
|
+
/** ID of the access group to which you want to add an access system user. */
|
|
67262
67747
|
acs_access_group_id: string;
|
|
67263
67748
|
};
|
|
67264
67749
|
formData: {};
|
|
@@ -67269,17 +67754,19 @@ interface Routes {
|
|
|
67269
67754
|
method: 'POST';
|
|
67270
67755
|
queryParams: {};
|
|
67271
67756
|
jsonBody: {
|
|
67272
|
-
/** Full name of the new
|
|
67757
|
+
/** Full name of the new access system user. */
|
|
67273
67758
|
full_name: string;
|
|
67274
|
-
/** ID of the
|
|
67759
|
+
/** ID of the access system to which you want to add the new access system user. */
|
|
67275
67760
|
acs_system_id: string;
|
|
67276
|
-
/** Array of
|
|
67761
|
+
/** Array of access group IDs to indicate the access groups to which you want to add the new access system user. */
|
|
67277
67762
|
acs_access_group_ids?: string[];
|
|
67278
|
-
/** ID of the user identity with which to associate the new
|
|
67763
|
+
/** ID of the user identity with which you want to associate the new access system user. */
|
|
67279
67764
|
user_identity_id?: string | undefined;
|
|
67280
|
-
/** `starts_at` and `ends_at` timestamps for the new
|
|
67765
|
+
/** `starts_at` and `ends_at` timestamps for the new access system user's access. If you specify an `access_schedule`, you may include both `starts_at` and `ends_at`. If you omit `starts_at`, it defaults to the current time. `ends_at` is optional and must be a time in the future and after `starts_at`. */
|
|
67281
67766
|
access_schedule?: {
|
|
67767
|
+
/** Starting timestamp for the new access system user's access. */
|
|
67282
67768
|
starts_at?: string | undefined;
|
|
67769
|
+
/** Ending timestamp for the new access system user's access. */
|
|
67283
67770
|
ends_at?: (string | undefined) | null;
|
|
67284
67771
|
} | undefined;
|
|
67285
67772
|
/**
|
|
@@ -67488,7 +67975,7 @@ interface Routes {
|
|
|
67488
67975
|
queryParams: {};
|
|
67489
67976
|
jsonBody: {};
|
|
67490
67977
|
commonParams: {
|
|
67491
|
-
/** ID of the
|
|
67978
|
+
/** ID of the access system user that you want to delete. */
|
|
67492
67979
|
acs_user_id: string;
|
|
67493
67980
|
};
|
|
67494
67981
|
formData: {};
|
|
@@ -67500,7 +67987,7 @@ interface Routes {
|
|
|
67500
67987
|
queryParams: {};
|
|
67501
67988
|
jsonBody: {};
|
|
67502
67989
|
commonParams: {
|
|
67503
|
-
/** ID of the
|
|
67990
|
+
/** ID of the access system user that you want to get. */
|
|
67504
67991
|
acs_user_id: string;
|
|
67505
67992
|
};
|
|
67506
67993
|
formData: {};
|
|
@@ -67700,18 +68187,19 @@ interface Routes {
|
|
|
67700
68187
|
queryParams: {};
|
|
67701
68188
|
jsonBody: {};
|
|
67702
68189
|
commonParams: {
|
|
67703
|
-
/** ID of the user identity for which you want to retrieve all
|
|
68190
|
+
/** ID of the user identity for which you want to retrieve all access system users. */
|
|
67704
68191
|
user_identity_id?: string | undefined;
|
|
67705
|
-
/** Phone number of the user identity for which you want to retrieve all
|
|
68192
|
+
/** Phone number of the user identity for which you want to retrieve all access system users, in [E.164 format](https://www.itu.int/rec/T-REC-E.164/en) (for example, `+15555550100`). */
|
|
67706
68193
|
user_identity_phone_number?: string | undefined;
|
|
67707
|
-
/** Email address of the user identity for which you want to retrieve all
|
|
68194
|
+
/** Email address of the user identity for which you want to retrieve all access system users. */
|
|
67708
68195
|
user_identity_email_address?: string | undefined;
|
|
67709
|
-
/** ID of the `acs_system` for which you want to retrieve all
|
|
68196
|
+
/** ID of the `acs_system` for which you want to retrieve all access system users. */
|
|
67710
68197
|
acs_system_id?: string | undefined;
|
|
67711
|
-
/** String for which to search. Filters returned
|
|
68198
|
+
/** String for which to search. Filters returned access system users to include all records that satisfy a partial match using `full_name`, `phone_number`, `email_address`, `acs_user_id`, `user_identity_id`, `user_identity_full_name` or `user_identity_phone_number`. */
|
|
67712
68199
|
search?: string | undefined;
|
|
67713
68200
|
/** Maximum number of records to return per page. */
|
|
67714
68201
|
limit?: number;
|
|
68202
|
+
/** Timestamp by which to limit returned access system users. Returns users created before this timestamp. */
|
|
67715
68203
|
created_before?: Date | undefined;
|
|
67716
68204
|
/** Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`. */
|
|
67717
68205
|
page_cursor?: (string | undefined) | null;
|
|
@@ -67917,7 +68405,7 @@ interface Routes {
|
|
|
67917
68405
|
queryParams: {};
|
|
67918
68406
|
jsonBody: {};
|
|
67919
68407
|
commonParams: {
|
|
67920
|
-
/** ID of the
|
|
68408
|
+
/** ID of the access system user for whom you want to list accessible entrances. */
|
|
67921
68409
|
acs_user_id: string;
|
|
67922
68410
|
};
|
|
67923
68411
|
formData: {};
|
|
@@ -67992,9 +68480,9 @@ interface Routes {
|
|
|
67992
68480
|
queryParams: {};
|
|
67993
68481
|
jsonBody: {};
|
|
67994
68482
|
commonParams: {
|
|
67995
|
-
/** ID of the
|
|
68483
|
+
/** ID of the access system user that you want to remove from an access group. */
|
|
67996
68484
|
acs_user_id: string;
|
|
67997
|
-
/** ID of the
|
|
68485
|
+
/** ID of the access group from which you want to remove an access system user. */
|
|
67998
68486
|
acs_access_group_id: string;
|
|
67999
68487
|
};
|
|
68000
68488
|
formData: {};
|
|
@@ -68005,7 +68493,7 @@ interface Routes {
|
|
|
68005
68493
|
method: 'POST';
|
|
68006
68494
|
queryParams: {};
|
|
68007
68495
|
jsonBody: {
|
|
68008
|
-
/** ID of the
|
|
68496
|
+
/** ID of the access system user for whom you want to revoke access. */
|
|
68009
68497
|
acs_user_id: string;
|
|
68010
68498
|
};
|
|
68011
68499
|
commonParams: {};
|
|
@@ -68018,7 +68506,7 @@ interface Routes {
|
|
|
68018
68506
|
queryParams: {};
|
|
68019
68507
|
jsonBody: {};
|
|
68020
68508
|
commonParams: {
|
|
68021
|
-
/** ID of the
|
|
68509
|
+
/** ID of the access system user that you want to suspend. */
|
|
68022
68510
|
acs_user_id: string;
|
|
68023
68511
|
};
|
|
68024
68512
|
formData: {};
|
|
@@ -68030,6 +68518,7 @@ interface Routes {
|
|
|
68030
68518
|
queryParams: {};
|
|
68031
68519
|
jsonBody: {};
|
|
68032
68520
|
commonParams: {
|
|
68521
|
+
/** ID of the unmanaged access system user that you want to get. */
|
|
68033
68522
|
acs_user_id: string;
|
|
68034
68523
|
};
|
|
68035
68524
|
formData: {};
|
|
@@ -68225,10 +68714,15 @@ interface Routes {
|
|
|
68225
68714
|
queryParams: {};
|
|
68226
68715
|
jsonBody: {};
|
|
68227
68716
|
commonParams: {
|
|
68717
|
+
/** ID of the user identity for which you want to retrieve all unmanaged access system users. */
|
|
68228
68718
|
user_identity_id?: string | undefined;
|
|
68719
|
+
/** Phone number of the user identity for which you want to retrieve all unmanaged access system users. */
|
|
68229
68720
|
user_identity_phone_number?: string | undefined;
|
|
68721
|
+
/** Email address of the user identity for which you want to retrieve all unmanaged access system users. */
|
|
68230
68722
|
user_identity_email_address?: string | undefined;
|
|
68723
|
+
/** ID of the access system for which you want to retrieve all unmanaged access system users. */
|
|
68231
68724
|
acs_system_id?: string | undefined;
|
|
68725
|
+
/** Number of unmanaged access system users to return. */
|
|
68232
68726
|
limit?: number;
|
|
68233
68727
|
};
|
|
68234
68728
|
formData: {};
|
|
@@ -68423,7 +68917,7 @@ interface Routes {
|
|
|
68423
68917
|
queryParams: {};
|
|
68424
68918
|
jsonBody: {};
|
|
68425
68919
|
commonParams: {
|
|
68426
|
-
/** ID of the
|
|
68920
|
+
/** ID of the access system user that you want to unsuspend. */
|
|
68427
68921
|
acs_user_id: string;
|
|
68428
68922
|
};
|
|
68429
68923
|
formData: {};
|
|
@@ -68434,9 +68928,11 @@ interface Routes {
|
|
|
68434
68928
|
method: 'PATCH' | 'POST';
|
|
68435
68929
|
queryParams: {};
|
|
68436
68930
|
jsonBody: {
|
|
68437
|
-
/** `starts_at` and `ends_at` timestamps for the
|
|
68931
|
+
/** `starts_at` and `ends_at` timestamps for the access system user's access. If you specify an `access_schedule`, you may include both `starts_at` and `ends_at`. If you omit `starts_at`, it defaults to the current time. `ends_at` is optional and must be a time in the future and after `starts_at`. */
|
|
68438
68932
|
access_schedule?: ({
|
|
68933
|
+
/** Starting timestamp for the access system user's access. */
|
|
68439
68934
|
starts_at: string;
|
|
68935
|
+
/** Ending timestamp for the access system user's access. */
|
|
68440
68936
|
ends_at: string;
|
|
68441
68937
|
} | null) | undefined;
|
|
68442
68938
|
/** ID of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). */
|
|
@@ -68462,6 +68958,7 @@ interface Routes {
|
|
|
68462
68958
|
queryParams: {};
|
|
68463
68959
|
jsonBody: {};
|
|
68464
68960
|
commonParams: {
|
|
68961
|
+
/** ID of the action attempt that you want to get. */
|
|
68465
68962
|
action_attempt_id: string;
|
|
68466
68963
|
};
|
|
68467
68964
|
formData: {};
|
|
@@ -69577,6 +70074,7 @@ interface Routes {
|
|
|
69577
70074
|
queryParams: {};
|
|
69578
70075
|
jsonBody: {};
|
|
69579
70076
|
commonParams: {
|
|
70077
|
+
/** IDs of the action attempts that you want to retrieve. */
|
|
69580
70078
|
action_attempt_ids: string[];
|
|
69581
70079
|
};
|
|
69582
70080
|
formData: {};
|
|
@@ -70691,6 +71189,7 @@ interface Routes {
|
|
|
70691
71189
|
queryParams: {};
|
|
70692
71190
|
jsonBody: {};
|
|
70693
71191
|
commonParams: {
|
|
71192
|
+
/** ID of the Seam Bridge that you want to get. */
|
|
70694
71193
|
bridge_id: string;
|
|
70695
71194
|
};
|
|
70696
71195
|
formData: {};
|
|
@@ -70723,16 +71222,29 @@ interface Routes {
|
|
|
70723
71222
|
method: 'POST' | 'PUT';
|
|
70724
71223
|
queryParams: {};
|
|
70725
71224
|
jsonBody: {
|
|
71225
|
+
/** Your user ID for the user for whom you want to create a client session. */
|
|
70726
71226
|
user_identifier_key?: string | undefined;
|
|
71227
|
+
/** IDs of the [Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews) for which you want to create a client session. */
|
|
70727
71228
|
connect_webview_ids?: string[] | undefined;
|
|
71229
|
+
/** IDs of the [connected accounts](https://docs.seam.co/latest/core-concepts/connected-accounts) for which you want to create a client session. */
|
|
70728
71230
|
connected_account_ids?: string[] | undefined;
|
|
71231
|
+
/** IDs of the [user identities](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) for which you want to create a client session. */
|
|
70729
71232
|
user_identity_ids?: string[] | undefined;
|
|
71233
|
+
/** Date and time at which the client session should expire, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
|
|
70730
71234
|
expires_at?: Date | undefined;
|
|
70731
71235
|
};
|
|
70732
71236
|
commonParams: {};
|
|
70733
71237
|
formData: {};
|
|
70734
71238
|
jsonResponse: {
|
|
70735
|
-
/**
|
|
71239
|
+
/** Represents a [client session](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens). If you want to restrict your users' access to their own devices, use client sessions.
|
|
71240
|
+
|
|
71241
|
+
You create each client session with a custom `user_identifier_key`. Normally, the `user_identifier_key` is a user ID that your application provides.
|
|
71242
|
+
|
|
71243
|
+
When calling the Seam API from your backend using an API key, you can pass the `user_identifier_key` as a parameter to limit results to the associated client session. For example, `/devices/list?user_identifier_key=123` only returns devices associated with the client session created with the `user_identifier_key` `123`.
|
|
71244
|
+
|
|
71245
|
+
A client session has a token that you can use with the Seam JavaScript SDK to make requests from the client (browser) directly to the Seam API. The token restricts the user's access to only the devices that they own.
|
|
71246
|
+
|
|
71247
|
+
See also [Get Started with React](https://docs.seam.co/latest/ui-components/overview/getting-started-with-seam-components/get-started-with-react-components-and-client-session-tokens). */
|
|
70736
71248
|
client_session: {
|
|
70737
71249
|
client_session_id: string;
|
|
70738
71250
|
workspace_id: string;
|
|
@@ -70753,6 +71265,7 @@ interface Routes {
|
|
|
70753
71265
|
queryParams: {};
|
|
70754
71266
|
jsonBody: {};
|
|
70755
71267
|
commonParams: {
|
|
71268
|
+
/** ID of the client session that you want to delete. */
|
|
70756
71269
|
client_session_id: string;
|
|
70757
71270
|
};
|
|
70758
71271
|
formData: {};
|
|
@@ -70764,12 +71277,22 @@ interface Routes {
|
|
|
70764
71277
|
queryParams: {};
|
|
70765
71278
|
jsonBody: {};
|
|
70766
71279
|
commonParams: {
|
|
71280
|
+
/** ID of the client session that you want to get. */
|
|
70767
71281
|
client_session_id?: string | undefined;
|
|
71282
|
+
/** User identifier key associated with the client session that you want to get. */
|
|
70768
71283
|
user_identifier_key?: string | undefined;
|
|
70769
71284
|
};
|
|
70770
71285
|
formData: {};
|
|
70771
71286
|
jsonResponse: {
|
|
70772
|
-
/**
|
|
71287
|
+
/** Represents a [client session](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens). If you want to restrict your users' access to their own devices, use client sessions.
|
|
71288
|
+
|
|
71289
|
+
You create each client session with a custom `user_identifier_key`. Normally, the `user_identifier_key` is a user ID that your application provides.
|
|
71290
|
+
|
|
71291
|
+
When calling the Seam API from your backend using an API key, you can pass the `user_identifier_key` as a parameter to limit results to the associated client session. For example, `/devices/list?user_identifier_key=123` only returns devices associated with the client session created with the `user_identifier_key` `123`.
|
|
71292
|
+
|
|
71293
|
+
A client session has a token that you can use with the Seam JavaScript SDK to make requests from the client (browser) directly to the Seam API. The token restricts the user's access to only the devices that they own.
|
|
71294
|
+
|
|
71295
|
+
See also [Get Started with React](https://docs.seam.co/latest/ui-components/overview/getting-started-with-seam-components/get-started-with-react-components-and-client-session-tokens). */
|
|
70773
71296
|
client_session: {
|
|
70774
71297
|
client_session_id: string;
|
|
70775
71298
|
workspace_id: string;
|
|
@@ -70789,16 +71312,29 @@ interface Routes {
|
|
|
70789
71312
|
method: 'POST';
|
|
70790
71313
|
queryParams: {};
|
|
70791
71314
|
jsonBody: {
|
|
71315
|
+
/** Your user ID for the user that you want to associate with the client session (or that is already associated with the existing client session). */
|
|
70792
71316
|
user_identifier_key?: string | undefined;
|
|
71317
|
+
/** IDs of the [Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews) that you want to associate with the client session (or that are already associated with the existing client session). */
|
|
70793
71318
|
connect_webview_ids?: string[] | undefined;
|
|
71319
|
+
/** IDs of the [connected accounts](https://docs.seam.co/latest/api/connected_accounts) that you want to associate with the client session (or that are already associated with the existing client session). */
|
|
70794
71320
|
connected_account_ids?: string[] | undefined;
|
|
71321
|
+
/** IDs of the [user identities](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) that you want to associate with the client session (or that are already associated with the existing client session). */
|
|
70795
71322
|
user_identity_ids?: string[] | undefined;
|
|
71323
|
+
/** Date and time at which the client session should expire (or at which the existing client session expires), in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
|
|
70796
71324
|
expires_at?: Date | undefined;
|
|
70797
71325
|
};
|
|
70798
71326
|
commonParams: {};
|
|
70799
71327
|
formData: {};
|
|
70800
71328
|
jsonResponse: {
|
|
70801
|
-
/**
|
|
71329
|
+
/** Represents a [client session](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens). If you want to restrict your users' access to their own devices, use client sessions.
|
|
71330
|
+
|
|
71331
|
+
You create each client session with a custom `user_identifier_key`. Normally, the `user_identifier_key` is a user ID that your application provides.
|
|
71332
|
+
|
|
71333
|
+
When calling the Seam API from your backend using an API key, you can pass the `user_identifier_key` as a parameter to limit results to the associated client session. For example, `/devices/list?user_identifier_key=123` only returns devices associated with the client session created with the `user_identifier_key` `123`.
|
|
71334
|
+
|
|
71335
|
+
A client session has a token that you can use with the Seam JavaScript SDK to make requests from the client (browser) directly to the Seam API. The token restricts the user's access to only the devices that they own.
|
|
71336
|
+
|
|
71337
|
+
See also [Get Started with React](https://docs.seam.co/latest/ui-components/overview/getting-started-with-seam-components/get-started-with-react-components-and-client-session-tokens). */
|
|
70802
71338
|
client_session: {
|
|
70803
71339
|
client_session_id: string;
|
|
70804
71340
|
workspace_id: string;
|
|
@@ -70819,15 +71355,28 @@ interface Routes {
|
|
|
70819
71355
|
queryParams: {};
|
|
70820
71356
|
jsonBody: {};
|
|
70821
71357
|
commonParams: {
|
|
71358
|
+
/** ID of the client session to which you want to grant access to resources. */
|
|
70822
71359
|
client_session_id?: string | undefined;
|
|
71360
|
+
/** Your user ID for the user that you want to associate with the client session. */
|
|
70823
71361
|
user_identifier_key?: string | undefined;
|
|
71362
|
+
/** IDs of the [connected accounts](https://docs.seam.co/latest/core-concepts/connected-accounts) that you want to associate with the client session. */
|
|
70824
71363
|
connected_account_ids?: string[] | undefined;
|
|
71364
|
+
/** IDs of the [Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews) that you want to associate with the client session. */
|
|
70825
71365
|
connect_webview_ids?: string[] | undefined;
|
|
71366
|
+
/** IDs of the [user identities](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) that you want to associate with the client session. */
|
|
70826
71367
|
user_identity_ids?: string[] | undefined;
|
|
70827
71368
|
};
|
|
70828
71369
|
formData: {};
|
|
70829
71370
|
jsonResponse: {
|
|
70830
|
-
/**
|
|
71371
|
+
/** Represents a [client session](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens). If you want to restrict your users' access to their own devices, use client sessions.
|
|
71372
|
+
|
|
71373
|
+
You create each client session with a custom `user_identifier_key`. Normally, the `user_identifier_key` is a user ID that your application provides.
|
|
71374
|
+
|
|
71375
|
+
When calling the Seam API from your backend using an API key, you can pass the `user_identifier_key` as a parameter to limit results to the associated client session. For example, `/devices/list?user_identifier_key=123` only returns devices associated with the client session created with the `user_identifier_key` `123`.
|
|
71376
|
+
|
|
71377
|
+
A client session has a token that you can use with the Seam JavaScript SDK to make requests from the client (browser) directly to the Seam API. The token restricts the user's access to only the devices that they own.
|
|
71378
|
+
|
|
71379
|
+
See also [Get Started with React](https://docs.seam.co/latest/ui-components/overview/getting-started-with-seam-components/get-started-with-react-components-and-client-session-tokens). */
|
|
70831
71380
|
client_session: {
|
|
70832
71381
|
client_session_id: string;
|
|
70833
71382
|
workspace_id: string;
|
|
@@ -70848,10 +71397,15 @@ interface Routes {
|
|
|
70848
71397
|
queryParams: {};
|
|
70849
71398
|
jsonBody: {};
|
|
70850
71399
|
commonParams: {
|
|
71400
|
+
/** ID of the client session that you want to retrieve. */
|
|
70851
71401
|
client_session_id?: string | undefined;
|
|
71402
|
+
/** Your user ID for the user by which you want to filter client sessions. */
|
|
70852
71403
|
user_identifier_key?: string | undefined;
|
|
71404
|
+
/** ID of the [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews) for which you want to retrieve client sessions. */
|
|
70853
71405
|
connect_webview_id?: string | undefined;
|
|
71406
|
+
/** Indicates whether to retrieve only client sessions without associated user identifier keys. */
|
|
70854
71407
|
without_user_identifier_key?: boolean | undefined;
|
|
71408
|
+
/** ID of the [user identity](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) for which you want to retrieve client sessions. */
|
|
70855
71409
|
user_identity_id?: string | undefined;
|
|
70856
71410
|
};
|
|
70857
71411
|
formData: {};
|
|
@@ -70876,6 +71430,7 @@ interface Routes {
|
|
|
70876
71430
|
queryParams: {};
|
|
70877
71431
|
jsonBody: {};
|
|
70878
71432
|
commonParams: {
|
|
71433
|
+
/** ID of the client session that you want to revoke. */
|
|
70879
71434
|
client_session_id: string;
|
|
70880
71435
|
};
|
|
70881
71436
|
formData: {};
|
|
@@ -70886,19 +71441,37 @@ interface Routes {
|
|
|
70886
71441
|
method: 'POST';
|
|
70887
71442
|
queryParams: {};
|
|
70888
71443
|
jsonBody: {
|
|
71444
|
+
/** */
|
|
70889
71445
|
device_selection_mode?: ('none' | 'single' | 'multiple') | undefined;
|
|
71446
|
+
/** URL that you want to redirect the user to after the provider login is complete. */
|
|
70890
71447
|
custom_redirect_url?: string | undefined;
|
|
71448
|
+
/** Alternative URL that you want to redirect the user to on an error. If you do not set this parameter, the Connect Webview falls back to the `custom_redirect_url`. */
|
|
70891
71449
|
custom_redirect_failure_url?: string | undefined;
|
|
71450
|
+
/** Accepted device provider keys as an alternative to `provider_category`. Use this parameter to specify accepted providers explicitly. See [Customize the Brands to Display in Your Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-brands-to-display-in-your-connect-webviews). To list all provider keys, use [`/devices/list_device_providers`](https://docs.seam.co/latest/api/devices/list_device_providers) with no filters. */
|
|
70892
71451
|
accepted_providers?: Array<'dormakaba_community' | 'legic_connect' | 'akuvox' | 'august' | 'avigilon_alta' | 'brivo' | 'butterflymx' | 'schlage' | 'smartthings' | 'yale' | 'genie' | 'doorking' | 'salto' | 'salto_ks' | 'lockly' | 'ttlock' | 'linear' | 'noiseaware' | 'nuki' | 'seam_relay_admin' | 'igloo' | 'kwikset' | 'minut' | 'my_2n' | 'controlbyweb' | 'nest' | 'igloohome' | 'ecobee' | 'hubitat' | 'four_suites' | 'dormakaba_oracode' | 'pti' | 'wyze' | 'seam_passport' | 'visionline' | 'assa_abloy_credential_service' | 'seam_bridge' | 'tedee' | 'honeywell_resideo' | 'latch' | 'akiles' | 'assa_abloy_vostio' | 'assa_abloy_vostio_credential_service' | 'tado' | 'salto_space' | 'sensi' | 'kwikset2' | 'yale_access' | 'hid_cm' | 'google_nest'> | undefined;
|
|
71452
|
+
/** Specifies the category of providers that you want to include. To list all providers within a category, use [`/devices/list_device_providers`](https://docs.seam.co/latest/api/devices/list_device_providers) with the desired `provider_category` filter. */
|
|
70893
71453
|
provider_category?: ('stable' | 'consumer_smartlocks' | 'thermostats' | 'noise_sensors' | 'access_control_systems' | 'internal_beta') | undefined;
|
|
71454
|
+
/** Custom metadata that you want to associate with the Connect Webview. Supports up to 50 JSON key:value pairs. [Adding custom metadata to a Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview) enables you to store custom information, like customer details or internal IDs from your application. The custom metadata is then transferred to any [connected accounts](https://docs.seam.co/latest/core-concepts/connected-accounts) that were connected using the Connect Webview, making it easy to find and filter these resources in your [workspace](https://docs.seam.co/latest/core-concepts/workspaces). You can also [filter Connect Webviews by custom metadata](https://docs.seam.co/latest/core-concepts/connect-webviews/filtering-connect-webviews-by-custom-metadata). */
|
|
70894
71455
|
custom_metadata?: Record<string, string | boolean | null> | undefined;
|
|
71456
|
+
/** Indicates whether newly-added devices should appear as [managed devices](https://docs.seam.co/latest/core-concepts/devices/managed-and-unmanaged-devices). See also: [Customize the Behavior Settings of Your Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-behavior-settings-of-your-connect-webviews). */
|
|
70895
71457
|
automatically_manage_new_devices?: boolean;
|
|
71458
|
+
/** Indicates whether Seam should finish syncing all devices in a newly-connected account before completing the associated Connect Webview. See also: [Customize the Behavior Settings of Your Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-behavior-settings-of-your-connect-webviews). */
|
|
70896
71459
|
wait_for_device_creation?: boolean;
|
|
70897
71460
|
};
|
|
70898
71461
|
commonParams: {};
|
|
70899
71462
|
formData: {};
|
|
70900
71463
|
jsonResponse: {
|
|
70901
|
-
/**
|
|
71464
|
+
/** Represents a [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews).
|
|
71465
|
+
|
|
71466
|
+
Connect Webviews are fully-embedded client-side components that you add to your app. Your users interact with your embedded Connect Webviews to link their IoT device or system accounts to Seam. That is, Connect Webviews walk your users through the process of logging in to their device or system accounts. Seam handles all the authentication steps, and—once your user has completed the authorization through your app—you can access and control their devices or systems using the Seam API.
|
|
71467
|
+
|
|
71468
|
+
Connect Webviews perform credential validation, multifactor authentication (when applicable), and error handling for each brand that Seam supports. Further, Connect Webviews work across all modern browsers and platforms, including Chrome, Safari, and Firefox.
|
|
71469
|
+
|
|
71470
|
+
To enable a user to connect their device or system account to Seam through your app, first create a `connect_webview`. Once created, this `connect_webview` includes a URL that you can use to open an [iframe](https://www.w3schools.com/html/html_iframe.asp) or new window containing the Connect Webview for your user.
|
|
71471
|
+
|
|
71472
|
+
When you create a Connect Webview, specify the desired provider category key in the `provider_category` parameter. Alternately, to specify a list of providers explicitly, use the `accepted_providers` parameter with a list of device provider keys.
|
|
71473
|
+
|
|
71474
|
+
To list all providers within a category, use `/devices/list_device_providers` with the desired `provider_category` filter. To list all provider keys, use `/devices/list_device_providers` with no filters. */
|
|
70902
71475
|
connect_webview: {
|
|
70903
71476
|
connect_webview_id: string;
|
|
70904
71477
|
workspace_id: string;
|
|
@@ -70931,6 +71504,7 @@ interface Routes {
|
|
|
70931
71504
|
method: 'DELETE' | 'POST';
|
|
70932
71505
|
queryParams: {};
|
|
70933
71506
|
jsonBody: {
|
|
71507
|
+
/** ID of the Connect Webview that you want to delete. */
|
|
70934
71508
|
connect_webview_id: string;
|
|
70935
71509
|
};
|
|
70936
71510
|
commonParams: {};
|
|
@@ -70943,11 +71517,22 @@ interface Routes {
|
|
|
70943
71517
|
queryParams: {};
|
|
70944
71518
|
jsonBody: {};
|
|
70945
71519
|
commonParams: {
|
|
71520
|
+
/** ID of the Connect Webview that you want to get. */
|
|
70946
71521
|
connect_webview_id: string;
|
|
70947
71522
|
};
|
|
70948
71523
|
formData: {};
|
|
70949
71524
|
jsonResponse: {
|
|
70950
|
-
/**
|
|
71525
|
+
/** Represents a [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews).
|
|
71526
|
+
|
|
71527
|
+
Connect Webviews are fully-embedded client-side components that you add to your app. Your users interact with your embedded Connect Webviews to link their IoT device or system accounts to Seam. That is, Connect Webviews walk your users through the process of logging in to their device or system accounts. Seam handles all the authentication steps, and—once your user has completed the authorization through your app—you can access and control their devices or systems using the Seam API.
|
|
71528
|
+
|
|
71529
|
+
Connect Webviews perform credential validation, multifactor authentication (when applicable), and error handling for each brand that Seam supports. Further, Connect Webviews work across all modern browsers and platforms, including Chrome, Safari, and Firefox.
|
|
71530
|
+
|
|
71531
|
+
To enable a user to connect their device or system account to Seam through your app, first create a `connect_webview`. Once created, this `connect_webview` includes a URL that you can use to open an [iframe](https://www.w3schools.com/html/html_iframe.asp) or new window containing the Connect Webview for your user.
|
|
71532
|
+
|
|
71533
|
+
When you create a Connect Webview, specify the desired provider category key in the `provider_category` parameter. Alternately, to specify a list of providers explicitly, use the `accepted_providers` parameter with a list of device provider keys.
|
|
71534
|
+
|
|
71535
|
+
To list all providers within a category, use `/devices/list_device_providers` with the desired `provider_category` filter. To list all provider keys, use `/devices/list_device_providers` with no filters. */
|
|
70951
71536
|
connect_webview: {
|
|
70952
71537
|
connect_webview_id: string;
|
|
70953
71538
|
workspace_id: string;
|
|
@@ -70981,10 +71566,11 @@ interface Routes {
|
|
|
70981
71566
|
queryParams: {};
|
|
70982
71567
|
jsonBody: {};
|
|
70983
71568
|
commonParams: {
|
|
70984
|
-
/**
|
|
71569
|
+
/** Your user ID for the user by which you want to filter Connect Webviews. */
|
|
70985
71570
|
user_identifier_key?: string | undefined;
|
|
70986
|
-
/**
|
|
71571
|
+
/** Custom metadata pairs by which you want to [filter Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews/filtering-connect-webviews-by-custom-metadata). Returns Connect Webviews with `custom_metadata` that contains all of the provided key:value pairs. */
|
|
70987
71572
|
custom_metadata_has?: Record<string, string | boolean> | undefined;
|
|
71573
|
+
/** Maximum number of records to return per page. */
|
|
70988
71574
|
limit?: number;
|
|
70989
71575
|
};
|
|
70990
71576
|
formData: {};
|
|
@@ -71021,7 +71607,9 @@ interface Routes {
|
|
|
71021
71607
|
method: 'DELETE' | 'POST';
|
|
71022
71608
|
queryParams: {};
|
|
71023
71609
|
jsonBody: {
|
|
71610
|
+
/** ID of the connected account that you want to delete. */
|
|
71024
71611
|
connected_account_id: string;
|
|
71612
|
+
/** */
|
|
71025
71613
|
sync?: boolean;
|
|
71026
71614
|
};
|
|
71027
71615
|
commonParams: {};
|
|
@@ -71034,13 +71622,15 @@ interface Routes {
|
|
|
71034
71622
|
queryParams: {};
|
|
71035
71623
|
jsonBody: {};
|
|
71036
71624
|
commonParams: {
|
|
71625
|
+
/** ID of the connected account that you want to get. */
|
|
71037
71626
|
connected_account_id: string;
|
|
71038
71627
|
} | {
|
|
71628
|
+
/** Email address associated with the connected account that you want to get. */
|
|
71039
71629
|
email: string;
|
|
71040
71630
|
};
|
|
71041
71631
|
formData: {};
|
|
71042
71632
|
jsonResponse: {
|
|
71043
|
-
/**
|
|
71633
|
+
/** 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. */
|
|
71044
71634
|
connected_account: {
|
|
71045
71635
|
connected_account_id?: string | undefined;
|
|
71046
71636
|
created_at?: string | undefined;
|
|
@@ -71132,9 +71722,9 @@ interface Routes {
|
|
|
71132
71722
|
queryParams: {};
|
|
71133
71723
|
jsonBody: {};
|
|
71134
71724
|
commonParams: {
|
|
71135
|
-
/**
|
|
71725
|
+
/** Your user ID for the user by which you want to filter connected accounts. */
|
|
71136
71726
|
user_identifier_key?: string | undefined;
|
|
71137
|
-
/** Returns accounts
|
|
71727
|
+
/** Custom metadata pairs by which you want to filter connected accounts. Returns connected accounts with `custom_metadata` that contains all of the provided key:value pairs. */
|
|
71138
71728
|
custom_metadata_has?: Record<string, string | boolean> | undefined;
|
|
71139
71729
|
customer_ids?: string[] | undefined;
|
|
71140
71730
|
/** Maximum number of records to return per page. */
|
|
@@ -71243,14 +71833,17 @@ interface Routes {
|
|
|
71243
71833
|
method: 'POST';
|
|
71244
71834
|
queryParams: {};
|
|
71245
71835
|
jsonBody: {
|
|
71836
|
+
/** ID of the connected account that you want to update. */
|
|
71246
71837
|
connected_account_id: string;
|
|
71838
|
+
/** Indicates whether newly-added devices should appear as [managed devices](https://docs.seam.co/latest/core-concepts/devices/managed-and-unmanaged-devices). */
|
|
71247
71839
|
automatically_manage_new_devices?: boolean | undefined;
|
|
71840
|
+
/** Custom metadata that you want to associate with the connected account. Supports up to 50 JSON key:value pairs. [Adding custom metadata to a connected account](https://docs.seam.co/latest/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account) enables you to store custom information, like customer details or internal IDs from your application. Then, you can [filter connected accounts by the desired metadata](https://docs.seam.co/latest/core-concepts/connected-accounts/filtering-connected-accounts-by-custom-metadata). */
|
|
71248
71841
|
custom_metadata?: Record<string, string | boolean | null> | undefined;
|
|
71249
71842
|
};
|
|
71250
71843
|
commonParams: {};
|
|
71251
71844
|
formData: {};
|
|
71252
71845
|
jsonResponse: {
|
|
71253
|
-
/**
|
|
71846
|
+
/** 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. */
|
|
71254
71847
|
connected_account: {
|
|
71255
71848
|
connected_account_id?: string | undefined;
|
|
71256
71849
|
created_at?: string | undefined;
|
|
@@ -71342,6 +71935,7 @@ interface Routes {
|
|
|
71342
71935
|
queryParams: {};
|
|
71343
71936
|
jsonBody: {};
|
|
71344
71937
|
commonParams: {
|
|
71938
|
+
/** ID of the device that you want to delete. */
|
|
71345
71939
|
device_id: string;
|
|
71346
71940
|
};
|
|
71347
71941
|
formData: {};
|
|
@@ -71353,12 +71947,14 @@ interface Routes {
|
|
|
71353
71947
|
queryParams: {};
|
|
71354
71948
|
jsonBody: {};
|
|
71355
71949
|
commonParams: {
|
|
71950
|
+
/** ID of the device that you want to get. */
|
|
71356
71951
|
device_id?: string | undefined;
|
|
71952
|
+
/** Name of the device that you want to get. */
|
|
71357
71953
|
name?: string | undefined;
|
|
71358
71954
|
};
|
|
71359
71955
|
formData: {};
|
|
71360
71956
|
jsonResponse: {
|
|
71361
|
-
/**
|
|
71957
|
+
/** Represents a [device](https://docs.seam.co/latest/core-concepts/devices) that has been connected to Seam. */
|
|
71362
71958
|
device: {
|
|
71363
71959
|
/** Unique identifier for the device. */
|
|
71364
71960
|
device_id: string;
|
|
@@ -71416,7 +72012,7 @@ interface Routes {
|
|
|
71416
72012
|
level: number;
|
|
71417
72013
|
status: 'critical' | 'low' | 'good' | 'full';
|
|
71418
72014
|
} | undefined;
|
|
71419
|
-
/** Manufacturer of the device. */
|
|
72015
|
+
/** Manufacturer of the device. When a device, such as a smart lock, is connected through a smart hub, the manufacturer of the device might be different from that of the smart hub. */
|
|
71420
72016
|
manufacturer?: string | undefined;
|
|
71421
72017
|
/** Image URL for the device. */
|
|
71422
72018
|
image_url?: string | undefined;
|
|
@@ -71695,6 +72291,7 @@ interface Routes {
|
|
|
71695
72291
|
} | undefined;
|
|
71696
72292
|
}) & ({
|
|
71697
72293
|
_experimental_supported_code_from_access_codes_lengths?: (number[] | undefined) | undefined;
|
|
72294
|
+
/** Constraints on access codes for the device. Seam represents each constraint as an object with a `constraint_type` property. Depending on the constraint type, there may also be additional properties. Note that some constraints are manufacturer- or device-specific. */
|
|
71698
72295
|
code_constraints?: (Array<{
|
|
71699
72296
|
constraint_type: 'no_zeros' | 'cannot_start_with_12' | 'no_triple_consecutive_ints' | 'cannot_specify_pin_code' | 'pin_code_matches_existing_set' | 'start_date_in_future' | 'no_ascending_or_descending_sequence' | 'at_least_three_unique_digits' | 'cannot_contain_089' | 'cannot_contain_0789';
|
|
71700
72297
|
} | {
|
|
@@ -72120,27 +72717,27 @@ interface Routes {
|
|
|
72120
72717
|
jsonBody: {};
|
|
72121
72718
|
commonParams: {
|
|
72122
72719
|
customer_ids?: string[] | undefined;
|
|
72123
|
-
/** ID of the connected account
|
|
72720
|
+
/** ID of the connected account for which you want to list devices. */
|
|
72124
72721
|
connected_account_id?: string | undefined;
|
|
72125
|
-
/** Array of IDs of the connected accounts
|
|
72722
|
+
/** Array of IDs of the connected accounts for which you want to list devices. */
|
|
72126
72723
|
connected_account_ids?: string[] | undefined;
|
|
72127
|
-
/** ID of the Connect Webview
|
|
72724
|
+
/** ID of the Connect Webview for which you want to list devices. */
|
|
72128
72725
|
connect_webview_id?: string | undefined;
|
|
72129
|
-
/** Device type
|
|
72726
|
+
/** Device type for which you want to list devices. */
|
|
72130
72727
|
device_type?: (('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;
|
|
72131
|
-
/** Array of device types
|
|
72728
|
+
/** Array of device types for which you want to list devices. */
|
|
72132
72729
|
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;
|
|
72133
|
-
/** Manufacturer
|
|
72730
|
+
/** Manufacturer for which you want to list devices. */
|
|
72134
72731
|
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' | 'smartthings' | 'dormakaba_oracode' | 'tedee' | 'akiles' | 'ecobee' | 'honeywell_resideo' | 'minut' | 'nest' | 'noiseaware' | 'tado' | 'sensi') | undefined;
|
|
72135
|
-
/** Array of device IDs
|
|
72732
|
+
/** Array of device IDs for which you want to list devices. */
|
|
72136
72733
|
device_ids?: string[] | undefined;
|
|
72137
72734
|
/** Numerical limit on the number of devices to return. */
|
|
72138
72735
|
limit?: number;
|
|
72139
|
-
/**
|
|
72736
|
+
/** Timestamp by which to limit returned devices. Returns devices created before this timestamp. */
|
|
72140
72737
|
created_before?: Date | undefined;
|
|
72141
|
-
/** Your own internal user ID for the user
|
|
72738
|
+
/** Your own internal user ID for the user for which you want to list devices. */
|
|
72142
72739
|
user_identifier_key?: string | undefined;
|
|
72143
|
-
/** Set of key:value [custom metadata](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device) pairs
|
|
72740
|
+
/** Set of key:value [custom metadata](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device) pairs for which you want to list devices. */
|
|
72144
72741
|
custom_metadata_has?: Record<string, string | boolean> | undefined;
|
|
72145
72742
|
/** Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`. */
|
|
72146
72743
|
page_cursor?: (string | undefined) | null;
|
|
@@ -72148,7 +72745,7 @@ interface Routes {
|
|
|
72148
72745
|
include_if?: Array<'can_remotely_unlock' | 'can_remotely_lock' | 'can_program_offline_access_codes' | 'can_program_online_access_codes' | 'can_hvac_heat' | 'can_hvac_cool' | 'can_hvac_heat_cool' | 'can_turn_off_hvac' | 'can_simulate_removal' | 'can_simulate_connection' | 'can_simulate_disconnection'> | undefined;
|
|
72149
72746
|
/** */
|
|
72150
72747
|
exclude_if?: Array<'can_remotely_unlock' | 'can_remotely_lock' | 'can_program_offline_access_codes' | 'can_program_online_access_codes' | 'can_hvac_heat' | 'can_hvac_cool' | 'can_hvac_heat_cool' | 'can_turn_off_hvac' | 'can_simulate_removal' | 'can_simulate_connection' | 'can_simulate_disconnection'> | undefined;
|
|
72151
|
-
/**
|
|
72748
|
+
/** ID of the location for which you want to list devices. */
|
|
72152
72749
|
unstable_location_id?: (string | null) | undefined;
|
|
72153
72750
|
};
|
|
72154
72751
|
formData: {};
|
|
@@ -72210,7 +72807,7 @@ interface Routes {
|
|
|
72210
72807
|
level: number;
|
|
72211
72808
|
status: 'critical' | 'low' | 'good' | 'full';
|
|
72212
72809
|
} | undefined;
|
|
72213
|
-
/** Manufacturer of the device. */
|
|
72810
|
+
/** Manufacturer of the device. When a device, such as a smart lock, is connected through a smart hub, the manufacturer of the device might be different from that of the smart hub. */
|
|
72214
72811
|
manufacturer?: string | undefined;
|
|
72215
72812
|
/** Image URL for the device. */
|
|
72216
72813
|
image_url?: string | undefined;
|
|
@@ -72489,6 +73086,7 @@ interface Routes {
|
|
|
72489
73086
|
} | undefined;
|
|
72490
73087
|
}) & ({
|
|
72491
73088
|
_experimental_supported_code_from_access_codes_lengths?: (number[] | undefined) | undefined;
|
|
73089
|
+
/** Constraints on access codes for the device. Seam represents each constraint as an object with a `constraint_type` property. Depending on the constraint type, there may also be additional properties. Note that some constraints are manufacturer- or device-specific. */
|
|
72492
73090
|
code_constraints?: (Array<{
|
|
72493
73091
|
constraint_type: 'no_zeros' | 'cannot_start_with_12' | 'no_triple_consecutive_ints' | 'cannot_specify_pin_code' | 'pin_code_matches_existing_set' | 'start_date_in_future' | 'no_ascending_or_descending_sequence' | 'at_least_three_unique_digits' | 'cannot_contain_089' | 'cannot_contain_0789';
|
|
72494
73092
|
} | {
|
|
@@ -72922,6 +73520,7 @@ interface Routes {
|
|
|
72922
73520
|
queryParams: {};
|
|
72923
73521
|
jsonBody: {};
|
|
72924
73522
|
commonParams: {
|
|
73523
|
+
/** Category for which you want to list providers. */
|
|
72925
73524
|
provider_category?: ('stable' | 'consumer_smartlocks' | 'thermostats' | 'noise_sensors' | 'access_control_systems') | undefined;
|
|
72926
73525
|
};
|
|
72927
73526
|
formData: {};
|
|
@@ -72950,6 +73549,7 @@ interface Routes {
|
|
|
72950
73549
|
method: 'POST';
|
|
72951
73550
|
queryParams: {};
|
|
72952
73551
|
jsonBody: {
|
|
73552
|
+
/** ID of the device that you want to simulate connecting to Seam. */
|
|
72953
73553
|
device_id: string;
|
|
72954
73554
|
};
|
|
72955
73555
|
commonParams: {};
|
|
@@ -72961,6 +73561,7 @@ interface Routes {
|
|
|
72961
73561
|
method: 'POST';
|
|
72962
73562
|
queryParams: {};
|
|
72963
73563
|
jsonBody: {
|
|
73564
|
+
/** ID of the device that you want to simulate disconnecting from Seam. */
|
|
72964
73565
|
device_id: string;
|
|
72965
73566
|
};
|
|
72966
73567
|
commonParams: {};
|
|
@@ -72972,6 +73573,7 @@ interface Routes {
|
|
|
72972
73573
|
method: 'DELETE' | 'POST';
|
|
72973
73574
|
queryParams: {};
|
|
72974
73575
|
jsonBody: {
|
|
73576
|
+
/** ID of the device that you want to simulate removing from Seam. */
|
|
72975
73577
|
device_id: string;
|
|
72976
73578
|
};
|
|
72977
73579
|
commonParams: {};
|
|
@@ -72984,12 +73586,14 @@ interface Routes {
|
|
|
72984
73586
|
queryParams: {};
|
|
72985
73587
|
jsonBody: {};
|
|
72986
73588
|
commonParams: {
|
|
73589
|
+
/** ID of the unmanaged device that you want to get. */
|
|
72987
73590
|
device_id?: string | undefined;
|
|
73591
|
+
/** Name of the unmanaged device that you want to get. */
|
|
72988
73592
|
name?: string | undefined;
|
|
72989
73593
|
};
|
|
72990
73594
|
formData: {};
|
|
72991
73595
|
jsonResponse: {
|
|
72992
|
-
/**
|
|
73596
|
+
/** Represents an [unmanaged device](https://docs.seam.co/latest/core-concepts/devices/managed-and-unmanaged-devices). An unmanaged device has a limited set of visible properties and a subset of supported events. You cannot control an unmanaged device. Any [access codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes) on an unmanaged device are unmanaged. To control an unmanaged device with Seam, [convert it to a managed device](https://docs.seam.co/latest/core-concepts/devices/managed-and-unmanaged-devices#convert-an-unmanaged-device-to-managed). */
|
|
72993
73597
|
device: {
|
|
72994
73598
|
/** Unique identifier for the device. */
|
|
72995
73599
|
device_id: string;
|
|
@@ -73211,7 +73815,7 @@ interface Routes {
|
|
|
73211
73815
|
name: string;
|
|
73212
73816
|
/** Indicates whether the device is online. */
|
|
73213
73817
|
online: boolean;
|
|
73214
|
-
/** Manufacturer of the device. */
|
|
73818
|
+
/** Manufacturer of the device. When a device, such as a smart lock, is connected through a smart hub, the manufacturer of the device might be different from that of the smart hub. */
|
|
73215
73819
|
manufacturer?: string | undefined;
|
|
73216
73820
|
/** Image URL for the device. */
|
|
73217
73821
|
image_url?: string | undefined;
|
|
@@ -73267,27 +73871,27 @@ interface Routes {
|
|
|
73267
73871
|
jsonBody: {};
|
|
73268
73872
|
commonParams: {
|
|
73269
73873
|
customer_ids?: string[] | undefined;
|
|
73270
|
-
/** ID of the connected account
|
|
73874
|
+
/** ID of the connected account for which you want to list devices. */
|
|
73271
73875
|
connected_account_id?: string | undefined;
|
|
73272
|
-
/** Array of IDs of the connected accounts
|
|
73876
|
+
/** Array of IDs of the connected accounts for which you want to list devices. */
|
|
73273
73877
|
connected_account_ids?: string[] | undefined;
|
|
73274
|
-
/** ID of the Connect Webview
|
|
73878
|
+
/** ID of the Connect Webview for which you want to list devices. */
|
|
73275
73879
|
connect_webview_id?: string | undefined;
|
|
73276
|
-
/** Device type
|
|
73880
|
+
/** Device type for which you want to list devices. */
|
|
73277
73881
|
device_type?: (('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;
|
|
73278
|
-
/** Array of device types
|
|
73882
|
+
/** Array of device types for which you want to list devices. */
|
|
73279
73883
|
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;
|
|
73280
|
-
/** Manufacturer
|
|
73884
|
+
/** Manufacturer for which you want to list devices. */
|
|
73281
73885
|
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' | 'smartthings' | 'dormakaba_oracode' | 'tedee' | 'akiles' | 'ecobee' | 'honeywell_resideo' | 'minut' | 'nest' | 'noiseaware' | 'tado' | 'sensi') | undefined;
|
|
73282
|
-
/** Array of device IDs
|
|
73886
|
+
/** Array of device IDs for which you want to list devices. */
|
|
73283
73887
|
device_ids?: string[] | undefined;
|
|
73284
73888
|
/** Numerical limit on the number of devices to return. */
|
|
73285
73889
|
limit?: number;
|
|
73286
|
-
/**
|
|
73890
|
+
/** Timestamp by which to limit returned devices. Returns devices created before this timestamp. */
|
|
73287
73891
|
created_before?: Date | undefined;
|
|
73288
|
-
/** Your own internal user ID for the user
|
|
73892
|
+
/** Your own internal user ID for the user for which you want to list devices. */
|
|
73289
73893
|
user_identifier_key?: string | undefined;
|
|
73290
|
-
/** Set of key:value [custom metadata](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device) pairs
|
|
73894
|
+
/** Set of key:value [custom metadata](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device) pairs for which you want to list devices. */
|
|
73291
73895
|
custom_metadata_has?: Record<string, string | boolean> | undefined;
|
|
73292
73896
|
/** Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`. */
|
|
73293
73897
|
page_cursor?: (string | undefined) | null;
|
|
@@ -73295,7 +73899,7 @@ interface Routes {
|
|
|
73295
73899
|
include_if?: Array<'can_remotely_unlock' | 'can_remotely_lock' | 'can_program_offline_access_codes' | 'can_program_online_access_codes' | 'can_hvac_heat' | 'can_hvac_cool' | 'can_hvac_heat_cool' | 'can_turn_off_hvac' | 'can_simulate_removal' | 'can_simulate_connection' | 'can_simulate_disconnection'> | undefined;
|
|
73296
73900
|
/** */
|
|
73297
73901
|
exclude_if?: Array<'can_remotely_unlock' | 'can_remotely_lock' | 'can_program_offline_access_codes' | 'can_program_online_access_codes' | 'can_hvac_heat' | 'can_hvac_cool' | 'can_hvac_heat_cool' | 'can_turn_off_hvac' | 'can_simulate_removal' | 'can_simulate_connection' | 'can_simulate_disconnection'> | undefined;
|
|
73298
|
-
/**
|
|
73902
|
+
/** ID of the location for which you want to list devices. */
|
|
73299
73903
|
unstable_location_id?: (string | null) | undefined;
|
|
73300
73904
|
};
|
|
73301
73905
|
formData: {};
|
|
@@ -73521,7 +74125,7 @@ interface Routes {
|
|
|
73521
74125
|
name: string;
|
|
73522
74126
|
/** Indicates whether the device is online. */
|
|
73523
74127
|
online: boolean;
|
|
73524
|
-
/** Manufacturer of the device. */
|
|
74128
|
+
/** Manufacturer of the device. When a device, such as a smart lock, is connected through a smart hub, the manufacturer of the device might be different from that of the smart hub. */
|
|
73525
74129
|
manufacturer?: string | undefined;
|
|
73526
74130
|
/** Image URL for the device. */
|
|
73527
74131
|
image_url?: string | undefined;
|
|
@@ -73576,7 +74180,9 @@ interface Routes {
|
|
|
73576
74180
|
queryParams: {};
|
|
73577
74181
|
jsonBody: {};
|
|
73578
74182
|
commonParams: {
|
|
74183
|
+
/** ID of the unmanaged device that you want to update. */
|
|
73579
74184
|
device_id: string;
|
|
74185
|
+
/** Indicates whether the device is managed. Set this parameter to `true` to convert an unmanaged device to managed. */
|
|
73580
74186
|
is_managed: true;
|
|
73581
74187
|
};
|
|
73582
74188
|
formData: {};
|
|
@@ -73588,12 +74194,17 @@ interface Routes {
|
|
|
73588
74194
|
queryParams: {};
|
|
73589
74195
|
jsonBody: {};
|
|
73590
74196
|
commonParams: {
|
|
74197
|
+
/** ID of the device that you want to update. */
|
|
73591
74198
|
device_id: string;
|
|
73592
74199
|
properties?: {
|
|
74200
|
+
/** Name for the device. */
|
|
73593
74201
|
name?: (string | null) | undefined;
|
|
73594
74202
|
} | undefined;
|
|
74203
|
+
/** Name for the device. */
|
|
73595
74204
|
name?: (string | null) | undefined;
|
|
74205
|
+
/** Indicates whether the device is managed. To unmanage a device, set `is_managed` to `false`. */
|
|
73596
74206
|
is_managed?: boolean;
|
|
74207
|
+
/** Custom metadata that you want to associate with the device. Supports up to 50 JSON key:value pairs. [Adding custom metadata to a 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. Then, you can [filter devices by the desired metadata](https://docs.seam.co/latest/core-concepts/devices/filtering-devices-by-custom-metadata). */
|
|
73597
74208
|
custom_metadata?: Record<string, string | boolean | null> | undefined;
|
|
73598
74209
|
};
|
|
73599
74210
|
formData: {};
|
|
@@ -73611,7 +74222,9 @@ interface Routes {
|
|
|
73611
74222
|
};
|
|
73612
74223
|
formData: {};
|
|
73613
74224
|
jsonResponse: {
|
|
73614
|
-
/**
|
|
74225
|
+
/** Represents an event. Events let you know when something interesting happens in your workspace. For example, when a lock is unlocked, Seam creates a `lock.unlocked` event. When a device's battery level is low, Seam creates a `device.battery_low` event.
|
|
74226
|
+
|
|
74227
|
+
As with other API resources, you can retrieve an individual event or a list of events. Seam also provides a separate [webhook](https://docs.seam.co/latest/developer-tools/webhooks) system for sending the event objects directly to an endpoint on your sever. Manage webhooks through [Seam Console](https://console.seam.co). You can also use the webhooks sandbox in Seam Console to see the different payloads for each event and test them against your own endpoints. */
|
|
73615
74228
|
event?: ({
|
|
73616
74229
|
/** ID of the event. */
|
|
73617
74230
|
event_id: string;
|
|
@@ -76375,7 +76988,7 @@ interface Routes {
|
|
|
76375
76988
|
};
|
|
76376
76989
|
formData: {};
|
|
76377
76990
|
jsonResponse: {
|
|
76378
|
-
/**
|
|
76991
|
+
/** Represents a [device](https://docs.seam.co/latest/core-concepts/devices) that has been connected to Seam. */
|
|
76379
76992
|
lock: {
|
|
76380
76993
|
/** Unique identifier for the device. */
|
|
76381
76994
|
device_id: string;
|
|
@@ -76433,7 +77046,7 @@ interface Routes {
|
|
|
76433
77046
|
level: number;
|
|
76434
77047
|
status: 'critical' | 'low' | 'good' | 'full';
|
|
76435
77048
|
} | undefined;
|
|
76436
|
-
/** Manufacturer of the device. */
|
|
77049
|
+
/** Manufacturer of the device. When a device, such as a smart lock, is connected through a smart hub, the manufacturer of the device might be different from that of the smart hub. */
|
|
76437
77050
|
manufacturer?: string | undefined;
|
|
76438
77051
|
/** Image URL for the device. */
|
|
76439
77052
|
image_url?: string | undefined;
|
|
@@ -76712,6 +77325,7 @@ interface Routes {
|
|
|
76712
77325
|
} | undefined;
|
|
76713
77326
|
}) & ({
|
|
76714
77327
|
_experimental_supported_code_from_access_codes_lengths?: (number[] | undefined) | undefined;
|
|
77328
|
+
/** Constraints on access codes for the device. Seam represents each constraint as an object with a `constraint_type` property. Depending on the constraint type, there may also be additional properties. Note that some constraints are manufacturer- or device-specific. */
|
|
76715
77329
|
code_constraints?: (Array<{
|
|
76716
77330
|
constraint_type: 'no_zeros' | 'cannot_start_with_12' | 'no_triple_consecutive_ints' | 'cannot_specify_pin_code' | 'pin_code_matches_existing_set' | 'start_date_in_future' | 'no_ascending_or_descending_sequence' | 'at_least_three_unique_digits' | 'cannot_contain_089' | 'cannot_contain_0789';
|
|
76717
77331
|
} | {
|
|
@@ -77128,7 +77742,7 @@ interface Routes {
|
|
|
77128
77742
|
can_simulate_connection?: boolean | undefined;
|
|
77129
77743
|
can_simulate_disconnection?: boolean | undefined;
|
|
77130
77744
|
};
|
|
77131
|
-
/**
|
|
77745
|
+
/** Represents a [device](https://docs.seam.co/latest/core-concepts/devices) that has been connected to Seam. */
|
|
77132
77746
|
device: {
|
|
77133
77747
|
/** Unique identifier for the device. */
|
|
77134
77748
|
device_id: string;
|
|
@@ -77186,7 +77800,7 @@ interface Routes {
|
|
|
77186
77800
|
level: number;
|
|
77187
77801
|
status: 'critical' | 'low' | 'good' | 'full';
|
|
77188
77802
|
} | undefined;
|
|
77189
|
-
/** Manufacturer of the device. */
|
|
77803
|
+
/** Manufacturer of the device. When a device, such as a smart lock, is connected through a smart hub, the manufacturer of the device might be different from that of the smart hub. */
|
|
77190
77804
|
manufacturer?: string | undefined;
|
|
77191
77805
|
/** Image URL for the device. */
|
|
77192
77806
|
image_url?: string | undefined;
|
|
@@ -77465,6 +78079,7 @@ interface Routes {
|
|
|
77465
78079
|
} | undefined;
|
|
77466
78080
|
}) & ({
|
|
77467
78081
|
_experimental_supported_code_from_access_codes_lengths?: (number[] | undefined) | undefined;
|
|
78082
|
+
/** Constraints on access codes for the device. Seam represents each constraint as an object with a `constraint_type` property. Depending on the constraint type, there may also be additional properties. Note that some constraints are manufacturer- or device-specific. */
|
|
77468
78083
|
code_constraints?: (Array<{
|
|
77469
78084
|
constraint_type: 'no_zeros' | 'cannot_start_with_12' | 'no_triple_consecutive_ints' | 'cannot_specify_pin_code' | 'pin_code_matches_existing_set' | 'start_date_in_future' | 'no_ascending_or_descending_sequence' | 'at_least_three_unique_digits' | 'cannot_contain_089' | 'cannot_contain_0789';
|
|
77470
78085
|
} | {
|
|
@@ -77890,11 +78505,11 @@ interface Routes {
|
|
|
77890
78505
|
jsonBody: {};
|
|
77891
78506
|
commonParams: {
|
|
77892
78507
|
customer_ids?: string[] | undefined;
|
|
77893
|
-
/** ID of the connected account
|
|
78508
|
+
/** ID of the connected account for which you want to list devices. */
|
|
77894
78509
|
connected_account_id?: string | undefined;
|
|
77895
|
-
/** Array of IDs of the connected accounts
|
|
78510
|
+
/** Array of IDs of the connected accounts for which you want to list devices. */
|
|
77896
78511
|
connected_account_ids?: string[] | undefined;
|
|
77897
|
-
/** ID of the Connect Webview
|
|
78512
|
+
/** ID of the Connect Webview for which you want to list devices. */
|
|
77898
78513
|
connect_webview_id?: string | undefined;
|
|
77899
78514
|
/** Device type by which to filter devices. */
|
|
77900
78515
|
device_type?: ('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;
|
|
@@ -77902,15 +78517,15 @@ interface Routes {
|
|
|
77902
78517
|
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;
|
|
77903
78518
|
/** Manufacturer by which to filter devices. */
|
|
77904
78519
|
manufacturer?: ('akuvox' | 'august' | 'brivo' | 'butterflymx' | 'avigilon_alta' | 'doorking' | 'genie' | 'igloo' | 'linear' | 'lockly' | 'kwikset' | 'nuki' | 'salto' | 'schlage' | 'seam' | 'smartthings' | 'wyze' | 'yale' | 'two_n' | 'controlbyweb' | 'ttlock' | 'igloohome' | 'hubitat' | 'four_suites' | 'dormakaba_oracode' | 'tedee' | 'akiles') | undefined;
|
|
77905
|
-
/** Array of device IDs
|
|
78520
|
+
/** Array of device IDs for which you want to list devices. */
|
|
77906
78521
|
device_ids?: string[] | undefined;
|
|
77907
78522
|
/** Numerical limit on the number of devices to return. */
|
|
77908
78523
|
limit?: number;
|
|
77909
|
-
/**
|
|
78524
|
+
/** Timestamp by which to limit returned devices. Returns devices created before this timestamp. */
|
|
77910
78525
|
created_before?: Date | undefined;
|
|
77911
|
-
/** Your own internal user ID for the user
|
|
78526
|
+
/** Your own internal user ID for the user for which you want to list devices. */
|
|
77912
78527
|
user_identifier_key?: string | undefined;
|
|
77913
|
-
/** Set of key:value [custom metadata](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device) pairs
|
|
78528
|
+
/** Set of key:value [custom metadata](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device) pairs for which you want to list devices. */
|
|
77914
78529
|
custom_metadata_has?: Record<string, string | boolean> | undefined;
|
|
77915
78530
|
/** Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`. */
|
|
77916
78531
|
page_cursor?: (string | undefined) | null;
|
|
@@ -77918,7 +78533,7 @@ interface Routes {
|
|
|
77918
78533
|
include_if?: Array<'can_remotely_unlock' | 'can_remotely_lock' | 'can_program_offline_access_codes' | 'can_program_online_access_codes' | 'can_hvac_heat' | 'can_hvac_cool' | 'can_hvac_heat_cool' | 'can_turn_off_hvac' | 'can_simulate_removal' | 'can_simulate_connection' | 'can_simulate_disconnection'> | undefined;
|
|
77919
78534
|
/** */
|
|
77920
78535
|
exclude_if?: Array<'can_remotely_unlock' | 'can_remotely_lock' | 'can_program_offline_access_codes' | 'can_program_online_access_codes' | 'can_hvac_heat' | 'can_hvac_cool' | 'can_hvac_heat_cool' | 'can_turn_off_hvac' | 'can_simulate_removal' | 'can_simulate_connection' | 'can_simulate_disconnection'> | undefined;
|
|
77921
|
-
/**
|
|
78536
|
+
/** ID of the location for which you want to list devices. */
|
|
77922
78537
|
unstable_location_id?: (string | null) | undefined;
|
|
77923
78538
|
};
|
|
77924
78539
|
formData: {};
|
|
@@ -77980,7 +78595,7 @@ interface Routes {
|
|
|
77980
78595
|
level: number;
|
|
77981
78596
|
status: 'critical' | 'low' | 'good' | 'full';
|
|
77982
78597
|
} | undefined;
|
|
77983
|
-
/** Manufacturer of the device. */
|
|
78598
|
+
/** Manufacturer of the device. When a device, such as a smart lock, is connected through a smart hub, the manufacturer of the device might be different from that of the smart hub. */
|
|
77984
78599
|
manufacturer?: string | undefined;
|
|
77985
78600
|
/** Image URL for the device. */
|
|
77986
78601
|
image_url?: string | undefined;
|
|
@@ -78259,6 +78874,7 @@ interface Routes {
|
|
|
78259
78874
|
} | undefined;
|
|
78260
78875
|
}) & ({
|
|
78261
78876
|
_experimental_supported_code_from_access_codes_lengths?: (number[] | undefined) | undefined;
|
|
78877
|
+
/** Constraints on access codes for the device. Seam represents each constraint as an object with a `constraint_type` property. Depending on the constraint type, there may also be additional properties. Note that some constraints are manufacturer- or device-specific. */
|
|
78262
78878
|
code_constraints?: (Array<{
|
|
78263
78879
|
constraint_type: 'no_zeros' | 'cannot_start_with_12' | 'no_triple_consecutive_ints' | 'cannot_specify_pin_code' | 'pin_code_matches_existing_set' | 'start_date_in_future' | 'no_ascending_or_descending_sequence' | 'at_least_three_unique_digits' | 'cannot_contain_089' | 'cannot_contain_0789';
|
|
78264
78880
|
} | {
|
|
@@ -78732,7 +79348,7 @@ interface Routes {
|
|
|
78732
79348
|
level: number;
|
|
78733
79349
|
status: 'critical' | 'low' | 'good' | 'full';
|
|
78734
79350
|
} | undefined;
|
|
78735
|
-
/** Manufacturer of the device. */
|
|
79351
|
+
/** Manufacturer of the device. When a device, such as a smart lock, is connected through a smart hub, the manufacturer of the device might be different from that of the smart hub. */
|
|
78736
79352
|
manufacturer?: string | undefined;
|
|
78737
79353
|
/** Image URL for the device. */
|
|
78738
79354
|
image_url?: string | undefined;
|
|
@@ -79011,6 +79627,7 @@ interface Routes {
|
|
|
79011
79627
|
} | undefined;
|
|
79012
79628
|
}) & ({
|
|
79013
79629
|
_experimental_supported_code_from_access_codes_lengths?: (number[] | undefined) | undefined;
|
|
79630
|
+
/** Constraints on access codes for the device. Seam represents each constraint as an object with a `constraint_type` property. Depending on the constraint type, there may also be additional properties. Note that some constraints are manufacturer- or device-specific. */
|
|
79014
79631
|
code_constraints?: (Array<{
|
|
79015
79632
|
constraint_type: 'no_zeros' | 'cannot_start_with_12' | 'no_triple_consecutive_ints' | 'cannot_specify_pin_code' | 'pin_code_matches_existing_set' | 'start_date_in_future' | 'no_ascending_or_descending_sequence' | 'at_least_three_unique_digits' | 'cannot_contain_089' | 'cannot_contain_0789';
|
|
79016
79633
|
} | {
|
|
@@ -83934,11 +84551,11 @@ interface Routes {
|
|
|
83934
84551
|
jsonBody: {};
|
|
83935
84552
|
commonParams: {
|
|
83936
84553
|
customer_ids?: string[] | undefined;
|
|
83937
|
-
/** ID of the connected account
|
|
84554
|
+
/** ID of the connected account for which you want to list devices. */
|
|
83938
84555
|
connected_account_id?: string | undefined;
|
|
83939
|
-
/** Array of IDs of the connected accounts
|
|
84556
|
+
/** Array of IDs of the connected accounts for which you want to list devices. */
|
|
83940
84557
|
connected_account_ids?: string[] | undefined;
|
|
83941
|
-
/** ID of the Connect Webview
|
|
84558
|
+
/** ID of the Connect Webview for which you want to list devices. */
|
|
83942
84559
|
connect_webview_id?: string | undefined;
|
|
83943
84560
|
/** Device type by which to filter devices. */
|
|
83944
84561
|
device_type?: ('noiseaware_activity_zone' | 'minut_sensor') | undefined;
|
|
@@ -83946,15 +84563,15 @@ interface Routes {
|
|
|
83946
84563
|
device_types?: Array<'noiseaware_activity_zone' | 'minut_sensor'> | undefined;
|
|
83947
84564
|
/** Manufacturer by which to filter devices. */
|
|
83948
84565
|
manufacturer?: ('minut' | 'noiseaware') | undefined;
|
|
83949
|
-
/** Array of device IDs
|
|
84566
|
+
/** Array of device IDs for which you want to list devices. */
|
|
83950
84567
|
device_ids?: string[] | undefined;
|
|
83951
84568
|
/** Numerical limit on the number of devices to return. */
|
|
83952
84569
|
limit?: number;
|
|
83953
|
-
/**
|
|
84570
|
+
/** Timestamp by which to limit returned devices. Returns devices created before this timestamp. */
|
|
83954
84571
|
created_before?: Date | undefined;
|
|
83955
|
-
/** Your own internal user ID for the user
|
|
84572
|
+
/** Your own internal user ID for the user for which you want to list devices. */
|
|
83956
84573
|
user_identifier_key?: string | undefined;
|
|
83957
|
-
/** Set of key:value [custom metadata](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device) pairs
|
|
84574
|
+
/** Set of key:value [custom metadata](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device) pairs for which you want to list devices. */
|
|
83958
84575
|
custom_metadata_has?: Record<string, string | boolean> | undefined;
|
|
83959
84576
|
/** Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`. */
|
|
83960
84577
|
page_cursor?: (string | undefined) | null;
|
|
@@ -83962,7 +84579,7 @@ interface Routes {
|
|
|
83962
84579
|
include_if?: Array<'can_remotely_unlock' | 'can_remotely_lock' | 'can_program_offline_access_codes' | 'can_program_online_access_codes' | 'can_hvac_heat' | 'can_hvac_cool' | 'can_hvac_heat_cool' | 'can_turn_off_hvac' | 'can_simulate_removal' | 'can_simulate_connection' | 'can_simulate_disconnection'> | undefined;
|
|
83963
84580
|
/** */
|
|
83964
84581
|
exclude_if?: Array<'can_remotely_unlock' | 'can_remotely_lock' | 'can_program_offline_access_codes' | 'can_program_online_access_codes' | 'can_hvac_heat' | 'can_hvac_cool' | 'can_hvac_heat_cool' | 'can_turn_off_hvac' | 'can_simulate_removal' | 'can_simulate_connection' | 'can_simulate_disconnection'> | undefined;
|
|
83965
|
-
/**
|
|
84582
|
+
/** ID of the location for which you want to list devices. */
|
|
83966
84583
|
unstable_location_id?: (string | null) | undefined;
|
|
83967
84584
|
};
|
|
83968
84585
|
formData: {};
|
|
@@ -84024,7 +84641,7 @@ interface Routes {
|
|
|
84024
84641
|
level: number;
|
|
84025
84642
|
status: 'critical' | 'low' | 'good' | 'full';
|
|
84026
84643
|
} | undefined;
|
|
84027
|
-
/** Manufacturer of the device. */
|
|
84644
|
+
/** Manufacturer of the device. When a device, such as a smart lock, is connected through a smart hub, the manufacturer of the device might be different from that of the smart hub. */
|
|
84028
84645
|
manufacturer?: string | undefined;
|
|
84029
84646
|
/** Image URL for the device. */
|
|
84030
84647
|
image_url?: string | undefined;
|
|
@@ -84303,6 +84920,7 @@ interface Routes {
|
|
|
84303
84920
|
} | undefined;
|
|
84304
84921
|
}) & ({
|
|
84305
84922
|
_experimental_supported_code_from_access_codes_lengths?: (number[] | undefined) | undefined;
|
|
84923
|
+
/** Constraints on access codes for the device. Seam represents each constraint as an object with a `constraint_type` property. Depending on the constraint type, there may also be additional properties. Note that some constraints are manufacturer- or device-specific. */
|
|
84306
84924
|
code_constraints?: (Array<{
|
|
84307
84925
|
constraint_type: 'no_zeros' | 'cannot_start_with_12' | 'no_triple_consecutive_ints' | 'cannot_specify_pin_code' | 'pin_code_matches_existing_set' | 'start_date_in_future' | 'no_ascending_or_descending_sequence' | 'at_least_three_unique_digits' | 'cannot_contain_089' | 'cannot_contain_0789';
|
|
84308
84926
|
} | {
|
|
@@ -84776,7 +85394,7 @@ interface Routes {
|
|
|
84776
85394
|
level: number;
|
|
84777
85395
|
status: 'critical' | 'low' | 'good' | 'full';
|
|
84778
85396
|
} | undefined;
|
|
84779
|
-
/** Manufacturer of the device. */
|
|
85397
|
+
/** Manufacturer of the device. When a device, such as a smart lock, is connected through a smart hub, the manufacturer of the device might be different from that of the smart hub. */
|
|
84780
85398
|
manufacturer?: string | undefined;
|
|
84781
85399
|
/** Image URL for the device. */
|
|
84782
85400
|
image_url?: string | undefined;
|
|
@@ -85055,6 +85673,7 @@ interface Routes {
|
|
|
85055
85673
|
} | undefined;
|
|
85056
85674
|
}) & ({
|
|
85057
85675
|
_experimental_supported_code_from_access_codes_lengths?: (number[] | undefined) | undefined;
|
|
85676
|
+
/** Constraints on access codes for the device. Seam represents each constraint as an object with a `constraint_type` property. Depending on the constraint type, there may also be additional properties. Note that some constraints are manufacturer- or device-specific. */
|
|
85058
85677
|
code_constraints?: (Array<{
|
|
85059
85678
|
constraint_type: 'no_zeros' | 'cannot_start_with_12' | 'no_triple_consecutive_ints' | 'cannot_specify_pin_code' | 'pin_code_matches_existing_set' | 'start_date_in_future' | 'no_ascending_or_descending_sequence' | 'at_least_three_unique_digits' | 'cannot_contain_089' | 'cannot_contain_0789';
|
|
85060
85679
|
} | {
|
|
@@ -89354,7 +89973,15 @@ interface Routes {
|
|
|
89354
89973
|
commonParams: {};
|
|
89355
89974
|
formData: {};
|
|
89356
89975
|
jsonResponse: {
|
|
89357
|
-
/**
|
|
89976
|
+
/** Represents a [client session](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens). If you want to restrict your users' access to their own devices, use client sessions.
|
|
89977
|
+
|
|
89978
|
+
You create each client session with a custom `user_identifier_key`. Normally, the `user_identifier_key` is a user ID that your application provides.
|
|
89979
|
+
|
|
89980
|
+
When calling the Seam API from your backend using an API key, you can pass the `user_identifier_key` as a parameter to limit results to the associated client session. For example, `/devices/list?user_identifier_key=123` only returns devices associated with the client session created with the `user_identifier_key` `123`.
|
|
89981
|
+
|
|
89982
|
+
A client session has a token that you can use with the Seam JavaScript SDK to make requests from the client (browser) directly to the Seam API. The token restricts the user's access to only the devices that they own.
|
|
89983
|
+
|
|
89984
|
+
See also [Get Started with React](https://docs.seam.co/latest/ui-components/overview/getting-started-with-seam-components/get-started-with-react-components-and-client-session-tokens). */
|
|
89358
89985
|
client_session: {
|
|
89359
89986
|
client_session_id: string;
|
|
89360
89987
|
workspace_id: string;
|
|
@@ -92969,7 +93596,7 @@ interface Routes {
|
|
|
92969
93596
|
};
|
|
92970
93597
|
formData: {};
|
|
92971
93598
|
jsonResponse: {
|
|
92972
|
-
/**
|
|
93599
|
+
/** Represents a [device](https://docs.seam.co/latest/core-concepts/devices) that has been connected to Seam. */
|
|
92973
93600
|
thermostat: {
|
|
92974
93601
|
/** Unique identifier for the device. */
|
|
92975
93602
|
device_id: string;
|
|
@@ -93027,7 +93654,7 @@ interface Routes {
|
|
|
93027
93654
|
level: number;
|
|
93028
93655
|
status: 'critical' | 'low' | 'good' | 'full';
|
|
93029
93656
|
} | undefined;
|
|
93030
|
-
/** Manufacturer of the device. */
|
|
93657
|
+
/** Manufacturer of the device. When a device, such as a smart lock, is connected through a smart hub, the manufacturer of the device might be different from that of the smart hub. */
|
|
93031
93658
|
manufacturer?: string | undefined;
|
|
93032
93659
|
/** Image URL for the device. */
|
|
93033
93660
|
image_url?: string | undefined;
|
|
@@ -93306,6 +93933,7 @@ interface Routes {
|
|
|
93306
93933
|
} | undefined;
|
|
93307
93934
|
}) & ({
|
|
93308
93935
|
_experimental_supported_code_from_access_codes_lengths?: (number[] | undefined) | undefined;
|
|
93936
|
+
/** Constraints on access codes for the device. Seam represents each constraint as an object with a `constraint_type` property. Depending on the constraint type, there may also be additional properties. Note that some constraints are manufacturer- or device-specific. */
|
|
93309
93937
|
code_constraints?: (Array<{
|
|
93310
93938
|
constraint_type: 'no_zeros' | 'cannot_start_with_12' | 'no_triple_consecutive_ints' | 'cannot_specify_pin_code' | 'pin_code_matches_existing_set' | 'start_date_in_future' | 'no_ascending_or_descending_sequence' | 'at_least_three_unique_digits' | 'cannot_contain_089' | 'cannot_contain_0789';
|
|
93311
93939
|
} | {
|
|
@@ -95979,11 +96607,11 @@ interface Routes {
|
|
|
95979
96607
|
jsonBody: {};
|
|
95980
96608
|
commonParams: {
|
|
95981
96609
|
customer_ids?: string[] | undefined;
|
|
95982
|
-
/** ID of the connected account
|
|
96610
|
+
/** ID of the connected account for which you want to list devices. */
|
|
95983
96611
|
connected_account_id?: string | undefined;
|
|
95984
|
-
/** Array of IDs of the connected accounts
|
|
96612
|
+
/** Array of IDs of the connected accounts for which you want to list devices. */
|
|
95985
96613
|
connected_account_ids?: string[] | undefined;
|
|
95986
|
-
/** ID of the Connect Webview
|
|
96614
|
+
/** ID of the Connect Webview for which you want to list devices. */
|
|
95987
96615
|
connect_webview_id?: string | undefined;
|
|
95988
96616
|
/** Device type by which to filter thermostat devices. */
|
|
95989
96617
|
device_type?: ('ecobee_thermostat' | 'nest_thermostat' | 'honeywell_resideo_thermostat' | 'tado_thermostat' | 'sensi_thermostat' | 'smartthings_thermostat') | undefined;
|
|
@@ -95991,15 +96619,15 @@ interface Routes {
|
|
|
95991
96619
|
device_types?: Array<'ecobee_thermostat' | 'nest_thermostat' | 'honeywell_resideo_thermostat' | 'tado_thermostat' | 'sensi_thermostat' | 'smartthings_thermostat'> | undefined;
|
|
95992
96620
|
/** Manufacturer by which to filter thermostat devices. */
|
|
95993
96621
|
manufacturer?: ('ecobee' | 'honeywell_resideo' | 'nest' | 'tado' | 'sensi') | undefined;
|
|
95994
|
-
/** Array of device IDs
|
|
96622
|
+
/** Array of device IDs for which you want to list devices. */
|
|
95995
96623
|
device_ids?: string[] | undefined;
|
|
95996
96624
|
/** Numerical limit on the number of devices to return. */
|
|
95997
96625
|
limit?: number;
|
|
95998
|
-
/**
|
|
96626
|
+
/** Timestamp by which to limit returned devices. Returns devices created before this timestamp. */
|
|
95999
96627
|
created_before?: Date | undefined;
|
|
96000
|
-
/** Your own internal user ID for the user
|
|
96628
|
+
/** Your own internal user ID for the user for which you want to list devices. */
|
|
96001
96629
|
user_identifier_key?: string | undefined;
|
|
96002
|
-
/** Set of key:value [custom metadata](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device) pairs
|
|
96630
|
+
/** Set of key:value [custom metadata](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device) pairs for which you want to list devices. */
|
|
96003
96631
|
custom_metadata_has?: Record<string, string | boolean> | undefined;
|
|
96004
96632
|
/** Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`. */
|
|
96005
96633
|
page_cursor?: (string | undefined) | null;
|
|
@@ -96007,7 +96635,7 @@ interface Routes {
|
|
|
96007
96635
|
include_if?: Array<'can_remotely_unlock' | 'can_remotely_lock' | 'can_program_offline_access_codes' | 'can_program_online_access_codes' | 'can_hvac_heat' | 'can_hvac_cool' | 'can_hvac_heat_cool' | 'can_turn_off_hvac' | 'can_simulate_removal' | 'can_simulate_connection' | 'can_simulate_disconnection'> | undefined;
|
|
96008
96636
|
/** */
|
|
96009
96637
|
exclude_if?: Array<'can_remotely_unlock' | 'can_remotely_lock' | 'can_program_offline_access_codes' | 'can_program_online_access_codes' | 'can_hvac_heat' | 'can_hvac_cool' | 'can_hvac_heat_cool' | 'can_turn_off_hvac' | 'can_simulate_removal' | 'can_simulate_connection' | 'can_simulate_disconnection'> | undefined;
|
|
96010
|
-
/**
|
|
96638
|
+
/** ID of the location for which you want to list devices. */
|
|
96011
96639
|
unstable_location_id?: (string | null) | undefined;
|
|
96012
96640
|
};
|
|
96013
96641
|
formData: {};
|
|
@@ -96069,7 +96697,7 @@ interface Routes {
|
|
|
96069
96697
|
level: number;
|
|
96070
96698
|
status: 'critical' | 'low' | 'good' | 'full';
|
|
96071
96699
|
} | undefined;
|
|
96072
|
-
/** Manufacturer of the device. */
|
|
96700
|
+
/** Manufacturer of the device. When a device, such as a smart lock, is connected through a smart hub, the manufacturer of the device might be different from that of the smart hub. */
|
|
96073
96701
|
manufacturer?: string | undefined;
|
|
96074
96702
|
/** Image URL for the device. */
|
|
96075
96703
|
image_url?: string | undefined;
|
|
@@ -96348,6 +96976,7 @@ interface Routes {
|
|
|
96348
96976
|
} | undefined;
|
|
96349
96977
|
}) & ({
|
|
96350
96978
|
_experimental_supported_code_from_access_codes_lengths?: (number[] | undefined) | undefined;
|
|
96979
|
+
/** Constraints on access codes for the device. Seam represents each constraint as an object with a `constraint_type` property. Depending on the constraint type, there may also be additional properties. Note that some constraints are manufacturer- or device-specific. */
|
|
96351
96980
|
code_constraints?: (Array<{
|
|
96352
96981
|
constraint_type: 'no_zeros' | 'cannot_start_with_12' | 'no_triple_consecutive_ints' | 'cannot_specify_pin_code' | 'pin_code_matches_existing_set' | 'start_date_in_future' | 'no_ascending_or_descending_sequence' | 'at_least_three_unique_digits' | 'cannot_contain_089' | 'cannot_contain_0789';
|
|
96353
96982
|
} | {
|
|
@@ -96821,7 +97450,7 @@ interface Routes {
|
|
|
96821
97450
|
level: number;
|
|
96822
97451
|
status: 'critical' | 'low' | 'good' | 'full';
|
|
96823
97452
|
} | undefined;
|
|
96824
|
-
/** Manufacturer of the device. */
|
|
97453
|
+
/** Manufacturer of the device. When a device, such as a smart lock, is connected through a smart hub, the manufacturer of the device might be different from that of the smart hub. */
|
|
96825
97454
|
manufacturer?: string | undefined;
|
|
96826
97455
|
/** Image URL for the device. */
|
|
96827
97456
|
image_url?: string | undefined;
|
|
@@ -97100,6 +97729,7 @@ interface Routes {
|
|
|
97100
97729
|
} | undefined;
|
|
97101
97730
|
}) & ({
|
|
97102
97731
|
_experimental_supported_code_from_access_codes_lengths?: (number[] | undefined) | undefined;
|
|
97732
|
+
/** Constraints on access codes for the device. Seam represents each constraint as an object with a `constraint_type` property. Depending on the constraint type, there may also be additional properties. Note that some constraints are manufacturer- or device-specific. */
|
|
97103
97733
|
code_constraints?: (Array<{
|
|
97104
97734
|
constraint_type: 'no_zeros' | 'cannot_start_with_12' | 'no_triple_consecutive_ints' | 'cannot_specify_pin_code' | 'pin_code_matches_existing_set' | 'start_date_in_future' | 'no_ascending_or_descending_sequence' | 'at_least_three_unique_digits' | 'cannot_contain_089' | 'cannot_contain_0789';
|
|
97105
97735
|
} | {
|
|
@@ -102752,6 +103382,43 @@ interface Routes {
|
|
|
102752
103382
|
};
|
|
102753
103383
|
};
|
|
102754
103384
|
};
|
|
103385
|
+
'/unstable_partner/resources/push': {
|
|
103386
|
+
route: '/unstable_partner/resources/push';
|
|
103387
|
+
method: 'POST';
|
|
103388
|
+
queryParams: {};
|
|
103389
|
+
jsonBody: Array<{
|
|
103390
|
+
partner_resource_type?: string | undefined;
|
|
103391
|
+
partner_resource_key?: string | undefined;
|
|
103392
|
+
customer_key?: string | undefined;
|
|
103393
|
+
email_address?: string | undefined;
|
|
103394
|
+
phone_number?: string | undefined;
|
|
103395
|
+
starts_at?: string | undefined;
|
|
103396
|
+
ends_at?: string | undefined;
|
|
103397
|
+
user_identity_key?: string | undefined;
|
|
103398
|
+
location_keys?: string[] | undefined;
|
|
103399
|
+
name?: string | undefined;
|
|
103400
|
+
description?: string | undefined;
|
|
103401
|
+
icon_url?: string | undefined;
|
|
103402
|
+
custom_metadata?: Record<string, string> | undefined;
|
|
103403
|
+
}> | {
|
|
103404
|
+
partner_resource_type?: string | undefined;
|
|
103405
|
+
partner_resource_key?: string | undefined;
|
|
103406
|
+
customer_key?: string | undefined;
|
|
103407
|
+
email_address?: string | undefined;
|
|
103408
|
+
phone_number?: string | undefined;
|
|
103409
|
+
starts_at?: string | undefined;
|
|
103410
|
+
ends_at?: string | undefined;
|
|
103411
|
+
user_identity_key?: string | undefined;
|
|
103412
|
+
location_keys?: string[] | undefined;
|
|
103413
|
+
name?: string | undefined;
|
|
103414
|
+
description?: string | undefined;
|
|
103415
|
+
icon_url?: string | undefined;
|
|
103416
|
+
custom_metadata?: Record<string, string> | undefined;
|
|
103417
|
+
};
|
|
103418
|
+
commonParams: {};
|
|
103419
|
+
formData: {};
|
|
103420
|
+
jsonResponse: {};
|
|
103421
|
+
};
|
|
102755
103422
|
'/user_identities/add_acs_user': {
|
|
102756
103423
|
route: '/user_identities/add_acs_user';
|
|
102757
103424
|
method: 'POST' | 'PUT';
|
|
@@ -102785,7 +103452,7 @@ interface Routes {
|
|
|
102785
103452
|
};
|
|
102786
103453
|
formData: {};
|
|
102787
103454
|
jsonResponse: {
|
|
102788
|
-
/** Represents a [user identity](https://docs.seam.co/latest/capability-guides/mobile-access
|
|
103455
|
+
/** Represents a [user identity](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) associated with an application user account. */
|
|
102789
103456
|
user_identity: {
|
|
102790
103457
|
/** ID of the user identity. */
|
|
102791
103458
|
user_identity_id: string;
|
|
@@ -102946,7 +103613,7 @@ interface Routes {
|
|
|
102946
103613
|
};
|
|
102947
103614
|
formData: {};
|
|
102948
103615
|
jsonResponse: {
|
|
102949
|
-
/** Represents a [user identity](https://docs.seam.co/latest/capability-guides/mobile-access
|
|
103616
|
+
/** Represents a [user identity](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) associated with an application user account. */
|
|
102950
103617
|
user_identity: {
|
|
102951
103618
|
/** ID of the user identity. */
|
|
102952
103619
|
user_identity_id: string;
|
|
@@ -103075,7 +103742,7 @@ interface Routes {
|
|
|
103075
103742
|
level: number;
|
|
103076
103743
|
status: 'critical' | 'low' | 'good' | 'full';
|
|
103077
103744
|
} | undefined;
|
|
103078
|
-
/** Manufacturer of the device. */
|
|
103745
|
+
/** Manufacturer of the device. When a device, such as a smart lock, is connected through a smart hub, the manufacturer of the device might be different from that of the smart hub. */
|
|
103079
103746
|
manufacturer?: string | undefined;
|
|
103080
103747
|
/** Image URL for the device. */
|
|
103081
103748
|
image_url?: string | undefined;
|
|
@@ -103354,6 +104021,7 @@ interface Routes {
|
|
|
103354
104021
|
} | undefined;
|
|
103355
104022
|
}) & ({
|
|
103356
104023
|
_experimental_supported_code_from_access_codes_lengths?: (number[] | undefined) | undefined;
|
|
104024
|
+
/** Constraints on access codes for the device. Seam represents each constraint as an object with a `constraint_type` property. Depending on the constraint type, there may also be additional properties. Note that some constraints are manufacturer- or device-specific. */
|
|
103357
104025
|
code_constraints?: (Array<{
|
|
103358
104026
|
constraint_type: 'no_zeros' | 'cannot_start_with_12' | 'no_triple_consecutive_ints' | 'cannot_specify_pin_code' | 'pin_code_matches_existing_set' | 'start_date_in_future' | 'no_ascending_or_descending_sequence' | 'at_least_three_unique_digits' | 'cannot_contain_089' | 'cannot_contain_0789';
|
|
103359
104027
|
} | {
|
|
@@ -103829,7 +104497,7 @@ interface Routes {
|
|
|
103829
104497
|
level: number;
|
|
103830
104498
|
status: 'critical' | 'low' | 'good' | 'full';
|
|
103831
104499
|
} | undefined;
|
|
103832
|
-
/** Manufacturer of the device. */
|
|
104500
|
+
/** Manufacturer of the device. When a device, such as a smart lock, is connected through a smart hub, the manufacturer of the device might be different from that of the smart hub. */
|
|
103833
104501
|
manufacturer?: string | undefined;
|
|
103834
104502
|
/** Image URL for the device. */
|
|
103835
104503
|
image_url?: string | undefined;
|
|
@@ -104108,6 +104776,7 @@ interface Routes {
|
|
|
104108
104776
|
} | undefined;
|
|
104109
104777
|
}) & ({
|
|
104110
104778
|
_experimental_supported_code_from_access_codes_lengths?: (number[] | undefined) | undefined;
|
|
104779
|
+
/** Constraints on access codes for the device. Seam represents each constraint as an object with a `constraint_type` property. Depending on the constraint type, there may also be additional properties. Note that some constraints are manufacturer- or device-specific. */
|
|
104111
104780
|
code_constraints?: (Array<{
|
|
104112
104781
|
constraint_type: 'no_zeros' | 'cannot_start_with_12' | 'no_triple_consecutive_ints' | 'cannot_specify_pin_code' | 'pin_code_matches_existing_set' | 'start_date_in_future' | 'no_ascending_or_descending_sequence' | 'at_least_three_unique_digits' | 'cannot_contain_089' | 'cannot_contain_0789';
|
|
104113
104782
|
} | {
|
|
@@ -105024,7 +105693,7 @@ interface Routes {
|
|
|
105024
105693
|
commonParams: {};
|
|
105025
105694
|
formData: {};
|
|
105026
105695
|
jsonResponse: {
|
|
105027
|
-
/**
|
|
105696
|
+
/** Represents a Seam [workspace](https://docs.seam.co/latest/core-concepts/workspaces). A workspace is a top-level entity that encompasses all other resources below it, such as devices, connected accounts, and Connect Webviews. Seam provides two types of workspaces. A [sandbox workspace](https://docs.seam.co/latest/core-concepts/workspaces#sandbox-workspaces) is a special type of workspace designed for testing code. Sandbox workspaces offer test device accounts and virtual devices that you can connect and control. This ability to work with virtual devices is quite handy because it removes the need to own physical devices from multiple brands. To connect real devices and systems to Seam, use a [production workspace](https://docs.seam.co/latest/core-concepts/workspaces#production-workspaces). */
|
|
105028
105697
|
workspace: {
|
|
105029
105698
|
workspace_id: string;
|
|
105030
105699
|
name: string;
|
|
@@ -105053,7 +105722,7 @@ interface Routes {
|
|
|
105053
105722
|
commonParams: {};
|
|
105054
105723
|
formData: {};
|
|
105055
105724
|
jsonResponse: {
|
|
105056
|
-
/**
|
|
105725
|
+
/** Represents a Seam [workspace](https://docs.seam.co/latest/core-concepts/workspaces). A workspace is a top-level entity that encompasses all other resources below it, such as devices, connected accounts, and Connect Webviews. Seam provides two types of workspaces. A [sandbox workspace](https://docs.seam.co/latest/core-concepts/workspaces#sandbox-workspaces) is a special type of workspace designed for testing code. Sandbox workspaces offer test device accounts and virtual devices that you can connect and control. This ability to work with virtual devices is quite handy because it removes the need to own physical devices from multiple brands. To connect real devices and systems to Seam, use a [production workspace](https://docs.seam.co/latest/core-concepts/workspaces#production-workspaces). */
|
|
105057
105726
|
workspace: {
|
|
105058
105727
|
workspace_id: string;
|
|
105059
105728
|
name: string;
|