@seamapi/types 1.410.1 → 1.411.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -21200,11 +21200,11 @@ declare const pagination: z.ZodObject<{
21200
21200
  }>;
21201
21201
  type Pagination = z.infer<typeof pagination>;
21202
21202
 
21203
- declare const building_block_type: z.ZodEnum<["connect_accounts", "manage_devices", "organize_spaces"]>;
21203
+ declare const building_block_type: z.ZodEnum<["connect_accounts", "manage_devices", "organize_spaces", "console"]>;
21204
21204
  type BuildingBlockType = z.infer<typeof building_block_type>;
21205
21205
  declare const magic_link: z.ZodObject<{
21206
21206
  url: z.ZodString;
21207
- building_block_type: z.ZodEnum<["connect_accounts", "manage_devices", "organize_spaces"]>;
21207
+ building_block_type: z.ZodEnum<["connect_accounts", "manage_devices", "organize_spaces", "console"]>;
21208
21208
  customer_key: z.ZodString;
21209
21209
  expires_at: z.ZodString;
21210
21210
  workspace_id: z.ZodString;
@@ -21214,14 +21214,14 @@ declare const magic_link: z.ZodObject<{
21214
21214
  created_at: string;
21215
21215
  url: string;
21216
21216
  expires_at: string;
21217
- building_block_type: "connect_accounts" | "manage_devices" | "organize_spaces";
21217
+ building_block_type: "connect_accounts" | "manage_devices" | "organize_spaces" | "console";
21218
21218
  customer_key: string;
21219
21219
  }, {
21220
21220
  workspace_id: string;
21221
21221
  created_at: string;
21222
21222
  url: string;
21223
21223
  expires_at: string;
21224
- building_block_type: "connect_accounts" | "manage_devices" | "organize_spaces";
21224
+ building_block_type: "connect_accounts" | "manage_devices" | "organize_spaces" | "console";
21225
21225
  customer_key: string;
21226
21226
  }>;
21227
21227
  type MagicLink = z.infer<typeof magic_link>;
@@ -34448,22 +34448,32 @@ declare const _default: {
34448
34448
  };
34449
34449
  security: ({
34450
34450
  client_session: never[];
34451
+ client_session_with_customer?: never;
34452
+ pat_with_workspace?: never;
34453
+ console_session_with_workspace?: never;
34454
+ api_key?: never;
34455
+ } | {
34456
+ client_session_with_customer: never[];
34457
+ client_session?: never;
34451
34458
  pat_with_workspace?: never;
34452
34459
  console_session_with_workspace?: never;
34453
34460
  api_key?: never;
34454
34461
  } | {
34455
34462
  pat_with_workspace: never[];
34456
34463
  client_session?: never;
34464
+ client_session_with_customer?: never;
34457
34465
  console_session_with_workspace?: never;
34458
34466
  api_key?: never;
34459
34467
  } | {
34460
34468
  console_session_with_workspace: never[];
34461
34469
  client_session?: never;
34470
+ client_session_with_customer?: never;
34462
34471
  pat_with_workspace?: never;
34463
34472
  api_key?: never;
34464
34473
  } | {
34465
34474
  api_key: never[];
34466
34475
  client_session?: never;
34476
+ client_session_with_customer?: never;
34467
34477
  pat_with_workspace?: never;
34468
34478
  console_session_with_workspace?: never;
34469
34479
  })[];
@@ -34603,22 +34613,32 @@ declare const _default: {
34603
34613
  };
34604
34614
  security: ({
34605
34615
  client_session: never[];
34616
+ client_session_with_customer?: never;
34617
+ pat_with_workspace?: never;
34618
+ console_session_with_workspace?: never;
34619
+ api_key?: never;
34620
+ } | {
34621
+ client_session_with_customer: never[];
34622
+ client_session?: never;
34606
34623
  pat_with_workspace?: never;
34607
34624
  console_session_with_workspace?: never;
34608
34625
  api_key?: never;
34609
34626
  } | {
34610
34627
  pat_with_workspace: never[];
34611
34628
  client_session?: never;
34629
+ client_session_with_customer?: never;
34612
34630
  console_session_with_workspace?: never;
34613
34631
  api_key?: never;
34614
34632
  } | {
34615
34633
  console_session_with_workspace: never[];
34616
34634
  client_session?: never;
34635
+ client_session_with_customer?: never;
34617
34636
  pat_with_workspace?: never;
34618
34637
  api_key?: never;
34619
34638
  } | {
34620
34639
  api_key: never[];
34621
34640
  client_session?: never;
34641
+ client_session_with_customer?: never;
34622
34642
  pat_with_workspace?: never;
34623
34643
  console_session_with_workspace?: never;
34624
34644
  })[];
@@ -34759,22 +34779,32 @@ declare const _default: {
34759
34779
  };
34760
34780
  security: ({
34761
34781
  client_session: never[];
34782
+ client_session_with_customer?: never;
34783
+ pat_with_workspace?: never;
34784
+ console_session_with_workspace?: never;
34785
+ api_key?: never;
34786
+ } | {
34787
+ client_session_with_customer: never[];
34788
+ client_session?: never;
34762
34789
  pat_with_workspace?: never;
34763
34790
  console_session_with_workspace?: never;
34764
34791
  api_key?: never;
34765
34792
  } | {
34766
34793
  pat_with_workspace: never[];
34767
34794
  client_session?: never;
34795
+ client_session_with_customer?: never;
34768
34796
  console_session_with_workspace?: never;
34769
34797
  api_key?: never;
34770
34798
  } | {
34771
34799
  console_session_with_workspace: never[];
34772
34800
  client_session?: never;
34801
+ client_session_with_customer?: never;
34773
34802
  pat_with_workspace?: never;
34774
34803
  api_key?: never;
34775
34804
  } | {
34776
34805
  api_key: never[];
34777
34806
  client_session?: never;
34807
+ client_session_with_customer?: never;
34778
34808
  pat_with_workspace?: never;
34779
34809
  console_session_with_workspace?: never;
34780
34810
  })[];
@@ -42457,22 +42487,32 @@ declare const _default: {
42457
42487
  };
42458
42488
  security: ({
42459
42489
  client_session: never[];
42490
+ client_session_with_customer?: never;
42491
+ api_key?: never;
42492
+ pat_with_workspace?: never;
42493
+ console_session_with_workspace?: never;
42494
+ } | {
42495
+ client_session_with_customer: never[];
42496
+ client_session?: never;
42460
42497
  api_key?: never;
42461
42498
  pat_with_workspace?: never;
42462
42499
  console_session_with_workspace?: never;
42463
42500
  } | {
42464
42501
  api_key: never[];
42465
42502
  client_session?: never;
42503
+ client_session_with_customer?: never;
42466
42504
  pat_with_workspace?: never;
42467
42505
  console_session_with_workspace?: never;
42468
42506
  } | {
42469
42507
  pat_with_workspace: never[];
42470
42508
  client_session?: never;
42509
+ client_session_with_customer?: never;
42471
42510
  api_key?: never;
42472
42511
  console_session_with_workspace?: never;
42473
42512
  } | {
42474
42513
  console_session_with_workspace: never[];
42475
42514
  client_session?: never;
42515
+ client_session_with_customer?: never;
42476
42516
  api_key?: never;
42477
42517
  pat_with_workspace?: never;
42478
42518
  })[];
@@ -43238,14 +43278,22 @@ declare const _default: {
43238
43278
  api_key: never[];
43239
43279
  pat_with_workspace?: never;
43240
43280
  console_session_with_workspace?: never;
43281
+ client_session_with_customer?: never;
43241
43282
  } | {
43242
43283
  pat_with_workspace: never[];
43243
43284
  api_key?: never;
43244
43285
  console_session_with_workspace?: never;
43286
+ client_session_with_customer?: never;
43245
43287
  } | {
43246
43288
  console_session_with_workspace: never[];
43247
43289
  api_key?: never;
43248
43290
  pat_with_workspace?: never;
43291
+ client_session_with_customer?: never;
43292
+ } | {
43293
+ client_session_with_customer: never[];
43294
+ api_key?: never;
43295
+ pat_with_workspace?: never;
43296
+ console_session_with_workspace?: never;
43249
43297
  })[];
43250
43298
  summary: string;
43251
43299
  tags: string[];
@@ -43304,14 +43352,22 @@ declare const _default: {
43304
43352
  api_key: never[];
43305
43353
  pat_with_workspace?: never;
43306
43354
  console_session_with_workspace?: never;
43355
+ client_session_with_customer?: never;
43307
43356
  } | {
43308
43357
  pat_with_workspace: never[];
43309
43358
  api_key?: never;
43310
43359
  console_session_with_workspace?: never;
43360
+ client_session_with_customer?: never;
43311
43361
  } | {
43312
43362
  console_session_with_workspace: never[];
43313
43363
  api_key?: never;
43314
43364
  pat_with_workspace?: never;
43365
+ client_session_with_customer?: never;
43366
+ } | {
43367
+ client_session_with_customer: never[];
43368
+ api_key?: never;
43369
+ pat_with_workspace?: never;
43370
+ console_session_with_workspace?: never;
43315
43371
  })[];
43316
43372
  summary: string;
43317
43373
  tags: string[];
@@ -43370,14 +43426,22 @@ declare const _default: {
43370
43426
  api_key: never[];
43371
43427
  pat_with_workspace?: never;
43372
43428
  console_session_with_workspace?: never;
43429
+ client_session_with_customer?: never;
43373
43430
  } | {
43374
43431
  pat_with_workspace: never[];
43375
43432
  api_key?: never;
43376
43433
  console_session_with_workspace?: never;
43434
+ client_session_with_customer?: never;
43377
43435
  } | {
43378
43436
  console_session_with_workspace: never[];
43379
43437
  api_key?: never;
43380
43438
  pat_with_workspace?: never;
43439
+ client_session_with_customer?: never;
43440
+ } | {
43441
+ client_session_with_customer: never[];
43442
+ api_key?: never;
43443
+ pat_with_workspace?: never;
43444
+ console_session_with_workspace?: never;
43381
43445
  })[];
43382
43446
  summary: string;
43383
43447
  tags: string[];
@@ -43872,21 +43936,31 @@ declare const _default: {
43872
43936
  pat_with_workspace?: never;
43873
43937
  console_session_with_workspace?: never;
43874
43938
  client_session?: never;
43939
+ client_session_with_customer?: never;
43875
43940
  } | {
43876
43941
  pat_with_workspace: never[];
43877
43942
  api_key?: never;
43878
43943
  console_session_with_workspace?: never;
43879
43944
  client_session?: never;
43945
+ client_session_with_customer?: never;
43880
43946
  } | {
43881
43947
  console_session_with_workspace: never[];
43882
43948
  api_key?: never;
43883
43949
  pat_with_workspace?: never;
43884
43950
  client_session?: never;
43951
+ client_session_with_customer?: never;
43885
43952
  } | {
43886
43953
  client_session: never[];
43887
43954
  api_key?: never;
43888
43955
  pat_with_workspace?: never;
43889
43956
  console_session_with_workspace?: never;
43957
+ client_session_with_customer?: never;
43958
+ } | {
43959
+ client_session_with_customer: never[];
43960
+ api_key?: never;
43961
+ pat_with_workspace?: never;
43962
+ console_session_with_workspace?: never;
43963
+ client_session?: never;
43890
43964
  })[];
43891
43965
  summary: string;
43892
43966
  tags: string[];
@@ -43977,21 +44051,31 @@ declare const _default: {
43977
44051
  pat_with_workspace?: never;
43978
44052
  console_session_with_workspace?: never;
43979
44053
  client_session?: never;
44054
+ client_session_with_customer?: never;
43980
44055
  } | {
43981
44056
  pat_with_workspace: never[];
43982
44057
  api_key?: never;
43983
44058
  console_session_with_workspace?: never;
43984
44059
  client_session?: never;
44060
+ client_session_with_customer?: never;
43985
44061
  } | {
43986
44062
  console_session_with_workspace: never[];
43987
44063
  api_key?: never;
43988
44064
  pat_with_workspace?: never;
43989
44065
  client_session?: never;
44066
+ client_session_with_customer?: never;
43990
44067
  } | {
43991
44068
  client_session: never[];
43992
44069
  api_key?: never;
43993
44070
  pat_with_workspace?: never;
43994
44071
  console_session_with_workspace?: never;
44072
+ client_session_with_customer?: never;
44073
+ } | {
44074
+ client_session_with_customer: never[];
44075
+ api_key?: never;
44076
+ pat_with_workspace?: never;
44077
+ console_session_with_workspace?: never;
44078
+ client_session?: never;
43995
44079
  })[];
43996
44080
  summary: string;
43997
44081
  tags: string[];
@@ -44065,21 +44149,31 @@ declare const _default: {
44065
44149
  api_key?: never;
44066
44150
  pat_with_workspace?: never;
44067
44151
  console_session_with_workspace?: never;
44152
+ client_session_with_customer?: never;
44068
44153
  } | {
44069
44154
  api_key: never[];
44070
44155
  client_session?: never;
44071
44156
  pat_with_workspace?: never;
44072
44157
  console_session_with_workspace?: never;
44158
+ client_session_with_customer?: never;
44073
44159
  } | {
44074
44160
  pat_with_workspace: never[];
44075
44161
  client_session?: never;
44076
44162
  api_key?: never;
44077
44163
  console_session_with_workspace?: never;
44164
+ client_session_with_customer?: never;
44078
44165
  } | {
44079
44166
  console_session_with_workspace: never[];
44080
44167
  client_session?: never;
44081
44168
  api_key?: never;
44082
44169
  pat_with_workspace?: never;
44170
+ client_session_with_customer?: never;
44171
+ } | {
44172
+ client_session_with_customer: never[];
44173
+ client_session?: never;
44174
+ api_key?: never;
44175
+ pat_with_workspace?: never;
44176
+ console_session_with_workspace?: never;
44083
44177
  })[];
44084
44178
  summary: string;
44085
44179
  tags: string[];
@@ -46328,12 +46422,15 @@ declare const _default: {
46328
46422
  schema: {
46329
46423
  properties: {
46330
46424
  bridge_client_machine_identifier_key: {
46425
+ description: string;
46331
46426
  type: string;
46332
46427
  };
46333
46428
  bridge_client_name: {
46429
+ description: string;
46334
46430
  type: string;
46335
46431
  };
46336
46432
  bridge_client_time_zone: {
46433
+ description: string;
46337
46434
  type: string;
46338
46435
  };
46339
46436
  };
@@ -47215,10 +47312,12 @@ declare const _default: {
47215
47312
  schema: {
47216
47313
  properties: {
47217
47314
  is_tailscale_connected: {
47315
+ description: string;
47218
47316
  nullable: boolean;
47219
47317
  type: string;
47220
47318
  };
47221
47319
  tailscale_ip_v4: {
47320
+ description: string;
47222
47321
  nullable: boolean;
47223
47322
  type: string;
47224
47323
  };
@@ -47552,9 +47651,11 @@ declare const _default: {
47552
47651
  schema: {
47553
47652
  properties: {
47554
47653
  custom_sdk_installation_id: {
47654
+ description: string;
47555
47655
  type: string;
47556
47656
  };
47557
47657
  phone_device_metadata: {
47658
+ description: string;
47558
47659
  properties: {
47559
47660
  manufacturer: {
47560
47661
  type: string;
@@ -47569,6 +47670,7 @@ declare const _default: {
47569
47670
  type: string;
47570
47671
  };
47571
47672
  phone_os: {
47673
+ description: string;
47572
47674
  enum: string[];
47573
47675
  type: string;
47574
47676
  };
@@ -47629,6 +47731,7 @@ declare const _default: {
47629
47731
  schema: {
47630
47732
  properties: {
47631
47733
  collection_key: {
47734
+ description: string;
47632
47735
  type: string;
47633
47736
  };
47634
47737
  };
@@ -47846,6 +47949,7 @@ declare const _default: {
47846
47949
  schema: {
47847
47950
  properties: {
47848
47951
  acs_entrance_ids: {
47952
+ description: string;
47849
47953
  items: {
47850
47954
  format: string;
47851
47955
  type: string;
@@ -47854,6 +47958,7 @@ declare const _default: {
47854
47958
  type: string;
47855
47959
  };
47856
47960
  space_id: {
47961
+ description: string;
47857
47962
  format: string;
47858
47963
  type: string;
47859
47964
  };
@@ -47918,6 +48023,7 @@ declare const _default: {
47918
48023
  schema: {
47919
48024
  properties: {
47920
48025
  acs_entrance_ids: {
48026
+ description: string;
47921
48027
  items: {
47922
48028
  format: string;
47923
48029
  type: string;
@@ -47926,6 +48032,7 @@ declare const _default: {
47926
48032
  type: string;
47927
48033
  };
47928
48034
  space_id: {
48035
+ description: string;
47929
48036
  format: string;
47930
48037
  type: string;
47931
48038
  };
@@ -47991,6 +48098,7 @@ declare const _default: {
47991
48098
  schema: {
47992
48099
  properties: {
47993
48100
  device_ids: {
48101
+ description: string;
47994
48102
  items: {
47995
48103
  format: string;
47996
48104
  type: string;
@@ -47999,6 +48107,7 @@ declare const _default: {
47999
48107
  type: string;
48000
48108
  };
48001
48109
  space_id: {
48110
+ description: string;
48002
48111
  format: string;
48003
48112
  type: string;
48004
48113
  };
@@ -48063,6 +48172,7 @@ declare const _default: {
48063
48172
  schema: {
48064
48173
  properties: {
48065
48174
  device_ids: {
48175
+ description: string;
48066
48176
  items: {
48067
48177
  format: string;
48068
48178
  type: string;
@@ -48071,6 +48181,7 @@ declare const _default: {
48071
48181
  type: string;
48072
48182
  };
48073
48183
  space_id: {
48184
+ description: string;
48074
48185
  format: string;
48075
48186
  type: string;
48076
48187
  };
@@ -48136,6 +48247,7 @@ declare const _default: {
48136
48247
  schema: {
48137
48248
  properties: {
48138
48249
  acs_entrance_ids: {
48250
+ description: string;
48139
48251
  items: {
48140
48252
  format: string;
48141
48253
  type: string;
@@ -48143,6 +48255,7 @@ declare const _default: {
48143
48255
  type: string;
48144
48256
  };
48145
48257
  device_ids: {
48258
+ description: string;
48146
48259
  items: {
48147
48260
  format: string;
48148
48261
  type: string;
@@ -48150,6 +48263,7 @@ declare const _default: {
48150
48263
  type: string;
48151
48264
  };
48152
48265
  name: {
48266
+ description: string;
48153
48267
  type: string;
48154
48268
  };
48155
48269
  };
@@ -48219,6 +48333,7 @@ declare const _default: {
48219
48333
  schema: {
48220
48334
  properties: {
48221
48335
  space_id: {
48336
+ description: string;
48222
48337
  format: string;
48223
48338
  type: string;
48224
48339
  };
@@ -48268,6 +48383,7 @@ declare const _default: {
48268
48383
  })[];
48269
48384
  summary: string;
48270
48385
  tags: never[];
48386
+ 'x-draft': string;
48271
48387
  'x-fern-sdk-group-name': string[];
48272
48388
  'x-fern-sdk-method-name': string;
48273
48389
  'x-response-key': null;
@@ -48284,6 +48400,7 @@ declare const _default: {
48284
48400
  schema: {
48285
48401
  properties: {
48286
48402
  space_id: {
48403
+ description: string;
48287
48404
  format: string;
48288
48405
  type: string;
48289
48406
  };
@@ -48336,6 +48453,7 @@ declare const _default: {
48336
48453
  })[];
48337
48454
  summary: string;
48338
48455
  tags: never[];
48456
+ 'x-draft': string;
48339
48457
  'x-fern-sdk-group-name': string[];
48340
48458
  'x-fern-sdk-method-name': string;
48341
48459
  'x-fern-sdk-return-value': string;
@@ -48463,6 +48581,7 @@ declare const _default: {
48463
48581
  schema: {
48464
48582
  properties: {
48465
48583
  acs_entrance_ids: {
48584
+ description: string;
48466
48585
  items: {
48467
48586
  format: string;
48468
48587
  type: string;
@@ -48470,6 +48589,7 @@ declare const _default: {
48470
48589
  type: string;
48471
48590
  };
48472
48591
  space_id: {
48592
+ description: string;
48473
48593
  format: string;
48474
48594
  type: string;
48475
48595
  };
@@ -48536,6 +48656,7 @@ declare const _default: {
48536
48656
  schema: {
48537
48657
  properties: {
48538
48658
  device_ids: {
48659
+ description: string;
48539
48660
  items: {
48540
48661
  format: string;
48541
48662
  type: string;
@@ -48543,6 +48664,7 @@ declare const _default: {
48543
48664
  type: string;
48544
48665
  };
48545
48666
  space_id: {
48667
+ description: string;
48546
48668
  format: string;
48547
48669
  type: string;
48548
48670
  };
@@ -48609,9 +48731,11 @@ declare const _default: {
48609
48731
  schema: {
48610
48732
  properties: {
48611
48733
  name: {
48734
+ description: string;
48612
48735
  type: string;
48613
48736
  };
48614
48737
  space_id: {
48738
+ description: string;
48615
48739
  format: string;
48616
48740
  type: string;
48617
48741
  };
@@ -48678,9 +48802,11 @@ declare const _default: {
48678
48802
  schema: {
48679
48803
  properties: {
48680
48804
  name: {
48805
+ description: string;
48681
48806
  type: string;
48682
48807
  };
48683
48808
  space_id: {
48809
+ description: string;
48684
48810
  format: string;
48685
48811
  type: string;
48686
48812
  };
@@ -52793,6 +52919,7 @@ declare const _default: {
52793
52919
  schema: {
52794
52920
  properties: {
52795
52921
  acs_entrance_ids: {
52922
+ description: string;
52796
52923
  items: {
52797
52924
  format: string;
52798
52925
  type: string;
@@ -52801,6 +52928,7 @@ declare const _default: {
52801
52928
  type: string;
52802
52929
  };
52803
52930
  location_id: {
52931
+ description: string;
52804
52932
  format: string;
52805
52933
  type: string;
52806
52934
  };
@@ -52865,6 +52993,7 @@ declare const _default: {
52865
52993
  schema: {
52866
52994
  properties: {
52867
52995
  acs_entrance_ids: {
52996
+ description: string;
52868
52997
  items: {
52869
52998
  format: string;
52870
52999
  type: string;
@@ -52873,6 +53002,7 @@ declare const _default: {
52873
53002
  type: string;
52874
53003
  };
52875
53004
  location_id: {
53005
+ description: string;
52876
53006
  format: string;
52877
53007
  type: string;
52878
53008
  };
@@ -52938,6 +53068,7 @@ declare const _default: {
52938
53068
  schema: {
52939
53069
  properties: {
52940
53070
  device_ids: {
53071
+ description: string;
52941
53072
  items: {
52942
53073
  format: string;
52943
53074
  type: string;
@@ -52946,6 +53077,7 @@ declare const _default: {
52946
53077
  type: string;
52947
53078
  };
52948
53079
  location_id: {
53080
+ description: string;
52949
53081
  format: string;
52950
53082
  type: string;
52951
53083
  };
@@ -53010,6 +53142,7 @@ declare const _default: {
53010
53142
  schema: {
53011
53143
  properties: {
53012
53144
  device_ids: {
53145
+ description: string;
53013
53146
  items: {
53014
53147
  format: string;
53015
53148
  type: string;
@@ -53018,6 +53151,7 @@ declare const _default: {
53018
53151
  type: string;
53019
53152
  };
53020
53153
  location_id: {
53154
+ description: string;
53021
53155
  format: string;
53022
53156
  type: string;
53023
53157
  };
@@ -53083,6 +53217,7 @@ declare const _default: {
53083
53217
  schema: {
53084
53218
  properties: {
53085
53219
  acs_entrance_ids: {
53220
+ description: string;
53086
53221
  items: {
53087
53222
  format: string;
53088
53223
  type: string;
@@ -53090,6 +53225,7 @@ declare const _default: {
53090
53225
  type: string;
53091
53226
  };
53092
53227
  device_ids: {
53228
+ description: string;
53093
53229
  items: {
53094
53230
  format: string;
53095
53231
  type: string;
@@ -53097,6 +53233,7 @@ declare const _default: {
53097
53233
  type: string;
53098
53234
  };
53099
53235
  geolocation: {
53236
+ description: string;
53100
53237
  properties: {
53101
53238
  latitude: {
53102
53239
  format: string;
@@ -53111,9 +53248,11 @@ declare const _default: {
53111
53248
  type: string;
53112
53249
  };
53113
53250
  name: {
53251
+ description: string;
53114
53252
  type: string;
53115
53253
  };
53116
53254
  time_zone: {
53255
+ description: string;
53117
53256
  type: string;
53118
53257
  };
53119
53258
  };
@@ -53228,6 +53367,7 @@ declare const _default: {
53228
53367
  schema: {
53229
53368
  properties: {
53230
53369
  location_id: {
53370
+ description: string;
53231
53371
  format: string;
53232
53372
  type: string;
53233
53373
  };
@@ -53294,6 +53434,7 @@ declare const _default: {
53294
53434
  schema: {
53295
53435
  properties: {
53296
53436
  location_id: {
53437
+ description: string;
53297
53438
  format: string;
53298
53439
  type: string;
53299
53440
  };
@@ -53609,6 +53750,7 @@ declare const _default: {
53609
53750
  schema: {
53610
53751
  properties: {
53611
53752
  acs_entrance_ids: {
53753
+ description: string;
53612
53754
  items: {
53613
53755
  format: string;
53614
53756
  type: string;
@@ -53616,6 +53758,7 @@ declare const _default: {
53616
53758
  type: string;
53617
53759
  };
53618
53760
  location_id: {
53761
+ description: string;
53619
53762
  format: string;
53620
53763
  type: string;
53621
53764
  };
@@ -53682,6 +53825,7 @@ declare const _default: {
53682
53825
  schema: {
53683
53826
  properties: {
53684
53827
  device_ids: {
53828
+ description: string;
53685
53829
  items: {
53686
53830
  format: string;
53687
53831
  type: string;
@@ -53689,6 +53833,7 @@ declare const _default: {
53689
53833
  type: string;
53690
53834
  };
53691
53835
  location_id: {
53836
+ description: string;
53692
53837
  format: string;
53693
53838
  type: string;
53694
53839
  };
@@ -53755,6 +53900,7 @@ declare const _default: {
53755
53900
  schema: {
53756
53901
  properties: {
53757
53902
  geolocation: {
53903
+ description: string;
53758
53904
  properties: {
53759
53905
  latitude: {
53760
53906
  format: string;
@@ -53769,13 +53915,16 @@ declare const _default: {
53769
53915
  type: string;
53770
53916
  };
53771
53917
  location_id: {
53918
+ description: string;
53772
53919
  format: string;
53773
53920
  type: string;
53774
53921
  };
53775
53922
  name: {
53923
+ description: string;
53776
53924
  type: string;
53777
53925
  };
53778
53926
  time_zone: {
53927
+ description: string;
53779
53928
  type: string;
53780
53929
  };
53781
53930
  };
@@ -53886,6 +54035,7 @@ declare const _default: {
53886
54035
  schema: {
53887
54036
  properties: {
53888
54037
  geolocation: {
54038
+ description: string;
53889
54039
  properties: {
53890
54040
  latitude: {
53891
54041
  format: string;
@@ -53900,13 +54050,16 @@ declare const _default: {
53900
54050
  type: string;
53901
54051
  };
53902
54052
  location_id: {
54053
+ description: string;
53903
54054
  format: string;
53904
54055
  type: string;
53905
54056
  };
53906
54057
  name: {
54058
+ description: string;
53907
54059
  type: string;
53908
54060
  };
53909
54061
  time_zone: {
54062
+ description: string;
53910
54063
  type: string;
53911
54064
  };
53912
54065
  };
@@ -54021,6 +54174,7 @@ declare const _default: {
54021
54174
  schema: {
54022
54175
  properties: {
54023
54176
  customer_key: {
54177
+ description: string;
54024
54178
  type: string;
54025
54179
  };
54026
54180
  };
@@ -54088,59 +54242,46 @@ declare const _default: {
54088
54242
  content: {
54089
54243
  'application/json': {
54090
54244
  schema: {
54091
- oneOf: ({
54092
- properties: {
54093
- building_block_type: {
54094
- enum: string[];
54095
- type: string;
54096
- };
54097
- customer_key: {
54098
- type: string;
54099
- };
54100
- partner_resources?: never;
54245
+ properties: {
54246
+ building_block_type: {
54247
+ description: string;
54248
+ enum: string[];
54249
+ type: string;
54101
54250
  };
54102
- required: string[];
54103
- type: string;
54104
- } | {
54105
- properties: {
54106
- building_block_type: {
54107
- enum: string[];
54108
- type: string;
54109
- };
54110
- customer_key: {
54111
- type: string;
54112
- };
54113
- partner_resources: {
54114
- description: string;
54115
- items: {
54116
- properties: {
54117
- custom_metadata: {
54118
- additionalProperties: {
54119
- type: string;
54120
- };
54121
- type: string;
54122
- };
54123
- description: {
54124
- type: string;
54125
- };
54126
- name: {
54127
- type: string;
54128
- };
54129
- partner_resource_key: {
54251
+ customer_key: {
54252
+ description: string;
54253
+ type: string;
54254
+ };
54255
+ spaces: {
54256
+ description: string;
54257
+ items: {
54258
+ properties: {
54259
+ custom_metadata: {
54260
+ additionalProperties: {
54130
54261
  type: string;
54131
54262
  };
54263
+ type: string;
54264
+ };
54265
+ description: {
54266
+ type: string;
54267
+ };
54268
+ name: {
54269
+ type: string;
54270
+ };
54271
+ space_key: {
54272
+ type: string;
54132
54273
  };
54133
- required: string[];
54134
- type: string;
54135
- 'x-route-path': string;
54136
- 'x-undocumented': string;
54137
54274
  };
54275
+ required: string[];
54138
54276
  type: string;
54277
+ 'x-route-path': string;
54278
+ 'x-undocumented': string;
54139
54279
  };
54280
+ type: string;
54140
54281
  };
54141
- required: string[];
54142
- type: string;
54143
- })[];
54282
+ };
54283
+ required: string[];
54284
+ type: string;
54144
54285
  };
54145
54286
  };
54146
54287
  };
@@ -54205,6 +54346,7 @@ declare const _default: {
54205
54346
  schema: {
54206
54347
  properties: {
54207
54348
  customer_key: {
54349
+ description: string;
54208
54350
  type: string;
54209
54351
  };
54210
54352
  };
@@ -54274,9 +54416,11 @@ declare const _default: {
54274
54416
  schema: {
54275
54417
  properties: {
54276
54418
  customer_key: {
54419
+ description: string;
54277
54420
  type: string;
54278
54421
  };
54279
- partner_resources: {
54422
+ spaces: {
54423
+ description: string;
54280
54424
  items: {
54281
54425
  properties: {
54282
54426
  custom_metadata: {
@@ -54291,7 +54435,7 @@ declare const _default: {
54291
54435
  name: {
54292
54436
  type: string;
54293
54437
  };
54294
- partner_resource_key: {
54438
+ space_key: {
54295
54439
  type: string;
54296
54440
  };
54297
54441
  };
@@ -54377,6 +54521,7 @@ declare const _default: {
54377
54521
  type: string;
54378
54522
  };
54379
54523
  customer_key: {
54524
+ description: string;
54380
54525
  type: string;
54381
54526
  };
54382
54527
  description: {
@@ -54398,9 +54543,11 @@ declare const _default: {
54398
54543
  type: string;
54399
54544
  };
54400
54545
  partner_resource_key: {
54546
+ description: string;
54401
54547
  type: string;
54402
54548
  };
54403
54549
  partner_resource_type: {
54550
+ description: string;
54404
54551
  type: string;
54405
54552
  };
54406
54553
  phone_number: {
@@ -54430,6 +54577,7 @@ declare const _default: {
54430
54577
  type: string;
54431
54578
  };
54432
54579
  customer_key: {
54580
+ description: string;
54433
54581
  type: string;
54434
54582
  };
54435
54583
  description: {
@@ -54451,9 +54599,11 @@ declare const _default: {
54451
54599
  type: string;
54452
54600
  };
54453
54601
  partner_resource_key: {
54602
+ description: string;
54454
54603
  type: string;
54455
54604
  };
54456
54605
  partner_resource_type: {
54606
+ description: string;
54457
54607
  type: string;
54458
54608
  };
54459
54609
  phone_number: {
@@ -55469,6 +55619,7 @@ declare const _default: {
55469
55619
  schema: {
55470
55620
  properties: {
55471
55621
  credential_manager_acs_system_id: {
55622
+ description: string;
55472
55623
  format: string;
55473
55624
  type: string;
55474
55625
  };
@@ -55917,6 +56068,7 @@ declare const _default: {
55917
56068
  };
55918
56069
  '/user_identities/update': {
55919
56070
  patch: {
56071
+ description: string;
55920
56072
  operationId: string;
55921
56073
  requestBody: {
55922
56074
  content: {
@@ -55930,6 +56082,7 @@ declare const _default: {
55930
56082
  type: string;
55931
56083
  };
55932
56084
  full_name: {
56085
+ description: string;
55933
56086
  minLength: number;
55934
56087
  nullable: boolean;
55935
56088
  type: string;
@@ -56001,6 +56154,7 @@ declare const _default: {
56001
56154
  'x-title': string;
56002
56155
  };
56003
56156
  post: {
56157
+ description: string;
56004
56158
  operationId: string;
56005
56159
  requestBody: {
56006
56160
  content: {
@@ -56014,6 +56168,7 @@ declare const _default: {
56014
56168
  type: string;
56015
56169
  };
56016
56170
  full_name: {
56171
+ description: string;
56017
56172
  minLength: number;
56018
56173
  nullable: boolean;
56019
56174
  type: string;
@@ -56088,6 +56243,7 @@ declare const _default: {
56088
56243
  };
56089
56244
  '/webhooks/create': {
56090
56245
  post: {
56246
+ description: string;
56091
56247
  operationId: string;
56092
56248
  requestBody: {
56093
56249
  content: {
@@ -56096,12 +56252,14 @@ declare const _default: {
56096
56252
  properties: {
56097
56253
  event_types: {
56098
56254
  default: string[];
56255
+ description: string;
56099
56256
  items: {
56100
56257
  type: string;
56101
56258
  };
56102
56259
  type: string;
56103
56260
  };
56104
56261
  url: {
56262
+ description: string;
56105
56263
  format: string;
56106
56264
  type: string;
56107
56265
  };
@@ -56158,10 +56316,12 @@ declare const _default: {
56158
56316
  'x-fern-sdk-method-name': string;
56159
56317
  'x-fern-sdk-return-value': string;
56160
56318
  'x-response-key': string;
56319
+ 'x-title': string;
56161
56320
  };
56162
56321
  };
56163
56322
  '/webhooks/delete': {
56164
56323
  post: {
56324
+ description: string;
56165
56325
  operationId: string;
56166
56326
  requestBody: {
56167
56327
  content: {
@@ -56169,6 +56329,7 @@ declare const _default: {
56169
56329
  schema: {
56170
56330
  properties: {
56171
56331
  webhook_id: {
56332
+ description: string;
56172
56333
  type: string;
56173
56334
  };
56174
56335
  };
@@ -56220,10 +56381,12 @@ declare const _default: {
56220
56381
  'x-fern-sdk-group-name': string[];
56221
56382
  'x-fern-sdk-method-name': string;
56222
56383
  'x-response-key': null;
56384
+ 'x-title': string;
56223
56385
  };
56224
56386
  };
56225
56387
  '/webhooks/get': {
56226
56388
  post: {
56389
+ description: string;
56227
56390
  operationId: string;
56228
56391
  requestBody: {
56229
56392
  content: {
@@ -56231,6 +56394,7 @@ declare const _default: {
56231
56394
  schema: {
56232
56395
  properties: {
56233
56396
  webhook_id: {
56397
+ description: string;
56234
56398
  type: string;
56235
56399
  };
56236
56400
  };
@@ -56286,10 +56450,12 @@ declare const _default: {
56286
56450
  'x-fern-sdk-method-name': string;
56287
56451
  'x-fern-sdk-return-value': string;
56288
56452
  'x-response-key': string;
56453
+ 'x-title': string;
56289
56454
  };
56290
56455
  };
56291
56456
  '/webhooks/list': {
56292
56457
  get: {
56458
+ description: string;
56293
56459
  operationId: string;
56294
56460
  responses: {
56295
56461
  200: {
@@ -56338,8 +56504,10 @@ declare const _default: {
56338
56504
  tags: string[];
56339
56505
  'x-fern-ignore': boolean;
56340
56506
  'x-response-key': string;
56507
+ 'x-title': string;
56341
56508
  };
56342
56509
  post: {
56510
+ description: string;
56343
56511
  operationId: string;
56344
56512
  responses: {
56345
56513
  200: {
@@ -56390,10 +56558,12 @@ declare const _default: {
56390
56558
  'x-fern-sdk-method-name': string;
56391
56559
  'x-fern-sdk-return-value': string;
56392
56560
  'x-response-key': string;
56561
+ 'x-title': string;
56393
56562
  };
56394
56563
  };
56395
56564
  '/webhooks/update': {
56396
56565
  post: {
56566
+ description: string;
56397
56567
  operationId: string;
56398
56568
  requestBody: {
56399
56569
  content: {
@@ -56401,12 +56571,14 @@ declare const _default: {
56401
56571
  schema: {
56402
56572
  properties: {
56403
56573
  event_types: {
56574
+ description: string;
56404
56575
  items: {
56405
56576
  type: string;
56406
56577
  };
56407
56578
  type: string;
56408
56579
  };
56409
56580
  webhook_id: {
56581
+ description: string;
56410
56582
  type: string;
56411
56583
  };
56412
56584
  };
@@ -56458,8 +56630,10 @@ declare const _default: {
56458
56630
  'x-fern-sdk-group-name': string[];
56459
56631
  'x-fern-sdk-method-name': string;
56460
56632
  'x-response-key': null;
56633
+ 'x-title': string;
56461
56634
  };
56462
56635
  put: {
56636
+ description: string;
56463
56637
  operationId: string;
56464
56638
  requestBody: {
56465
56639
  content: {
@@ -56467,12 +56641,14 @@ declare const _default: {
56467
56641
  schema: {
56468
56642
  properties: {
56469
56643
  event_types: {
56644
+ description: string;
56470
56645
  items: {
56471
56646
  type: string;
56472
56647
  };
56473
56648
  type: string;
56474
56649
  };
56475
56650
  webhook_id: {
56651
+ description: string;
56476
56652
  type: string;
56477
56653
  };
56478
56654
  };
@@ -56523,10 +56699,12 @@ declare const _default: {
56523
56699
  tags: string[];
56524
56700
  'x-fern-ignore': boolean;
56525
56701
  'x-response-key': null;
56702
+ 'x-title': string;
56526
56703
  };
56527
56704
  };
56528
56705
  '/workspaces/create': {
56529
56706
  post: {
56707
+ description: string;
56530
56708
  operationId: string;
56531
56709
  requestBody: {
56532
56710
  content: {
@@ -56534,30 +56712,37 @@ declare const _default: {
56534
56712
  schema: {
56535
56713
  properties: {
56536
56714
  company_name: {
56715
+ description: string;
56537
56716
  type: string;
56538
56717
  };
56539
56718
  connect_partner_name: {
56540
56719
  deprecated: boolean;
56720
+ description: string;
56541
56721
  nullable: boolean;
56542
56722
  type: string;
56543
56723
  'x-deprecated': string;
56544
56724
  };
56545
56725
  connect_webview_customization: {
56726
+ description: string;
56546
56727
  properties: {
56547
56728
  logo_shape: {
56729
+ description: string;
56548
56730
  enum: string[];
56549
56731
  nullable: boolean;
56550
56732
  type: string;
56551
56733
  };
56552
56734
  primary_button_color: {
56735
+ description: string;
56553
56736
  nullable: boolean;
56554
56737
  type: string;
56555
56738
  };
56556
56739
  primary_button_text_color: {
56740
+ description: string;
56557
56741
  nullable: boolean;
56558
56742
  type: string;
56559
56743
  };
56560
56744
  success_message: {
56745
+ description: string;
56561
56746
  nullable: boolean;
56562
56747
  type: string;
56563
56748
  };
@@ -56566,9 +56751,11 @@ declare const _default: {
56566
56751
  };
56567
56752
  is_sandbox: {
56568
56753
  default: boolean;
56754
+ description: string;
56569
56755
  type: string;
56570
56756
  };
56571
56757
  name: {
56758
+ description: string;
56572
56759
  type: string;
56573
56760
  };
56574
56761
  webview_logo_shape: {
@@ -56645,10 +56832,12 @@ declare const _default: {
56645
56832
  'x-fern-sdk-method-name': string;
56646
56833
  'x-fern-sdk-return-value': string;
56647
56834
  'x-response-key': string;
56835
+ 'x-title': string;
56648
56836
  };
56649
56837
  };
56650
56838
  '/workspaces/get': {
56651
56839
  get: {
56840
+ description: string;
56652
56841
  operationId: string;
56653
56842
  responses: {
56654
56843
  200: {
@@ -56681,29 +56870,41 @@ declare const _default: {
56681
56870
  api_key: never[];
56682
56871
  console_session_with_workspace?: never;
56683
56872
  client_session?: never;
56873
+ client_session_with_customer?: never;
56684
56874
  pat_with_workspace?: never;
56685
56875
  } | {
56686
56876
  console_session_with_workspace: never[];
56687
56877
  api_key?: never;
56688
56878
  client_session?: never;
56879
+ client_session_with_customer?: never;
56689
56880
  pat_with_workspace?: never;
56690
56881
  } | {
56691
56882
  client_session: never[];
56692
56883
  api_key?: never;
56693
56884
  console_session_with_workspace?: never;
56885
+ client_session_with_customer?: never;
56886
+ pat_with_workspace?: never;
56887
+ } | {
56888
+ client_session_with_customer: never[];
56889
+ api_key?: never;
56890
+ console_session_with_workspace?: never;
56891
+ client_session?: never;
56694
56892
  pat_with_workspace?: never;
56695
56893
  } | {
56696
56894
  pat_with_workspace: never[];
56697
56895
  api_key?: never;
56698
56896
  console_session_with_workspace?: never;
56699
56897
  client_session?: never;
56898
+ client_session_with_customer?: never;
56700
56899
  })[];
56701
56900
  summary: string;
56702
56901
  tags: string[];
56703
56902
  'x-fern-ignore': boolean;
56704
56903
  'x-response-key': string;
56904
+ 'x-title': string;
56705
56905
  };
56706
56906
  post: {
56907
+ description: string;
56707
56908
  operationId: string;
56708
56909
  responses: {
56709
56910
  200: {
@@ -56736,22 +56937,32 @@ declare const _default: {
56736
56937
  api_key: never[];
56737
56938
  console_session_with_workspace?: never;
56738
56939
  client_session?: never;
56940
+ client_session_with_customer?: never;
56739
56941
  pat_with_workspace?: never;
56740
56942
  } | {
56741
56943
  console_session_with_workspace: never[];
56742
56944
  api_key?: never;
56743
56945
  client_session?: never;
56946
+ client_session_with_customer?: never;
56744
56947
  pat_with_workspace?: never;
56745
56948
  } | {
56746
56949
  client_session: never[];
56747
56950
  api_key?: never;
56748
56951
  console_session_with_workspace?: never;
56952
+ client_session_with_customer?: never;
56953
+ pat_with_workspace?: never;
56954
+ } | {
56955
+ client_session_with_customer: never[];
56956
+ api_key?: never;
56957
+ console_session_with_workspace?: never;
56958
+ client_session?: never;
56749
56959
  pat_with_workspace?: never;
56750
56960
  } | {
56751
56961
  pat_with_workspace: never[];
56752
56962
  api_key?: never;
56753
56963
  console_session_with_workspace?: never;
56754
56964
  client_session?: never;
56965
+ client_session_with_customer?: never;
56755
56966
  })[];
56756
56967
  summary: string;
56757
56968
  tags: string[];
@@ -56759,10 +56970,12 @@ declare const _default: {
56759
56970
  'x-fern-sdk-method-name': string;
56760
56971
  'x-fern-sdk-return-value': string;
56761
56972
  'x-response-key': string;
56973
+ 'x-title': string;
56762
56974
  };
56763
56975
  };
56764
56976
  '/workspaces/list': {
56765
56977
  get: {
56978
+ description: string;
56766
56979
  operationId: string;
56767
56980
  responses: {
56768
56981
  200: {
@@ -56841,8 +57054,10 @@ declare const _default: {
56841
57054
  tags: string[];
56842
57055
  'x-fern-ignore': boolean;
56843
57056
  'x-response-key': string;
57057
+ 'x-title': string;
56844
57058
  };
56845
57059
  post: {
57060
+ description: string;
56846
57061
  operationId: string;
56847
57062
  responses: {
56848
57063
  200: {
@@ -56923,6 +57138,7 @@ declare const _default: {
56923
57138
  'x-fern-sdk-method-name': string;
56924
57139
  'x-fern-sdk-return-value': string;
56925
57140
  'x-response-key': string;
57141
+ 'x-title': string;
56926
57142
  };
56927
57143
  };
56928
57144
  '/workspaces/reset_sandbox': {
@@ -56976,10 +57192,12 @@ declare const _default: {
56976
57192
  'x-fern-sdk-method-name': string;
56977
57193
  'x-fern-sdk-return-value': string;
56978
57194
  'x-response-key': string;
57195
+ 'x-title': string;
56979
57196
  };
56980
57197
  };
56981
57198
  '/workspaces/update': {
56982
57199
  patch: {
57200
+ description: string;
56983
57201
  operationId: string;
56984
57202
  requestBody: {
56985
57203
  content: {
@@ -56987,24 +57205,30 @@ declare const _default: {
56987
57205
  schema: {
56988
57206
  properties: {
56989
57207
  connect_partner_name: {
57208
+ description: string;
56990
57209
  type: string;
56991
57210
  };
56992
57211
  connect_webview_customization: {
57212
+ description: string;
56993
57213
  properties: {
56994
57214
  logo_shape: {
57215
+ description: string;
56995
57216
  enum: string[];
56996
57217
  nullable: boolean;
56997
57218
  type: string;
56998
57219
  };
56999
57220
  primary_button_color: {
57221
+ description: string;
57000
57222
  nullable: boolean;
57001
57223
  type: string;
57002
57224
  };
57003
57225
  primary_button_text_color: {
57226
+ description: string;
57004
57227
  nullable: boolean;
57005
57228
  type: string;
57006
57229
  };
57007
57230
  success_message: {
57231
+ description: string;
57008
57232
  nullable: boolean;
57009
57233
  type: string;
57010
57234
  };
@@ -57012,9 +57236,11 @@ declare const _default: {
57012
57236
  type: string;
57013
57237
  };
57014
57238
  is_suspended: {
57239
+ description: string;
57015
57240
  type: string;
57016
57241
  };
57017
57242
  name: {
57243
+ description: string;
57018
57244
  type: string;
57019
57245
  };
57020
57246
  };
@@ -57051,8 +57277,10 @@ declare const _default: {
57051
57277
  tags: string[];
57052
57278
  'x-fern-ignore': boolean;
57053
57279
  'x-response-key': null;
57280
+ 'x-title': string;
57054
57281
  };
57055
57282
  post: {
57283
+ description: string;
57056
57284
  operationId: string;
57057
57285
  requestBody: {
57058
57286
  content: {
@@ -57060,24 +57288,30 @@ declare const _default: {
57060
57288
  schema: {
57061
57289
  properties: {
57062
57290
  connect_partner_name: {
57291
+ description: string;
57063
57292
  type: string;
57064
57293
  };
57065
57294
  connect_webview_customization: {
57295
+ description: string;
57066
57296
  properties: {
57067
57297
  logo_shape: {
57298
+ description: string;
57068
57299
  enum: string[];
57069
57300
  nullable: boolean;
57070
57301
  type: string;
57071
57302
  };
57072
57303
  primary_button_color: {
57304
+ description: string;
57073
57305
  nullable: boolean;
57074
57306
  type: string;
57075
57307
  };
57076
57308
  primary_button_text_color: {
57309
+ description: string;
57077
57310
  nullable: boolean;
57078
57311
  type: string;
57079
57312
  };
57080
57313
  success_message: {
57314
+ description: string;
57081
57315
  nullable: boolean;
57082
57316
  type: string;
57083
57317
  };
@@ -57085,9 +57319,11 @@ declare const _default: {
57085
57319
  type: string;
57086
57320
  };
57087
57321
  is_suspended: {
57322
+ description: string;
57088
57323
  type: string;
57089
57324
  };
57090
57325
  name: {
57326
+ description: string;
57091
57327
  type: string;
57092
57328
  };
57093
57329
  };
@@ -57125,6 +57361,7 @@ declare const _default: {
57125
57361
  'x-fern-sdk-group-name': string[];
57126
57362
  'x-fern-sdk-method-name': string;
57127
57363
  'x-response-key': null;
57364
+ 'x-title': string;
57128
57365
  };
57129
57366
  };
57130
57367
  };
@@ -98220,7 +98457,7 @@ interface Routes {
98220
98457
  method: 'DELETE' | 'POST';
98221
98458
  queryParams: {};
98222
98459
  jsonBody: {
98223
- /** Device ID of the desired phone. */
98460
+ /** Device ID of the phone that you want to deactivate. */
98224
98461
  device_id: string;
98225
98462
  };
98226
98463
  commonParams: {};
@@ -98233,7 +98470,7 @@ interface Routes {
98233
98470
  queryParams: {};
98234
98471
  jsonBody: {};
98235
98472
  commonParams: {
98236
- /** Device ID of the desired phone. */
98473
+ /** Device ID of the phone that you want to get. */
98237
98474
  device_id: string;
98238
98475
  };
98239
98476
  formData: {};
@@ -98302,9 +98539,9 @@ interface Routes {
98302
98539
  queryParams: {};
98303
98540
  jsonBody: {};
98304
98541
  commonParams: {
98305
- /** ID of the user identity that represents the owner by which to filter the list of returned phones. */
98542
+ /** ID of the user identity that represents the owner by which you want to filter the list of returned phones. */
98306
98543
  owner_user_identity_id?: string | undefined;
98307
- /** ID of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) by which to filter the list of returned phones. */
98544
+ /** ID of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) by which you want to filter the list of returned phones. */
98308
98545
  acs_credential_id?: string | undefined;
98309
98546
  };
98310
98547
  formData: {};
@@ -98371,11 +98608,11 @@ interface Routes {
98371
98608
  method: 'GET' | 'POST';
98372
98609
  queryParams: {};
98373
98610
  jsonBody: {
98374
- /** ID of the custom SDK installation to use for the simulated phone. */
98611
+ /** ID of the custom SDK installation that you want to use for the simulated phone. */
98375
98612
  custom_sdk_installation_id?: string | undefined;
98376
- /** ID of the user identity to associate with the simulated phone. */
98613
+ /** ID of the user identity that you want to associate with the simulated phone. */
98377
98614
  user_identity_id: string;
98378
- /** Metadata to associate with the simulated phone. */
98615
+ /** Metadata that you want to associate with the simulated phone. */
98379
98616
  phone_metadata?: {
98380
98617
  /** Mobile operating system that you want to use for the simulated phone. */
98381
98618
  operating_system?: 'android' | 'ios';
@@ -98386,7 +98623,7 @@ interface Routes {
98386
98623
  /** Device model that you want to use for the simulated phone. */
98387
98624
  device_model?: string;
98388
98625
  };
98389
- /** ASSA ABLOY metadata to associate with the simulated phone. */
98626
+ /** ASSA ABLOY metadata that you want to associate with the simulated phone. */
98390
98627
  assa_abloy_metadata?: {
98391
98628
  /** Indicates whether the simulated phone should have Bluetooth low energy (BLE) capability. */
98392
98629
  ble_capability?: boolean;
@@ -98468,8 +98705,11 @@ interface Routes {
98468
98705
  method: 'POST';
98469
98706
  queryParams: {};
98470
98707
  jsonBody: {
98708
+ /** Name of the Seam Bridge client that you want to create. */
98471
98709
  bridge_client_name: string;
98710
+ /** Time zone for the Seam Bridge that you want to create. */
98472
98711
  bridge_client_time_zone: string;
98712
+ /** Identifier key of the client machine for the Seam Bridge client that you want to create. */
98473
98713
  bridge_client_machine_identifier_key: string;
98474
98714
  };
98475
98715
  commonParams: {};
@@ -98660,7 +98900,9 @@ interface Routes {
98660
98900
  method: 'POST';
98661
98901
  queryParams: {};
98662
98902
  jsonBody: {
98903
+ /** Indicates whether Tailscale is connected. */
98663
98904
  is_tailscale_connected: boolean | null;
98905
+ /** Tailscale IPv4 address. */
98664
98906
  tailscale_ip_v4: string | null;
98665
98907
  };
98666
98908
  commonParams: {};
@@ -98692,7 +98934,7 @@ interface Routes {
98692
98934
  method: 'POST';
98693
98935
  queryParams: {};
98694
98936
  jsonBody: {
98695
- /** The short code to exchange for a client session token */
98937
+ /** Short code that you want to exchange for a client session token. */
98696
98938
  short_code: string;
98697
98939
  };
98698
98940
  commonParams: {};
@@ -98850,8 +99092,11 @@ interface Routes {
98850
99092
  method: 'POST';
98851
99093
  queryParams: {};
98852
99094
  jsonBody: {
99095
+ /** ID of the custom SDK installation that you want to use for the new session. */
98853
99096
  custom_sdk_installation_id: string;
99097
+ /** Phone operating system that you want to use for the new session. */
98854
99098
  phone_os: 'ios' | 'android';
99099
+ /** Phone device metadata that you want to use for the new session. */
98855
99100
  phone_device_metadata?: {
98856
99101
  os_version?: string | undefined;
98857
99102
  manufacturer?: string | undefined;
@@ -99056,6 +99301,7 @@ interface Routes {
99056
99301
  queryParams: {};
99057
99302
  jsonBody: {};
99058
99303
  commonParams: {
99304
+ /** Collection key. */
99059
99305
  collection_key: string;
99060
99306
  };
99061
99307
  formData: {};
@@ -99082,7 +99328,7 @@ interface Routes {
99082
99328
  queryParams: {};
99083
99329
  jsonBody: {};
99084
99330
  commonParams: {
99085
- /** Filter by resource type alias. */
99331
+ /** Resource type alias by which you want to filter partner resources. */
99086
99332
  resource_type_alias?: string | undefined;
99087
99333
  };
99088
99334
  formData: {};
@@ -99108,7 +99354,9 @@ interface Routes {
99108
99354
  method: 'POST' | 'PUT';
99109
99355
  queryParams: {};
99110
99356
  jsonBody: {
99357
+ /** ID of the space to which you want to add entrances. */
99111
99358
  space_id: string;
99359
+ /** IDs of the entrances that you want to add to the space. */
99112
99360
  acs_entrance_ids: string[];
99113
99361
  };
99114
99362
  commonParams: {};
@@ -99120,7 +99368,9 @@ interface Routes {
99120
99368
  method: 'POST' | 'PUT';
99121
99369
  queryParams: {};
99122
99370
  jsonBody: {
99371
+ /** ID of the space to which you want to add devices. */
99123
99372
  space_id: string;
99373
+ /** IDs of the devices that you want to add to the space. */
99124
99374
  device_ids: string[];
99125
99375
  };
99126
99376
  commonParams: {};
@@ -99132,8 +99382,11 @@ interface Routes {
99132
99382
  method: 'POST';
99133
99383
  queryParams: {};
99134
99384
  jsonBody: {
99385
+ /** Name of the space that you want to create. */
99135
99386
  name: string;
99387
+ /** IDs of the devices that you want to add to the new space. */
99136
99388
  device_ids?: string[] | undefined;
99389
+ /** IDs of the entrances that you want to add to the new space. */
99137
99390
  acs_entrance_ids?: string[] | undefined;
99138
99391
  };
99139
99392
  commonParams: {};
@@ -99159,6 +99412,7 @@ interface Routes {
99159
99412
  method: 'DELETE' | 'POST';
99160
99413
  queryParams: {};
99161
99414
  jsonBody: {
99415
+ /** ID of the space that you want to delete. */
99162
99416
  space_id: string;
99163
99417
  };
99164
99418
  commonParams: {};
@@ -99171,6 +99425,7 @@ interface Routes {
99171
99425
  queryParams: {};
99172
99426
  jsonBody: {};
99173
99427
  commonParams: {
99428
+ /** ID of the space that you want to get. */
99174
99429
  space_id: string;
99175
99430
  };
99176
99431
  formData: {};
@@ -99218,7 +99473,9 @@ interface Routes {
99218
99473
  queryParams: {};
99219
99474
  jsonBody: {};
99220
99475
  commonParams: {
99476
+ /** ID of the space from which you want to remove entrances. */
99221
99477
  space_id: string;
99478
+ /** IDs of the entrances that you want to remove from the space. */
99222
99479
  acs_entrance_ids: string[];
99223
99480
  };
99224
99481
  formData: {};
@@ -99230,7 +99487,9 @@ interface Routes {
99230
99487
  queryParams: {};
99231
99488
  jsonBody: {};
99232
99489
  commonParams: {
99490
+ /** ID of the space from which you want to remove devices. */
99233
99491
  space_id: string;
99492
+ /** IDs of the devices that you want to remove from the space. */
99234
99493
  device_ids: string[];
99235
99494
  };
99236
99495
  formData: {};
@@ -99241,7 +99500,9 @@ interface Routes {
99241
99500
  method: 'POST' | 'PATCH';
99242
99501
  queryParams: {};
99243
99502
  jsonBody: {
99503
+ /** ID of the space that you want to update. */
99244
99504
  space_id: string;
99505
+ /** Name of the space. */
99245
99506
  name?: string | undefined;
99246
99507
  };
99247
99508
  commonParams: {};
@@ -100387,9 +100648,9 @@ interface Routes {
100387
100648
  jsonBody: {
100388
100649
  /** ID of the thermostat device that you want to set to cool mode. */
100389
100650
  device_id: string;
100390
- /** Desired [cooling set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °C. You must set one of the `cooling_set_point` parameters. */
100651
+ /** [Cooling set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °C that you want to set for the thermostat. You must set one of the `cooling_set_point` parameters. */
100391
100652
  cooling_set_point_celsius?: number | undefined;
100392
- /** Desired [cooling set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °F. You must set one of the `cooling_set_point` parameters. */
100653
+ /** [Cooling set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °F that you want to set for the thermostat. You must set one of the `cooling_set_point` parameters. */
100393
100654
  cooling_set_point_fahrenheit?: number | undefined;
100394
100655
  /** */
100395
100656
  sync?: boolean;
@@ -101540,7 +101801,7 @@ interface Routes {
101540
101801
  jsonBody: {
101541
101802
  /** ID of the thermostat device for which you want to create a daily program. */
101542
101803
  device_id: string;
101543
- /** User-friendly name to identify the thermostat daily program. */
101804
+ /** Name of the thermostat daily program. */
101544
101805
  name: string;
101545
101806
  /** Array of thermostat daily program periods. */
101546
101807
  periods: Array<{
@@ -101594,7 +101855,7 @@ interface Routes {
101594
101855
  jsonBody: {
101595
101856
  /** ID of the thermostat daily program that you want to update. */
101596
101857
  thermostat_daily_program_id: string;
101597
- /** User-friendly name to identify the thermostat daily program that you want to update. */
101858
+ /** Name of the thermostat daily program that you want to update. */
101598
101859
  name: string;
101599
101860
  /** Array of thermostat daily program periods. The periods that you specify overwrite any existing periods for the daily program. */
101600
101861
  periods: Array<{
@@ -102732,9 +102993,9 @@ interface Routes {
102732
102993
  queryParams: {};
102733
102994
  jsonBody: {};
102734
102995
  commonParams: {
102735
- /** ID of the thermostat device that you want to retrieve. */
102996
+ /** ID of the thermostat device that you want to get. */
102736
102997
  device_id?: string | undefined;
102737
- /** User-friendly name of the thermostat device that you want to retrieve. */
102998
+ /** Name of the thermostat device that you want to retrieve. */
102738
102999
  name?: string | undefined;
102739
103000
  };
102740
103001
  formData: {};
@@ -103952,9 +104213,9 @@ interface Routes {
103952
104213
  jsonBody: {
103953
104214
  /** ID of the thermostat device that you want to set to heat mode. */
103954
104215
  device_id: string;
103955
- /** Desired [heating set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °C. You must set one of the `heating_set_point` parameters. */
104216
+ /** [Heating set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °C that you want to set for the thermostat. You must set one of the `heating_set_point` parameters. */
103956
104217
  heating_set_point_celsius?: number | undefined;
103957
- /** Desired [heating set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °F. You must set one of the `heating_set_point` parameters. */
104218
+ /** [Heating set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °F that you want to set for the thermostat. You must set one of the `heating_set_point` parameters. */
103958
104219
  heating_set_point_fahrenheit?: number | undefined;
103959
104220
  /** */
103960
104221
  sync?: boolean;
@@ -105074,13 +105335,13 @@ interface Routes {
105074
105335
  jsonBody: {
105075
105336
  /** ID of the thermostat device that you want to set to heat-cool mode. */
105076
105337
  device_id: string;
105077
- /** Desired [heating set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °C. You must set one of the `heating_set_point` parameters. */
105338
+ /** [Heating set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °C that you want to set for the thermostat. You must set one of the `heating_set_point` parameters. */
105078
105339
  heating_set_point_celsius?: number | undefined;
105079
- /** Desired [heating set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °F. You must set one of the `heating_set_point` parameters. */
105340
+ /** [Heating set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °F that you want to set for the thermostat. You must set one of the `heating_set_point` parameters. */
105080
105341
  heating_set_point_fahrenheit?: number | undefined;
105081
- /** Desired [cooling set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °C. You must set one of the `cooling_set_point` parameters. */
105342
+ /** [Cooling set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °C that you want to set for the thermostat. You must set one of the `cooling_set_point` parameters. */
105082
105343
  cooling_set_point_celsius?: number | undefined;
105083
- /** Desired [cooling set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °F. You must set one of the `cooling_set_point` parameters. */
105344
+ /** [Cooling set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °F that you want to set for the thermostat. You must set one of the `cooling_set_point` parameters. */
105084
105345
  cooling_set_point_fahrenheit?: number | undefined;
105085
105346
  /** */
105086
105347
  sync?: boolean;
@@ -106206,11 +106467,11 @@ interface Routes {
106206
106467
  connected_account_ids?: string[] | undefined;
106207
106468
  /** ID of the Connect Webview for which you want to list devices. */
106208
106469
  connect_webview_id?: string | undefined;
106209
- /** Device type by which to filter thermostat devices. */
106470
+ /** Device type by which you want to filter thermostat devices. */
106210
106471
  device_type?: ('ecobee_thermostat' | 'nest_thermostat' | 'honeywell_resideo_thermostat' | 'tado_thermostat' | 'sensi_thermostat' | 'smartthings_thermostat') | undefined;
106211
- /** Array of device types by which to filter thermostat devices. */
106472
+ /** Array of device types by which you want to filter thermostat devices. */
106212
106473
  device_types?: Array<'ecobee_thermostat' | 'nest_thermostat' | 'honeywell_resideo_thermostat' | 'tado_thermostat' | 'sensi_thermostat' | 'smartthings_thermostat'> | undefined;
106213
- /** Manufacturer by which to filter thermostat devices. */
106474
+ /** Manufacturer by which you want to filter thermostat devices. */
106214
106475
  manufacturer?: ('ecobee' | 'honeywell_resideo' | 'nest' | 'tado' | 'sensi' | 'smartthings') | undefined;
106215
106476
  /** Array of device IDs for which you want to list devices. */
106216
106477
  device_ids?: string[] | undefined;
@@ -109767,19 +110028,19 @@ interface Routes {
109767
110028
  method: 'POST';
109768
110029
  queryParams: {};
109769
110030
  jsonBody: {
109770
- /** ID of the desired thermostat device. */
110031
+ /** ID of the thermostat device for which you want to create a schedule. */
109771
110032
  device_id: string;
109772
- /** User-friendly name to identify the thermostat schedule. */
110033
+ /** Name of the thermostat schedule. */
109773
110034
  name?: string | undefined;
109774
- /** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the thermostat schedule. */
110035
+ /** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the new thermostat schedule. */
109775
110036
  climate_preset_key: string;
109776
110037
  /** Number of minutes for which a person at the thermostat or using the API can change the thermostat's settings after the activation of the scheduled climate preset. See also [Specifying Manual Override Permissions](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions). */
109777
110038
  max_override_period_minutes?: (number | null) | undefined;
109778
- /** Date and time at which the thermostat schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
110039
+ /** Date and time at which the new thermostat schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
109779
110040
  starts_at: string;
109780
- /** Date and time at which the thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
110041
+ /** Date and time at which the new thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
109781
110042
  ends_at: string;
109782
- /** Indicates whether a person at the thermostat or using the API can change the thermostat's settings while the schedule is active. See also [Specifying Manual Override Permissions](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions). */
110043
+ /** Indicates whether a person at the thermostat or using the API can change the thermostat's settings while the new schedule is active. See also [Specifying Manual Override Permissions](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions). */
109783
110044
  is_override_allowed?: boolean | undefined;
109784
110045
  };
109785
110046
  commonParams: {};
@@ -109823,7 +110084,7 @@ interface Routes {
109823
110084
  queryParams: {};
109824
110085
  jsonBody: {};
109825
110086
  commonParams: {
109826
- /** ID of the desired thermostat schedule. */
110087
+ /** ID of the thermostat schedule that you want to delete. */
109827
110088
  thermostat_schedule_id: string;
109828
110089
  };
109829
110090
  formData: {};
@@ -109835,7 +110096,7 @@ interface Routes {
109835
110096
  queryParams: {};
109836
110097
  jsonBody: {};
109837
110098
  commonParams: {
109838
- /** ID of the desired thermostat schedule. */
110099
+ /** ID of the thermostat schedule that you want to get. */
109839
110100
  thermostat_schedule_id: string;
109840
110101
  };
109841
110102
  formData: {};
@@ -109878,7 +110139,7 @@ interface Routes {
109878
110139
  queryParams: {};
109879
110140
  jsonBody: {};
109880
110141
  commonParams: {
109881
- /** ID of the desired thermostat device. */
110142
+ /** ID of the thermostat device for which you want to list schedules. */
109882
110143
  device_id: string;
109883
110144
  /** User identifier key by which to filter the list of returned thermostat schedules. */
109884
110145
  user_identifier_key?: string | undefined;
@@ -109921,9 +110182,9 @@ interface Routes {
109921
110182
  method: 'PATCH' | 'POST';
109922
110183
  queryParams: {};
109923
110184
  jsonBody: {
109924
- /** ID of the desired thermostat schedule. */
110185
+ /** ID of the thermostat schedule that you want to update. */
109925
110186
  thermostat_schedule_id: string;
109926
- /** User-friendly name to identify the thermostat schedule. */
110187
+ /** Name of the thermostat schedule. */
109927
110188
  name?: string | undefined;
109928
110189
  /** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the thermostat schedule. */
109929
110190
  climate_preset_key?: string | undefined;
@@ -109964,7 +110225,7 @@ interface Routes {
109964
110225
  /**
109965
110226
  * @deprecated Use `fan_mode_setting` instead. */
109966
110227
  fan_mode?: ('auto' | 'on' | 'circulate') | undefined;
109967
- /** Desired [fan mode setting](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings) for the thermostat. */
110228
+ /** [Fan mode setting](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings) that you want to set for the thermostat. */
109968
110229
  fan_mode_setting?: ('auto' | 'on' | 'circulate') | undefined;
109969
110230
  /** */
109970
110231
  sync?: boolean;
@@ -111089,29 +111350,29 @@ interface Routes {
111089
111350
  hvac_mode_setting: 'cool';
111090
111351
  /** ID of the thermostat device for which you want to set the HVAC mode. */
111091
111352
  device_id: string;
111092
- /** Desired [cooling set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °C. You must set one of the `cooling_set_point` parameters. */
111353
+ /** [Cooling set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °C that you want to set for the thermostat. You must set one of the `cooling_set_point` parameters. */
111093
111354
  cooling_set_point_celsius?: number | undefined;
111094
- /** Desired [cooling set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °F. You must set one of the `cooling_set_point` parameters. */
111355
+ /** [Cooling set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °F that you want to set for the thermostat. You must set one of the `cooling_set_point` parameters. */
111095
111356
  cooling_set_point_fahrenheit?: number | undefined;
111096
111357
  } | {
111097
111358
  hvac_mode_setting: 'heat';
111098
111359
  /** ID of the thermostat device for which you want to set the HVAC mode. */
111099
111360
  device_id: string;
111100
- /** Desired [heating set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °C. You must set one of the `heating_set_point` parameters. */
111361
+ /** [Heating set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °C that you want to set for the thermostat. You must set one of the `heating_set_point` parameters. */
111101
111362
  heating_set_point_celsius?: number | undefined;
111102
- /** Desired [heating set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °F. You must set one of the `heating_set_point` parameters. */
111363
+ /** [Heating set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °F that you want to set for the thermostat. You must set one of the `heating_set_point` parameters. */
111103
111364
  heating_set_point_fahrenheit?: number | undefined;
111104
111365
  } | {
111105
111366
  hvac_mode_setting: 'heat_cool';
111106
111367
  /** ID of the thermostat device for which you want to set the HVAC mode. */
111107
111368
  device_id: string;
111108
- /** Desired [cooling set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °C. You must set one of the `cooling_set_point` parameters. */
111369
+ /** [Cooling set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °C that you want to set for the thermostat. You must set one of the `cooling_set_point` parameters. */
111109
111370
  cooling_set_point_celsius?: number | undefined;
111110
- /** Desired [cooling set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °F. You must set one of the `cooling_set_point` parameters. */
111371
+ /** [Cooling set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °F that you want to set for the thermostat. You must set one of the `cooling_set_point` parameters. */
111111
111372
  cooling_set_point_fahrenheit?: number | undefined;
111112
- /** Desired [heating set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °C. You must set one of the `heating_set_point` parameters. */
111373
+ /** [Heating set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °C that you want to set for the thermostat. You must set one of the `heating_set_point` parameters. */
111113
111374
  heating_set_point_celsius?: number | undefined;
111114
- /** Desired [heating set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °F. You must set one of the `heating_set_point` parameters. */
111375
+ /** [Heating set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °F that you want to set for the thermostat. You must set one of the `heating_set_point` parameters. */
111115
111376
  heating_set_point_fahrenheit?: number | undefined;
111116
111377
  };
111117
111378
  commonParams: {};
@@ -112247,40 +112508,40 @@ interface Routes {
112247
112508
  method: 'POST';
112248
112509
  queryParams: {};
112249
112510
  jsonBody: {
112250
- /** Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) to simulate. */
112511
+ /** HVAC mode that you want to simulate. */
112251
112512
  hvac_mode: 'off';
112252
- /** ID of the desired thermostat device. */
112513
+ /** ID of the thermostat device for which you want to simulate having adjusted the HVAC mode. */
112253
112514
  device_id: string;
112254
112515
  } | {
112255
- /** Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) to simulate. */
112516
+ /** HVAC mode that you want to simulate. */
112256
112517
  hvac_mode: 'cool';
112257
- /** ID of the desired thermostat device. */
112518
+ /** ID of the thermostat device for which you want to simulate having adjusted the HVAC mode. */
112258
112519
  device_id: string;
112259
- /** Desired simulated cooling [set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °C. You must set `cooling_set_point_celsius` or `cooling_set_point_fahrenheit`. */
112520
+ /** Cooling [set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °C that you want to simulate. You must set `cooling_set_point_celsius` or `cooling_set_point_fahrenheit`. */
112260
112521
  cooling_set_point_celsius?: number | undefined;
112261
- /** Desired simulated cooling [set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °F. You must set `cooling_set_point_fahrenheit` or `cooling_set_point_celsius`. */
112522
+ /** Cooling [set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °F that you want to simulate. You must set `cooling_set_point_fahrenheit` or `cooling_set_point_celsius`. */
112262
112523
  cooling_set_point_fahrenheit?: number | undefined;
112263
112524
  } | {
112264
- /** Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) to simulate. */
112525
+ /** HVAC mode that you want to simulate. */
112265
112526
  hvac_mode: 'heat';
112266
- /** ID of the desired thermostat device. */
112527
+ /** ID of the thermostat device for which you want to simulate having adjusted the HVAC mode. */
112267
112528
  device_id: string;
112268
- /** Desired simulated heating [set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °C. You must set `heating_set_point_celsius` or `heating_set_point_fahrenheit`. */
112529
+ /** Heating [set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °C that you want to simulate. You must set `heating_set_point_celsius` or `heating_set_point_fahrenheit`. */
112269
112530
  heating_set_point_celsius?: number | undefined;
112270
- /** Desired simulated heating [set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °F. You must set `heating_set_point_fahrenheit` or `heating_set_point_celsius`. */
112531
+ /** Heating [set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °F that you want to simulate. You must set `heating_set_point_fahrenheit` or `heating_set_point_celsius`. */
112271
112532
  heating_set_point_fahrenheit?: number | undefined;
112272
112533
  } | {
112273
- /** Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) to simulate. */
112534
+ /** HVAC mode that you want to simulate. */
112274
112535
  hvac_mode: 'heat_cool';
112275
- /** ID of the desired thermostat device. */
112536
+ /** ID of the thermostat device for which you want to simulate having adjusted the HVAC mode. */
112276
112537
  device_id: string;
112277
- /** Desired simulated cooling [set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °C. You must set `cooling_set_point_celsius` or `cooling_set_point_fahrenheit`. */
112538
+ /** Cooling [set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °C that you want to simulate. You must set `cooling_set_point_celsius` or `cooling_set_point_fahrenheit`. */
112278
112539
  cooling_set_point_celsius?: number | undefined;
112279
- /** Desired simulated cooling [set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °F. You must set `cooling_set_point_fahrenheit` or `cooling_set_point_celsius`. */
112540
+ /** Cooling [set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °F that you want to simulate. You must set `cooling_set_point_fahrenheit` or `cooling_set_point_celsius`. */
112280
112541
  cooling_set_point_fahrenheit?: number | undefined;
112281
- /** Desired simulated heating [set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °C. You must set `heating_set_point_celsius` or `heating_set_point_fahrenheit`. */
112542
+ /** Heating [set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °C that you want to simulate. You must set `heating_set_point_celsius` or `heating_set_point_fahrenheit`. */
112282
112543
  heating_set_point_celsius?: number | undefined;
112283
- /** Desired simulated heating [set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °F. You must set `heating_set_point_fahrenheit` or `heating_set_point_celsius`. */
112544
+ /** Heating [set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °F that you want to simulate. You must set `heating_set_point_fahrenheit` or `heating_set_point_celsius`. */
112284
112545
  heating_set_point_fahrenheit?: number | undefined;
112285
112546
  };
112286
112547
  commonParams: {};
@@ -112292,11 +112553,11 @@ interface Routes {
112292
112553
  method: 'POST';
112293
112554
  queryParams: {};
112294
112555
  jsonBody: {
112295
- /** ID of the desired thermostat device. */
112556
+ /** ID of the thermostat device that you want to simulate reaching a specified temperature. */
112296
112557
  device_id: string;
112297
- /** Desired simulated temperature in °C. You must set `temperature_celsius` or `temperature_fahrenheit`. */
112558
+ /** Temperature in °C that you want simulate the thermostat reaching. You must set `temperature_celsius` or `temperature_fahrenheit`. */
112298
112559
  temperature_celsius?: number | undefined;
112299
- /** Desired simulated temperature in °F. You must set `temperature_fahrenheit` or `temperature_celsius`. */
112560
+ /** Temperature in °F that you want simulate the thermostat reaching. You must set `temperature_fahrenheit` or `temperature_celsius`. */
112300
112561
  temperature_fahrenheit?: number | undefined;
112301
112562
  };
112302
112563
  commonParams: {};
@@ -113470,10 +113731,10 @@ interface Routes {
113470
113731
  queryParams: {};
113471
113732
  jsonBody: {};
113472
113733
  commonParams: ({
113473
- /** ID of user identity for whom access is being granted. */
113734
+ /** ID of user identity for whom you want to grant access. */
113474
113735
  user_identity_id: string;
113475
113736
  } | {
113476
- /** When used, creates a new user identity with the given details, and grants them access. */
113737
+ /** User identity. When used, creates a new user identity with the specified details and grants them access. */
113477
113738
  user_identity: {
113478
113739
  /** Unique email address for the user identity. */
113479
113740
  email_address?: (string | null) | undefined;
@@ -113485,9 +113746,9 @@ interface Routes {
113485
113746
  /**
113486
113747
  * @deprecated Use `space_ids`. */
113487
113748
  location_ids?: string[] | undefined;
113488
- /** Set of IDs of existing spaces to which access is being granted. */
113749
+ /** IDs of the existing spaces to which you want to grant access. */
113489
113750
  space_ids?: string[] | undefined;
113490
- /** When used, creates a new location with the given entrances and devices, and gives the user access to this location. */
113751
+ /** Location. When used, creates a new location with the specified entrances and devices, and gives the user access to this location. */
113491
113752
  location?: {
113492
113753
  /** Name of the location. */
113493
113754
  name?: string | undefined;
@@ -113498,12 +113759,12 @@ interface Routes {
113498
113759
  * @deprecated Use `device_ids` at the top level. */
113499
113760
  device_ids?: string[];
113500
113761
  } | undefined;
113501
- /** Set of IDs of the [entrances](https://docs.seam.co/latest/api/acs/systems/list) to which access is being granted. */
113762
+ /** IDs of the [entrances](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) to which you want to grant access. */
113502
113763
  acs_entrance_ids?: string[];
113503
- /** Set of IDs of the [devices](https://docs.seam.co/latest/api/devices/list) to which access is being granted. */
113764
+ /** IDs of the devices to which you want to grant access. */
113504
113765
  device_ids?: string[];
113505
113766
  requested_access_methods: Array<{
113506
- /** Access method mode. Supported values: `code`, `card`, `mobile_key`. */
113767
+ /** Access method mode. */
113507
113768
  mode: 'code' | 'card' | 'mobile_key';
113508
113769
  }>;
113509
113770
  /** Date and time at which the validity of the new grant starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
@@ -113552,7 +113813,7 @@ interface Routes {
113552
113813
  queryParams: {};
113553
113814
  jsonBody: {};
113554
113815
  commonParams: {
113555
- /** ID of access grant to delete. */
113816
+ /** ID of access grant that you want to delete. */
113556
113817
  access_grant_id: string;
113557
113818
  };
113558
113819
  formData: {};
@@ -113564,7 +113825,7 @@ interface Routes {
113564
113825
  queryParams: {};
113565
113826
  jsonBody: {};
113566
113827
  commonParams: {
113567
- /** ID of access grant to get. */
113828
+ /** ID of access grant that you want to get. */
113568
113829
  access_grant_id: string;
113569
113830
  };
113570
113831
  formData: {};
@@ -113608,16 +113869,16 @@ interface Routes {
113608
113869
  queryParams: {};
113609
113870
  jsonBody: {};
113610
113871
  commonParams: {
113611
- /** ID of user identity to filter list of access grants by. */
113872
+ /** ID of the user identity by which you want to filter the list of access grants. */
113612
113873
  user_identity_id?: string | undefined;
113613
- /** ID of system to filter list of access grants by. */
113874
+ /** ID of the access system by which you want to filter the list of access grants. */
113614
113875
  acs_system_id?: string | undefined;
113615
- /** ID of entrance to filter list of access grants by. */
113876
+ /** ID of the entrance by which you want to filter the list of access grants. */
113616
113877
  acs_entrance_id?: string | undefined;
113617
113878
  /**
113618
113879
  * @deprecated Use `space_id`. */
113619
113880
  location_id?: string | undefined;
113620
- /** ID of space to filter list of access grants by. */
113881
+ /** ID of the space by which you want to filter the list of access grants. */
113621
113882
  space_id?: string | undefined;
113622
113883
  };
113623
113884
  formData: {};
@@ -113660,7 +113921,7 @@ interface Routes {
113660
113921
  queryParams: {};
113661
113922
  jsonBody: {};
113662
113923
  commonParams: {
113663
- /** ID of access method to get. */
113924
+ /** ID of the access method that you want to delete. */
113664
113925
  access_method_id: string;
113665
113926
  };
113666
113927
  formData: {};
@@ -113672,7 +113933,7 @@ interface Routes {
113672
113933
  queryParams: {};
113673
113934
  jsonBody: {};
113674
113935
  commonParams: {
113675
- /** ID of access method to get. */
113936
+ /** ID of the access method that you want to get. */
113676
113937
  access_method_id: string;
113677
113938
  };
113678
113939
  formData: {};
@@ -113704,7 +113965,7 @@ interface Routes {
113704
113965
  queryParams: {};
113705
113966
  jsonBody: {};
113706
113967
  commonParams: {
113707
- /** ID of access grant to list access methods for. */
113968
+ /** ID of the access grant by which to filter the list of access methods. */
113708
113969
  access_grant_id: string;
113709
113970
  };
113710
113971
  formData: {};
@@ -113734,7 +113995,9 @@ interface Routes {
113734
113995
  method: 'POST' | 'PUT';
113735
113996
  queryParams: {};
113736
113997
  jsonBody: {
113998
+ /** ID of the location to which you want to add entrances. */
113737
113999
  location_id: string;
114000
+ /** IDs of the entrances that you want to add to the location. */
113738
114001
  acs_entrance_ids: string[];
113739
114002
  };
113740
114003
  commonParams: {};
@@ -113746,7 +114009,9 @@ interface Routes {
113746
114009
  method: 'POST' | 'PUT';
113747
114010
  queryParams: {};
113748
114011
  jsonBody: {
114012
+ /** ID of the location to which you want to add devices. */
113749
114013
  location_id: string;
114014
+ /** IDs of the devices that you want to add to the location. */
113750
114015
  device_ids: string[];
113751
114016
  };
113752
114017
  commonParams: {};
@@ -113758,13 +114023,18 @@ interface Routes {
113758
114023
  method: 'POST';
113759
114024
  queryParams: {};
113760
114025
  jsonBody: {
114026
+ /** Name of the new location. */
113761
114027
  name: string;
114028
+ /** Geolocation of the new location. */
113762
114029
  geolocation?: {
113763
114030
  latitude: number;
113764
114031
  longitude: number;
113765
114032
  } | undefined;
114033
+ /** Time zone of the new location. */
113766
114034
  time_zone?: string | undefined;
114035
+ /** IDs of the devices that you want to add to the new location. */
113767
114036
  device_ids?: string[] | undefined;
114037
+ /** IDs of the entrances that you want to add to the new location. */
113768
114038
  acs_entrance_ids?: string[] | undefined;
113769
114039
  };
113770
114040
  commonParams: {};
@@ -113796,6 +114066,7 @@ interface Routes {
113796
114066
  method: 'DELETE' | 'POST';
113797
114067
  queryParams: {};
113798
114068
  jsonBody: {
114069
+ /** ID of the location that you want to delete. */
113799
114070
  location_id: string;
113800
114071
  };
113801
114072
  commonParams: {};
@@ -113808,6 +114079,7 @@ interface Routes {
113808
114079
  queryParams: {};
113809
114080
  jsonBody: {};
113810
114081
  commonParams: {
114082
+ /** ID of the location that you want to get. */
113811
114083
  location_id: string;
113812
114084
  };
113813
114085
  formData: {};
@@ -113868,7 +114140,9 @@ interface Routes {
113868
114140
  queryParams: {};
113869
114141
  jsonBody: {};
113870
114142
  commonParams: {
114143
+ /** ID of the location from which you want to remove entrances. */
113871
114144
  location_id: string;
114145
+ /** IDs of the entrances that you want to remove from the location. */
113872
114146
  acs_entrance_ids: string[];
113873
114147
  };
113874
114148
  formData: {};
@@ -113880,7 +114154,9 @@ interface Routes {
113880
114154
  queryParams: {};
113881
114155
  jsonBody: {};
113882
114156
  commonParams: {
114157
+ /** ID of the location from which you want to remove devices. */
113883
114158
  location_id: string;
114159
+ /** IDs of the devices that you want to remove from the location. */
113884
114160
  device_ids: string[];
113885
114161
  };
113886
114162
  formData: {};
@@ -113891,12 +114167,16 @@ interface Routes {
113891
114167
  method: 'POST' | 'PATCH';
113892
114168
  queryParams: {};
113893
114169
  jsonBody: {
114170
+ /** ID of the location that you want to update. */
113894
114171
  location_id: string;
114172
+ /** Name of the location. */
113895
114173
  name?: string | undefined;
114174
+ /** Geolocation of the location. */
113896
114175
  geolocation?: {
113897
114176
  latitude: number;
113898
114177
  longitude: number;
113899
114178
  } | undefined;
114179
+ /** Time zone of the the location. */
113900
114180
  time_zone?: string | undefined;
113901
114181
  };
113902
114182
  commonParams: {};
@@ -113929,6 +114209,7 @@ interface Routes {
113929
114209
  queryParams: {};
113930
114210
  jsonBody: {};
113931
114211
  commonParams: {
114212
+ /** Customer key for which you want to connect accounts. */
113932
114213
  customer_key: string;
113933
114214
  };
113934
114215
  formData: {};
@@ -113936,7 +114217,7 @@ interface Routes {
113936
114217
  /** */
113937
114218
  magic_link: {
113938
114219
  url: string;
113939
- building_block_type: 'connect_accounts' | 'manage_devices' | 'organize_spaces';
114220
+ building_block_type: 'connect_accounts' | 'manage_devices' | 'organize_spaces' | 'console';
113940
114221
  customer_key: string;
113941
114222
  expires_at: string;
113942
114223
  workspace_id: string;
@@ -113950,17 +114231,13 @@ interface Routes {
113950
114231
  queryParams: {};
113951
114232
  jsonBody: {};
113952
114233
  commonParams: {
113953
- building_block_type: 'connect_accounts';
113954
- customer_key: string;
113955
- } | {
113956
- building_block_type: 'manage_devices';
114234
+ /** Type of building block to create a magic link for. */
114235
+ building_block_type: 'connect_accounts' | 'organize_spaces' | 'console' | 'manage_devices';
114236
+ /** Customer key for which you want to create a new building block magic link. */
113957
114237
  customer_key: string;
113958
- } | {
113959
- building_block_type: 'organize_spaces';
113960
- customer_key: string;
113961
- /** Optional list of partner resources to include in the magic link. */
113962
- partner_resources?: Array<{
113963
- partner_resource_key: string;
114238
+ /** Optional list of spaces that you want to include in the new building block magic link. */
114239
+ spaces?: Array<{
114240
+ space_key: string;
113964
114241
  name: string;
113965
114242
  description?: string | undefined;
113966
114243
  custom_metadata?: Record<string, string> | undefined;
@@ -113971,7 +114248,7 @@ interface Routes {
113971
114248
  /** */
113972
114249
  magic_link: {
113973
114250
  url: string;
113974
- building_block_type: 'connect_accounts' | 'manage_devices' | 'organize_spaces';
114251
+ building_block_type: 'connect_accounts' | 'manage_devices' | 'organize_spaces' | 'console';
113975
114252
  customer_key: string;
113976
114253
  expires_at: string;
113977
114254
  workspace_id: string;
@@ -113985,6 +114262,7 @@ interface Routes {
113985
114262
  queryParams: {};
113986
114263
  jsonBody: {};
113987
114264
  commonParams: {
114265
+ /** Customer key for which you want to manage devices. */
113988
114266
  customer_key: string;
113989
114267
  };
113990
114268
  formData: {};
@@ -113992,7 +114270,7 @@ interface Routes {
113992
114270
  /** */
113993
114271
  magic_link: {
113994
114272
  url: string;
113995
- building_block_type: 'connect_accounts' | 'manage_devices' | 'organize_spaces';
114273
+ building_block_type: 'connect_accounts' | 'manage_devices' | 'organize_spaces' | 'console';
113996
114274
  customer_key: string;
113997
114275
  expires_at: string;
113998
114276
  workspace_id: string;
@@ -114006,9 +114284,11 @@ interface Routes {
114006
114284
  queryParams: {};
114007
114285
  jsonBody: {};
114008
114286
  commonParams: {
114287
+ /** Customer key for which you want to organize spaces. */
114009
114288
  customer_key: string;
114010
- partner_resources?: Array<{
114011
- partner_resource_key: string;
114289
+ /** Optional list of spaces that you want to include in the new building block magic link. */
114290
+ spaces?: Array<{
114291
+ space_key: string;
114012
114292
  name: string;
114013
114293
  description?: string | undefined;
114014
114294
  custom_metadata?: Record<string, string> | undefined;
@@ -114019,7 +114299,7 @@ interface Routes {
114019
114299
  /** */
114020
114300
  magic_link: {
114021
114301
  url: string;
114022
- building_block_type: 'connect_accounts' | 'manage_devices' | 'organize_spaces';
114302
+ building_block_type: 'connect_accounts' | 'manage_devices' | 'organize_spaces' | 'console';
114023
114303
  customer_key: string;
114024
114304
  expires_at: string;
114025
114305
  workspace_id: string;
@@ -114032,8 +114312,11 @@ interface Routes {
114032
114312
  method: 'POST';
114033
114313
  queryParams: {};
114034
114314
  jsonBody: Array<{
114315
+ /** Type of the resource that you want to push to Seam. */
114035
114316
  partner_resource_type?: string | undefined;
114317
+ /** Key of the resource that you want to push to Seam. */
114036
114318
  partner_resource_key?: string | undefined;
114319
+ /** Customer key associated with the resource that you want to push to Seam. */
114037
114320
  customer_key?: string | undefined;
114038
114321
  email_address?: string | undefined;
114039
114322
  phone_number?: string | undefined;
@@ -114045,8 +114328,11 @@ interface Routes {
114045
114328
  description?: string | undefined;
114046
114329
  custom_metadata?: Record<string, string> | undefined;
114047
114330
  }> | {
114331
+ /** Type of the resource that you want to push to Seam. */
114048
114332
  partner_resource_type?: string | undefined;
114333
+ /** Key of the resource that you want to push to Seam. */
114049
114334
  partner_resource_key?: string | undefined;
114335
+ /** Customer key associated with the resource that you want to push to Seam. */
114050
114336
  customer_key?: string | undefined;
114051
114337
  email_address?: string | undefined;
114052
114338
  phone_number?: string | undefined;
@@ -114068,9 +114354,9 @@ interface Routes {
114068
114354
  queryParams: {};
114069
114355
  jsonBody: {};
114070
114356
  commonParams: {
114071
- /** ID of the desired user identity. */
114357
+ /** ID of the user identity to which you want to add an access system user. */
114072
114358
  user_identity_id: string;
114073
- /** ID of the desired ACS user. */
114359
+ /** ID of the access system user that you want to add to the user identity. */
114074
114360
  acs_user_id: string;
114075
114361
  };
114076
114362
  formData: {};
@@ -114082,15 +114368,15 @@ interface Routes {
114082
114368
  queryParams: {};
114083
114369
  jsonBody: {};
114084
114370
  commonParams: {
114085
- /** Unique key for the user identity. */
114371
+ /** Unique key for the new user identity. */
114086
114372
  user_identity_key?: (string | null) | undefined;
114087
- /** Unique email address for the user identity. */
114373
+ /** Unique email address for the new user identity. */
114088
114374
  email_address?: (string | null) | undefined;
114089
- /** Unique phone number for the user identity in E.164 format (for example, +15555550100). */
114375
+ /** Unique phone number for the new user identity in E.164 format (for example, +15555550100). */
114090
114376
  phone_number?: (string | null) | undefined;
114091
- /** Full name of the user associated with the user identity. */
114377
+ /** Full name of the user associated with the new user identity. */
114092
114378
  full_name?: (string | null) | undefined;
114093
- /** List of ACS system IDs to associate with the user identity through ACS users. If there's no user with the same email address or phone number in the specified ACS systems, a new ACS user is created. If there is an existing user with the same email or phone number in the specified ACS systems, the user is linked to the user identity. */
114379
+ /** List of access system IDs to associate with the new user identity through access system users. If there's no user with the same email address or phone number in the specified access systems, a new access system user is created. If there is an existing user with the same email or phone number in the specified access systems, the user is linked to the user identity. */
114094
114380
  acs_system_ids?: string[] | undefined;
114095
114381
  };
114096
114382
  formData: {};
@@ -114120,7 +114406,7 @@ interface Routes {
114120
114406
  queryParams: {};
114121
114407
  jsonBody: {};
114122
114408
  commonParams: {
114123
- /** ID of the desired user identity. */
114409
+ /** ID of the user identity that you want to delete. */
114124
114410
  user_identity_id: string;
114125
114411
  };
114126
114412
  formData: {};
@@ -114132,7 +114418,7 @@ interface Routes {
114132
114418
  queryParams: {};
114133
114419
  jsonBody: {};
114134
114420
  commonParams: {
114135
- /** ID of the desired enrollment automation. */
114421
+ /** ID of the enrollment automation that you want to delete. */
114136
114422
  enrollment_automation_id: string;
114137
114423
  };
114138
114424
  formData: {};
@@ -114144,7 +114430,7 @@ interface Routes {
114144
114430
  queryParams: {};
114145
114431
  jsonBody: {};
114146
114432
  commonParams: {
114147
- /** ID of the desired enrollment automation. */
114433
+ /** ID of the enrollment automation that you want to get. */
114148
114434
  enrollment_automation_id: string;
114149
114435
  };
114150
114436
  formData: {};
@@ -114170,15 +114456,15 @@ interface Routes {
114170
114456
  queryParams: {};
114171
114457
  jsonBody: {};
114172
114458
  commonParams: {
114173
- /** ID of the desired user identity. */
114459
+ /** ID of the user identity for which you want to launch an enrollment automation. */
114174
114460
  user_identity_id: string;
114175
- /** ID of the desired ACS system that serves as the credential manager. */
114461
+ /** ID of the desired access system that serves as the credential manager for the enrollment automation. */
114176
114462
  credential_manager_acs_system_id: string;
114177
- /** ID of the ACS credential pool from which to obtain credentials for the user identity. */
114463
+ /** ID of the credential pool from which to obtain credentials for the user identity. */
114178
114464
  acs_credential_pool_id?: string | undefined;
114179
114465
  /** 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`. */
114180
114466
  create_credential_manager_user?: boolean | undefined;
114181
- /** ID of the associated ACS user within the credential manager. If you specify a `credential_manager_acs_user_id`, you cannot set `create_credential_manager_user` to `true`. */
114467
+ /** 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`. */
114182
114468
  credential_manager_acs_user_id?: string | undefined;
114183
114469
  };
114184
114470
  formData: {};
@@ -114199,7 +114485,7 @@ interface Routes {
114199
114485
  queryParams: {};
114200
114486
  jsonBody: {};
114201
114487
  commonParams: {
114202
- /** ID of the user identity for which you want to retrieve all enrollment automations. */
114488
+ /** ID of the user identity for which you want to retrieve enrollment automations. */
114203
114489
  user_identity_id: string;
114204
114490
  };
114205
114491
  formData: {};
@@ -114226,7 +114512,7 @@ interface Routes {
114226
114512
  commonParams: {
114227
114513
  /** ID of the user identity for which you want to generate an instant key. */
114228
114514
  user_identity_id: string;
114229
- /** The maximum number of times the instant key can be used. Defaults to 1. */
114515
+ /** Maximum number of times the instant key can be used. Default: 1. */
114230
114516
  max_use_count?: number;
114231
114517
  };
114232
114518
  formData: {};
@@ -114249,7 +114535,7 @@ interface Routes {
114249
114535
  queryParams: {};
114250
114536
  jsonBody: {};
114251
114537
  commonParams: {
114252
- /** ID of the desired user identity. */
114538
+ /** ID of the user identity that you want to get. */
114253
114539
  user_identity_id: string;
114254
114540
  } | {
114255
114541
  user_identity_key: string;
@@ -114281,9 +114567,9 @@ interface Routes {
114281
114567
  queryParams: {};
114282
114568
  jsonBody: {};
114283
114569
  commonParams: {
114284
- /** ID of the desired user identity. */
114570
+ /** ID of the user identity that you want to grant access to a device. */
114285
114571
  user_identity_id: string;
114286
- /** ID of the desired managed device. */
114572
+ /** ID of the managed device to which you want to grant access to the user identity. */
114287
114573
  device_id: string;
114288
114574
  };
114289
114575
  formData: {};
@@ -114295,6 +114581,7 @@ interface Routes {
114295
114581
  queryParams: {};
114296
114582
  jsonBody: {};
114297
114583
  commonParams: {
114584
+ /** `acs_system_id` of the credential manager by which you want to filter the list of user identities. */
114298
114585
  credential_manager_acs_system_id?: string | undefined;
114299
114586
  };
114300
114587
  formData: {};
@@ -115532,7 +115819,7 @@ interface Routes {
115532
115819
  can_simulate_disconnection?: boolean | undefined;
115533
115820
  }>;
115534
115821
  /**
115535
- * @deprecated use devices. */
115822
+ * @deprecated Use devices. */
115536
115823
  accessible_devices: Array<{
115537
115824
  /** Unique identifier for the device. */
115538
115825
  device_id: string;
@@ -116744,7 +117031,7 @@ interface Routes {
116744
117031
  queryParams: {};
116745
117032
  jsonBody: {};
116746
117033
  commonParams: {
116747
- /** ID of the user identity for which you want to retrieve all access control systems. */
117034
+ /** ID of the user identity for which you want to retrieve all access systems. */
116748
117035
  user_identity_id: string;
116749
117036
  };
116750
117037
  formData: {};
@@ -116875,7 +117162,7 @@ interface Routes {
116875
117162
  queryParams: {};
116876
117163
  jsonBody: {};
116877
117164
  commonParams: {
116878
- /** ID of the user identity for which you want to retrieve all ACS users. */
117165
+ /** ID of the user identity for which you want to retrieve all access system users. */
116879
117166
  user_identity_id: string;
116880
117167
  };
116881
117168
  formData: {};
@@ -117074,9 +117361,9 @@ interface Routes {
117074
117361
  queryParams: {};
117075
117362
  jsonBody: {};
117076
117363
  commonParams: {
117077
- /** ID of the desired user identity. */
117364
+ /** ID of the user identity from which you want to remove an access system user. */
117078
117365
  user_identity_id: string;
117079
- /** ID of the ACS user. */
117366
+ /** ID of the access system user that you want to remove from the user identity.. */
117080
117367
  acs_user_id: string;
117081
117368
  };
117082
117369
  formData: {};
@@ -117088,9 +117375,9 @@ interface Routes {
117088
117375
  queryParams: {};
117089
117376
  jsonBody: {};
117090
117377
  commonParams: {
117091
- /** ID of the desired user identity. */
117378
+ /** ID of the user identity from which you want to revoke access to a device. */
117092
117379
  user_identity_id: string;
117093
- /** ID of the desired managed device. */
117380
+ /** ID of the managed device to which you want to revoke access from the user identity. */
117094
117381
  device_id: string;
117095
117382
  };
117096
117383
  formData: {};
@@ -117101,14 +117388,15 @@ interface Routes {
117101
117388
  method: 'PATCH' | 'POST';
117102
117389
  queryParams: {};
117103
117390
  jsonBody: {
117104
- /** ID of the user identity. */
117391
+ /** ID of the user identity that you want to update. */
117105
117392
  user_identity_id: string;
117106
117393
  /** Unique key for the user identity. */
117107
117394
  user_identity_key?: (string | null) | undefined;
117108
117395
  /** Unique email address for the user identity. */
117109
117396
  email_address?: (string | null) | undefined;
117110
- /** Unique phone number for the user identity in [E.164 format](https://www.itu.int/rec/T-REC-E.164/en) (for example, +15555550100). */
117397
+ /** Unique phone number for the user identity. */
117111
117398
  phone_number?: (string | null) | undefined;
117399
+ /** Full name of the user associated with the user identity. */
117112
117400
  full_name?: (string | null) | undefined;
117113
117401
  };
117114
117402
  commonParams: {};
@@ -117120,7 +117408,9 @@ interface Routes {
117120
117408
  method: 'POST';
117121
117409
  queryParams: {};
117122
117410
  jsonBody: {
117411
+ /** URL for the new webhook. */
117123
117412
  url: string;
117413
+ /** Types of events that you want the new webhook to receive. */
117124
117414
  event_types?: string[];
117125
117415
  };
117126
117416
  commonParams: {};
@@ -117141,6 +117431,7 @@ interface Routes {
117141
117431
  queryParams: {};
117142
117432
  jsonBody: {};
117143
117433
  commonParams: {
117434
+ /** ID of the webhook that you want to delete. */
117144
117435
  webhook_id: string;
117145
117436
  };
117146
117437
  formData: {};
@@ -117152,6 +117443,7 @@ interface Routes {
117152
117443
  queryParams: {};
117153
117444
  jsonBody: {};
117154
117445
  commonParams: {
117446
+ /** ID of the webhook that you want to get. */
117155
117447
  webhook_id: string;
117156
117448
  };
117157
117449
  formData: {};
@@ -117186,7 +117478,9 @@ interface Routes {
117186
117478
  method: 'PUT' | 'POST';
117187
117479
  queryParams: {};
117188
117480
  jsonBody: {
117481
+ /** ID of the webhook that you want to update. */
117189
117482
  webhook_id: string;
117483
+ /** Types of events that you want the webhook to receive. */
117190
117484
  event_types: string[];
117191
117485
  };
117192
117486
  commonParams: {};
@@ -117198,11 +117492,13 @@ interface Routes {
117198
117492
  method: 'POST';
117199
117493
  queryParams: {};
117200
117494
  jsonBody: {
117495
+ /** Name of the new workspace. */
117201
117496
  name: string;
117497
+ /** Company name for the new workspace. */
117202
117498
  company_name?: string | undefined;
117203
- /**
117204
- * @deprecated use company_name */
117499
+ /** Connect partner name for the new workspace. */
117205
117500
  connect_partner_name?: ((string | null) | null) | undefined;
117501
+ /** Indicates whether the new workspace is a [sandbox workspace](https://docs.seam.co/latest/core-concepts/workspaces#sandbox-workspaces). */
117206
117502
  is_sandbox?: boolean;
117207
117503
  /**
117208
117504
  * @deprecated Use `connect_webview_customization.webview_primary_button_color` instead. */
@@ -117216,10 +117512,15 @@ interface Routes {
117216
117512
  /**
117217
117513
  * @deprecated Use `connect_webview_customization.webview_success_message` instead. */
117218
117514
  webview_success_message?: string | undefined;
117515
+ /** [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews) customizations for the new workspace. See also [Customize the Look and Feel of Your Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews). */
117219
117516
  connect_webview_customization?: {
117517
+ /** Primary button color for [Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews) in the new workspace. See also [Customize the Look and Feel of Your Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews). */
117220
117518
  primary_button_color?: (string | null) | undefined;
117519
+ /** Primary button text color for [Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews) in the new workspace. See also [Customize the Look and Feel of Your Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews). */
117221
117520
  primary_button_text_color?: (string | null) | undefined;
117521
+ /** Success message for [Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews) in the new workspace. See also [Customize the Look and Feel of Your Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews). */
117222
117522
  success_message?: (string | null) | undefined;
117523
+ /** Logo shape for [Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews) in the new workspace. See also [Customize the Look and Feel of Your Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews). */
117223
117524
  logo_shape?: (('circle' | 'square') | null) | undefined;
117224
117525
  } | undefined;
117225
117526
  };
@@ -118422,14 +118723,22 @@ interface Routes {
118422
118723
  method: 'POST' | 'PATCH';
118423
118724
  queryParams: {};
118424
118725
  jsonBody: {
118726
+ /** Name of the workspace. */
118425
118727
  name?: string | undefined;
118728
+ /** Connect partner name for the workspace. */
118426
118729
  connect_partner_name?: string | undefined;
118730
+ /** [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews) customizations for the workspace. See also [Customize the Look and Feel of Your Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews). */
118427
118731
  connect_webview_customization?: {
118732
+ /** Primary button color for [Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews) in the workspace. See also [Customize the Look and Feel of Your Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews). */
118428
118733
  primary_button_color?: (string | null) | undefined;
118734
+ /** Primary button text color for [Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews) in the workspace. See also [Customize the Look and Feel of Your Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews). */
118429
118735
  primary_button_text_color?: (string | null) | undefined;
118736
+ /** Success message for [Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews) in the workspace. See also [Customize the Look and Feel of Your Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews). */
118430
118737
  success_message?: (string | null) | undefined;
118738
+ /** Logo shape for [Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews) in the workspace. See also [Customize the Look and Feel of Your Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews). */
118431
118739
  logo_shape?: (('circle' | 'square') | null) | undefined;
118432
118740
  } | undefined;
118741
+ /** Indicates whether the workspace is suspended. */
118433
118742
  is_suspended?: boolean | undefined;
118434
118743
  };
118435
118744
  commonParams: {};