@seamapi/types 1.398.0 → 1.399.1

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.
Files changed (42) hide show
  1. package/dist/connect.cjs +886 -294
  2. package/dist/connect.cjs.map +1 -1
  3. package/dist/connect.d.cts +848 -177
  4. package/lib/seam/connect/models/access-codes/managed-access-code.js +8 -2
  5. package/lib/seam/connect/models/access-codes/managed-access-code.js.map +1 -1
  6. package/lib/seam/connect/models/access-codes/unmanaged-access-code.js +4 -0
  7. package/lib/seam/connect/models/access-codes/unmanaged-access-code.js.map +1 -1
  8. package/lib/seam/connect/models/client-sessions/client-session.js +9 -0
  9. package/lib/seam/connect/models/client-sessions/client-session.js.map +1 -1
  10. package/lib/seam/connect/models/connect-webviews/connect-webview.js +13 -0
  11. package/lib/seam/connect/models/connect-webviews/connect-webview.js.map +1 -1
  12. package/lib/seam/connect/models/connected-accounts/connected-account.js +1 -0
  13. package/lib/seam/connect/models/connected-accounts/connected-account.js.map +1 -1
  14. package/lib/seam/connect/models/devices/capability-properties/access-code.js +4 -1
  15. package/lib/seam/connect/models/devices/capability-properties/access-code.js.map +1 -1
  16. package/lib/seam/connect/models/devices/device.js +5 -1
  17. package/lib/seam/connect/models/devices/device.js.map +1 -1
  18. package/lib/seam/connect/models/devices/unmanaged-device.js +1 -0
  19. package/lib/seam/connect/models/devices/unmanaged-device.js.map +1 -1
  20. package/lib/seam/connect/models/events/seam-event.js +3 -0
  21. package/lib/seam/connect/models/events/seam-event.js.map +1 -1
  22. package/lib/seam/connect/models/user-identities/user-identity.js +1 -1
  23. package/lib/seam/connect/models/workspaces/workspace.js +1 -0
  24. package/lib/seam/connect/models/workspaces/workspace.js.map +1 -1
  25. package/lib/seam/connect/openapi.d.ts +381 -0
  26. package/lib/seam/connect/openapi.js +804 -255
  27. package/lib/seam/connect/openapi.js.map +1 -1
  28. package/lib/seam/connect/route-types.d.ts +467 -177
  29. package/package.json +1 -1
  30. package/src/lib/seam/connect/models/access-codes/managed-access-code.ts +8 -2
  31. package/src/lib/seam/connect/models/access-codes/unmanaged-access-code.ts +4 -0
  32. package/src/lib/seam/connect/models/client-sessions/client-session.ts +9 -0
  33. package/src/lib/seam/connect/models/connect-webviews/connect-webview.ts +13 -0
  34. package/src/lib/seam/connect/models/connected-accounts/connected-account.ts +1 -0
  35. package/src/lib/seam/connect/models/devices/capability-properties/access-code.ts +6 -1
  36. package/src/lib/seam/connect/models/devices/device.ts +7 -1
  37. package/src/lib/seam/connect/models/devices/unmanaged-device.ts +1 -0
  38. package/src/lib/seam/connect/models/events/seam-event.ts +3 -0
  39. package/src/lib/seam/connect/models/user-identities/user-identity.ts +1 -1
  40. package/src/lib/seam/connect/models/workspaces/workspace.ts +1 -0
  41. package/src/lib/seam/connect/openapi.ts +1007 -255
  42. package/src/lib/seam/connect/route-types.ts +469 -177
@@ -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': {
@@ -34317,6 +34330,7 @@ declare const _default: {
34317
34330
  'x-fern-sdk-method-name': string;
34318
34331
  'x-fern-sdk-return-value': string;
34319
34332
  'x-response-key': string;
34333
+ 'x-title': string;
34320
34334
  'x-undocumented': string;
34321
34335
  };
34322
34336
  };
@@ -34394,11 +34408,13 @@ declare const _default: {
34394
34408
  'x-fern-sdk-method-name': string;
34395
34409
  'x-fern-sdk-return-value': string;
34396
34410
  'x-response-key': string;
34411
+ 'x-title': string;
34397
34412
  'x-undocumented': string;
34398
34413
  };
34399
34414
  };
34400
34415
  '/acs/credential_pools/list': {
34401
34416
  post: {
34417
+ description: string;
34402
34418
  operationId: string;
34403
34419
  requestBody: {
34404
34420
  content: {
@@ -34406,6 +34422,7 @@ declare const _default: {
34406
34422
  schema: {
34407
34423
  properties: {
34408
34424
  acs_system_id: {
34425
+ description: string;
34409
34426
  format: string;
34410
34427
  type: string;
34411
34428
  };
@@ -34466,11 +34483,13 @@ declare const _default: {
34466
34483
  'x-fern-sdk-method-name': string;
34467
34484
  'x-fern-sdk-return-value': string;
34468
34485
  'x-response-key': string;
34486
+ 'x-title': string;
34469
34487
  'x-undocumented': string;
34470
34488
  };
34471
34489
  };
34472
34490
  '/acs/credential_provisioning_automations/launch': {
34473
34491
  post: {
34492
+ description: string;
34474
34493
  operationId: string;
34475
34494
  requestBody: {
34476
34495
  content: {
@@ -34478,21 +34497,26 @@ declare const _default: {
34478
34497
  schema: {
34479
34498
  properties: {
34480
34499
  acs_credential_pool_id: {
34500
+ description: string;
34481
34501
  format: string;
34482
34502
  type: string;
34483
34503
  };
34484
34504
  create_credential_manager_user: {
34505
+ description: string;
34485
34506
  type: string;
34486
34507
  };
34487
34508
  credential_manager_acs_system_id: {
34509
+ description: string;
34488
34510
  format: string;
34489
34511
  type: string;
34490
34512
  };
34491
34513
  credential_manager_acs_user_id: {
34514
+ description: string;
34492
34515
  format: string;
34493
34516
  type: string;
34494
34517
  };
34495
34518
  user_identity_id: {
34519
+ description: string;
34496
34520
  format: string;
34497
34521
  type: string;
34498
34522
  };
@@ -34550,6 +34574,7 @@ declare const _default: {
34550
34574
  'x-fern-sdk-method-name': string;
34551
34575
  'x-fern-sdk-return-value': string;
34552
34576
  'x-response-key': string;
34577
+ 'x-title': string;
34553
34578
  'x-undocumented': string;
34554
34579
  };
34555
34580
  };
@@ -34712,6 +34737,11 @@ declare const _default: {
34712
34737
  enum: string[];
34713
34738
  type: string;
34714
34739
  };
34740
+ acs_system_id: {
34741
+ description: string;
34742
+ format: string;
34743
+ type: string;
34744
+ };
34715
34745
  acs_user_id: {
34716
34746
  description: string;
34717
34747
  format: string;
@@ -34772,9 +34802,11 @@ declare const _default: {
34772
34802
  description: string;
34773
34803
  properties: {
34774
34804
  assign_new_key: {
34805
+ description: string;
34775
34806
  type: string;
34776
34807
  };
34777
34808
  update_current_key: {
34809
+ description: string;
34778
34810
  type: string;
34779
34811
  };
34780
34812
  };
@@ -34785,6 +34817,11 @@ declare const _default: {
34785
34817
  format: string;
34786
34818
  type: string;
34787
34819
  };
34820
+ user_identity_id: {
34821
+ description: string;
34822
+ format: string;
34823
+ type: string;
34824
+ };
34788
34825
  visionline_metadata: {
34789
34826
  description: string;
34790
34827
  properties: {
@@ -35564,6 +35601,7 @@ declare const _default: {
35564
35601
  'application/json': {
35565
35602
  schema: {
35566
35603
  oneOf: ({
35604
+ description: string;
35567
35605
  properties: {
35568
35606
  acs_user_id: {
35569
35607
  description: string;
@@ -35576,6 +35614,7 @@ declare const _default: {
35576
35614
  required: string[];
35577
35615
  type: string;
35578
35616
  } | {
35617
+ description: string;
35579
35618
  properties: {
35580
35619
  acs_system_id: {
35581
35620
  description: string;
@@ -35588,6 +35627,7 @@ declare const _default: {
35588
35627
  required: string[];
35589
35628
  type: string;
35590
35629
  } | {
35630
+ description: string;
35591
35631
  properties: {
35592
35632
  acs_system_id: {
35593
35633
  description: string;
@@ -35604,6 +35644,7 @@ declare const _default: {
35604
35644
  required: string[];
35605
35645
  type: string;
35606
35646
  } | {
35647
+ description: string;
35607
35648
  properties: {
35608
35649
  user_identity_id: {
35609
35650
  description: string;
@@ -36618,6 +36659,7 @@ declare const _default: {
36618
36659
  schema: {
36619
36660
  properties: {
36620
36661
  acs_entrance_id: {
36662
+ description: string;
36621
36663
  format: string;
36622
36664
  type: string;
36623
36665
  };
@@ -36687,6 +36729,7 @@ declare const _default: {
36687
36729
  };
36688
36730
  '/acs/entrances/grant_access': {
36689
36731
  post: {
36732
+ description: string;
36690
36733
  operationId: string;
36691
36734
  requestBody: {
36692
36735
  content: {
@@ -36694,10 +36737,12 @@ declare const _default: {
36694
36737
  schema: {
36695
36738
  properties: {
36696
36739
  acs_entrance_id: {
36740
+ description: string;
36697
36741
  format: string;
36698
36742
  type: string;
36699
36743
  };
36700
36744
  acs_user_id: {
36745
+ description: string;
36701
36746
  format: string;
36702
36747
  type: string;
36703
36748
  };
@@ -36763,14 +36808,17 @@ declare const _default: {
36763
36808
  schema: {
36764
36809
  properties: {
36765
36810
  acs_credential_id: {
36811
+ description: string;
36766
36812
  format: string;
36767
36813
  type: string;
36768
36814
  };
36769
36815
  acs_system_id: {
36816
+ description: string;
36770
36817
  format: string;
36771
36818
  type: string;
36772
36819
  };
36773
36820
  location_id: {
36821
+ description: string;
36774
36822
  format: string;
36775
36823
  nullable: boolean;
36776
36824
  type: string;
@@ -36852,10 +36900,12 @@ declare const _default: {
36852
36900
  schema: {
36853
36901
  properties: {
36854
36902
  acs_entrance_id: {
36903
+ description: string;
36855
36904
  format: string;
36856
36905
  type: string;
36857
36906
  };
36858
36907
  include_if: {
36908
+ description: string;
36859
36909
  items: {
36860
36910
  enum: string[];
36861
36911
  type: string;
@@ -37304,11 +37354,13 @@ declare const _default: {
37304
37354
  description: string;
37305
37355
  properties: {
37306
37356
  ends_at: {
37357
+ description: string;
37307
37358
  format: string;
37308
37359
  nullable: boolean;
37309
37360
  type: string;
37310
37361
  };
37311
37362
  starts_at: {
37363
+ description: string;
37312
37364
  format: string;
37313
37365
  type: string;
37314
37366
  };
@@ -37560,6 +37612,7 @@ declare const _default: {
37560
37612
  type: string;
37561
37613
  };
37562
37614
  created_before: {
37615
+ description: string;
37563
37616
  format: string;
37564
37617
  type: string;
37565
37618
  };
@@ -37948,6 +38001,7 @@ declare const _default: {
37948
38001
  };
37949
38002
  '/acs/users/unmanaged/get': {
37950
38003
  post: {
38004
+ description: string;
37951
38005
  operationId: string;
37952
38006
  requestBody: {
37953
38007
  content: {
@@ -37955,6 +38009,7 @@ declare const _default: {
37955
38009
  schema: {
37956
38010
  properties: {
37957
38011
  acs_user_id: {
38012
+ description: string;
37958
38013
  format: string;
37959
38014
  type: string;
37960
38015
  };
@@ -38011,11 +38066,13 @@ declare const _default: {
38011
38066
  'x-fern-sdk-method-name': string;
38012
38067
  'x-fern-sdk-return-value': string;
38013
38068
  'x-response-key': string;
38069
+ 'x-title': string;
38014
38070
  'x-undocumented': string;
38015
38071
  };
38016
38072
  };
38017
38073
  '/acs/users/unmanaged/list': {
38018
38074
  post: {
38075
+ description: string;
38019
38076
  operationId: string;
38020
38077
  requestBody: {
38021
38078
  content: {
@@ -38023,22 +38080,27 @@ declare const _default: {
38023
38080
  schema: {
38024
38081
  properties: {
38025
38082
  acs_system_id: {
38083
+ description: string;
38026
38084
  format: string;
38027
38085
  type: string;
38028
38086
  };
38029
38087
  limit: {
38030
38088
  default: number;
38089
+ description: string;
38031
38090
  format: string;
38032
38091
  type: string;
38033
38092
  };
38034
38093
  user_identity_email_address: {
38094
+ description: string;
38035
38095
  type: string;
38036
38096
  };
38037
38097
  user_identity_id: {
38098
+ description: string;
38038
38099
  format: string;
38039
38100
  type: string;
38040
38101
  };
38041
38102
  user_identity_phone_number: {
38103
+ description: string;
38042
38104
  type: string;
38043
38105
  };
38044
38106
  };
@@ -38096,6 +38158,7 @@ declare const _default: {
38096
38158
  'x-fern-sdk-method-name': string;
38097
38159
  'x-fern-sdk-return-value': string;
38098
38160
  'x-response-key': string;
38161
+ 'x-title': string;
38099
38162
  'x-undocumented': string;
38100
38163
  };
38101
38164
  };
@@ -38179,10 +38242,12 @@ declare const _default: {
38179
38242
  nullable: boolean;
38180
38243
  properties: {
38181
38244
  ends_at: {
38245
+ description: string;
38182
38246
  format: string;
38183
38247
  type: string;
38184
38248
  };
38185
38249
  starts_at: {
38250
+ description: string;
38186
38251
  format: string;
38187
38252
  type: string;
38188
38253
  };
@@ -38282,10 +38347,12 @@ declare const _default: {
38282
38347
  nullable: boolean;
38283
38348
  properties: {
38284
38349
  ends_at: {
38350
+ description: string;
38285
38351
  format: string;
38286
38352
  type: string;
38287
38353
  };
38288
38354
  starts_at: {
38355
+ description: string;
38289
38356
  format: string;
38290
38357
  type: string;
38291
38358
  };
@@ -38376,6 +38443,7 @@ declare const _default: {
38376
38443
  };
38377
38444
  '/action_attempts/get': {
38378
38445
  post: {
38446
+ description: string;
38379
38447
  operationId: string;
38380
38448
  requestBody: {
38381
38449
  content: {
@@ -38383,6 +38451,7 @@ declare const _default: {
38383
38451
  schema: {
38384
38452
  properties: {
38385
38453
  action_attempt_id: {
38454
+ description: string;
38386
38455
  format: string;
38387
38456
  type: string;
38388
38457
  };
@@ -38447,10 +38516,12 @@ declare const _default: {
38447
38516
  'x-fern-sdk-method-name': string;
38448
38517
  'x-fern-sdk-return-value': string;
38449
38518
  'x-response-key': string;
38519
+ 'x-title': string;
38450
38520
  };
38451
38521
  };
38452
38522
  '/action_attempts/list': {
38453
38523
  post: {
38524
+ description: string;
38454
38525
  operationId: string;
38455
38526
  requestBody: {
38456
38527
  content: {
@@ -38458,6 +38529,7 @@ declare const _default: {
38458
38529
  schema: {
38459
38530
  properties: {
38460
38531
  action_attempt_ids: {
38532
+ description: string;
38461
38533
  items: {
38462
38534
  format: string;
38463
38535
  type: string;
@@ -38520,10 +38592,12 @@ declare const _default: {
38520
38592
  'x-fern-sdk-method-name': string;
38521
38593
  'x-fern-sdk-return-value': string;
38522
38594
  'x-response-key': string;
38595
+ 'x-title': string;
38523
38596
  };
38524
38597
  };
38525
38598
  '/bridges/get': {
38526
38599
  post: {
38600
+ description: string;
38527
38601
  operationId: string;
38528
38602
  requestBody: {
38529
38603
  content: {
@@ -38531,6 +38605,7 @@ declare const _default: {
38531
38605
  schema: {
38532
38606
  properties: {
38533
38607
  bridge_id: {
38608
+ description: string;
38534
38609
  format: string;
38535
38610
  type: string;
38536
38611
  };
@@ -38604,10 +38679,13 @@ declare const _default: {
38604
38679
  'x-fern-sdk-method-name': string;
38605
38680
  'x-fern-sdk-return-value': string;
38606
38681
  'x-response-key': string;
38682
+ 'x-title': string;
38683
+ 'x-undocumented': string;
38607
38684
  };
38608
38685
  };
38609
38686
  '/bridges/list': {
38610
38687
  post: {
38688
+ description: string;
38611
38689
  operationId: string;
38612
38690
  requestBody: {
38613
38691
  content: {
@@ -38685,10 +38763,13 @@ declare const _default: {
38685
38763
  'x-fern-sdk-method-name': string;
38686
38764
  'x-fern-sdk-return-value': string;
38687
38765
  'x-response-key': string;
38766
+ 'x-title': string;
38767
+ 'x-undocumented': string;
38688
38768
  };
38689
38769
  };
38690
38770
  '/client_sessions/create': {
38691
38771
  post: {
38772
+ description: string;
38692
38773
  operationId: string;
38693
38774
  requestBody: {
38694
38775
  content: {
@@ -38696,26 +38777,31 @@ declare const _default: {
38696
38777
  schema: {
38697
38778
  properties: {
38698
38779
  connect_webview_ids: {
38780
+ description: string;
38699
38781
  items: {
38700
38782
  type: string;
38701
38783
  };
38702
38784
  type: string;
38703
38785
  };
38704
38786
  connected_account_ids: {
38787
+ description: string;
38705
38788
  items: {
38706
38789
  type: string;
38707
38790
  };
38708
38791
  type: string;
38709
38792
  };
38710
38793
  expires_at: {
38794
+ description: string;
38711
38795
  format: string;
38712
38796
  type: string;
38713
38797
  };
38714
38798
  user_identifier_key: {
38799
+ description: string;
38715
38800
  minLength: number;
38716
38801
  type: string;
38717
38802
  };
38718
38803
  user_identity_ids: {
38804
+ description: string;
38719
38805
  items: {
38720
38806
  type: string;
38721
38807
  };
@@ -38781,8 +38867,10 @@ declare const _default: {
38781
38867
  'x-fern-sdk-method-name': string;
38782
38868
  'x-fern-sdk-return-value': string;
38783
38869
  'x-response-key': string;
38870
+ 'x-title': string;
38784
38871
  };
38785
38872
  put: {
38873
+ description: string;
38786
38874
  operationId: string;
38787
38875
  requestBody: {
38788
38876
  content: {
@@ -38790,26 +38878,31 @@ declare const _default: {
38790
38878
  schema: {
38791
38879
  properties: {
38792
38880
  connect_webview_ids: {
38881
+ description: string;
38793
38882
  items: {
38794
38883
  type: string;
38795
38884
  };
38796
38885
  type: string;
38797
38886
  };
38798
38887
  connected_account_ids: {
38888
+ description: string;
38799
38889
  items: {
38800
38890
  type: string;
38801
38891
  };
38802
38892
  type: string;
38803
38893
  };
38804
38894
  expires_at: {
38895
+ description: string;
38805
38896
  format: string;
38806
38897
  type: string;
38807
38898
  };
38808
38899
  user_identifier_key: {
38900
+ description: string;
38809
38901
  minLength: number;
38810
38902
  type: string;
38811
38903
  };
38812
38904
  user_identity_ids: {
38905
+ description: string;
38813
38906
  items: {
38814
38907
  type: string;
38815
38908
  };
@@ -38873,10 +38966,12 @@ declare const _default: {
38873
38966
  tags: string[];
38874
38967
  'x-fern-ignore': boolean;
38875
38968
  'x-response-key': string;
38969
+ 'x-title': string;
38876
38970
  };
38877
38971
  };
38878
38972
  '/client_sessions/delete': {
38879
38973
  post: {
38974
+ description: string;
38880
38975
  operationId: string;
38881
38976
  requestBody: {
38882
38977
  content: {
@@ -38884,6 +38979,7 @@ declare const _default: {
38884
38979
  schema: {
38885
38980
  properties: {
38886
38981
  client_session_id: {
38982
+ description: string;
38887
38983
  format: string;
38888
38984
  type: string;
38889
38985
  };
@@ -38936,10 +39032,12 @@ declare const _default: {
38936
39032
  'x-fern-sdk-group-name': string[];
38937
39033
  'x-fern-sdk-method-name': string;
38938
39034
  'x-response-key': null;
39035
+ 'x-title': string;
38939
39036
  };
38940
39037
  };
38941
39038
  '/client_sessions/get': {
38942
39039
  post: {
39040
+ description: string;
38943
39041
  operationId: string;
38944
39042
  requestBody: {
38945
39043
  content: {
@@ -38947,9 +39045,11 @@ declare const _default: {
38947
39045
  schema: {
38948
39046
  properties: {
38949
39047
  client_session_id: {
39048
+ description: string;
38950
39049
  type: string;
38951
39050
  };
38952
39051
  user_identifier_key: {
39052
+ description: string;
38953
39053
  type: string;
38954
39054
  };
38955
39055
  };
@@ -39012,10 +39112,12 @@ declare const _default: {
39012
39112
  'x-fern-sdk-method-name': string;
39013
39113
  'x-fern-sdk-return-value': string;
39014
39114
  'x-response-key': string;
39115
+ 'x-title': string;
39015
39116
  };
39016
39117
  };
39017
39118
  '/client_sessions/get_or_create': {
39018
39119
  post: {
39120
+ description: string;
39019
39121
  operationId: string;
39020
39122
  requestBody: {
39021
39123
  content: {
@@ -39023,26 +39125,31 @@ declare const _default: {
39023
39125
  schema: {
39024
39126
  properties: {
39025
39127
  connect_webview_ids: {
39128
+ description: string;
39026
39129
  items: {
39027
39130
  type: string;
39028
39131
  };
39029
39132
  type: string;
39030
39133
  };
39031
39134
  connected_account_ids: {
39135
+ description: string;
39032
39136
  items: {
39033
39137
  type: string;
39034
39138
  };
39035
39139
  type: string;
39036
39140
  };
39037
39141
  expires_at: {
39142
+ description: string;
39038
39143
  format: string;
39039
39144
  type: string;
39040
39145
  };
39041
39146
  user_identifier_key: {
39147
+ description: string;
39042
39148
  minLength: number;
39043
39149
  type: string;
39044
39150
  };
39045
39151
  user_identity_ids: {
39152
+ description: string;
39046
39153
  items: {
39047
39154
  type: string;
39048
39155
  };
@@ -39108,10 +39215,12 @@ declare const _default: {
39108
39215
  'x-fern-sdk-method-name': string;
39109
39216
  'x-fern-sdk-return-value': string;
39110
39217
  'x-response-key': string;
39218
+ 'x-title': string;
39111
39219
  };
39112
39220
  };
39113
39221
  '/client_sessions/grant_access': {
39114
39222
  patch: {
39223
+ description: string;
39115
39224
  operationId: string;
39116
39225
  requestBody: {
39117
39226
  content: {
@@ -39119,24 +39228,29 @@ declare const _default: {
39119
39228
  schema: {
39120
39229
  properties: {
39121
39230
  client_session_id: {
39231
+ description: string;
39122
39232
  type: string;
39123
39233
  };
39124
39234
  connect_webview_ids: {
39235
+ description: string;
39125
39236
  items: {
39126
39237
  type: string;
39127
39238
  };
39128
39239
  type: string;
39129
39240
  };
39130
39241
  connected_account_ids: {
39242
+ description: string;
39131
39243
  items: {
39132
39244
  type: string;
39133
39245
  };
39134
39246
  type: string;
39135
39247
  };
39136
39248
  user_identifier_key: {
39249
+ description: string;
39137
39250
  type: string;
39138
39251
  };
39139
39252
  user_identity_ids: {
39253
+ description: string;
39140
39254
  items: {
39141
39255
  type: string;
39142
39256
  };
@@ -39192,8 +39306,10 @@ declare const _default: {
39192
39306
  tags: string[];
39193
39307
  'x-fern-ignore': boolean;
39194
39308
  'x-response-key': null;
39309
+ 'x-title': string;
39195
39310
  };
39196
39311
  post: {
39312
+ description: string;
39197
39313
  operationId: string;
39198
39314
  requestBody: {
39199
39315
  content: {
@@ -39201,24 +39317,29 @@ declare const _default: {
39201
39317
  schema: {
39202
39318
  properties: {
39203
39319
  client_session_id: {
39320
+ description: string;
39204
39321
  type: string;
39205
39322
  };
39206
39323
  connect_webview_ids: {
39324
+ description: string;
39207
39325
  items: {
39208
39326
  type: string;
39209
39327
  };
39210
39328
  type: string;
39211
39329
  };
39212
39330
  connected_account_ids: {
39331
+ description: string;
39213
39332
  items: {
39214
39333
  type: string;
39215
39334
  };
39216
39335
  type: string;
39217
39336
  };
39218
39337
  user_identifier_key: {
39338
+ description: string;
39219
39339
  type: string;
39220
39340
  };
39221
39341
  user_identity_ids: {
39342
+ description: string;
39222
39343
  items: {
39223
39344
  type: string;
39224
39345
  };
@@ -39275,10 +39396,12 @@ declare const _default: {
39275
39396
  'x-fern-sdk-group-name': string[];
39276
39397
  'x-fern-sdk-method-name': string;
39277
39398
  'x-response-key': null;
39399
+ 'x-title': string;
39278
39400
  };
39279
39401
  };
39280
39402
  '/client_sessions/list': {
39281
39403
  post: {
39404
+ description: string;
39282
39405
  operationId: string;
39283
39406
  requestBody: {
39284
39407
  content: {
@@ -39286,18 +39409,23 @@ declare const _default: {
39286
39409
  schema: {
39287
39410
  properties: {
39288
39411
  client_session_id: {
39412
+ description: string;
39289
39413
  type: string;
39290
39414
  };
39291
39415
  connect_webview_id: {
39416
+ description: string;
39292
39417
  type: string;
39293
39418
  };
39294
39419
  user_identifier_key: {
39420
+ description: string;
39295
39421
  type: string;
39296
39422
  };
39297
39423
  user_identity_id: {
39424
+ description: string;
39298
39425
  type: string;
39299
39426
  };
39300
39427
  without_user_identifier_key: {
39428
+ description: string;
39301
39429
  type: string;
39302
39430
  };
39303
39431
  };
@@ -39355,10 +39483,12 @@ declare const _default: {
39355
39483
  'x-fern-sdk-method-name': string;
39356
39484
  'x-fern-sdk-return-value': string;
39357
39485
  'x-response-key': string;
39486
+ 'x-title': string;
39358
39487
  };
39359
39488
  };
39360
39489
  '/client_sessions/revoke': {
39361
39490
  post: {
39491
+ description: string;
39362
39492
  operationId: string;
39363
39493
  requestBody: {
39364
39494
  content: {
@@ -39366,6 +39496,7 @@ declare const _default: {
39366
39496
  schema: {
39367
39497
  properties: {
39368
39498
  client_session_id: {
39499
+ description: string;
39369
39500
  format: string;
39370
39501
  type: string;
39371
39502
  };
@@ -39418,10 +39549,12 @@ declare const _default: {
39418
39549
  'x-fern-sdk-group-name': string[];
39419
39550
  'x-fern-sdk-method-name': string;
39420
39551
  'x-response-key': null;
39552
+ 'x-title': string;
39421
39553
  };
39422
39554
  };
39423
39555
  '/connect_webviews/create': {
39424
39556
  post: {
39557
+ description: string;
39425
39558
  operationId: string;
39426
39559
  requestBody: {
39427
39560
  content: {
@@ -39429,6 +39562,7 @@ declare const _default: {
39429
39562
  schema: {
39430
39563
  properties: {
39431
39564
  accepted_providers: {
39565
+ description: string;
39432
39566
  items: {
39433
39567
  enum: string[];
39434
39568
  type: string;
@@ -39437,6 +39571,7 @@ declare const _default: {
39437
39571
  };
39438
39572
  automatically_manage_new_devices: {
39439
39573
  default: boolean;
39574
+ description: string;
39440
39575
  type: string;
39441
39576
  };
39442
39577
  custom_metadata: {
@@ -39450,24 +39585,30 @@ declare const _default: {
39450
39585
  maxLength?: never;
39451
39586
  })[];
39452
39587
  };
39588
+ description: string;
39453
39589
  type: string;
39454
39590
  };
39455
39591
  custom_redirect_failure_url: {
39592
+ description: string;
39456
39593
  type: string;
39457
39594
  };
39458
39595
  custom_redirect_url: {
39596
+ description: string;
39459
39597
  type: string;
39460
39598
  };
39461
39599
  device_selection_mode: {
39462
39600
  enum: string[];
39463
39601
  type: string;
39602
+ 'x-undocumented': string;
39464
39603
  };
39465
39604
  provider_category: {
39605
+ description: string;
39466
39606
  enum: string[];
39467
39607
  type: string;
39468
39608
  };
39469
39609
  wait_for_device_creation: {
39470
39610
  default: boolean;
39611
+ description: string;
39471
39612
  type: string;
39472
39613
  };
39473
39614
  };
@@ -39530,10 +39671,12 @@ declare const _default: {
39530
39671
  'x-fern-sdk-method-name': string;
39531
39672
  'x-fern-sdk-return-value': string;
39532
39673
  'x-response-key': string;
39674
+ 'x-title': string;
39533
39675
  };
39534
39676
  };
39535
39677
  '/connect_webviews/delete': {
39536
39678
  post: {
39679
+ description: string;
39537
39680
  operationId: string;
39538
39681
  requestBody: {
39539
39682
  content: {
@@ -39541,6 +39684,7 @@ declare const _default: {
39541
39684
  schema: {
39542
39685
  properties: {
39543
39686
  connect_webview_id: {
39687
+ description: string;
39544
39688
  format: string;
39545
39689
  type: string;
39546
39690
  };
@@ -39593,10 +39737,12 @@ declare const _default: {
39593
39737
  'x-fern-sdk-group-name': string[];
39594
39738
  'x-fern-sdk-method-name': string;
39595
39739
  'x-response-key': null;
39740
+ 'x-title': string;
39596
39741
  };
39597
39742
  };
39598
39743
  '/connect_webviews/get': {
39599
39744
  post: {
39745
+ description: string;
39600
39746
  operationId: string;
39601
39747
  requestBody: {
39602
39748
  content: {
@@ -39604,6 +39750,7 @@ declare const _default: {
39604
39750
  schema: {
39605
39751
  properties: {
39606
39752
  connect_webview_id: {
39753
+ description: string;
39607
39754
  format: string;
39608
39755
  type: string;
39609
39756
  };
@@ -39668,10 +39815,12 @@ declare const _default: {
39668
39815
  'x-fern-sdk-method-name': string;
39669
39816
  'x-fern-sdk-return-value': string;
39670
39817
  'x-response-key': string;
39818
+ 'x-title': string;
39671
39819
  };
39672
39820
  };
39673
39821
  '/connect_webviews/list': {
39674
39822
  post: {
39823
+ description: string;
39675
39824
  operationId: string;
39676
39825
  requestBody: {
39677
39826
  content: {
@@ -39689,6 +39838,7 @@ declare const _default: {
39689
39838
  };
39690
39839
  limit: {
39691
39840
  default: number;
39841
+ description: string;
39692
39842
  format: string;
39693
39843
  type: string;
39694
39844
  };
@@ -39759,10 +39909,12 @@ declare const _default: {
39759
39909
  'x-fern-sdk-method-name': string;
39760
39910
  'x-fern-sdk-return-value': string;
39761
39911
  'x-response-key': string;
39912
+ 'x-title': string;
39762
39913
  };
39763
39914
  };
39764
39915
  '/connected_accounts/delete': {
39765
39916
  post: {
39917
+ description: string;
39766
39918
  operationId: string;
39767
39919
  requestBody: {
39768
39920
  content: {
@@ -39770,12 +39922,14 @@ declare const _default: {
39770
39922
  schema: {
39771
39923
  properties: {
39772
39924
  connected_account_id: {
39925
+ description: string;
39773
39926
  format: string;
39774
39927
  type: string;
39775
39928
  };
39776
39929
  sync: {
39777
39930
  default: boolean;
39778
39931
  type: string;
39932
+ 'x-undocumented': string;
39779
39933
  };
39780
39934
  };
39781
39935
  required: string[];
@@ -39831,6 +39985,7 @@ declare const _default: {
39831
39985
  };
39832
39986
  '/connected_accounts/get': {
39833
39987
  post: {
39988
+ description: string;
39834
39989
  operationId: string;
39835
39990
  requestBody: {
39836
39991
  content: {
@@ -39839,6 +39994,7 @@ declare const _default: {
39839
39994
  oneOf: ({
39840
39995
  properties: {
39841
39996
  connected_account_id: {
39997
+ description: string;
39842
39998
  format: string;
39843
39999
  type: string;
39844
40000
  };
@@ -39849,6 +40005,7 @@ declare const _default: {
39849
40005
  } | {
39850
40006
  properties: {
39851
40007
  email: {
40008
+ description: string;
39852
40009
  format: string;
39853
40010
  type: string;
39854
40011
  };
@@ -39920,6 +40077,7 @@ declare const _default: {
39920
40077
  };
39921
40078
  '/connected_accounts/list': {
39922
40079
  post: {
40080
+ description: string;
39923
40081
  operationId: string;
39924
40082
  requestBody: {
39925
40083
  content: {
@@ -40021,6 +40179,7 @@ declare const _default: {
40021
40179
  };
40022
40180
  '/connected_accounts/update': {
40023
40181
  post: {
40182
+ description: string;
40024
40183
  operationId: string;
40025
40184
  requestBody: {
40026
40185
  content: {
@@ -40028,9 +40187,11 @@ declare const _default: {
40028
40187
  schema: {
40029
40188
  properties: {
40030
40189
  automatically_manage_new_devices: {
40190
+ description: string;
40031
40191
  type: string;
40032
40192
  };
40033
40193
  connected_account_id: {
40194
+ description: string;
40034
40195
  format: string;
40035
40196
  type: string;
40036
40197
  };
@@ -40045,6 +40206,7 @@ declare const _default: {
40045
40206
  maxLength?: never;
40046
40207
  })[];
40047
40208
  };
40209
+ description: string;
40048
40210
  type: string;
40049
40211
  };
40050
40212
  };
@@ -40104,6 +40266,7 @@ declare const _default: {
40104
40266
  };
40105
40267
  '/devices/delete': {
40106
40268
  post: {
40269
+ description: string;
40107
40270
  operationId: string;
40108
40271
  requestBody: {
40109
40272
  content: {
@@ -40111,6 +40274,7 @@ declare const _default: {
40111
40274
  schema: {
40112
40275
  properties: {
40113
40276
  device_id: {
40277
+ description: string;
40114
40278
  format: string;
40115
40279
  type: string;
40116
40280
  };
@@ -40164,11 +40328,13 @@ declare const _default: {
40164
40328
  'x-fern-sdk-group-name': string[];
40165
40329
  'x-fern-sdk-method-name': string;
40166
40330
  'x-response-key': null;
40331
+ 'x-title': string;
40167
40332
  'x-undocumented': string;
40168
40333
  };
40169
40334
  };
40170
40335
  '/devices/get': {
40171
40336
  post: {
40337
+ description: string;
40172
40338
  operationId: string;
40173
40339
  requestBody: {
40174
40340
  content: {
@@ -40176,10 +40342,12 @@ declare const _default: {
40176
40342
  schema: {
40177
40343
  properties: {
40178
40344
  device_id: {
40345
+ description: string;
40179
40346
  format: string;
40180
40347
  type: string;
40181
40348
  };
40182
40349
  name: {
40350
+ description: string;
40183
40351
  type: string;
40184
40352
  };
40185
40353
  };
@@ -40242,6 +40410,7 @@ declare const _default: {
40242
40410
  'x-fern-sdk-method-name': string;
40243
40411
  'x-fern-sdk-return-value': string;
40244
40412
  'x-response-key': string;
40413
+ 'x-title': string;
40245
40414
  };
40246
40415
  };
40247
40416
  '/devices/list': {
@@ -40360,6 +40529,7 @@ declare const _default: {
40360
40529
  type: string;
40361
40530
  };
40362
40531
  unstable_location_id: {
40532
+ description: string;
40363
40533
  format: string;
40364
40534
  nullable: boolean;
40365
40535
  type: string;
@@ -40440,6 +40610,7 @@ declare const _default: {
40440
40610
  };
40441
40611
  '/devices/list_device_providers': {
40442
40612
  post: {
40613
+ description: string;
40443
40614
  operationId: string;
40444
40615
  requestBody: {
40445
40616
  content: {
@@ -40447,6 +40618,7 @@ declare const _default: {
40447
40618
  schema: {
40448
40619
  properties: {
40449
40620
  provider_category: {
40621
+ description: string;
40450
40622
  enum: string[];
40451
40623
  type: string;
40452
40624
  };
@@ -40513,10 +40685,12 @@ declare const _default: {
40513
40685
  'x-fern-sdk-method-name': string;
40514
40686
  'x-fern-sdk-return-value': string;
40515
40687
  'x-response-key': string;
40688
+ 'x-title': string;
40516
40689
  };
40517
40690
  };
40518
40691
  '/devices/simulate/connect': {
40519
40692
  post: {
40693
+ description: string;
40520
40694
  operationId: string;
40521
40695
  requestBody: {
40522
40696
  content: {
@@ -40524,6 +40698,7 @@ declare const _default: {
40524
40698
  schema: {
40525
40699
  properties: {
40526
40700
  device_id: {
40701
+ description: string;
40527
40702
  format: string;
40528
40703
  type: string;
40529
40704
  };
@@ -40576,10 +40751,12 @@ declare const _default: {
40576
40751
  'x-fern-sdk-group-name': string[];
40577
40752
  'x-fern-sdk-method-name': string;
40578
40753
  'x-response-key': null;
40754
+ 'x-title': string;
40579
40755
  };
40580
40756
  };
40581
40757
  '/devices/simulate/disconnect': {
40582
40758
  post: {
40759
+ description: string;
40583
40760
  operationId: string;
40584
40761
  requestBody: {
40585
40762
  content: {
@@ -40587,6 +40764,7 @@ declare const _default: {
40587
40764
  schema: {
40588
40765
  properties: {
40589
40766
  device_id: {
40767
+ description: string;
40590
40768
  format: string;
40591
40769
  type: string;
40592
40770
  };
@@ -40639,10 +40817,12 @@ declare const _default: {
40639
40817
  'x-fern-sdk-group-name': string[];
40640
40818
  'x-fern-sdk-method-name': string;
40641
40819
  'x-response-key': null;
40820
+ 'x-title': string;
40642
40821
  };
40643
40822
  };
40644
40823
  '/devices/simulate/remove': {
40645
40824
  post: {
40825
+ description: string;
40646
40826
  operationId: string;
40647
40827
  requestBody: {
40648
40828
  content: {
@@ -40650,6 +40830,7 @@ declare const _default: {
40650
40830
  schema: {
40651
40831
  properties: {
40652
40832
  device_id: {
40833
+ description: string;
40653
40834
  format: string;
40654
40835
  type: string;
40655
40836
  };
@@ -40702,10 +40883,12 @@ declare const _default: {
40702
40883
  'x-fern-sdk-group-name': string[];
40703
40884
  'x-fern-sdk-method-name': string;
40704
40885
  'x-response-key': null;
40886
+ 'x-title': string;
40705
40887
  };
40706
40888
  };
40707
40889
  '/devices/unmanaged/get': {
40708
40890
  post: {
40891
+ description: string;
40709
40892
  operationId: string;
40710
40893
  requestBody: {
40711
40894
  content: {
@@ -40713,10 +40896,12 @@ declare const _default: {
40713
40896
  schema: {
40714
40897
  properties: {
40715
40898
  device_id: {
40899
+ description: string;
40716
40900
  format: string;
40717
40901
  type: string;
40718
40902
  };
40719
40903
  name: {
40904
+ description: string;
40720
40905
  type: string;
40721
40906
  };
40722
40907
  };
@@ -40779,10 +40964,12 @@ declare const _default: {
40779
40964
  'x-fern-sdk-method-name': string;
40780
40965
  'x-fern-sdk-return-value': string;
40781
40966
  'x-response-key': string;
40967
+ 'x-title': string;
40782
40968
  };
40783
40969
  };
40784
40970
  '/devices/unmanaged/list': {
40785
40971
  post: {
40972
+ description: string;
40786
40973
  operationId: string;
40787
40974
  requestBody: {
40788
40975
  content: {
@@ -40896,6 +41083,7 @@ declare const _default: {
40896
41083
  type: string;
40897
41084
  };
40898
41085
  unstable_location_id: {
41086
+ description: string;
40899
41087
  format: string;
40900
41088
  nullable: boolean;
40901
41089
  type: string;
@@ -40960,10 +41148,12 @@ declare const _default: {
40960
41148
  'x-fern-sdk-method-name': string;
40961
41149
  'x-fern-sdk-return-value': string;
40962
41150
  'x-response-key': string;
41151
+ 'x-title': string;
40963
41152
  };
40964
41153
  };
40965
41154
  '/devices/unmanaged/update': {
40966
41155
  patch: {
41156
+ description: string;
40967
41157
  operationId: string;
40968
41158
  requestBody: {
40969
41159
  content: {
@@ -40971,10 +41161,12 @@ declare const _default: {
40971
41161
  schema: {
40972
41162
  properties: {
40973
41163
  device_id: {
41164
+ description: string;
40974
41165
  format: string;
40975
41166
  type: string;
40976
41167
  };
40977
41168
  is_managed: {
41169
+ description: string;
40978
41170
  enum: boolean[];
40979
41171
  type: string;
40980
41172
  };
@@ -41026,8 +41218,10 @@ declare const _default: {
41026
41218
  tags: string[];
41027
41219
  'x-fern-ignore': boolean;
41028
41220
  'x-response-key': null;
41221
+ 'x-title': string;
41029
41222
  };
41030
41223
  post: {
41224
+ description: string;
41031
41225
  operationId: string;
41032
41226
  requestBody: {
41033
41227
  content: {
@@ -41035,10 +41229,12 @@ declare const _default: {
41035
41229
  schema: {
41036
41230
  properties: {
41037
41231
  device_id: {
41232
+ description: string;
41038
41233
  format: string;
41039
41234
  type: string;
41040
41235
  };
41041
41236
  is_managed: {
41237
+ description: string;
41042
41238
  enum: boolean[];
41043
41239
  type: string;
41044
41240
  };
@@ -41091,10 +41287,12 @@ declare const _default: {
41091
41287
  'x-fern-sdk-group-name': string[];
41092
41288
  'x-fern-sdk-method-name': string;
41093
41289
  'x-response-key': null;
41290
+ 'x-title': string;
41094
41291
  };
41095
41292
  };
41096
41293
  '/devices/update': {
41097
41294
  patch: {
41295
+ description: string;
41098
41296
  operationId: string;
41099
41297
  requestBody: {
41100
41298
  content: {
@@ -41112,23 +41310,28 @@ declare const _default: {
41112
41310
  maxLength?: never;
41113
41311
  })[];
41114
41312
  };
41313
+ description: string;
41115
41314
  type: string;
41116
41315
  };
41117
41316
  device_id: {
41317
+ description: string;
41118
41318
  format: string;
41119
41319
  type: string;
41120
41320
  };
41121
41321
  is_managed: {
41122
41322
  default: boolean;
41323
+ description: string;
41123
41324
  type: string;
41124
41325
  };
41125
41326
  name: {
41327
+ description: string;
41126
41328
  nullable: boolean;
41127
41329
  type: string;
41128
41330
  };
41129
41331
  properties: {
41130
41332
  properties: {
41131
41333
  name: {
41334
+ description: string;
41132
41335
  nullable: boolean;
41133
41336
  type: string;
41134
41337
  };
@@ -41191,8 +41394,10 @@ declare const _default: {
41191
41394
  tags: string[];
41192
41395
  'x-fern-ignore': boolean;
41193
41396
  'x-response-key': null;
41397
+ 'x-title': string;
41194
41398
  };
41195
41399
  post: {
41400
+ description: string;
41196
41401
  operationId: string;
41197
41402
  requestBody: {
41198
41403
  content: {
@@ -41210,23 +41415,28 @@ declare const _default: {
41210
41415
  maxLength?: never;
41211
41416
  })[];
41212
41417
  };
41418
+ description: string;
41213
41419
  type: string;
41214
41420
  };
41215
41421
  device_id: {
41422
+ description: string;
41216
41423
  format: string;
41217
41424
  type: string;
41218
41425
  };
41219
41426
  is_managed: {
41220
41427
  default: boolean;
41428
+ description: string;
41221
41429
  type: string;
41222
41430
  };
41223
41431
  name: {
41432
+ description: string;
41224
41433
  nullable: boolean;
41225
41434
  type: string;
41226
41435
  };
41227
41436
  properties: {
41228
41437
  properties: {
41229
41438
  name: {
41439
+ description: string;
41230
41440
  nullable: boolean;
41231
41441
  type: string;
41232
41442
  };
@@ -41290,10 +41500,12 @@ declare const _default: {
41290
41500
  'x-fern-sdk-group-name': string[];
41291
41501
  'x-fern-sdk-method-name': string;
41292
41502
  'x-response-key': null;
41503
+ 'x-title': string;
41293
41504
  };
41294
41505
  };
41295
41506
  '/events/get': {
41296
41507
  post: {
41508
+ description: string;
41297
41509
  operationId: string;
41298
41510
  requestBody: {
41299
41511
  content: {
@@ -41374,10 +41586,12 @@ declare const _default: {
41374
41586
  'x-fern-sdk-method-name': string;
41375
41587
  'x-fern-sdk-return-value': string;
41376
41588
  'x-response-key': string;
41589
+ 'x-title': string;
41377
41590
  };
41378
41591
  };
41379
41592
  '/events/list': {
41380
41593
  post: {
41594
+ description: string;
41381
41595
  operationId: string;
41382
41596
  requestBody: {
41383
41597
  content: {
@@ -41539,6 +41753,7 @@ declare const _default: {
41539
41753
  'x-fern-sdk-method-name': string;
41540
41754
  'x-fern-sdk-return-value': string;
41541
41755
  'x-response-key': string;
41756
+ 'x-title': string;
41542
41757
  };
41543
41758
  };
41544
41759
  '/locks/get': {
@@ -41723,6 +41938,7 @@ declare const _default: {
41723
41938
  type: string;
41724
41939
  };
41725
41940
  unstable_location_id: {
41941
+ description: string;
41726
41942
  format: string;
41727
41943
  nullable: boolean;
41728
41944
  type: string;
@@ -42336,6 +42552,7 @@ declare const _default: {
42336
42552
  type: string;
42337
42553
  };
42338
42554
  unstable_location_id: {
42555
+ description: string;
42339
42556
  format: string;
42340
42557
  nullable: boolean;
42341
42558
  type: string;
@@ -45827,6 +46044,7 @@ declare const _default: {
45827
46044
  type: string;
45828
46045
  };
45829
46046
  unstable_location_id: {
46047
+ description: string;
45830
46048
  format: string;
45831
46049
  nullable: boolean;
45832
46050
  type: string;
@@ -49681,6 +49899,168 @@ declare const _default: {
49681
49899
  'x-undocumented': string;
49682
49900
  };
49683
49901
  };
49902
+ '/unstable_partner/resources/push': {
49903
+ post: {
49904
+ description: string;
49905
+ operationId: string;
49906
+ requestBody: {
49907
+ content: {
49908
+ 'application/json': {
49909
+ schema: {
49910
+ oneOf: ({
49911
+ items: {
49912
+ properties: {
49913
+ custom_metadata: {
49914
+ additionalProperties: {
49915
+ type: string;
49916
+ };
49917
+ type: string;
49918
+ };
49919
+ customer_key: {
49920
+ type: string;
49921
+ };
49922
+ description: {
49923
+ type: string;
49924
+ };
49925
+ email_address: {
49926
+ type: string;
49927
+ };
49928
+ ends_at: {
49929
+ type: string;
49930
+ };
49931
+ icon_url: {
49932
+ type: string;
49933
+ };
49934
+ location_keys: {
49935
+ items: {
49936
+ type: string;
49937
+ };
49938
+ type: string;
49939
+ };
49940
+ name: {
49941
+ type: string;
49942
+ };
49943
+ partner_resource_key: {
49944
+ type: string;
49945
+ };
49946
+ partner_resource_type: {
49947
+ type: string;
49948
+ };
49949
+ phone_number: {
49950
+ type: string;
49951
+ };
49952
+ starts_at: {
49953
+ type: string;
49954
+ };
49955
+ user_identity_key: {
49956
+ type: string;
49957
+ };
49958
+ };
49959
+ type: string;
49960
+ };
49961
+ type: string;
49962
+ properties?: never;
49963
+ } | {
49964
+ properties: {
49965
+ custom_metadata: {
49966
+ additionalProperties: {
49967
+ type: string;
49968
+ };
49969
+ type: string;
49970
+ };
49971
+ customer_key: {
49972
+ type: string;
49973
+ };
49974
+ description: {
49975
+ type: string;
49976
+ };
49977
+ email_address: {
49978
+ type: string;
49979
+ };
49980
+ ends_at: {
49981
+ type: string;
49982
+ };
49983
+ icon_url: {
49984
+ type: string;
49985
+ };
49986
+ location_keys: {
49987
+ items: {
49988
+ type: string;
49989
+ };
49990
+ type: string;
49991
+ };
49992
+ name: {
49993
+ type: string;
49994
+ };
49995
+ partner_resource_key: {
49996
+ type: string;
49997
+ };
49998
+ partner_resource_type: {
49999
+ type: string;
50000
+ };
50001
+ phone_number: {
50002
+ type: string;
50003
+ };
50004
+ starts_at: {
50005
+ type: string;
50006
+ };
50007
+ user_identity_key: {
50008
+ type: string;
50009
+ };
50010
+ };
50011
+ type: string;
50012
+ items?: never;
50013
+ })[];
50014
+ };
50015
+ };
50016
+ };
50017
+ };
50018
+ responses: {
50019
+ 200: {
50020
+ content: {
50021
+ 'application/json': {
50022
+ schema: {
50023
+ properties: {
50024
+ ok: {
50025
+ type: string;
50026
+ };
50027
+ };
50028
+ required: string[];
50029
+ type: string;
50030
+ };
50031
+ };
50032
+ };
50033
+ description: string;
50034
+ };
50035
+ 400: {
50036
+ description: string;
50037
+ };
50038
+ 401: {
50039
+ description: string;
50040
+ };
50041
+ };
50042
+ security: ({
50043
+ pat_with_workspace: never[];
50044
+ console_session_with_workspace?: never;
50045
+ api_key?: never;
50046
+ } | {
50047
+ console_session_with_workspace: never[];
50048
+ pat_with_workspace?: never;
50049
+ api_key?: never;
50050
+ } | {
50051
+ api_key: never[];
50052
+ pat_with_workspace?: never;
50053
+ console_session_with_workspace?: never;
50054
+ })[];
50055
+ summary: string;
50056
+ tags: never[];
50057
+ 'x-fern-sdk-group-name': string[];
50058
+ 'x-fern-sdk-method-name': string;
50059
+ 'x-response-key': null;
50060
+ 'x-title': string;
50061
+ 'x-undocumented': string;
50062
+ };
50063
+ };
49684
50064
  '/user_identities/add_acs_user': {
49685
50065
  post: {
49686
50066
  description: string;
@@ -52087,6 +52467,7 @@ declare const _default: {
52087
52467
  };
52088
52468
  '/workspaces/reset_sandbox': {
52089
52469
  post: {
52470
+ description: string;
52090
52471
  operationId: string;
52091
52472
  responses: {
52092
52473
  200: {
@@ -52302,9 +52683,15 @@ interface Routes {
52302
52683
  method: 'POST';
52303
52684
  queryParams: {};
52304
52685
  jsonBody: {
52305
- /** ID of the device for which to create the new access code. */
52686
+ /** ID of the device for which you want to create the new access code. */
52306
52687
  device_id: string;
52307
- /** Name of the new access code. */
52688
+ /** Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.
52689
+
52690
+ 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`.
52691
+
52692
+ 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.
52693
+
52694
+ 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). */
52308
52695
  name?: string | undefined;
52309
52696
  /** 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. */
52310
52697
  starts_at?: string | undefined;
@@ -53445,7 +53832,7 @@ interface Routes {
53445
53832
 
53446
53833
  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.
53447
53834
 
53448
- 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`.
53835
+ 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.
53449
53836
 
53450
53837
  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. */
53451
53838
  access_code: {
@@ -53461,7 +53848,13 @@ interface Routes {
53461
53848
  access_code_id: string;
53462
53849
  /** Unique identifier for the device associated with the access code. */
53463
53850
  device_id: string;
53464
- /** Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. */
53851
+ /** Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.
53852
+
53853
+ 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`.
53854
+
53855
+ 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.
53856
+
53857
+ 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). */
53465
53858
  name: string | null;
53466
53859
  /** Code used for access. Typically, a numeric or alphanumeric string. */
53467
53860
  code: string | null;
@@ -53904,13 +54297,19 @@ interface Routes {
53904
54297
  method: 'POST' | 'PUT';
53905
54298
  queryParams: {};
53906
54299
  jsonBody: {
53907
- /** IDs of the devices for which to create the new access codes. */
54300
+ /** IDs of the devices for which you want to create the new access codes. */
53908
54301
  device_ids: string[];
53909
54302
  /** 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. */
53910
54303
  behavior_when_code_cannot_be_shared?: 'throw' | 'create_random_code';
53911
54304
  /** 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. */
53912
54305
  preferred_code_length?: number | undefined;
53913
- /** Name of the new access code. */
54306
+ /** Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.
54307
+
54308
+ 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`.
54309
+
54310
+ 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.
54311
+
54312
+ 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). */
53914
54313
  name?: string | undefined;
53915
54314
  /** 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. */
53916
54315
  starts_at?: string | undefined;
@@ -53951,7 +54350,13 @@ interface Routes {
53951
54350
  access_code_id: string;
53952
54351
  /** Unique identifier for the device associated with the access code. */
53953
54352
  device_id: string;
53954
- /** Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. */
54353
+ /** Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.
54354
+
54355
+ 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`.
54356
+
54357
+ 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.
54358
+
54359
+ 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). */
53955
54360
  name: string | null;
53956
54361
  /** Code used for access. Typically, a numeric or alphanumeric string. */
53957
54362
  code: string | null;
@@ -54395,9 +54800,9 @@ interface Routes {
54395
54800
  queryParams: {};
54396
54801
  jsonBody: {};
54397
54802
  commonParams: {
54398
- /** ID of the device for which to delete the access code. */
54803
+ /** ID of the device for which you want to delete the access code. */
54399
54804
  device_id?: string | undefined;
54400
- /** ID of the access code to delete. */
54805
+ /** ID of the access code that you want to delete. */
54401
54806
  access_code_id: string;
54402
54807
  /** */
54403
54808
  sync?: boolean;
@@ -55515,6 +55920,7 @@ interface Routes {
55515
55920
  queryParams: {};
55516
55921
  jsonBody: {};
55517
55922
  commonParams: {
55923
+ /** ID of the device for which you want to generate a code. */
55518
55924
  device_id: string;
55519
55925
  };
55520
55926
  formData: {};
@@ -55544,7 +55950,7 @@ interface Routes {
55544
55950
 
55545
55951
  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.
55546
55952
 
55547
- 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`.
55953
+ 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.
55548
55954
 
55549
55955
  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. */
55550
55956
  access_code: {
@@ -55560,7 +55966,13 @@ interface Routes {
55560
55966
  access_code_id: string;
55561
55967
  /** Unique identifier for the device associated with the access code. */
55562
55968
  device_id: string;
55563
- /** Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. */
55969
+ /** Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.
55970
+
55971
+ 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`.
55972
+
55973
+ 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.
55974
+
55975
+ 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). */
55564
55976
  name: string | null;
55565
55977
  /** Code used for access. Typically, a numeric or alphanumeric string. */
55566
55978
  code: string | null;
@@ -56030,7 +56442,13 @@ interface Routes {
56030
56442
  access_code_id: string;
56031
56443
  /** Unique identifier for the device associated with the access code. */
56032
56444
  device_id: string;
56033
- /** Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. */
56445
+ /** Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.
56446
+
56447
+ 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`.
56448
+
56449
+ 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.
56450
+
56451
+ 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). */
56034
56452
  name: string | null;
56035
56453
  /** Code used for access. Typically, a numeric or alphanumeric string. */
56036
56454
  code: string | null;
@@ -56492,7 +56910,7 @@ interface Routes {
56492
56910
 
56493
56911
  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.
56494
56912
 
56495
- 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`.
56913
+ 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.
56496
56914
 
56497
56915
  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. */
56498
56916
  backup_access_code: {
@@ -56508,7 +56926,13 @@ interface Routes {
56508
56926
  access_code_id: string;
56509
56927
  /** Unique identifier for the device associated with the access code. */
56510
56928
  device_id: string;
56511
- /** Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. */
56929
+ /** Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.
56930
+
56931
+ 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`.
56932
+
56933
+ 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.
56934
+
56935
+ 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). */
56512
56936
  name: string | null;
56513
56937
  /** Code used for access. Typically, a numeric or alphanumeric string. */
56514
56938
  code: string | null;
@@ -56948,7 +57372,7 @@ interface Routes {
56948
57372
 
56949
57373
  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.
56950
57374
 
56951
- 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`.
57375
+ 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.
56952
57376
 
56953
57377
  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. */
56954
57378
  access_code: {
@@ -56964,7 +57388,13 @@ interface Routes {
56964
57388
  access_code_id: string;
56965
57389
  /** Unique identifier for the device associated with the access code. */
56966
57390
  device_id: string;
56967
- /** Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. */
57391
+ /** Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.
57392
+
57393
+ 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`.
57394
+
57395
+ 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.
57396
+
57397
+ 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). */
56968
57398
  name: string | null;
56969
57399
  /** Code used for access. Typically, a numeric or alphanumeric string. */
56970
57400
  code: string | null;
@@ -57407,7 +57837,7 @@ interface Routes {
57407
57837
  method: 'POST';
57408
57838
  queryParams: {};
57409
57839
  jsonBody: {
57410
- /** ID of the device for which to report constraints. */
57840
+ /** ID of the device for which you want to report constraints. */
57411
57841
  device_id: string;
57412
57842
  /** 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`. */
57413
57843
  supported_code_lengths?: number[] | undefined;
@@ -57441,7 +57871,11 @@ interface Routes {
57441
57871
 
57442
57872
  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.
57443
57873
 
57444
- 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. */
57874
+ 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.
57875
+
57876
+ Not all providers support unmanaged access codes. The following providers do not support unmanaged access codes:
57877
+
57878
+ - [Kwikset](https://docs.seam.co/latest/device-and-system-integration-guides/kwikset-locks) */
57445
57879
  access_code: {
57446
57880
  /** 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. */
57447
57881
  type: 'time_bound' | 'ongoing';
@@ -57449,7 +57883,13 @@ interface Routes {
57449
57883
  access_code_id: string;
57450
57884
  /** Unique identifier for the device associated with the access code. */
57451
57885
  device_id: string;
57452
- /** Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. */
57886
+ /** Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.
57887
+
57888
+ 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`.
57889
+
57890
+ 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.
57891
+
57892
+ 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). */
57453
57893
  name: string | null;
57454
57894
  /** Code used for access. Typically, a numeric or alphanumeric string. */
57455
57895
  code: string | null;
@@ -57883,9 +58323,9 @@ interface Routes {
57883
58323
  commonParams: {
57884
58324
  /** ID of the unmanaged access code that you want to convert to a managed access code. */
57885
58325
  access_code_id: string;
57886
- /** Indicates whether external modification of the access code is allowed. */
58326
+ /** Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the access code is allowed. */
57887
58327
  is_external_modification_allowed?: boolean | undefined;
57888
- /** Indicates whether external modification of the access code is allowed. */
58328
+ /** Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the access code is allowed. */
57889
58329
  allow_external_modification?: boolean | undefined;
57890
58330
  /** 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`. */
57891
58331
  force?: boolean | undefined;
@@ -57901,7 +58341,7 @@ interface Routes {
57901
58341
  queryParams: {};
57902
58342
  jsonBody: {};
57903
58343
  commonParams: {
57904
- /** ID of the unmanaged access code to delete. */
58344
+ /** ID of the unmanaged access code that you want to delete. */
57905
58345
  access_code_id: string;
57906
58346
  /** */
57907
58347
  sync?: boolean;
@@ -59034,7 +59474,11 @@ interface Routes {
59034
59474
 
59035
59475
  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.
59036
59476
 
59037
- 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. */
59477
+ 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.
59478
+
59479
+ Not all providers support unmanaged access codes. The following providers do not support unmanaged access codes:
59480
+
59481
+ - [Kwikset](https://docs.seam.co/latest/device-and-system-integration-guides/kwikset-locks) */
59038
59482
  access_code: {
59039
59483
  /** 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. */
59040
59484
  type: 'time_bound' | 'ongoing';
@@ -59042,7 +59486,13 @@ interface Routes {
59042
59486
  access_code_id: string;
59043
59487
  /** Unique identifier for the device associated with the access code. */
59044
59488
  device_id: string;
59045
- /** Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. */
59489
+ /** Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.
59490
+
59491
+ 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`.
59492
+
59493
+ 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.
59494
+
59495
+ 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). */
59046
59496
  name: string | null;
59047
59497
  /** Code used for access. Typically, a numeric or alphanumeric string. */
59048
59498
  code: string | null;
@@ -59488,7 +59938,13 @@ interface Routes {
59488
59938
  access_code_id: string;
59489
59939
  /** Unique identifier for the device associated with the access code. */
59490
59940
  device_id: string;
59491
- /** Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. */
59941
+ /** Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.
59942
+
59943
+ 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`.
59944
+
59945
+ 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.
59946
+
59947
+ 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). */
59492
59948
  name: string | null;
59493
59949
  /** Code used for access. Typically, a numeric or alphanumeric string. */
59494
59950
  code: string | null;
@@ -59938,7 +60394,13 @@ interface Routes {
59938
60394
  method: 'POST' | 'PATCH' | 'PUT';
59939
60395
  queryParams: {};
59940
60396
  jsonBody: {
59941
- /** Name of the new access code. */
60397
+ /** Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.
60398
+
60399
+ 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`.
60400
+
60401
+ 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.
60402
+
60403
+ 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). */
59942
60404
  name?: string | undefined;
59943
60405
  /** 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. */
59944
60406
  starts_at?: string | undefined;
@@ -61092,7 +61554,13 @@ interface Routes {
61092
61554
  ends_at?: string | undefined;
61093
61555
  /** 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. */
61094
61556
  starts_at?: string | undefined;
61095
- /** Name of the new access code. */
61557
+ /** Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.
61558
+
61559
+ 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`.
61560
+
61561
+ 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.
61562
+
61563
+ 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). */
61096
61564
  name?: string | undefined;
61097
61565
  /** Key that links the group of access codes, assigned on creation by `/access_codes/create_multiple`. */
61098
61566
  common_code_key: string;
@@ -61107,9 +61575,9 @@ interface Routes {
61107
61575
  queryParams: {};
61108
61576
  jsonBody: {};
61109
61577
  commonParams: {
61110
- /** ID of the desired access group. */
61578
+ /** ID of the access group to which you want to add an access system user. */
61111
61579
  acs_access_group_id: string;
61112
- /** ID of the desired user. */
61580
+ /** ID of the access system user that you want to add to an access group. */
61113
61581
  acs_user_id: string;
61114
61582
  };
61115
61583
  formData: {};
@@ -61121,7 +61589,7 @@ interface Routes {
61121
61589
  queryParams: {};
61122
61590
  jsonBody: {};
61123
61591
  commonParams: {
61124
- /** ID of the desired access group. */
61592
+ /** ID of the access group that you want to get. */
61125
61593
  acs_access_group_id: string;
61126
61594
  };
61127
61595
  formData: {};
@@ -61172,9 +61640,9 @@ interface Routes {
61172
61640
  queryParams: {};
61173
61641
  jsonBody: {};
61174
61642
  commonParams: {
61175
- /** ID of the access control system for which you want to retrieve all access groups. */
61643
+ /** ID of the access system for which you want to retrieve all access groups. */
61176
61644
  acs_system_id?: string | undefined;
61177
- /** ID of the user for which you want to retrieve all access groups. */
61645
+ /** ID of the access system user for which you want to retrieve all access groups. */
61178
61646
  acs_user_id?: string | undefined;
61179
61647
  /** ID of the user identity for which you want to retrieve all access groups. */
61180
61648
  user_identity_id?: string | undefined;
@@ -61297,7 +61765,7 @@ interface Routes {
61297
61765
  queryParams: {};
61298
61766
  jsonBody: {};
61299
61767
  commonParams: {
61300
- /** ID of the access group for which you want to retrieve all users. */
61768
+ /** ID of the access group for which you want to retrieve all access system users. */
61301
61769
  acs_access_group_id: string;
61302
61770
  };
61303
61771
  formData: {};
@@ -61492,11 +61960,11 @@ interface Routes {
61492
61960
  queryParams: {};
61493
61961
  jsonBody: {};
61494
61962
  commonParams: {
61495
- /** ID of the desired access group. */
61963
+ /** ID of the access group from which you want to remove an access system user. */
61496
61964
  acs_access_group_id: string;
61497
- /** ID of the desired user. */
61965
+ /** ID of the access system user that you want to remove from an access group. */
61498
61966
  acs_user_id?: string | undefined;
61499
- /** ID of the desired user identity. */
61967
+ /** ID of the user identity associated with the user that you want to remove from an access group. */
61500
61968
  user_identity_id?: string | undefined;
61501
61969
  };
61502
61970
  formData: {};
@@ -61508,7 +61976,7 @@ interface Routes {
61508
61976
  queryParams: {};
61509
61977
  jsonBody: {};
61510
61978
  commonParams: {
61511
- /** ID of the desired unmanaged access group. */
61979
+ /** ID of the unmanaged access group that you want to get. */
61512
61980
  acs_access_group_id: string;
61513
61981
  };
61514
61982
  formData: {};
@@ -61555,9 +62023,9 @@ interface Routes {
61555
62023
  queryParams: {};
61556
62024
  jsonBody: {};
61557
62025
  commonParams: {
61558
- /** ID of the access control system for which you want to retrieve all unmanaged access groups. */
62026
+ /** ID of the access system for which you want to retrieve all unmanaged access groups. */
61559
62027
  acs_system_id?: string | undefined;
61560
- /** ID of the user for which you want to retrieve all unmanaged access groups. */
62028
+ /** ID of the access system user for which you want to retrieve all unmanaged access groups. */
61561
62029
  acs_user_id?: string | undefined;
61562
62030
  };
61563
62031
  formData: {};
@@ -61603,6 +62071,7 @@ interface Routes {
61603
62071
  queryParams: {};
61604
62072
  jsonBody: {};
61605
62073
  commonParams: {
62074
+ /** ID of the access system for which you want to list credential pools. */
61606
62075
  acs_system_id: string;
61607
62076
  };
61608
62077
  formData: {};
@@ -61624,10 +62093,15 @@ interface Routes {
61624
62093
  queryParams: {};
61625
62094
  jsonBody: {};
61626
62095
  commonParams: {
62096
+ /** ID of the user identity for which you want to launch a credential provisioning automation. */
61627
62097
  user_identity_id: string;
62098
+ /** Access system ID of the credential manager for which you want to launch a credential provisioning automation. */
61628
62099
  credential_manager_acs_system_id: string;
62100
+ /** ID of the credential pool for which you want to launch a credential provisioning automation. */
61629
62101
  acs_credential_pool_id?: string | undefined;
62102
+ /** 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`. */
61630
62103
  create_credential_manager_user?: boolean | undefined;
62104
+ /** 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`. */
61631
62105
  credential_manager_acs_user_id?: string | undefined;
61632
62106
  };
61633
62107
  formData: {};
@@ -61647,9 +62121,9 @@ interface Routes {
61647
62121
  method: 'PATCH' | 'POST';
61648
62122
  queryParams: {};
61649
62123
  jsonBody: {
61650
- /** ID of the desired user. */
62124
+ /** ID of the access system user to whom you want to assign a credential. */
61651
62125
  acs_user_id: string;
61652
- /** ID of the desired credential. */
62126
+ /** ID of the credential that you want to assign to an access system user. */
61653
62127
  acs_credential_id: string;
61654
62128
  };
61655
62129
  commonParams: {};
@@ -61783,8 +62257,12 @@ interface Routes {
61783
62257
  commonParams: {
61784
62258
  /** ACS system ID of the credential manager for the new credential. */
61785
62259
  credential_manager_acs_system_id?: string | undefined;
61786
- /** ID of the ACS user to whom the new credential belongs. */
61787
- acs_user_id: string;
62260
+ /** 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`. */
62261
+ acs_user_id?: string | undefined;
62262
+ /** 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. */
62263
+ user_identity_id?: string | undefined;
62264
+ /** 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`. */
62265
+ acs_system_id?: string | undefined;
61788
62266
  /** Access method for the new credential. Supported values: `code`, `card`, `mobile_key`. */
61789
62267
  access_method: 'code' | 'card' | 'mobile_key';
61790
62268
  /** Access (PIN) code for the new credential. There may be manufacturer-specific code restrictions. For details, see the applicable [device or system integration guide](https://docs.seam.co/latest/device-and-system-integration-guides/overview). */
@@ -61816,7 +62294,9 @@ interface Routes {
61816
62294
  } | undefined;
61817
62295
  /** Salto Space-specific metadata for the new credential. */
61818
62296
  salto_space_metadata?: {
62297
+ /** 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). */
61819
62298
  assign_new_key?: boolean | undefined;
62299
+ /** 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). */
61820
62300
  update_current_key?: boolean | undefined;
61821
62301
  } | undefined;
61822
62302
  /** 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. */
@@ -61952,7 +62432,7 @@ interface Routes {
61952
62432
  queryParams: {};
61953
62433
  jsonBody: {};
61954
62434
  commonParams: {
61955
- /** ID of the ACS user to whom the new credential belongs. */
62435
+ /** ID of the access system user to whom the new credential belongs. */
61956
62436
  acs_user_id: string;
61957
62437
  /** 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. */
61958
62438
  allowed_acs_entrance_id: string;
@@ -62091,7 +62571,7 @@ interface Routes {
62091
62571
  queryParams: {};
62092
62572
  jsonBody: {};
62093
62573
  commonParams: {
62094
- /** ID of the desired credential. */
62574
+ /** ID of the credential that you want to delete. */
62095
62575
  acs_credential_id: string;
62096
62576
  };
62097
62577
  formData: {};
@@ -62103,7 +62583,7 @@ interface Routes {
62103
62583
  queryParams: {};
62104
62584
  jsonBody: {};
62105
62585
  commonParams: {
62106
- /** ID of the desired credential. */
62586
+ /** ID of the credential that you want to get. */
62107
62587
  acs_credential_id: string;
62108
62588
  };
62109
62589
  formData: {};
@@ -62234,15 +62714,15 @@ interface Routes {
62234
62714
  queryParams: {};
62235
62715
  jsonBody: {};
62236
62716
  commonParams: ({
62237
- /** ID of the ACS user for which you want to retrieve all credentials. */
62717
+ /** ID of the access system user for which you want to retrieve all credentials. */
62238
62718
  acs_user_id: string;
62239
62719
  } | {
62240
- /** ID of the access control system for which you want to retrieve all credentials. */
62720
+ /** ID of the access system for which you want to retrieve all credentials. */
62241
62721
  acs_system_id: string;
62242
62722
  } | {
62243
- /** ID of the ACS user for which you want to retrieve all credentials. */
62723
+ /** ID of the access system user for which you want to retrieve all credentials. */
62244
62724
  acs_user_id: string;
62245
- /** ID of the access control system for which you want to retrieve all credentials. */
62725
+ /** ID of the access system for which you want to retrieve all credentials. */
62246
62726
  acs_system_id: string;
62247
62727
  } | {
62248
62728
  /** ID of the user identity for which you want to retrieve all credentials. */
@@ -62378,7 +62858,7 @@ interface Routes {
62378
62858
  queryParams: {};
62379
62859
  jsonBody: {};
62380
62860
  commonParams: {
62381
- /** ID of the credential for which you want to retrieve all entrances to which this credential grants access. */
62861
+ /** ID of the credential for which you want to retrieve all entrances to which the credential grants access. */
62382
62862
  acs_credential_id: string;
62383
62863
  };
62384
62864
  formData: {};
@@ -62452,9 +62932,9 @@ interface Routes {
62452
62932
  method: 'PATCH' | 'POST';
62453
62933
  queryParams: {};
62454
62934
  jsonBody: {
62455
- /** ID of the desired user. */
62935
+ /** ID of the access system user from which you want to unassign a credential. */
62456
62936
  acs_user_id: string;
62457
- /** ID of the desired credential. */
62937
+ /** ID of the credential that you want to unassign from an access system user. */
62458
62938
  acs_credential_id: string;
62459
62939
  };
62460
62940
  commonParams: {};
@@ -62586,7 +63066,7 @@ interface Routes {
62586
63066
  queryParams: {};
62587
63067
  jsonBody: {};
62588
63068
  commonParams: {
62589
- /** ID of the desired unmanaged credential. */
63069
+ /** ID of the unmanaged credential that you want to get. */
62590
63070
  acs_credential_id: string;
62591
63071
  };
62592
63072
  formData: {};
@@ -62713,15 +63193,15 @@ interface Routes {
62713
63193
  queryParams: {};
62714
63194
  jsonBody: {};
62715
63195
  commonParams: {
62716
- /** ID of the ACS user for which you want to retrieve all credentials. */
63196
+ /** ID of the access system user for which you want to retrieve all credentials. */
62717
63197
  acs_user_id: string;
62718
63198
  } | {
62719
- /** ID of the access control system for which you want to retrieve all credentials. */
63199
+ /** ID of the access system for which you want to retrieve all credentials. */
62720
63200
  acs_system_id: string;
62721
63201
  } | {
62722
- /** ID of the ACS user for which you want to retrieve all credentials. */
63202
+ /** ID of the access system user for which you want to retrieve all credentials. */
62723
63203
  acs_user_id: string;
62724
- /** ID of the access control system for which you want to retrieve all credentials. */
63204
+ /** ID of the access system for which you want to retrieve all credentials. */
62725
63205
  acs_system_id: string;
62726
63206
  } | {
62727
63207
  /** ID of the user identity for which you want to retrieve all credentials. */
@@ -62849,9 +63329,9 @@ interface Routes {
62849
63329
  method: 'PATCH' | 'POST';
62850
63330
  queryParams: {};
62851
63331
  jsonBody: {
62852
- /** ID of the desired credential. */
63332
+ /** ID of the credential that you want to update. */
62853
63333
  acs_credential_id: string;
62854
- /** Replacement access (PIN) code for the credential. */
63334
+ /** Replacement access (PIN) code for the credential that you want to update. */
62855
63335
  code?: string | undefined;
62856
63336
  /** 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. */
62857
63337
  ends_at?: string | undefined;
@@ -65221,7 +65701,7 @@ interface Routes {
65221
65701
  queryParams: {};
65222
65702
  jsonBody: {};
65223
65703
  commonParams: {
65224
- /** ID of the desired encoder. */
65704
+ /** ID of the encoder that you want to get. */
65225
65705
  acs_encoder_id: string;
65226
65706
  };
65227
65707
  formData: {};
@@ -65269,19 +65749,19 @@ interface Routes {
65269
65749
  queryParams: {};
65270
65750
  jsonBody: {};
65271
65751
  commonParams: {
65272
- /** ID of the `acs_system` for which you want to retrieve all `acs_encoder`s. */
65752
+ /** ID of the access system for which you want to retrieve all encoders. */
65273
65753
  acs_system_id: string;
65274
- /** Number of `acs_encoders` to return. */
65754
+ /** Number of encoders to return. */
65275
65755
  limit?: number;
65276
65756
  } | {
65277
- /** IDs of the `acs_system`s for which you want to retrieve all `acs_encoder`s. */
65757
+ /** IDs of the access systems for which you want to retrieve all encoders. */
65278
65758
  acs_system_ids: string[];
65279
- /** Number of `acs_encoders` to return. */
65759
+ /** Number of encoders to return. */
65280
65760
  limit?: number;
65281
65761
  } | {
65282
- /** IDs of the `acs_encoder`s that you want to retrieve. */
65762
+ /** IDs of the encoders that you want to retrieve. */
65283
65763
  acs_encoder_ids: string[];
65284
- /** Number of `acs_encoders` to return. */
65764
+ /** Number of encoders to return. */
65285
65765
  limit?: number;
65286
65766
  };
65287
65767
  formData: {};
@@ -65315,7 +65795,7 @@ interface Routes {
65315
65795
  queryParams: {};
65316
65796
  jsonBody: {};
65317
65797
  commonParams: {
65318
- /** ID of the `acs_encoder` to use for the scan. */
65798
+ /** ID of the encoder to use for the scan. */
65319
65799
  acs_encoder_id: string;
65320
65800
  };
65321
65801
  formData: {};
@@ -66510,6 +66990,7 @@ interface Routes {
66510
66990
  queryParams: {};
66511
66991
  jsonBody: {};
66512
66992
  commonParams: {
66993
+ /** ID of the entrance that you want to get. */
66513
66994
  acs_entrance_id: string;
66514
66995
  };
66515
66996
  formData: {};
@@ -66586,7 +67067,9 @@ interface Routes {
66586
67067
  method: 'POST';
66587
67068
  queryParams: {};
66588
67069
  jsonBody: {
67070
+ /** ID of the entrance to which you want to grant an access system user access. */
66589
67071
  acs_entrance_id: string;
67072
+ /** ID of the access system user to whom you want to grant access to an entrance. */
66590
67073
  acs_user_id: string;
66591
67074
  };
66592
67075
  commonParams: {};
@@ -66599,9 +67082,11 @@ interface Routes {
66599
67082
  queryParams: {};
66600
67083
  jsonBody: {};
66601
67084
  commonParams: {
67085
+ /** ID of the access system for which you want to retrieve all entrances. */
66602
67086
  acs_system_id?: string | undefined;
67087
+ /** ID of the credential for which you want to retrieve all entrances. */
66603
67088
  acs_credential_id?: string | undefined;
66604
- /** */
67089
+ /** ID of the location for which you want to retrieve all entrances. */
66605
67090
  location_id?: (string | null) | undefined;
66606
67091
  };
66607
67092
  formData: {};
@@ -66676,7 +67161,9 @@ interface Routes {
66676
67161
  queryParams: {};
66677
67162
  jsonBody: {};
66678
67163
  commonParams: {
67164
+ /** ID of the entrance for which you want to list all credentials that grant access. */
66679
67165
  acs_entrance_id: string;
67166
+ /** Conditions that credentials must meet to be included in the returned list. */
66680
67167
  include_if?: Array<'visionline_metadata.is_valid'> | undefined;
66681
67168
  };
66682
67169
  formData: {};
@@ -66802,7 +67289,7 @@ interface Routes {
66802
67289
  queryParams: {};
66803
67290
  jsonBody: {};
66804
67291
  commonParams: {
66805
- /** ID of the desired access control system. */
67292
+ /** ID of the access system that you want to get. */
66806
67293
  acs_system_id: string;
66807
67294
  };
66808
67295
  formData: {};
@@ -66952,7 +67439,7 @@ interface Routes {
66952
67439
  queryParams: {};
66953
67440
  jsonBody: {};
66954
67441
  commonParams: {
66955
- /** ID of the connected account by which to filter the list of returned access control systems. */
67442
+ /** ID of the connected account by which you want to filter the list of access systems. */
66956
67443
  connected_account_id?: string | undefined;
66957
67444
  };
66958
67445
  formData: {};
@@ -67097,7 +67584,7 @@ interface Routes {
67097
67584
  queryParams: {};
67098
67585
  jsonBody: {};
67099
67586
  commonParams: {
67100
- /** ID of the ACS system for which you want to retrieve all compatible credential manager ACS systems. */
67587
+ /** ID of the access system for which you want to retrieve all compatible credential manager systems. */
67101
67588
  acs_system_id: string;
67102
67589
  };
67103
67590
  formData: {};
@@ -67242,9 +67729,9 @@ interface Routes {
67242
67729
  queryParams: {};
67243
67730
  jsonBody: {};
67244
67731
  commonParams: {
67245
- /** ID of the desired `acs_user`. */
67732
+ /** ID of the access system user that you want to add to an access group. */
67246
67733
  acs_user_id: string;
67247
- /** ID of the desired access group. */
67734
+ /** ID of the access group to which you want to add an access system user. */
67248
67735
  acs_access_group_id: string;
67249
67736
  };
67250
67737
  formData: {};
@@ -67255,17 +67742,19 @@ interface Routes {
67255
67742
  method: 'POST';
67256
67743
  queryParams: {};
67257
67744
  jsonBody: {
67258
- /** Full name of the new `acs_user`. */
67745
+ /** Full name of the new access system user. */
67259
67746
  full_name: string;
67260
- /** ID of the `acs_system` to which to add the new `acs_user`. */
67747
+ /** ID of the access system to which you want to add the new access system user. */
67261
67748
  acs_system_id: string;
67262
- /** Array of `access_group_id`s to indicate the access groups to which to add the new `acs_user`. */
67749
+ /** Array of access group IDs to indicate the access groups to which you want to add the new access system user. */
67263
67750
  acs_access_group_ids?: string[];
67264
- /** ID of the user identity with which to associate the new `acs_user`. */
67751
+ /** ID of the user identity with which you want to associate the new access system user. */
67265
67752
  user_identity_id?: string | undefined;
67266
- /** `starts_at` and `ends_at` timestamps for the new `acs_user`'s access. If you specify an `access_schedule`, you may include both `starts_at` and `ends_at`. `starts_at` defaults to the current time if not provided. `ends_at` is optional and must be a time in the future and after `starts_at`. */
67753
+ /** `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`. */
67267
67754
  access_schedule?: {
67755
+ /** Starting timestamp for the new access system user's access. */
67268
67756
  starts_at?: string | undefined;
67757
+ /** Ending timestamp for the new access system user's access. */
67269
67758
  ends_at?: (string | undefined) | null;
67270
67759
  } | undefined;
67271
67760
  /**
@@ -67474,7 +67963,7 @@ interface Routes {
67474
67963
  queryParams: {};
67475
67964
  jsonBody: {};
67476
67965
  commonParams: {
67477
- /** ID of the desired `acs_user`. */
67966
+ /** ID of the access system user that you want to delete. */
67478
67967
  acs_user_id: string;
67479
67968
  };
67480
67969
  formData: {};
@@ -67486,7 +67975,7 @@ interface Routes {
67486
67975
  queryParams: {};
67487
67976
  jsonBody: {};
67488
67977
  commonParams: {
67489
- /** ID of the desired `acs_user`. */
67978
+ /** ID of the access system user that you want to get. */
67490
67979
  acs_user_id: string;
67491
67980
  };
67492
67981
  formData: {};
@@ -67686,18 +68175,19 @@ interface Routes {
67686
68175
  queryParams: {};
67687
68176
  jsonBody: {};
67688
68177
  commonParams: {
67689
- /** ID of the user identity for which you want to retrieve all `acs_user`s. */
68178
+ /** ID of the user identity for which you want to retrieve all access system users. */
67690
68179
  user_identity_id?: string | undefined;
67691
- /** Phone number of the user identity for which you want to retrieve all `acs_user`s, in [E.164 format](https://www.itu.int/rec/T-REC-E.164/en) (for example, `+15555550100`). */
68180
+ /** 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`). */
67692
68181
  user_identity_phone_number?: string | undefined;
67693
- /** Email address of the user identity for which you want to retrieve all `acs_user`s. */
68182
+ /** Email address of the user identity for which you want to retrieve all access system users. */
67694
68183
  user_identity_email_address?: string | undefined;
67695
- /** ID of the `acs_system` for which you want to retrieve all `acs_user`s. */
68184
+ /** ID of the `acs_system` for which you want to retrieve all access system users. */
67696
68185
  acs_system_id?: string | undefined;
67697
- /** String for which to search. Filters returned `acs_user`s 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`. */
68186
+ /** 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`. */
67698
68187
  search?: string | undefined;
67699
68188
  /** Maximum number of records to return per page. */
67700
68189
  limit?: number;
68190
+ /** Timestamp by which to limit returned access system users. Returns users created before this timestamp. */
67701
68191
  created_before?: Date | undefined;
67702
68192
  /** Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`. */
67703
68193
  page_cursor?: (string | undefined) | null;
@@ -67903,7 +68393,7 @@ interface Routes {
67903
68393
  queryParams: {};
67904
68394
  jsonBody: {};
67905
68395
  commonParams: {
67906
- /** ID of the desired `acs_user`. */
68396
+ /** ID of the access system user for whom you want to list accessible entrances. */
67907
68397
  acs_user_id: string;
67908
68398
  };
67909
68399
  formData: {};
@@ -67978,9 +68468,9 @@ interface Routes {
67978
68468
  queryParams: {};
67979
68469
  jsonBody: {};
67980
68470
  commonParams: {
67981
- /** ID of the desired `acs_user`. */
68471
+ /** ID of the access system user that you want to remove from an access group. */
67982
68472
  acs_user_id: string;
67983
- /** ID of the desired access group. */
68473
+ /** ID of the access group from which you want to remove an access system user. */
67984
68474
  acs_access_group_id: string;
67985
68475
  };
67986
68476
  formData: {};
@@ -67991,7 +68481,7 @@ interface Routes {
67991
68481
  method: 'POST';
67992
68482
  queryParams: {};
67993
68483
  jsonBody: {
67994
- /** ID of the desired `acs_user`. */
68484
+ /** ID of the access system user for whom you want to revoke access. */
67995
68485
  acs_user_id: string;
67996
68486
  };
67997
68487
  commonParams: {};
@@ -68004,7 +68494,7 @@ interface Routes {
68004
68494
  queryParams: {};
68005
68495
  jsonBody: {};
68006
68496
  commonParams: {
68007
- /** ID of the desired `acs_user`. */
68497
+ /** ID of the access system user that you want to suspend. */
68008
68498
  acs_user_id: string;
68009
68499
  };
68010
68500
  formData: {};
@@ -68016,6 +68506,7 @@ interface Routes {
68016
68506
  queryParams: {};
68017
68507
  jsonBody: {};
68018
68508
  commonParams: {
68509
+ /** ID of the unmanaged access system user that you want to get. */
68019
68510
  acs_user_id: string;
68020
68511
  };
68021
68512
  formData: {};
@@ -68211,10 +68702,15 @@ interface Routes {
68211
68702
  queryParams: {};
68212
68703
  jsonBody: {};
68213
68704
  commonParams: {
68705
+ /** ID of the user identity for which you want to retrieve all unmanaged access system users. */
68214
68706
  user_identity_id?: string | undefined;
68707
+ /** Phone number of the user identity for which you want to retrieve all unmanaged access system users. */
68215
68708
  user_identity_phone_number?: string | undefined;
68709
+ /** Email address of the user identity for which you want to retrieve all unmanaged access system users. */
68216
68710
  user_identity_email_address?: string | undefined;
68711
+ /** ID of the access system for which you want to retrieve all unmanaged access system users. */
68217
68712
  acs_system_id?: string | undefined;
68713
+ /** Number of unmanaged access system users to return. */
68218
68714
  limit?: number;
68219
68715
  };
68220
68716
  formData: {};
@@ -68409,7 +68905,7 @@ interface Routes {
68409
68905
  queryParams: {};
68410
68906
  jsonBody: {};
68411
68907
  commonParams: {
68412
- /** ID of the desired `acs_user`. */
68908
+ /** ID of the access system user that you want to unsuspend. */
68413
68909
  acs_user_id: string;
68414
68910
  };
68415
68911
  formData: {};
@@ -68420,9 +68916,11 @@ interface Routes {
68420
68916
  method: 'PATCH' | 'POST';
68421
68917
  queryParams: {};
68422
68918
  jsonBody: {
68423
- /** `starts_at` and `ends_at` timestamps for the `acs_user`'s access. If you specify an `access_schedule`, you must include both `starts_at` and `ends_at`. `ends_at` must be a time in the future and after `starts_at`. */
68919
+ /** `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`. */
68424
68920
  access_schedule?: ({
68921
+ /** Starting timestamp for the access system user's access. */
68425
68922
  starts_at: string;
68923
+ /** Ending timestamp for the access system user's access. */
68426
68924
  ends_at: string;
68427
68925
  } | null) | undefined;
68428
68926
  /** ID of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). */
@@ -68448,6 +68946,7 @@ interface Routes {
68448
68946
  queryParams: {};
68449
68947
  jsonBody: {};
68450
68948
  commonParams: {
68949
+ /** ID of the action attempt that you want to get. */
68451
68950
  action_attempt_id: string;
68452
68951
  };
68453
68952
  formData: {};
@@ -69563,6 +70062,7 @@ interface Routes {
69563
70062
  queryParams: {};
69564
70063
  jsonBody: {};
69565
70064
  commonParams: {
70065
+ /** IDs of the action attempts that you want to retrieve. */
69566
70066
  action_attempt_ids: string[];
69567
70067
  };
69568
70068
  formData: {};
@@ -70677,6 +71177,7 @@ interface Routes {
70677
71177
  queryParams: {};
70678
71178
  jsonBody: {};
70679
71179
  commonParams: {
71180
+ /** ID of the Seam Bridge that you want to get. */
70680
71181
  bridge_id: string;
70681
71182
  };
70682
71183
  formData: {};
@@ -70709,16 +71210,29 @@ interface Routes {
70709
71210
  method: 'POST' | 'PUT';
70710
71211
  queryParams: {};
70711
71212
  jsonBody: {
71213
+ /** Your user ID for the user for whom you want to create a client session. */
70712
71214
  user_identifier_key?: string | undefined;
71215
+ /** IDs of the [Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews) for which you want to create a client session. */
70713
71216
  connect_webview_ids?: string[] | undefined;
71217
+ /** IDs of the [connected accounts](https://docs.seam.co/latest/core-concepts/connected-accounts) for which you want to create a client session. */
70714
71218
  connected_account_ids?: string[] | undefined;
71219
+ /** 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. */
70715
71220
  user_identity_ids?: string[] | undefined;
71221
+ /** 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. */
70716
71222
  expires_at?: Date | undefined;
70717
71223
  };
70718
71224
  commonParams: {};
70719
71225
  formData: {};
70720
71226
  jsonResponse: {
70721
- /** */
71227
+ /** 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.
71228
+
71229
+ You create each client session with a custom `user_identifier_key`. Normally, the `user_identifier_key` is a user ID that your application provides.
71230
+
71231
+ 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`.
71232
+
71233
+ 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.
71234
+
71235
+ 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). */
70722
71236
  client_session: {
70723
71237
  client_session_id: string;
70724
71238
  workspace_id: string;
@@ -70739,6 +71253,7 @@ interface Routes {
70739
71253
  queryParams: {};
70740
71254
  jsonBody: {};
70741
71255
  commonParams: {
71256
+ /** ID of the client session that you want to delete. */
70742
71257
  client_session_id: string;
70743
71258
  };
70744
71259
  formData: {};
@@ -70750,12 +71265,22 @@ interface Routes {
70750
71265
  queryParams: {};
70751
71266
  jsonBody: {};
70752
71267
  commonParams: {
71268
+ /** ID of the client session that you want to get. */
70753
71269
  client_session_id?: string | undefined;
71270
+ /** User identifier key associated with the client session that you want to get. */
70754
71271
  user_identifier_key?: string | undefined;
70755
71272
  };
70756
71273
  formData: {};
70757
71274
  jsonResponse: {
70758
- /** */
71275
+ /** 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.
71276
+
71277
+ You create each client session with a custom `user_identifier_key`. Normally, the `user_identifier_key` is a user ID that your application provides.
71278
+
71279
+ 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`.
71280
+
71281
+ 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.
71282
+
71283
+ 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). */
70759
71284
  client_session: {
70760
71285
  client_session_id: string;
70761
71286
  workspace_id: string;
@@ -70775,16 +71300,29 @@ interface Routes {
70775
71300
  method: 'POST';
70776
71301
  queryParams: {};
70777
71302
  jsonBody: {
71303
+ /** 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). */
70778
71304
  user_identifier_key?: string | undefined;
71305
+ /** 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). */
70779
71306
  connect_webview_ids?: string[] | undefined;
71307
+ /** 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). */
70780
71308
  connected_account_ids?: string[] | undefined;
71309
+ /** 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). */
70781
71310
  user_identity_ids?: string[] | undefined;
71311
+ /** 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. */
70782
71312
  expires_at?: Date | undefined;
70783
71313
  };
70784
71314
  commonParams: {};
70785
71315
  formData: {};
70786
71316
  jsonResponse: {
70787
- /** */
71317
+ /** 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.
71318
+
71319
+ You create each client session with a custom `user_identifier_key`. Normally, the `user_identifier_key` is a user ID that your application provides.
71320
+
71321
+ 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`.
71322
+
71323
+ 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.
71324
+
71325
+ 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). */
70788
71326
  client_session: {
70789
71327
  client_session_id: string;
70790
71328
  workspace_id: string;
@@ -70805,15 +71343,28 @@ interface Routes {
70805
71343
  queryParams: {};
70806
71344
  jsonBody: {};
70807
71345
  commonParams: {
71346
+ /** ID of the client session to which you want to grant access to resources. */
70808
71347
  client_session_id?: string | undefined;
71348
+ /** Your user ID for the user that you want to associate with the client session. */
70809
71349
  user_identifier_key?: string | undefined;
71350
+ /** IDs of the [connected accounts](https://docs.seam.co/latest/core-concepts/connected-accounts) that you want to associate with the client session. */
70810
71351
  connected_account_ids?: string[] | undefined;
71352
+ /** IDs of the [Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews) that you want to associate with the client session. */
70811
71353
  connect_webview_ids?: string[] | undefined;
71354
+ /** 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. */
70812
71355
  user_identity_ids?: string[] | undefined;
70813
71356
  };
70814
71357
  formData: {};
70815
71358
  jsonResponse: {
70816
- /** */
71359
+ /** 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.
71360
+
71361
+ You create each client session with a custom `user_identifier_key`. Normally, the `user_identifier_key` is a user ID that your application provides.
71362
+
71363
+ 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`.
71364
+
71365
+ 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.
71366
+
71367
+ 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). */
70817
71368
  client_session: {
70818
71369
  client_session_id: string;
70819
71370
  workspace_id: string;
@@ -70834,10 +71385,15 @@ interface Routes {
70834
71385
  queryParams: {};
70835
71386
  jsonBody: {};
70836
71387
  commonParams: {
71388
+ /** ID of the client session that you want to retrieve. */
70837
71389
  client_session_id?: string | undefined;
71390
+ /** Your user ID for the user by which you want to filter client sessions. */
70838
71391
  user_identifier_key?: string | undefined;
71392
+ /** ID of the [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews) for which you want to retrieve client sessions. */
70839
71393
  connect_webview_id?: string | undefined;
71394
+ /** Indicates whether to retrieve only client sessions without associated user identifier keys. */
70840
71395
  without_user_identifier_key?: boolean | undefined;
71396
+ /** 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. */
70841
71397
  user_identity_id?: string | undefined;
70842
71398
  };
70843
71399
  formData: {};
@@ -70862,6 +71418,7 @@ interface Routes {
70862
71418
  queryParams: {};
70863
71419
  jsonBody: {};
70864
71420
  commonParams: {
71421
+ /** ID of the client session that you want to revoke. */
70865
71422
  client_session_id: string;
70866
71423
  };
70867
71424
  formData: {};
@@ -70872,19 +71429,37 @@ interface Routes {
70872
71429
  method: 'POST';
70873
71430
  queryParams: {};
70874
71431
  jsonBody: {
71432
+ /** */
70875
71433
  device_selection_mode?: ('none' | 'single' | 'multiple') | undefined;
71434
+ /** URL that you want to redirect the user to after the provider login is complete. */
70876
71435
  custom_redirect_url?: string | undefined;
71436
+ /** 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`. */
70877
71437
  custom_redirect_failure_url?: string | undefined;
71438
+ /** 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. */
70878
71439
  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;
71440
+ /** 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. */
70879
71441
  provider_category?: ('stable' | 'consumer_smartlocks' | 'thermostats' | 'noise_sensors' | 'access_control_systems' | 'internal_beta') | undefined;
71442
+ /** 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). */
70880
71443
  custom_metadata?: Record<string, string | boolean | null> | undefined;
71444
+ /** 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). */
70881
71445
  automatically_manage_new_devices?: boolean;
71446
+ /** 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). */
70882
71447
  wait_for_device_creation?: boolean;
70883
71448
  };
70884
71449
  commonParams: {};
70885
71450
  formData: {};
70886
71451
  jsonResponse: {
70887
- /** */
71452
+ /** Represents a [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews).
71453
+
71454
+ 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.
71455
+
71456
+ 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.
71457
+
71458
+ 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.
71459
+
71460
+ 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.
71461
+
71462
+ 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. */
70888
71463
  connect_webview: {
70889
71464
  connect_webview_id: string;
70890
71465
  workspace_id: string;
@@ -70917,6 +71492,7 @@ interface Routes {
70917
71492
  method: 'DELETE' | 'POST';
70918
71493
  queryParams: {};
70919
71494
  jsonBody: {
71495
+ /** ID of the Connect Webview that you want to delete. */
70920
71496
  connect_webview_id: string;
70921
71497
  };
70922
71498
  commonParams: {};
@@ -70929,11 +71505,22 @@ interface Routes {
70929
71505
  queryParams: {};
70930
71506
  jsonBody: {};
70931
71507
  commonParams: {
71508
+ /** ID of the Connect Webview that you want to get. */
70932
71509
  connect_webview_id: string;
70933
71510
  };
70934
71511
  formData: {};
70935
71512
  jsonResponse: {
70936
- /** */
71513
+ /** Represents a [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews).
71514
+
71515
+ 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.
71516
+
71517
+ 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.
71518
+
71519
+ 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.
71520
+
71521
+ 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.
71522
+
71523
+ 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. */
70937
71524
  connect_webview: {
70938
71525
  connect_webview_id: string;
70939
71526
  workspace_id: string;
@@ -70967,10 +71554,11 @@ interface Routes {
70967
71554
  queryParams: {};
70968
71555
  jsonBody: {};
70969
71556
  commonParams: {
70970
- /** Returns webviews that can be accessed by the provided user_identifier_key. */
71557
+ /** Your user ID for the user by which you want to filter Connect Webviews. */
70971
71558
  user_identifier_key?: string | undefined;
70972
- /** Returns webviews whose custom_metadata contains all of the provided key/value pairs. */
71559
+ /** 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. */
70973
71560
  custom_metadata_has?: Record<string, string | boolean> | undefined;
71561
+ /** Maximum number of records to return per page. */
70974
71562
  limit?: number;
70975
71563
  };
70976
71564
  formData: {};
@@ -71007,7 +71595,9 @@ interface Routes {
71007
71595
  method: 'DELETE' | 'POST';
71008
71596
  queryParams: {};
71009
71597
  jsonBody: {
71598
+ /** ID of the connected account that you want to delete. */
71010
71599
  connected_account_id: string;
71600
+ /** */
71011
71601
  sync?: boolean;
71012
71602
  };
71013
71603
  commonParams: {};
@@ -71020,13 +71610,15 @@ interface Routes {
71020
71610
  queryParams: {};
71021
71611
  jsonBody: {};
71022
71612
  commonParams: {
71613
+ /** ID of the connected account that you want to get. */
71023
71614
  connected_account_id: string;
71024
71615
  } | {
71616
+ /** Email address associated with the connected account that you want to get. */
71025
71617
  email: string;
71026
71618
  };
71027
71619
  formData: {};
71028
71620
  jsonResponse: {
71029
- /** */
71621
+ /** 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. */
71030
71622
  connected_account: {
71031
71623
  connected_account_id?: string | undefined;
71032
71624
  created_at?: string | undefined;
@@ -71118,9 +71710,9 @@ interface Routes {
71118
71710
  queryParams: {};
71119
71711
  jsonBody: {};
71120
71712
  commonParams: {
71121
- /** Returns accounts that can be accessed by the provided user_identifier_key. */
71713
+ /** Your user ID for the user by which you want to filter connected accounts. */
71122
71714
  user_identifier_key?: string | undefined;
71123
- /** Returns accounts whose custom_metadata contains all of the provided key/value pairs. */
71715
+ /** 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. */
71124
71716
  custom_metadata_has?: Record<string, string | boolean> | undefined;
71125
71717
  customer_ids?: string[] | undefined;
71126
71718
  /** Maximum number of records to return per page. */
@@ -71229,14 +71821,17 @@ interface Routes {
71229
71821
  method: 'POST';
71230
71822
  queryParams: {};
71231
71823
  jsonBody: {
71824
+ /** ID of the connected account that you want to update. */
71232
71825
  connected_account_id: string;
71826
+ /** Indicates whether newly-added devices should appear as [managed devices](https://docs.seam.co/latest/core-concepts/devices/managed-and-unmanaged-devices). */
71233
71827
  automatically_manage_new_devices?: boolean | undefined;
71828
+ /** 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). */
71234
71829
  custom_metadata?: Record<string, string | boolean | null> | undefined;
71235
71830
  };
71236
71831
  commonParams: {};
71237
71832
  formData: {};
71238
71833
  jsonResponse: {
71239
- /** */
71834
+ /** 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. */
71240
71835
  connected_account: {
71241
71836
  connected_account_id?: string | undefined;
71242
71837
  created_at?: string | undefined;
@@ -71328,6 +71923,7 @@ interface Routes {
71328
71923
  queryParams: {};
71329
71924
  jsonBody: {};
71330
71925
  commonParams: {
71926
+ /** ID of the device that you want to delete. */
71331
71927
  device_id: string;
71332
71928
  };
71333
71929
  formData: {};
@@ -71339,12 +71935,14 @@ interface Routes {
71339
71935
  queryParams: {};
71340
71936
  jsonBody: {};
71341
71937
  commonParams: {
71938
+ /** ID of the device that you want to get. */
71342
71939
  device_id?: string | undefined;
71940
+ /** Name of the device that you want to get. */
71343
71941
  name?: string | undefined;
71344
71942
  };
71345
71943
  formData: {};
71346
71944
  jsonResponse: {
71347
- /** */
71945
+ /** Represents a [device](https://docs.seam.co/latest/core-concepts/devices) that has been connected to Seam. */
71348
71946
  device: {
71349
71947
  /** Unique identifier for the device. */
71350
71948
  device_id: string;
@@ -71402,7 +72000,7 @@ interface Routes {
71402
72000
  level: number;
71403
72001
  status: 'critical' | 'low' | 'good' | 'full';
71404
72002
  } | undefined;
71405
- /** Manufacturer of the device. */
72003
+ /** 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. */
71406
72004
  manufacturer?: string | undefined;
71407
72005
  /** Image URL for the device. */
71408
72006
  image_url?: string | undefined;
@@ -71681,6 +72279,7 @@ interface Routes {
71681
72279
  } | undefined;
71682
72280
  }) & ({
71683
72281
  _experimental_supported_code_from_access_codes_lengths?: (number[] | undefined) | undefined;
72282
+ /** 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. */
71684
72283
  code_constraints?: (Array<{
71685
72284
  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';
71686
72285
  } | {
@@ -72106,27 +72705,27 @@ interface Routes {
72106
72705
  jsonBody: {};
72107
72706
  commonParams: {
72108
72707
  customer_ids?: string[] | undefined;
72109
- /** ID of the connected account by which to filter. */
72708
+ /** ID of the connected account for which you want to list devices. */
72110
72709
  connected_account_id?: string | undefined;
72111
- /** Array of IDs of the connected accounts by which to filter devices. */
72710
+ /** Array of IDs of the connected accounts for which you want to list devices. */
72112
72711
  connected_account_ids?: string[] | undefined;
72113
- /** ID of the Connect Webview by which to filter devices. */
72712
+ /** ID of the Connect Webview for which you want to list devices. */
72114
72713
  connect_webview_id?: string | undefined;
72115
- /** Device type by which to filter devices. */
72714
+ /** Device type for which you want to list devices. */
72116
72715
  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;
72117
- /** Array of device types by which to filter devices. */
72716
+ /** Array of device types for which you want to list devices. */
72118
72717
  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;
72119
- /** Manufacturer by which to filter devices. */
72718
+ /** Manufacturer for which you want to list devices. */
72120
72719
  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;
72121
- /** Array of device IDs by which to filter devices. */
72720
+ /** Array of device IDs for which you want to list devices. */
72122
72721
  device_ids?: string[] | undefined;
72123
72722
  /** Numerical limit on the number of devices to return. */
72124
72723
  limit?: number;
72125
- /** Date threshold for devices to return. If specified, returns only devices created before the specified date. */
72724
+ /** Timestamp by which to limit returned devices. Returns devices created before this timestamp. */
72126
72725
  created_before?: Date | undefined;
72127
- /** Your own internal user ID for the user by which to filter devices. */
72726
+ /** Your own internal user ID for the user for which you want to list devices. */
72128
72727
  user_identifier_key?: string | undefined;
72129
- /** Set of key:value [custom metadata](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device) pairs by which you want to filter devices. */
72728
+ /** 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. */
72130
72729
  custom_metadata_has?: Record<string, string | boolean> | undefined;
72131
72730
  /** Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`. */
72132
72731
  page_cursor?: (string | undefined) | null;
@@ -72134,7 +72733,7 @@ interface Routes {
72134
72733
  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;
72135
72734
  /** */
72136
72735
  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;
72137
- /** */
72736
+ /** ID of the location for which you want to list devices. */
72138
72737
  unstable_location_id?: (string | null) | undefined;
72139
72738
  };
72140
72739
  formData: {};
@@ -72196,7 +72795,7 @@ interface Routes {
72196
72795
  level: number;
72197
72796
  status: 'critical' | 'low' | 'good' | 'full';
72198
72797
  } | undefined;
72199
- /** Manufacturer of the device. */
72798
+ /** 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. */
72200
72799
  manufacturer?: string | undefined;
72201
72800
  /** Image URL for the device. */
72202
72801
  image_url?: string | undefined;
@@ -72475,6 +73074,7 @@ interface Routes {
72475
73074
  } | undefined;
72476
73075
  }) & ({
72477
73076
  _experimental_supported_code_from_access_codes_lengths?: (number[] | undefined) | undefined;
73077
+ /** 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. */
72478
73078
  code_constraints?: (Array<{
72479
73079
  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';
72480
73080
  } | {
@@ -72908,6 +73508,7 @@ interface Routes {
72908
73508
  queryParams: {};
72909
73509
  jsonBody: {};
72910
73510
  commonParams: {
73511
+ /** Category for which you want to list providers. */
72911
73512
  provider_category?: ('stable' | 'consumer_smartlocks' | 'thermostats' | 'noise_sensors' | 'access_control_systems') | undefined;
72912
73513
  };
72913
73514
  formData: {};
@@ -72936,6 +73537,7 @@ interface Routes {
72936
73537
  method: 'POST';
72937
73538
  queryParams: {};
72938
73539
  jsonBody: {
73540
+ /** ID of the device that you want to simulate connecting to Seam. */
72939
73541
  device_id: string;
72940
73542
  };
72941
73543
  commonParams: {};
@@ -72947,6 +73549,7 @@ interface Routes {
72947
73549
  method: 'POST';
72948
73550
  queryParams: {};
72949
73551
  jsonBody: {
73552
+ /** ID of the device that you want to simulate disconnecting from Seam. */
72950
73553
  device_id: string;
72951
73554
  };
72952
73555
  commonParams: {};
@@ -72958,6 +73561,7 @@ interface Routes {
72958
73561
  method: 'DELETE' | 'POST';
72959
73562
  queryParams: {};
72960
73563
  jsonBody: {
73564
+ /** ID of the device that you want to simulate removing from Seam. */
72961
73565
  device_id: string;
72962
73566
  };
72963
73567
  commonParams: {};
@@ -72970,12 +73574,14 @@ interface Routes {
72970
73574
  queryParams: {};
72971
73575
  jsonBody: {};
72972
73576
  commonParams: {
73577
+ /** ID of the unmanaged device that you want to get. */
72973
73578
  device_id?: string | undefined;
73579
+ /** Name of the unmanaged device that you want to get. */
72974
73580
  name?: string | undefined;
72975
73581
  };
72976
73582
  formData: {};
72977
73583
  jsonResponse: {
72978
- /** */
73584
+ /** 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). */
72979
73585
  device: {
72980
73586
  /** Unique identifier for the device. */
72981
73587
  device_id: string;
@@ -73197,7 +73803,7 @@ interface Routes {
73197
73803
  name: string;
73198
73804
  /** Indicates whether the device is online. */
73199
73805
  online: boolean;
73200
- /** Manufacturer of the device. */
73806
+ /** 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. */
73201
73807
  manufacturer?: string | undefined;
73202
73808
  /** Image URL for the device. */
73203
73809
  image_url?: string | undefined;
@@ -73253,27 +73859,27 @@ interface Routes {
73253
73859
  jsonBody: {};
73254
73860
  commonParams: {
73255
73861
  customer_ids?: string[] | undefined;
73256
- /** ID of the connected account by which to filter. */
73862
+ /** ID of the connected account for which you want to list devices. */
73257
73863
  connected_account_id?: string | undefined;
73258
- /** Array of IDs of the connected accounts by which to filter devices. */
73864
+ /** Array of IDs of the connected accounts for which you want to list devices. */
73259
73865
  connected_account_ids?: string[] | undefined;
73260
- /** ID of the Connect Webview by which to filter devices. */
73866
+ /** ID of the Connect Webview for which you want to list devices. */
73261
73867
  connect_webview_id?: string | undefined;
73262
- /** Device type by which to filter devices. */
73868
+ /** Device type for which you want to list devices. */
73263
73869
  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;
73264
- /** Array of device types by which to filter devices. */
73870
+ /** Array of device types for which you want to list devices. */
73265
73871
  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;
73266
- /** Manufacturer by which to filter devices. */
73872
+ /** Manufacturer for which you want to list devices. */
73267
73873
  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;
73268
- /** Array of device IDs by which to filter devices. */
73874
+ /** Array of device IDs for which you want to list devices. */
73269
73875
  device_ids?: string[] | undefined;
73270
73876
  /** Numerical limit on the number of devices to return. */
73271
73877
  limit?: number;
73272
- /** Date threshold for devices to return. If specified, returns only devices created before the specified date. */
73878
+ /** Timestamp by which to limit returned devices. Returns devices created before this timestamp. */
73273
73879
  created_before?: Date | undefined;
73274
- /** Your own internal user ID for the user by which to filter devices. */
73880
+ /** Your own internal user ID for the user for which you want to list devices. */
73275
73881
  user_identifier_key?: string | undefined;
73276
- /** Set of key:value [custom metadata](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device) pairs by which you want to filter devices. */
73882
+ /** 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. */
73277
73883
  custom_metadata_has?: Record<string, string | boolean> | undefined;
73278
73884
  /** Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`. */
73279
73885
  page_cursor?: (string | undefined) | null;
@@ -73281,7 +73887,7 @@ interface Routes {
73281
73887
  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;
73282
73888
  /** */
73283
73889
  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;
73284
- /** */
73890
+ /** ID of the location for which you want to list devices. */
73285
73891
  unstable_location_id?: (string | null) | undefined;
73286
73892
  };
73287
73893
  formData: {};
@@ -73507,7 +74113,7 @@ interface Routes {
73507
74113
  name: string;
73508
74114
  /** Indicates whether the device is online. */
73509
74115
  online: boolean;
73510
- /** Manufacturer of the device. */
74116
+ /** 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. */
73511
74117
  manufacturer?: string | undefined;
73512
74118
  /** Image URL for the device. */
73513
74119
  image_url?: string | undefined;
@@ -73562,7 +74168,9 @@ interface Routes {
73562
74168
  queryParams: {};
73563
74169
  jsonBody: {};
73564
74170
  commonParams: {
74171
+ /** ID of the unmanaged device that you want to update. */
73565
74172
  device_id: string;
74173
+ /** Indicates whether the device is managed. Set this parameter to `true` to convert an unmanaged device to managed. */
73566
74174
  is_managed: true;
73567
74175
  };
73568
74176
  formData: {};
@@ -73574,12 +74182,17 @@ interface Routes {
73574
74182
  queryParams: {};
73575
74183
  jsonBody: {};
73576
74184
  commonParams: {
74185
+ /** ID of the device that you want to update. */
73577
74186
  device_id: string;
73578
74187
  properties?: {
74188
+ /** Name for the device. */
73579
74189
  name?: (string | null) | undefined;
73580
74190
  } | undefined;
74191
+ /** Name for the device. */
73581
74192
  name?: (string | null) | undefined;
74193
+ /** Indicates whether the device is managed. To unmanage a device, set `is_managed` to `false`. */
73582
74194
  is_managed?: boolean;
74195
+ /** 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). */
73583
74196
  custom_metadata?: Record<string, string | boolean | null> | undefined;
73584
74197
  };
73585
74198
  formData: {};
@@ -73597,7 +74210,9 @@ interface Routes {
73597
74210
  };
73598
74211
  formData: {};
73599
74212
  jsonResponse: {
73600
- /** */
74213
+ /** 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.
74214
+
74215
+ 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. */
73601
74216
  event?: ({
73602
74217
  /** ID of the event. */
73603
74218
  event_id: string;
@@ -76361,7 +76976,7 @@ interface Routes {
76361
76976
  };
76362
76977
  formData: {};
76363
76978
  jsonResponse: {
76364
- /** */
76979
+ /** Represents a [device](https://docs.seam.co/latest/core-concepts/devices) that has been connected to Seam. */
76365
76980
  lock: {
76366
76981
  /** Unique identifier for the device. */
76367
76982
  device_id: string;
@@ -76419,7 +77034,7 @@ interface Routes {
76419
77034
  level: number;
76420
77035
  status: 'critical' | 'low' | 'good' | 'full';
76421
77036
  } | undefined;
76422
- /** Manufacturer of the device. */
77037
+ /** 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. */
76423
77038
  manufacturer?: string | undefined;
76424
77039
  /** Image URL for the device. */
76425
77040
  image_url?: string | undefined;
@@ -76698,6 +77313,7 @@ interface Routes {
76698
77313
  } | undefined;
76699
77314
  }) & ({
76700
77315
  _experimental_supported_code_from_access_codes_lengths?: (number[] | undefined) | undefined;
77316
+ /** 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. */
76701
77317
  code_constraints?: (Array<{
76702
77318
  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';
76703
77319
  } | {
@@ -77114,7 +77730,7 @@ interface Routes {
77114
77730
  can_simulate_connection?: boolean | undefined;
77115
77731
  can_simulate_disconnection?: boolean | undefined;
77116
77732
  };
77117
- /** */
77733
+ /** Represents a [device](https://docs.seam.co/latest/core-concepts/devices) that has been connected to Seam. */
77118
77734
  device: {
77119
77735
  /** Unique identifier for the device. */
77120
77736
  device_id: string;
@@ -77172,7 +77788,7 @@ interface Routes {
77172
77788
  level: number;
77173
77789
  status: 'critical' | 'low' | 'good' | 'full';
77174
77790
  } | undefined;
77175
- /** Manufacturer of the device. */
77791
+ /** 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. */
77176
77792
  manufacturer?: string | undefined;
77177
77793
  /** Image URL for the device. */
77178
77794
  image_url?: string | undefined;
@@ -77451,6 +78067,7 @@ interface Routes {
77451
78067
  } | undefined;
77452
78068
  }) & ({
77453
78069
  _experimental_supported_code_from_access_codes_lengths?: (number[] | undefined) | undefined;
78070
+ /** 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. */
77454
78071
  code_constraints?: (Array<{
77455
78072
  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';
77456
78073
  } | {
@@ -77876,11 +78493,11 @@ interface Routes {
77876
78493
  jsonBody: {};
77877
78494
  commonParams: {
77878
78495
  customer_ids?: string[] | undefined;
77879
- /** ID of the connected account by which to filter. */
78496
+ /** ID of the connected account for which you want to list devices. */
77880
78497
  connected_account_id?: string | undefined;
77881
- /** Array of IDs of the connected accounts by which to filter devices. */
78498
+ /** Array of IDs of the connected accounts for which you want to list devices. */
77882
78499
  connected_account_ids?: string[] | undefined;
77883
- /** ID of the Connect Webview by which to filter devices. */
78500
+ /** ID of the Connect Webview for which you want to list devices. */
77884
78501
  connect_webview_id?: string | undefined;
77885
78502
  /** Device type by which to filter devices. */
77886
78503
  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;
@@ -77888,15 +78505,15 @@ interface Routes {
77888
78505
  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;
77889
78506
  /** Manufacturer by which to filter devices. */
77890
78507
  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;
77891
- /** Array of device IDs by which to filter devices. */
78508
+ /** Array of device IDs for which you want to list devices. */
77892
78509
  device_ids?: string[] | undefined;
77893
78510
  /** Numerical limit on the number of devices to return. */
77894
78511
  limit?: number;
77895
- /** Date threshold for devices to return. If specified, returns only devices created before the specified date. */
78512
+ /** Timestamp by which to limit returned devices. Returns devices created before this timestamp. */
77896
78513
  created_before?: Date | undefined;
77897
- /** Your own internal user ID for the user by which to filter devices. */
78514
+ /** Your own internal user ID for the user for which you want to list devices. */
77898
78515
  user_identifier_key?: string | undefined;
77899
- /** Set of key:value [custom metadata](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device) pairs by which you want to filter devices. */
78516
+ /** 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. */
77900
78517
  custom_metadata_has?: Record<string, string | boolean> | undefined;
77901
78518
  /** Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`. */
77902
78519
  page_cursor?: (string | undefined) | null;
@@ -77904,7 +78521,7 @@ interface Routes {
77904
78521
  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;
77905
78522
  /** */
77906
78523
  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;
77907
- /** */
78524
+ /** ID of the location for which you want to list devices. */
77908
78525
  unstable_location_id?: (string | null) | undefined;
77909
78526
  };
77910
78527
  formData: {};
@@ -77966,7 +78583,7 @@ interface Routes {
77966
78583
  level: number;
77967
78584
  status: 'critical' | 'low' | 'good' | 'full';
77968
78585
  } | undefined;
77969
- /** Manufacturer of the device. */
78586
+ /** 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. */
77970
78587
  manufacturer?: string | undefined;
77971
78588
  /** Image URL for the device. */
77972
78589
  image_url?: string | undefined;
@@ -78245,6 +78862,7 @@ interface Routes {
78245
78862
  } | undefined;
78246
78863
  }) & ({
78247
78864
  _experimental_supported_code_from_access_codes_lengths?: (number[] | undefined) | undefined;
78865
+ /** 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. */
78248
78866
  code_constraints?: (Array<{
78249
78867
  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';
78250
78868
  } | {
@@ -78718,7 +79336,7 @@ interface Routes {
78718
79336
  level: number;
78719
79337
  status: 'critical' | 'low' | 'good' | 'full';
78720
79338
  } | undefined;
78721
- /** Manufacturer of the device. */
79339
+ /** 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. */
78722
79340
  manufacturer?: string | undefined;
78723
79341
  /** Image URL for the device. */
78724
79342
  image_url?: string | undefined;
@@ -78997,6 +79615,7 @@ interface Routes {
78997
79615
  } | undefined;
78998
79616
  }) & ({
78999
79617
  _experimental_supported_code_from_access_codes_lengths?: (number[] | undefined) | undefined;
79618
+ /** 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. */
79000
79619
  code_constraints?: (Array<{
79001
79620
  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';
79002
79621
  } | {
@@ -83920,11 +84539,11 @@ interface Routes {
83920
84539
  jsonBody: {};
83921
84540
  commonParams: {
83922
84541
  customer_ids?: string[] | undefined;
83923
- /** ID of the connected account by which to filter. */
84542
+ /** ID of the connected account for which you want to list devices. */
83924
84543
  connected_account_id?: string | undefined;
83925
- /** Array of IDs of the connected accounts by which to filter devices. */
84544
+ /** Array of IDs of the connected accounts for which you want to list devices. */
83926
84545
  connected_account_ids?: string[] | undefined;
83927
- /** ID of the Connect Webview by which to filter devices. */
84546
+ /** ID of the Connect Webview for which you want to list devices. */
83928
84547
  connect_webview_id?: string | undefined;
83929
84548
  /** Device type by which to filter devices. */
83930
84549
  device_type?: ('noiseaware_activity_zone' | 'minut_sensor') | undefined;
@@ -83932,15 +84551,15 @@ interface Routes {
83932
84551
  device_types?: Array<'noiseaware_activity_zone' | 'minut_sensor'> | undefined;
83933
84552
  /** Manufacturer by which to filter devices. */
83934
84553
  manufacturer?: ('minut' | 'noiseaware') | undefined;
83935
- /** Array of device IDs by which to filter devices. */
84554
+ /** Array of device IDs for which you want to list devices. */
83936
84555
  device_ids?: string[] | undefined;
83937
84556
  /** Numerical limit on the number of devices to return. */
83938
84557
  limit?: number;
83939
- /** Date threshold for devices to return. If specified, returns only devices created before the specified date. */
84558
+ /** Timestamp by which to limit returned devices. Returns devices created before this timestamp. */
83940
84559
  created_before?: Date | undefined;
83941
- /** Your own internal user ID for the user by which to filter devices. */
84560
+ /** Your own internal user ID for the user for which you want to list devices. */
83942
84561
  user_identifier_key?: string | undefined;
83943
- /** Set of key:value [custom metadata](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device) pairs by which you want to filter devices. */
84562
+ /** 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. */
83944
84563
  custom_metadata_has?: Record<string, string | boolean> | undefined;
83945
84564
  /** Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`. */
83946
84565
  page_cursor?: (string | undefined) | null;
@@ -83948,7 +84567,7 @@ interface Routes {
83948
84567
  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;
83949
84568
  /** */
83950
84569
  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;
83951
- /** */
84570
+ /** ID of the location for which you want to list devices. */
83952
84571
  unstable_location_id?: (string | null) | undefined;
83953
84572
  };
83954
84573
  formData: {};
@@ -84010,7 +84629,7 @@ interface Routes {
84010
84629
  level: number;
84011
84630
  status: 'critical' | 'low' | 'good' | 'full';
84012
84631
  } | undefined;
84013
- /** Manufacturer of the device. */
84632
+ /** 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. */
84014
84633
  manufacturer?: string | undefined;
84015
84634
  /** Image URL for the device. */
84016
84635
  image_url?: string | undefined;
@@ -84289,6 +84908,7 @@ interface Routes {
84289
84908
  } | undefined;
84290
84909
  }) & ({
84291
84910
  _experimental_supported_code_from_access_codes_lengths?: (number[] | undefined) | undefined;
84911
+ /** 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. */
84292
84912
  code_constraints?: (Array<{
84293
84913
  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';
84294
84914
  } | {
@@ -84762,7 +85382,7 @@ interface Routes {
84762
85382
  level: number;
84763
85383
  status: 'critical' | 'low' | 'good' | 'full';
84764
85384
  } | undefined;
84765
- /** Manufacturer of the device. */
85385
+ /** 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. */
84766
85386
  manufacturer?: string | undefined;
84767
85387
  /** Image URL for the device. */
84768
85388
  image_url?: string | undefined;
@@ -85041,6 +85661,7 @@ interface Routes {
85041
85661
  } | undefined;
85042
85662
  }) & ({
85043
85663
  _experimental_supported_code_from_access_codes_lengths?: (number[] | undefined) | undefined;
85664
+ /** 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. */
85044
85665
  code_constraints?: (Array<{
85045
85666
  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';
85046
85667
  } | {
@@ -89340,7 +89961,15 @@ interface Routes {
89340
89961
  commonParams: {};
89341
89962
  formData: {};
89342
89963
  jsonResponse: {
89343
- /** */
89964
+ /** 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.
89965
+
89966
+ You create each client session with a custom `user_identifier_key`. Normally, the `user_identifier_key` is a user ID that your application provides.
89967
+
89968
+ 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`.
89969
+
89970
+ 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.
89971
+
89972
+ 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). */
89344
89973
  client_session: {
89345
89974
  client_session_id: string;
89346
89975
  workspace_id: string;
@@ -92955,7 +93584,7 @@ interface Routes {
92955
93584
  };
92956
93585
  formData: {};
92957
93586
  jsonResponse: {
92958
- /** */
93587
+ /** Represents a [device](https://docs.seam.co/latest/core-concepts/devices) that has been connected to Seam. */
92959
93588
  thermostat: {
92960
93589
  /** Unique identifier for the device. */
92961
93590
  device_id: string;
@@ -93013,7 +93642,7 @@ interface Routes {
93013
93642
  level: number;
93014
93643
  status: 'critical' | 'low' | 'good' | 'full';
93015
93644
  } | undefined;
93016
- /** Manufacturer of the device. */
93645
+ /** 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. */
93017
93646
  manufacturer?: string | undefined;
93018
93647
  /** Image URL for the device. */
93019
93648
  image_url?: string | undefined;
@@ -93292,6 +93921,7 @@ interface Routes {
93292
93921
  } | undefined;
93293
93922
  }) & ({
93294
93923
  _experimental_supported_code_from_access_codes_lengths?: (number[] | undefined) | undefined;
93924
+ /** 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. */
93295
93925
  code_constraints?: (Array<{
93296
93926
  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';
93297
93927
  } | {
@@ -95965,11 +96595,11 @@ interface Routes {
95965
96595
  jsonBody: {};
95966
96596
  commonParams: {
95967
96597
  customer_ids?: string[] | undefined;
95968
- /** ID of the connected account by which to filter. */
96598
+ /** ID of the connected account for which you want to list devices. */
95969
96599
  connected_account_id?: string | undefined;
95970
- /** Array of IDs of the connected accounts by which to filter devices. */
96600
+ /** Array of IDs of the connected accounts for which you want to list devices. */
95971
96601
  connected_account_ids?: string[] | undefined;
95972
- /** ID of the Connect Webview by which to filter devices. */
96602
+ /** ID of the Connect Webview for which you want to list devices. */
95973
96603
  connect_webview_id?: string | undefined;
95974
96604
  /** Device type by which to filter thermostat devices. */
95975
96605
  device_type?: ('ecobee_thermostat' | 'nest_thermostat' | 'honeywell_resideo_thermostat' | 'tado_thermostat' | 'sensi_thermostat' | 'smartthings_thermostat') | undefined;
@@ -95977,15 +96607,15 @@ interface Routes {
95977
96607
  device_types?: Array<'ecobee_thermostat' | 'nest_thermostat' | 'honeywell_resideo_thermostat' | 'tado_thermostat' | 'sensi_thermostat' | 'smartthings_thermostat'> | undefined;
95978
96608
  /** Manufacturer by which to filter thermostat devices. */
95979
96609
  manufacturer?: ('ecobee' | 'honeywell_resideo' | 'nest' | 'tado' | 'sensi') | undefined;
95980
- /** Array of device IDs by which to filter devices. */
96610
+ /** Array of device IDs for which you want to list devices. */
95981
96611
  device_ids?: string[] | undefined;
95982
96612
  /** Numerical limit on the number of devices to return. */
95983
96613
  limit?: number;
95984
- /** Date threshold for devices to return. If specified, returns only devices created before the specified date. */
96614
+ /** Timestamp by which to limit returned devices. Returns devices created before this timestamp. */
95985
96615
  created_before?: Date | undefined;
95986
- /** Your own internal user ID for the user by which to filter devices. */
96616
+ /** Your own internal user ID for the user for which you want to list devices. */
95987
96617
  user_identifier_key?: string | undefined;
95988
- /** Set of key:value [custom metadata](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device) pairs by which you want to filter devices. */
96618
+ /** 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. */
95989
96619
  custom_metadata_has?: Record<string, string | boolean> | undefined;
95990
96620
  /** Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`. */
95991
96621
  page_cursor?: (string | undefined) | null;
@@ -95993,7 +96623,7 @@ interface Routes {
95993
96623
  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;
95994
96624
  /** */
95995
96625
  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;
95996
- /** */
96626
+ /** ID of the location for which you want to list devices. */
95997
96627
  unstable_location_id?: (string | null) | undefined;
95998
96628
  };
95999
96629
  formData: {};
@@ -96055,7 +96685,7 @@ interface Routes {
96055
96685
  level: number;
96056
96686
  status: 'critical' | 'low' | 'good' | 'full';
96057
96687
  } | undefined;
96058
- /** Manufacturer of the device. */
96688
+ /** 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. */
96059
96689
  manufacturer?: string | undefined;
96060
96690
  /** Image URL for the device. */
96061
96691
  image_url?: string | undefined;
@@ -96334,6 +96964,7 @@ interface Routes {
96334
96964
  } | undefined;
96335
96965
  }) & ({
96336
96966
  _experimental_supported_code_from_access_codes_lengths?: (number[] | undefined) | undefined;
96967
+ /** 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. */
96337
96968
  code_constraints?: (Array<{
96338
96969
  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';
96339
96970
  } | {
@@ -96807,7 +97438,7 @@ interface Routes {
96807
97438
  level: number;
96808
97439
  status: 'critical' | 'low' | 'good' | 'full';
96809
97440
  } | undefined;
96810
- /** Manufacturer of the device. */
97441
+ /** 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. */
96811
97442
  manufacturer?: string | undefined;
96812
97443
  /** Image URL for the device. */
96813
97444
  image_url?: string | undefined;
@@ -97086,6 +97717,7 @@ interface Routes {
97086
97717
  } | undefined;
97087
97718
  }) & ({
97088
97719
  _experimental_supported_code_from_access_codes_lengths?: (number[] | undefined) | undefined;
97720
+ /** 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. */
97089
97721
  code_constraints?: (Array<{
97090
97722
  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';
97091
97723
  } | {
@@ -102738,6 +103370,43 @@ interface Routes {
102738
103370
  };
102739
103371
  };
102740
103372
  };
103373
+ '/unstable_partner/resources/push': {
103374
+ route: '/unstable_partner/resources/push';
103375
+ method: 'POST';
103376
+ queryParams: {};
103377
+ jsonBody: Array<{
103378
+ partner_resource_type?: string | undefined;
103379
+ partner_resource_key?: string | undefined;
103380
+ customer_key?: string | undefined;
103381
+ email_address?: string | undefined;
103382
+ phone_number?: string | undefined;
103383
+ starts_at?: string | undefined;
103384
+ ends_at?: string | undefined;
103385
+ user_identity_key?: string | undefined;
103386
+ location_keys?: string[] | undefined;
103387
+ name?: string | undefined;
103388
+ description?: string | undefined;
103389
+ icon_url?: string | undefined;
103390
+ custom_metadata?: Record<string, string> | undefined;
103391
+ }> | {
103392
+ partner_resource_type?: string | undefined;
103393
+ partner_resource_key?: string | undefined;
103394
+ customer_key?: string | undefined;
103395
+ email_address?: string | undefined;
103396
+ phone_number?: string | undefined;
103397
+ starts_at?: string | undefined;
103398
+ ends_at?: string | undefined;
103399
+ user_identity_key?: string | undefined;
103400
+ location_keys?: string[] | undefined;
103401
+ name?: string | undefined;
103402
+ description?: string | undefined;
103403
+ icon_url?: string | undefined;
103404
+ custom_metadata?: Record<string, string> | undefined;
103405
+ };
103406
+ commonParams: {};
103407
+ formData: {};
103408
+ jsonResponse: {};
103409
+ };
102741
103410
  '/user_identities/add_acs_user': {
102742
103411
  route: '/user_identities/add_acs_user';
102743
103412
  method: 'POST' | 'PUT';
@@ -102771,7 +103440,7 @@ interface Routes {
102771
103440
  };
102772
103441
  formData: {};
102773
103442
  jsonResponse: {
102774
- /** Represents a [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) associated with an application user account. */
103443
+ /** 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. */
102775
103444
  user_identity: {
102776
103445
  /** ID of the user identity. */
102777
103446
  user_identity_id: string;
@@ -102932,7 +103601,7 @@ interface Routes {
102932
103601
  };
102933
103602
  formData: {};
102934
103603
  jsonResponse: {
102935
- /** Represents a [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) associated with an application user account. */
103604
+ /** 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. */
102936
103605
  user_identity: {
102937
103606
  /** ID of the user identity. */
102938
103607
  user_identity_id: string;
@@ -103061,7 +103730,7 @@ interface Routes {
103061
103730
  level: number;
103062
103731
  status: 'critical' | 'low' | 'good' | 'full';
103063
103732
  } | undefined;
103064
- /** Manufacturer of the device. */
103733
+ /** 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. */
103065
103734
  manufacturer?: string | undefined;
103066
103735
  /** Image URL for the device. */
103067
103736
  image_url?: string | undefined;
@@ -103340,6 +104009,7 @@ interface Routes {
103340
104009
  } | undefined;
103341
104010
  }) & ({
103342
104011
  _experimental_supported_code_from_access_codes_lengths?: (number[] | undefined) | undefined;
104012
+ /** 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. */
103343
104013
  code_constraints?: (Array<{
103344
104014
  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';
103345
104015
  } | {
@@ -103815,7 +104485,7 @@ interface Routes {
103815
104485
  level: number;
103816
104486
  status: 'critical' | 'low' | 'good' | 'full';
103817
104487
  } | undefined;
103818
- /** Manufacturer of the device. */
104488
+ /** 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. */
103819
104489
  manufacturer?: string | undefined;
103820
104490
  /** Image URL for the device. */
103821
104491
  image_url?: string | undefined;
@@ -104094,6 +104764,7 @@ interface Routes {
104094
104764
  } | undefined;
104095
104765
  }) & ({
104096
104766
  _experimental_supported_code_from_access_codes_lengths?: (number[] | undefined) | undefined;
104767
+ /** 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. */
104097
104768
  code_constraints?: (Array<{
104098
104769
  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';
104099
104770
  } | {
@@ -105010,7 +105681,7 @@ interface Routes {
105010
105681
  commonParams: {};
105011
105682
  formData: {};
105012
105683
  jsonResponse: {
105013
- /** */
105684
+ /** 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). */
105014
105685
  workspace: {
105015
105686
  workspace_id: string;
105016
105687
  name: string;
@@ -105039,7 +105710,7 @@ interface Routes {
105039
105710
  commonParams: {};
105040
105711
  formData: {};
105041
105712
  jsonResponse: {
105042
- /** */
105713
+ /** 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). */
105043
105714
  workspace: {
105044
105715
  workspace_id: string;
105045
105716
  name: string;