@seamapi/types 1.399.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 +877 -295
  2. package/dist/connect.cjs.map +1 -1
  3. package/dist/connect.d.cts +835 -178
  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 +371 -0
  26. package/lib/seam/connect/openapi.js +795 -256
  27. package/lib/seam/connect/openapi.js.map +1 -1
  28. package/lib/seam/connect/route-types.d.ts +464 -178
  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 +996 -256
  42. package/src/lib/seam/connect/route-types.ts +466 -178
@@ -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
  };
@@ -34777,9 +34802,11 @@ declare const _default: {
34777
34802
  description: string;
34778
34803
  properties: {
34779
34804
  assign_new_key: {
34805
+ description: string;
34780
34806
  type: string;
34781
34807
  };
34782
34808
  update_current_key: {
34809
+ description: string;
34783
34810
  type: string;
34784
34811
  };
34785
34812
  };
@@ -35574,6 +35601,7 @@ declare const _default: {
35574
35601
  'application/json': {
35575
35602
  schema: {
35576
35603
  oneOf: ({
35604
+ description: string;
35577
35605
  properties: {
35578
35606
  acs_user_id: {
35579
35607
  description: string;
@@ -35586,6 +35614,7 @@ declare const _default: {
35586
35614
  required: string[];
35587
35615
  type: string;
35588
35616
  } | {
35617
+ description: string;
35589
35618
  properties: {
35590
35619
  acs_system_id: {
35591
35620
  description: string;
@@ -35598,6 +35627,7 @@ declare const _default: {
35598
35627
  required: string[];
35599
35628
  type: string;
35600
35629
  } | {
35630
+ description: string;
35601
35631
  properties: {
35602
35632
  acs_system_id: {
35603
35633
  description: string;
@@ -35614,6 +35644,7 @@ declare const _default: {
35614
35644
  required: string[];
35615
35645
  type: string;
35616
35646
  } | {
35647
+ description: string;
35617
35648
  properties: {
35618
35649
  user_identity_id: {
35619
35650
  description: string;
@@ -36628,6 +36659,7 @@ declare const _default: {
36628
36659
  schema: {
36629
36660
  properties: {
36630
36661
  acs_entrance_id: {
36662
+ description: string;
36631
36663
  format: string;
36632
36664
  type: string;
36633
36665
  };
@@ -36697,6 +36729,7 @@ declare const _default: {
36697
36729
  };
36698
36730
  '/acs/entrances/grant_access': {
36699
36731
  post: {
36732
+ description: string;
36700
36733
  operationId: string;
36701
36734
  requestBody: {
36702
36735
  content: {
@@ -36704,10 +36737,12 @@ declare const _default: {
36704
36737
  schema: {
36705
36738
  properties: {
36706
36739
  acs_entrance_id: {
36740
+ description: string;
36707
36741
  format: string;
36708
36742
  type: string;
36709
36743
  };
36710
36744
  acs_user_id: {
36745
+ description: string;
36711
36746
  format: string;
36712
36747
  type: string;
36713
36748
  };
@@ -36773,14 +36808,17 @@ declare const _default: {
36773
36808
  schema: {
36774
36809
  properties: {
36775
36810
  acs_credential_id: {
36811
+ description: string;
36776
36812
  format: string;
36777
36813
  type: string;
36778
36814
  };
36779
36815
  acs_system_id: {
36816
+ description: string;
36780
36817
  format: string;
36781
36818
  type: string;
36782
36819
  };
36783
36820
  location_id: {
36821
+ description: string;
36784
36822
  format: string;
36785
36823
  nullable: boolean;
36786
36824
  type: string;
@@ -36862,10 +36900,12 @@ declare const _default: {
36862
36900
  schema: {
36863
36901
  properties: {
36864
36902
  acs_entrance_id: {
36903
+ description: string;
36865
36904
  format: string;
36866
36905
  type: string;
36867
36906
  };
36868
36907
  include_if: {
36908
+ description: string;
36869
36909
  items: {
36870
36910
  enum: string[];
36871
36911
  type: string;
@@ -37314,11 +37354,13 @@ declare const _default: {
37314
37354
  description: string;
37315
37355
  properties: {
37316
37356
  ends_at: {
37357
+ description: string;
37317
37358
  format: string;
37318
37359
  nullable: boolean;
37319
37360
  type: string;
37320
37361
  };
37321
37362
  starts_at: {
37363
+ description: string;
37322
37364
  format: string;
37323
37365
  type: string;
37324
37366
  };
@@ -37570,6 +37612,7 @@ declare const _default: {
37570
37612
  type: string;
37571
37613
  };
37572
37614
  created_before: {
37615
+ description: string;
37573
37616
  format: string;
37574
37617
  type: string;
37575
37618
  };
@@ -37958,6 +38001,7 @@ declare const _default: {
37958
38001
  };
37959
38002
  '/acs/users/unmanaged/get': {
37960
38003
  post: {
38004
+ description: string;
37961
38005
  operationId: string;
37962
38006
  requestBody: {
37963
38007
  content: {
@@ -37965,6 +38009,7 @@ declare const _default: {
37965
38009
  schema: {
37966
38010
  properties: {
37967
38011
  acs_user_id: {
38012
+ description: string;
37968
38013
  format: string;
37969
38014
  type: string;
37970
38015
  };
@@ -38021,11 +38066,13 @@ declare const _default: {
38021
38066
  'x-fern-sdk-method-name': string;
38022
38067
  'x-fern-sdk-return-value': string;
38023
38068
  'x-response-key': string;
38069
+ 'x-title': string;
38024
38070
  'x-undocumented': string;
38025
38071
  };
38026
38072
  };
38027
38073
  '/acs/users/unmanaged/list': {
38028
38074
  post: {
38075
+ description: string;
38029
38076
  operationId: string;
38030
38077
  requestBody: {
38031
38078
  content: {
@@ -38033,22 +38080,27 @@ declare const _default: {
38033
38080
  schema: {
38034
38081
  properties: {
38035
38082
  acs_system_id: {
38083
+ description: string;
38036
38084
  format: string;
38037
38085
  type: string;
38038
38086
  };
38039
38087
  limit: {
38040
38088
  default: number;
38089
+ description: string;
38041
38090
  format: string;
38042
38091
  type: string;
38043
38092
  };
38044
38093
  user_identity_email_address: {
38094
+ description: string;
38045
38095
  type: string;
38046
38096
  };
38047
38097
  user_identity_id: {
38098
+ description: string;
38048
38099
  format: string;
38049
38100
  type: string;
38050
38101
  };
38051
38102
  user_identity_phone_number: {
38103
+ description: string;
38052
38104
  type: string;
38053
38105
  };
38054
38106
  };
@@ -38106,6 +38158,7 @@ declare const _default: {
38106
38158
  'x-fern-sdk-method-name': string;
38107
38159
  'x-fern-sdk-return-value': string;
38108
38160
  'x-response-key': string;
38161
+ 'x-title': string;
38109
38162
  'x-undocumented': string;
38110
38163
  };
38111
38164
  };
@@ -38189,10 +38242,12 @@ declare const _default: {
38189
38242
  nullable: boolean;
38190
38243
  properties: {
38191
38244
  ends_at: {
38245
+ description: string;
38192
38246
  format: string;
38193
38247
  type: string;
38194
38248
  };
38195
38249
  starts_at: {
38250
+ description: string;
38196
38251
  format: string;
38197
38252
  type: string;
38198
38253
  };
@@ -38292,10 +38347,12 @@ declare const _default: {
38292
38347
  nullable: boolean;
38293
38348
  properties: {
38294
38349
  ends_at: {
38350
+ description: string;
38295
38351
  format: string;
38296
38352
  type: string;
38297
38353
  };
38298
38354
  starts_at: {
38355
+ description: string;
38299
38356
  format: string;
38300
38357
  type: string;
38301
38358
  };
@@ -38386,6 +38443,7 @@ declare const _default: {
38386
38443
  };
38387
38444
  '/action_attempts/get': {
38388
38445
  post: {
38446
+ description: string;
38389
38447
  operationId: string;
38390
38448
  requestBody: {
38391
38449
  content: {
@@ -38393,6 +38451,7 @@ declare const _default: {
38393
38451
  schema: {
38394
38452
  properties: {
38395
38453
  action_attempt_id: {
38454
+ description: string;
38396
38455
  format: string;
38397
38456
  type: string;
38398
38457
  };
@@ -38457,10 +38516,12 @@ declare const _default: {
38457
38516
  'x-fern-sdk-method-name': string;
38458
38517
  'x-fern-sdk-return-value': string;
38459
38518
  'x-response-key': string;
38519
+ 'x-title': string;
38460
38520
  };
38461
38521
  };
38462
38522
  '/action_attempts/list': {
38463
38523
  post: {
38524
+ description: string;
38464
38525
  operationId: string;
38465
38526
  requestBody: {
38466
38527
  content: {
@@ -38468,6 +38529,7 @@ declare const _default: {
38468
38529
  schema: {
38469
38530
  properties: {
38470
38531
  action_attempt_ids: {
38532
+ description: string;
38471
38533
  items: {
38472
38534
  format: string;
38473
38535
  type: string;
@@ -38530,10 +38592,12 @@ declare const _default: {
38530
38592
  'x-fern-sdk-method-name': string;
38531
38593
  'x-fern-sdk-return-value': string;
38532
38594
  'x-response-key': string;
38595
+ 'x-title': string;
38533
38596
  };
38534
38597
  };
38535
38598
  '/bridges/get': {
38536
38599
  post: {
38600
+ description: string;
38537
38601
  operationId: string;
38538
38602
  requestBody: {
38539
38603
  content: {
@@ -38541,6 +38605,7 @@ declare const _default: {
38541
38605
  schema: {
38542
38606
  properties: {
38543
38607
  bridge_id: {
38608
+ description: string;
38544
38609
  format: string;
38545
38610
  type: string;
38546
38611
  };
@@ -38614,10 +38679,13 @@ declare const _default: {
38614
38679
  'x-fern-sdk-method-name': string;
38615
38680
  'x-fern-sdk-return-value': string;
38616
38681
  'x-response-key': string;
38682
+ 'x-title': string;
38683
+ 'x-undocumented': string;
38617
38684
  };
38618
38685
  };
38619
38686
  '/bridges/list': {
38620
38687
  post: {
38688
+ description: string;
38621
38689
  operationId: string;
38622
38690
  requestBody: {
38623
38691
  content: {
@@ -38695,10 +38763,13 @@ declare const _default: {
38695
38763
  'x-fern-sdk-method-name': string;
38696
38764
  'x-fern-sdk-return-value': string;
38697
38765
  'x-response-key': string;
38766
+ 'x-title': string;
38767
+ 'x-undocumented': string;
38698
38768
  };
38699
38769
  };
38700
38770
  '/client_sessions/create': {
38701
38771
  post: {
38772
+ description: string;
38702
38773
  operationId: string;
38703
38774
  requestBody: {
38704
38775
  content: {
@@ -38706,26 +38777,31 @@ declare const _default: {
38706
38777
  schema: {
38707
38778
  properties: {
38708
38779
  connect_webview_ids: {
38780
+ description: string;
38709
38781
  items: {
38710
38782
  type: string;
38711
38783
  };
38712
38784
  type: string;
38713
38785
  };
38714
38786
  connected_account_ids: {
38787
+ description: string;
38715
38788
  items: {
38716
38789
  type: string;
38717
38790
  };
38718
38791
  type: string;
38719
38792
  };
38720
38793
  expires_at: {
38794
+ description: string;
38721
38795
  format: string;
38722
38796
  type: string;
38723
38797
  };
38724
38798
  user_identifier_key: {
38799
+ description: string;
38725
38800
  minLength: number;
38726
38801
  type: string;
38727
38802
  };
38728
38803
  user_identity_ids: {
38804
+ description: string;
38729
38805
  items: {
38730
38806
  type: string;
38731
38807
  };
@@ -38791,8 +38867,10 @@ declare const _default: {
38791
38867
  'x-fern-sdk-method-name': string;
38792
38868
  'x-fern-sdk-return-value': string;
38793
38869
  'x-response-key': string;
38870
+ 'x-title': string;
38794
38871
  };
38795
38872
  put: {
38873
+ description: string;
38796
38874
  operationId: string;
38797
38875
  requestBody: {
38798
38876
  content: {
@@ -38800,26 +38878,31 @@ declare const _default: {
38800
38878
  schema: {
38801
38879
  properties: {
38802
38880
  connect_webview_ids: {
38881
+ description: string;
38803
38882
  items: {
38804
38883
  type: string;
38805
38884
  };
38806
38885
  type: string;
38807
38886
  };
38808
38887
  connected_account_ids: {
38888
+ description: string;
38809
38889
  items: {
38810
38890
  type: string;
38811
38891
  };
38812
38892
  type: string;
38813
38893
  };
38814
38894
  expires_at: {
38895
+ description: string;
38815
38896
  format: string;
38816
38897
  type: string;
38817
38898
  };
38818
38899
  user_identifier_key: {
38900
+ description: string;
38819
38901
  minLength: number;
38820
38902
  type: string;
38821
38903
  };
38822
38904
  user_identity_ids: {
38905
+ description: string;
38823
38906
  items: {
38824
38907
  type: string;
38825
38908
  };
@@ -38883,10 +38966,12 @@ declare const _default: {
38883
38966
  tags: string[];
38884
38967
  'x-fern-ignore': boolean;
38885
38968
  'x-response-key': string;
38969
+ 'x-title': string;
38886
38970
  };
38887
38971
  };
38888
38972
  '/client_sessions/delete': {
38889
38973
  post: {
38974
+ description: string;
38890
38975
  operationId: string;
38891
38976
  requestBody: {
38892
38977
  content: {
@@ -38894,6 +38979,7 @@ declare const _default: {
38894
38979
  schema: {
38895
38980
  properties: {
38896
38981
  client_session_id: {
38982
+ description: string;
38897
38983
  format: string;
38898
38984
  type: string;
38899
38985
  };
@@ -38946,10 +39032,12 @@ declare const _default: {
38946
39032
  'x-fern-sdk-group-name': string[];
38947
39033
  'x-fern-sdk-method-name': string;
38948
39034
  'x-response-key': null;
39035
+ 'x-title': string;
38949
39036
  };
38950
39037
  };
38951
39038
  '/client_sessions/get': {
38952
39039
  post: {
39040
+ description: string;
38953
39041
  operationId: string;
38954
39042
  requestBody: {
38955
39043
  content: {
@@ -38957,9 +39045,11 @@ declare const _default: {
38957
39045
  schema: {
38958
39046
  properties: {
38959
39047
  client_session_id: {
39048
+ description: string;
38960
39049
  type: string;
38961
39050
  };
38962
39051
  user_identifier_key: {
39052
+ description: string;
38963
39053
  type: string;
38964
39054
  };
38965
39055
  };
@@ -39022,10 +39112,12 @@ declare const _default: {
39022
39112
  'x-fern-sdk-method-name': string;
39023
39113
  'x-fern-sdk-return-value': string;
39024
39114
  'x-response-key': string;
39115
+ 'x-title': string;
39025
39116
  };
39026
39117
  };
39027
39118
  '/client_sessions/get_or_create': {
39028
39119
  post: {
39120
+ description: string;
39029
39121
  operationId: string;
39030
39122
  requestBody: {
39031
39123
  content: {
@@ -39033,26 +39125,31 @@ declare const _default: {
39033
39125
  schema: {
39034
39126
  properties: {
39035
39127
  connect_webview_ids: {
39128
+ description: string;
39036
39129
  items: {
39037
39130
  type: string;
39038
39131
  };
39039
39132
  type: string;
39040
39133
  };
39041
39134
  connected_account_ids: {
39135
+ description: string;
39042
39136
  items: {
39043
39137
  type: string;
39044
39138
  };
39045
39139
  type: string;
39046
39140
  };
39047
39141
  expires_at: {
39142
+ description: string;
39048
39143
  format: string;
39049
39144
  type: string;
39050
39145
  };
39051
39146
  user_identifier_key: {
39147
+ description: string;
39052
39148
  minLength: number;
39053
39149
  type: string;
39054
39150
  };
39055
39151
  user_identity_ids: {
39152
+ description: string;
39056
39153
  items: {
39057
39154
  type: string;
39058
39155
  };
@@ -39118,10 +39215,12 @@ declare const _default: {
39118
39215
  'x-fern-sdk-method-name': string;
39119
39216
  'x-fern-sdk-return-value': string;
39120
39217
  'x-response-key': string;
39218
+ 'x-title': string;
39121
39219
  };
39122
39220
  };
39123
39221
  '/client_sessions/grant_access': {
39124
39222
  patch: {
39223
+ description: string;
39125
39224
  operationId: string;
39126
39225
  requestBody: {
39127
39226
  content: {
@@ -39129,24 +39228,29 @@ declare const _default: {
39129
39228
  schema: {
39130
39229
  properties: {
39131
39230
  client_session_id: {
39231
+ description: string;
39132
39232
  type: string;
39133
39233
  };
39134
39234
  connect_webview_ids: {
39235
+ description: string;
39135
39236
  items: {
39136
39237
  type: string;
39137
39238
  };
39138
39239
  type: string;
39139
39240
  };
39140
39241
  connected_account_ids: {
39242
+ description: string;
39141
39243
  items: {
39142
39244
  type: string;
39143
39245
  };
39144
39246
  type: string;
39145
39247
  };
39146
39248
  user_identifier_key: {
39249
+ description: string;
39147
39250
  type: string;
39148
39251
  };
39149
39252
  user_identity_ids: {
39253
+ description: string;
39150
39254
  items: {
39151
39255
  type: string;
39152
39256
  };
@@ -39202,8 +39306,10 @@ declare const _default: {
39202
39306
  tags: string[];
39203
39307
  'x-fern-ignore': boolean;
39204
39308
  'x-response-key': null;
39309
+ 'x-title': string;
39205
39310
  };
39206
39311
  post: {
39312
+ description: string;
39207
39313
  operationId: string;
39208
39314
  requestBody: {
39209
39315
  content: {
@@ -39211,24 +39317,29 @@ declare const _default: {
39211
39317
  schema: {
39212
39318
  properties: {
39213
39319
  client_session_id: {
39320
+ description: string;
39214
39321
  type: string;
39215
39322
  };
39216
39323
  connect_webview_ids: {
39324
+ description: string;
39217
39325
  items: {
39218
39326
  type: string;
39219
39327
  };
39220
39328
  type: string;
39221
39329
  };
39222
39330
  connected_account_ids: {
39331
+ description: string;
39223
39332
  items: {
39224
39333
  type: string;
39225
39334
  };
39226
39335
  type: string;
39227
39336
  };
39228
39337
  user_identifier_key: {
39338
+ description: string;
39229
39339
  type: string;
39230
39340
  };
39231
39341
  user_identity_ids: {
39342
+ description: string;
39232
39343
  items: {
39233
39344
  type: string;
39234
39345
  };
@@ -39285,10 +39396,12 @@ declare const _default: {
39285
39396
  'x-fern-sdk-group-name': string[];
39286
39397
  'x-fern-sdk-method-name': string;
39287
39398
  'x-response-key': null;
39399
+ 'x-title': string;
39288
39400
  };
39289
39401
  };
39290
39402
  '/client_sessions/list': {
39291
39403
  post: {
39404
+ description: string;
39292
39405
  operationId: string;
39293
39406
  requestBody: {
39294
39407
  content: {
@@ -39296,18 +39409,23 @@ declare const _default: {
39296
39409
  schema: {
39297
39410
  properties: {
39298
39411
  client_session_id: {
39412
+ description: string;
39299
39413
  type: string;
39300
39414
  };
39301
39415
  connect_webview_id: {
39416
+ description: string;
39302
39417
  type: string;
39303
39418
  };
39304
39419
  user_identifier_key: {
39420
+ description: string;
39305
39421
  type: string;
39306
39422
  };
39307
39423
  user_identity_id: {
39424
+ description: string;
39308
39425
  type: string;
39309
39426
  };
39310
39427
  without_user_identifier_key: {
39428
+ description: string;
39311
39429
  type: string;
39312
39430
  };
39313
39431
  };
@@ -39365,10 +39483,12 @@ declare const _default: {
39365
39483
  'x-fern-sdk-method-name': string;
39366
39484
  'x-fern-sdk-return-value': string;
39367
39485
  'x-response-key': string;
39486
+ 'x-title': string;
39368
39487
  };
39369
39488
  };
39370
39489
  '/client_sessions/revoke': {
39371
39490
  post: {
39491
+ description: string;
39372
39492
  operationId: string;
39373
39493
  requestBody: {
39374
39494
  content: {
@@ -39376,6 +39496,7 @@ declare const _default: {
39376
39496
  schema: {
39377
39497
  properties: {
39378
39498
  client_session_id: {
39499
+ description: string;
39379
39500
  format: string;
39380
39501
  type: string;
39381
39502
  };
@@ -39428,10 +39549,12 @@ declare const _default: {
39428
39549
  'x-fern-sdk-group-name': string[];
39429
39550
  'x-fern-sdk-method-name': string;
39430
39551
  'x-response-key': null;
39552
+ 'x-title': string;
39431
39553
  };
39432
39554
  };
39433
39555
  '/connect_webviews/create': {
39434
39556
  post: {
39557
+ description: string;
39435
39558
  operationId: string;
39436
39559
  requestBody: {
39437
39560
  content: {
@@ -39439,6 +39562,7 @@ declare const _default: {
39439
39562
  schema: {
39440
39563
  properties: {
39441
39564
  accepted_providers: {
39565
+ description: string;
39442
39566
  items: {
39443
39567
  enum: string[];
39444
39568
  type: string;
@@ -39447,6 +39571,7 @@ declare const _default: {
39447
39571
  };
39448
39572
  automatically_manage_new_devices: {
39449
39573
  default: boolean;
39574
+ description: string;
39450
39575
  type: string;
39451
39576
  };
39452
39577
  custom_metadata: {
@@ -39460,24 +39585,30 @@ declare const _default: {
39460
39585
  maxLength?: never;
39461
39586
  })[];
39462
39587
  };
39588
+ description: string;
39463
39589
  type: string;
39464
39590
  };
39465
39591
  custom_redirect_failure_url: {
39592
+ description: string;
39466
39593
  type: string;
39467
39594
  };
39468
39595
  custom_redirect_url: {
39596
+ description: string;
39469
39597
  type: string;
39470
39598
  };
39471
39599
  device_selection_mode: {
39472
39600
  enum: string[];
39473
39601
  type: string;
39602
+ 'x-undocumented': string;
39474
39603
  };
39475
39604
  provider_category: {
39605
+ description: string;
39476
39606
  enum: string[];
39477
39607
  type: string;
39478
39608
  };
39479
39609
  wait_for_device_creation: {
39480
39610
  default: boolean;
39611
+ description: string;
39481
39612
  type: string;
39482
39613
  };
39483
39614
  };
@@ -39540,10 +39671,12 @@ declare const _default: {
39540
39671
  'x-fern-sdk-method-name': string;
39541
39672
  'x-fern-sdk-return-value': string;
39542
39673
  'x-response-key': string;
39674
+ 'x-title': string;
39543
39675
  };
39544
39676
  };
39545
39677
  '/connect_webviews/delete': {
39546
39678
  post: {
39679
+ description: string;
39547
39680
  operationId: string;
39548
39681
  requestBody: {
39549
39682
  content: {
@@ -39551,6 +39684,7 @@ declare const _default: {
39551
39684
  schema: {
39552
39685
  properties: {
39553
39686
  connect_webview_id: {
39687
+ description: string;
39554
39688
  format: string;
39555
39689
  type: string;
39556
39690
  };
@@ -39603,10 +39737,12 @@ declare const _default: {
39603
39737
  'x-fern-sdk-group-name': string[];
39604
39738
  'x-fern-sdk-method-name': string;
39605
39739
  'x-response-key': null;
39740
+ 'x-title': string;
39606
39741
  };
39607
39742
  };
39608
39743
  '/connect_webviews/get': {
39609
39744
  post: {
39745
+ description: string;
39610
39746
  operationId: string;
39611
39747
  requestBody: {
39612
39748
  content: {
@@ -39614,6 +39750,7 @@ declare const _default: {
39614
39750
  schema: {
39615
39751
  properties: {
39616
39752
  connect_webview_id: {
39753
+ description: string;
39617
39754
  format: string;
39618
39755
  type: string;
39619
39756
  };
@@ -39678,10 +39815,12 @@ declare const _default: {
39678
39815
  'x-fern-sdk-method-name': string;
39679
39816
  'x-fern-sdk-return-value': string;
39680
39817
  'x-response-key': string;
39818
+ 'x-title': string;
39681
39819
  };
39682
39820
  };
39683
39821
  '/connect_webviews/list': {
39684
39822
  post: {
39823
+ description: string;
39685
39824
  operationId: string;
39686
39825
  requestBody: {
39687
39826
  content: {
@@ -39699,6 +39838,7 @@ declare const _default: {
39699
39838
  };
39700
39839
  limit: {
39701
39840
  default: number;
39841
+ description: string;
39702
39842
  format: string;
39703
39843
  type: string;
39704
39844
  };
@@ -39769,10 +39909,12 @@ declare const _default: {
39769
39909
  'x-fern-sdk-method-name': string;
39770
39910
  'x-fern-sdk-return-value': string;
39771
39911
  'x-response-key': string;
39912
+ 'x-title': string;
39772
39913
  };
39773
39914
  };
39774
39915
  '/connected_accounts/delete': {
39775
39916
  post: {
39917
+ description: string;
39776
39918
  operationId: string;
39777
39919
  requestBody: {
39778
39920
  content: {
@@ -39780,12 +39922,14 @@ declare const _default: {
39780
39922
  schema: {
39781
39923
  properties: {
39782
39924
  connected_account_id: {
39925
+ description: string;
39783
39926
  format: string;
39784
39927
  type: string;
39785
39928
  };
39786
39929
  sync: {
39787
39930
  default: boolean;
39788
39931
  type: string;
39932
+ 'x-undocumented': string;
39789
39933
  };
39790
39934
  };
39791
39935
  required: string[];
@@ -39841,6 +39985,7 @@ declare const _default: {
39841
39985
  };
39842
39986
  '/connected_accounts/get': {
39843
39987
  post: {
39988
+ description: string;
39844
39989
  operationId: string;
39845
39990
  requestBody: {
39846
39991
  content: {
@@ -39849,6 +39994,7 @@ declare const _default: {
39849
39994
  oneOf: ({
39850
39995
  properties: {
39851
39996
  connected_account_id: {
39997
+ description: string;
39852
39998
  format: string;
39853
39999
  type: string;
39854
40000
  };
@@ -39859,6 +40005,7 @@ declare const _default: {
39859
40005
  } | {
39860
40006
  properties: {
39861
40007
  email: {
40008
+ description: string;
39862
40009
  format: string;
39863
40010
  type: string;
39864
40011
  };
@@ -39930,6 +40077,7 @@ declare const _default: {
39930
40077
  };
39931
40078
  '/connected_accounts/list': {
39932
40079
  post: {
40080
+ description: string;
39933
40081
  operationId: string;
39934
40082
  requestBody: {
39935
40083
  content: {
@@ -40031,6 +40179,7 @@ declare const _default: {
40031
40179
  };
40032
40180
  '/connected_accounts/update': {
40033
40181
  post: {
40182
+ description: string;
40034
40183
  operationId: string;
40035
40184
  requestBody: {
40036
40185
  content: {
@@ -40038,9 +40187,11 @@ declare const _default: {
40038
40187
  schema: {
40039
40188
  properties: {
40040
40189
  automatically_manage_new_devices: {
40190
+ description: string;
40041
40191
  type: string;
40042
40192
  };
40043
40193
  connected_account_id: {
40194
+ description: string;
40044
40195
  format: string;
40045
40196
  type: string;
40046
40197
  };
@@ -40055,6 +40206,7 @@ declare const _default: {
40055
40206
  maxLength?: never;
40056
40207
  })[];
40057
40208
  };
40209
+ description: string;
40058
40210
  type: string;
40059
40211
  };
40060
40212
  };
@@ -40114,6 +40266,7 @@ declare const _default: {
40114
40266
  };
40115
40267
  '/devices/delete': {
40116
40268
  post: {
40269
+ description: string;
40117
40270
  operationId: string;
40118
40271
  requestBody: {
40119
40272
  content: {
@@ -40121,6 +40274,7 @@ declare const _default: {
40121
40274
  schema: {
40122
40275
  properties: {
40123
40276
  device_id: {
40277
+ description: string;
40124
40278
  format: string;
40125
40279
  type: string;
40126
40280
  };
@@ -40174,11 +40328,13 @@ declare const _default: {
40174
40328
  'x-fern-sdk-group-name': string[];
40175
40329
  'x-fern-sdk-method-name': string;
40176
40330
  'x-response-key': null;
40331
+ 'x-title': string;
40177
40332
  'x-undocumented': string;
40178
40333
  };
40179
40334
  };
40180
40335
  '/devices/get': {
40181
40336
  post: {
40337
+ description: string;
40182
40338
  operationId: string;
40183
40339
  requestBody: {
40184
40340
  content: {
@@ -40186,10 +40342,12 @@ declare const _default: {
40186
40342
  schema: {
40187
40343
  properties: {
40188
40344
  device_id: {
40345
+ description: string;
40189
40346
  format: string;
40190
40347
  type: string;
40191
40348
  };
40192
40349
  name: {
40350
+ description: string;
40193
40351
  type: string;
40194
40352
  };
40195
40353
  };
@@ -40252,6 +40410,7 @@ declare const _default: {
40252
40410
  'x-fern-sdk-method-name': string;
40253
40411
  'x-fern-sdk-return-value': string;
40254
40412
  'x-response-key': string;
40413
+ 'x-title': string;
40255
40414
  };
40256
40415
  };
40257
40416
  '/devices/list': {
@@ -40370,6 +40529,7 @@ declare const _default: {
40370
40529
  type: string;
40371
40530
  };
40372
40531
  unstable_location_id: {
40532
+ description: string;
40373
40533
  format: string;
40374
40534
  nullable: boolean;
40375
40535
  type: string;
@@ -40450,6 +40610,7 @@ declare const _default: {
40450
40610
  };
40451
40611
  '/devices/list_device_providers': {
40452
40612
  post: {
40613
+ description: string;
40453
40614
  operationId: string;
40454
40615
  requestBody: {
40455
40616
  content: {
@@ -40457,6 +40618,7 @@ declare const _default: {
40457
40618
  schema: {
40458
40619
  properties: {
40459
40620
  provider_category: {
40621
+ description: string;
40460
40622
  enum: string[];
40461
40623
  type: string;
40462
40624
  };
@@ -40523,10 +40685,12 @@ declare const _default: {
40523
40685
  'x-fern-sdk-method-name': string;
40524
40686
  'x-fern-sdk-return-value': string;
40525
40687
  'x-response-key': string;
40688
+ 'x-title': string;
40526
40689
  };
40527
40690
  };
40528
40691
  '/devices/simulate/connect': {
40529
40692
  post: {
40693
+ description: string;
40530
40694
  operationId: string;
40531
40695
  requestBody: {
40532
40696
  content: {
@@ -40534,6 +40698,7 @@ declare const _default: {
40534
40698
  schema: {
40535
40699
  properties: {
40536
40700
  device_id: {
40701
+ description: string;
40537
40702
  format: string;
40538
40703
  type: string;
40539
40704
  };
@@ -40586,10 +40751,12 @@ declare const _default: {
40586
40751
  'x-fern-sdk-group-name': string[];
40587
40752
  'x-fern-sdk-method-name': string;
40588
40753
  'x-response-key': null;
40754
+ 'x-title': string;
40589
40755
  };
40590
40756
  };
40591
40757
  '/devices/simulate/disconnect': {
40592
40758
  post: {
40759
+ description: string;
40593
40760
  operationId: string;
40594
40761
  requestBody: {
40595
40762
  content: {
@@ -40597,6 +40764,7 @@ declare const _default: {
40597
40764
  schema: {
40598
40765
  properties: {
40599
40766
  device_id: {
40767
+ description: string;
40600
40768
  format: string;
40601
40769
  type: string;
40602
40770
  };
@@ -40649,10 +40817,12 @@ declare const _default: {
40649
40817
  'x-fern-sdk-group-name': string[];
40650
40818
  'x-fern-sdk-method-name': string;
40651
40819
  'x-response-key': null;
40820
+ 'x-title': string;
40652
40821
  };
40653
40822
  };
40654
40823
  '/devices/simulate/remove': {
40655
40824
  post: {
40825
+ description: string;
40656
40826
  operationId: string;
40657
40827
  requestBody: {
40658
40828
  content: {
@@ -40660,6 +40830,7 @@ declare const _default: {
40660
40830
  schema: {
40661
40831
  properties: {
40662
40832
  device_id: {
40833
+ description: string;
40663
40834
  format: string;
40664
40835
  type: string;
40665
40836
  };
@@ -40712,10 +40883,12 @@ declare const _default: {
40712
40883
  'x-fern-sdk-group-name': string[];
40713
40884
  'x-fern-sdk-method-name': string;
40714
40885
  'x-response-key': null;
40886
+ 'x-title': string;
40715
40887
  };
40716
40888
  };
40717
40889
  '/devices/unmanaged/get': {
40718
40890
  post: {
40891
+ description: string;
40719
40892
  operationId: string;
40720
40893
  requestBody: {
40721
40894
  content: {
@@ -40723,10 +40896,12 @@ declare const _default: {
40723
40896
  schema: {
40724
40897
  properties: {
40725
40898
  device_id: {
40899
+ description: string;
40726
40900
  format: string;
40727
40901
  type: string;
40728
40902
  };
40729
40903
  name: {
40904
+ description: string;
40730
40905
  type: string;
40731
40906
  };
40732
40907
  };
@@ -40789,10 +40964,12 @@ declare const _default: {
40789
40964
  'x-fern-sdk-method-name': string;
40790
40965
  'x-fern-sdk-return-value': string;
40791
40966
  'x-response-key': string;
40967
+ 'x-title': string;
40792
40968
  };
40793
40969
  };
40794
40970
  '/devices/unmanaged/list': {
40795
40971
  post: {
40972
+ description: string;
40796
40973
  operationId: string;
40797
40974
  requestBody: {
40798
40975
  content: {
@@ -40906,6 +41083,7 @@ declare const _default: {
40906
41083
  type: string;
40907
41084
  };
40908
41085
  unstable_location_id: {
41086
+ description: string;
40909
41087
  format: string;
40910
41088
  nullable: boolean;
40911
41089
  type: string;
@@ -40970,10 +41148,12 @@ declare const _default: {
40970
41148
  'x-fern-sdk-method-name': string;
40971
41149
  'x-fern-sdk-return-value': string;
40972
41150
  'x-response-key': string;
41151
+ 'x-title': string;
40973
41152
  };
40974
41153
  };
40975
41154
  '/devices/unmanaged/update': {
40976
41155
  patch: {
41156
+ description: string;
40977
41157
  operationId: string;
40978
41158
  requestBody: {
40979
41159
  content: {
@@ -40981,10 +41161,12 @@ declare const _default: {
40981
41161
  schema: {
40982
41162
  properties: {
40983
41163
  device_id: {
41164
+ description: string;
40984
41165
  format: string;
40985
41166
  type: string;
40986
41167
  };
40987
41168
  is_managed: {
41169
+ description: string;
40988
41170
  enum: boolean[];
40989
41171
  type: string;
40990
41172
  };
@@ -41036,8 +41218,10 @@ declare const _default: {
41036
41218
  tags: string[];
41037
41219
  'x-fern-ignore': boolean;
41038
41220
  'x-response-key': null;
41221
+ 'x-title': string;
41039
41222
  };
41040
41223
  post: {
41224
+ description: string;
41041
41225
  operationId: string;
41042
41226
  requestBody: {
41043
41227
  content: {
@@ -41045,10 +41229,12 @@ declare const _default: {
41045
41229
  schema: {
41046
41230
  properties: {
41047
41231
  device_id: {
41232
+ description: string;
41048
41233
  format: string;
41049
41234
  type: string;
41050
41235
  };
41051
41236
  is_managed: {
41237
+ description: string;
41052
41238
  enum: boolean[];
41053
41239
  type: string;
41054
41240
  };
@@ -41101,10 +41287,12 @@ declare const _default: {
41101
41287
  'x-fern-sdk-group-name': string[];
41102
41288
  'x-fern-sdk-method-name': string;
41103
41289
  'x-response-key': null;
41290
+ 'x-title': string;
41104
41291
  };
41105
41292
  };
41106
41293
  '/devices/update': {
41107
41294
  patch: {
41295
+ description: string;
41108
41296
  operationId: string;
41109
41297
  requestBody: {
41110
41298
  content: {
@@ -41122,23 +41310,28 @@ declare const _default: {
41122
41310
  maxLength?: never;
41123
41311
  })[];
41124
41312
  };
41313
+ description: string;
41125
41314
  type: string;
41126
41315
  };
41127
41316
  device_id: {
41317
+ description: string;
41128
41318
  format: string;
41129
41319
  type: string;
41130
41320
  };
41131
41321
  is_managed: {
41132
41322
  default: boolean;
41323
+ description: string;
41133
41324
  type: string;
41134
41325
  };
41135
41326
  name: {
41327
+ description: string;
41136
41328
  nullable: boolean;
41137
41329
  type: string;
41138
41330
  };
41139
41331
  properties: {
41140
41332
  properties: {
41141
41333
  name: {
41334
+ description: string;
41142
41335
  nullable: boolean;
41143
41336
  type: string;
41144
41337
  };
@@ -41201,8 +41394,10 @@ declare const _default: {
41201
41394
  tags: string[];
41202
41395
  'x-fern-ignore': boolean;
41203
41396
  'x-response-key': null;
41397
+ 'x-title': string;
41204
41398
  };
41205
41399
  post: {
41400
+ description: string;
41206
41401
  operationId: string;
41207
41402
  requestBody: {
41208
41403
  content: {
@@ -41220,23 +41415,28 @@ declare const _default: {
41220
41415
  maxLength?: never;
41221
41416
  })[];
41222
41417
  };
41418
+ description: string;
41223
41419
  type: string;
41224
41420
  };
41225
41421
  device_id: {
41422
+ description: string;
41226
41423
  format: string;
41227
41424
  type: string;
41228
41425
  };
41229
41426
  is_managed: {
41230
41427
  default: boolean;
41428
+ description: string;
41231
41429
  type: string;
41232
41430
  };
41233
41431
  name: {
41432
+ description: string;
41234
41433
  nullable: boolean;
41235
41434
  type: string;
41236
41435
  };
41237
41436
  properties: {
41238
41437
  properties: {
41239
41438
  name: {
41439
+ description: string;
41240
41440
  nullable: boolean;
41241
41441
  type: string;
41242
41442
  };
@@ -41300,10 +41500,12 @@ declare const _default: {
41300
41500
  'x-fern-sdk-group-name': string[];
41301
41501
  'x-fern-sdk-method-name': string;
41302
41502
  'x-response-key': null;
41503
+ 'x-title': string;
41303
41504
  };
41304
41505
  };
41305
41506
  '/events/get': {
41306
41507
  post: {
41508
+ description: string;
41307
41509
  operationId: string;
41308
41510
  requestBody: {
41309
41511
  content: {
@@ -41384,10 +41586,12 @@ declare const _default: {
41384
41586
  'x-fern-sdk-method-name': string;
41385
41587
  'x-fern-sdk-return-value': string;
41386
41588
  'x-response-key': string;
41589
+ 'x-title': string;
41387
41590
  };
41388
41591
  };
41389
41592
  '/events/list': {
41390
41593
  post: {
41594
+ description: string;
41391
41595
  operationId: string;
41392
41596
  requestBody: {
41393
41597
  content: {
@@ -41549,6 +41753,7 @@ declare const _default: {
41549
41753
  'x-fern-sdk-method-name': string;
41550
41754
  'x-fern-sdk-return-value': string;
41551
41755
  'x-response-key': string;
41756
+ 'x-title': string;
41552
41757
  };
41553
41758
  };
41554
41759
  '/locks/get': {
@@ -41733,6 +41938,7 @@ declare const _default: {
41733
41938
  type: string;
41734
41939
  };
41735
41940
  unstable_location_id: {
41941
+ description: string;
41736
41942
  format: string;
41737
41943
  nullable: boolean;
41738
41944
  type: string;
@@ -42346,6 +42552,7 @@ declare const _default: {
42346
42552
  type: string;
42347
42553
  };
42348
42554
  unstable_location_id: {
42555
+ description: string;
42349
42556
  format: string;
42350
42557
  nullable: boolean;
42351
42558
  type: string;
@@ -45837,6 +46044,7 @@ declare const _default: {
45837
46044
  type: string;
45838
46045
  };
45839
46046
  unstable_location_id: {
46047
+ description: string;
45840
46048
  format: string;
45841
46049
  nullable: boolean;
45842
46050
  type: string;
@@ -49691,6 +49899,168 @@ declare const _default: {
49691
49899
  'x-undocumented': string;
49692
49900
  };
49693
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
+ };
49694
50064
  '/user_identities/add_acs_user': {
49695
50065
  post: {
49696
50066
  description: string;
@@ -52097,6 +52467,7 @@ declare const _default: {
52097
52467
  };
52098
52468
  '/workspaces/reset_sandbox': {
52099
52469
  post: {
52470
+ description: string;
52100
52471
  operationId: string;
52101
52472
  responses: {
52102
52473
  200: {
@@ -52312,9 +52683,15 @@ interface Routes {
52312
52683
  method: 'POST';
52313
52684
  queryParams: {};
52314
52685
  jsonBody: {
52315
- /** 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. */
52316
52687
  device_id: string;
52317
- /** 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). */
52318
52695
  name?: string | undefined;
52319
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. */
52320
52697
  starts_at?: string | undefined;
@@ -53455,7 +53832,7 @@ interface Routes {
53455
53832
 
53456
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.
53457
53834
 
53458
- Seam supports programming two types of access codes: [ongoing](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#ongoing-access-codes) and [time-bound](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#time-bound-access-codes). To differentiate between the two, refer to the `type` property of the access code. Ongoing codes display as `ongoing`, whereas time-bound codes are labeled `time_bound`.
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.
53459
53836
 
53460
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. */
53461
53838
  access_code: {
@@ -53471,7 +53848,13 @@ interface Routes {
53471
53848
  access_code_id: string;
53472
53849
  /** Unique identifier for the device associated with the access code. */
53473
53850
  device_id: string;
53474
- /** Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. */
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). */
53475
53858
  name: string | null;
53476
53859
  /** Code used for access. Typically, a numeric or alphanumeric string. */
53477
53860
  code: string | null;
@@ -53914,13 +54297,19 @@ interface Routes {
53914
54297
  method: 'POST' | 'PUT';
53915
54298
  queryParams: {};
53916
54299
  jsonBody: {
53917
- /** 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. */
53918
54301
  device_ids: string[];
53919
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. */
53920
54303
  behavior_when_code_cannot_be_shared?: 'throw' | 'create_random_code';
53921
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. */
53922
54305
  preferred_code_length?: number | undefined;
53923
- /** 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). */
53924
54313
  name?: string | undefined;
53925
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. */
53926
54315
  starts_at?: string | undefined;
@@ -53961,7 +54350,13 @@ interface Routes {
53961
54350
  access_code_id: string;
53962
54351
  /** Unique identifier for the device associated with the access code. */
53963
54352
  device_id: string;
53964
- /** Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. */
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). */
53965
54360
  name: string | null;
53966
54361
  /** Code used for access. Typically, a numeric or alphanumeric string. */
53967
54362
  code: string | null;
@@ -54405,9 +54800,9 @@ interface Routes {
54405
54800
  queryParams: {};
54406
54801
  jsonBody: {};
54407
54802
  commonParams: {
54408
- /** 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. */
54409
54804
  device_id?: string | undefined;
54410
- /** ID of the access code to delete. */
54805
+ /** ID of the access code that you want to delete. */
54411
54806
  access_code_id: string;
54412
54807
  /** */
54413
54808
  sync?: boolean;
@@ -55525,6 +55920,7 @@ interface Routes {
55525
55920
  queryParams: {};
55526
55921
  jsonBody: {};
55527
55922
  commonParams: {
55923
+ /** ID of the device for which you want to generate a code. */
55528
55924
  device_id: string;
55529
55925
  };
55530
55926
  formData: {};
@@ -55554,7 +55950,7 @@ interface Routes {
55554
55950
 
55555
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.
55556
55952
 
55557
- Seam supports programming two types of access codes: [ongoing](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#ongoing-access-codes) and [time-bound](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#time-bound-access-codes). To differentiate between the two, refer to the `type` property of the access code. Ongoing codes display as `ongoing`, whereas time-bound codes are labeled `time_bound`.
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.
55558
55954
 
55559
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. */
55560
55956
  access_code: {
@@ -55570,7 +55966,13 @@ interface Routes {
55570
55966
  access_code_id: string;
55571
55967
  /** Unique identifier for the device associated with the access code. */
55572
55968
  device_id: string;
55573
- /** Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. */
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). */
55574
55976
  name: string | null;
55575
55977
  /** Code used for access. Typically, a numeric or alphanumeric string. */
55576
55978
  code: string | null;
@@ -56040,7 +56442,13 @@ interface Routes {
56040
56442
  access_code_id: string;
56041
56443
  /** Unique identifier for the device associated with the access code. */
56042
56444
  device_id: string;
56043
- /** Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. */
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). */
56044
56452
  name: string | null;
56045
56453
  /** Code used for access. Typically, a numeric or alphanumeric string. */
56046
56454
  code: string | null;
@@ -56502,7 +56910,7 @@ interface Routes {
56502
56910
 
56503
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.
56504
56912
 
56505
- Seam supports programming two types of access codes: [ongoing](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#ongoing-access-codes) and [time-bound](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#time-bound-access-codes). To differentiate between the two, refer to the `type` property of the access code. Ongoing codes display as `ongoing`, whereas time-bound codes are labeled `time_bound`.
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.
56506
56914
 
56507
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. */
56508
56916
  backup_access_code: {
@@ -56518,7 +56926,13 @@ interface Routes {
56518
56926
  access_code_id: string;
56519
56927
  /** Unique identifier for the device associated with the access code. */
56520
56928
  device_id: string;
56521
- /** Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. */
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). */
56522
56936
  name: string | null;
56523
56937
  /** Code used for access. Typically, a numeric or alphanumeric string. */
56524
56938
  code: string | null;
@@ -56958,7 +57372,7 @@ interface Routes {
56958
57372
 
56959
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.
56960
57374
 
56961
- Seam supports programming two types of access codes: [ongoing](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#ongoing-access-codes) and [time-bound](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#time-bound-access-codes). To differentiate between the two, refer to the `type` property of the access code. Ongoing codes display as `ongoing`, whereas time-bound codes are labeled `time_bound`.
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.
56962
57376
 
56963
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. */
56964
57378
  access_code: {
@@ -56974,7 +57388,13 @@ interface Routes {
56974
57388
  access_code_id: string;
56975
57389
  /** Unique identifier for the device associated with the access code. */
56976
57390
  device_id: string;
56977
- /** Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. */
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). */
56978
57398
  name: string | null;
56979
57399
  /** Code used for access. Typically, a numeric or alphanumeric string. */
56980
57400
  code: string | null;
@@ -57417,7 +57837,7 @@ interface Routes {
57417
57837
  method: 'POST';
57418
57838
  queryParams: {};
57419
57839
  jsonBody: {
57420
- /** ID of the device for which to report constraints. */
57840
+ /** ID of the device for which you want to report constraints. */
57421
57841
  device_id: string;
57422
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`. */
57423
57843
  supported_code_lengths?: number[] | undefined;
@@ -57451,7 +57871,11 @@ interface Routes {
57451
57871
 
57452
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.
57453
57873
 
57454
- Prior to using Seam to manage your devices, you may have used another lock management system to manage the access codes on your devices. Where possible, we help you keep any existing access codes on devices and transition those codes to ones managed by your Seam workspace. */
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) */
57455
57879
  access_code: {
57456
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. */
57457
57881
  type: 'time_bound' | 'ongoing';
@@ -57459,7 +57883,13 @@ interface Routes {
57459
57883
  access_code_id: string;
57460
57884
  /** Unique identifier for the device associated with the access code. */
57461
57885
  device_id: string;
57462
- /** Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. */
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). */
57463
57893
  name: string | null;
57464
57894
  /** Code used for access. Typically, a numeric or alphanumeric string. */
57465
57895
  code: string | null;
@@ -57893,9 +58323,9 @@ interface Routes {
57893
58323
  commonParams: {
57894
58324
  /** ID of the unmanaged access code that you want to convert to a managed access code. */
57895
58325
  access_code_id: string;
57896
- /** 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. */
57897
58327
  is_external_modification_allowed?: boolean | undefined;
57898
- /** 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. */
57899
58329
  allow_external_modification?: boolean | undefined;
57900
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`. */
57901
58331
  force?: boolean | undefined;
@@ -57911,7 +58341,7 @@ interface Routes {
57911
58341
  queryParams: {};
57912
58342
  jsonBody: {};
57913
58343
  commonParams: {
57914
- /** ID of the unmanaged access code to delete. */
58344
+ /** ID of the unmanaged access code that you want to delete. */
57915
58345
  access_code_id: string;
57916
58346
  /** */
57917
58347
  sync?: boolean;
@@ -59044,7 +59474,11 @@ interface Routes {
59044
59474
 
59045
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.
59046
59476
 
59047
- Prior to using Seam to manage your devices, you may have used another lock management system to manage the access codes on your devices. Where possible, we help you keep any existing access codes on devices and transition those codes to ones managed by your Seam workspace. */
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) */
59048
59482
  access_code: {
59049
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. */
59050
59484
  type: 'time_bound' | 'ongoing';
@@ -59052,7 +59486,13 @@ interface Routes {
59052
59486
  access_code_id: string;
59053
59487
  /** Unique identifier for the device associated with the access code. */
59054
59488
  device_id: string;
59055
- /** Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. */
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). */
59056
59496
  name: string | null;
59057
59497
  /** Code used for access. Typically, a numeric or alphanumeric string. */
59058
59498
  code: string | null;
@@ -59498,7 +59938,13 @@ interface Routes {
59498
59938
  access_code_id: string;
59499
59939
  /** Unique identifier for the device associated with the access code. */
59500
59940
  device_id: string;
59501
- /** Name of the access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. */
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). */
59502
59948
  name: string | null;
59503
59949
  /** Code used for access. Typically, a numeric or alphanumeric string. */
59504
59950
  code: string | null;
@@ -59948,7 +60394,13 @@ interface Routes {
59948
60394
  method: 'POST' | 'PATCH' | 'PUT';
59949
60395
  queryParams: {};
59950
60396
  jsonBody: {
59951
- /** 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). */
59952
60404
  name?: string | undefined;
59953
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. */
59954
60406
  starts_at?: string | undefined;
@@ -61102,7 +61554,13 @@ interface Routes {
61102
61554
  ends_at?: string | undefined;
61103
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. */
61104
61556
  starts_at?: string | undefined;
61105
- /** 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). */
61106
61564
  name?: string | undefined;
61107
61565
  /** Key that links the group of access codes, assigned on creation by `/access_codes/create_multiple`. */
61108
61566
  common_code_key: string;
@@ -61117,9 +61575,9 @@ interface Routes {
61117
61575
  queryParams: {};
61118
61576
  jsonBody: {};
61119
61577
  commonParams: {
61120
- /** ID of the desired access group. */
61578
+ /** ID of the access group to which you want to add an access system user. */
61121
61579
  acs_access_group_id: string;
61122
- /** ID of the desired user. */
61580
+ /** ID of the access system user that you want to add to an access group. */
61123
61581
  acs_user_id: string;
61124
61582
  };
61125
61583
  formData: {};
@@ -61131,7 +61589,7 @@ interface Routes {
61131
61589
  queryParams: {};
61132
61590
  jsonBody: {};
61133
61591
  commonParams: {
61134
- /** ID of the desired access group. */
61592
+ /** ID of the access group that you want to get. */
61135
61593
  acs_access_group_id: string;
61136
61594
  };
61137
61595
  formData: {};
@@ -61182,9 +61640,9 @@ interface Routes {
61182
61640
  queryParams: {};
61183
61641
  jsonBody: {};
61184
61642
  commonParams: {
61185
- /** 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. */
61186
61644
  acs_system_id?: string | undefined;
61187
- /** 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. */
61188
61646
  acs_user_id?: string | undefined;
61189
61647
  /** ID of the user identity for which you want to retrieve all access groups. */
61190
61648
  user_identity_id?: string | undefined;
@@ -61307,7 +61765,7 @@ interface Routes {
61307
61765
  queryParams: {};
61308
61766
  jsonBody: {};
61309
61767
  commonParams: {
61310
- /** 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. */
61311
61769
  acs_access_group_id: string;
61312
61770
  };
61313
61771
  formData: {};
@@ -61502,11 +61960,11 @@ interface Routes {
61502
61960
  queryParams: {};
61503
61961
  jsonBody: {};
61504
61962
  commonParams: {
61505
- /** ID of the desired access group. */
61963
+ /** ID of the access group from which you want to remove an access system user. */
61506
61964
  acs_access_group_id: string;
61507
- /** ID of the desired user. */
61965
+ /** ID of the access system user that you want to remove from an access group. */
61508
61966
  acs_user_id?: string | undefined;
61509
- /** 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. */
61510
61968
  user_identity_id?: string | undefined;
61511
61969
  };
61512
61970
  formData: {};
@@ -61518,7 +61976,7 @@ interface Routes {
61518
61976
  queryParams: {};
61519
61977
  jsonBody: {};
61520
61978
  commonParams: {
61521
- /** ID of the desired unmanaged access group. */
61979
+ /** ID of the unmanaged access group that you want to get. */
61522
61980
  acs_access_group_id: string;
61523
61981
  };
61524
61982
  formData: {};
@@ -61565,9 +62023,9 @@ interface Routes {
61565
62023
  queryParams: {};
61566
62024
  jsonBody: {};
61567
62025
  commonParams: {
61568
- /** 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. */
61569
62027
  acs_system_id?: string | undefined;
61570
- /** 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. */
61571
62029
  acs_user_id?: string | undefined;
61572
62030
  };
61573
62031
  formData: {};
@@ -61613,6 +62071,7 @@ interface Routes {
61613
62071
  queryParams: {};
61614
62072
  jsonBody: {};
61615
62073
  commonParams: {
62074
+ /** ID of the access system for which you want to list credential pools. */
61616
62075
  acs_system_id: string;
61617
62076
  };
61618
62077
  formData: {};
@@ -61634,10 +62093,15 @@ interface Routes {
61634
62093
  queryParams: {};
61635
62094
  jsonBody: {};
61636
62095
  commonParams: {
62096
+ /** ID of the user identity for which you want to launch a credential provisioning automation. */
61637
62097
  user_identity_id: string;
62098
+ /** Access system ID of the credential manager for which you want to launch a credential provisioning automation. */
61638
62099
  credential_manager_acs_system_id: string;
62100
+ /** ID of the credential pool for which you want to launch a credential provisioning automation. */
61639
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`. */
61640
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`. */
61641
62105
  credential_manager_acs_user_id?: string | undefined;
61642
62106
  };
61643
62107
  formData: {};
@@ -61657,9 +62121,9 @@ interface Routes {
61657
62121
  method: 'PATCH' | 'POST';
61658
62122
  queryParams: {};
61659
62123
  jsonBody: {
61660
- /** ID of the desired user. */
62124
+ /** ID of the access system user to whom you want to assign a credential. */
61661
62125
  acs_user_id: string;
61662
- /** ID of the desired credential. */
62126
+ /** ID of the credential that you want to assign to an access system user. */
61663
62127
  acs_credential_id: string;
61664
62128
  };
61665
62129
  commonParams: {};
@@ -61793,11 +62257,11 @@ interface Routes {
61793
62257
  commonParams: {
61794
62258
  /** ACS system ID of the credential manager for the new credential. */
61795
62259
  credential_manager_acs_system_id?: string | undefined;
61796
- /** ID of the ACS 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`. */
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`. */
61797
62261
  acs_user_id?: string | undefined;
61798
- /** ID of the user identity to whom the new credential belongs. You must provide either `acs_user_id` or the combination of `user_identity_id` and `acs_system_id`. If the ACS system contains an ACS user with the same `email_address` or `phone_number` as the user identity that you specify, they are linked, and the credential belongs to the ACS user. If the ACS system does not have a corresponding ACS user, one is created. */
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. */
61799
62263
  user_identity_id?: string | undefined;
61800
- /** ID of the ACS 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`. */
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`. */
61801
62265
  acs_system_id?: string | undefined;
61802
62266
  /** Access method for the new credential. Supported values: `code`, `card`, `mobile_key`. */
61803
62267
  access_method: 'code' | 'card' | 'mobile_key';
@@ -61830,7 +62294,9 @@ interface Routes {
61830
62294
  } | undefined;
61831
62295
  /** Salto Space-specific metadata for the new credential. */
61832
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). */
61833
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). */
61834
62300
  update_current_key?: boolean | undefined;
61835
62301
  } | undefined;
61836
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. */
@@ -61966,7 +62432,7 @@ interface Routes {
61966
62432
  queryParams: {};
61967
62433
  jsonBody: {};
61968
62434
  commonParams: {
61969
- /** ID of the ACS user to whom the new credential belongs. */
62435
+ /** ID of the access system user to whom the new credential belongs. */
61970
62436
  acs_user_id: string;
61971
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. */
61972
62438
  allowed_acs_entrance_id: string;
@@ -62105,7 +62571,7 @@ interface Routes {
62105
62571
  queryParams: {};
62106
62572
  jsonBody: {};
62107
62573
  commonParams: {
62108
- /** ID of the desired credential. */
62574
+ /** ID of the credential that you want to delete. */
62109
62575
  acs_credential_id: string;
62110
62576
  };
62111
62577
  formData: {};
@@ -62117,7 +62583,7 @@ interface Routes {
62117
62583
  queryParams: {};
62118
62584
  jsonBody: {};
62119
62585
  commonParams: {
62120
- /** ID of the desired credential. */
62586
+ /** ID of the credential that you want to get. */
62121
62587
  acs_credential_id: string;
62122
62588
  };
62123
62589
  formData: {};
@@ -62248,15 +62714,15 @@ interface Routes {
62248
62714
  queryParams: {};
62249
62715
  jsonBody: {};
62250
62716
  commonParams: ({
62251
- /** 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. */
62252
62718
  acs_user_id: string;
62253
62719
  } | {
62254
- /** 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. */
62255
62721
  acs_system_id: string;
62256
62722
  } | {
62257
- /** 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. */
62258
62724
  acs_user_id: string;
62259
- /** 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. */
62260
62726
  acs_system_id: string;
62261
62727
  } | {
62262
62728
  /** ID of the user identity for which you want to retrieve all credentials. */
@@ -62392,7 +62858,7 @@ interface Routes {
62392
62858
  queryParams: {};
62393
62859
  jsonBody: {};
62394
62860
  commonParams: {
62395
- /** 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. */
62396
62862
  acs_credential_id: string;
62397
62863
  };
62398
62864
  formData: {};
@@ -62466,9 +62932,9 @@ interface Routes {
62466
62932
  method: 'PATCH' | 'POST';
62467
62933
  queryParams: {};
62468
62934
  jsonBody: {
62469
- /** ID of the desired user. */
62935
+ /** ID of the access system user from which you want to unassign a credential. */
62470
62936
  acs_user_id: string;
62471
- /** ID of the desired credential. */
62937
+ /** ID of the credential that you want to unassign from an access system user. */
62472
62938
  acs_credential_id: string;
62473
62939
  };
62474
62940
  commonParams: {};
@@ -62600,7 +63066,7 @@ interface Routes {
62600
63066
  queryParams: {};
62601
63067
  jsonBody: {};
62602
63068
  commonParams: {
62603
- /** ID of the desired unmanaged credential. */
63069
+ /** ID of the unmanaged credential that you want to get. */
62604
63070
  acs_credential_id: string;
62605
63071
  };
62606
63072
  formData: {};
@@ -62727,15 +63193,15 @@ interface Routes {
62727
63193
  queryParams: {};
62728
63194
  jsonBody: {};
62729
63195
  commonParams: {
62730
- /** 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. */
62731
63197
  acs_user_id: string;
62732
63198
  } | {
62733
- /** 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. */
62734
63200
  acs_system_id: string;
62735
63201
  } | {
62736
- /** 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. */
62737
63203
  acs_user_id: string;
62738
- /** 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. */
62739
63205
  acs_system_id: string;
62740
63206
  } | {
62741
63207
  /** ID of the user identity for which you want to retrieve all credentials. */
@@ -62863,9 +63329,9 @@ interface Routes {
62863
63329
  method: 'PATCH' | 'POST';
62864
63330
  queryParams: {};
62865
63331
  jsonBody: {
62866
- /** ID of the desired credential. */
63332
+ /** ID of the credential that you want to update. */
62867
63333
  acs_credential_id: string;
62868
- /** Replacement access (PIN) code for the credential. */
63334
+ /** Replacement access (PIN) code for the credential that you want to update. */
62869
63335
  code?: string | undefined;
62870
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. */
62871
63337
  ends_at?: string | undefined;
@@ -65235,7 +65701,7 @@ interface Routes {
65235
65701
  queryParams: {};
65236
65702
  jsonBody: {};
65237
65703
  commonParams: {
65238
- /** ID of the desired encoder. */
65704
+ /** ID of the encoder that you want to get. */
65239
65705
  acs_encoder_id: string;
65240
65706
  };
65241
65707
  formData: {};
@@ -65283,19 +65749,19 @@ interface Routes {
65283
65749
  queryParams: {};
65284
65750
  jsonBody: {};
65285
65751
  commonParams: {
65286
- /** 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. */
65287
65753
  acs_system_id: string;
65288
- /** Number of `acs_encoders` to return. */
65754
+ /** Number of encoders to return. */
65289
65755
  limit?: number;
65290
65756
  } | {
65291
- /** 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. */
65292
65758
  acs_system_ids: string[];
65293
- /** Number of `acs_encoders` to return. */
65759
+ /** Number of encoders to return. */
65294
65760
  limit?: number;
65295
65761
  } | {
65296
- /** IDs of the `acs_encoder`s that you want to retrieve. */
65762
+ /** IDs of the encoders that you want to retrieve. */
65297
65763
  acs_encoder_ids: string[];
65298
- /** Number of `acs_encoders` to return. */
65764
+ /** Number of encoders to return. */
65299
65765
  limit?: number;
65300
65766
  };
65301
65767
  formData: {};
@@ -65329,7 +65795,7 @@ interface Routes {
65329
65795
  queryParams: {};
65330
65796
  jsonBody: {};
65331
65797
  commonParams: {
65332
- /** ID of the `acs_encoder` to use for the scan. */
65798
+ /** ID of the encoder to use for the scan. */
65333
65799
  acs_encoder_id: string;
65334
65800
  };
65335
65801
  formData: {};
@@ -66524,6 +66990,7 @@ interface Routes {
66524
66990
  queryParams: {};
66525
66991
  jsonBody: {};
66526
66992
  commonParams: {
66993
+ /** ID of the entrance that you want to get. */
66527
66994
  acs_entrance_id: string;
66528
66995
  };
66529
66996
  formData: {};
@@ -66600,7 +67067,9 @@ interface Routes {
66600
67067
  method: 'POST';
66601
67068
  queryParams: {};
66602
67069
  jsonBody: {
67070
+ /** ID of the entrance to which you want to grant an access system user access. */
66603
67071
  acs_entrance_id: string;
67072
+ /** ID of the access system user to whom you want to grant access to an entrance. */
66604
67073
  acs_user_id: string;
66605
67074
  };
66606
67075
  commonParams: {};
@@ -66613,9 +67082,11 @@ interface Routes {
66613
67082
  queryParams: {};
66614
67083
  jsonBody: {};
66615
67084
  commonParams: {
67085
+ /** ID of the access system for which you want to retrieve all entrances. */
66616
67086
  acs_system_id?: string | undefined;
67087
+ /** ID of the credential for which you want to retrieve all entrances. */
66617
67088
  acs_credential_id?: string | undefined;
66618
- /** */
67089
+ /** ID of the location for which you want to retrieve all entrances. */
66619
67090
  location_id?: (string | null) | undefined;
66620
67091
  };
66621
67092
  formData: {};
@@ -66690,7 +67161,9 @@ interface Routes {
66690
67161
  queryParams: {};
66691
67162
  jsonBody: {};
66692
67163
  commonParams: {
67164
+ /** ID of the entrance for which you want to list all credentials that grant access. */
66693
67165
  acs_entrance_id: string;
67166
+ /** Conditions that credentials must meet to be included in the returned list. */
66694
67167
  include_if?: Array<'visionline_metadata.is_valid'> | undefined;
66695
67168
  };
66696
67169
  formData: {};
@@ -66816,7 +67289,7 @@ interface Routes {
66816
67289
  queryParams: {};
66817
67290
  jsonBody: {};
66818
67291
  commonParams: {
66819
- /** ID of the desired access control system. */
67292
+ /** ID of the access system that you want to get. */
66820
67293
  acs_system_id: string;
66821
67294
  };
66822
67295
  formData: {};
@@ -66966,7 +67439,7 @@ interface Routes {
66966
67439
  queryParams: {};
66967
67440
  jsonBody: {};
66968
67441
  commonParams: {
66969
- /** 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. */
66970
67443
  connected_account_id?: string | undefined;
66971
67444
  };
66972
67445
  formData: {};
@@ -67111,7 +67584,7 @@ interface Routes {
67111
67584
  queryParams: {};
67112
67585
  jsonBody: {};
67113
67586
  commonParams: {
67114
- /** 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. */
67115
67588
  acs_system_id: string;
67116
67589
  };
67117
67590
  formData: {};
@@ -67256,9 +67729,9 @@ interface Routes {
67256
67729
  queryParams: {};
67257
67730
  jsonBody: {};
67258
67731
  commonParams: {
67259
- /** ID of the desired `acs_user`. */
67732
+ /** ID of the access system user that you want to add to an access group. */
67260
67733
  acs_user_id: string;
67261
- /** ID of the desired access group. */
67734
+ /** ID of the access group to which you want to add an access system user. */
67262
67735
  acs_access_group_id: string;
67263
67736
  };
67264
67737
  formData: {};
@@ -67269,17 +67742,19 @@ interface Routes {
67269
67742
  method: 'POST';
67270
67743
  queryParams: {};
67271
67744
  jsonBody: {
67272
- /** Full name of the new `acs_user`. */
67745
+ /** Full name of the new access system user. */
67273
67746
  full_name: string;
67274
- /** 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. */
67275
67748
  acs_system_id: string;
67276
- /** 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. */
67277
67750
  acs_access_group_ids?: string[];
67278
- /** 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. */
67279
67752
  user_identity_id?: string | undefined;
67280
- /** `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`. */
67281
67754
  access_schedule?: {
67755
+ /** Starting timestamp for the new access system user's access. */
67282
67756
  starts_at?: string | undefined;
67757
+ /** Ending timestamp for the new access system user's access. */
67283
67758
  ends_at?: (string | undefined) | null;
67284
67759
  } | undefined;
67285
67760
  /**
@@ -67488,7 +67963,7 @@ interface Routes {
67488
67963
  queryParams: {};
67489
67964
  jsonBody: {};
67490
67965
  commonParams: {
67491
- /** ID of the desired `acs_user`. */
67966
+ /** ID of the access system user that you want to delete. */
67492
67967
  acs_user_id: string;
67493
67968
  };
67494
67969
  formData: {};
@@ -67500,7 +67975,7 @@ interface Routes {
67500
67975
  queryParams: {};
67501
67976
  jsonBody: {};
67502
67977
  commonParams: {
67503
- /** ID of the desired `acs_user`. */
67978
+ /** ID of the access system user that you want to get. */
67504
67979
  acs_user_id: string;
67505
67980
  };
67506
67981
  formData: {};
@@ -67700,18 +68175,19 @@ interface Routes {
67700
68175
  queryParams: {};
67701
68176
  jsonBody: {};
67702
68177
  commonParams: {
67703
- /** 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. */
67704
68179
  user_identity_id?: string | undefined;
67705
- /** 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`). */
67706
68181
  user_identity_phone_number?: string | undefined;
67707
- /** 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. */
67708
68183
  user_identity_email_address?: string | undefined;
67709
- /** 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. */
67710
68185
  acs_system_id?: string | undefined;
67711
- /** 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`. */
67712
68187
  search?: string | undefined;
67713
68188
  /** Maximum number of records to return per page. */
67714
68189
  limit?: number;
68190
+ /** Timestamp by which to limit returned access system users. Returns users created before this timestamp. */
67715
68191
  created_before?: Date | undefined;
67716
68192
  /** Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`. */
67717
68193
  page_cursor?: (string | undefined) | null;
@@ -67917,7 +68393,7 @@ interface Routes {
67917
68393
  queryParams: {};
67918
68394
  jsonBody: {};
67919
68395
  commonParams: {
67920
- /** ID of the desired `acs_user`. */
68396
+ /** ID of the access system user for whom you want to list accessible entrances. */
67921
68397
  acs_user_id: string;
67922
68398
  };
67923
68399
  formData: {};
@@ -67992,9 +68468,9 @@ interface Routes {
67992
68468
  queryParams: {};
67993
68469
  jsonBody: {};
67994
68470
  commonParams: {
67995
- /** ID of the desired `acs_user`. */
68471
+ /** ID of the access system user that you want to remove from an access group. */
67996
68472
  acs_user_id: string;
67997
- /** ID of the desired access group. */
68473
+ /** ID of the access group from which you want to remove an access system user. */
67998
68474
  acs_access_group_id: string;
67999
68475
  };
68000
68476
  formData: {};
@@ -68005,7 +68481,7 @@ interface Routes {
68005
68481
  method: 'POST';
68006
68482
  queryParams: {};
68007
68483
  jsonBody: {
68008
- /** ID of the desired `acs_user`. */
68484
+ /** ID of the access system user for whom you want to revoke access. */
68009
68485
  acs_user_id: string;
68010
68486
  };
68011
68487
  commonParams: {};
@@ -68018,7 +68494,7 @@ interface Routes {
68018
68494
  queryParams: {};
68019
68495
  jsonBody: {};
68020
68496
  commonParams: {
68021
- /** ID of the desired `acs_user`. */
68497
+ /** ID of the access system user that you want to suspend. */
68022
68498
  acs_user_id: string;
68023
68499
  };
68024
68500
  formData: {};
@@ -68030,6 +68506,7 @@ interface Routes {
68030
68506
  queryParams: {};
68031
68507
  jsonBody: {};
68032
68508
  commonParams: {
68509
+ /** ID of the unmanaged access system user that you want to get. */
68033
68510
  acs_user_id: string;
68034
68511
  };
68035
68512
  formData: {};
@@ -68225,10 +68702,15 @@ interface Routes {
68225
68702
  queryParams: {};
68226
68703
  jsonBody: {};
68227
68704
  commonParams: {
68705
+ /** ID of the user identity for which you want to retrieve all unmanaged access system users. */
68228
68706
  user_identity_id?: string | undefined;
68707
+ /** Phone number of the user identity for which you want to retrieve all unmanaged access system users. */
68229
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. */
68230
68710
  user_identity_email_address?: string | undefined;
68711
+ /** ID of the access system for which you want to retrieve all unmanaged access system users. */
68231
68712
  acs_system_id?: string | undefined;
68713
+ /** Number of unmanaged access system users to return. */
68232
68714
  limit?: number;
68233
68715
  };
68234
68716
  formData: {};
@@ -68423,7 +68905,7 @@ interface Routes {
68423
68905
  queryParams: {};
68424
68906
  jsonBody: {};
68425
68907
  commonParams: {
68426
- /** ID of the desired `acs_user`. */
68908
+ /** ID of the access system user that you want to unsuspend. */
68427
68909
  acs_user_id: string;
68428
68910
  };
68429
68911
  formData: {};
@@ -68434,9 +68916,11 @@ interface Routes {
68434
68916
  method: 'PATCH' | 'POST';
68435
68917
  queryParams: {};
68436
68918
  jsonBody: {
68437
- /** `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`. */
68438
68920
  access_schedule?: ({
68921
+ /** Starting timestamp for the access system user's access. */
68439
68922
  starts_at: string;
68923
+ /** Ending timestamp for the access system user's access. */
68440
68924
  ends_at: string;
68441
68925
  } | null) | undefined;
68442
68926
  /** ID of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). */
@@ -68462,6 +68946,7 @@ interface Routes {
68462
68946
  queryParams: {};
68463
68947
  jsonBody: {};
68464
68948
  commonParams: {
68949
+ /** ID of the action attempt that you want to get. */
68465
68950
  action_attempt_id: string;
68466
68951
  };
68467
68952
  formData: {};
@@ -69577,6 +70062,7 @@ interface Routes {
69577
70062
  queryParams: {};
69578
70063
  jsonBody: {};
69579
70064
  commonParams: {
70065
+ /** IDs of the action attempts that you want to retrieve. */
69580
70066
  action_attempt_ids: string[];
69581
70067
  };
69582
70068
  formData: {};
@@ -70691,6 +71177,7 @@ interface Routes {
70691
71177
  queryParams: {};
70692
71178
  jsonBody: {};
70693
71179
  commonParams: {
71180
+ /** ID of the Seam Bridge that you want to get. */
70694
71181
  bridge_id: string;
70695
71182
  };
70696
71183
  formData: {};
@@ -70723,16 +71210,29 @@ interface Routes {
70723
71210
  method: 'POST' | 'PUT';
70724
71211
  queryParams: {};
70725
71212
  jsonBody: {
71213
+ /** Your user ID for the user for whom you want to create a client session. */
70726
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. */
70727
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. */
70728
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. */
70729
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. */
70730
71222
  expires_at?: Date | undefined;
70731
71223
  };
70732
71224
  commonParams: {};
70733
71225
  formData: {};
70734
71226
  jsonResponse: {
70735
- /** */
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). */
70736
71236
  client_session: {
70737
71237
  client_session_id: string;
70738
71238
  workspace_id: string;
@@ -70753,6 +71253,7 @@ interface Routes {
70753
71253
  queryParams: {};
70754
71254
  jsonBody: {};
70755
71255
  commonParams: {
71256
+ /** ID of the client session that you want to delete. */
70756
71257
  client_session_id: string;
70757
71258
  };
70758
71259
  formData: {};
@@ -70764,12 +71265,22 @@ interface Routes {
70764
71265
  queryParams: {};
70765
71266
  jsonBody: {};
70766
71267
  commonParams: {
71268
+ /** ID of the client session that you want to get. */
70767
71269
  client_session_id?: string | undefined;
71270
+ /** User identifier key associated with the client session that you want to get. */
70768
71271
  user_identifier_key?: string | undefined;
70769
71272
  };
70770
71273
  formData: {};
70771
71274
  jsonResponse: {
70772
- /** */
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). */
70773
71284
  client_session: {
70774
71285
  client_session_id: string;
70775
71286
  workspace_id: string;
@@ -70789,16 +71300,29 @@ interface Routes {
70789
71300
  method: 'POST';
70790
71301
  queryParams: {};
70791
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). */
70792
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). */
70793
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). */
70794
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). */
70795
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. */
70796
71312
  expires_at?: Date | undefined;
70797
71313
  };
70798
71314
  commonParams: {};
70799
71315
  formData: {};
70800
71316
  jsonResponse: {
70801
- /** */
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). */
70802
71326
  client_session: {
70803
71327
  client_session_id: string;
70804
71328
  workspace_id: string;
@@ -70819,15 +71343,28 @@ interface Routes {
70819
71343
  queryParams: {};
70820
71344
  jsonBody: {};
70821
71345
  commonParams: {
71346
+ /** ID of the client session to which you want to grant access to resources. */
70822
71347
  client_session_id?: string | undefined;
71348
+ /** Your user ID for the user that you want to associate with the client session. */
70823
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. */
70824
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. */
70825
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. */
70826
71355
  user_identity_ids?: string[] | undefined;
70827
71356
  };
70828
71357
  formData: {};
70829
71358
  jsonResponse: {
70830
- /** */
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). */
70831
71368
  client_session: {
70832
71369
  client_session_id: string;
70833
71370
  workspace_id: string;
@@ -70848,10 +71385,15 @@ interface Routes {
70848
71385
  queryParams: {};
70849
71386
  jsonBody: {};
70850
71387
  commonParams: {
71388
+ /** ID of the client session that you want to retrieve. */
70851
71389
  client_session_id?: string | undefined;
71390
+ /** Your user ID for the user by which you want to filter client sessions. */
70852
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. */
70853
71393
  connect_webview_id?: string | undefined;
71394
+ /** Indicates whether to retrieve only client sessions without associated user identifier keys. */
70854
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. */
70855
71397
  user_identity_id?: string | undefined;
70856
71398
  };
70857
71399
  formData: {};
@@ -70876,6 +71418,7 @@ interface Routes {
70876
71418
  queryParams: {};
70877
71419
  jsonBody: {};
70878
71420
  commonParams: {
71421
+ /** ID of the client session that you want to revoke. */
70879
71422
  client_session_id: string;
70880
71423
  };
70881
71424
  formData: {};
@@ -70886,19 +71429,37 @@ interface Routes {
70886
71429
  method: 'POST';
70887
71430
  queryParams: {};
70888
71431
  jsonBody: {
71432
+ /** */
70889
71433
  device_selection_mode?: ('none' | 'single' | 'multiple') | undefined;
71434
+ /** URL that you want to redirect the user to after the provider login is complete. */
70890
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`. */
70891
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. */
70892
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. */
70893
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). */
70894
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). */
70895
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). */
70896
71447
  wait_for_device_creation?: boolean;
70897
71448
  };
70898
71449
  commonParams: {};
70899
71450
  formData: {};
70900
71451
  jsonResponse: {
70901
- /** */
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. */
70902
71463
  connect_webview: {
70903
71464
  connect_webview_id: string;
70904
71465
  workspace_id: string;
@@ -70931,6 +71492,7 @@ interface Routes {
70931
71492
  method: 'DELETE' | 'POST';
70932
71493
  queryParams: {};
70933
71494
  jsonBody: {
71495
+ /** ID of the Connect Webview that you want to delete. */
70934
71496
  connect_webview_id: string;
70935
71497
  };
70936
71498
  commonParams: {};
@@ -70943,11 +71505,22 @@ interface Routes {
70943
71505
  queryParams: {};
70944
71506
  jsonBody: {};
70945
71507
  commonParams: {
71508
+ /** ID of the Connect Webview that you want to get. */
70946
71509
  connect_webview_id: string;
70947
71510
  };
70948
71511
  formData: {};
70949
71512
  jsonResponse: {
70950
- /** */
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. */
70951
71524
  connect_webview: {
70952
71525
  connect_webview_id: string;
70953
71526
  workspace_id: string;
@@ -70981,10 +71554,11 @@ interface Routes {
70981
71554
  queryParams: {};
70982
71555
  jsonBody: {};
70983
71556
  commonParams: {
70984
- /** 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. */
70985
71558
  user_identifier_key?: string | undefined;
70986
- /** 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. */
70987
71560
  custom_metadata_has?: Record<string, string | boolean> | undefined;
71561
+ /** Maximum number of records to return per page. */
70988
71562
  limit?: number;
70989
71563
  };
70990
71564
  formData: {};
@@ -71021,7 +71595,9 @@ interface Routes {
71021
71595
  method: 'DELETE' | 'POST';
71022
71596
  queryParams: {};
71023
71597
  jsonBody: {
71598
+ /** ID of the connected account that you want to delete. */
71024
71599
  connected_account_id: string;
71600
+ /** */
71025
71601
  sync?: boolean;
71026
71602
  };
71027
71603
  commonParams: {};
@@ -71034,13 +71610,15 @@ interface Routes {
71034
71610
  queryParams: {};
71035
71611
  jsonBody: {};
71036
71612
  commonParams: {
71613
+ /** ID of the connected account that you want to get. */
71037
71614
  connected_account_id: string;
71038
71615
  } | {
71616
+ /** Email address associated with the connected account that you want to get. */
71039
71617
  email: string;
71040
71618
  };
71041
71619
  formData: {};
71042
71620
  jsonResponse: {
71043
- /** */
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. */
71044
71622
  connected_account: {
71045
71623
  connected_account_id?: string | undefined;
71046
71624
  created_at?: string | undefined;
@@ -71132,9 +71710,9 @@ interface Routes {
71132
71710
  queryParams: {};
71133
71711
  jsonBody: {};
71134
71712
  commonParams: {
71135
- /** 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. */
71136
71714
  user_identifier_key?: string | undefined;
71137
- /** 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. */
71138
71716
  custom_metadata_has?: Record<string, string | boolean> | undefined;
71139
71717
  customer_ids?: string[] | undefined;
71140
71718
  /** Maximum number of records to return per page. */
@@ -71243,14 +71821,17 @@ interface Routes {
71243
71821
  method: 'POST';
71244
71822
  queryParams: {};
71245
71823
  jsonBody: {
71824
+ /** ID of the connected account that you want to update. */
71246
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). */
71247
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). */
71248
71829
  custom_metadata?: Record<string, string | boolean | null> | undefined;
71249
71830
  };
71250
71831
  commonParams: {};
71251
71832
  formData: {};
71252
71833
  jsonResponse: {
71253
- /** */
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. */
71254
71835
  connected_account: {
71255
71836
  connected_account_id?: string | undefined;
71256
71837
  created_at?: string | undefined;
@@ -71342,6 +71923,7 @@ interface Routes {
71342
71923
  queryParams: {};
71343
71924
  jsonBody: {};
71344
71925
  commonParams: {
71926
+ /** ID of the device that you want to delete. */
71345
71927
  device_id: string;
71346
71928
  };
71347
71929
  formData: {};
@@ -71353,12 +71935,14 @@ interface Routes {
71353
71935
  queryParams: {};
71354
71936
  jsonBody: {};
71355
71937
  commonParams: {
71938
+ /** ID of the device that you want to get. */
71356
71939
  device_id?: string | undefined;
71940
+ /** Name of the device that you want to get. */
71357
71941
  name?: string | undefined;
71358
71942
  };
71359
71943
  formData: {};
71360
71944
  jsonResponse: {
71361
- /** */
71945
+ /** Represents a [device](https://docs.seam.co/latest/core-concepts/devices) that has been connected to Seam. */
71362
71946
  device: {
71363
71947
  /** Unique identifier for the device. */
71364
71948
  device_id: string;
@@ -71416,7 +72000,7 @@ interface Routes {
71416
72000
  level: number;
71417
72001
  status: 'critical' | 'low' | 'good' | 'full';
71418
72002
  } | undefined;
71419
- /** 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. */
71420
72004
  manufacturer?: string | undefined;
71421
72005
  /** Image URL for the device. */
71422
72006
  image_url?: string | undefined;
@@ -71695,6 +72279,7 @@ interface Routes {
71695
72279
  } | undefined;
71696
72280
  }) & ({
71697
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. */
71698
72283
  code_constraints?: (Array<{
71699
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';
71700
72285
  } | {
@@ -72120,27 +72705,27 @@ interface Routes {
72120
72705
  jsonBody: {};
72121
72706
  commonParams: {
72122
72707
  customer_ids?: string[] | undefined;
72123
- /** ID of the connected account by which to filter. */
72708
+ /** ID of the connected account for which you want to list devices. */
72124
72709
  connected_account_id?: string | undefined;
72125
- /** 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. */
72126
72711
  connected_account_ids?: string[] | undefined;
72127
- /** ID of the Connect Webview by which to filter devices. */
72712
+ /** ID of the Connect Webview for which you want to list devices. */
72128
72713
  connect_webview_id?: string | undefined;
72129
- /** Device type by which to filter devices. */
72714
+ /** Device type for which you want to list devices. */
72130
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;
72131
- /** Array of device types by which to filter devices. */
72716
+ /** Array of device types for which you want to list devices. */
72132
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;
72133
- /** Manufacturer by which to filter devices. */
72718
+ /** Manufacturer for which you want to list devices. */
72134
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;
72135
- /** Array of device IDs by which to filter devices. */
72720
+ /** Array of device IDs for which you want to list devices. */
72136
72721
  device_ids?: string[] | undefined;
72137
72722
  /** Numerical limit on the number of devices to return. */
72138
72723
  limit?: number;
72139
- /** 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. */
72140
72725
  created_before?: Date | undefined;
72141
- /** 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. */
72142
72727
  user_identifier_key?: string | undefined;
72143
- /** Set of key:value [custom metadata](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device) pairs 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. */
72144
72729
  custom_metadata_has?: Record<string, string | boolean> | undefined;
72145
72730
  /** Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`. */
72146
72731
  page_cursor?: (string | undefined) | null;
@@ -72148,7 +72733,7 @@ interface Routes {
72148
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;
72149
72734
  /** */
72150
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;
72151
- /** */
72736
+ /** ID of the location for which you want to list devices. */
72152
72737
  unstable_location_id?: (string | null) | undefined;
72153
72738
  };
72154
72739
  formData: {};
@@ -72210,7 +72795,7 @@ interface Routes {
72210
72795
  level: number;
72211
72796
  status: 'critical' | 'low' | 'good' | 'full';
72212
72797
  } | undefined;
72213
- /** 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. */
72214
72799
  manufacturer?: string | undefined;
72215
72800
  /** Image URL for the device. */
72216
72801
  image_url?: string | undefined;
@@ -72489,6 +73074,7 @@ interface Routes {
72489
73074
  } | undefined;
72490
73075
  }) & ({
72491
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. */
72492
73078
  code_constraints?: (Array<{
72493
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';
72494
73080
  } | {
@@ -72922,6 +73508,7 @@ interface Routes {
72922
73508
  queryParams: {};
72923
73509
  jsonBody: {};
72924
73510
  commonParams: {
73511
+ /** Category for which you want to list providers. */
72925
73512
  provider_category?: ('stable' | 'consumer_smartlocks' | 'thermostats' | 'noise_sensors' | 'access_control_systems') | undefined;
72926
73513
  };
72927
73514
  formData: {};
@@ -72950,6 +73537,7 @@ interface Routes {
72950
73537
  method: 'POST';
72951
73538
  queryParams: {};
72952
73539
  jsonBody: {
73540
+ /** ID of the device that you want to simulate connecting to Seam. */
72953
73541
  device_id: string;
72954
73542
  };
72955
73543
  commonParams: {};
@@ -72961,6 +73549,7 @@ interface Routes {
72961
73549
  method: 'POST';
72962
73550
  queryParams: {};
72963
73551
  jsonBody: {
73552
+ /** ID of the device that you want to simulate disconnecting from Seam. */
72964
73553
  device_id: string;
72965
73554
  };
72966
73555
  commonParams: {};
@@ -72972,6 +73561,7 @@ interface Routes {
72972
73561
  method: 'DELETE' | 'POST';
72973
73562
  queryParams: {};
72974
73563
  jsonBody: {
73564
+ /** ID of the device that you want to simulate removing from Seam. */
72975
73565
  device_id: string;
72976
73566
  };
72977
73567
  commonParams: {};
@@ -72984,12 +73574,14 @@ interface Routes {
72984
73574
  queryParams: {};
72985
73575
  jsonBody: {};
72986
73576
  commonParams: {
73577
+ /** ID of the unmanaged device that you want to get. */
72987
73578
  device_id?: string | undefined;
73579
+ /** Name of the unmanaged device that you want to get. */
72988
73580
  name?: string | undefined;
72989
73581
  };
72990
73582
  formData: {};
72991
73583
  jsonResponse: {
72992
- /** */
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). */
72993
73585
  device: {
72994
73586
  /** Unique identifier for the device. */
72995
73587
  device_id: string;
@@ -73211,7 +73803,7 @@ interface Routes {
73211
73803
  name: string;
73212
73804
  /** Indicates whether the device is online. */
73213
73805
  online: boolean;
73214
- /** 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. */
73215
73807
  manufacturer?: string | undefined;
73216
73808
  /** Image URL for the device. */
73217
73809
  image_url?: string | undefined;
@@ -73267,27 +73859,27 @@ interface Routes {
73267
73859
  jsonBody: {};
73268
73860
  commonParams: {
73269
73861
  customer_ids?: string[] | undefined;
73270
- /** ID of the connected account by which to filter. */
73862
+ /** ID of the connected account for which you want to list devices. */
73271
73863
  connected_account_id?: string | undefined;
73272
- /** 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. */
73273
73865
  connected_account_ids?: string[] | undefined;
73274
- /** ID of the Connect Webview by which to filter devices. */
73866
+ /** ID of the Connect Webview for which you want to list devices. */
73275
73867
  connect_webview_id?: string | undefined;
73276
- /** Device type by which to filter devices. */
73868
+ /** Device type for which you want to list devices. */
73277
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;
73278
- /** Array of device types by which to filter devices. */
73870
+ /** Array of device types for which you want to list devices. */
73279
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;
73280
- /** Manufacturer by which to filter devices. */
73872
+ /** Manufacturer for which you want to list devices. */
73281
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;
73282
- /** Array of device IDs by which to filter devices. */
73874
+ /** Array of device IDs for which you want to list devices. */
73283
73875
  device_ids?: string[] | undefined;
73284
73876
  /** Numerical limit on the number of devices to return. */
73285
73877
  limit?: number;
73286
- /** 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. */
73287
73879
  created_before?: Date | undefined;
73288
- /** 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. */
73289
73881
  user_identifier_key?: string | undefined;
73290
- /** Set of key:value [custom metadata](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device) pairs 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. */
73291
73883
  custom_metadata_has?: Record<string, string | boolean> | undefined;
73292
73884
  /** Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`. */
73293
73885
  page_cursor?: (string | undefined) | null;
@@ -73295,7 +73887,7 @@ interface Routes {
73295
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;
73296
73888
  /** */
73297
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;
73298
- /** */
73890
+ /** ID of the location for which you want to list devices. */
73299
73891
  unstable_location_id?: (string | null) | undefined;
73300
73892
  };
73301
73893
  formData: {};
@@ -73521,7 +74113,7 @@ interface Routes {
73521
74113
  name: string;
73522
74114
  /** Indicates whether the device is online. */
73523
74115
  online: boolean;
73524
- /** 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. */
73525
74117
  manufacturer?: string | undefined;
73526
74118
  /** Image URL for the device. */
73527
74119
  image_url?: string | undefined;
@@ -73576,7 +74168,9 @@ interface Routes {
73576
74168
  queryParams: {};
73577
74169
  jsonBody: {};
73578
74170
  commonParams: {
74171
+ /** ID of the unmanaged device that you want to update. */
73579
74172
  device_id: string;
74173
+ /** Indicates whether the device is managed. Set this parameter to `true` to convert an unmanaged device to managed. */
73580
74174
  is_managed: true;
73581
74175
  };
73582
74176
  formData: {};
@@ -73588,12 +74182,17 @@ interface Routes {
73588
74182
  queryParams: {};
73589
74183
  jsonBody: {};
73590
74184
  commonParams: {
74185
+ /** ID of the device that you want to update. */
73591
74186
  device_id: string;
73592
74187
  properties?: {
74188
+ /** Name for the device. */
73593
74189
  name?: (string | null) | undefined;
73594
74190
  } | undefined;
74191
+ /** Name for the device. */
73595
74192
  name?: (string | null) | undefined;
74193
+ /** Indicates whether the device is managed. To unmanage a device, set `is_managed` to `false`. */
73596
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). */
73597
74196
  custom_metadata?: Record<string, string | boolean | null> | undefined;
73598
74197
  };
73599
74198
  formData: {};
@@ -73611,7 +74210,9 @@ interface Routes {
73611
74210
  };
73612
74211
  formData: {};
73613
74212
  jsonResponse: {
73614
- /** */
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. */
73615
74216
  event?: ({
73616
74217
  /** ID of the event. */
73617
74218
  event_id: string;
@@ -76375,7 +76976,7 @@ interface Routes {
76375
76976
  };
76376
76977
  formData: {};
76377
76978
  jsonResponse: {
76378
- /** */
76979
+ /** Represents a [device](https://docs.seam.co/latest/core-concepts/devices) that has been connected to Seam. */
76379
76980
  lock: {
76380
76981
  /** Unique identifier for the device. */
76381
76982
  device_id: string;
@@ -76433,7 +77034,7 @@ interface Routes {
76433
77034
  level: number;
76434
77035
  status: 'critical' | 'low' | 'good' | 'full';
76435
77036
  } | undefined;
76436
- /** 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. */
76437
77038
  manufacturer?: string | undefined;
76438
77039
  /** Image URL for the device. */
76439
77040
  image_url?: string | undefined;
@@ -76712,6 +77313,7 @@ interface Routes {
76712
77313
  } | undefined;
76713
77314
  }) & ({
76714
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. */
76715
77317
  code_constraints?: (Array<{
76716
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';
76717
77319
  } | {
@@ -77128,7 +77730,7 @@ interface Routes {
77128
77730
  can_simulate_connection?: boolean | undefined;
77129
77731
  can_simulate_disconnection?: boolean | undefined;
77130
77732
  };
77131
- /** */
77733
+ /** Represents a [device](https://docs.seam.co/latest/core-concepts/devices) that has been connected to Seam. */
77132
77734
  device: {
77133
77735
  /** Unique identifier for the device. */
77134
77736
  device_id: string;
@@ -77186,7 +77788,7 @@ interface Routes {
77186
77788
  level: number;
77187
77789
  status: 'critical' | 'low' | 'good' | 'full';
77188
77790
  } | undefined;
77189
- /** 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. */
77190
77792
  manufacturer?: string | undefined;
77191
77793
  /** Image URL for the device. */
77192
77794
  image_url?: string | undefined;
@@ -77465,6 +78067,7 @@ interface Routes {
77465
78067
  } | undefined;
77466
78068
  }) & ({
77467
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. */
77468
78071
  code_constraints?: (Array<{
77469
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';
77470
78073
  } | {
@@ -77890,11 +78493,11 @@ interface Routes {
77890
78493
  jsonBody: {};
77891
78494
  commonParams: {
77892
78495
  customer_ids?: string[] | undefined;
77893
- /** ID of the connected account by which to filter. */
78496
+ /** ID of the connected account for which you want to list devices. */
77894
78497
  connected_account_id?: string | undefined;
77895
- /** 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. */
77896
78499
  connected_account_ids?: string[] | undefined;
77897
- /** ID of the Connect Webview by which to filter devices. */
78500
+ /** ID of the Connect Webview for which you want to list devices. */
77898
78501
  connect_webview_id?: string | undefined;
77899
78502
  /** Device type by which to filter devices. */
77900
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;
@@ -77902,15 +78505,15 @@ interface Routes {
77902
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;
77903
78506
  /** Manufacturer by which to filter devices. */
77904
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;
77905
- /** Array of device IDs by which to filter devices. */
78508
+ /** Array of device IDs for which you want to list devices. */
77906
78509
  device_ids?: string[] | undefined;
77907
78510
  /** Numerical limit on the number of devices to return. */
77908
78511
  limit?: number;
77909
- /** 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. */
77910
78513
  created_before?: Date | undefined;
77911
- /** 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. */
77912
78515
  user_identifier_key?: string | undefined;
77913
- /** Set of key:value [custom metadata](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device) pairs 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. */
77914
78517
  custom_metadata_has?: Record<string, string | boolean> | undefined;
77915
78518
  /** Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`. */
77916
78519
  page_cursor?: (string | undefined) | null;
@@ -77918,7 +78521,7 @@ interface Routes {
77918
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;
77919
78522
  /** */
77920
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;
77921
- /** */
78524
+ /** ID of the location for which you want to list devices. */
77922
78525
  unstable_location_id?: (string | null) | undefined;
77923
78526
  };
77924
78527
  formData: {};
@@ -77980,7 +78583,7 @@ interface Routes {
77980
78583
  level: number;
77981
78584
  status: 'critical' | 'low' | 'good' | 'full';
77982
78585
  } | undefined;
77983
- /** 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. */
77984
78587
  manufacturer?: string | undefined;
77985
78588
  /** Image URL for the device. */
77986
78589
  image_url?: string | undefined;
@@ -78259,6 +78862,7 @@ interface Routes {
78259
78862
  } | undefined;
78260
78863
  }) & ({
78261
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. */
78262
78866
  code_constraints?: (Array<{
78263
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';
78264
78868
  } | {
@@ -78732,7 +79336,7 @@ interface Routes {
78732
79336
  level: number;
78733
79337
  status: 'critical' | 'low' | 'good' | 'full';
78734
79338
  } | undefined;
78735
- /** 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. */
78736
79340
  manufacturer?: string | undefined;
78737
79341
  /** Image URL for the device. */
78738
79342
  image_url?: string | undefined;
@@ -79011,6 +79615,7 @@ interface Routes {
79011
79615
  } | undefined;
79012
79616
  }) & ({
79013
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. */
79014
79619
  code_constraints?: (Array<{
79015
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';
79016
79621
  } | {
@@ -83934,11 +84539,11 @@ interface Routes {
83934
84539
  jsonBody: {};
83935
84540
  commonParams: {
83936
84541
  customer_ids?: string[] | undefined;
83937
- /** ID of the connected account by which to filter. */
84542
+ /** ID of the connected account for which you want to list devices. */
83938
84543
  connected_account_id?: string | undefined;
83939
- /** 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. */
83940
84545
  connected_account_ids?: string[] | undefined;
83941
- /** ID of the Connect Webview by which to filter devices. */
84546
+ /** ID of the Connect Webview for which you want to list devices. */
83942
84547
  connect_webview_id?: string | undefined;
83943
84548
  /** Device type by which to filter devices. */
83944
84549
  device_type?: ('noiseaware_activity_zone' | 'minut_sensor') | undefined;
@@ -83946,15 +84551,15 @@ interface Routes {
83946
84551
  device_types?: Array<'noiseaware_activity_zone' | 'minut_sensor'> | undefined;
83947
84552
  /** Manufacturer by which to filter devices. */
83948
84553
  manufacturer?: ('minut' | 'noiseaware') | undefined;
83949
- /** Array of device IDs by which to filter devices. */
84554
+ /** Array of device IDs for which you want to list devices. */
83950
84555
  device_ids?: string[] | undefined;
83951
84556
  /** Numerical limit on the number of devices to return. */
83952
84557
  limit?: number;
83953
- /** 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. */
83954
84559
  created_before?: Date | undefined;
83955
- /** 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. */
83956
84561
  user_identifier_key?: string | undefined;
83957
- /** Set of key:value [custom metadata](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device) pairs 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. */
83958
84563
  custom_metadata_has?: Record<string, string | boolean> | undefined;
83959
84564
  /** Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`. */
83960
84565
  page_cursor?: (string | undefined) | null;
@@ -83962,7 +84567,7 @@ interface Routes {
83962
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;
83963
84568
  /** */
83964
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;
83965
- /** */
84570
+ /** ID of the location for which you want to list devices. */
83966
84571
  unstable_location_id?: (string | null) | undefined;
83967
84572
  };
83968
84573
  formData: {};
@@ -84024,7 +84629,7 @@ interface Routes {
84024
84629
  level: number;
84025
84630
  status: 'critical' | 'low' | 'good' | 'full';
84026
84631
  } | undefined;
84027
- /** 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. */
84028
84633
  manufacturer?: string | undefined;
84029
84634
  /** Image URL for the device. */
84030
84635
  image_url?: string | undefined;
@@ -84303,6 +84908,7 @@ interface Routes {
84303
84908
  } | undefined;
84304
84909
  }) & ({
84305
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. */
84306
84912
  code_constraints?: (Array<{
84307
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';
84308
84914
  } | {
@@ -84776,7 +85382,7 @@ interface Routes {
84776
85382
  level: number;
84777
85383
  status: 'critical' | 'low' | 'good' | 'full';
84778
85384
  } | undefined;
84779
- /** 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. */
84780
85386
  manufacturer?: string | undefined;
84781
85387
  /** Image URL for the device. */
84782
85388
  image_url?: string | undefined;
@@ -85055,6 +85661,7 @@ interface Routes {
85055
85661
  } | undefined;
85056
85662
  }) & ({
85057
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. */
85058
85665
  code_constraints?: (Array<{
85059
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';
85060
85667
  } | {
@@ -89354,7 +89961,15 @@ interface Routes {
89354
89961
  commonParams: {};
89355
89962
  formData: {};
89356
89963
  jsonResponse: {
89357
- /** */
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). */
89358
89973
  client_session: {
89359
89974
  client_session_id: string;
89360
89975
  workspace_id: string;
@@ -92969,7 +93584,7 @@ interface Routes {
92969
93584
  };
92970
93585
  formData: {};
92971
93586
  jsonResponse: {
92972
- /** */
93587
+ /** Represents a [device](https://docs.seam.co/latest/core-concepts/devices) that has been connected to Seam. */
92973
93588
  thermostat: {
92974
93589
  /** Unique identifier for the device. */
92975
93590
  device_id: string;
@@ -93027,7 +93642,7 @@ interface Routes {
93027
93642
  level: number;
93028
93643
  status: 'critical' | 'low' | 'good' | 'full';
93029
93644
  } | undefined;
93030
- /** 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. */
93031
93646
  manufacturer?: string | undefined;
93032
93647
  /** Image URL for the device. */
93033
93648
  image_url?: string | undefined;
@@ -93306,6 +93921,7 @@ interface Routes {
93306
93921
  } | undefined;
93307
93922
  }) & ({
93308
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. */
93309
93925
  code_constraints?: (Array<{
93310
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';
93311
93927
  } | {
@@ -95979,11 +96595,11 @@ interface Routes {
95979
96595
  jsonBody: {};
95980
96596
  commonParams: {
95981
96597
  customer_ids?: string[] | undefined;
95982
- /** ID of the connected account by which to filter. */
96598
+ /** ID of the connected account for which you want to list devices. */
95983
96599
  connected_account_id?: string | undefined;
95984
- /** 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. */
95985
96601
  connected_account_ids?: string[] | undefined;
95986
- /** ID of the Connect Webview by which to filter devices. */
96602
+ /** ID of the Connect Webview for which you want to list devices. */
95987
96603
  connect_webview_id?: string | undefined;
95988
96604
  /** Device type by which to filter thermostat devices. */
95989
96605
  device_type?: ('ecobee_thermostat' | 'nest_thermostat' | 'honeywell_resideo_thermostat' | 'tado_thermostat' | 'sensi_thermostat' | 'smartthings_thermostat') | undefined;
@@ -95991,15 +96607,15 @@ interface Routes {
95991
96607
  device_types?: Array<'ecobee_thermostat' | 'nest_thermostat' | 'honeywell_resideo_thermostat' | 'tado_thermostat' | 'sensi_thermostat' | 'smartthings_thermostat'> | undefined;
95992
96608
  /** Manufacturer by which to filter thermostat devices. */
95993
96609
  manufacturer?: ('ecobee' | 'honeywell_resideo' | 'nest' | 'tado' | 'sensi') | undefined;
95994
- /** Array of device IDs by which to filter devices. */
96610
+ /** Array of device IDs for which you want to list devices. */
95995
96611
  device_ids?: string[] | undefined;
95996
96612
  /** Numerical limit on the number of devices to return. */
95997
96613
  limit?: number;
95998
- /** 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. */
95999
96615
  created_before?: Date | undefined;
96000
- /** 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. */
96001
96617
  user_identifier_key?: string | undefined;
96002
- /** Set of key:value [custom metadata](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device) pairs 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. */
96003
96619
  custom_metadata_has?: Record<string, string | boolean> | undefined;
96004
96620
  /** Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`. */
96005
96621
  page_cursor?: (string | undefined) | null;
@@ -96007,7 +96623,7 @@ interface Routes {
96007
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;
96008
96624
  /** */
96009
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;
96010
- /** */
96626
+ /** ID of the location for which you want to list devices. */
96011
96627
  unstable_location_id?: (string | null) | undefined;
96012
96628
  };
96013
96629
  formData: {};
@@ -96069,7 +96685,7 @@ interface Routes {
96069
96685
  level: number;
96070
96686
  status: 'critical' | 'low' | 'good' | 'full';
96071
96687
  } | undefined;
96072
- /** 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. */
96073
96689
  manufacturer?: string | undefined;
96074
96690
  /** Image URL for the device. */
96075
96691
  image_url?: string | undefined;
@@ -96348,6 +96964,7 @@ interface Routes {
96348
96964
  } | undefined;
96349
96965
  }) & ({
96350
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. */
96351
96968
  code_constraints?: (Array<{
96352
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';
96353
96970
  } | {
@@ -96821,7 +97438,7 @@ interface Routes {
96821
97438
  level: number;
96822
97439
  status: 'critical' | 'low' | 'good' | 'full';
96823
97440
  } | undefined;
96824
- /** 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. */
96825
97442
  manufacturer?: string | undefined;
96826
97443
  /** Image URL for the device. */
96827
97444
  image_url?: string | undefined;
@@ -97100,6 +97717,7 @@ interface Routes {
97100
97717
  } | undefined;
97101
97718
  }) & ({
97102
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. */
97103
97721
  code_constraints?: (Array<{
97104
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';
97105
97723
  } | {
@@ -102752,6 +103370,43 @@ interface Routes {
102752
103370
  };
102753
103371
  };
102754
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
+ };
102755
103410
  '/user_identities/add_acs_user': {
102756
103411
  route: '/user_identities/add_acs_user';
102757
103412
  method: 'POST' | 'PUT';
@@ -102785,7 +103440,7 @@ interface Routes {
102785
103440
  };
102786
103441
  formData: {};
102787
103442
  jsonResponse: {
102788
- /** 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. */
102789
103444
  user_identity: {
102790
103445
  /** ID of the user identity. */
102791
103446
  user_identity_id: string;
@@ -102946,7 +103601,7 @@ interface Routes {
102946
103601
  };
102947
103602
  formData: {};
102948
103603
  jsonResponse: {
102949
- /** 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. */
102950
103605
  user_identity: {
102951
103606
  /** ID of the user identity. */
102952
103607
  user_identity_id: string;
@@ -103075,7 +103730,7 @@ interface Routes {
103075
103730
  level: number;
103076
103731
  status: 'critical' | 'low' | 'good' | 'full';
103077
103732
  } | undefined;
103078
- /** 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. */
103079
103734
  manufacturer?: string | undefined;
103080
103735
  /** Image URL for the device. */
103081
103736
  image_url?: string | undefined;
@@ -103354,6 +104009,7 @@ interface Routes {
103354
104009
  } | undefined;
103355
104010
  }) & ({
103356
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. */
103357
104013
  code_constraints?: (Array<{
103358
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';
103359
104015
  } | {
@@ -103829,7 +104485,7 @@ interface Routes {
103829
104485
  level: number;
103830
104486
  status: 'critical' | 'low' | 'good' | 'full';
103831
104487
  } | undefined;
103832
- /** 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. */
103833
104489
  manufacturer?: string | undefined;
103834
104490
  /** Image URL for the device. */
103835
104491
  image_url?: string | undefined;
@@ -104108,6 +104764,7 @@ interface Routes {
104108
104764
  } | undefined;
104109
104765
  }) & ({
104110
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. */
104111
104768
  code_constraints?: (Array<{
104112
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';
104113
104770
  } | {
@@ -105024,7 +105681,7 @@ interface Routes {
105024
105681
  commonParams: {};
105025
105682
  formData: {};
105026
105683
  jsonResponse: {
105027
- /** */
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). */
105028
105685
  workspace: {
105029
105686
  workspace_id: string;
105030
105687
  name: string;
@@ -105053,7 +105710,7 @@ interface Routes {
105053
105710
  commonParams: {};
105054
105711
  formData: {};
105055
105712
  jsonResponse: {
105056
- /** */
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). */
105057
105714
  workspace: {
105058
105715
  workspace_id: string;
105059
105716
  name: string;