@seamapi/types 1.307.0 → 1.308.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 (29) hide show
  1. package/dist/connect.cjs +69 -39
  2. package/dist/connect.cjs.map +1 -1
  3. package/dist/connect.d.cts +137 -113
  4. package/lib/seam/connect/models/acs/acs-access-group.d.ts +13 -13
  5. package/lib/seam/connect/models/acs/acs-access-group.js +1 -1
  6. package/lib/seam/connect/models/acs/acs-access-group.js.map +1 -1
  7. package/lib/seam/connect/models/acs/acs-system.d.ts +34 -13
  8. package/lib/seam/connect/models/acs/acs-system.js +11 -4
  9. package/lib/seam/connect/models/acs/acs-system.js.map +1 -1
  10. package/lib/seam/connect/models/devices/device-metadata.d.ts +5 -10
  11. package/lib/seam/connect/models/devices/device-metadata.js +1 -2
  12. package/lib/seam/connect/models/devices/device-metadata.js.map +1 -1
  13. package/lib/seam/connect/models/devices/device-provider.d.ts +2 -1
  14. package/lib/seam/connect/models/devices/device-provider.js +2 -0
  15. package/lib/seam/connect/models/devices/device-provider.js.map +1 -1
  16. package/lib/seam/connect/models/devices/device.d.ts +7 -14
  17. package/lib/seam/connect/models/devices/phone.d.ts +5 -10
  18. package/lib/seam/connect/models/devices/unmanaged-device.d.ts +5 -10
  19. package/lib/seam/connect/openapi.d.ts +20 -21
  20. package/lib/seam/connect/openapi.js +52 -29
  21. package/lib/seam/connect/openapi.js.map +1 -1
  22. package/lib/seam/connect/route-types.d.ts +59 -44
  23. package/package.json +1 -1
  24. package/src/lib/seam/connect/models/acs/acs-access-group.ts +1 -1
  25. package/src/lib/seam/connect/models/acs/acs-system.ts +15 -5
  26. package/src/lib/seam/connect/models/devices/device-metadata.ts +1 -2
  27. package/src/lib/seam/connect/models/devices/device-provider.ts +2 -0
  28. package/src/lib/seam/connect/openapi.ts +58 -32
  29. package/src/lib/seam/connect/route-types.ts +103 -66
@@ -4856,7 +4856,7 @@ export interface Routes {
4856
4856
  access_group_type:
4857
4857
  | 'pti_unit'
4858
4858
  | 'pti_access_level'
4859
- | 'salto_access_group'
4859
+ | 'salto_ks_access_group'
4860
4860
  | 'brivo_group'
4861
4861
  /**
4862
4862
  * @deprecated Use `external_type_display_name`. */
@@ -4866,7 +4866,7 @@ export interface Routes {
4866
4866
  external_type:
4867
4867
  | 'pti_unit'
4868
4868
  | 'pti_access_level'
4869
- | 'salto_access_group'
4869
+ | 'salto_ks_access_group'
4870
4870
  | 'brivo_group'
4871
4871
  /** Display name that corresponds to the brand-specific terminology for the access group type. */
4872
4872
  external_type_display_name: string
@@ -4903,7 +4903,7 @@ export interface Routes {
4903
4903
  access_group_type:
4904
4904
  | 'pti_unit'
4905
4905
  | 'pti_access_level'
4906
- | 'salto_access_group'
4906
+ | 'salto_ks_access_group'
4907
4907
  | 'brivo_group'
4908
4908
  /**
4909
4909
  * @deprecated Use `external_type_display_name`. */
@@ -4913,7 +4913,7 @@ export interface Routes {
4913
4913
  external_type:
4914
4914
  | 'pti_unit'
4915
4915
  | 'pti_access_level'
4916
- | 'salto_access_group'
4916
+ | 'salto_ks_access_group'
4917
4917
  | 'brivo_group'
4918
4918
  /** Display name that corresponds to the brand-specific terminology for the access group type. */
4919
4919
  external_type_display_name: string
@@ -5167,7 +5167,7 @@ export interface Routes {
5167
5167
  access_group_type:
5168
5168
  | 'pti_unit'
5169
5169
  | 'pti_access_level'
5170
- | 'salto_access_group'
5170
+ | 'salto_ks_access_group'
5171
5171
  | 'brivo_group'
5172
5172
  /**
5173
5173
  * @deprecated Use `external_type_display_name`. */
@@ -5177,7 +5177,7 @@ export interface Routes {
5177
5177
  external_type:
5178
5178
  | 'pti_unit'
5179
5179
  | 'pti_access_level'
5180
- | 'salto_access_group'
5180
+ | 'salto_ks_access_group'
5181
5181
  | 'brivo_group'
5182
5182
  /** Display name that corresponds to the brand-specific terminology for the access group type. */
5183
5183
  external_type_display_name: string
@@ -5214,7 +5214,7 @@ export interface Routes {
5214
5214
  access_group_type:
5215
5215
  | 'pti_unit'
5216
5216
  | 'pti_access_level'
5217
- | 'salto_access_group'
5217
+ | 'salto_ks_access_group'
5218
5218
  | 'brivo_group'
5219
5219
  /**
5220
5220
  * @deprecated Use `external_type_display_name`. */
@@ -5224,7 +5224,7 @@ export interface Routes {
5224
5224
  external_type:
5225
5225
  | 'pti_unit'
5226
5226
  | 'pti_access_level'
5227
- | 'salto_access_group'
5227
+ | 'salto_ks_access_group'
5228
5228
  | 'brivo_group'
5229
5229
  /** Display name that corresponds to the brand-specific terminology for the access group type. */
5230
5230
  external_type_display_name: string
@@ -8926,6 +8926,7 @@ export interface Routes {
8926
8926
  | 'pti_site'
8927
8927
  | 'alta_org'
8928
8928
  | 'salto_ks_site'
8929
+ | 'salto_space_system'
8929
8930
  | 'brivo_account'
8930
8931
  | 'hid_credential_manager_organization'
8931
8932
  | 'visionline_system'
@@ -8958,6 +8959,7 @@ export interface Routes {
8958
8959
  | 'pti_site'
8959
8960
  | 'alta_org'
8960
8961
  | 'salto_ks_site'
8962
+ | 'salto_space_system'
8961
8963
  | 'brivo_account'
8962
8964
  | 'hid_credential_manager_organization'
8963
8965
  | 'visionline_system'
@@ -9040,14 +9042,24 @@ export interface Routes {
9040
9042
  }
9041
9043
  >
9042
9044
  /** Warnings associated with the `acs_system`. */
9043
- warnings: Array<{
9044
- /** Date and time at which Seam created the warning. */
9045
- created_at: string
9046
- /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
9047
- message: string
9048
- /** Indicates that the Salto KS site has exceeded 80% of the maximum number of allowed users. Please increase your subscription limit, or delete some users from your site to rectify this. */
9049
- warning_code: 'salto_ks_subscription_limit_almost_reached'
9050
- }>
9045
+ warnings: Array<
9046
+ | {
9047
+ /** Date and time at which Seam created the warning. */
9048
+ created_at: string
9049
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
9050
+ message: string
9051
+ /** Indicates that the Salto KS site has exceeded 80% of the maximum number of allowed users. Please increase your subscription limit, or delete some users from your site to rectify this. */
9052
+ warning_code: 'salto_ks_subscription_limit_almost_reached'
9053
+ }
9054
+ | {
9055
+ /** Date and time at which Seam created the warning. */
9056
+ created_at: string
9057
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
9058
+ message: string
9059
+ /** Indicates the ACS system time zone could not be determined because the reported physical location does not match the time zone configured on the physical ACS entrances. */
9060
+ warning_code: 'time_zone_does_not_match_location'
9061
+ }
9062
+ >
9051
9063
  /** Indicates whether it is possible to [launch enrollment automations](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system#prepare-the-phones-for-a-user-identity-to-start-receiving-mobile-credentials-using-an-enrollment-aut) for the `acs_system`. */
9052
9064
  can_automate_enrollment?: boolean | undefined
9053
9065
  /** Indicates whether the `acs_system` supports creating [access groups](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). See also [Access Group-based Access Control Systems](https://docs.seam.co/latest/capability-guides/access-systems/understanding-access-control-system-differences#access-group-based-access-control-systems). */
@@ -9081,6 +9093,7 @@ export interface Routes {
9081
9093
  | 'pti_site'
9082
9094
  | 'alta_org'
9083
9095
  | 'salto_ks_site'
9096
+ | 'salto_space_system'
9084
9097
  | 'brivo_account'
9085
9098
  | 'hid_credential_manager_organization'
9086
9099
  | 'visionline_system'
@@ -9113,6 +9126,7 @@ export interface Routes {
9113
9126
  | 'pti_site'
9114
9127
  | 'alta_org'
9115
9128
  | 'salto_ks_site'
9129
+ | 'salto_space_system'
9116
9130
  | 'brivo_account'
9117
9131
  | 'hid_credential_manager_organization'
9118
9132
  | 'visionline_system'
@@ -9195,14 +9209,24 @@ export interface Routes {
9195
9209
  }
9196
9210
  >
9197
9211
  /** Warnings associated with the `acs_system`. */
9198
- warnings: Array<{
9199
- /** Date and time at which Seam created the warning. */
9200
- created_at: string
9201
- /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
9202
- message: string
9203
- /** Indicates that the Salto KS site has exceeded 80% of the maximum number of allowed users. Please increase your subscription limit, or delete some users from your site to rectify this. */
9204
- warning_code: 'salto_ks_subscription_limit_almost_reached'
9205
- }>
9212
+ warnings: Array<
9213
+ | {
9214
+ /** Date and time at which Seam created the warning. */
9215
+ created_at: string
9216
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
9217
+ message: string
9218
+ /** Indicates that the Salto KS site has exceeded 80% of the maximum number of allowed users. Please increase your subscription limit, or delete some users from your site to rectify this. */
9219
+ warning_code: 'salto_ks_subscription_limit_almost_reached'
9220
+ }
9221
+ | {
9222
+ /** Date and time at which Seam created the warning. */
9223
+ created_at: string
9224
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
9225
+ message: string
9226
+ /** Indicates the ACS system time zone could not be determined because the reported physical location does not match the time zone configured on the physical ACS entrances. */
9227
+ warning_code: 'time_zone_does_not_match_location'
9228
+ }
9229
+ >
9206
9230
  /** Indicates whether it is possible to [launch enrollment automations](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system#prepare-the-phones-for-a-user-identity-to-start-receiving-mobile-credentials-using-an-enrollment-aut) for the `acs_system`. */
9207
9231
  can_automate_enrollment?: boolean | undefined
9208
9232
  /** Indicates whether the `acs_system` supports creating [access groups](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). See also [Access Group-based Access Control Systems](https://docs.seam.co/latest/capability-guides/access-systems/understanding-access-control-system-differences#access-group-based-access-control-systems). */
@@ -9236,6 +9260,7 @@ export interface Routes {
9236
9260
  | 'pti_site'
9237
9261
  | 'alta_org'
9238
9262
  | 'salto_ks_site'
9263
+ | 'salto_space_system'
9239
9264
  | 'brivo_account'
9240
9265
  | 'hid_credential_manager_organization'
9241
9266
  | 'visionline_system'
@@ -9268,6 +9293,7 @@ export interface Routes {
9268
9293
  | 'pti_site'
9269
9294
  | 'alta_org'
9270
9295
  | 'salto_ks_site'
9296
+ | 'salto_space_system'
9271
9297
  | 'brivo_account'
9272
9298
  | 'hid_credential_manager_organization'
9273
9299
  | 'visionline_system'
@@ -9350,14 +9376,24 @@ export interface Routes {
9350
9376
  }
9351
9377
  >
9352
9378
  /** Warnings associated with the `acs_system`. */
9353
- warnings: Array<{
9354
- /** Date and time at which Seam created the warning. */
9355
- created_at: string
9356
- /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
9357
- message: string
9358
- /** Indicates that the Salto KS site has exceeded 80% of the maximum number of allowed users. Please increase your subscription limit, or delete some users from your site to rectify this. */
9359
- warning_code: 'salto_ks_subscription_limit_almost_reached'
9360
- }>
9379
+ warnings: Array<
9380
+ | {
9381
+ /** Date and time at which Seam created the warning. */
9382
+ created_at: string
9383
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
9384
+ message: string
9385
+ /** Indicates that the Salto KS site has exceeded 80% of the maximum number of allowed users. Please increase your subscription limit, or delete some users from your site to rectify this. */
9386
+ warning_code: 'salto_ks_subscription_limit_almost_reached'
9387
+ }
9388
+ | {
9389
+ /** Date and time at which Seam created the warning. */
9390
+ created_at: string
9391
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
9392
+ message: string
9393
+ /** Indicates the ACS system time zone could not be determined because the reported physical location does not match the time zone configured on the physical ACS entrances. */
9394
+ warning_code: 'time_zone_does_not_match_location'
9395
+ }
9396
+ >
9361
9397
  /** Indicates whether it is possible to [launch enrollment automations](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system#prepare-the-phones-for-a-user-identity-to-start-receiving-mobile-credentials-using-an-enrollment-aut) for the `acs_system`. */
9362
9398
  can_automate_enrollment?: boolean | undefined
9363
9399
  /** Indicates whether the `acs_system` supports creating [access groups](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). See also [Access Group-based Access Control Systems](https://docs.seam.co/latest/capability-guides/access-systems/understanding-access-control-system-differences#access-group-based-access-control-systems). */
@@ -12459,6 +12495,7 @@ export interface Routes {
12459
12495
  | 'assa_abloy_vostio'
12460
12496
  | 'assa_abloy_vostio_credential_service'
12461
12497
  | 'tado'
12498
+ | 'salto_space'
12462
12499
  | 'yale_access'
12463
12500
  | 'hid_cm'
12464
12501
  | 'google_nest'
@@ -13190,8 +13227,7 @@ export interface Routes {
13190
13227
  | undefined
13191
13228
  tado_metadata?:
13192
13229
  | {
13193
- serial_number: string
13194
- device_name: string
13230
+ serial_no: string
13195
13231
  device_type: string
13196
13232
  }
13197
13233
  | undefined
@@ -14077,8 +14113,7 @@ export interface Routes {
14077
14113
  | undefined
14078
14114
  tado_metadata?:
14079
14115
  | {
14080
- serial_number: string
14081
- device_name: string
14116
+ serial_no: string
14082
14117
  device_type: string
14083
14118
  }
14084
14119
  | undefined
@@ -14410,6 +14445,7 @@ export interface Routes {
14410
14445
  | 'assa_abloy_vostio'
14411
14446
  | 'assa_abloy_vostio_credential_service'
14412
14447
  | 'tado'
14448
+ | 'salto_space'
14413
14449
  display_name: string
14414
14450
  image_url: string
14415
14451
  provider_categories: Array<
@@ -15683,8 +15719,7 @@ export interface Routes {
15683
15719
  | undefined
15684
15720
  tado_metadata?:
15685
15721
  | {
15686
- serial_number: string
15687
- device_name: string
15722
+ serial_no: string
15688
15723
  device_type: string
15689
15724
  }
15690
15725
  | undefined
@@ -16386,8 +16421,7 @@ export interface Routes {
16386
16421
  | undefined
16387
16422
  tado_metadata?:
16388
16423
  | {
16389
- serial_number: string
16390
- device_name: string
16424
+ serial_no: string
16391
16425
  device_type: string
16392
16426
  }
16393
16427
  | undefined
@@ -17273,8 +17307,7 @@ export interface Routes {
17273
17307
  | undefined
17274
17308
  tado_metadata?:
17275
17309
  | {
17276
- serial_number: string
17277
- device_name: string
17310
+ serial_no: string
17278
17311
  device_type: string
17279
17312
  }
17280
17313
  | undefined
@@ -17976,8 +18009,7 @@ export interface Routes {
17976
18009
  | undefined
17977
18010
  tado_metadata?:
17978
18011
  | {
17979
- serial_number: string
17980
- device_name: string
18012
+ serial_no: string
17981
18013
  device_type: string
17982
18014
  }
17983
18015
  | undefined
@@ -20945,8 +20977,7 @@ export interface Routes {
20945
20977
  | undefined
20946
20978
  tado_metadata?:
20947
20979
  | {
20948
- serial_number: string
20949
- device_name: string
20980
+ serial_no: string
20950
20981
  device_type: string
20951
20982
  }
20952
20983
  | undefined
@@ -21648,8 +21679,7 @@ export interface Routes {
21648
21679
  | undefined
21649
21680
  tado_metadata?:
21650
21681
  | {
21651
- serial_number: string
21652
- device_name: string
21682
+ serial_no: string
21653
21683
  device_type: string
21654
21684
  }
21655
21685
  | undefined
@@ -27807,8 +27837,7 @@ export interface Routes {
27807
27837
  | undefined
27808
27838
  tado_metadata?:
27809
27839
  | {
27810
- serial_number: string
27811
- device_name: string
27840
+ serial_no: string
27812
27841
  device_type: string
27813
27842
  }
27814
27843
  | undefined
@@ -30758,8 +30787,7 @@ export interface Routes {
30758
30787
  | undefined
30759
30788
  tado_metadata?:
30760
30789
  | {
30761
- serial_number: string
30762
- device_name: string
30790
+ serial_no: string
30763
30791
  device_type: string
30764
30792
  }
30765
30793
  | undefined
@@ -31461,8 +31489,7 @@ export interface Routes {
31461
31489
  | undefined
31462
31490
  tado_metadata?:
31463
31491
  | {
31464
- serial_number: string
31465
- device_name: string
31492
+ serial_no: string
31466
31493
  device_type: string
31467
31494
  }
31468
31495
  | undefined
@@ -35740,8 +35767,7 @@ export interface Routes {
35740
35767
  | undefined
35741
35768
  tado_metadata?:
35742
35769
  | {
35743
- serial_number: string
35744
- device_name: string
35770
+ serial_no: string
35745
35771
  device_type: string
35746
35772
  }
35747
35773
  | undefined
@@ -36445,8 +36471,7 @@ export interface Routes {
36445
36471
  | undefined
36446
36472
  tado_metadata?:
36447
36473
  | {
36448
- serial_number: string
36449
- device_name: string
36474
+ serial_no: string
36450
36475
  device_type: string
36451
36476
  }
36452
36477
  | undefined
@@ -36736,6 +36761,7 @@ export interface Routes {
36736
36761
  | 'pti_site'
36737
36762
  | 'alta_org'
36738
36763
  | 'salto_ks_site'
36764
+ | 'salto_space_system'
36739
36765
  | 'brivo_account'
36740
36766
  | 'hid_credential_manager_organization'
36741
36767
  | 'visionline_system'
@@ -36768,6 +36794,7 @@ export interface Routes {
36768
36794
  | 'pti_site'
36769
36795
  | 'alta_org'
36770
36796
  | 'salto_ks_site'
36797
+ | 'salto_space_system'
36771
36798
  | 'brivo_account'
36772
36799
  | 'hid_credential_manager_organization'
36773
36800
  | 'visionline_system'
@@ -36850,14 +36877,24 @@ export interface Routes {
36850
36877
  }
36851
36878
  >
36852
36879
  /** Warnings associated with the `acs_system`. */
36853
- warnings: Array<{
36854
- /** Date and time at which Seam created the warning. */
36855
- created_at: string
36856
- /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
36857
- message: string
36858
- /** Indicates that the Salto KS site has exceeded 80% of the maximum number of allowed users. Please increase your subscription limit, or delete some users from your site to rectify this. */
36859
- warning_code: 'salto_ks_subscription_limit_almost_reached'
36860
- }>
36880
+ warnings: Array<
36881
+ | {
36882
+ /** Date and time at which Seam created the warning. */
36883
+ created_at: string
36884
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
36885
+ message: string
36886
+ /** Indicates that the Salto KS site has exceeded 80% of the maximum number of allowed users. Please increase your subscription limit, or delete some users from your site to rectify this. */
36887
+ warning_code: 'salto_ks_subscription_limit_almost_reached'
36888
+ }
36889
+ | {
36890
+ /** Date and time at which Seam created the warning. */
36891
+ created_at: string
36892
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
36893
+ message: string
36894
+ /** Indicates the ACS system time zone could not be determined because the reported physical location does not match the time zone configured on the physical ACS entrances. */
36895
+ warning_code: 'time_zone_does_not_match_location'
36896
+ }
36897
+ >
36861
36898
  /** Indicates whether it is possible to [launch enrollment automations](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system#prepare-the-phones-for-a-user-identity-to-start-receiving-mobile-credentials-using-an-enrollment-aut) for the `acs_system`. */
36862
36899
  can_automate_enrollment?: boolean | undefined
36863
36900
  /** Indicates whether the `acs_system` supports creating [access groups](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). See also [Access Group-based Access Control Systems](https://docs.seam.co/latest/capability-guides/access-systems/understanding-access-control-system-differences#access-group-based-access-control-systems). */