@seamapi/types 1.843.0 → 1.845.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.
@@ -12801,6 +12801,15 @@ export type Routes = {
12801
12801
  /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
12802
12802
  message: string;
12803
12803
  }[];
12804
+ /** Warnings associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
12805
+ warnings: {
12806
+ /** Date and time at which Seam created the warning. */
12807
+ created_at: string;
12808
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
12809
+ message: string;
12810
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
12811
+ warning_code: 'salto_ks_entrance_access_code_support_removed';
12812
+ }[];
12804
12813
  /** Latch-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
12805
12814
  latch_metadata?: {
12806
12815
  /** Accessibility type in the Latch access system. */
@@ -17264,6 +17273,15 @@ export type Routes = {
17264
17273
  /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
17265
17274
  message: string;
17266
17275
  }[];
17276
+ /** Warnings associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
17277
+ warnings: {
17278
+ /** Date and time at which Seam created the warning. */
17279
+ created_at: string;
17280
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
17281
+ message: string;
17282
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
17283
+ warning_code: 'salto_ks_entrance_access_code_support_removed';
17284
+ }[];
17267
17285
  /** Latch-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
17268
17286
  latch_metadata?: {
17269
17287
  /** Accessibility type in the Latch access system. */
@@ -18675,6 +18693,15 @@ export type Routes = {
18675
18693
  /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
18676
18694
  message: string;
18677
18695
  }[];
18696
+ /** Warnings associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
18697
+ warnings: {
18698
+ /** Date and time at which Seam created the warning. */
18699
+ created_at: string;
18700
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
18701
+ message: string;
18702
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
18703
+ warning_code: 'salto_ks_entrance_access_code_support_removed';
18704
+ }[];
18678
18705
  /** Latch-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
18679
18706
  latch_metadata?: {
18680
18707
  /** Accessibility type in the Latch access system. */
@@ -20387,6 +20414,15 @@ export type Routes = {
20387
20414
  /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
20388
20415
  message: string;
20389
20416
  }[];
20417
+ /** Warnings associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
20418
+ warnings: {
20419
+ /** Date and time at which Seam created the warning. */
20420
+ created_at: string;
20421
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
20422
+ message: string;
20423
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
20424
+ warning_code: 'salto_ks_entrance_access_code_support_removed';
20425
+ }[];
20390
20426
  /** Latch-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
20391
20427
  latch_metadata?: {
20392
20428
  /** Accessibility type in the Latch access system. */
@@ -24040,6 +24076,15 @@ export type Routes = {
24040
24076
  /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
24041
24077
  message: string;
24042
24078
  }[];
24079
+ /** Warnings associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
24080
+ warnings: {
24081
+ /** Date and time at which Seam created the warning. */
24082
+ created_at: string;
24083
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
24084
+ message: string;
24085
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
24086
+ warning_code: 'salto_ks_entrance_access_code_support_removed';
24087
+ }[];
24043
24088
  /** Latch-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
24044
24089
  latch_metadata?: {
24045
24090
  /** Accessibility type in the Latch access system. */
@@ -24238,6 +24283,15 @@ export type Routes = {
24238
24283
  /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
24239
24284
  message: string;
24240
24285
  }[];
24286
+ /** Warnings associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
24287
+ warnings: {
24288
+ /** Date and time at which Seam created the warning. */
24289
+ created_at: string;
24290
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
24291
+ message: string;
24292
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
24293
+ warning_code: 'salto_ks_entrance_access_code_support_removed';
24294
+ }[];
24241
24295
  /** Latch-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
24242
24296
  latch_metadata?: {
24243
24297
  /** Accessibility type in the Latch access system. */
@@ -27230,6 +27284,15 @@ export type Routes = {
27230
27284
  /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
27231
27285
  message: string;
27232
27286
  }[];
27287
+ /** Warnings associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
27288
+ warnings: {
27289
+ /** Date and time at which Seam created the warning. */
27290
+ created_at: string;
27291
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
27292
+ message: string;
27293
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
27294
+ warning_code: 'salto_ks_entrance_access_code_support_removed';
27295
+ }[];
27233
27296
  /** Latch-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
27234
27297
  latch_metadata?: {
27235
27298
  /** Accessibility type in the Latch access system. */
@@ -31066,7 +31129,7 @@ export type Routes = {
31066
31129
  /** Associate the Connect Webview, the connected account, and all resources under the connected account with a customer. If the connected account already exists, it will be associated with the customer. If the connected account already exists, but is already associated with a customer, the Connect Webview will show an error. */
31067
31130
  customer_key?: string | undefined;
31068
31131
  /** Accepted device provider keys as an alternative to `provider_category`. Use this parameter to specify accepted providers explicitly. See [Customize the Brands to Display in Your Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-brands-to-display-in-your-connect-webviews). To list all provider keys, use [`/devices/list_device_providers`](https://docs.seam.co/latest/api/devices/list_device_providers) with no filters. */
31069
- accepted_providers?: ('hotek' | 'dormakaba_community' | 'legic_connect' | 'akuvox' | 'august' | 'avigilon_alta' | 'brivo' | 'butterflymx' | 'schlage' | 'smartthings' | 'yale' | 'genie' | 'doorking' | 'salto' | 'salto_ks' | 'lockly' | 'ttlock' | 'linear' | 'noiseaware' | 'nuki' | 'igloo' | 'kwikset' | 'minut' | 'my_2n' | 'controlbyweb' | 'nest' | 'igloohome' | 'ecobee' | 'four_suites' | 'dormakaba_oracode' | 'pti' | 'wyze' | 'seam_passport' | 'visionline' | 'assa_abloy_credential_service' | 'tedee' | 'honeywell_resideo' | 'first_alert' | 'latch' | 'akiles' | 'assa_abloy_vostio' | 'assa_abloy_vostio_credential_service' | 'tado' | 'salto_space' | 'sensi' | 'keynest' | 'korelock' | 'dormakaba_ambiance' | 'ultraloq' | 'ring' | 'ical' | 'lodgify' | 'yale_access' | 'hid_cm' | 'google_nest')[] | undefined;
31132
+ accepted_providers?: ('hotek' | 'dormakaba_community' | 'legic_connect' | 'akuvox' | 'august' | 'avigilon_alta' | 'brivo' | 'butterflymx' | 'schlage' | 'smartthings' | 'yale' | 'genie' | 'doorking' | 'salto' | 'salto_ks' | 'lockly' | 'ttlock' | 'linear' | 'noiseaware' | 'nuki' | 'igloo' | 'kwikset' | 'minut' | 'my_2n' | 'controlbyweb' | 'nest' | 'igloohome' | 'ecobee' | 'four_suites' | 'dormakaba_oracode' | 'pti' | 'wyze' | 'seam_passport' | 'visionline' | 'assa_abloy_credential_service' | 'tedee' | 'honeywell_resideo' | 'first_alert' | 'latch' | 'akiles' | 'assa_abloy_vostio' | 'assa_abloy_vostio_credential_service' | 'tado' | 'salto_space' | 'sensi' | 'keynest' | 'korelock' | 'dormakaba_ambiance' | 'ultraloq' | 'ring' | 'ical' | 'lodgify' | 'hostaway' | 'yale_access' | 'hid_cm' | 'google_nest')[] | undefined;
31070
31133
  /** Specifies the category of providers that you want to include. To list all providers within a category, use [`/devices/list_device_providers`](https://docs.seam.co/latest/api/devices/list_device_providers) with the desired `provider_category` filter. */
31071
31134
  provider_category?: ('stable' | 'consumer_smartlocks' | 'beta' | 'thermostats' | 'noise_sensors' | 'access_control_systems' | 'cameras' | 'connectors' | 'internal_beta') | undefined;
31072
31135
  /** Custom metadata that you want to associate with the Connect Webview. Supports up to 50 JSON key:value pairs. [Adding custom metadata to a Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview) enables you to store custom information, like customer details or internal IDs from your application. The custom metadata is then transferred to any [connected accounts](https://docs.seam.co/latest/core-concepts/connected-accounts) that were connected using the Connect Webview, making it easy to find and filter these resources in your [workspace](https://docs.seam.co/latest/core-concepts/workspaces). You can also [filter Connect Webviews by custom metadata](https://docs.seam.co/latest/core-concepts/connect-webviews/filtering-connect-webviews-by-custom-metadata). */
@@ -34093,7 +34156,7 @@ export type Routes = {
34093
34156
  /** Array of device types for which you want to list devices. */
34094
34157
  device_types?: (('akuvox_lock' | 'august_lock' | 'brivo_access_point' | 'butterflymx_panel' | 'avigilon_alta_entry' | 'doorking_lock' | 'genie_door' | 'igloo_lock' | 'linear_lock' | 'lockly_lock' | 'kwikset_lock' | 'nuki_lock' | 'salto_lock' | 'schlage_lock' | 'smartthings_lock' | 'wyze_lock' | 'yale_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'four_suites_door' | 'dormakaba_oracode_door' | 'tedee_lock' | 'akiles_lock' | 'ultraloq_lock' | 'korelock_lock') | 'keynest_key' | ('noiseaware_activity_zone' | 'minut_sensor') | ('ecobee_thermostat' | 'nest_thermostat' | 'honeywell_resideo_thermostat' | 'tado_thermostat' | 'sensi_thermostat' | 'smartthings_thermostat') | ('ios_phone' | 'android_phone') | 'ring_camera')[] | undefined;
34095
34158
  /** Manufacturer for which you want to list devices. */
34096
- manufacturer?: ('akuvox' | 'august' | 'avigilon_alta' | 'brivo' | 'butterflymx' | 'doorking' | 'four_suites' | 'genie' | 'igloo' | 'keywe' | 'kwikset' | 'linear' | 'lockly' | 'nuki' | 'philia' | 'salto' | 'samsung' | 'schlage' | 'seam' | 'unknown' | 'wyze' | 'yale' | 'two_n' | 'ttlock' | 'igloohome' | 'controlbyweb' | 'dormakaba_oracode' | 'tedee' | 'korelock' | 'akiles' | 'ecobee' | 'honeywell_resideo' | 'keynest' | 'korelock' | 'minut' | 'nest' | 'noiseaware' | 'sensi' | 'smartthings' | 'tado' | 'ultraloq' | 'ring' | 'ical' | 'lodgify') | undefined;
34159
+ manufacturer?: ('akuvox' | 'august' | 'avigilon_alta' | 'brivo' | 'butterflymx' | 'doorking' | 'four_suites' | 'genie' | 'igloo' | 'keywe' | 'kwikset' | 'linear' | 'lockly' | 'nuki' | 'philia' | 'salto' | 'samsung' | 'schlage' | 'seam' | 'unknown' | 'wyze' | 'yale' | 'two_n' | 'ttlock' | 'igloohome' | 'controlbyweb' | 'dormakaba_oracode' | 'tedee' | 'korelock' | 'akiles' | 'ecobee' | 'honeywell_resideo' | 'keynest' | 'korelock' | 'minut' | 'nest' | 'noiseaware' | 'sensi' | 'smartthings' | 'tado' | 'ultraloq' | 'ring' | 'ical' | 'lodgify' | 'hostaway') | undefined;
34097
34160
  /** Array of device IDs for which you want to list devices. */
34098
34161
  device_ids?: string[] | undefined;
34099
34162
  /** Numerical limit on the number of devices to return. */
@@ -35479,7 +35542,7 @@ export type Routes = {
35479
35542
  formData: {};
35480
35543
  jsonResponse: {
35481
35544
  device_providers: {
35482
- device_provider_name: 'hotek' | 'dormakaba_community' | 'legic_connect' | 'akuvox' | 'august' | 'avigilon_alta' | 'brivo' | 'butterflymx' | 'schlage' | 'smartthings' | 'yale' | 'genie' | 'doorking' | 'salto' | 'salto_ks' | 'lockly' | 'ttlock' | 'linear' | 'noiseaware' | 'nuki' | 'igloo' | 'kwikset' | 'minut' | 'my_2n' | 'controlbyweb' | 'nest' | 'igloohome' | 'ecobee' | 'four_suites' | 'dormakaba_oracode' | 'pti' | 'wyze' | 'seam_passport' | 'visionline' | 'assa_abloy_credential_service' | 'tedee' | 'honeywell_resideo' | 'first_alert' | 'latch' | 'akiles' | 'assa_abloy_vostio' | 'assa_abloy_vostio_credential_service' | 'tado' | 'salto_space' | 'sensi' | 'keynest' | 'korelock' | 'dormakaba_ambiance' | 'ultraloq' | 'ring' | 'ical' | 'lodgify';
35545
+ device_provider_name: 'hotek' | 'dormakaba_community' | 'legic_connect' | 'akuvox' | 'august' | 'avigilon_alta' | 'brivo' | 'butterflymx' | 'schlage' | 'smartthings' | 'yale' | 'genie' | 'doorking' | 'salto' | 'salto_ks' | 'lockly' | 'ttlock' | 'linear' | 'noiseaware' | 'nuki' | 'igloo' | 'kwikset' | 'minut' | 'my_2n' | 'controlbyweb' | 'nest' | 'igloohome' | 'ecobee' | 'four_suites' | 'dormakaba_oracode' | 'pti' | 'wyze' | 'seam_passport' | 'visionline' | 'assa_abloy_credential_service' | 'tedee' | 'honeywell_resideo' | 'first_alert' | 'latch' | 'akiles' | 'assa_abloy_vostio' | 'assa_abloy_vostio_credential_service' | 'tado' | 'salto_space' | 'sensi' | 'keynest' | 'korelock' | 'dormakaba_ambiance' | 'ultraloq' | 'ring' | 'ical' | 'lodgify' | 'hostaway';
35483
35546
  display_name: string;
35484
35547
  image_url: string;
35485
35548
  provider_categories: ('stable' | 'consumer_smartlocks' | 'beta' | 'thermostats' | 'noise_sensors' | 'access_control_systems' | 'cameras' | 'connectors')[];
@@ -36087,7 +36150,7 @@ export type Routes = {
36087
36150
  /** Array of device types for which you want to list devices. */
36088
36151
  device_types?: (('akuvox_lock' | 'august_lock' | 'brivo_access_point' | 'butterflymx_panel' | 'avigilon_alta_entry' | 'doorking_lock' | 'genie_door' | 'igloo_lock' | 'linear_lock' | 'lockly_lock' | 'kwikset_lock' | 'nuki_lock' | 'salto_lock' | 'schlage_lock' | 'smartthings_lock' | 'wyze_lock' | 'yale_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'four_suites_door' | 'dormakaba_oracode_door' | 'tedee_lock' | 'akiles_lock' | 'ultraloq_lock' | 'korelock_lock') | 'keynest_key' | ('noiseaware_activity_zone' | 'minut_sensor') | ('ecobee_thermostat' | 'nest_thermostat' | 'honeywell_resideo_thermostat' | 'tado_thermostat' | 'sensi_thermostat' | 'smartthings_thermostat') | ('ios_phone' | 'android_phone') | 'ring_camera')[] | undefined;
36089
36152
  /** Manufacturer for which you want to list devices. */
36090
- manufacturer?: ('akuvox' | 'august' | 'avigilon_alta' | 'brivo' | 'butterflymx' | 'doorking' | 'four_suites' | 'genie' | 'igloo' | 'keywe' | 'kwikset' | 'linear' | 'lockly' | 'nuki' | 'philia' | 'salto' | 'samsung' | 'schlage' | 'seam' | 'unknown' | 'wyze' | 'yale' | 'two_n' | 'ttlock' | 'igloohome' | 'controlbyweb' | 'dormakaba_oracode' | 'tedee' | 'korelock' | 'akiles' | 'ecobee' | 'honeywell_resideo' | 'keynest' | 'korelock' | 'minut' | 'nest' | 'noiseaware' | 'sensi' | 'smartthings' | 'tado' | 'ultraloq' | 'ring' | 'ical' | 'lodgify') | undefined;
36153
+ manufacturer?: ('akuvox' | 'august' | 'avigilon_alta' | 'brivo' | 'butterflymx' | 'doorking' | 'four_suites' | 'genie' | 'igloo' | 'keywe' | 'kwikset' | 'linear' | 'lockly' | 'nuki' | 'philia' | 'salto' | 'samsung' | 'schlage' | 'seam' | 'unknown' | 'wyze' | 'yale' | 'two_n' | 'ttlock' | 'igloohome' | 'controlbyweb' | 'dormakaba_oracode' | 'tedee' | 'korelock' | 'akiles' | 'ecobee' | 'honeywell_resideo' | 'keynest' | 'korelock' | 'minut' | 'nest' | 'noiseaware' | 'sensi' | 'smartthings' | 'tado' | 'ultraloq' | 'ring' | 'ical' | 'lodgify' | 'hostaway') | undefined;
36091
36154
  /** Array of device IDs for which you want to list devices. */
36092
36155
  device_ids?: string[] | undefined;
36093
36156
  /** Timestamp by which to limit returned devices. Returns devices created before this timestamp. */
@@ -64019,7 +64082,7 @@ export type Routes = {
64019
64082
  queryParams: {};
64020
64083
  jsonBody: {
64021
64084
  /** Type of connector to create */
64022
- connector_type: 'mock' | 'mews' | 'rms' | 'cloudbeds' | 'smoobu' | 'zonal' | 'ical' | 'lodgify';
64085
+ connector_type: 'mock' | 'mews' | 'rms' | 'cloudbeds' | 'smoobu' | 'zonal' | 'ical' | 'lodgify' | 'hostaway';
64023
64086
  /** Key identifying the customer */
64024
64087
  customer_key?: string | undefined;
64025
64088
  /** Instance-specific configuration for the connector */
@@ -68912,6 +68975,15 @@ export type Routes = {
68912
68975
  /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
68913
68976
  message: string;
68914
68977
  }[];
68978
+ /** Warnings associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
68979
+ warnings: {
68980
+ /** Date and time at which Seam created the warning. */
68981
+ created_at: string;
68982
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
68983
+ message: string;
68984
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
68985
+ warning_code: 'salto_ks_entrance_access_code_support_removed';
68986
+ }[];
68915
68987
  /** Latch-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
68916
68988
  latch_metadata?: {
68917
68989
  /** Accessibility type in the Latch access system. */
@@ -70730,6 +70802,15 @@ export type Routes = {
70730
70802
  /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
70731
70803
  message: string;
70732
70804
  }[];
70805
+ /** Warnings associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
70806
+ warnings: {
70807
+ /** Date and time at which Seam created the warning. */
70808
+ created_at: string;
70809
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
70810
+ message: string;
70811
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
70812
+ warning_code: 'salto_ks_entrance_access_code_support_removed';
70813
+ }[];
70733
70814
  /** Latch-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
70734
70815
  latch_metadata?: {
70735
70816
  /** Accessibility type in the Latch access system. */
@@ -91346,6 +91427,15 @@ export type Routes = {
91346
91427
  /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
91347
91428
  message: string;
91348
91429
  }[];
91430
+ /** Warnings associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
91431
+ warnings: {
91432
+ /** Date and time at which Seam created the warning. */
91433
+ created_at: string;
91434
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
91435
+ message: string;
91436
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
91437
+ warning_code: 'salto_ks_entrance_access_code_support_removed';
91438
+ }[];
91349
91439
  /** Latch-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
91350
91440
  latch_metadata?: {
91351
91441
  /** Accessibility type in the Latch access system. */
@@ -93824,6 +93914,15 @@ export type Routes = {
93824
93914
  /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
93825
93915
  message: string;
93826
93916
  }[];
93917
+ /** Warnings associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
93918
+ warnings: {
93919
+ /** Date and time at which Seam created the warning. */
93920
+ created_at: string;
93921
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
93922
+ message: string;
93923
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
93924
+ warning_code: 'salto_ks_entrance_access_code_support_removed';
93925
+ }[];
93827
93926
  /** Latch-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
93828
93927
  latch_metadata?: {
93829
93928
  /** Accessibility type in the Latch access system. */
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@seamapi/types",
3
- "version": "1.843.0",
3
+ "version": "1.845.0",
4
4
  "description": "TypeScript types for the Seam API.",
5
5
  "type": "module",
6
6
  "main": "index.js",
@@ -13,6 +13,47 @@ import {
13
13
  } from './metadata/index.js'
14
14
  import { acs_entrance_salto_space_metadata } from './metadata/salto-space.js'
15
15
 
16
+ const warning_code_description =
17
+ 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.'
18
+
19
+ const common_acs_entrance_warning = z.object({
20
+ created_at: z
21
+ .string()
22
+ .datetime()
23
+ .describe('Date and time at which Seam created the warning.'),
24
+ message: z
25
+ .string()
26
+ .describe(
27
+ 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
28
+ ),
29
+ })
30
+
31
+ const salto_ks_entrance_access_code_support_removed =
32
+ common_acs_entrance_warning
33
+ .extend({
34
+ warning_code: z
35
+ .literal('salto_ks_entrance_access_code_support_removed')
36
+ .describe(warning_code_description),
37
+ })
38
+ .describe(
39
+ 'Indicates that a change in the reported device model has been detected for this Salto KS entrance, which may occur after an IQ hub reset. Access code support may be affected. See https://help.getseam.com/articles/5098842588-salto-ks-lock-loses-access-code-support for troubleshooting steps.',
40
+ )
41
+
42
+ const acs_entrance_warning = z
43
+ .discriminatedUnion('warning_code', [
44
+ salto_ks_entrance_access_code_support_removed,
45
+ ])
46
+ .describe(
47
+ 'Warning associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
48
+ )
49
+
50
+ const _acs_entrance_warning_map = z.object({
51
+ salto_ks_entrance_access_code_support_removed:
52
+ salto_ks_entrance_access_code_support_removed.optional().nullable(),
53
+ })
54
+
55
+ export type AcsEntranceWarningMap = z.infer<typeof _acs_entrance_warning_map>
56
+
16
57
  export const acs_entrance_capability_flags = z.object({
17
58
  can_unlock_with_mobile_key: z
18
59
  .boolean()
@@ -98,6 +139,11 @@ export const acs_entrance = z
98
139
  .describe(
99
140
  'Errors associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
100
141
  ),
142
+ warnings: z
143
+ .array(acs_entrance_warning)
144
+ .describe(
145
+ 'Warnings associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
146
+ ),
101
147
  latch_metadata: acs_entrance_latch_metadata
102
148
  .optional()
103
149
  .describe(
@@ -56,6 +56,7 @@ export const DEVICE_PROVIDERS = {
56
56
  RING: 'ring',
57
57
  ICAL: 'ical',
58
58
  LODGIFY: 'lodgify',
59
+ HOSTAWAY: 'hostaway',
59
60
  } as const
60
61
 
61
62
  export type DeviceProviderName =
@@ -143,7 +144,7 @@ export const PROVIDER_CATEGORY_MAP = {
143
144
 
144
145
  cameras: ['ring'],
145
146
 
146
- connectors: ['ical', 'lodgify'],
147
+ connectors: ['ical', 'lodgify', 'hostaway'],
147
148
 
148
149
  internal_beta: ALL_DEVICE_PROVIDERS,
149
150
  } as const satisfies Record<string, readonly DeviceProviderName[]>
@@ -4651,6 +4651,43 @@ const openapi: OpenAPISpec = {
4651
4651
  required: ['door_name', 'door_category'],
4652
4652
  type: 'object',
4653
4653
  },
4654
+ warnings: {
4655
+ description:
4656
+ 'Warnings associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
4657
+ items: {
4658
+ description:
4659
+ 'Warning associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
4660
+ discriminator: { propertyName: 'warning_code' },
4661
+ oneOf: [
4662
+ {
4663
+ description:
4664
+ 'Indicates that a change in the reported device model has been detected for this Salto KS entrance, which may occur after an IQ hub reset. Access code support may be affected. See https://help.getseam.com/articles/5098842588-salto-ks-lock-loses-access-code-support for troubleshooting steps.',
4665
+ properties: {
4666
+ created_at: {
4667
+ description:
4668
+ 'Date and time at which Seam created the warning.',
4669
+ format: 'date-time',
4670
+ type: 'string',
4671
+ },
4672
+ message: {
4673
+ description:
4674
+ 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
4675
+ type: 'string',
4676
+ },
4677
+ warning_code: {
4678
+ description:
4679
+ 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
4680
+ enum: ['salto_ks_entrance_access_code_support_removed'],
4681
+ type: 'string',
4682
+ },
4683
+ },
4684
+ required: ['created_at', 'message', 'warning_code'],
4685
+ type: 'object',
4686
+ },
4687
+ ],
4688
+ },
4689
+ type: 'array',
4690
+ },
4654
4691
  },
4655
4692
  required: [
4656
4693
  'acs_system_id',
@@ -4660,6 +4697,7 @@ const openapi: OpenAPISpec = {
4660
4697
  'display_name',
4661
4698
  'connected_account_id',
4662
4699
  'errors',
4700
+ 'warnings',
4663
4701
  ],
4664
4702
  type: 'object',
4665
4703
  'x-route-path': '/acs/entrances',
@@ -15826,6 +15864,7 @@ const openapi: OpenAPISpec = {
15826
15864
  'ring',
15827
15865
  'ical',
15828
15866
  'lodgify',
15867
+ 'hostaway',
15829
15868
  ],
15830
15869
  type: 'string',
15831
15870
  },
@@ -25428,6 +25467,49 @@ const openapi: OpenAPISpec = {
25428
25467
  required: ['door_name', 'door_category'],
25429
25468
  type: 'object',
25430
25469
  },
25470
+ warnings: {
25471
+ description:
25472
+ 'Warnings associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
25473
+ items: {
25474
+ description:
25475
+ 'Warning associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
25476
+ discriminator: { propertyName: 'warning_code' },
25477
+ oneOf: [
25478
+ {
25479
+ description:
25480
+ 'Indicates that a change in the reported device model has been detected for this Salto KS entrance, which may occur after an IQ hub reset. Access code support may be affected. See https://help.getseam.com/articles/5098842588-salto-ks-lock-loses-access-code-support for troubleshooting steps.',
25481
+ properties: {
25482
+ created_at: {
25483
+ description:
25484
+ 'Date and time at which Seam created the warning.',
25485
+ format: 'date-time',
25486
+ type: 'string',
25487
+ },
25488
+ message: {
25489
+ description:
25490
+ 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
25491
+ type: 'string',
25492
+ },
25493
+ warning_code: {
25494
+ description:
25495
+ 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
25496
+ enum: [
25497
+ 'salto_ks_entrance_access_code_support_removed',
25498
+ ],
25499
+ type: 'string',
25500
+ },
25501
+ },
25502
+ required: [
25503
+ 'created_at',
25504
+ 'message',
25505
+ 'warning_code',
25506
+ ],
25507
+ type: 'object',
25508
+ },
25509
+ ],
25510
+ },
25511
+ type: 'array',
25512
+ },
25431
25513
  },
25432
25514
  required: [
25433
25515
  'acs_system_id',
@@ -25437,6 +25519,7 @@ const openapi: OpenAPISpec = {
25437
25519
  'display_name',
25438
25520
  'connected_account_id',
25439
25521
  'errors',
25522
+ 'warnings',
25440
25523
  ],
25441
25524
  type: 'object',
25442
25525
  'x-route-path': '/acs/entrances',
@@ -49775,6 +49858,7 @@ const openapi: OpenAPISpec = {
49775
49858
  'ring',
49776
49859
  'ical',
49777
49860
  'lodgify',
49861
+ 'hostaway',
49778
49862
  'yale_access',
49779
49863
  'hid_cm',
49780
49864
  'google_nest',
@@ -54085,6 +54169,7 @@ const openapi: OpenAPISpec = {
54085
54169
  'ring',
54086
54170
  'ical',
54087
54171
  'lodgify',
54172
+ 'hostaway',
54088
54173
  ],
54089
54174
  type: 'string',
54090
54175
  },
@@ -54601,6 +54686,7 @@ const openapi: OpenAPISpec = {
54601
54686
  'ring',
54602
54687
  'ical',
54603
54688
  'lodgify',
54689
+ 'hostaway',
54604
54690
  ],
54605
54691
  type: 'string',
54606
54692
  },
@@ -56432,6 +56518,7 @@ const openapi: OpenAPISpec = {
56432
56518
  'ring',
56433
56519
  'ical',
56434
56520
  'lodgify',
56521
+ 'hostaway',
56435
56522
  ],
56436
56523
  type: 'string',
56437
56524
  },
@@ -56947,6 +57034,7 @@ const openapi: OpenAPISpec = {
56947
57034
  'ring',
56948
57035
  'ical',
56949
57036
  'lodgify',
57037
+ 'hostaway',
56950
57038
  ],
56951
57039
  type: 'string',
56952
57040
  },
@@ -65637,6 +65725,7 @@ const openapi: OpenAPISpec = {
65637
65725
  'zonal',
65638
65726
  'ical',
65639
65727
  'lodgify',
65728
+ 'hostaway',
65640
65729
  ],
65641
65730
  type: 'string',
65642
65731
  },