@seamapi/http 2.47.0 → 2.49.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.
- package/lib/resources/device-provider.d.ts +1 -1
- package/lib/resources/device.d.ts +30 -1
- package/lib/resources/event.d.ts +126 -0
- package/lib/resources/unmanaged-device.d.ts +1 -1
- package/lib/routes/connect-webviews/connect-webviews.d.ts +1 -1
- package/lib/routes/devices/devices.d.ts +3 -3
- package/lib/routes/devices/unmanaged/unmanaged.d.ts +3 -3
- package/lib/routes/events/events.d.ts +2 -2
- package/lib/routes/locks/locks.d.ts +3 -3
- package/lib/version.d.ts +1 -1
- package/lib/version.js +1 -1
- package/package.json +4 -4
- package/src/lib/resources/device-provider.ts +3 -0
- package/src/lib/resources/device.ts +32 -0
- package/src/lib/resources/event.ts +150 -0
- package/src/lib/resources/unmanaged-device.ts +1 -0
- package/src/lib/routes/connect-webviews/connect-webviews.ts +3 -1
- package/src/lib/routes/devices/devices.ts +3 -0
- package/src/lib/routes/devices/unmanaged/unmanaged.ts +3 -0
- package/src/lib/routes/events/events.ts +6 -0
- package/src/lib/routes/locks/locks.ts +3 -0
- package/src/lib/version.ts +1 -1
|
@@ -90,7 +90,7 @@ export type DeviceProvider = {
|
|
|
90
90
|
/**
|
|
91
91
|
* Name of the device provider.
|
|
92
92
|
*/
|
|
93
|
-
device_provider_name: 'hotek' | 'dormakaba_community' | 'legic_connect' | 'akuvox' | 'august' | 'avigilon_alta' | 'brivo' | 'butterflymx' | 'schlage' | 'smartthings' | 'yale' | 'genie' | 'doorking' | 'salto' | 'salto_ks' | 'salto_ks_accept' | 'lockly' | 'ttlock' | 'linear' | 'noiseaware' | 'nuki' | 'igloo' | 'kwikset' | 'minut' | 'my_2n' | 'controlbyweb' | 'nest' | 'igloohome' | 'ecobee' | 'four_suites' | 'dormakaba_oracode' | 'dormakaba_oracode_iho' | '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' | 'keyincode' | 'dormakaba_ambiance' | 'ultraloq' | 'yacan' | 'dusaw' | 'sifely' | 'thirty_three_lock' | 'ring' | 'tapo' | 'arlo' | 'reolink' | 'unifi_protect' | 'ical' | 'lodgify' | 'hostaway' | 'guesty' | 'acuity_scheduling' | 'omnitec' | 'kisi' | 'aqara' | 'eufy' | 'sonos';
|
|
93
|
+
device_provider_name: 'hotek' | 'dormakaba_community' | 'legic_connect' | 'akuvox' | 'august' | 'avigilon_alta' | 'brivo' | 'butterflymx' | 'schlage' | 'smartthings' | 'yale' | 'yale_access' | 'yale_home' | 'genie' | 'doorking' | 'salto' | 'salto_ks' | 'salto_ks_accept' | 'lockly' | 'ttlock' | 'linear' | 'noiseaware' | 'nuki' | 'igloo' | 'kwikset' | 'minut' | 'my_2n' | 'controlbyweb' | 'nest' | 'igloohome' | 'ecobee' | 'four_suites' | 'dormakaba_oracode' | 'dormakaba_oracode_iho' | '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' | 'keyincode' | 'dormakaba_ambiance' | 'ultraloq' | 'yacan' | 'dusaw' | 'sifely' | 'thirty_three_lock' | 'ring' | 'tapo' | 'arlo' | 'reolink' | 'unifi_protect' | 'yale_connect' | 'ical' | 'lodgify' | 'hostaway' | 'guesty' | 'acuity_scheduling' | 'omnitec' | 'kisi' | 'aqara' | 'eufy' | 'sonos';
|
|
94
94
|
/**
|
|
95
95
|
* Display name for the device provider.
|
|
96
96
|
*/
|
|
@@ -151,7 +151,7 @@ export type Device = {
|
|
|
151
151
|
/**
|
|
152
152
|
* Type of the device. The `august_lock` and `yale_lock` values are deprecated. Use `yale_access_lock` in place of `august_lock`, and `yale_access_lock` or `yale_home_lock` in place of `yale_lock`.
|
|
153
153
|
*/
|
|
154
|
-
device_type: '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' | 'yale_access_lock' | 'yale_home_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'four_suites_door' | 'dormakaba_oracode_door' | 'tedee_lock' | 'akiles_lock' | 'ultraloq_lock' | 'yacan_lock' | 'keyincode_lock' | 'omnitec_lock' | 'kisi_lock' | 'aqara_lock' | 'eufy_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' | 'tapo_camera' | 'arlo_camera' | 'reolink_camera' | 'unifi_protect_camera' | 'sonos_speaker';
|
|
154
|
+
device_type: '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' | 'yale_access_lock' | 'yale_home_lock' | 'yale_connect_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'four_suites_door' | 'dormakaba_oracode_door' | 'tedee_lock' | 'akiles_lock' | 'ultraloq_lock' | 'yacan_lock' | 'keyincode_lock' | 'omnitec_lock' | 'kisi_lock' | 'aqara_lock' | 'eufy_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' | 'tapo_camera' | 'arlo_camera' | 'reolink_camera' | 'unifi_protect_camera' | 'sonos_speaker';
|
|
155
155
|
/**
|
|
156
156
|
* Display name of the device, defaults to nickname (if it is set) or `properties.appearance.name`, otherwise. Enables administrators and users to identify the device easily, especially when there are numerous devices.
|
|
157
157
|
*/
|
|
@@ -1891,6 +1891,35 @@ export type Device = {
|
|
|
1891
1891
|
*/
|
|
1892
1892
|
serial_number?: string | undefined;
|
|
1893
1893
|
} | undefined;
|
|
1894
|
+
/**
|
|
1895
|
+
* Metadata for a Yale Connect lock.
|
|
1896
|
+
*/
|
|
1897
|
+
yale_connect_metadata?: {
|
|
1898
|
+
/**
|
|
1899
|
+
* Device ID for a Yale Connect lock.
|
|
1900
|
+
*/
|
|
1901
|
+
device_id?: string | undefined;
|
|
1902
|
+
/**
|
|
1903
|
+
* Device name for a Yale Connect lock.
|
|
1904
|
+
*/
|
|
1905
|
+
device_name?: string | undefined;
|
|
1906
|
+
/**
|
|
1907
|
+
* Firmware version reported by the Yale Connect lock.
|
|
1908
|
+
*/
|
|
1909
|
+
firmware_version?: string | undefined;
|
|
1910
|
+
/**
|
|
1911
|
+
* Name of the Yale Connect home that contains the lock.
|
|
1912
|
+
*/
|
|
1913
|
+
home_name?: string | undefined;
|
|
1914
|
+
/**
|
|
1915
|
+
* Model reported by the Yale Connect lock.
|
|
1916
|
+
*/
|
|
1917
|
+
model?: string | undefined;
|
|
1918
|
+
/**
|
|
1919
|
+
* Time zone of the Yale Connect home, as Yale reports it.
|
|
1920
|
+
*/
|
|
1921
|
+
time_zone_description?: string | undefined;
|
|
1922
|
+
} | undefined;
|
|
1894
1923
|
/**
|
|
1895
1924
|
* The delay in seconds before the lock automatically locks after being unlocked.
|
|
1896
1925
|
*/
|
package/lib/resources/event.d.ts
CHANGED
|
@@ -4867,6 +4867,132 @@ export type SeamEvent = {
|
|
|
4867
4867
|
* ID of the workspace associated with the event.
|
|
4868
4868
|
*/
|
|
4869
4869
|
workspace_id: string;
|
|
4870
|
+
} | {
|
|
4871
|
+
/**
|
|
4872
|
+
* Custom metadata of the connected account, present when connected_account_id is provided.
|
|
4873
|
+
*/
|
|
4874
|
+
connected_account_custom_metadata?: Record<string, string | boolean> | undefined;
|
|
4875
|
+
/**
|
|
4876
|
+
* ID of the connected account associated with the event.
|
|
4877
|
+
*/
|
|
4878
|
+
connected_account_id: string;
|
|
4879
|
+
/**
|
|
4880
|
+
* Date and time at which the event was created.
|
|
4881
|
+
*/
|
|
4882
|
+
created_at: string;
|
|
4883
|
+
/**
|
|
4884
|
+
* The customer key associated with the device, if any.
|
|
4885
|
+
*/
|
|
4886
|
+
customer_key?: string | undefined;
|
|
4887
|
+
/**
|
|
4888
|
+
* Custom metadata of the device, present when device_id is provided.
|
|
4889
|
+
*/
|
|
4890
|
+
device_custom_metadata?: Record<string, string | boolean> | undefined;
|
|
4891
|
+
/**
|
|
4892
|
+
* ID of the affected device.
|
|
4893
|
+
*/
|
|
4894
|
+
device_id: string;
|
|
4895
|
+
/**
|
|
4896
|
+
* Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.
|
|
4897
|
+
*/
|
|
4898
|
+
event_description?: string | undefined;
|
|
4899
|
+
/**
|
|
4900
|
+
* ID of the event.
|
|
4901
|
+
*/
|
|
4902
|
+
event_id: string;
|
|
4903
|
+
event_type: 'lock.jammed';
|
|
4904
|
+
/**
|
|
4905
|
+
* Date and time at which the event occurred.
|
|
4906
|
+
*/
|
|
4907
|
+
occurred_at: string;
|
|
4908
|
+
/**
|
|
4909
|
+
* ID of the workspace associated with the event.
|
|
4910
|
+
*/
|
|
4911
|
+
workspace_id: string;
|
|
4912
|
+
} | {
|
|
4913
|
+
/**
|
|
4914
|
+
* Custom metadata of the connected account, present when connected_account_id is provided.
|
|
4915
|
+
*/
|
|
4916
|
+
connected_account_custom_metadata?: Record<string, string | boolean> | undefined;
|
|
4917
|
+
/**
|
|
4918
|
+
* ID of the connected account associated with the event.
|
|
4919
|
+
*/
|
|
4920
|
+
connected_account_id: string;
|
|
4921
|
+
/**
|
|
4922
|
+
* Date and time at which the event was created.
|
|
4923
|
+
*/
|
|
4924
|
+
created_at: string;
|
|
4925
|
+
/**
|
|
4926
|
+
* The customer key associated with the device, if any.
|
|
4927
|
+
*/
|
|
4928
|
+
customer_key?: string | undefined;
|
|
4929
|
+
/**
|
|
4930
|
+
* Custom metadata of the device, present when device_id is provided.
|
|
4931
|
+
*/
|
|
4932
|
+
device_custom_metadata?: Record<string, string | boolean> | undefined;
|
|
4933
|
+
/**
|
|
4934
|
+
* ID of the affected device.
|
|
4935
|
+
*/
|
|
4936
|
+
device_id: string;
|
|
4937
|
+
/**
|
|
4938
|
+
* Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.
|
|
4939
|
+
*/
|
|
4940
|
+
event_description?: string | undefined;
|
|
4941
|
+
/**
|
|
4942
|
+
* ID of the event.
|
|
4943
|
+
*/
|
|
4944
|
+
event_id: string;
|
|
4945
|
+
event_type: 'lock.door_opened';
|
|
4946
|
+
/**
|
|
4947
|
+
* Date and time at which the event occurred.
|
|
4948
|
+
*/
|
|
4949
|
+
occurred_at: string;
|
|
4950
|
+
/**
|
|
4951
|
+
* ID of the workspace associated with the event.
|
|
4952
|
+
*/
|
|
4953
|
+
workspace_id: string;
|
|
4954
|
+
} | {
|
|
4955
|
+
/**
|
|
4956
|
+
* Custom metadata of the connected account, present when connected_account_id is provided.
|
|
4957
|
+
*/
|
|
4958
|
+
connected_account_custom_metadata?: Record<string, string | boolean> | undefined;
|
|
4959
|
+
/**
|
|
4960
|
+
* ID of the connected account associated with the event.
|
|
4961
|
+
*/
|
|
4962
|
+
connected_account_id: string;
|
|
4963
|
+
/**
|
|
4964
|
+
* Date and time at which the event was created.
|
|
4965
|
+
*/
|
|
4966
|
+
created_at: string;
|
|
4967
|
+
/**
|
|
4968
|
+
* The customer key associated with the device, if any.
|
|
4969
|
+
*/
|
|
4970
|
+
customer_key?: string | undefined;
|
|
4971
|
+
/**
|
|
4972
|
+
* Custom metadata of the device, present when device_id is provided.
|
|
4973
|
+
*/
|
|
4974
|
+
device_custom_metadata?: Record<string, string | boolean> | undefined;
|
|
4975
|
+
/**
|
|
4976
|
+
* ID of the affected device.
|
|
4977
|
+
*/
|
|
4978
|
+
device_id: string;
|
|
4979
|
+
/**
|
|
4980
|
+
* Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.
|
|
4981
|
+
*/
|
|
4982
|
+
event_description?: string | undefined;
|
|
4983
|
+
/**
|
|
4984
|
+
* ID of the event.
|
|
4985
|
+
*/
|
|
4986
|
+
event_id: string;
|
|
4987
|
+
event_type: 'lock.door_closed';
|
|
4988
|
+
/**
|
|
4989
|
+
* Date and time at which the event occurred.
|
|
4990
|
+
*/
|
|
4991
|
+
occurred_at: string;
|
|
4992
|
+
/**
|
|
4993
|
+
* ID of the workspace associated with the event.
|
|
4994
|
+
*/
|
|
4995
|
+
workspace_id: string;
|
|
4870
4996
|
} | {
|
|
4871
4997
|
/**
|
|
4872
4998
|
* Key of the climate preset that was activated.
|
|
@@ -113,7 +113,7 @@ export type UnmanagedDevice = {
|
|
|
113
113
|
/**
|
|
114
114
|
* Type of the device. The `august_lock` and `yale_lock` values are deprecated. Use `yale_access_lock` in place of `august_lock`, and `yale_access_lock` or `yale_home_lock` in place of `yale_lock`.
|
|
115
115
|
*/
|
|
116
|
-
device_type: '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' | 'yale_access_lock' | 'yale_home_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'four_suites_door' | 'dormakaba_oracode_door' | 'tedee_lock' | 'akiles_lock' | 'ultraloq_lock' | 'yacan_lock' | 'keyincode_lock' | 'omnitec_lock' | 'kisi_lock' | 'aqara_lock' | 'eufy_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' | 'tapo_camera' | 'arlo_camera' | 'reolink_camera' | 'unifi_protect_camera' | 'sonos_speaker';
|
|
116
|
+
device_type: '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' | 'yale_access_lock' | 'yale_home_lock' | 'yale_connect_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'four_suites_door' | 'dormakaba_oracode_door' | 'tedee_lock' | 'akiles_lock' | 'ultraloq_lock' | 'yacan_lock' | 'keyincode_lock' | 'omnitec_lock' | 'kisi_lock' | 'aqara_lock' | 'eufy_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' | 'tapo_camera' | 'arlo_camera' | 'reolink_camera' | 'unifi_protect_camera' | 'sonos_speaker';
|
|
117
117
|
/**
|
|
118
118
|
* Display name of the device, defaults to nickname (if it is set) or `properties.appearance.name`, otherwise. Enables administrators and users to identify the device easily, especially when there are numerous devices.
|
|
119
119
|
*/
|
|
@@ -50,7 +50,7 @@ export type ConnectWebviewsCreateParameters = {
|
|
|
50
50
|
/**
|
|
51
51
|
* 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://www.seam.co/docs/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://www.seam.co/docs/api/devices/list_device_providers) with no filters.
|
|
52
52
|
*/
|
|
53
|
-
accepted_providers?: Array<'hotek' | 'dormakaba_community' | 'legic_connect' | 'akuvox' | 'august' | 'avigilon_alta' | 'brivo' | 'butterflymx' | 'schlage' | 'smartthings' | 'yale' | 'genie' | 'doorking' | 'salto' | 'salto_ks' | 'salto_ks_accept' | 'lockly' | 'ttlock' | 'linear' | 'noiseaware' | 'nuki' | 'igloo' | 'kwikset' | 'minut' | 'my_2n' | 'controlbyweb' | 'nest' | 'igloohome' | 'ecobee' | 'four_suites' | 'dormakaba_oracode' | 'dormakaba_oracode_iho' | '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' | 'keyincode' | 'dormakaba_ambiance' | 'ultraloq' | 'yacan' | 'dusaw' | 'sifely' | 'thirty_three_lock' | 'ring' | 'tapo' | 'arlo' | 'reolink' | 'unifi_protect' | 'ical' | 'lodgify' | 'hostaway' | 'guesty' | 'acuity_scheduling' | 'omnitec' | 'kisi' | 'aqara' | 'eufy' | 'sonos' | '
|
|
53
|
+
accepted_providers?: Array<'hotek' | 'dormakaba_community' | 'legic_connect' | 'akuvox' | 'august' | 'avigilon_alta' | 'brivo' | 'butterflymx' | 'schlage' | 'smartthings' | 'yale' | 'yale_access' | 'yale_home' | 'genie' | 'doorking' | 'salto' | 'salto_ks' | 'salto_ks_accept' | 'lockly' | 'ttlock' | 'linear' | 'noiseaware' | 'nuki' | 'igloo' | 'kwikset' | 'minut' | 'my_2n' | 'controlbyweb' | 'nest' | 'igloohome' | 'ecobee' | 'four_suites' | 'dormakaba_oracode' | 'dormakaba_oracode_iho' | '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' | 'keyincode' | 'dormakaba_ambiance' | 'ultraloq' | 'yacan' | 'dusaw' | 'sifely' | 'thirty_three_lock' | 'ring' | 'tapo' | 'arlo' | 'reolink' | 'unifi_protect' | 'yale_connect' | 'ical' | 'lodgify' | 'hostaway' | 'guesty' | 'acuity_scheduling' | 'omnitec' | 'kisi' | 'aqara' | 'eufy' | 'sonos' | 'hid_cm' | 'google_nest' | 'slack'> | undefined;
|
|
54
54
|
/**
|
|
55
55
|
* Indicates whether newly-added devices should appear as [managed devices](https://www.seam.co/docs/core-concepts/devices/managed-and-unmanaged-devices). See also: [Customize the Behavior Settings of Your Connect Webviews](https://www.seam.co/docs/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-behavior-settings-of-your-connect-webviews).
|
|
56
56
|
*/
|
|
@@ -101,11 +101,11 @@ export type DevicesListParameters = {
|
|
|
101
101
|
/**
|
|
102
102
|
* Device type for which you want to list devices.
|
|
103
103
|
*/
|
|
104
|
-
device_type?: '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' | 'yale_access_lock' | 'yale_home_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'four_suites_door' | 'dormakaba_oracode_door' | 'tedee_lock' | 'akiles_lock' | 'ultraloq_lock' | 'yacan_lock' | 'keyincode_lock' | 'omnitec_lock' | 'kisi_lock' | 'aqara_lock' | 'eufy_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' | 'tapo_camera' | 'arlo_camera' | 'reolink_camera' | 'unifi_protect_camera' | 'sonos_speaker' | undefined;
|
|
104
|
+
device_type?: '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' | 'yale_access_lock' | 'yale_home_lock' | 'yale_connect_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'four_suites_door' | 'dormakaba_oracode_door' | 'tedee_lock' | 'akiles_lock' | 'ultraloq_lock' | 'yacan_lock' | 'keyincode_lock' | 'omnitec_lock' | 'kisi_lock' | 'aqara_lock' | 'eufy_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' | 'tapo_camera' | 'arlo_camera' | 'reolink_camera' | 'unifi_protect_camera' | 'sonos_speaker' | undefined;
|
|
105
105
|
/**
|
|
106
106
|
* Array of device types for which you want to list devices.
|
|
107
107
|
*/
|
|
108
|
-
device_types?: Array<'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' | 'yale_access_lock' | 'yale_home_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'four_suites_door' | 'dormakaba_oracode_door' | 'tedee_lock' | 'akiles_lock' | 'ultraloq_lock' | 'yacan_lock' | 'keyincode_lock' | 'omnitec_lock' | 'kisi_lock' | 'aqara_lock' | 'eufy_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' | 'tapo_camera' | 'arlo_camera' | 'reolink_camera' | 'unifi_protect_camera' | 'sonos_speaker'> | undefined;
|
|
108
|
+
device_types?: Array<'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' | 'yale_access_lock' | 'yale_home_lock' | 'yale_connect_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'four_suites_door' | 'dormakaba_oracode_door' | 'tedee_lock' | 'akiles_lock' | 'ultraloq_lock' | 'yacan_lock' | 'keyincode_lock' | 'omnitec_lock' | 'kisi_lock' | 'aqara_lock' | 'eufy_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' | 'tapo_camera' | 'arlo_camera' | 'reolink_camera' | 'unifi_protect_camera' | 'sonos_speaker'> | undefined;
|
|
109
109
|
/**
|
|
110
110
|
* Numerical limit on the number of devices to return.
|
|
111
111
|
*/
|
|
@@ -113,7 +113,7 @@ export type DevicesListParameters = {
|
|
|
113
113
|
/**
|
|
114
114
|
* Manufacturer for which you want to list devices.
|
|
115
115
|
*/
|
|
116
|
-
manufacturer?: 'akuvox' | 'august' | 'avigilon_alta' | 'brivo' | 'butterflymx' | 'doorking' | 'four_suites' | 'genie' | 'igloo' | 'keywe' | 'kwikset' | 'linear' | 'nuki' | 'philia' | 'salto' | 'samsung' | 'schlage' | 'seam' | 'unknown' | 'wyze' | 'yale' | 'two_n' | 'ttlock' | 'igloohome' | 'controlbyweb' | 'tedee' | 'keyincode' | 'ubiquiti' | 'akiles' | 'aqara' | 'ecobee' | 'eufy' | 'dormakaba_oracode' | 'dormakaba_oracode_iho' | 'honeywell_resideo' | 'keynest' | 'korelock' | 'lockly' | 'minut' | 'nest' | 'noiseaware' | 'sensi' | 'smartthings' | 'tado' | 'ultraloq' | 'ring' | 'tapo' | 'arlo' | 'reolink' | 'unifi_protect' | 'ical' | 'lodgify' | 'hostaway' | 'guesty' | 'acuity_scheduling' | 'omnitec' | 'kisi' | 'slack' | 'yacan' | 'sonos' | undefined;
|
|
116
|
+
manufacturer?: 'akuvox' | 'august' | 'avigilon_alta' | 'brivo' | 'butterflymx' | 'doorking' | 'four_suites' | 'genie' | 'igloo' | 'keywe' | 'kwikset' | 'linear' | 'nuki' | 'philia' | 'salto' | 'samsung' | 'schlage' | 'seam' | 'unknown' | 'wyze' | 'yale' | 'two_n' | 'ttlock' | 'igloohome' | 'controlbyweb' | 'tedee' | 'keyincode' | 'ubiquiti' | 'akiles' | 'aqara' | 'ecobee' | 'eufy' | 'dormakaba_oracode' | 'dormakaba_oracode_iho' | 'honeywell_resideo' | 'keynest' | 'korelock' | 'lockly' | 'minut' | 'nest' | 'noiseaware' | 'sensi' | 'smartthings' | 'tado' | 'ultraloq' | 'ring' | 'tapo' | 'arlo' | 'reolink' | 'unifi_protect' | 'yale_connect' | 'ical' | 'lodgify' | 'hostaway' | 'guesty' | 'acuity_scheduling' | 'omnitec' | 'kisi' | 'slack' | 'yacan' | 'sonos' | undefined;
|
|
117
117
|
/**
|
|
118
118
|
* Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.
|
|
119
119
|
*/
|
|
@@ -84,11 +84,11 @@ export type DevicesUnmanagedListParameters = {
|
|
|
84
84
|
/**
|
|
85
85
|
* Device type for which you want to list devices.
|
|
86
86
|
*/
|
|
87
|
-
device_type?: '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' | 'yale_access_lock' | 'yale_home_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'four_suites_door' | 'dormakaba_oracode_door' | 'tedee_lock' | 'akiles_lock' | 'ultraloq_lock' | 'yacan_lock' | 'keyincode_lock' | 'omnitec_lock' | 'kisi_lock' | 'aqara_lock' | 'eufy_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' | 'tapo_camera' | 'arlo_camera' | 'reolink_camera' | 'unifi_protect_camera' | 'sonos_speaker' | undefined;
|
|
87
|
+
device_type?: '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' | 'yale_access_lock' | 'yale_home_lock' | 'yale_connect_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'four_suites_door' | 'dormakaba_oracode_door' | 'tedee_lock' | 'akiles_lock' | 'ultraloq_lock' | 'yacan_lock' | 'keyincode_lock' | 'omnitec_lock' | 'kisi_lock' | 'aqara_lock' | 'eufy_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' | 'tapo_camera' | 'arlo_camera' | 'reolink_camera' | 'unifi_protect_camera' | 'sonos_speaker' | undefined;
|
|
88
88
|
/**
|
|
89
89
|
* Array of device types for which you want to list devices.
|
|
90
90
|
*/
|
|
91
|
-
device_types?: Array<'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' | 'yale_access_lock' | 'yale_home_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'four_suites_door' | 'dormakaba_oracode_door' | 'tedee_lock' | 'akiles_lock' | 'ultraloq_lock' | 'yacan_lock' | 'keyincode_lock' | 'omnitec_lock' | 'kisi_lock' | 'aqara_lock' | 'eufy_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' | 'tapo_camera' | 'arlo_camera' | 'reolink_camera' | 'unifi_protect_camera' | 'sonos_speaker'> | undefined;
|
|
91
|
+
device_types?: Array<'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' | 'yale_access_lock' | 'yale_home_lock' | 'yale_connect_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'four_suites_door' | 'dormakaba_oracode_door' | 'tedee_lock' | 'akiles_lock' | 'ultraloq_lock' | 'yacan_lock' | 'keyincode_lock' | 'omnitec_lock' | 'kisi_lock' | 'aqara_lock' | 'eufy_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' | 'tapo_camera' | 'arlo_camera' | 'reolink_camera' | 'unifi_protect_camera' | 'sonos_speaker'> | undefined;
|
|
92
92
|
/**
|
|
93
93
|
* Numerical limit on the number of devices to return.
|
|
94
94
|
*/
|
|
@@ -96,7 +96,7 @@ export type DevicesUnmanagedListParameters = {
|
|
|
96
96
|
/**
|
|
97
97
|
* Manufacturer for which you want to list devices.
|
|
98
98
|
*/
|
|
99
|
-
manufacturer?: 'akuvox' | 'august' | 'avigilon_alta' | 'brivo' | 'butterflymx' | 'doorking' | 'four_suites' | 'genie' | 'igloo' | 'keywe' | 'kwikset' | 'linear' | 'nuki' | 'philia' | 'salto' | 'samsung' | 'schlage' | 'seam' | 'unknown' | 'wyze' | 'yale' | 'two_n' | 'ttlock' | 'igloohome' | 'controlbyweb' | 'tedee' | 'keyincode' | 'ubiquiti' | 'akiles' | 'aqara' | 'ecobee' | 'eufy' | 'dormakaba_oracode' | 'dormakaba_oracode_iho' | 'honeywell_resideo' | 'keynest' | 'korelock' | 'lockly' | 'minut' | 'nest' | 'noiseaware' | 'sensi' | 'smartthings' | 'tado' | 'ultraloq' | 'ring' | 'tapo' | 'arlo' | 'reolink' | 'unifi_protect' | 'ical' | 'lodgify' | 'hostaway' | 'guesty' | 'acuity_scheduling' | 'omnitec' | 'kisi' | 'slack' | 'yacan' | 'sonos' | undefined;
|
|
99
|
+
manufacturer?: 'akuvox' | 'august' | 'avigilon_alta' | 'brivo' | 'butterflymx' | 'doorking' | 'four_suites' | 'genie' | 'igloo' | 'keywe' | 'kwikset' | 'linear' | 'nuki' | 'philia' | 'salto' | 'samsung' | 'schlage' | 'seam' | 'unknown' | 'wyze' | 'yale' | 'two_n' | 'ttlock' | 'igloohome' | 'controlbyweb' | 'tedee' | 'keyincode' | 'ubiquiti' | 'akiles' | 'aqara' | 'ecobee' | 'eufy' | 'dormakaba_oracode' | 'dormakaba_oracode_iho' | 'honeywell_resideo' | 'keynest' | 'korelock' | 'lockly' | 'minut' | 'nest' | 'noiseaware' | 'sensi' | 'smartthings' | 'tado' | 'ultraloq' | 'ring' | 'tapo' | 'arlo' | 'reolink' | 'unifi_protect' | 'yale_connect' | 'ical' | 'lodgify' | 'hostaway' | 'guesty' | 'acuity_scheduling' | 'omnitec' | 'kisi' | 'slack' | 'yacan' | 'sonos' | undefined;
|
|
100
100
|
/**
|
|
101
101
|
* Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.
|
|
102
102
|
*/
|
|
@@ -132,11 +132,11 @@ export type EventsListParameters = RequireAtLeastOne<{
|
|
|
132
132
|
/**
|
|
133
133
|
* Type of the events that you want to list.
|
|
134
134
|
*/
|
|
135
|
-
event_type?: 'access_code.created' | 'access_code.changed' | 'access_code.name_changed' | 'access_code.code_changed' | 'access_code.time_frame_changed' | 'access_code.mutations_requested' | 'access_code.scheduled_on_device' | 'access_code.set_on_device' | 'access_code.removed_from_device' | 'access_code.delay_in_setting_on_device' | 'access_code.failed_to_set_on_device' | 'access_code.issued' | 'access_code.delay_in_issuing' | 'access_code.failed_to_issue' | 'access_code.failed_to_update' | 'access_code.failed_to_delete' | 'access_code.deleted' | 'access_code.delay_in_removing_from_device' | 'access_code.failed_to_remove_from_device' | 'access_code.modified_external_to_seam' | 'access_code.deleted_external_to_seam' | 'access_code.backup_access_code_pulled' | 'access_code.unmanaged.converted_to_managed' | 'access_code.unmanaged.failed_to_convert_to_managed' | 'access_code.unmanaged.created' | 'access_code.unmanaged.removed' | 'access_grant.created' | 'access_grant.deleted' | 'access_grant.access_granted_to_all_doors' | 'access_grant.access_granted_to_door' | 'access_grant.access_to_door_lost' | 'access_grant.access_times_changed' | 'access_grant.could_not_create_requested_access_methods' | 'access_method.issued' | 'access_method.revoked' | 'access_method.card_encoding_required' | 'access_method.deleted' | 'access_method.reissued' | 'access_method.created' | 'access_method.delay_in_issuing' | 'access_method.failed_to_issue' | 'acs_system.connected' | 'acs_system.added' | 'acs_system.disconnected' | 'acs_credential.deleted' | 'acs_credential.issued' | 'acs_credential.reissued' | 'acs_credential.invalidated' | 'acs_user.created' | 'acs_user.deleted' | 'acs_encoder.added' | 'acs_encoder.removed' | 'acs_access_group.deleted' | 'acs_entrance.added' | 'acs_entrance.removed' | 'client_session.deleted' | 'connected_account.connected' | 'connected_account.created' | 'connected_account.successful_login' | 'connected_account.disconnected' | 'connected_account.completed_first_sync' | 'connected_account.deleted' | 'connected_account.completed_first_sync_after_reconnection' | 'connected_account.reauthorization_requested' | 'action_attempt.lock_door.succeeded' | 'action_attempt.lock_door.failed' | 'action_attempt.unlock_door.succeeded' | 'action_attempt.unlock_door.failed' | 'action_attempt.simulate_keypad_code_entry.succeeded' | 'action_attempt.simulate_keypad_code_entry.failed' | 'action_attempt.simulate_manual_lock_via_keypad.succeeded' | 'action_attempt.simulate_manual_lock_via_keypad.failed' | 'connect_webview.login_succeeded' | 'connect_webview.login_failed' | 'device.connected' | 'device.added' | 'device.converted_to_unmanaged' | 'device.unmanaged.converted_to_managed' | 'device.unmanaged.connected' | 'device.disconnected' | 'device.unmanaged.disconnected' | 'device.tampered' | 'device.low_battery' | 'device.battery_status_changed' | 'device.removed' | 'device.deleted' | 'device.third_party_integration_detected' | 'device.third_party_integration_no_longer_detected' | 'device.salto.privacy_mode_activated' | 'device.salto.privacy_mode_deactivated' | 'device.connection_became_flaky' | 'device.connection_stabilized' | 'device.error.subscription_required' | 'device.error.subscription_required.resolved' | 'device.accessory_keypad_connected' | 'device.accessory_keypad_disconnected' | 'noise_sensor.noise_threshold_triggered' | 'lock.locked' | 'lock.unlocked' | 'lock.access_denied' | 'thermostat.climate_preset_activated' | 'thermostat.manually_adjusted' | 'thermostat.temperature_threshold_exceeded' | 'thermostat.temperature_threshold_no_longer_exceeded' | 'thermostat.temperature_reached_set_point' | 'thermostat.temperature_changed' | 'device.name_changed' | 'camera.activated' | 'device.doorbell_rang' | 'enrollment_automation.deleted' | 'phone.deactivated' | 'space.device_membership_changed' | 'space.created' | 'space.deleted' | undefined;
|
|
135
|
+
event_type?: 'access_code.created' | 'access_code.changed' | 'access_code.name_changed' | 'access_code.code_changed' | 'access_code.time_frame_changed' | 'access_code.mutations_requested' | 'access_code.scheduled_on_device' | 'access_code.set_on_device' | 'access_code.removed_from_device' | 'access_code.delay_in_setting_on_device' | 'access_code.failed_to_set_on_device' | 'access_code.issued' | 'access_code.delay_in_issuing' | 'access_code.failed_to_issue' | 'access_code.failed_to_update' | 'access_code.failed_to_delete' | 'access_code.deleted' | 'access_code.delay_in_removing_from_device' | 'access_code.failed_to_remove_from_device' | 'access_code.modified_external_to_seam' | 'access_code.deleted_external_to_seam' | 'access_code.backup_access_code_pulled' | 'access_code.unmanaged.converted_to_managed' | 'access_code.unmanaged.failed_to_convert_to_managed' | 'access_code.unmanaged.created' | 'access_code.unmanaged.removed' | 'access_grant.created' | 'access_grant.deleted' | 'access_grant.access_granted_to_all_doors' | 'access_grant.access_granted_to_door' | 'access_grant.access_to_door_lost' | 'access_grant.access_times_changed' | 'access_grant.could_not_create_requested_access_methods' | 'access_method.issued' | 'access_method.revoked' | 'access_method.card_encoding_required' | 'access_method.deleted' | 'access_method.reissued' | 'access_method.created' | 'access_method.delay_in_issuing' | 'access_method.failed_to_issue' | 'acs_system.connected' | 'acs_system.added' | 'acs_system.disconnected' | 'acs_credential.deleted' | 'acs_credential.issued' | 'acs_credential.reissued' | 'acs_credential.invalidated' | 'acs_user.created' | 'acs_user.deleted' | 'acs_encoder.added' | 'acs_encoder.removed' | 'acs_access_group.deleted' | 'acs_entrance.added' | 'acs_entrance.removed' | 'client_session.deleted' | 'connected_account.connected' | 'connected_account.created' | 'connected_account.successful_login' | 'connected_account.disconnected' | 'connected_account.completed_first_sync' | 'connected_account.deleted' | 'connected_account.completed_first_sync_after_reconnection' | 'connected_account.reauthorization_requested' | 'action_attempt.lock_door.succeeded' | 'action_attempt.lock_door.failed' | 'action_attempt.unlock_door.succeeded' | 'action_attempt.unlock_door.failed' | 'action_attempt.simulate_keypad_code_entry.succeeded' | 'action_attempt.simulate_keypad_code_entry.failed' | 'action_attempt.simulate_manual_lock_via_keypad.succeeded' | 'action_attempt.simulate_manual_lock_via_keypad.failed' | 'connect_webview.login_succeeded' | 'connect_webview.login_failed' | 'device.connected' | 'device.added' | 'device.converted_to_unmanaged' | 'device.unmanaged.converted_to_managed' | 'device.unmanaged.connected' | 'device.disconnected' | 'device.unmanaged.disconnected' | 'device.tampered' | 'device.low_battery' | 'device.battery_status_changed' | 'device.removed' | 'device.deleted' | 'device.third_party_integration_detected' | 'device.third_party_integration_no_longer_detected' | 'device.salto.privacy_mode_activated' | 'device.salto.privacy_mode_deactivated' | 'device.connection_became_flaky' | 'device.connection_stabilized' | 'device.error.subscription_required' | 'device.error.subscription_required.resolved' | 'device.accessory_keypad_connected' | 'device.accessory_keypad_disconnected' | 'noise_sensor.noise_threshold_triggered' | 'lock.locked' | 'lock.unlocked' | 'lock.access_denied' | 'lock.jammed' | 'lock.door_opened' | 'lock.door_closed' | 'thermostat.climate_preset_activated' | 'thermostat.manually_adjusted' | 'thermostat.temperature_threshold_exceeded' | 'thermostat.temperature_threshold_no_longer_exceeded' | 'thermostat.temperature_reached_set_point' | 'thermostat.temperature_changed' | 'device.name_changed' | 'camera.activated' | 'device.doorbell_rang' | 'enrollment_automation.deleted' | 'phone.deactivated' | 'space.device_membership_changed' | 'space.created' | 'space.deleted' | undefined;
|
|
136
136
|
/**
|
|
137
137
|
* Types of the events that you want to list.
|
|
138
138
|
*/
|
|
139
|
-
event_types?: Array<'access_code.created' | 'access_code.changed' | 'access_code.name_changed' | 'access_code.code_changed' | 'access_code.time_frame_changed' | 'access_code.mutations_requested' | 'access_code.scheduled_on_device' | 'access_code.set_on_device' | 'access_code.removed_from_device' | 'access_code.delay_in_setting_on_device' | 'access_code.failed_to_set_on_device' | 'access_code.issued' | 'access_code.delay_in_issuing' | 'access_code.failed_to_issue' | 'access_code.failed_to_update' | 'access_code.failed_to_delete' | 'access_code.deleted' | 'access_code.delay_in_removing_from_device' | 'access_code.failed_to_remove_from_device' | 'access_code.modified_external_to_seam' | 'access_code.deleted_external_to_seam' | 'access_code.backup_access_code_pulled' | 'access_code.unmanaged.converted_to_managed' | 'access_code.unmanaged.failed_to_convert_to_managed' | 'access_code.unmanaged.created' | 'access_code.unmanaged.removed' | 'access_grant.created' | 'access_grant.deleted' | 'access_grant.access_granted_to_all_doors' | 'access_grant.access_granted_to_door' | 'access_grant.access_to_door_lost' | 'access_grant.access_times_changed' | 'access_grant.could_not_create_requested_access_methods' | 'access_method.issued' | 'access_method.revoked' | 'access_method.card_encoding_required' | 'access_method.deleted' | 'access_method.reissued' | 'access_method.created' | 'access_method.delay_in_issuing' | 'access_method.failed_to_issue' | 'acs_system.connected' | 'acs_system.added' | 'acs_system.disconnected' | 'acs_credential.deleted' | 'acs_credential.issued' | 'acs_credential.reissued' | 'acs_credential.invalidated' | 'acs_user.created' | 'acs_user.deleted' | 'acs_encoder.added' | 'acs_encoder.removed' | 'acs_access_group.deleted' | 'acs_entrance.added' | 'acs_entrance.removed' | 'client_session.deleted' | 'connected_account.connected' | 'connected_account.created' | 'connected_account.successful_login' | 'connected_account.disconnected' | 'connected_account.completed_first_sync' | 'connected_account.deleted' | 'connected_account.completed_first_sync_after_reconnection' | 'connected_account.reauthorization_requested' | 'action_attempt.lock_door.succeeded' | 'action_attempt.lock_door.failed' | 'action_attempt.unlock_door.succeeded' | 'action_attempt.unlock_door.failed' | 'action_attempt.simulate_keypad_code_entry.succeeded' | 'action_attempt.simulate_keypad_code_entry.failed' | 'action_attempt.simulate_manual_lock_via_keypad.succeeded' | 'action_attempt.simulate_manual_lock_via_keypad.failed' | 'connect_webview.login_succeeded' | 'connect_webview.login_failed' | 'device.connected' | 'device.added' | 'device.converted_to_unmanaged' | 'device.unmanaged.converted_to_managed' | 'device.unmanaged.connected' | 'device.disconnected' | 'device.unmanaged.disconnected' | 'device.tampered' | 'device.low_battery' | 'device.battery_status_changed' | 'device.removed' | 'device.deleted' | 'device.third_party_integration_detected' | 'device.third_party_integration_no_longer_detected' | 'device.salto.privacy_mode_activated' | 'device.salto.privacy_mode_deactivated' | 'device.connection_became_flaky' | 'device.connection_stabilized' | 'device.error.subscription_required' | 'device.error.subscription_required.resolved' | 'device.accessory_keypad_connected' | 'device.accessory_keypad_disconnected' | 'noise_sensor.noise_threshold_triggered' | 'lock.locked' | 'lock.unlocked' | 'lock.access_denied' | 'thermostat.climate_preset_activated' | 'thermostat.manually_adjusted' | 'thermostat.temperature_threshold_exceeded' | 'thermostat.temperature_threshold_no_longer_exceeded' | 'thermostat.temperature_reached_set_point' | 'thermostat.temperature_changed' | 'device.name_changed' | 'camera.activated' | 'device.doorbell_rang' | 'enrollment_automation.deleted' | 'phone.deactivated' | 'space.device_membership_changed' | 'space.created' | 'space.deleted'> | undefined;
|
|
139
|
+
event_types?: Array<'access_code.created' | 'access_code.changed' | 'access_code.name_changed' | 'access_code.code_changed' | 'access_code.time_frame_changed' | 'access_code.mutations_requested' | 'access_code.scheduled_on_device' | 'access_code.set_on_device' | 'access_code.removed_from_device' | 'access_code.delay_in_setting_on_device' | 'access_code.failed_to_set_on_device' | 'access_code.issued' | 'access_code.delay_in_issuing' | 'access_code.failed_to_issue' | 'access_code.failed_to_update' | 'access_code.failed_to_delete' | 'access_code.deleted' | 'access_code.delay_in_removing_from_device' | 'access_code.failed_to_remove_from_device' | 'access_code.modified_external_to_seam' | 'access_code.deleted_external_to_seam' | 'access_code.backup_access_code_pulled' | 'access_code.unmanaged.converted_to_managed' | 'access_code.unmanaged.failed_to_convert_to_managed' | 'access_code.unmanaged.created' | 'access_code.unmanaged.removed' | 'access_grant.created' | 'access_grant.deleted' | 'access_grant.access_granted_to_all_doors' | 'access_grant.access_granted_to_door' | 'access_grant.access_to_door_lost' | 'access_grant.access_times_changed' | 'access_grant.could_not_create_requested_access_methods' | 'access_method.issued' | 'access_method.revoked' | 'access_method.card_encoding_required' | 'access_method.deleted' | 'access_method.reissued' | 'access_method.created' | 'access_method.delay_in_issuing' | 'access_method.failed_to_issue' | 'acs_system.connected' | 'acs_system.added' | 'acs_system.disconnected' | 'acs_credential.deleted' | 'acs_credential.issued' | 'acs_credential.reissued' | 'acs_credential.invalidated' | 'acs_user.created' | 'acs_user.deleted' | 'acs_encoder.added' | 'acs_encoder.removed' | 'acs_access_group.deleted' | 'acs_entrance.added' | 'acs_entrance.removed' | 'client_session.deleted' | 'connected_account.connected' | 'connected_account.created' | 'connected_account.successful_login' | 'connected_account.disconnected' | 'connected_account.completed_first_sync' | 'connected_account.deleted' | 'connected_account.completed_first_sync_after_reconnection' | 'connected_account.reauthorization_requested' | 'action_attempt.lock_door.succeeded' | 'action_attempt.lock_door.failed' | 'action_attempt.unlock_door.succeeded' | 'action_attempt.unlock_door.failed' | 'action_attempt.simulate_keypad_code_entry.succeeded' | 'action_attempt.simulate_keypad_code_entry.failed' | 'action_attempt.simulate_manual_lock_via_keypad.succeeded' | 'action_attempt.simulate_manual_lock_via_keypad.failed' | 'connect_webview.login_succeeded' | 'connect_webview.login_failed' | 'device.connected' | 'device.added' | 'device.converted_to_unmanaged' | 'device.unmanaged.converted_to_managed' | 'device.unmanaged.connected' | 'device.disconnected' | 'device.unmanaged.disconnected' | 'device.tampered' | 'device.low_battery' | 'device.battery_status_changed' | 'device.removed' | 'device.deleted' | 'device.third_party_integration_detected' | 'device.third_party_integration_no_longer_detected' | 'device.salto.privacy_mode_activated' | 'device.salto.privacy_mode_deactivated' | 'device.connection_became_flaky' | 'device.connection_stabilized' | 'device.error.subscription_required' | 'device.error.subscription_required.resolved' | 'device.accessory_keypad_connected' | 'device.accessory_keypad_disconnected' | 'noise_sensor.noise_threshold_triggered' | 'lock.locked' | 'lock.unlocked' | 'lock.access_denied' | 'lock.jammed' | 'lock.door_opened' | 'lock.door_closed' | 'thermostat.climate_preset_activated' | 'thermostat.manually_adjusted' | 'thermostat.temperature_threshold_exceeded' | 'thermostat.temperature_threshold_no_longer_exceeded' | 'thermostat.temperature_reached_set_point' | 'thermostat.temperature_changed' | 'device.name_changed' | 'camera.activated' | 'device.doorbell_rang' | 'enrollment_automation.deleted' | 'phone.deactivated' | 'space.device_membership_changed' | 'space.created' | 'space.deleted'> | undefined;
|
|
140
140
|
/**
|
|
141
141
|
* Numerical limit on the number of events to return.
|
|
142
142
|
*/
|
|
@@ -98,15 +98,15 @@ export type LocksListParameters = {
|
|
|
98
98
|
/**
|
|
99
99
|
* Device type of the locks that you want to list.
|
|
100
100
|
*/
|
|
101
|
-
device_type?: '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' | 'yale_access_lock' | 'yale_home_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'four_suites_door' | 'dormakaba_oracode_door' | 'tedee_lock' | 'akiles_lock' | 'ultraloq_lock' | 'yacan_lock' | 'keyincode_lock' | 'omnitec_lock' | 'kisi_lock' | 'aqara_lock' | 'eufy_lock' | undefined;
|
|
101
|
+
device_type?: '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' | 'yale_access_lock' | 'yale_home_lock' | 'yale_connect_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'four_suites_door' | 'dormakaba_oracode_door' | 'tedee_lock' | 'akiles_lock' | 'ultraloq_lock' | 'yacan_lock' | 'keyincode_lock' | 'omnitec_lock' | 'kisi_lock' | 'aqara_lock' | 'eufy_lock' | undefined;
|
|
102
102
|
/**
|
|
103
103
|
* Device types of the locks that you want to list.
|
|
104
104
|
*/
|
|
105
|
-
device_types?: Array<'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' | 'yale_access_lock' | 'yale_home_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'four_suites_door' | 'dormakaba_oracode_door' | 'tedee_lock' | 'akiles_lock' | 'ultraloq_lock' | 'yacan_lock' | 'keyincode_lock' | 'omnitec_lock' | 'kisi_lock' | 'aqara_lock' | 'eufy_lock'> | undefined;
|
|
105
|
+
device_types?: Array<'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' | 'yale_access_lock' | 'yale_home_lock' | 'yale_connect_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'four_suites_door' | 'dormakaba_oracode_door' | 'tedee_lock' | 'akiles_lock' | 'ultraloq_lock' | 'yacan_lock' | 'keyincode_lock' | 'omnitec_lock' | 'kisi_lock' | 'aqara_lock' | 'eufy_lock'> | undefined;
|
|
106
106
|
/**
|
|
107
107
|
* Manufacturer of the locks that you want to list.
|
|
108
108
|
*/
|
|
109
|
-
manufacturer?: 'akuvox' | 'august' | 'brivo' | 'butterflymx' | 'avigilon_alta' | 'doorking' | 'genie' | 'igloo' | 'linear' | 'kwikset' | 'nuki' | 'salto' | 'schlage' | 'seam' | 'wyze' | 'yale' | 'two_n' | 'controlbyweb' | 'ttlock' | 'igloohome' | 'four_suites' | 'tedee' | 'keyincode' | 'akiles' | 'aqara' | 'eufy' | 'dormakaba_oracode' | 'dormakaba_oracode_iho' | 'korelock' | 'lockly' | 'smartthings' | 'ultraloq' | 'omnitec' | 'kisi' | 'yacan' | undefined;
|
|
109
|
+
manufacturer?: 'akuvox' | 'august' | 'brivo' | 'butterflymx' | 'avigilon_alta' | 'doorking' | 'genie' | 'igloo' | 'linear' | 'kwikset' | 'nuki' | 'salto' | 'schlage' | 'seam' | 'wyze' | 'yale' | 'two_n' | 'controlbyweb' | 'ttlock' | 'igloohome' | 'four_suites' | 'tedee' | 'keyincode' | 'akiles' | 'aqara' | 'eufy' | 'dormakaba_oracode' | 'dormakaba_oracode_iho' | 'korelock' | 'lockly' | 'smartthings' | 'ultraloq' | 'yale_connect' | 'omnitec' | 'kisi' | 'yacan' | undefined;
|
|
110
110
|
};
|
|
111
111
|
/**
|
|
112
112
|
* @deprecated Use LocksListRequest instead.
|
package/lib/version.d.ts
CHANGED
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
declare const seamapiJavascriptHttpVersion = "2.
|
|
1
|
+
declare const seamapiJavascriptHttpVersion = "2.49.0";
|
|
2
2
|
export default seamapiJavascriptHttpVersion;
|
package/lib/version.js
CHANGED
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@seamapi/http",
|
|
3
|
-
"version": "2.
|
|
3
|
+
"version": "2.49.0",
|
|
4
4
|
"description": "JavaScript HTTP client for the Seam API written in TypeScript.",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"main": "index.js",
|
|
@@ -85,10 +85,10 @@
|
|
|
85
85
|
"axios-retry": "^4.4.2"
|
|
86
86
|
},
|
|
87
87
|
"devDependencies": {
|
|
88
|
-
"@seamapi/blueprint": "^1.
|
|
88
|
+
"@seamapi/blueprint": "^1.13.2",
|
|
89
89
|
"@seamapi/fake-seam-connect": "^2.0.4",
|
|
90
|
-
"@seamapi/smith": "^1.
|
|
91
|
-
"@seamapi/types": "1.
|
|
90
|
+
"@seamapi/smith": "^1.2.0",
|
|
91
|
+
"@seamapi/types": "1.1183.0",
|
|
92
92
|
"@types/jsonwebtoken": "^9.0.6",
|
|
93
93
|
"@types/node": "^24.10.9",
|
|
94
94
|
"ava": "^8.0.1",
|
|
@@ -107,6 +107,8 @@ export type DeviceProvider = {
|
|
|
107
107
|
| 'schlage'
|
|
108
108
|
| 'smartthings'
|
|
109
109
|
| 'yale'
|
|
110
|
+
| 'yale_access'
|
|
111
|
+
| 'yale_home'
|
|
110
112
|
| 'genie'
|
|
111
113
|
| 'doorking'
|
|
112
114
|
| 'salto'
|
|
@@ -157,6 +159,7 @@ export type DeviceProvider = {
|
|
|
157
159
|
| 'arlo'
|
|
158
160
|
| 'reolink'
|
|
159
161
|
| 'unifi_protect'
|
|
162
|
+
| 'yale_connect'
|
|
160
163
|
| 'ical'
|
|
161
164
|
| 'lodgify'
|
|
162
165
|
| 'hostaway'
|
|
@@ -195,6 +195,7 @@ export type Device = {
|
|
|
195
195
|
| 'yale_lock'
|
|
196
196
|
| 'yale_access_lock'
|
|
197
197
|
| 'yale_home_lock'
|
|
198
|
+
| 'yale_connect_lock'
|
|
198
199
|
| 'two_n_intercom'
|
|
199
200
|
| 'controlbyweb_device'
|
|
200
201
|
| 'ttlock_lock'
|
|
@@ -2166,6 +2167,37 @@ export type Device = {
|
|
|
2166
2167
|
serial_number?: string | undefined
|
|
2167
2168
|
}
|
|
2168
2169
|
| undefined
|
|
2170
|
+
/**
|
|
2171
|
+
* Metadata for a Yale Connect lock.
|
|
2172
|
+
*/
|
|
2173
|
+
yale_connect_metadata?:
|
|
2174
|
+
| {
|
|
2175
|
+
/**
|
|
2176
|
+
* Device ID for a Yale Connect lock.
|
|
2177
|
+
*/
|
|
2178
|
+
device_id?: string | undefined
|
|
2179
|
+
/**
|
|
2180
|
+
* Device name for a Yale Connect lock.
|
|
2181
|
+
*/
|
|
2182
|
+
device_name?: string | undefined
|
|
2183
|
+
/**
|
|
2184
|
+
* Firmware version reported by the Yale Connect lock.
|
|
2185
|
+
*/
|
|
2186
|
+
firmware_version?: string | undefined
|
|
2187
|
+
/**
|
|
2188
|
+
* Name of the Yale Connect home that contains the lock.
|
|
2189
|
+
*/
|
|
2190
|
+
home_name?: string | undefined
|
|
2191
|
+
/**
|
|
2192
|
+
* Model reported by the Yale Connect lock.
|
|
2193
|
+
*/
|
|
2194
|
+
model?: string | undefined
|
|
2195
|
+
/**
|
|
2196
|
+
* Time zone of the Yale Connect home, as Yale reports it.
|
|
2197
|
+
*/
|
|
2198
|
+
time_zone_description?: string | undefined
|
|
2199
|
+
}
|
|
2200
|
+
| undefined
|
|
2169
2201
|
/**
|
|
2170
2202
|
* The delay in seconds before the lock automatically locks after being unlocked.
|
|
2171
2203
|
*/
|
|
@@ -5836,6 +5836,156 @@ export type SeamEvent =
|
|
|
5836
5836
|
*/
|
|
5837
5837
|
workspace_id: string
|
|
5838
5838
|
}
|
|
5839
|
+
| {
|
|
5840
|
+
/**
|
|
5841
|
+
* Custom metadata of the connected account, present when connected_account_id is provided.
|
|
5842
|
+
*/
|
|
5843
|
+
connected_account_custom_metadata?:
|
|
5844
|
+
Record<string, string | boolean> | undefined
|
|
5845
|
+
/**
|
|
5846
|
+
* ID of the connected account associated with the event.
|
|
5847
|
+
*/
|
|
5848
|
+
connected_account_id: string
|
|
5849
|
+
|
|
5850
|
+
/**
|
|
5851
|
+
* Date and time at which the event was created.
|
|
5852
|
+
*/
|
|
5853
|
+
created_at: string
|
|
5854
|
+
|
|
5855
|
+
/**
|
|
5856
|
+
* The customer key associated with the device, if any.
|
|
5857
|
+
*/
|
|
5858
|
+
customer_key?: string | undefined
|
|
5859
|
+
/**
|
|
5860
|
+
* Custom metadata of the device, present when device_id is provided.
|
|
5861
|
+
*/
|
|
5862
|
+
device_custom_metadata?: Record<string, string | boolean> | undefined
|
|
5863
|
+
/**
|
|
5864
|
+
* ID of the affected device.
|
|
5865
|
+
*/
|
|
5866
|
+
device_id: string
|
|
5867
|
+
|
|
5868
|
+
/**
|
|
5869
|
+
* Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.
|
|
5870
|
+
*/
|
|
5871
|
+
event_description?: string | undefined
|
|
5872
|
+
/**
|
|
5873
|
+
* ID of the event.
|
|
5874
|
+
*/
|
|
5875
|
+
event_id: string
|
|
5876
|
+
|
|
5877
|
+
event_type: 'lock.jammed'
|
|
5878
|
+
|
|
5879
|
+
/**
|
|
5880
|
+
* Date and time at which the event occurred.
|
|
5881
|
+
*/
|
|
5882
|
+
occurred_at: string
|
|
5883
|
+
|
|
5884
|
+
/**
|
|
5885
|
+
* ID of the workspace associated with the event.
|
|
5886
|
+
*/
|
|
5887
|
+
workspace_id: string
|
|
5888
|
+
}
|
|
5889
|
+
| {
|
|
5890
|
+
/**
|
|
5891
|
+
* Custom metadata of the connected account, present when connected_account_id is provided.
|
|
5892
|
+
*/
|
|
5893
|
+
connected_account_custom_metadata?:
|
|
5894
|
+
Record<string, string | boolean> | undefined
|
|
5895
|
+
/**
|
|
5896
|
+
* ID of the connected account associated with the event.
|
|
5897
|
+
*/
|
|
5898
|
+
connected_account_id: string
|
|
5899
|
+
|
|
5900
|
+
/**
|
|
5901
|
+
* Date and time at which the event was created.
|
|
5902
|
+
*/
|
|
5903
|
+
created_at: string
|
|
5904
|
+
|
|
5905
|
+
/**
|
|
5906
|
+
* The customer key associated with the device, if any.
|
|
5907
|
+
*/
|
|
5908
|
+
customer_key?: string | undefined
|
|
5909
|
+
/**
|
|
5910
|
+
* Custom metadata of the device, present when device_id is provided.
|
|
5911
|
+
*/
|
|
5912
|
+
device_custom_metadata?: Record<string, string | boolean> | undefined
|
|
5913
|
+
/**
|
|
5914
|
+
* ID of the affected device.
|
|
5915
|
+
*/
|
|
5916
|
+
device_id: string
|
|
5917
|
+
|
|
5918
|
+
/**
|
|
5919
|
+
* Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.
|
|
5920
|
+
*/
|
|
5921
|
+
event_description?: string | undefined
|
|
5922
|
+
/**
|
|
5923
|
+
* ID of the event.
|
|
5924
|
+
*/
|
|
5925
|
+
event_id: string
|
|
5926
|
+
|
|
5927
|
+
event_type: 'lock.door_opened'
|
|
5928
|
+
|
|
5929
|
+
/**
|
|
5930
|
+
* Date and time at which the event occurred.
|
|
5931
|
+
*/
|
|
5932
|
+
occurred_at: string
|
|
5933
|
+
|
|
5934
|
+
/**
|
|
5935
|
+
* ID of the workspace associated with the event.
|
|
5936
|
+
*/
|
|
5937
|
+
workspace_id: string
|
|
5938
|
+
}
|
|
5939
|
+
| {
|
|
5940
|
+
/**
|
|
5941
|
+
* Custom metadata of the connected account, present when connected_account_id is provided.
|
|
5942
|
+
*/
|
|
5943
|
+
connected_account_custom_metadata?:
|
|
5944
|
+
Record<string, string | boolean> | undefined
|
|
5945
|
+
/**
|
|
5946
|
+
* ID of the connected account associated with the event.
|
|
5947
|
+
*/
|
|
5948
|
+
connected_account_id: string
|
|
5949
|
+
|
|
5950
|
+
/**
|
|
5951
|
+
* Date and time at which the event was created.
|
|
5952
|
+
*/
|
|
5953
|
+
created_at: string
|
|
5954
|
+
|
|
5955
|
+
/**
|
|
5956
|
+
* The customer key associated with the device, if any.
|
|
5957
|
+
*/
|
|
5958
|
+
customer_key?: string | undefined
|
|
5959
|
+
/**
|
|
5960
|
+
* Custom metadata of the device, present when device_id is provided.
|
|
5961
|
+
*/
|
|
5962
|
+
device_custom_metadata?: Record<string, string | boolean> | undefined
|
|
5963
|
+
/**
|
|
5964
|
+
* ID of the affected device.
|
|
5965
|
+
*/
|
|
5966
|
+
device_id: string
|
|
5967
|
+
|
|
5968
|
+
/**
|
|
5969
|
+
* Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event.
|
|
5970
|
+
*/
|
|
5971
|
+
event_description?: string | undefined
|
|
5972
|
+
/**
|
|
5973
|
+
* ID of the event.
|
|
5974
|
+
*/
|
|
5975
|
+
event_id: string
|
|
5976
|
+
|
|
5977
|
+
event_type: 'lock.door_closed'
|
|
5978
|
+
|
|
5979
|
+
/**
|
|
5980
|
+
* Date and time at which the event occurred.
|
|
5981
|
+
*/
|
|
5982
|
+
occurred_at: string
|
|
5983
|
+
|
|
5984
|
+
/**
|
|
5985
|
+
* ID of the workspace associated with the event.
|
|
5986
|
+
*/
|
|
5987
|
+
workspace_id: string
|
|
5988
|
+
}
|
|
5839
5989
|
| {
|
|
5840
5990
|
/**
|
|
5841
5991
|
* Key of the climate preset that was activated.
|
|
@@ -283,6 +283,8 @@ export type ConnectWebviewsCreateParameters = {
|
|
|
283
283
|
| 'schlage'
|
|
284
284
|
| 'smartthings'
|
|
285
285
|
| 'yale'
|
|
286
|
+
| 'yale_access'
|
|
287
|
+
| 'yale_home'
|
|
286
288
|
| 'genie'
|
|
287
289
|
| 'doorking'
|
|
288
290
|
| 'salto'
|
|
@@ -333,6 +335,7 @@ export type ConnectWebviewsCreateParameters = {
|
|
|
333
335
|
| 'arlo'
|
|
334
336
|
| 'reolink'
|
|
335
337
|
| 'unifi_protect'
|
|
338
|
+
| 'yale_connect'
|
|
336
339
|
| 'ical'
|
|
337
340
|
| 'lodgify'
|
|
338
341
|
| 'hostaway'
|
|
@@ -343,7 +346,6 @@ export type ConnectWebviewsCreateParameters = {
|
|
|
343
346
|
| 'aqara'
|
|
344
347
|
| 'eufy'
|
|
345
348
|
| 'sonos'
|
|
346
|
-
| 'yale_access'
|
|
347
349
|
| 'hid_cm'
|
|
348
350
|
| 'google_nest'
|
|
349
351
|
| 'slack'
|
|
@@ -359,6 +359,7 @@ export type DevicesListParameters = {
|
|
|
359
359
|
| 'yale_lock'
|
|
360
360
|
| 'yale_access_lock'
|
|
361
361
|
| 'yale_home_lock'
|
|
362
|
+
| 'yale_connect_lock'
|
|
362
363
|
| 'two_n_intercom'
|
|
363
364
|
| 'controlbyweb_device'
|
|
364
365
|
| 'ttlock_lock'
|
|
@@ -416,6 +417,7 @@ export type DevicesListParameters = {
|
|
|
416
417
|
| 'yale_lock'
|
|
417
418
|
| 'yale_access_lock'
|
|
418
419
|
| 'yale_home_lock'
|
|
420
|
+
| 'yale_connect_lock'
|
|
419
421
|
| 'two_n_intercom'
|
|
420
422
|
| 'controlbyweb_device'
|
|
421
423
|
| 'ttlock_lock'
|
|
@@ -508,6 +510,7 @@ export type DevicesListParameters = {
|
|
|
508
510
|
| 'arlo'
|
|
509
511
|
| 'reolink'
|
|
510
512
|
| 'unifi_protect'
|
|
513
|
+
| 'yale_connect'
|
|
511
514
|
| 'ical'
|
|
512
515
|
| 'lodgify'
|
|
513
516
|
| 'hostaway'
|
|
@@ -306,6 +306,7 @@ export type DevicesUnmanagedListParameters = {
|
|
|
306
306
|
| 'yale_lock'
|
|
307
307
|
| 'yale_access_lock'
|
|
308
308
|
| 'yale_home_lock'
|
|
309
|
+
| 'yale_connect_lock'
|
|
309
310
|
| 'two_n_intercom'
|
|
310
311
|
| 'controlbyweb_device'
|
|
311
312
|
| 'ttlock_lock'
|
|
@@ -363,6 +364,7 @@ export type DevicesUnmanagedListParameters = {
|
|
|
363
364
|
| 'yale_lock'
|
|
364
365
|
| 'yale_access_lock'
|
|
365
366
|
| 'yale_home_lock'
|
|
367
|
+
| 'yale_connect_lock'
|
|
366
368
|
| 'two_n_intercom'
|
|
367
369
|
| 'controlbyweb_device'
|
|
368
370
|
| 'ttlock_lock'
|
|
@@ -455,6 +457,7 @@ export type DevicesUnmanagedListParameters = {
|
|
|
455
457
|
| 'arlo'
|
|
456
458
|
| 'reolink'
|
|
457
459
|
| 'unifi_protect'
|
|
460
|
+
| 'yale_connect'
|
|
458
461
|
| 'ical'
|
|
459
462
|
| 'lodgify'
|
|
460
463
|
| 'hostaway'
|
|
@@ -444,6 +444,9 @@ export type EventsListParameters = RequireAtLeastOne<
|
|
|
444
444
|
| 'lock.locked'
|
|
445
445
|
| 'lock.unlocked'
|
|
446
446
|
| 'lock.access_denied'
|
|
447
|
+
| 'lock.jammed'
|
|
448
|
+
| 'lock.door_opened'
|
|
449
|
+
| 'lock.door_closed'
|
|
447
450
|
| 'thermostat.climate_preset_activated'
|
|
448
451
|
| 'thermostat.manually_adjusted'
|
|
449
452
|
| 'thermostat.temperature_threshold_exceeded'
|
|
@@ -564,6 +567,9 @@ export type EventsListParameters = RequireAtLeastOne<
|
|
|
564
567
|
| 'lock.locked'
|
|
565
568
|
| 'lock.unlocked'
|
|
566
569
|
| 'lock.access_denied'
|
|
570
|
+
| 'lock.jammed'
|
|
571
|
+
| 'lock.door_opened'
|
|
572
|
+
| 'lock.door_closed'
|
|
567
573
|
| 'thermostat.climate_preset_activated'
|
|
568
574
|
| 'thermostat.manually_adjusted'
|
|
569
575
|
| 'thermostat.temperature_threshold_exceeded'
|
|
@@ -377,6 +377,7 @@ export type LocksListParameters = {
|
|
|
377
377
|
| 'yale_lock'
|
|
378
378
|
| 'yale_access_lock'
|
|
379
379
|
| 'yale_home_lock'
|
|
380
|
+
| 'yale_connect_lock'
|
|
380
381
|
| 'two_n_intercom'
|
|
381
382
|
| 'controlbyweb_device'
|
|
382
383
|
| 'ttlock_lock'
|
|
@@ -417,6 +418,7 @@ export type LocksListParameters = {
|
|
|
417
418
|
| 'yale_lock'
|
|
418
419
|
| 'yale_access_lock'
|
|
419
420
|
| 'yale_home_lock'
|
|
421
|
+
| 'yale_connect_lock'
|
|
420
422
|
| 'two_n_intercom'
|
|
421
423
|
| 'controlbyweb_device'
|
|
422
424
|
| 'ttlock_lock'
|
|
@@ -470,6 +472,7 @@ export type LocksListParameters = {
|
|
|
470
472
|
| 'lockly'
|
|
471
473
|
| 'smartthings'
|
|
472
474
|
| 'ultraloq'
|
|
475
|
+
| 'yale_connect'
|
|
473
476
|
| 'omnitec'
|
|
474
477
|
| 'kisi'
|
|
475
478
|
| 'yacan'
|
package/src/lib/version.ts
CHANGED