@seamapi/http 2.38.0 → 2.40.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/access-grant.d.ts +9 -5
- package/lib/resources/access-method.d.ts +39 -1
- package/lib/resources/acs-entrance.d.ts +6 -2
- package/lib/resources/acs-system.d.ts +15 -0
- package/lib/resources/action-attempt.d.ts +341 -8
- package/lib/resources/connect-webview.d.ts +1 -1
- package/lib/resources/connected-account.d.ts +1 -1
- package/lib/resources/device-provider.d.ts +25 -1
- package/lib/resources/device.d.ts +121 -2
- package/lib/resources/event.d.ts +1 -1
- package/lib/resources/phone.d.ts +702 -10
- package/lib/resources/unmanaged-access-grant.d.ts +9 -5
- package/lib/resources/unmanaged-access-method.d.ts +39 -1
- package/lib/resources/unmanaged-device.d.ts +25 -1
- package/lib/routes/connect-webviews/connect-webviews.d.ts +2 -2
- package/lib/routes/connected-accounts/connected-accounts.d.ts +1 -1
- package/lib/routes/customers/customers.d.ts +21 -0
- package/lib/routes/customers/customers.js +1 -0
- package/lib/routes/customers/customers.js.map +1 -1
- package/lib/routes/devices/devices.d.ts +3 -3
- package/lib/routes/devices/unmanaged/unmanaged.d.ts +3 -3
- package/lib/routes/seam-http-endpoints.d.ts +1 -0
- package/lib/routes/seam-http-endpoints.js +1 -0
- package/lib/routes/seam-http-endpoints.js.map +1 -1
- package/lib/version.d.ts +1 -1
- package/lib/version.js +1 -1
- package/package.json +2 -2
- package/src/lib/resources/access-grant.ts +9 -6
- package/src/lib/resources/access-method.ts +47 -1
- package/src/lib/resources/acs-entrance.ts +17 -12
- package/src/lib/resources/acs-system.ts +18 -0
- package/src/lib/resources/action-attempt.ts +434 -24
- package/src/lib/resources/connect-webview.ts +6 -1
- package/src/lib/resources/connected-account.ts +6 -1
- package/src/lib/resources/device-provider.ts +25 -0
- package/src/lib/resources/device.ts +136 -1
- package/src/lib/resources/event.ts +1 -0
- package/src/lib/resources/phone.ts +855 -22
- package/src/lib/resources/unmanaged-access-grant.ts +9 -6
- package/src/lib/resources/unmanaged-access-method.ts +47 -1
- package/src/lib/resources/unmanaged-device.ts +25 -0
- package/src/lib/routes/connect-webviews/connect-webviews.ts +7 -1
- package/src/lib/routes/connected-accounts/connected-accounts.ts +6 -1
- package/src/lib/routes/customers/customers.ts +21 -0
- package/src/lib/routes/devices/devices.ts +3 -0
- package/src/lib/routes/devices/unmanaged/unmanaged.ts +3 -0
- package/src/lib/routes/seam-http-endpoints.ts +1 -0
- package/src/lib/version.ts +1 -1
|
@@ -22,6 +22,18 @@ export type Device = {
|
|
|
22
22
|
* Indicates whether the thermostat supports simultaneous heating and cooling.
|
|
23
23
|
*/
|
|
24
24
|
can_hvac_heat_cool?: boolean | undefined;
|
|
25
|
+
/**
|
|
26
|
+
* Indicates whether the speaker supports muting.
|
|
27
|
+
*/
|
|
28
|
+
can_mute_speaker?: boolean | undefined;
|
|
29
|
+
/**
|
|
30
|
+
* Indicates whether the speaker supports pausing playback.
|
|
31
|
+
*/
|
|
32
|
+
can_pause_speaker_playback?: boolean | undefined;
|
|
33
|
+
/**
|
|
34
|
+
* Indicates whether the speaker supports playing a chime.
|
|
35
|
+
*/
|
|
36
|
+
can_play_speaker_chime?: boolean | undefined;
|
|
25
37
|
/**
|
|
26
38
|
* Indicates whether the device supports programming offline access codes.
|
|
27
39
|
*/
|
|
@@ -50,10 +62,18 @@ export type Device = {
|
|
|
50
62
|
* Indicates whether the device supports remote unlocking.
|
|
51
63
|
*/
|
|
52
64
|
can_remotely_unlock?: boolean | undefined;
|
|
65
|
+
/**
|
|
66
|
+
* Indicates whether the speaker supports resuming playback.
|
|
67
|
+
*/
|
|
68
|
+
can_resume_speaker_playback?: boolean | undefined;
|
|
53
69
|
/**
|
|
54
70
|
* Indicates whether the thermostat supports running climate programs.
|
|
55
71
|
*/
|
|
56
72
|
can_run_thermostat_programs?: boolean | undefined;
|
|
73
|
+
/**
|
|
74
|
+
* Indicates whether the speaker supports setting its volume.
|
|
75
|
+
*/
|
|
76
|
+
can_set_speaker_volume?: boolean | undefined;
|
|
57
77
|
/**
|
|
58
78
|
* Indicates whether the device supports simulating connection in a sandbox.
|
|
59
79
|
*/
|
|
@@ -90,6 +110,10 @@ export type Device = {
|
|
|
90
110
|
* Indicates whether the lock supports unlocking with an access code.
|
|
91
111
|
*/
|
|
92
112
|
can_unlock_with_code?: boolean | undefined;
|
|
113
|
+
/**
|
|
114
|
+
* Indicates whether the speaker supports unmuting.
|
|
115
|
+
*/
|
|
116
|
+
can_unmute_speaker?: boolean | undefined;
|
|
93
117
|
/**
|
|
94
118
|
* Collection of capabilities that the device supports when connected to Seam. Values are `access_code`, which indicates that the device can manage and utilize digital PIN codes for secure access; `lock`, which indicates that the device controls a door locking mechanism, enabling the remote opening and closing of doors and other entry points; `noise_detection`, which indicates that the device supports monitoring and responding to ambient noise levels; `thermostat`, which indicates that the device can regulate and adjust indoor temperatures; `battery`, which indicates that the device can manage battery life and health; and `phone`, which indicates that the device is a mobile device, such as a smartphone. **Important:** Superseded by [capability flags](https://www.seam.co/docs/capability-guides/device-and-system-capabilities#capability-flags).
|
|
95
119
|
*/
|
|
@@ -151,7 +175,7 @@ export type Device = {
|
|
|
151
175
|
/**
|
|
152
176
|
* Type of the device.
|
|
153
177
|
*/
|
|
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' | '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' | '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';
|
|
178
|
+
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' | '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' | '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' | 'sonos_speaker';
|
|
155
179
|
/**
|
|
156
180
|
* 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
181
|
*/
|
|
@@ -1562,7 +1586,7 @@ export type Device = {
|
|
|
1562
1586
|
*/
|
|
1563
1587
|
device_name?: string | undefined;
|
|
1564
1588
|
/**
|
|
1565
|
-
*
|
|
1589
|
+
* Deprecated. Seam no longer sets this field.
|
|
1566
1590
|
*/
|
|
1567
1591
|
dual_setpoints_not_supported?: boolean | undefined;
|
|
1568
1592
|
/**
|
|
@@ -1591,6 +1615,39 @@ export type Device = {
|
|
|
1591
1615
|
*/
|
|
1592
1616
|
model?: string | undefined;
|
|
1593
1617
|
} | undefined;
|
|
1618
|
+
/**
|
|
1619
|
+
* Metadata for a Sonos speaker.
|
|
1620
|
+
*/
|
|
1621
|
+
sonos_metadata?: {
|
|
1622
|
+
/**
|
|
1623
|
+
* Models of the speakers bonded to this speaker, such as surrounds or a subwoofer.
|
|
1624
|
+
*/
|
|
1625
|
+
bonded_member_models?: Array<string> | undefined;
|
|
1626
|
+
/**
|
|
1627
|
+
* Color of the speaker, as reported by Sonos.
|
|
1628
|
+
*/
|
|
1629
|
+
color?: string | undefined;
|
|
1630
|
+
/**
|
|
1631
|
+
* ID of the Sonos household that the speaker belongs to.
|
|
1632
|
+
*/
|
|
1633
|
+
household_id?: string | undefined;
|
|
1634
|
+
/**
|
|
1635
|
+
* Model name of the speaker, as reported by Sonos.
|
|
1636
|
+
*/
|
|
1637
|
+
model_display_name?: string | undefined;
|
|
1638
|
+
/**
|
|
1639
|
+
* ID of the Sonos player for the speaker.
|
|
1640
|
+
*/
|
|
1641
|
+
player_id?: string | undefined;
|
|
1642
|
+
/**
|
|
1643
|
+
* Name of the speaker, as set in the Sonos app.
|
|
1644
|
+
*/
|
|
1645
|
+
player_name?: string | undefined;
|
|
1646
|
+
/**
|
|
1647
|
+
* Software version running on the speaker.
|
|
1648
|
+
*/
|
|
1649
|
+
software_version?: string | undefined;
|
|
1650
|
+
} | undefined;
|
|
1594
1651
|
/**
|
|
1595
1652
|
* Metadata for a tado° device.
|
|
1596
1653
|
*/
|
|
@@ -1977,6 +2034,68 @@ export type Device = {
|
|
|
1977
2034
|
*/
|
|
1978
2035
|
time_zone?: string | undefined;
|
|
1979
2036
|
}> | undefined;
|
|
2037
|
+
/**
|
|
2038
|
+
* Audio state and capabilities of the speaker.
|
|
2039
|
+
*/
|
|
2040
|
+
speaker?: {
|
|
2041
|
+
/**
|
|
2042
|
+
* IDs of the other speakers that are currently grouped with this speaker. Pausing or resuming playback on a speaker also affects the speakers in its group.
|
|
2043
|
+
*/
|
|
2044
|
+
grouped_with_device_ids: Array<string>;
|
|
2045
|
+
/**
|
|
2046
|
+
* Indicates whether the speaker's volume is fixed, for example, because the speaker's line-out level is controlled by an external amplifier. A speaker with a fixed volume cannot have its volume set through Seam.
|
|
2047
|
+
*/
|
|
2048
|
+
has_fixed_volume: boolean;
|
|
2049
|
+
/**
|
|
2050
|
+
* Indicates whether the speaker is muted.
|
|
2051
|
+
*/
|
|
2052
|
+
is_muted: boolean;
|
|
2053
|
+
/**
|
|
2054
|
+
* Maximum volume that you can set on the speaker. This is the ceiling of the speaker's native volume scale, not a limit configured for guests.
|
|
2055
|
+
*/
|
|
2056
|
+
max_volume: number;
|
|
2057
|
+
/**
|
|
2058
|
+
* Minimum volume that you can set on the speaker.
|
|
2059
|
+
*/
|
|
2060
|
+
min_volume: number;
|
|
2061
|
+
/**
|
|
2062
|
+
* Content that is currently playing on the speaker.
|
|
2063
|
+
*/
|
|
2064
|
+
now_playing?: {
|
|
2065
|
+
/**
|
|
2066
|
+
* Album of the content that is currently playing.
|
|
2067
|
+
*/
|
|
2068
|
+
album?: string | undefined;
|
|
2069
|
+
/**
|
|
2070
|
+
* Artist of the content that is currently playing.
|
|
2071
|
+
*/
|
|
2072
|
+
artist?: string | undefined;
|
|
2073
|
+
/**
|
|
2074
|
+
* Title of the content that is currently playing.
|
|
2075
|
+
*/
|
|
2076
|
+
title?: string | undefined;
|
|
2077
|
+
} | undefined;
|
|
2078
|
+
/**
|
|
2079
|
+
* Playback state of the speaker.
|
|
2080
|
+
*/
|
|
2081
|
+
playback_state: 'playing' | 'paused' | 'idle' | 'buffering' | 'unknown';
|
|
2082
|
+
/**
|
|
2083
|
+
* Indicates whether the speaker can play a chime.
|
|
2084
|
+
*/
|
|
2085
|
+
supports_chime: boolean;
|
|
2086
|
+
/**
|
|
2087
|
+
* Current volume of the speaker, on the speaker's native volume scale from `min_volume` to `max_volume`. This is the native volume setting, not a decibel level.
|
|
2088
|
+
*/
|
|
2089
|
+
volume: number;
|
|
2090
|
+
/**
|
|
2091
|
+
* Date and time at which the speaker first reported its current volume.
|
|
2092
|
+
*/
|
|
2093
|
+
volume_reported_at?: string | undefined;
|
|
2094
|
+
/**
|
|
2095
|
+
* Increment between the volume values that you can set on the speaker.
|
|
2096
|
+
*/
|
|
2097
|
+
volume_step: number;
|
|
2098
|
+
} | undefined;
|
|
1980
2099
|
/**
|
|
1981
2100
|
* Supported code lengths for access codes.
|
|
1982
2101
|
*/
|
package/lib/resources/event.d.ts
CHANGED
|
@@ -4861,7 +4861,7 @@ export type SeamEvent = {
|
|
|
4861
4861
|
/**
|
|
4862
4862
|
* Normalized reason a lock denied access. Provider-agnostic; not all providers report every value.
|
|
4863
4863
|
*/
|
|
4864
|
-
reason_code: 'unknown_code' | 'expired_code' | 'blocklisted_code' | 'too_many_attempts' | 'blocked_by_privacy_mode' | 'credential_error';
|
|
4864
|
+
reason_code: 'unknown_code' | 'expired_code' | 'blocklisted_code' | 'too_many_attempts' | 'blocked_by_privacy_mode' | 'credential_error' | 'connection_error';
|
|
4865
4865
|
} | undefined;
|
|
4866
4866
|
/**
|
|
4867
4867
|
* ID of the workspace associated with the event.
|