@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
@@ -4213,13 +4213,13 @@ export interface Routes {
4213
4213
  name: string;
4214
4214
  /**
4215
4215
  * @deprecated Use `external_type`. */
4216
- access_group_type: 'pti_unit' | 'pti_access_level' | 'salto_access_group' | 'brivo_group';
4216
+ access_group_type: 'pti_unit' | 'pti_access_level' | 'salto_ks_access_group' | 'brivo_group';
4217
4217
  /**
4218
4218
  * @deprecated Use `external_type_display_name`. */
4219
4219
  access_group_type_display_name: string;
4220
4220
  display_name: string;
4221
4221
  /** Brand-specific terminology for the access group type. */
4222
- external_type: 'pti_unit' | 'pti_access_level' | 'salto_access_group' | 'brivo_group';
4222
+ external_type: 'pti_unit' | 'pti_access_level' | 'salto_ks_access_group' | 'brivo_group';
4223
4223
  /** Display name that corresponds to the brand-specific terminology for the access group type. */
4224
4224
  external_type_display_name: string;
4225
4225
  /** Date and time at which the access group was created. */
@@ -4252,13 +4252,13 @@ export interface Routes {
4252
4252
  name: string;
4253
4253
  /**
4254
4254
  * @deprecated Use `external_type`. */
4255
- access_group_type: 'pti_unit' | 'pti_access_level' | 'salto_access_group' | 'brivo_group';
4255
+ access_group_type: 'pti_unit' | 'pti_access_level' | 'salto_ks_access_group' | 'brivo_group';
4256
4256
  /**
4257
4257
  * @deprecated Use `external_type_display_name`. */
4258
4258
  access_group_type_display_name: string;
4259
4259
  display_name: string;
4260
4260
  /** Brand-specific terminology for the access group type. */
4261
- external_type: 'pti_unit' | 'pti_access_level' | 'salto_access_group' | 'brivo_group';
4261
+ external_type: 'pti_unit' | 'pti_access_level' | 'salto_ks_access_group' | 'brivo_group';
4262
4262
  /** Display name that corresponds to the brand-specific terminology for the access group type. */
4263
4263
  external_type_display_name: string;
4264
4264
  /** Date and time at which the access group was created. */
@@ -4467,13 +4467,13 @@ export interface Routes {
4467
4467
  name: string;
4468
4468
  /**
4469
4469
  * @deprecated Use `external_type`. */
4470
- access_group_type: 'pti_unit' | 'pti_access_level' | 'salto_access_group' | 'brivo_group';
4470
+ access_group_type: 'pti_unit' | 'pti_access_level' | 'salto_ks_access_group' | 'brivo_group';
4471
4471
  /**
4472
4472
  * @deprecated Use `external_type_display_name`. */
4473
4473
  access_group_type_display_name: string;
4474
4474
  display_name: string;
4475
4475
  /** Brand-specific terminology for the access group type. */
4476
- external_type: 'pti_unit' | 'pti_access_level' | 'salto_access_group' | 'brivo_group';
4476
+ external_type: 'pti_unit' | 'pti_access_level' | 'salto_ks_access_group' | 'brivo_group';
4477
4477
  /** Display name that corresponds to the brand-specific terminology for the access group type. */
4478
4478
  external_type_display_name: string;
4479
4479
  /** Date and time at which the access group was created. */
@@ -4506,13 +4506,13 @@ export interface Routes {
4506
4506
  name: string;
4507
4507
  /**
4508
4508
  * @deprecated Use `external_type`. */
4509
- access_group_type: 'pti_unit' | 'pti_access_level' | 'salto_access_group' | 'brivo_group';
4509
+ access_group_type: 'pti_unit' | 'pti_access_level' | 'salto_ks_access_group' | 'brivo_group';
4510
4510
  /**
4511
4511
  * @deprecated Use `external_type_display_name`. */
4512
4512
  access_group_type_display_name: string;
4513
4513
  display_name: string;
4514
4514
  /** Brand-specific terminology for the access group type. */
4515
- external_type: 'pti_unit' | 'pti_access_level' | 'salto_access_group' | 'brivo_group';
4515
+ external_type: 'pti_unit' | 'pti_access_level' | 'salto_ks_access_group' | 'brivo_group';
4516
4516
  /** Display name that corresponds to the brand-specific terminology for the access group type. */
4517
4517
  external_type_display_name: string;
4518
4518
  /** Date and time at which the access group was created. */
@@ -7675,7 +7675,7 @@ export interface Routes {
7675
7675
  /** ID of the `acs_system`. */
7676
7676
  acs_system_id: string;
7677
7677
  /** Brand-specific terminology for the `acs_system` type. */
7678
- external_type?: ('pti_site' | 'alta_org' | 'salto_ks_site' | 'brivo_account' | 'hid_credential_manager_organization' | 'visionline_system' | 'assa_abloy_credential_service' | 'latch_building' | 'dormakaba_community' | 'legic_connect' | 'assa_abloy_vostio' | 'assa_abloy_vostio_credential_service') | undefined;
7678
+ external_type?: ('pti_site' | 'alta_org' | 'salto_ks_site' | 'salto_space_system' | 'brivo_account' | 'hid_credential_manager_organization' | 'visionline_system' | 'assa_abloy_credential_service' | 'latch_building' | 'dormakaba_community' | 'legic_connect' | 'assa_abloy_vostio' | 'assa_abloy_vostio_credential_service') | undefined;
7679
7679
  /** Display name that corresponds to the brand-specific terminology for the `acs_system` type. */
7680
7680
  external_type_display_name?: string | undefined;
7681
7681
  /** Indicates if the `acs_system` is a credential manager. */
@@ -7690,7 +7690,7 @@ export interface Routes {
7690
7690
  } | undefined;
7691
7691
  /**
7692
7692
  * @deprecated Use `external_type`. */
7693
- system_type?: ('pti_site' | 'alta_org' | 'salto_ks_site' | 'brivo_account' | 'hid_credential_manager_organization' | 'visionline_system' | 'assa_abloy_credential_service' | 'latch_building' | 'dormakaba_community' | 'legic_connect' | 'assa_abloy_vostio' | 'assa_abloy_vostio_credential_service') | undefined;
7693
+ system_type?: ('pti_site' | 'alta_org' | 'salto_ks_site' | 'salto_space_system' | 'brivo_account' | 'hid_credential_manager_organization' | 'visionline_system' | 'assa_abloy_credential_service' | 'latch_building' | 'dormakaba_community' | 'legic_connect' | 'assa_abloy_vostio' | 'assa_abloy_vostio_credential_service') | undefined;
7694
7694
  /**
7695
7695
  * @deprecated Use `external_type_display_name`. */
7696
7696
  system_type_display_name?: string | undefined;
@@ -7762,6 +7762,13 @@ export interface Routes {
7762
7762
  message: string;
7763
7763
  /** 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. */
7764
7764
  warning_code: 'salto_ks_subscription_limit_almost_reached';
7765
+ } | {
7766
+ /** Date and time at which Seam created the warning. */
7767
+ created_at: string;
7768
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
7769
+ message: string;
7770
+ /** 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. */
7771
+ warning_code: 'time_zone_does_not_match_location';
7765
7772
  }>;
7766
7773
  /** 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`. */
7767
7774
  can_automate_enrollment?: boolean | undefined;
@@ -7791,7 +7798,7 @@ export interface Routes {
7791
7798
  /** ID of the `acs_system`. */
7792
7799
  acs_system_id: string;
7793
7800
  /** Brand-specific terminology for the `acs_system` type. */
7794
- external_type?: ('pti_site' | 'alta_org' | 'salto_ks_site' | 'brivo_account' | 'hid_credential_manager_organization' | 'visionline_system' | 'assa_abloy_credential_service' | 'latch_building' | 'dormakaba_community' | 'legic_connect' | 'assa_abloy_vostio' | 'assa_abloy_vostio_credential_service') | undefined;
7801
+ external_type?: ('pti_site' | 'alta_org' | 'salto_ks_site' | 'salto_space_system' | 'brivo_account' | 'hid_credential_manager_organization' | 'visionline_system' | 'assa_abloy_credential_service' | 'latch_building' | 'dormakaba_community' | 'legic_connect' | 'assa_abloy_vostio' | 'assa_abloy_vostio_credential_service') | undefined;
7795
7802
  /** Display name that corresponds to the brand-specific terminology for the `acs_system` type. */
7796
7803
  external_type_display_name?: string | undefined;
7797
7804
  /** Indicates if the `acs_system` is a credential manager. */
@@ -7806,7 +7813,7 @@ export interface Routes {
7806
7813
  } | undefined;
7807
7814
  /**
7808
7815
  * @deprecated Use `external_type`. */
7809
- system_type?: ('pti_site' | 'alta_org' | 'salto_ks_site' | 'brivo_account' | 'hid_credential_manager_organization' | 'visionline_system' | 'assa_abloy_credential_service' | 'latch_building' | 'dormakaba_community' | 'legic_connect' | 'assa_abloy_vostio' | 'assa_abloy_vostio_credential_service') | undefined;
7816
+ system_type?: ('pti_site' | 'alta_org' | 'salto_ks_site' | 'salto_space_system' | 'brivo_account' | 'hid_credential_manager_organization' | 'visionline_system' | 'assa_abloy_credential_service' | 'latch_building' | 'dormakaba_community' | 'legic_connect' | 'assa_abloy_vostio' | 'assa_abloy_vostio_credential_service') | undefined;
7810
7817
  /**
7811
7818
  * @deprecated Use `external_type_display_name`. */
7812
7819
  system_type_display_name?: string | undefined;
@@ -7878,6 +7885,13 @@ export interface Routes {
7878
7885
  message: string;
7879
7886
  /** 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. */
7880
7887
  warning_code: 'salto_ks_subscription_limit_almost_reached';
7888
+ } | {
7889
+ /** Date and time at which Seam created the warning. */
7890
+ created_at: string;
7891
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
7892
+ message: string;
7893
+ /** 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. */
7894
+ warning_code: 'time_zone_does_not_match_location';
7881
7895
  }>;
7882
7896
  /** 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`. */
7883
7897
  can_automate_enrollment?: boolean | undefined;
@@ -7907,7 +7921,7 @@ export interface Routes {
7907
7921
  /** ID of the `acs_system`. */
7908
7922
  acs_system_id: string;
7909
7923
  /** Brand-specific terminology for the `acs_system` type. */
7910
- external_type?: ('pti_site' | 'alta_org' | 'salto_ks_site' | 'brivo_account' | 'hid_credential_manager_organization' | 'visionline_system' | 'assa_abloy_credential_service' | 'latch_building' | 'dormakaba_community' | 'legic_connect' | 'assa_abloy_vostio' | 'assa_abloy_vostio_credential_service') | undefined;
7924
+ external_type?: ('pti_site' | 'alta_org' | 'salto_ks_site' | 'salto_space_system' | 'brivo_account' | 'hid_credential_manager_organization' | 'visionline_system' | 'assa_abloy_credential_service' | 'latch_building' | 'dormakaba_community' | 'legic_connect' | 'assa_abloy_vostio' | 'assa_abloy_vostio_credential_service') | undefined;
7911
7925
  /** Display name that corresponds to the brand-specific terminology for the `acs_system` type. */
7912
7926
  external_type_display_name?: string | undefined;
7913
7927
  /** Indicates if the `acs_system` is a credential manager. */
@@ -7922,7 +7936,7 @@ export interface Routes {
7922
7936
  } | undefined;
7923
7937
  /**
7924
7938
  * @deprecated Use `external_type`. */
7925
- system_type?: ('pti_site' | 'alta_org' | 'salto_ks_site' | 'brivo_account' | 'hid_credential_manager_organization' | 'visionline_system' | 'assa_abloy_credential_service' | 'latch_building' | 'dormakaba_community' | 'legic_connect' | 'assa_abloy_vostio' | 'assa_abloy_vostio_credential_service') | undefined;
7939
+ system_type?: ('pti_site' | 'alta_org' | 'salto_ks_site' | 'salto_space_system' | 'brivo_account' | 'hid_credential_manager_organization' | 'visionline_system' | 'assa_abloy_credential_service' | 'latch_building' | 'dormakaba_community' | 'legic_connect' | 'assa_abloy_vostio' | 'assa_abloy_vostio_credential_service') | undefined;
7926
7940
  /**
7927
7941
  * @deprecated Use `external_type_display_name`. */
7928
7942
  system_type_display_name?: string | undefined;
@@ -7994,6 +8008,13 @@ export interface Routes {
7994
8008
  message: string;
7995
8009
  /** 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. */
7996
8010
  warning_code: 'salto_ks_subscription_limit_almost_reached';
8011
+ } | {
8012
+ /** Date and time at which Seam created the warning. */
8013
+ created_at: string;
8014
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
8015
+ message: string;
8016
+ /** 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. */
8017
+ warning_code: 'time_zone_does_not_match_location';
7997
8018
  }>;
7998
8019
  /** 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`. */
7999
8020
  can_automate_enrollment?: boolean | undefined;
@@ -10622,7 +10643,7 @@ export interface Routes {
10622
10643
  device_selection_mode?: ('none' | 'single' | 'multiple') | undefined;
10623
10644
  custom_redirect_url?: string | undefined;
10624
10645
  custom_redirect_failure_url?: string | undefined;
10625
- accepted_providers?: Array<'dormakaba_community' | 'legic_connect' | 'akuvox' | 'august' | 'avigilon_alta' | 'brivo' | 'butterflymx' | 'schlage' | 'smartthings' | 'yale' | 'genie' | 'doorking' | 'salto' | 'salto_ks' | 'lockly' | 'ttlock' | 'linear' | 'noiseaware' | 'nuki' | 'seam_relay_admin' | 'igloo' | 'kwikset' | 'minut' | 'my_2n' | 'controlbyweb' | 'nest' | 'igloohome' | 'ecobee' | 'hubitat' | 'four_suites' | 'dormakaba_oracode' | 'pti' | 'wyze' | 'seam_passport' | 'visionline' | 'assa_abloy_credential_service' | 'seam_bridge' | 'tedee' | 'honeywell_resideo' | 'latch' | 'akiles' | 'assa_abloy_vostio' | 'assa_abloy_vostio_credential_service' | 'tado' | 'yale_access' | 'hid_cm' | 'google_nest'> | undefined;
10646
+ accepted_providers?: Array<'dormakaba_community' | 'legic_connect' | 'akuvox' | 'august' | 'avigilon_alta' | 'brivo' | 'butterflymx' | 'schlage' | 'smartthings' | 'yale' | 'genie' | 'doorking' | 'salto' | 'salto_ks' | 'lockly' | 'ttlock' | 'linear' | 'noiseaware' | 'nuki' | 'seam_relay_admin' | 'igloo' | 'kwikset' | 'minut' | 'my_2n' | 'controlbyweb' | 'nest' | 'igloohome' | 'ecobee' | 'hubitat' | 'four_suites' | 'dormakaba_oracode' | 'pti' | 'wyze' | 'seam_passport' | 'visionline' | 'assa_abloy_credential_service' | 'seam_bridge' | 'tedee' | 'honeywell_resideo' | 'latch' | 'akiles' | 'assa_abloy_vostio' | 'assa_abloy_vostio_credential_service' | 'tado' | 'salto_space' | 'yale_access' | 'hid_cm' | 'google_nest'> | undefined;
10626
10647
  provider_category?: ('stable' | 'consumer_smartlocks' | 'thermostats' | 'noise_sensors' | 'access_control_systems' | 'internal_beta') | undefined;
10627
10648
  custom_metadata?: Record<string, string | boolean | null> | undefined;
10628
10649
  automatically_manage_new_devices?: boolean;
@@ -11212,8 +11233,7 @@ export interface Routes {
11212
11233
  encoder_name: string;
11213
11234
  } | undefined;
11214
11235
  tado_metadata?: {
11215
- serial_number: string;
11216
- device_name: string;
11236
+ serial_no: string;
11217
11237
  device_type: string;
11218
11238
  } | undefined;
11219
11239
  }) & ({
@@ -11767,8 +11787,7 @@ export interface Routes {
11767
11787
  encoder_name: string;
11768
11788
  } | undefined;
11769
11789
  tado_metadata?: {
11770
- serial_number: string;
11771
- device_name: string;
11790
+ serial_no: string;
11772
11791
  device_type: string;
11773
11792
  } | undefined;
11774
11793
  }) & ({
@@ -11982,7 +12001,7 @@ export interface Routes {
11982
12001
  formData: {};
11983
12002
  jsonResponse: {
11984
12003
  device_providers: Array<{
11985
- device_provider_name: 'dormakaba_community' | 'legic_connect' | 'akuvox' | 'august' | 'avigilon_alta' | 'brivo' | 'butterflymx' | 'schlage' | 'smartthings' | 'yale' | 'genie' | 'doorking' | 'salto' | 'salto_ks' | 'lockly' | 'ttlock' | 'linear' | 'noiseaware' | 'nuki' | 'seam_relay_admin' | 'igloo' | 'kwikset' | 'minut' | 'my_2n' | 'controlbyweb' | 'nest' | 'igloohome' | 'ecobee' | 'hubitat' | 'four_suites' | 'dormakaba_oracode' | 'pti' | 'wyze' | 'seam_passport' | 'visionline' | 'assa_abloy_credential_service' | 'seam_bridge' | 'tedee' | 'honeywell_resideo' | 'latch' | 'akiles' | 'assa_abloy_vostio' | 'assa_abloy_vostio_credential_service' | 'tado';
12004
+ device_provider_name: 'dormakaba_community' | 'legic_connect' | 'akuvox' | 'august' | 'avigilon_alta' | 'brivo' | 'butterflymx' | 'schlage' | 'smartthings' | 'yale' | 'genie' | 'doorking' | 'salto' | 'salto_ks' | 'lockly' | 'ttlock' | 'linear' | 'noiseaware' | 'nuki' | 'seam_relay_admin' | 'igloo' | 'kwikset' | 'minut' | 'my_2n' | 'controlbyweb' | 'nest' | 'igloohome' | 'ecobee' | 'hubitat' | 'four_suites' | 'dormakaba_oracode' | 'pti' | 'wyze' | 'seam_passport' | 'visionline' | 'assa_abloy_credential_service' | 'seam_bridge' | 'tedee' | 'honeywell_resideo' | 'latch' | 'akiles' | 'assa_abloy_vostio' | 'assa_abloy_vostio_credential_service' | 'tado' | 'salto_space';
11986
12005
  display_name: string;
11987
12006
  image_url: string;
11988
12007
  provider_categories: Array<'stable' | 'consumer_smartlocks' | 'thermostats' | 'noise_sensors' | 'access_control_systems'>;
@@ -12725,8 +12744,7 @@ export interface Routes {
12725
12744
  encoder_name: string;
12726
12745
  } | undefined;
12727
12746
  tado_metadata?: {
12728
- serial_number: string;
12729
- device_name: string;
12747
+ serial_no: string;
12730
12748
  device_type: string;
12731
12749
  } | undefined;
12732
12750
  }) & ({
@@ -13243,8 +13261,7 @@ export interface Routes {
13243
13261
  encoder_name: string;
13244
13262
  } | undefined;
13245
13263
  tado_metadata?: {
13246
- serial_number: string;
13247
- device_name: string;
13264
+ serial_no: string;
13248
13265
  device_type: string;
13249
13266
  } | undefined;
13250
13267
  }) & ({
@@ -13798,8 +13815,7 @@ export interface Routes {
13798
13815
  encoder_name: string;
13799
13816
  } | undefined;
13800
13817
  tado_metadata?: {
13801
- serial_number: string;
13802
- device_name: string;
13818
+ serial_no: string;
13803
13819
  device_type: string;
13804
13820
  } | undefined;
13805
13821
  }) & ({
@@ -14316,8 +14332,7 @@ export interface Routes {
14316
14332
  encoder_name: string;
14317
14333
  } | undefined;
14318
14334
  tado_metadata?: {
14319
- serial_number: string;
14320
- device_name: string;
14335
+ serial_no: string;
14321
14336
  device_type: string;
14322
14337
  } | undefined;
14323
14338
  }) & ({
@@ -16651,8 +16666,7 @@ export interface Routes {
16651
16666
  encoder_name: string;
16652
16667
  } | undefined;
16653
16668
  tado_metadata?: {
16654
- serial_number: string;
16655
- device_name: string;
16669
+ serial_no: string;
16656
16670
  device_type: string;
16657
16671
  } | undefined;
16658
16672
  }) & ({
@@ -17169,8 +17183,7 @@ export interface Routes {
17169
17183
  encoder_name: string;
17170
17184
  } | undefined;
17171
17185
  tado_metadata?: {
17172
- serial_number: string;
17173
- device_name: string;
17186
+ serial_no: string;
17174
17187
  device_type: string;
17175
17188
  } | undefined;
17176
17189
  }) & ({
@@ -22364,8 +22377,7 @@ export interface Routes {
22364
22377
  encoder_name: string;
22365
22378
  } | undefined;
22366
22379
  tado_metadata?: {
22367
- serial_number: string;
22368
- device_name: string;
22380
+ serial_no: string;
22369
22381
  device_type: string;
22370
22382
  } | undefined;
22371
22383
  }) & ({
@@ -24681,8 +24693,7 @@ export interface Routes {
24681
24693
  encoder_name: string;
24682
24694
  } | undefined;
24683
24695
  tado_metadata?: {
24684
- serial_number: string;
24685
- device_name: string;
24696
+ serial_no: string;
24686
24697
  device_type: string;
24687
24698
  } | undefined;
24688
24699
  }) & ({
@@ -25199,8 +25210,7 @@ export interface Routes {
25199
25210
  encoder_name: string;
25200
25211
  } | undefined;
25201
25212
  tado_metadata?: {
25202
- serial_number: string;
25203
- device_name: string;
25213
+ serial_no: string;
25204
25214
  device_type: string;
25205
25215
  } | undefined;
25206
25216
  }) & ({
@@ -28834,8 +28844,7 @@ export interface Routes {
28834
28844
  encoder_name: string;
28835
28845
  } | undefined;
28836
28846
  tado_metadata?: {
28837
- serial_number: string;
28838
- device_name: string;
28847
+ serial_no: string;
28839
28848
  device_type: string;
28840
28849
  } | undefined;
28841
28850
  }) & ({
@@ -29354,8 +29363,7 @@ export interface Routes {
29354
29363
  encoder_name: string;
29355
29364
  } | undefined;
29356
29365
  tado_metadata?: {
29357
- serial_number: string;
29358
- device_name: string;
29366
+ serial_no: string;
29359
29367
  device_type: string;
29360
29368
  } | undefined;
29361
29369
  }) & ({
@@ -29575,7 +29583,7 @@ export interface Routes {
29575
29583
  /** ID of the `acs_system`. */
29576
29584
  acs_system_id: string;
29577
29585
  /** Brand-specific terminology for the `acs_system` type. */
29578
- external_type?: ('pti_site' | 'alta_org' | 'salto_ks_site' | 'brivo_account' | 'hid_credential_manager_organization' | 'visionline_system' | 'assa_abloy_credential_service' | 'latch_building' | 'dormakaba_community' | 'legic_connect' | 'assa_abloy_vostio' | 'assa_abloy_vostio_credential_service') | undefined;
29586
+ external_type?: ('pti_site' | 'alta_org' | 'salto_ks_site' | 'salto_space_system' | 'brivo_account' | 'hid_credential_manager_organization' | 'visionline_system' | 'assa_abloy_credential_service' | 'latch_building' | 'dormakaba_community' | 'legic_connect' | 'assa_abloy_vostio' | 'assa_abloy_vostio_credential_service') | undefined;
29579
29587
  /** Display name that corresponds to the brand-specific terminology for the `acs_system` type. */
29580
29588
  external_type_display_name?: string | undefined;
29581
29589
  /** Indicates if the `acs_system` is a credential manager. */
@@ -29590,7 +29598,7 @@ export interface Routes {
29590
29598
  } | undefined;
29591
29599
  /**
29592
29600
  * @deprecated Use `external_type`. */
29593
- system_type?: ('pti_site' | 'alta_org' | 'salto_ks_site' | 'brivo_account' | 'hid_credential_manager_organization' | 'visionline_system' | 'assa_abloy_credential_service' | 'latch_building' | 'dormakaba_community' | 'legic_connect' | 'assa_abloy_vostio' | 'assa_abloy_vostio_credential_service') | undefined;
29601
+ system_type?: ('pti_site' | 'alta_org' | 'salto_ks_site' | 'salto_space_system' | 'brivo_account' | 'hid_credential_manager_organization' | 'visionline_system' | 'assa_abloy_credential_service' | 'latch_building' | 'dormakaba_community' | 'legic_connect' | 'assa_abloy_vostio' | 'assa_abloy_vostio_credential_service') | undefined;
29594
29602
  /**
29595
29603
  * @deprecated Use `external_type_display_name`. */
29596
29604
  system_type_display_name?: string | undefined;
@@ -29662,6 +29670,13 @@ export interface Routes {
29662
29670
  message: string;
29663
29671
  /** 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. */
29664
29672
  warning_code: 'salto_ks_subscription_limit_almost_reached';
29673
+ } | {
29674
+ /** Date and time at which Seam created the warning. */
29675
+ created_at: string;
29676
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
29677
+ message: string;
29678
+ /** 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. */
29679
+ warning_code: 'time_zone_does_not_match_location';
29665
29680
  }>;
29666
29681
  /** 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`. */
29667
29682
  can_automate_enrollment?: boolean | undefined;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@seamapi/types",
3
- "version": "1.307.0",
3
+ "version": "1.308.0",
4
4
  "description": "TypeScript types for the Seam API.",
5
5
  "type": "module",
6
6
  "main": "index.js",
@@ -4,7 +4,7 @@ import { z } from 'zod'
4
4
  export const acs_access_group_external_type = z.enum([
5
5
  'pti_unit',
6
6
  'pti_access_level',
7
- 'salto_access_group',
7
+ 'salto_ks_access_group',
8
8
  'brivo_group',
9
9
  ])
10
10
 
@@ -39,6 +39,7 @@ export const acs_system_external_type = z.enum([
39
39
  'pti_site',
40
40
  'alta_org',
41
41
  'salto_ks_site',
42
+ 'salto_space_system',
42
43
  'brivo_account',
43
44
  'hid_credential_manager_organization',
44
45
  'visionline_system',
@@ -171,11 +172,20 @@ const salto_ks_subscription_limit_almost_reached =
171
172
  ),
172
173
  })
173
174
 
174
- const acs_system_warning =
175
- // z.union([
176
- salto_ks_subscription_limit_almost_reached
177
- // ])
178
- .describe('Warning associated with the `acs_system`.')
175
+ const time_zone_does_not_match_location = common_acs_system_warning.extend({
176
+ warning_code: z
177
+ .literal('time_zone_does_not_match_location')
178
+ .describe(
179
+ '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.',
180
+ ),
181
+ })
182
+
183
+ const acs_system_warning = z
184
+ .union([
185
+ salto_ks_subscription_limit_almost_reached,
186
+ time_zone_does_not_match_location,
187
+ ])
188
+ .describe('Warning associated with the `acs_system`.')
179
189
 
180
190
  export const acs_system_warning_map = z.object({
181
191
  salto_ks_subscription_limit_almost_reached:
@@ -268,8 +268,7 @@ export const device_metadata = z
268
268
  }),
269
269
 
270
270
  tado_metadata: z.object({
271
- serial_number: z.string(),
272
- device_name: z.string(),
271
+ serial_no: z.string(),
273
272
  device_type: z.string(),
274
273
  }),
275
274
  })
@@ -47,6 +47,7 @@ export const DEVICE_PROVIDERS = {
47
47
  VOSTIO: 'assa_abloy_vostio',
48
48
  ASSA_ABLOY_VOSTIO_CREDENTIAL_SERVICE: 'assa_abloy_vostio_credential_service',
49
49
  TADO: 'tado',
50
+ SALTO_SPACE: 'salto_space',
50
51
  } as const
51
52
 
52
53
  export type DeviceProviderName =
@@ -113,6 +114,7 @@ export const PROVIDER_CATEGORY_MAP = {
113
114
  'salto_ks',
114
115
  'assa_abloy_vostio',
115
116
  'assa_abloy_vostio_credential_service',
117
+ 'salto_space',
116
118
  ],
117
119
 
118
120
  internal_beta: ALL_DEVICE_PROVIDERS,
@@ -194,7 +194,7 @@ export default {
194
194
  enum: [
195
195
  'pti_unit',
196
196
  'pti_access_level',
197
- 'salto_access_group',
197
+ 'salto_ks_access_group',
198
198
  'brivo_group',
199
199
  ],
200
200
  type: 'string',
@@ -228,7 +228,7 @@ export default {
228
228
  enum: [
229
229
  'pti_unit',
230
230
  'pti_access_level',
231
- 'salto_access_group',
231
+ 'salto_ks_access_group',
232
232
  'brivo_group',
233
233
  ],
234
234
  type: 'string',
@@ -912,6 +912,7 @@ export default {
912
912
  'pti_site',
913
913
  'alta_org',
914
914
  'salto_ks_site',
915
+ 'salto_space_system',
915
916
  'brivo_account',
916
917
  'hid_credential_manager_organization',
917
918
  'visionline_system',
@@ -960,6 +961,7 @@ export default {
960
961
  'pti_site',
961
962
  'alta_org',
962
963
  'salto_ks_site',
964
+ 'salto_space_system',
963
965
  'brivo_account',
964
966
  'hid_credential_manager_organization',
965
967
  'visionline_system',
@@ -1003,27 +1005,54 @@ export default {
1003
1005
  description: 'Warnings associated with the `acs_system`.',
1004
1006
  items: {
1005
1007
  description: 'Warning associated with the `acs_system`.',
1006
- properties: {
1007
- created_at: {
1008
- description:
1009
- 'Date and time at which Seam created the warning.',
1010
- format: 'date-time',
1011
- type: 'string',
1012
- },
1013
- message: {
1014
- description:
1015
- 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
1016
- type: 'string',
1008
+ oneOf: [
1009
+ {
1010
+ properties: {
1011
+ created_at: {
1012
+ description:
1013
+ 'Date and time at which Seam created the warning.',
1014
+ format: 'date-time',
1015
+ type: 'string',
1016
+ },
1017
+ message: {
1018
+ description:
1019
+ 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
1020
+ type: 'string',
1021
+ },
1022
+ warning_code: {
1023
+ description:
1024
+ '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.',
1025
+ enum: ['salto_ks_subscription_limit_almost_reached'],
1026
+ type: 'string',
1027
+ },
1028
+ },
1029
+ required: ['created_at', 'message', 'warning_code'],
1030
+ type: 'object',
1017
1031
  },
1018
- warning_code: {
1019
- description:
1020
- '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.',
1021
- enum: ['salto_ks_subscription_limit_almost_reached'],
1022
- type: 'string',
1032
+ {
1033
+ properties: {
1034
+ created_at: {
1035
+ description:
1036
+ 'Date and time at which Seam created the warning.',
1037
+ format: 'date-time',
1038
+ type: 'string',
1039
+ },
1040
+ message: {
1041
+ description:
1042
+ 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
1043
+ type: 'string',
1044
+ },
1045
+ warning_code: {
1046
+ description:
1047
+ '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.',
1048
+ enum: ['time_zone_does_not_match_location'],
1049
+ type: 'string',
1050
+ },
1051
+ },
1052
+ required: ['created_at', 'message', 'warning_code'],
1053
+ type: 'object',
1023
1054
  },
1024
- },
1025
- required: ['created_at', 'message', 'warning_code'],
1026
- type: 'object',
1055
+ ],
1027
1056
  },
1028
1057
  type: 'array',
1029
1058
  },
@@ -5132,15 +5161,10 @@ export default {
5132
5161
  },
5133
5162
  tado_metadata: {
5134
5163
  properties: {
5135
- device_name: { type: 'string' },
5136
5164
  device_type: { type: 'string' },
5137
- serial_number: { type: 'string' },
5165
+ serial_no: { type: 'string' },
5138
5166
  },
5139
- required: [
5140
- 'serial_number',
5141
- 'device_name',
5142
- 'device_type',
5143
- ],
5167
+ required: ['serial_no', 'device_type'],
5144
5168
  type: 'object',
5145
5169
  },
5146
5170
  tedee_metadata: {
@@ -5854,6 +5878,7 @@ export default {
5854
5878
  'assa_abloy_vostio',
5855
5879
  'assa_abloy_vostio_credential_service',
5856
5880
  'tado',
5881
+ 'salto_space',
5857
5882
  ],
5858
5883
  type: 'string',
5859
5884
  },
@@ -8500,7 +8525,7 @@ export default {
8500
8525
  enum: [
8501
8526
  'pti_unit',
8502
8527
  'pti_access_level',
8503
- 'salto_access_group',
8528
+ 'salto_ks_access_group',
8504
8529
  'brivo_group',
8505
8530
  ],
8506
8531
  type: 'string',
@@ -8535,7 +8560,7 @@ export default {
8535
8560
  enum: [
8536
8561
  'pti_unit',
8537
8562
  'pti_access_level',
8538
- 'salto_access_group',
8563
+ 'salto_ks_access_group',
8539
8564
  'brivo_group',
8540
8565
  ],
8541
8566
  type: 'string',
@@ -8641,7 +8666,7 @@ export default {
8641
8666
  enum: [
8642
8667
  'pti_unit',
8643
8668
  'pti_access_level',
8644
- 'salto_access_group',
8669
+ 'salto_ks_access_group',
8645
8670
  'brivo_group',
8646
8671
  ],
8647
8672
  type: 'string',
@@ -8676,7 +8701,7 @@ export default {
8676
8701
  enum: [
8677
8702
  'pti_unit',
8678
8703
  'pti_access_level',
8679
- 'salto_access_group',
8704
+ 'salto_ks_access_group',
8680
8705
  'brivo_group',
8681
8706
  ],
8682
8707
  type: 'string',
@@ -13495,6 +13520,7 @@ export default {
13495
13520
  'assa_abloy_vostio',
13496
13521
  'assa_abloy_vostio_credential_service',
13497
13522
  'tado',
13523
+ 'salto_space',
13498
13524
  'yale_access',
13499
13525
  'hid_cm',
13500
13526
  'google_nest',