@seamapi/types 1.992.0 → 1.993.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.
@@ -9397,25 +9397,10 @@ export type Routes = {
9397
9397
  /** */
9398
9398
  sync?: boolean;
9399
9399
  attempt_for_offline_device?: boolean;
9400
- /** Indicates whether [native scheduling](https://docs.seam.co/low-level-apis/smart-locks/access-codes#native-scheduling) should be used for time-bound codes when supported by the provider. Default: `true`. */
9401
- prefer_native_scheduling?: boolean | undefined;
9402
- /** Indicates whether to use a [backup access code pool](https://docs.seam.co/low-level-apis/smart-locks/access-codes/backup-access-codes) provided by Seam. If `true`, you can use [`/access_codes/pull_backup_access_code`](https://docs.seam.co/api/access_codes/pull_backup_access_code). */
9403
- use_backup_access_code_pool?: boolean | undefined;
9404
9400
  /** Indicates whether [external modification](https://docs.seam.co/low-level-apis/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`. */
9405
9401
  allow_external_modification?: boolean | undefined;
9406
9402
  /** Indicates whether [external modification](https://docs.seam.co/low-level-apis/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`. */
9407
9403
  is_external_modification_allowed?: boolean | undefined;
9408
- /** Preferred code length. Only applicable if you do not specify a `code`. If the affected device does not support the preferred code length, Seam reverts to using the shortest supported code length. */
9409
- preferred_code_length?: number | undefined;
9410
- /**
9411
- * @deprecated Use `is_offline_access_code` instead.*/
9412
- use_offline_access_code?: boolean | undefined;
9413
- /** Indicates whether the access code is an [offline access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes/offline-access-codes). */
9414
- is_offline_access_code?: boolean | undefined;
9415
- /** Indicates whether the [offline access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes/offline-access-codes) is a single-use access code. */
9416
- is_one_time_use?: boolean | undefined;
9417
- /** Maximum rounding adjustment. To create a daily-bound [offline access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes/offline-access-codes) for devices that support this feature, set this parameter to `1d`. */
9418
- max_time_rounding?: (('1hour' | '1day' | '1h' | '1d') | undefined) | undefined;
9419
9404
  /** ID of the access code that you want to update. */
9420
9405
  access_code_id: string;
9421
9406
  /** ID of the device containing the access code that you want to update. */
@@ -45655,23 +45640,12 @@ export type Routes = {
45655
45640
  device_ids?: string[] | undefined;
45656
45641
  /** Timestamp by which to limit returned devices. Returns devices created before this timestamp. */
45657
45642
  created_before?: Date | undefined;
45658
- /** Your own internal user ID for the user for which you want to list devices. */
45659
- user_identifier_key?: string | undefined;
45660
- /** Set of key:value [custom metadata](https://docs.seam.co/core-concepts/devices/adding-custom-metadata-to-a-device) pairs for which you want to list devices. */
45661
- custom_metadata_has?: {
45662
- [x: string]: string | boolean;
45663
- } | undefined;
45664
45643
  /** Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`. */
45665
45644
  page_cursor?: (string | undefined) | null;
45666
45645
  /** */
45667
45646
  include_if?: ('can_remotely_unlock' | 'can_remotely_lock' | 'can_program_offline_access_codes' | 'can_program_online_access_codes' | 'can_hvac_heat' | 'can_hvac_cool' | 'can_hvac_heat_cool' | 'can_turn_off_hvac' | 'can_simulate_removal' | 'can_simulate_connection' | 'can_simulate_disconnection' | 'can_unlock_with_code' | 'can_run_thermostat_programs' | 'can_program_thermostat_programs_as_weekday_weekend' | 'can_program_thermostat_programs_as_different_each_day' | 'can_program_thermostat_programs_as_same_each_day' | 'can_simulate_hub_connection' | 'can_simulate_hub_disconnection' | 'can_simulate_paid_subscription' | 'can_configure_auto_lock')[] | undefined;
45668
45647
  /** */
45669
45648
  exclude_if?: ('can_remotely_unlock' | 'can_remotely_lock' | 'can_program_offline_access_codes' | 'can_program_online_access_codes' | 'can_hvac_heat' | 'can_hvac_cool' | 'can_hvac_heat_cool' | 'can_turn_off_hvac' | 'can_simulate_removal' | 'can_simulate_connection' | 'can_simulate_disconnection' | 'can_unlock_with_code' | 'can_run_thermostat_programs' | 'can_program_thermostat_programs_as_weekday_weekend' | 'can_program_thermostat_programs_as_different_each_day' | 'can_program_thermostat_programs_as_same_each_day' | 'can_simulate_hub_connection' | 'can_simulate_hub_disconnection' | 'can_simulate_paid_subscription' | 'can_configure_auto_lock')[] | undefined;
45670
- /**
45671
- * @deprecated Use `space_id`.*/
45672
- unstable_location_id?: (string | null) | undefined;
45673
- /** ID of the space for which you want to list devices. */
45674
- space_id?: string | undefined;
45675
45649
  /** String for which to search. Filters returned devices to include all records that satisfy a partial match using `device_id` (full or partial UUID prefix, minimum 4 characters), `connected_account_id`, `display_name`, `custom_metadata` or `location.location_name`. */
45676
45650
  search?: string | undefined;
45677
45651
  /** Numerical limit on the number of devices to return. */
@@ -57554,8 +57528,6 @@ export type Routes = {
57554
57528
  customer_key?: string | undefined;
57555
57529
  /** ID of the connected account for which you want to list devices. */
57556
57530
  connected_account_id?: string | undefined;
57557
- /** Array of IDs of the connected accounts for which you want to list devices. */
57558
- connected_account_ids?: string[] | undefined;
57559
57531
  /** ID of the Connect Webview for which you want to list devices. */
57560
57532
  connect_webview_id?: string | undefined;
57561
57533
  /** Device type of the locks that you want to list. */
@@ -57564,31 +57536,6 @@ export type Routes = {
57564
57536
  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' | 'keyincode_lock' | 'omnitec_lock' | 'kisi_lock' | 'aqara_lock')[] | undefined;
57565
57537
  /** Manufacturer of the locks that you want to list. */
57566
57538
  manufacturer?: ('akuvox' | 'august' | 'brivo' | 'butterflymx' | 'avigilon_alta' | 'doorking' | 'genie' | 'igloo' | 'linear' | 'lockly' | 'kwikset' | 'nuki' | 'salto' | 'schlage' | 'seam' | 'wyze' | 'yale' | 'two_n' | 'controlbyweb' | 'ttlock' | 'igloohome' | 'four_suites' | 'dormakaba_oracode' | 'tedee' | 'keyincode' | 'akiles' | 'aqara' | 'korelock' | 'smartthings' | 'ultraloq' | 'omnitec' | 'kisi') | undefined;
57567
- /** Array of device IDs for which you want to list devices. */
57568
- device_ids?: string[] | undefined;
57569
- /** Numerical limit on the number of devices to return. */
57570
- limit?: number;
57571
- /** Timestamp by which to limit returned devices. Returns devices created before this timestamp. */
57572
- created_before?: Date | undefined;
57573
- /** Your own internal user ID for the user for which you want to list devices. */
57574
- user_identifier_key?: string | undefined;
57575
- /** Set of key:value [custom metadata](https://docs.seam.co/core-concepts/devices/adding-custom-metadata-to-a-device) pairs for which you want to list devices. */
57576
- custom_metadata_has?: {
57577
- [x: string]: string | boolean;
57578
- } | undefined;
57579
- /** Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`. */
57580
- page_cursor?: (string | undefined) | null;
57581
- /** */
57582
- include_if?: ('can_remotely_unlock' | 'can_remotely_lock' | 'can_program_offline_access_codes' | 'can_program_online_access_codes' | 'can_hvac_heat' | 'can_hvac_cool' | 'can_hvac_heat_cool' | 'can_turn_off_hvac' | 'can_simulate_removal' | 'can_simulate_connection' | 'can_simulate_disconnection' | 'can_unlock_with_code' | 'can_run_thermostat_programs' | 'can_program_thermostat_programs_as_weekday_weekend' | 'can_program_thermostat_programs_as_different_each_day' | 'can_program_thermostat_programs_as_same_each_day' | 'can_simulate_hub_connection' | 'can_simulate_hub_disconnection' | 'can_simulate_paid_subscription' | 'can_configure_auto_lock')[] | undefined;
57583
- /** */
57584
- exclude_if?: ('can_remotely_unlock' | 'can_remotely_lock' | 'can_program_offline_access_codes' | 'can_program_online_access_codes' | 'can_hvac_heat' | 'can_hvac_cool' | 'can_hvac_heat_cool' | 'can_turn_off_hvac' | 'can_simulate_removal' | 'can_simulate_connection' | 'can_simulate_disconnection' | 'can_unlock_with_code' | 'can_run_thermostat_programs' | 'can_program_thermostat_programs_as_weekday_weekend' | 'can_program_thermostat_programs_as_different_each_day' | 'can_program_thermostat_programs_as_same_each_day' | 'can_simulate_hub_connection' | 'can_simulate_hub_disconnection' | 'can_simulate_paid_subscription' | 'can_configure_auto_lock')[] | undefined;
57585
- /**
57586
- * @deprecated Use `space_id`.*/
57587
- unstable_location_id?: (string | null) | undefined;
57588
- /** ID of the space for which you want to list devices. */
57589
- space_id?: string | undefined;
57590
- /** String for which to search. Filters returned devices to include all records that satisfy a partial match using `device_id` (full or partial UUID prefix, minimum 4 characters), `connected_account_id`, `display_name`, `custom_metadata` or `location.location_name`. */
57591
- search?: string | undefined;
57592
57539
  };
57593
57540
  formData: {};
57594
57541
  jsonResponse: {
@@ -67525,8 +67472,6 @@ export type Routes = {
67525
67472
  customer_key?: string | undefined;
67526
67473
  /** ID of the connected account for which you want to list devices. */
67527
67474
  connected_account_id?: string | undefined;
67528
- /** Array of IDs of the connected accounts for which you want to list devices. */
67529
- connected_account_ids?: string[] | undefined;
67530
67475
  /** ID of the Connect Webview for which you want to list devices. */
67531
67476
  connect_webview_id?: string | undefined;
67532
67477
  /** Device type of the noise sensors that you want to list. */
@@ -67535,31 +67480,6 @@ export type Routes = {
67535
67480
  device_types?: ('noiseaware_activity_zone' | 'minut_sensor')[] | undefined;
67536
67481
  /** Manufacturers of the noise sensors that you want to list. */
67537
67482
  manufacturer?: ('minut' | 'noiseaware') | undefined;
67538
- /** Array of device IDs for which you want to list devices. */
67539
- device_ids?: string[] | undefined;
67540
- /** Numerical limit on the number of devices to return. */
67541
- limit?: number;
67542
- /** Timestamp by which to limit returned devices. Returns devices created before this timestamp. */
67543
- created_before?: Date | undefined;
67544
- /** Your own internal user ID for the user for which you want to list devices. */
67545
- user_identifier_key?: string | undefined;
67546
- /** Set of key:value [custom metadata](https://docs.seam.co/core-concepts/devices/adding-custom-metadata-to-a-device) pairs for which you want to list devices. */
67547
- custom_metadata_has?: {
67548
- [x: string]: string | boolean;
67549
- } | undefined;
67550
- /** Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`. */
67551
- page_cursor?: (string | undefined) | null;
67552
- /** */
67553
- include_if?: ('can_remotely_unlock' | 'can_remotely_lock' | 'can_program_offline_access_codes' | 'can_program_online_access_codes' | 'can_hvac_heat' | 'can_hvac_cool' | 'can_hvac_heat_cool' | 'can_turn_off_hvac' | 'can_simulate_removal' | 'can_simulate_connection' | 'can_simulate_disconnection' | 'can_unlock_with_code' | 'can_run_thermostat_programs' | 'can_program_thermostat_programs_as_weekday_weekend' | 'can_program_thermostat_programs_as_different_each_day' | 'can_program_thermostat_programs_as_same_each_day' | 'can_simulate_hub_connection' | 'can_simulate_hub_disconnection' | 'can_simulate_paid_subscription' | 'can_configure_auto_lock')[] | undefined;
67554
- /** */
67555
- exclude_if?: ('can_remotely_unlock' | 'can_remotely_lock' | 'can_program_offline_access_codes' | 'can_program_online_access_codes' | 'can_hvac_heat' | 'can_hvac_cool' | 'can_hvac_heat_cool' | 'can_turn_off_hvac' | 'can_simulate_removal' | 'can_simulate_connection' | 'can_simulate_disconnection' | 'can_unlock_with_code' | 'can_run_thermostat_programs' | 'can_program_thermostat_programs_as_weekday_weekend' | 'can_program_thermostat_programs_as_different_each_day' | 'can_program_thermostat_programs_as_same_each_day' | 'can_simulate_hub_connection' | 'can_simulate_hub_disconnection' | 'can_simulate_paid_subscription' | 'can_configure_auto_lock')[] | undefined;
67556
- /**
67557
- * @deprecated Use `space_id`.*/
67558
- unstable_location_id?: (string | null) | undefined;
67559
- /** ID of the space for which you want to list devices. */
67560
- space_id?: string | undefined;
67561
- /** String for which to search. Filters returned devices to include all records that satisfy a partial match using `device_id` (full or partial UUID prefix, minimum 4 characters), `connected_account_id`, `display_name`, `custom_metadata` or `location.location_name`. */
67562
- search?: string | undefined;
67563
67483
  };
67564
67484
  formData: {};
67565
67485
  jsonResponse: {
@@ -98471,8 +98391,6 @@ export type Routes = {
98471
98391
  customer_key?: string | undefined;
98472
98392
  /** ID of the connected account for which you want to list devices. */
98473
98393
  connected_account_id?: string | undefined;
98474
- /** Array of IDs of the connected accounts for which you want to list devices. */
98475
- connected_account_ids?: string[] | undefined;
98476
98394
  /** ID of the Connect Webview for which you want to list devices. */
98477
98395
  connect_webview_id?: string | undefined;
98478
98396
  /** Device type by which you want to filter thermostat devices. */
@@ -98481,31 +98399,6 @@ export type Routes = {
98481
98399
  device_types?: ('ecobee_thermostat' | 'nest_thermostat' | 'honeywell_resideo_thermostat' | 'tado_thermostat' | 'sensi_thermostat' | 'smartthings_thermostat')[] | undefined;
98482
98400
  /** Manufacturer by which you want to filter thermostat devices. */
98483
98401
  manufacturer?: ('ecobee' | 'honeywell_resideo' | 'nest' | 'sensi' | 'smartthings' | 'tado') | undefined;
98484
- /** Array of device IDs for which you want to list devices. */
98485
- device_ids?: string[] | undefined;
98486
- /** Numerical limit on the number of devices to return. */
98487
- limit?: number;
98488
- /** Timestamp by which to limit returned devices. Returns devices created before this timestamp. */
98489
- created_before?: Date | undefined;
98490
- /** Your own internal user ID for the user for which you want to list devices. */
98491
- user_identifier_key?: string | undefined;
98492
- /** Set of key:value [custom metadata](https://docs.seam.co/core-concepts/devices/adding-custom-metadata-to-a-device) pairs for which you want to list devices. */
98493
- custom_metadata_has?: {
98494
- [x: string]: string | boolean;
98495
- } | undefined;
98496
- /** Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`. */
98497
- page_cursor?: (string | undefined) | null;
98498
- /** */
98499
- include_if?: ('can_remotely_unlock' | 'can_remotely_lock' | 'can_program_offline_access_codes' | 'can_program_online_access_codes' | 'can_hvac_heat' | 'can_hvac_cool' | 'can_hvac_heat_cool' | 'can_turn_off_hvac' | 'can_simulate_removal' | 'can_simulate_connection' | 'can_simulate_disconnection' | 'can_unlock_with_code' | 'can_run_thermostat_programs' | 'can_program_thermostat_programs_as_weekday_weekend' | 'can_program_thermostat_programs_as_different_each_day' | 'can_program_thermostat_programs_as_same_each_day' | 'can_simulate_hub_connection' | 'can_simulate_hub_disconnection' | 'can_simulate_paid_subscription' | 'can_configure_auto_lock')[] | undefined;
98500
- /** */
98501
- exclude_if?: ('can_remotely_unlock' | 'can_remotely_lock' | 'can_program_offline_access_codes' | 'can_program_online_access_codes' | 'can_hvac_heat' | 'can_hvac_cool' | 'can_hvac_heat_cool' | 'can_turn_off_hvac' | 'can_simulate_removal' | 'can_simulate_connection' | 'can_simulate_disconnection' | 'can_unlock_with_code' | 'can_run_thermostat_programs' | 'can_program_thermostat_programs_as_weekday_weekend' | 'can_program_thermostat_programs_as_different_each_day' | 'can_program_thermostat_programs_as_same_each_day' | 'can_simulate_hub_connection' | 'can_simulate_hub_disconnection' | 'can_simulate_paid_subscription' | 'can_configure_auto_lock')[] | undefined;
98502
- /**
98503
- * @deprecated Use `space_id`.*/
98504
- unstable_location_id?: (string | null) | undefined;
98505
- /** ID of the space for which you want to list devices. */
98506
- space_id?: string | undefined;
98507
- /** String for which to search. Filters returned devices to include all records that satisfy a partial match using `device_id` (full or partial UUID prefix, minimum 4 characters), `connected_account_id`, `display_name`, `custom_metadata` or `location.location_name`. */
98508
- search?: string | undefined;
98509
98402
  };
98510
98403
  formData: {};
98511
98404
  jsonResponse: {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@seamapi/types",
3
- "version": "1.992.0",
3
+ "version": "1.993.0",
4
4
  "description": "TypeScript types for the Seam API.",
5
5
  "type": "module",
6
6
  "main": "index.js",