@seamapi/types 1.992.0 → 1.994.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.
@@ -10887,27 +10887,10 @@ export type Routes = {
10887
10887
  /** */
10888
10888
  sync?: boolean
10889
10889
  attempt_for_offline_device?: boolean
10890
- /** 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`. */
10891
- prefer_native_scheduling?: boolean | undefined
10892
- /** 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). */
10893
- use_backup_access_code_pool?: boolean | undefined
10894
10890
  /** Indicates whether [external modification](https://docs.seam.co/low-level-apis/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`. */
10895
10891
  allow_external_modification?: boolean | undefined
10896
10892
  /** Indicates whether [external modification](https://docs.seam.co/low-level-apis/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`. */
10897
10893
  is_external_modification_allowed?: boolean | undefined
10898
- /** 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. */
10899
- preferred_code_length?: number | undefined
10900
- /**
10901
- * @deprecated Use `is_offline_access_code` instead.*/
10902
- use_offline_access_code?: boolean | undefined
10903
- /** Indicates whether the access code is an [offline access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes/offline-access-codes). */
10904
- is_offline_access_code?: boolean | undefined
10905
- /** 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. */
10906
- is_one_time_use?: boolean | undefined
10907
- /** 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`. */
10908
- max_time_rounding?:
10909
- | (('1hour' | '1day' | '1h' | '1d') | undefined)
10910
- | undefined
10911
10894
  /** ID of the access code that you want to update. */
10912
10895
  access_code_id: string
10913
10896
  /** ID of the device containing the access code that you want to update. */
@@ -56384,14 +56367,6 @@ export type Routes = {
56384
56367
  device_ids?: string[] | undefined
56385
56368
  /** Timestamp by which to limit returned devices. Returns devices created before this timestamp. */
56386
56369
  created_before?: Date | undefined
56387
- /** Your own internal user ID for the user for which you want to list devices. */
56388
- user_identifier_key?: string | undefined
56389
- /** 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. */
56390
- custom_metadata_has?:
56391
- | {
56392
- [x: string]: string | boolean
56393
- }
56394
- | undefined
56395
56370
  /** Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`. */
56396
56371
  page_cursor?: (string | undefined) | null
56397
56372
  /** */
@@ -56444,11 +56419,6 @@ export type Routes = {
56444
56419
  | 'can_configure_auto_lock'
56445
56420
  )[]
56446
56421
  | undefined
56447
- /**
56448
- * @deprecated Use `space_id`.*/
56449
- unstable_location_id?: (string | null) | undefined
56450
- /** ID of the space for which you want to list devices. */
56451
- space_id?: string | undefined
56452
56422
  /** 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`. */
56453
56423
  search?: string | undefined
56454
56424
  /** Numerical limit on the number of devices to return. */
@@ -70619,8 +70589,6 @@ export type Routes = {
70619
70589
  customer_key?: string | undefined
70620
70590
  /** ID of the connected account for which you want to list devices. */
70621
70591
  connected_account_id?: string | undefined
70622
- /** Array of IDs of the connected accounts for which you want to list devices. */
70623
- connected_account_ids?: string[] | undefined
70624
70592
  /** ID of the Connect Webview for which you want to list devices. */
70625
70593
  connect_webview_id?: string | undefined
70626
70594
  /** Device type of the locks that you want to list. */
@@ -70730,79 +70698,6 @@ export type Routes = {
70730
70698
  | 'kisi'
70731
70699
  )
70732
70700
  | undefined
70733
- /** Array of device IDs for which you want to list devices. */
70734
- device_ids?: string[] | undefined
70735
- /** Numerical limit on the number of devices to return. */
70736
- limit?: number
70737
- /** Timestamp by which to limit returned devices. Returns devices created before this timestamp. */
70738
- created_before?: Date | undefined
70739
- /** Your own internal user ID for the user for which you want to list devices. */
70740
- user_identifier_key?: string | undefined
70741
- /** 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. */
70742
- custom_metadata_has?:
70743
- | {
70744
- [x: string]: string | boolean
70745
- }
70746
- | undefined
70747
- /** Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`. */
70748
- page_cursor?: (string | undefined) | null
70749
- /** */
70750
- include_if?:
70751
- | (
70752
- | 'can_remotely_unlock'
70753
- | 'can_remotely_lock'
70754
- | 'can_program_offline_access_codes'
70755
- | 'can_program_online_access_codes'
70756
- | 'can_hvac_heat'
70757
- | 'can_hvac_cool'
70758
- | 'can_hvac_heat_cool'
70759
- | 'can_turn_off_hvac'
70760
- | 'can_simulate_removal'
70761
- | 'can_simulate_connection'
70762
- | 'can_simulate_disconnection'
70763
- | 'can_unlock_with_code'
70764
- | 'can_run_thermostat_programs'
70765
- | 'can_program_thermostat_programs_as_weekday_weekend'
70766
- | 'can_program_thermostat_programs_as_different_each_day'
70767
- | 'can_program_thermostat_programs_as_same_each_day'
70768
- | 'can_simulate_hub_connection'
70769
- | 'can_simulate_hub_disconnection'
70770
- | 'can_simulate_paid_subscription'
70771
- | 'can_configure_auto_lock'
70772
- )[]
70773
- | undefined
70774
- /** */
70775
- exclude_if?:
70776
- | (
70777
- | 'can_remotely_unlock'
70778
- | 'can_remotely_lock'
70779
- | 'can_program_offline_access_codes'
70780
- | 'can_program_online_access_codes'
70781
- | 'can_hvac_heat'
70782
- | 'can_hvac_cool'
70783
- | 'can_hvac_heat_cool'
70784
- | 'can_turn_off_hvac'
70785
- | 'can_simulate_removal'
70786
- | 'can_simulate_connection'
70787
- | 'can_simulate_disconnection'
70788
- | 'can_unlock_with_code'
70789
- | 'can_run_thermostat_programs'
70790
- | 'can_program_thermostat_programs_as_weekday_weekend'
70791
- | 'can_program_thermostat_programs_as_different_each_day'
70792
- | 'can_program_thermostat_programs_as_same_each_day'
70793
- | 'can_simulate_hub_connection'
70794
- | 'can_simulate_hub_disconnection'
70795
- | 'can_simulate_paid_subscription'
70796
- | 'can_configure_auto_lock'
70797
- )[]
70798
- | undefined
70799
- /**
70800
- * @deprecated Use `space_id`.*/
70801
- unstable_location_id?: (string | null) | undefined
70802
- /** ID of the space for which you want to list devices. */
70803
- space_id?: string | undefined
70804
- /** 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`. */
70805
- search?: string | undefined
70806
70701
  }
70807
70702
  formData: {}
70808
70703
  jsonResponse: {
@@ -82915,8 +82810,6 @@ export type Routes = {
82915
82810
  customer_key?: string | undefined
82916
82811
  /** ID of the connected account for which you want to list devices. */
82917
82812
  connected_account_id?: string | undefined
82918
- /** Array of IDs of the connected accounts for which you want to list devices. */
82919
- connected_account_ids?: string[] | undefined
82920
82813
  /** ID of the Connect Webview for which you want to list devices. */
82921
82814
  connect_webview_id?: string | undefined
82922
82815
  /** Device type of the noise sensors that you want to list. */
@@ -82925,79 +82818,6 @@ export type Routes = {
82925
82818
  device_types?: ('noiseaware_activity_zone' | 'minut_sensor')[] | undefined
82926
82819
  /** Manufacturers of the noise sensors that you want to list. */
82927
82820
  manufacturer?: ('minut' | 'noiseaware') | undefined
82928
- /** Array of device IDs for which you want to list devices. */
82929
- device_ids?: string[] | undefined
82930
- /** Numerical limit on the number of devices to return. */
82931
- limit?: number
82932
- /** Timestamp by which to limit returned devices. Returns devices created before this timestamp. */
82933
- created_before?: Date | undefined
82934
- /** Your own internal user ID for the user for which you want to list devices. */
82935
- user_identifier_key?: string | undefined
82936
- /** 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. */
82937
- custom_metadata_has?:
82938
- | {
82939
- [x: string]: string | boolean
82940
- }
82941
- | undefined
82942
- /** Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`. */
82943
- page_cursor?: (string | undefined) | null
82944
- /** */
82945
- include_if?:
82946
- | (
82947
- | 'can_remotely_unlock'
82948
- | 'can_remotely_lock'
82949
- | 'can_program_offline_access_codes'
82950
- | 'can_program_online_access_codes'
82951
- | 'can_hvac_heat'
82952
- | 'can_hvac_cool'
82953
- | 'can_hvac_heat_cool'
82954
- | 'can_turn_off_hvac'
82955
- | 'can_simulate_removal'
82956
- | 'can_simulate_connection'
82957
- | 'can_simulate_disconnection'
82958
- | 'can_unlock_with_code'
82959
- | 'can_run_thermostat_programs'
82960
- | 'can_program_thermostat_programs_as_weekday_weekend'
82961
- | 'can_program_thermostat_programs_as_different_each_day'
82962
- | 'can_program_thermostat_programs_as_same_each_day'
82963
- | 'can_simulate_hub_connection'
82964
- | 'can_simulate_hub_disconnection'
82965
- | 'can_simulate_paid_subscription'
82966
- | 'can_configure_auto_lock'
82967
- )[]
82968
- | undefined
82969
- /** */
82970
- exclude_if?:
82971
- | (
82972
- | 'can_remotely_unlock'
82973
- | 'can_remotely_lock'
82974
- | 'can_program_offline_access_codes'
82975
- | 'can_program_online_access_codes'
82976
- | 'can_hvac_heat'
82977
- | 'can_hvac_cool'
82978
- | 'can_hvac_heat_cool'
82979
- | 'can_turn_off_hvac'
82980
- | 'can_simulate_removal'
82981
- | 'can_simulate_connection'
82982
- | 'can_simulate_disconnection'
82983
- | 'can_unlock_with_code'
82984
- | 'can_run_thermostat_programs'
82985
- | 'can_program_thermostat_programs_as_weekday_weekend'
82986
- | 'can_program_thermostat_programs_as_different_each_day'
82987
- | 'can_program_thermostat_programs_as_same_each_day'
82988
- | 'can_simulate_hub_connection'
82989
- | 'can_simulate_hub_disconnection'
82990
- | 'can_simulate_paid_subscription'
82991
- | 'can_configure_auto_lock'
82992
- )[]
82993
- | undefined
82994
- /**
82995
- * @deprecated Use `space_id`.*/
82996
- unstable_location_id?: (string | null) | undefined
82997
- /** ID of the space for which you want to list devices. */
82998
- space_id?: string | undefined
82999
- /** 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`. */
83000
- search?: string | undefined
83001
82821
  }
83002
82822
  formData: {}
83003
82823
  jsonResponse: {
@@ -120192,8 +120012,6 @@ export type Routes = {
120192
120012
  customer_key?: string | undefined
120193
120013
  /** ID of the connected account for which you want to list devices. */
120194
120014
  connected_account_id?: string | undefined
120195
- /** Array of IDs of the connected accounts for which you want to list devices. */
120196
- connected_account_ids?: string[] | undefined
120197
120015
  /** ID of the Connect Webview for which you want to list devices. */
120198
120016
  connect_webview_id?: string | undefined
120199
120017
  /** Device type by which you want to filter thermostat devices. */
@@ -120229,79 +120047,6 @@ export type Routes = {
120229
120047
  | 'tado'
120230
120048
  )
120231
120049
  | undefined
120232
- /** Array of device IDs for which you want to list devices. */
120233
- device_ids?: string[] | undefined
120234
- /** Numerical limit on the number of devices to return. */
120235
- limit?: number
120236
- /** Timestamp by which to limit returned devices. Returns devices created before this timestamp. */
120237
- created_before?: Date | undefined
120238
- /** Your own internal user ID for the user for which you want to list devices. */
120239
- user_identifier_key?: string | undefined
120240
- /** 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. */
120241
- custom_metadata_has?:
120242
- | {
120243
- [x: string]: string | boolean
120244
- }
120245
- | undefined
120246
- /** Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`. */
120247
- page_cursor?: (string | undefined) | null
120248
- /** */
120249
- include_if?:
120250
- | (
120251
- | 'can_remotely_unlock'
120252
- | 'can_remotely_lock'
120253
- | 'can_program_offline_access_codes'
120254
- | 'can_program_online_access_codes'
120255
- | 'can_hvac_heat'
120256
- | 'can_hvac_cool'
120257
- | 'can_hvac_heat_cool'
120258
- | 'can_turn_off_hvac'
120259
- | 'can_simulate_removal'
120260
- | 'can_simulate_connection'
120261
- | 'can_simulate_disconnection'
120262
- | 'can_unlock_with_code'
120263
- | 'can_run_thermostat_programs'
120264
- | 'can_program_thermostat_programs_as_weekday_weekend'
120265
- | 'can_program_thermostat_programs_as_different_each_day'
120266
- | 'can_program_thermostat_programs_as_same_each_day'
120267
- | 'can_simulate_hub_connection'
120268
- | 'can_simulate_hub_disconnection'
120269
- | 'can_simulate_paid_subscription'
120270
- | 'can_configure_auto_lock'
120271
- )[]
120272
- | undefined
120273
- /** */
120274
- exclude_if?:
120275
- | (
120276
- | 'can_remotely_unlock'
120277
- | 'can_remotely_lock'
120278
- | 'can_program_offline_access_codes'
120279
- | 'can_program_online_access_codes'
120280
- | 'can_hvac_heat'
120281
- | 'can_hvac_cool'
120282
- | 'can_hvac_heat_cool'
120283
- | 'can_turn_off_hvac'
120284
- | 'can_simulate_removal'
120285
- | 'can_simulate_connection'
120286
- | 'can_simulate_disconnection'
120287
- | 'can_unlock_with_code'
120288
- | 'can_run_thermostat_programs'
120289
- | 'can_program_thermostat_programs_as_weekday_weekend'
120290
- | 'can_program_thermostat_programs_as_different_each_day'
120291
- | 'can_program_thermostat_programs_as_same_each_day'
120292
- | 'can_simulate_hub_connection'
120293
- | 'can_simulate_hub_disconnection'
120294
- | 'can_simulate_paid_subscription'
120295
- | 'can_configure_auto_lock'
120296
- )[]
120297
- | undefined
120298
- /**
120299
- * @deprecated Use `space_id`.*/
120300
- unstable_location_id?: (string | null) | undefined
120301
- /** ID of the space for which you want to list devices. */
120302
- space_id?: string | undefined
120303
- /** 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`. */
120304
- search?: string | undefined
120305
120050
  }
120306
120051
  formData: {}
120307
120052
  jsonResponse: {