@seamapi/types 1.272.0 → 1.274.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.
Files changed (21) hide show
  1. package/dist/connect.cjs +210 -39
  2. package/dist/connect.cjs.map +1 -1
  3. package/dist/connect.d.cts +394 -19
  4. package/lib/seam/connect/models/acs/acs-access-group.js +23 -8
  5. package/lib/seam/connect/models/acs/acs-access-group.js.map +1 -1
  6. package/lib/seam/connect/models/acs/acs-entrance.d.ts +19 -19
  7. package/lib/seam/connect/models/devices/device-metadata.d.ts +38 -0
  8. package/lib/seam/connect/models/devices/device-metadata.js +11 -0
  9. package/lib/seam/connect/models/devices/device-metadata.js.map +1 -1
  10. package/lib/seam/connect/models/devices/device.d.ts +54 -0
  11. package/lib/seam/connect/models/devices/phone.d.ts +38 -0
  12. package/lib/seam/connect/models/devices/unmanaged-device.d.ts +38 -0
  13. package/lib/seam/connect/openapi.d.ts +70 -0
  14. package/lib/seam/connect/openapi.js +179 -31
  15. package/lib/seam/connect/openapi.js.map +1 -1
  16. package/lib/seam/connect/route-types.d.ts +213 -0
  17. package/package.json +1 -1
  18. package/src/lib/seam/connect/models/acs/acs-access-group.ts +31 -8
  19. package/src/lib/seam/connect/models/devices/device-metadata.ts +11 -1
  20. package/src/lib/seam/connect/openapi.ts +210 -31
  21. package/src/lib/seam/connect/route-types.ts +241 -0
package/dist/connect.d.cts CHANGED
@@ -788,6 +788,16 @@ declare const acs_entrance: z.ZodObject<{
788
788
  display_name: string;
789
789
  acs_system_id: string;
790
790
  acs_entrance_id: string;
791
+ salto_ks_metadata?: {
792
+ lock_type: string;
793
+ battery_level: string;
794
+ locked_state: string;
795
+ door_name: string;
796
+ online: boolean;
797
+ left_open_alarm: boolean;
798
+ intrusion_alarm: boolean;
799
+ privacy_mode: boolean;
800
+ } | undefined;
791
801
  visionline_metadata?: {
792
802
  door_name: string;
793
803
  door_category: "entrance" | "guest" | "elevator reader" | "common" | "common (PMS)";
@@ -802,6 +812,15 @@ declare const acs_entrance: z.ZodObject<{
802
812
  accessibility_type: string;
803
813
  door_type: string;
804
814
  } | undefined;
815
+ }, {
816
+ created_at: string;
817
+ errors: {
818
+ message: string;
819
+ error_code: string;
820
+ }[];
821
+ display_name: string;
822
+ acs_system_id: string;
823
+ acs_entrance_id: string;
805
824
  salto_ks_metadata?: {
806
825
  lock_type: string;
807
826
  battery_level: string;
@@ -812,15 +831,6 @@ declare const acs_entrance: z.ZodObject<{
812
831
  intrusion_alarm: boolean;
813
832
  privacy_mode: boolean;
814
833
  } | undefined;
815
- }, {
816
- created_at: string;
817
- errors: {
818
- message: string;
819
- error_code: string;
820
- }[];
821
- display_name: string;
822
- acs_system_id: string;
823
- acs_entrance_id: string;
824
834
  visionline_metadata?: {
825
835
  door_name: string;
826
836
  door_category: "entrance" | "guest" | "elevator reader" | "common" | "common (PMS)";
@@ -835,16 +845,6 @@ declare const acs_entrance: z.ZodObject<{
835
845
  accessibility_type: string;
836
846
  door_type: string;
837
847
  } | undefined;
838
- salto_ks_metadata?: {
839
- lock_type: string;
840
- battery_level: string;
841
- locked_state: string;
842
- door_name: string;
843
- online: boolean;
844
- left_open_alarm: boolean;
845
- intrusion_alarm: boolean;
846
- privacy_mode: boolean;
847
- } | undefined;
848
848
  }>;
849
849
  type AcsEntrance = z.infer<typeof acs_entrance>;
850
850
 
@@ -4900,6 +4900,28 @@ declare const device: z.ZodObject<z.objectUtil.extendShape<{
4900
4900
  locked_state: string;
4901
4901
  model?: string | undefined;
4902
4902
  }>>;
4903
+ salto_ks_metadata: z.ZodOptional<z.ZodObject<{
4904
+ lock_id: z.ZodString;
4905
+ customer_reference: z.ZodString;
4906
+ lock_type: z.ZodString;
4907
+ battery_level: z.ZodString;
4908
+ locked_state: z.ZodString;
4909
+ model: z.ZodOptional<z.ZodString>;
4910
+ }, "strip", z.ZodTypeAny, {
4911
+ lock_type: string;
4912
+ lock_id: string;
4913
+ customer_reference: string;
4914
+ battery_level: string;
4915
+ locked_state: string;
4916
+ model?: string | undefined;
4917
+ }, {
4918
+ lock_type: string;
4919
+ lock_id: string;
4920
+ customer_reference: string;
4921
+ battery_level: string;
4922
+ locked_state: string;
4923
+ model?: string | undefined;
4924
+ }>>;
4903
4925
  genie_metadata: z.ZodOptional<z.ZodObject<{
4904
4926
  device_name: z.ZodString;
4905
4927
  door_name: z.ZodString;
@@ -5493,6 +5515,14 @@ declare const device: z.ZodObject<z.objectUtil.extendShape<{
5493
5515
  locked_state: string;
5494
5516
  model?: string | undefined;
5495
5517
  } | undefined;
5518
+ salto_ks_metadata?: {
5519
+ lock_type: string;
5520
+ lock_id: string;
5521
+ customer_reference: string;
5522
+ battery_level: string;
5523
+ locked_state: string;
5524
+ model?: string | undefined;
5525
+ } | undefined;
5496
5526
  genie_metadata?: {
5497
5527
  device_name: string;
5498
5528
  door_name: string;
@@ -5704,6 +5734,14 @@ declare const device: z.ZodObject<z.objectUtil.extendShape<{
5704
5734
  locked_state: string;
5705
5735
  model?: string | undefined;
5706
5736
  } | undefined;
5737
+ salto_ks_metadata?: {
5738
+ lock_type: string;
5739
+ lock_id: string;
5740
+ customer_reference: string;
5741
+ battery_level: string;
5742
+ locked_state: string;
5743
+ model?: string | undefined;
5744
+ } | undefined;
5707
5745
  genie_metadata?: {
5708
5746
  device_name: string;
5709
5747
  door_name: string;
@@ -6442,6 +6480,14 @@ declare const device: z.ZodObject<z.objectUtil.extendShape<{
6442
6480
  locked_state: string;
6443
6481
  model?: string | undefined;
6444
6482
  } | undefined;
6483
+ salto_ks_metadata?: {
6484
+ lock_type: string;
6485
+ lock_id: string;
6486
+ customer_reference: string;
6487
+ battery_level: string;
6488
+ locked_state: string;
6489
+ model?: string | undefined;
6490
+ } | undefined;
6445
6491
  genie_metadata?: {
6446
6492
  device_name: string;
6447
6493
  door_name: string;
@@ -6831,6 +6877,14 @@ declare const device: z.ZodObject<z.objectUtil.extendShape<{
6831
6877
  locked_state: string;
6832
6878
  model?: string | undefined;
6833
6879
  } | undefined;
6880
+ salto_ks_metadata?: {
6881
+ lock_type: string;
6882
+ lock_id: string;
6883
+ customer_reference: string;
6884
+ battery_level: string;
6885
+ locked_state: string;
6886
+ model?: string | undefined;
6887
+ } | undefined;
6834
6888
  genie_metadata?: {
6835
6889
  device_name: string;
6836
6890
  door_name: string;
@@ -7545,6 +7599,28 @@ declare const unmanaged_device: z.ZodObject<z.objectUtil.extendShape<z.objectUti
7545
7599
  locked_state: string;
7546
7600
  model?: string | undefined;
7547
7601
  }>>;
7602
+ salto_ks_metadata: z.ZodOptional<z.ZodObject<{
7603
+ lock_id: z.ZodString;
7604
+ customer_reference: z.ZodString;
7605
+ lock_type: z.ZodString;
7606
+ battery_level: z.ZodString;
7607
+ locked_state: z.ZodString;
7608
+ model: z.ZodOptional<z.ZodString>;
7609
+ }, "strip", z.ZodTypeAny, {
7610
+ lock_type: string;
7611
+ lock_id: string;
7612
+ customer_reference: string;
7613
+ battery_level: string;
7614
+ locked_state: string;
7615
+ model?: string | undefined;
7616
+ }, {
7617
+ lock_type: string;
7618
+ lock_id: string;
7619
+ customer_reference: string;
7620
+ battery_level: string;
7621
+ locked_state: string;
7622
+ model?: string | undefined;
7623
+ }>>;
7548
7624
  genie_metadata: z.ZodOptional<z.ZodObject<{
7549
7625
  device_name: z.ZodString;
7550
7626
  door_name: z.ZodString;
@@ -8138,6 +8214,14 @@ declare const unmanaged_device: z.ZodObject<z.objectUtil.extendShape<z.objectUti
8138
8214
  locked_state: string;
8139
8215
  model?: string | undefined;
8140
8216
  } | undefined;
8217
+ salto_ks_metadata?: {
8218
+ lock_type: string;
8219
+ lock_id: string;
8220
+ customer_reference: string;
8221
+ battery_level: string;
8222
+ locked_state: string;
8223
+ model?: string | undefined;
8224
+ } | undefined;
8141
8225
  genie_metadata?: {
8142
8226
  device_name: string;
8143
8227
  door_name: string;
@@ -8349,6 +8433,14 @@ declare const unmanaged_device: z.ZodObject<z.objectUtil.extendShape<z.objectUti
8349
8433
  locked_state: string;
8350
8434
  model?: string | undefined;
8351
8435
  } | undefined;
8436
+ salto_ks_metadata?: {
8437
+ lock_type: string;
8438
+ lock_id: string;
8439
+ customer_reference: string;
8440
+ battery_level: string;
8441
+ locked_state: string;
8442
+ model?: string | undefined;
8443
+ } | undefined;
8352
8444
  genie_metadata?: {
8353
8445
  device_name: string;
8354
8446
  door_name: string;
@@ -11310,6 +11402,7 @@ declare const _default: {
11310
11402
  type: string;
11311
11403
  };
11312
11404
  acs_access_group: {
11405
+ description: string;
11313
11406
  properties: {
11314
11407
  access_group_type: {
11315
11408
  deprecated: boolean;
@@ -11323,14 +11416,17 @@ declare const _default: {
11323
11416
  'x-deprecated': string;
11324
11417
  };
11325
11418
  acs_access_group_id: {
11419
+ description: string;
11326
11420
  format: string;
11327
11421
  type: string;
11328
11422
  };
11329
11423
  acs_system_id: {
11424
+ description: string;
11330
11425
  format: string;
11331
11426
  type: string;
11332
11427
  };
11333
11428
  created_at: {
11429
+ description: string;
11334
11430
  format: string;
11335
11431
  type: string;
11336
11432
  };
@@ -11338,10 +11434,12 @@ declare const _default: {
11338
11434
  type: string;
11339
11435
  };
11340
11436
  external_type: {
11437
+ description: string;
11341
11438
  enum: string[];
11342
11439
  type: string;
11343
11440
  };
11344
11441
  external_type_display_name: {
11442
+ description: string;
11345
11443
  type: string;
11346
11444
  };
11347
11445
  is_managed: {
@@ -11349,9 +11447,11 @@ declare const _default: {
11349
11447
  type: string;
11350
11448
  };
11351
11449
  name: {
11450
+ description: string;
11352
11451
  type: string;
11353
11452
  };
11354
11453
  workspace_id: {
11454
+ description: string;
11355
11455
  format: string;
11356
11456
  type: string;
11357
11457
  };
@@ -13895,7 +13995,32 @@ declare const _default: {
13895
13995
  required: string[];
13896
13996
  type: string;
13897
13997
  };
13998
+ salto_ks_metadata: {
13999
+ properties: {
14000
+ battery_level: {
14001
+ type: string;
14002
+ };
14003
+ customer_reference: {
14004
+ type: string;
14005
+ };
14006
+ lock_id: {
14007
+ type: string;
14008
+ };
14009
+ lock_type: {
14010
+ type: string;
14011
+ };
14012
+ locked_state: {
14013
+ type: string;
14014
+ };
14015
+ model: {
14016
+ type: string;
14017
+ };
14018
+ };
14019
+ required: string[];
14020
+ type: string;
14021
+ };
13898
14022
  salto_metadata: {
14023
+ description: string;
13899
14024
  properties: {
13900
14025
  battery_level: {
13901
14026
  type: string;
@@ -17611,6 +17736,7 @@ declare const _default: {
17611
17736
  };
17612
17737
  '/acs/access_groups/add_user': {
17613
17738
  post: {
17739
+ description: string;
17614
17740
  operationId: string;
17615
17741
  requestBody: {
17616
17742
  content: {
@@ -17618,10 +17744,12 @@ declare const _default: {
17618
17744
  schema: {
17619
17745
  properties: {
17620
17746
  acs_access_group_id: {
17747
+ description: string;
17621
17748
  format: string;
17622
17749
  type: string;
17623
17750
  };
17624
17751
  acs_user_id: {
17752
+ description: string;
17625
17753
  format: string;
17626
17754
  type: string;
17627
17755
  };
@@ -17676,6 +17804,7 @@ declare const _default: {
17676
17804
  'x-response-key': null;
17677
17805
  };
17678
17806
  put: {
17807
+ description: string;
17679
17808
  operationId: string;
17680
17809
  requestBody: {
17681
17810
  content: {
@@ -17683,10 +17812,12 @@ declare const _default: {
17683
17812
  schema: {
17684
17813
  properties: {
17685
17814
  acs_access_group_id: {
17815
+ description: string;
17686
17816
  format: string;
17687
17817
  type: string;
17688
17818
  };
17689
17819
  acs_user_id: {
17820
+ description: string;
17690
17821
  format: string;
17691
17822
  type: string;
17692
17823
  };
@@ -17742,6 +17873,7 @@ declare const _default: {
17742
17873
  };
17743
17874
  '/acs/access_groups/get': {
17744
17875
  post: {
17876
+ description: string;
17745
17877
  operationId: string;
17746
17878
  requestBody: {
17747
17879
  content: {
@@ -17749,6 +17881,7 @@ declare const _default: {
17749
17881
  schema: {
17750
17882
  properties: {
17751
17883
  acs_access_group_id: {
17884
+ description: string;
17752
17885
  format: string;
17753
17886
  type: string;
17754
17887
  };
@@ -17809,6 +17942,7 @@ declare const _default: {
17809
17942
  };
17810
17943
  '/acs/access_groups/list': {
17811
17944
  post: {
17945
+ description: string;
17812
17946
  operationId: string;
17813
17947
  requestBody: {
17814
17948
  content: {
@@ -17816,10 +17950,12 @@ declare const _default: {
17816
17950
  schema: {
17817
17951
  properties: {
17818
17952
  acs_system_id: {
17953
+ description: string;
17819
17954
  format: string;
17820
17955
  type: string;
17821
17956
  };
17822
17957
  acs_user_id: {
17958
+ description: string;
17823
17959
  format: string;
17824
17960
  type: string;
17825
17961
  };
@@ -17882,6 +18018,7 @@ declare const _default: {
17882
18018
  };
17883
18019
  '/acs/access_groups/list_accessible_entrances': {
17884
18020
  post: {
18021
+ description: string;
17885
18022
  operationId: string;
17886
18023
  requestBody: {
17887
18024
  content: {
@@ -17889,6 +18026,7 @@ declare const _default: {
17889
18026
  schema: {
17890
18027
  properties: {
17891
18028
  acs_access_group_id: {
18029
+ description: string;
17892
18030
  format: string;
17893
18031
  type: string;
17894
18032
  };
@@ -17952,6 +18090,7 @@ declare const _default: {
17952
18090
  };
17953
18091
  '/acs/access_groups/list_users': {
17954
18092
  post: {
18093
+ description: string;
17955
18094
  operationId: string;
17956
18095
  requestBody: {
17957
18096
  content: {
@@ -17959,6 +18098,7 @@ declare const _default: {
17959
18098
  schema: {
17960
18099
  properties: {
17961
18100
  acs_access_group_id: {
18101
+ description: string;
17962
18102
  format: string;
17963
18103
  type: string;
17964
18104
  };
@@ -18022,6 +18162,7 @@ declare const _default: {
18022
18162
  };
18023
18163
  '/acs/access_groups/remove_user': {
18024
18164
  post: {
18165
+ description: string;
18025
18166
  operationId: string;
18026
18167
  requestBody: {
18027
18168
  content: {
@@ -18029,10 +18170,12 @@ declare const _default: {
18029
18170
  schema: {
18030
18171
  properties: {
18031
18172
  acs_access_group_id: {
18173
+ description: string;
18032
18174
  format: string;
18033
18175
  type: string;
18034
18176
  };
18035
18177
  acs_user_id: {
18178
+ description: string;
18036
18179
  format: string;
18037
18180
  type: string;
18038
18181
  };
@@ -18089,6 +18232,7 @@ declare const _default: {
18089
18232
  };
18090
18233
  '/acs/access_groups/unmanaged/get': {
18091
18234
  post: {
18235
+ description: string;
18092
18236
  operationId: string;
18093
18237
  requestBody: {
18094
18238
  content: {
@@ -18096,6 +18240,7 @@ declare const _default: {
18096
18240
  schema: {
18097
18241
  properties: {
18098
18242
  acs_access_group_id: {
18243
+ description: string;
18099
18244
  format: string;
18100
18245
  type: string;
18101
18246
  };
@@ -18126,14 +18271,17 @@ declare const _default: {
18126
18271
  'x-deprecated': string;
18127
18272
  };
18128
18273
  acs_access_group_id: {
18274
+ description: string;
18129
18275
  format: string;
18130
18276
  type: string;
18131
18277
  };
18132
18278
  acs_system_id: {
18279
+ description: string;
18133
18280
  format: string;
18134
18281
  type: string;
18135
18282
  };
18136
18283
  created_at: {
18284
+ description: string;
18137
18285
  format: string;
18138
18286
  type: string;
18139
18287
  };
@@ -18141,10 +18289,12 @@ declare const _default: {
18141
18289
  type: string;
18142
18290
  };
18143
18291
  external_type: {
18292
+ description: string;
18144
18293
  enum: string[];
18145
18294
  type: string;
18146
18295
  };
18147
18296
  external_type_display_name: {
18297
+ description: string;
18148
18298
  type: string;
18149
18299
  };
18150
18300
  is_managed: {
@@ -18152,9 +18302,11 @@ declare const _default: {
18152
18302
  type: string;
18153
18303
  };
18154
18304
  name: {
18305
+ description: string;
18155
18306
  type: string;
18156
18307
  };
18157
18308
  workspace_id: {
18309
+ description: string;
18158
18310
  format: string;
18159
18311
  type: string;
18160
18312
  };
@@ -18203,6 +18355,7 @@ declare const _default: {
18203
18355
  };
18204
18356
  '/acs/access_groups/unmanaged/list': {
18205
18357
  post: {
18358
+ description: string;
18206
18359
  operationId: string;
18207
18360
  requestBody: {
18208
18361
  content: {
@@ -18210,10 +18363,12 @@ declare const _default: {
18210
18363
  schema: {
18211
18364
  properties: {
18212
18365
  acs_system_id: {
18366
+ description: string;
18213
18367
  format: string;
18214
18368
  type: string;
18215
18369
  };
18216
18370
  acs_user_id: {
18371
+ description: string;
18217
18372
  format: string;
18218
18373
  type: string;
18219
18374
  };
@@ -18244,14 +18399,17 @@ declare const _default: {
18244
18399
  'x-deprecated': string;
18245
18400
  };
18246
18401
  acs_access_group_id: {
18402
+ description: string;
18247
18403
  format: string;
18248
18404
  type: string;
18249
18405
  };
18250
18406
  acs_system_id: {
18407
+ description: string;
18251
18408
  format: string;
18252
18409
  type: string;
18253
18410
  };
18254
18411
  created_at: {
18412
+ description: string;
18255
18413
  format: string;
18256
18414
  type: string;
18257
18415
  };
@@ -18259,10 +18417,12 @@ declare const _default: {
18259
18417
  type: string;
18260
18418
  };
18261
18419
  external_type: {
18420
+ description: string;
18262
18421
  enum: string[];
18263
18422
  type: string;
18264
18423
  };
18265
18424
  external_type_display_name: {
18425
+ description: string;
18266
18426
  type: string;
18267
18427
  };
18268
18428
  is_managed: {
@@ -18270,9 +18430,11 @@ declare const _default: {
18270
18430
  type: string;
18271
18431
  };
18272
18432
  name: {
18433
+ description: string;
18273
18434
  type: string;
18274
18435
  };
18275
18436
  workspace_id: {
18437
+ description: string;
18276
18438
  format: string;
18277
18439
  type: string;
18278
18440
  };
@@ -33751,7 +33913,9 @@ interface Routes {
33751
33913
  queryParams: {};
33752
33914
  jsonBody: {};
33753
33915
  commonParams: {
33916
+ /** ID of the desired access group. */
33754
33917
  acs_access_group_id: string;
33918
+ /** ID of the desired user. */
33755
33919
  acs_user_id: string;
33756
33920
  };
33757
33921
  formData: {};
@@ -33763,14 +33927,24 @@ interface Routes {
33763
33927
  queryParams: {};
33764
33928
  jsonBody: {};
33765
33929
  commonParams: {
33930
+ /** ID of the desired access group. */
33766
33931
  acs_access_group_id: string;
33767
33932
  };
33768
33933
  formData: {};
33769
33934
  jsonResponse: {
33935
+ /**
33936
+ Group that defines the entrances to which a set of users has access and, in some cases, the access schedule for these entrances and users.
33937
+
33938
+ The `acs_access_group` object represents an [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups) within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems).
33939
+ */
33770
33940
  acs_access_group: {
33941
+ /** ID of the access group. */
33771
33942
  acs_access_group_id: string;
33943
+ /** ID of the access control system that contains the access group. */
33772
33944
  acs_system_id: string;
33945
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the access group. */
33773
33946
  workspace_id: string;
33947
+ /** Name of the access group. */
33774
33948
  name: string;
33775
33949
  /**
33776
33950
  * @deprecated use external_type */
@@ -33779,8 +33953,11 @@ interface Routes {
33779
33953
  * @deprecated use external_type_display_name */
33780
33954
  access_group_type_display_name: string;
33781
33955
  display_name: string;
33956
+ /** Brand-specific terminology for the access group type. */
33782
33957
  external_type: 'pti_unit' | 'pti_access_level' | 'salto_access_group' | 'brivo_group';
33958
+ /** Display name that corresponds to the brand-specific terminology for the access group type. */
33783
33959
  external_type_display_name: string;
33960
+ /** Date and time at which the access group was created. */
33784
33961
  created_at: string;
33785
33962
  is_managed: true;
33786
33963
  };
@@ -33792,15 +33969,21 @@ interface Routes {
33792
33969
  queryParams: {};
33793
33970
  jsonBody: {};
33794
33971
  commonParams: {
33972
+ /** ID of the access control system for which you want to retrieve all access groups. */
33795
33973
  acs_system_id?: string | undefined;
33974
+ /** ID of the user for which you want to retrieve all access groups. */
33796
33975
  acs_user_id?: string | undefined;
33797
33976
  };
33798
33977
  formData: {};
33799
33978
  jsonResponse: {
33800
33979
  acs_access_groups: Array<{
33980
+ /** ID of the access group. */
33801
33981
  acs_access_group_id: string;
33982
+ /** ID of the access control system that contains the access group. */
33802
33983
  acs_system_id: string;
33984
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the access group. */
33803
33985
  workspace_id: string;
33986
+ /** Name of the access group. */
33804
33987
  name: string;
33805
33988
  /**
33806
33989
  * @deprecated use external_type */
@@ -33809,8 +33992,11 @@ interface Routes {
33809
33992
  * @deprecated use external_type_display_name */
33810
33993
  access_group_type_display_name: string;
33811
33994
  display_name: string;
33995
+ /** Brand-specific terminology for the access group type. */
33812
33996
  external_type: 'pti_unit' | 'pti_access_level' | 'salto_access_group' | 'brivo_group';
33997
+ /** Display name that corresponds to the brand-specific terminology for the access group type. */
33813
33998
  external_type_display_name: string;
33999
+ /** Date and time at which the access group was created. */
33814
34000
  created_at: string;
33815
34001
  is_managed: true;
33816
34002
  }>;
@@ -33822,6 +34008,7 @@ interface Routes {
33822
34008
  queryParams: {};
33823
34009
  jsonBody: {};
33824
34010
  commonParams: {
34011
+ /** ID of the access group for which you want to retrieve all accessible entrances. */
33825
34012
  acs_access_group_id: string;
33826
34013
  };
33827
34014
  formData: {};
@@ -33872,6 +34059,7 @@ interface Routes {
33872
34059
  queryParams: {};
33873
34060
  jsonBody: {};
33874
34061
  commonParams: {
34062
+ /** ID of the access group for which you want to retrieve all users. */
33875
34063
  acs_access_group_id: string;
33876
34064
  };
33877
34065
  formData: {};
@@ -33972,7 +34160,9 @@ interface Routes {
33972
34160
  queryParams: {};
33973
34161
  jsonBody: {};
33974
34162
  commonParams: {
34163
+ /** ID of the desired access group. */
33975
34164
  acs_access_group_id: string;
34165
+ /** ID of the desired user. */
33976
34166
  acs_user_id: string;
33977
34167
  };
33978
34168
  formData: {};
@@ -33984,14 +34174,19 @@ interface Routes {
33984
34174
  queryParams: {};
33985
34175
  jsonBody: {};
33986
34176
  commonParams: {
34177
+ /** ID of the desired unmanaged access group. */
33987
34178
  acs_access_group_id: string;
33988
34179
  };
33989
34180
  formData: {};
33990
34181
  jsonResponse: {
33991
34182
  acs_access_group: {
34183
+ /** ID of the access group. */
33992
34184
  acs_access_group_id: string;
34185
+ /** ID of the access control system that contains the access group. */
33993
34186
  acs_system_id: string;
34187
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the access group. */
33994
34188
  workspace_id: string;
34189
+ /** Name of the access group. */
33995
34190
  name: string;
33996
34191
  /**
33997
34192
  * @deprecated use external_type */
@@ -34000,8 +34195,11 @@ interface Routes {
34000
34195
  * @deprecated use external_type_display_name */
34001
34196
  access_group_type_display_name: string;
34002
34197
  display_name: string;
34198
+ /** Brand-specific terminology for the access group type. */
34003
34199
  external_type: 'pti_unit' | 'pti_access_level' | 'salto_access_group' | 'brivo_group';
34200
+ /** Display name that corresponds to the brand-specific terminology for the access group type. */
34004
34201
  external_type_display_name: string;
34202
+ /** Date and time at which the access group was created. */
34005
34203
  created_at: string;
34006
34204
  is_managed: false;
34007
34205
  };
@@ -34013,15 +34211,21 @@ interface Routes {
34013
34211
  queryParams: {};
34014
34212
  jsonBody: {};
34015
34213
  commonParams: {
34214
+ /** ID of the access control system for which you want to retrieve all unmanaged access groups. */
34016
34215
  acs_system_id?: string | undefined;
34216
+ /** ID of the user for which you want to retrieve all unmanaged access groups. */
34017
34217
  acs_user_id?: string | undefined;
34018
34218
  };
34019
34219
  formData: {};
34020
34220
  jsonResponse: {
34021
34221
  acs_access_groups: Array<{
34222
+ /** ID of the access group. */
34022
34223
  acs_access_group_id: string;
34224
+ /** ID of the access control system that contains the access group. */
34023
34225
  acs_system_id: string;
34226
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the access group. */
34024
34227
  workspace_id: string;
34228
+ /** Name of the access group. */
34025
34229
  name: string;
34026
34230
  /**
34027
34231
  * @deprecated use external_type */
@@ -34030,8 +34234,11 @@ interface Routes {
34030
34234
  * @deprecated use external_type_display_name */
34031
34235
  access_group_type_display_name: string;
34032
34236
  display_name: string;
34237
+ /** Brand-specific terminology for the access group type. */
34033
34238
  external_type: 'pti_unit' | 'pti_access_level' | 'salto_access_group' | 'brivo_group';
34239
+ /** Display name that corresponds to the brand-specific terminology for the access group type. */
34034
34240
  external_type_display_name: string;
34241
+ /** Date and time at which the access group was created. */
34035
34242
  created_at: string;
34036
34243
  is_managed: false;
34037
34244
  }>;
@@ -35402,6 +35609,10 @@ interface Routes {
35402
35609
  device_name: string;
35403
35610
  model_number: string;
35404
35611
  } | undefined;
35612
+ /**
35613
+ ---
35614
+ deprecated: Use `salto_ks_metadata ` instead.
35615
+ */
35405
35616
  salto_metadata?: {
35406
35617
  lock_id: string;
35407
35618
  customer_reference: string;
@@ -35410,6 +35621,14 @@ interface Routes {
35410
35621
  locked_state: string;
35411
35622
  model?: string | undefined;
35412
35623
  } | undefined;
35624
+ salto_ks_metadata?: {
35625
+ lock_id: string;
35626
+ customer_reference: string;
35627
+ lock_type: string;
35628
+ battery_level: string;
35629
+ locked_state: string;
35630
+ model?: string | undefined;
35631
+ } | undefined;
35413
35632
  genie_metadata?: {
35414
35633
  device_name: string;
35415
35634
  door_name: string;
@@ -39378,6 +39597,10 @@ interface Routes {
39378
39597
  device_name: string;
39379
39598
  model_number: string;
39380
39599
  } | undefined;
39600
+ /**
39601
+ ---
39602
+ deprecated: Use `salto_ks_metadata ` instead.
39603
+ */
39381
39604
  salto_metadata?: {
39382
39605
  lock_id: string;
39383
39606
  customer_reference: string;
@@ -39386,6 +39609,14 @@ interface Routes {
39386
39609
  locked_state: string;
39387
39610
  model?: string | undefined;
39388
39611
  } | undefined;
39612
+ salto_ks_metadata?: {
39613
+ lock_id: string;
39614
+ customer_reference: string;
39615
+ lock_type: string;
39616
+ battery_level: string;
39617
+ locked_state: string;
39618
+ model?: string | undefined;
39619
+ } | undefined;
39389
39620
  genie_metadata?: {
39390
39621
  device_name: string;
39391
39622
  door_name: string;
@@ -39844,6 +40075,10 @@ interface Routes {
39844
40075
  device_name: string;
39845
40076
  model_number: string;
39846
40077
  } | undefined;
40078
+ /**
40079
+ ---
40080
+ deprecated: Use `salto_ks_metadata ` instead.
40081
+ */
39847
40082
  salto_metadata?: {
39848
40083
  lock_id: string;
39849
40084
  customer_reference: string;
@@ -39852,6 +40087,14 @@ interface Routes {
39852
40087
  locked_state: string;
39853
40088
  model?: string | undefined;
39854
40089
  } | undefined;
40090
+ salto_ks_metadata?: {
40091
+ lock_id: string;
40092
+ customer_reference: string;
40093
+ lock_type: string;
40094
+ battery_level: string;
40095
+ locked_state: string;
40096
+ model?: string | undefined;
40097
+ } | undefined;
39855
40098
  genie_metadata?: {
39856
40099
  device_name: string;
39857
40100
  door_name: string;
@@ -40710,6 +40953,10 @@ interface Routes {
40710
40953
  device_name: string;
40711
40954
  model_number: string;
40712
40955
  } | undefined;
40956
+ /**
40957
+ ---
40958
+ deprecated: Use `salto_ks_metadata ` instead.
40959
+ */
40713
40960
  salto_metadata?: {
40714
40961
  lock_id: string;
40715
40962
  customer_reference: string;
@@ -40718,6 +40965,14 @@ interface Routes {
40718
40965
  locked_state: string;
40719
40966
  model?: string | undefined;
40720
40967
  } | undefined;
40968
+ salto_ks_metadata?: {
40969
+ lock_id: string;
40970
+ customer_reference: string;
40971
+ lock_type: string;
40972
+ battery_level: string;
40973
+ locked_state: string;
40974
+ model?: string | undefined;
40975
+ } | undefined;
40721
40976
  genie_metadata?: {
40722
40977
  device_name: string;
40723
40978
  door_name: string;
@@ -41151,6 +41406,10 @@ interface Routes {
41151
41406
  device_name: string;
41152
41407
  model_number: string;
41153
41408
  } | undefined;
41409
+ /**
41410
+ ---
41411
+ deprecated: Use `salto_ks_metadata ` instead.
41412
+ */
41154
41413
  salto_metadata?: {
41155
41414
  lock_id: string;
41156
41415
  customer_reference: string;
@@ -41159,6 +41418,14 @@ interface Routes {
41159
41418
  locked_state: string;
41160
41419
  model?: string | undefined;
41161
41420
  } | undefined;
41421
+ salto_ks_metadata?: {
41422
+ lock_id: string;
41423
+ customer_reference: string;
41424
+ lock_type: string;
41425
+ battery_level: string;
41426
+ locked_state: string;
41427
+ model?: string | undefined;
41428
+ } | undefined;
41162
41429
  genie_metadata?: {
41163
41430
  device_name: string;
41164
41431
  door_name: string;
@@ -41617,6 +41884,10 @@ interface Routes {
41617
41884
  device_name: string;
41618
41885
  model_number: string;
41619
41886
  } | undefined;
41887
+ /**
41888
+ ---
41889
+ deprecated: Use `salto_ks_metadata ` instead.
41890
+ */
41620
41891
  salto_metadata?: {
41621
41892
  lock_id: string;
41622
41893
  customer_reference: string;
@@ -41625,6 +41896,14 @@ interface Routes {
41625
41896
  locked_state: string;
41626
41897
  model?: string | undefined;
41627
41898
  } | undefined;
41899
+ salto_ks_metadata?: {
41900
+ lock_id: string;
41901
+ customer_reference: string;
41902
+ lock_type: string;
41903
+ battery_level: string;
41904
+ locked_state: string;
41905
+ model?: string | undefined;
41906
+ } | undefined;
41628
41907
  genie_metadata?: {
41629
41908
  device_name: string;
41630
41909
  door_name: string;
@@ -42058,6 +42337,10 @@ interface Routes {
42058
42337
  device_name: string;
42059
42338
  model_number: string;
42060
42339
  } | undefined;
42340
+ /**
42341
+ ---
42342
+ deprecated: Use `salto_ks_metadata ` instead.
42343
+ */
42061
42344
  salto_metadata?: {
42062
42345
  lock_id: string;
42063
42346
  customer_reference: string;
@@ -42066,6 +42349,14 @@ interface Routes {
42066
42349
  locked_state: string;
42067
42350
  model?: string | undefined;
42068
42351
  } | undefined;
42352
+ salto_ks_metadata?: {
42353
+ lock_id: string;
42354
+ customer_reference: string;
42355
+ lock_type: string;
42356
+ battery_level: string;
42357
+ locked_state: string;
42358
+ model?: string | undefined;
42359
+ } | undefined;
42069
42360
  genie_metadata?: {
42070
42361
  device_name: string;
42071
42362
  door_name: string;
@@ -43844,6 +44135,10 @@ interface Routes {
43844
44135
  device_name: string;
43845
44136
  model_number: string;
43846
44137
  } | undefined;
44138
+ /**
44139
+ ---
44140
+ deprecated: Use `salto_ks_metadata ` instead.
44141
+ */
43847
44142
  salto_metadata?: {
43848
44143
  lock_id: string;
43849
44144
  customer_reference: string;
@@ -43852,6 +44147,14 @@ interface Routes {
43852
44147
  locked_state: string;
43853
44148
  model?: string | undefined;
43854
44149
  } | undefined;
44150
+ salto_ks_metadata?: {
44151
+ lock_id: string;
44152
+ customer_reference: string;
44153
+ lock_type: string;
44154
+ battery_level: string;
44155
+ locked_state: string;
44156
+ model?: string | undefined;
44157
+ } | undefined;
43855
44158
  genie_metadata?: {
43856
44159
  device_name: string;
43857
44160
  door_name: string;
@@ -44285,6 +44588,10 @@ interface Routes {
44285
44588
  device_name: string;
44286
44589
  model_number: string;
44287
44590
  } | undefined;
44591
+ /**
44592
+ ---
44593
+ deprecated: Use `salto_ks_metadata ` instead.
44594
+ */
44288
44595
  salto_metadata?: {
44289
44596
  lock_id: string;
44290
44597
  customer_reference: string;
@@ -44293,6 +44600,14 @@ interface Routes {
44293
44600
  locked_state: string;
44294
44601
  model?: string | undefined;
44295
44602
  } | undefined;
44603
+ salto_ks_metadata?: {
44604
+ lock_id: string;
44605
+ customer_reference: string;
44606
+ lock_type: string;
44607
+ battery_level: string;
44608
+ locked_state: string;
44609
+ model?: string | undefined;
44610
+ } | undefined;
44296
44611
  genie_metadata?: {
44297
44612
  device_name: string;
44298
44613
  door_name: string;
@@ -48234,6 +48549,10 @@ interface Routes {
48234
48549
  device_name: string;
48235
48550
  model_number: string;
48236
48551
  } | undefined;
48552
+ /**
48553
+ ---
48554
+ deprecated: Use `salto_ks_metadata ` instead.
48555
+ */
48237
48556
  salto_metadata?: {
48238
48557
  lock_id: string;
48239
48558
  customer_reference: string;
@@ -48242,6 +48561,14 @@ interface Routes {
48242
48561
  locked_state: string;
48243
48562
  model?: string | undefined;
48244
48563
  } | undefined;
48564
+ salto_ks_metadata?: {
48565
+ lock_id: string;
48566
+ customer_reference: string;
48567
+ lock_type: string;
48568
+ battery_level: string;
48569
+ locked_state: string;
48570
+ model?: string | undefined;
48571
+ } | undefined;
48245
48572
  genie_metadata?: {
48246
48573
  device_name: string;
48247
48574
  door_name: string;
@@ -49992,6 +50319,10 @@ interface Routes {
49992
50319
  device_name: string;
49993
50320
  model_number: string;
49994
50321
  } | undefined;
50322
+ /**
50323
+ ---
50324
+ deprecated: Use `salto_ks_metadata ` instead.
50325
+ */
49995
50326
  salto_metadata?: {
49996
50327
  lock_id: string;
49997
50328
  customer_reference: string;
@@ -50000,6 +50331,14 @@ interface Routes {
50000
50331
  locked_state: string;
50001
50332
  model?: string | undefined;
50002
50333
  } | undefined;
50334
+ salto_ks_metadata?: {
50335
+ lock_id: string;
50336
+ customer_reference: string;
50337
+ lock_type: string;
50338
+ battery_level: string;
50339
+ locked_state: string;
50340
+ model?: string | undefined;
50341
+ } | undefined;
50003
50342
  genie_metadata?: {
50004
50343
  device_name: string;
50005
50344
  door_name: string;
@@ -50433,6 +50772,10 @@ interface Routes {
50433
50772
  device_name: string;
50434
50773
  model_number: string;
50435
50774
  } | undefined;
50775
+ /**
50776
+ ---
50777
+ deprecated: Use `salto_ks_metadata ` instead.
50778
+ */
50436
50779
  salto_metadata?: {
50437
50780
  lock_id: string;
50438
50781
  customer_reference: string;
@@ -50441,6 +50784,14 @@ interface Routes {
50441
50784
  locked_state: string;
50442
50785
  model?: string | undefined;
50443
50786
  } | undefined;
50787
+ salto_ks_metadata?: {
50788
+ lock_id: string;
50789
+ customer_reference: string;
50790
+ lock_type: string;
50791
+ battery_level: string;
50792
+ locked_state: string;
50793
+ model?: string | undefined;
50794
+ } | undefined;
50444
50795
  genie_metadata?: {
50445
50796
  device_name: string;
50446
50797
  door_name: string;
@@ -52492,6 +52843,10 @@ interface Routes {
52492
52843
  device_name: string;
52493
52844
  model_number: string;
52494
52845
  } | undefined;
52846
+ /**
52847
+ ---
52848
+ deprecated: Use `salto_ks_metadata ` instead.
52849
+ */
52495
52850
  salto_metadata?: {
52496
52851
  lock_id: string;
52497
52852
  customer_reference: string;
@@ -52500,6 +52855,14 @@ interface Routes {
52500
52855
  locked_state: string;
52501
52856
  model?: string | undefined;
52502
52857
  } | undefined;
52858
+ salto_ks_metadata?: {
52859
+ lock_id: string;
52860
+ customer_reference: string;
52861
+ lock_type: string;
52862
+ battery_level: string;
52863
+ locked_state: string;
52864
+ model?: string | undefined;
52865
+ } | undefined;
52503
52866
  genie_metadata?: {
52504
52867
  device_name: string;
52505
52868
  door_name: string;
@@ -52935,6 +53298,10 @@ interface Routes {
52935
53298
  device_name: string;
52936
53299
  model_number: string;
52937
53300
  } | undefined;
53301
+ /**
53302
+ ---
53303
+ deprecated: Use `salto_ks_metadata ` instead.
53304
+ */
52938
53305
  salto_metadata?: {
52939
53306
  lock_id: string;
52940
53307
  customer_reference: string;
@@ -52943,6 +53310,14 @@ interface Routes {
52943
53310
  locked_state: string;
52944
53311
  model?: string | undefined;
52945
53312
  } | undefined;
53313
+ salto_ks_metadata?: {
53314
+ lock_id: string;
53315
+ customer_reference: string;
53316
+ lock_type: string;
53317
+ battery_level: string;
53318
+ locked_state: string;
53319
+ model?: string | undefined;
53320
+ } | undefined;
52946
53321
  genie_metadata?: {
52947
53322
  device_name: string;
52948
53323
  door_name: string;