@seamapi/http 2.38.0 → 2.39.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.
Files changed (46) hide show
  1. package/lib/resources/access-grant.d.ts +2 -2
  2. package/lib/resources/access-method.d.ts +16 -1
  3. package/lib/resources/acs-entrance.d.ts +6 -2
  4. package/lib/resources/acs-system.d.ts +15 -0
  5. package/lib/resources/action-attempt.d.ts +332 -7
  6. package/lib/resources/connect-webview.d.ts +1 -1
  7. package/lib/resources/connected-account.d.ts +1 -1
  8. package/lib/resources/device-provider.d.ts +17 -1
  9. package/lib/resources/device.d.ts +112 -1
  10. package/lib/resources/phone.d.ts +702 -10
  11. package/lib/resources/unmanaged-access-grant.d.ts +2 -2
  12. package/lib/resources/unmanaged-access-method.d.ts +16 -1
  13. package/lib/resources/unmanaged-device.d.ts +17 -1
  14. package/lib/routes/connect-webviews/connect-webviews.d.ts +2 -2
  15. package/lib/routes/connected-accounts/connected-accounts.d.ts +1 -1
  16. package/lib/routes/customers/customers.d.ts +13 -0
  17. package/lib/routes/customers/customers.js +1 -0
  18. package/lib/routes/customers/customers.js.map +1 -1
  19. package/lib/routes/devices/devices.d.ts +3 -3
  20. package/lib/routes/devices/unmanaged/unmanaged.d.ts +3 -3
  21. package/lib/routes/seam-http-endpoints.d.ts +1 -0
  22. package/lib/routes/seam-http-endpoints.js +1 -0
  23. package/lib/routes/seam-http-endpoints.js.map +1 -1
  24. package/lib/version.d.ts +1 -1
  25. package/lib/version.js +1 -1
  26. package/package.json +2 -2
  27. package/src/lib/resources/access-grant.ts +2 -2
  28. package/src/lib/resources/access-method.ts +19 -1
  29. package/src/lib/resources/acs-entrance.ts +17 -12
  30. package/src/lib/resources/acs-system.ts +18 -0
  31. package/src/lib/resources/action-attempt.ts +425 -24
  32. package/src/lib/resources/connect-webview.ts +6 -1
  33. package/src/lib/resources/connected-account.ts +6 -1
  34. package/src/lib/resources/device-provider.ts +17 -0
  35. package/src/lib/resources/device.ts +127 -0
  36. package/src/lib/resources/phone.ts +855 -22
  37. package/src/lib/resources/unmanaged-access-grant.ts +2 -2
  38. package/src/lib/resources/unmanaged-access-method.ts +19 -1
  39. package/src/lib/resources/unmanaged-device.ts +17 -0
  40. package/src/lib/routes/connect-webviews/connect-webviews.ts +7 -1
  41. package/src/lib/routes/connected-accounts/connected-accounts.ts +6 -1
  42. package/src/lib/routes/customers/customers.ts +13 -0
  43. package/src/lib/routes/devices/devices.ts +3 -0
  44. package/src/lib/routes/devices/unmanaged/unmanaged.ts +3 -0
  45. package/src/lib/routes/seam-http-endpoints.ts +1 -0
  46. package/src/lib/version.ts +1 -1
@@ -274,9 +274,9 @@ export type AccessGrant = {
274
274
  */
275
275
  device_id: string;
276
276
  /**
277
- * Reason the access code could not be revoked (e.g. `offline_access_code_not_revocable`).
277
+ * Reason the access code could not be revoked.
278
278
  */
279
- error_code: string;
279
+ error_code: 'offline_access_code_not_revocable';
280
280
  /**
281
281
  * Human-readable description of why revocation failed.
282
282
  */
@@ -87,7 +87,7 @@ export type AccessMethod = {
87
87
  */
88
88
  is_ready_for_assignment?: boolean | undefined;
89
89
  /**
90
- * Indicates whether the access method is ready to be encoded. This is true when the credential has been created and the card has not yet been issued.
90
+ * Indicates whether the access method is ready to be encoded. This is true when the card has not yet been issued and the access system has received all the access the card needs. While it is false, `pending_mutations` contains `waiting_for_access_on_acs_system`.
91
91
  */
92
92
  is_ready_for_encoding?: boolean | undefined;
93
93
  /**
@@ -210,6 +210,21 @@ export type AccessMethod = {
210
210
  */
211
211
  starts_at: string | null;
212
212
  };
213
+ } /**
214
+ * The access system has not yet received all the access this card needs. A card encoded now would carry only the access the system already has, so wait until this clears before encoding.
215
+ */ | {
216
+ /**
217
+ * Date and time at which the mutation was created.
218
+ */
219
+ created_at: string;
220
+ /**
221
+ * Detailed description of the mutation.
222
+ */
223
+ message: string;
224
+ /**
225
+ * Mutation code to indicate that the access system has not yet received all the access this card needs, so the card is not ready to be encoded.
226
+ */
227
+ mutation_code: 'waiting_for_access_on_acs_system';
213
228
  }>;
214
229
  /**
215
230
  * Warnings associated with the [access method](https://www.seam.co/docs/use-cases/granting-access/creating-an-access-grant).
@@ -170,7 +170,11 @@ export type AcsEntrance = {
170
170
  /**
171
171
  * Errors associated with the [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details).
172
172
  */
173
- errors: Array<{
173
+ errors: Array<
174
+ /**
175
+ * Indicates that the [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details) was removed from the connected account, so Seam can no longer sync it.
176
+ */
177
+ {
174
178
  /**
175
179
  * Date and time at which Seam created the error.
176
180
  */
@@ -178,7 +182,7 @@ export type AcsEntrance = {
178
182
  /**
179
183
  * Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
180
184
  */
181
- error_code: string;
185
+ error_code: 'entrance_removed';
182
186
  /**
183
187
  * Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
184
188
  */
@@ -110,6 +110,21 @@ export type AcsSystem = {
110
110
  */
111
111
  message: string;
112
112
  } /**
113
+ * Indicates that the access control system has reached the maximum number of users its license allows, so Seam cannot create new users on it and access for new guests is not provisioned. Remove unused users from the access control system or increase its license. The error clears once Seam can create users again.
114
+ */ | {
115
+ /**
116
+ * Date and time at which Seam created the error.
117
+ */
118
+ created_at: string;
119
+ /**
120
+ * Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
121
+ */
122
+ error_code: 'user_license_limit_reached';
123
+ /**
124
+ * Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
125
+ */
126
+ message: string;
127
+ } /**
113
128
  * Indicates that the provider's system backing this [access control system](https://www.seam.co/docs/low-level-apis/access-systems) is not letting Seam act on it, so access cannot be managed until this is resolved. The error message says which of two causes applies. Either Seam's integration user does not have sufficient permissions on the provider's system, or has been suspended there: grant the integration user the required permissions in the provider's system, or reauthorize the connected account in Seam. Or the provider account or site does not have a valid subscription with the provider: set up or renew that subscription with the provider.
114
129
  */ | {
115
130
  /**
@@ -1093,7 +1093,7 @@ export type ActionAttempt = {
1093
1093
  */
1094
1094
  is_ready_for_assignment?: boolean | undefined;
1095
1095
  /**
1096
- * Indicates whether the access method is ready to be encoded. This is true when the credential has been created and the card has not yet been issued.
1096
+ * Indicates whether the access method is ready to be encoded. This is true when the card has not yet been issued and the access system has received all the access the card needs. While it is false, `pending_mutations` contains `waiting_for_access_on_acs_system`.
1097
1097
  */
1098
1098
  is_ready_for_encoding?: boolean | undefined;
1099
1099
  /**
@@ -1115,7 +1115,7 @@ export type ActionAttempt = {
1115
1115
  /**
1116
1116
  * Previous access time configuration.
1117
1117
  */
1118
- from: {
1118
+ from?: {
1119
1119
  /**
1120
1120
  * Previous end time for access.
1121
1121
  */
@@ -1124,19 +1124,19 @@ export type ActionAttempt = {
1124
1124
  * Previous start time for access.
1125
1125
  */
1126
1126
  starts_at: string | null;
1127
- };
1127
+ } | undefined;
1128
1128
  /**
1129
1129
  * Detailed description of the mutation.
1130
1130
  */
1131
1131
  message: string;
1132
1132
  /**
1133
- * Mutation code to indicate that Seam is in the process of updating the access times for this access method.
1133
+ * Mutation code to indicate that the access system has not yet received all the access this card needs, so the card is not ready to be encoded.
1134
1134
  */
1135
- mutation_code: 'provisioning_access' | 'revoking_access' | 'updating_access_times';
1135
+ mutation_code: 'provisioning_access' | 'revoking_access' | 'updating_access_times' | 'waiting_for_access_on_acs_system';
1136
1136
  /**
1137
1137
  * New access time configuration.
1138
1138
  */
1139
- to: {
1139
+ to?: {
1140
1140
  /**
1141
1141
  * New end time for access.
1142
1142
  */
@@ -1145,7 +1145,7 @@ export type ActionAttempt = {
1145
1145
  * New start time for access.
1146
1146
  */
1147
1147
  starts_at: string | null;
1148
- };
1148
+ } | undefined;
1149
1149
  }>;
1150
1150
  /**
1151
1151
  * Warnings associated with the [access method](https://www.seam.co/docs/use-cases/granting-access/creating-an-access-grant).
@@ -1843,6 +1843,331 @@ export type ActionAttempt = {
1843
1843
  */
1844
1844
  result: null;
1845
1845
  status: 'error';
1846
+ } | {
1847
+ /**
1848
+ * ID of the action attempt.
1849
+ */
1850
+ action_attempt_id: string;
1851
+ /**
1852
+ * Action attempt to track the status of setting the volume on a speaker.
1853
+ */
1854
+ action_type: 'SET_SPEAKER_VOLUME';
1855
+ /**
1856
+ * Error associated with the action.
1857
+ */
1858
+ error: null;
1859
+ /**
1860
+ * Result of the action.
1861
+ */
1862
+ result: {};
1863
+ status: 'success';
1864
+ } | {
1865
+ /**
1866
+ * ID of the action attempt.
1867
+ */
1868
+ action_attempt_id: string;
1869
+ /**
1870
+ * Action attempt to track the status of setting the volume on a speaker.
1871
+ */
1872
+ action_type: 'SET_SPEAKER_VOLUME';
1873
+ /**
1874
+ * Error associated with the action.
1875
+ */
1876
+ error: null;
1877
+ /**
1878
+ * Result of the action.
1879
+ */
1880
+ result: null;
1881
+ status: 'pending';
1882
+ } | {
1883
+ /**
1884
+ * ID of the action attempt.
1885
+ */
1886
+ action_attempt_id: string;
1887
+ /**
1888
+ * Action attempt to track the status of setting the volume on a speaker.
1889
+ */
1890
+ action_type: 'SET_SPEAKER_VOLUME';
1891
+ /**
1892
+ * Error associated with the action.
1893
+ */
1894
+ error: {
1895
+ /**
1896
+ * Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
1897
+ */
1898
+ message: string;
1899
+ /**
1900
+ * Type of the error.
1901
+ */
1902
+ type: string;
1903
+ };
1904
+ /**
1905
+ * Result of the action.
1906
+ */
1907
+ result: null;
1908
+ status: 'error';
1909
+ } | {
1910
+ /**
1911
+ * ID of the action attempt.
1912
+ */
1913
+ action_attempt_id: string;
1914
+ /**
1915
+ * Action attempt to track the status of muting or unmuting a speaker.
1916
+ */
1917
+ action_type: 'SET_SPEAKER_MUTE';
1918
+ /**
1919
+ * Error associated with the action.
1920
+ */
1921
+ error: null;
1922
+ /**
1923
+ * Result of the action.
1924
+ */
1925
+ result: {};
1926
+ status: 'success';
1927
+ } | {
1928
+ /**
1929
+ * ID of the action attempt.
1930
+ */
1931
+ action_attempt_id: string;
1932
+ /**
1933
+ * Action attempt to track the status of muting or unmuting a speaker.
1934
+ */
1935
+ action_type: 'SET_SPEAKER_MUTE';
1936
+ /**
1937
+ * Error associated with the action.
1938
+ */
1939
+ error: null;
1940
+ /**
1941
+ * Result of the action.
1942
+ */
1943
+ result: null;
1944
+ status: 'pending';
1945
+ } | {
1946
+ /**
1947
+ * ID of the action attempt.
1948
+ */
1949
+ action_attempt_id: string;
1950
+ /**
1951
+ * Action attempt to track the status of muting or unmuting a speaker.
1952
+ */
1953
+ action_type: 'SET_SPEAKER_MUTE';
1954
+ /**
1955
+ * Error associated with the action.
1956
+ */
1957
+ error: {
1958
+ /**
1959
+ * Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
1960
+ */
1961
+ message: string;
1962
+ /**
1963
+ * Type of the error.
1964
+ */
1965
+ type: string;
1966
+ };
1967
+ /**
1968
+ * Result of the action.
1969
+ */
1970
+ result: null;
1971
+ status: 'error';
1972
+ } | {
1973
+ /**
1974
+ * ID of the action attempt.
1975
+ */
1976
+ action_attempt_id: string;
1977
+ /**
1978
+ * Action attempt to track the status of pausing playback on a speaker.
1979
+ */
1980
+ action_type: 'PAUSE_SPEAKER_PLAYBACK';
1981
+ /**
1982
+ * Error associated with the action.
1983
+ */
1984
+ error: null;
1985
+ /**
1986
+ * Result of the action.
1987
+ */
1988
+ result: {
1989
+ /**
1990
+ * IDs of the speakers whose playback was paused, including speakers grouped with the requested speaker.
1991
+ */
1992
+ affected_device_ids: Array<string>;
1993
+ };
1994
+ status: 'success';
1995
+ } | {
1996
+ /**
1997
+ * ID of the action attempt.
1998
+ */
1999
+ action_attempt_id: string;
2000
+ /**
2001
+ * Action attempt to track the status of pausing playback on a speaker.
2002
+ */
2003
+ action_type: 'PAUSE_SPEAKER_PLAYBACK';
2004
+ /**
2005
+ * Error associated with the action.
2006
+ */
2007
+ error: null;
2008
+ /**
2009
+ * Result of the action.
2010
+ */
2011
+ result: null;
2012
+ status: 'pending';
2013
+ } | {
2014
+ /**
2015
+ * ID of the action attempt.
2016
+ */
2017
+ action_attempt_id: string;
2018
+ /**
2019
+ * Action attempt to track the status of pausing playback on a speaker.
2020
+ */
2021
+ action_type: 'PAUSE_SPEAKER_PLAYBACK';
2022
+ /**
2023
+ * Error associated with the action.
2024
+ */
2025
+ error: {
2026
+ /**
2027
+ * Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
2028
+ */
2029
+ message: string;
2030
+ /**
2031
+ * Type of the error.
2032
+ */
2033
+ type: string;
2034
+ };
2035
+ /**
2036
+ * Result of the action.
2037
+ */
2038
+ result: null;
2039
+ status: 'error';
2040
+ } | {
2041
+ /**
2042
+ * ID of the action attempt.
2043
+ */
2044
+ action_attempt_id: string;
2045
+ /**
2046
+ * Action attempt to track the status of resuming playback on a speaker.
2047
+ */
2048
+ action_type: 'RESUME_SPEAKER_PLAYBACK';
2049
+ /**
2050
+ * Error associated with the action.
2051
+ */
2052
+ error: null;
2053
+ /**
2054
+ * Result of the action.
2055
+ */
2056
+ result: {
2057
+ /**
2058
+ * IDs of the speakers whose playback was resumed, including speakers grouped with the requested speaker.
2059
+ */
2060
+ affected_device_ids: Array<string>;
2061
+ };
2062
+ status: 'success';
2063
+ } | {
2064
+ /**
2065
+ * ID of the action attempt.
2066
+ */
2067
+ action_attempt_id: string;
2068
+ /**
2069
+ * Action attempt to track the status of resuming playback on a speaker.
2070
+ */
2071
+ action_type: 'RESUME_SPEAKER_PLAYBACK';
2072
+ /**
2073
+ * Error associated with the action.
2074
+ */
2075
+ error: null;
2076
+ /**
2077
+ * Result of the action.
2078
+ */
2079
+ result: null;
2080
+ status: 'pending';
2081
+ } | {
2082
+ /**
2083
+ * ID of the action attempt.
2084
+ */
2085
+ action_attempt_id: string;
2086
+ /**
2087
+ * Action attempt to track the status of resuming playback on a speaker.
2088
+ */
2089
+ action_type: 'RESUME_SPEAKER_PLAYBACK';
2090
+ /**
2091
+ * Error associated with the action.
2092
+ */
2093
+ error: {
2094
+ /**
2095
+ * Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
2096
+ */
2097
+ message: string;
2098
+ /**
2099
+ * Type of the error.
2100
+ */
2101
+ type: string;
2102
+ };
2103
+ /**
2104
+ * Result of the action.
2105
+ */
2106
+ result: null;
2107
+ status: 'error';
2108
+ } | {
2109
+ /**
2110
+ * ID of the action attempt.
2111
+ */
2112
+ action_attempt_id: string;
2113
+ /**
2114
+ * Action attempt to track the status of playing a chime on a speaker.
2115
+ */
2116
+ action_type: 'PLAY_SPEAKER_CHIME';
2117
+ /**
2118
+ * Error associated with the action.
2119
+ */
2120
+ error: null;
2121
+ /**
2122
+ * Result of the action.
2123
+ */
2124
+ result: {};
2125
+ status: 'success';
2126
+ } | {
2127
+ /**
2128
+ * ID of the action attempt.
2129
+ */
2130
+ action_attempt_id: string;
2131
+ /**
2132
+ * Action attempt to track the status of playing a chime on a speaker.
2133
+ */
2134
+ action_type: 'PLAY_SPEAKER_CHIME';
2135
+ /**
2136
+ * Error associated with the action.
2137
+ */
2138
+ error: null;
2139
+ /**
2140
+ * Result of the action.
2141
+ */
2142
+ result: null;
2143
+ status: 'pending';
2144
+ } | {
2145
+ /**
2146
+ * ID of the action attempt.
2147
+ */
2148
+ action_attempt_id: string;
2149
+ /**
2150
+ * Action attempt to track the status of playing a chime on a speaker.
2151
+ */
2152
+ action_type: 'PLAY_SPEAKER_CHIME';
2153
+ /**
2154
+ * Error associated with the action.
2155
+ */
2156
+ error: {
2157
+ /**
2158
+ * Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
2159
+ */
2160
+ message: string;
2161
+ /**
2162
+ * Type of the error.
2163
+ */
2164
+ type: string;
2165
+ };
2166
+ /**
2167
+ * Result of the action.
2168
+ */
2169
+ result: null;
2170
+ status: 'error';
1846
2171
  } | {
1847
2172
  /**
1848
2173
  * ID of the action attempt.
@@ -15,7 +15,7 @@ export type ConnectWebview = {
15
15
  /**
16
16
  * High-level device capabilities that the Connect Webview can accept. When creating a Connect Webview, you can specify the types of devices that it can connect to Seam. If you do not set custom `accepted_capabilities`, Seam uses a default set of `accepted_capabilities` for each provider. For example, if you create a Connect Webview that accepts SmartThing devices, without specifying `accepted_capabilities`, Seam accepts only SmartThings locks. To connect SmartThings thermostats and locks to Seam, create a Connect Webview and include both `thermostat` and `lock` in the `accepted_capabilities`.
17
17
  */
18
- accepted_capabilities: Array<'lock' | 'thermostat' | 'noise_sensor' | 'access_control' | 'camera'>;
18
+ accepted_capabilities: Array<'lock' | 'thermostat' | 'noise_sensor' | 'access_control' | 'camera' | 'speaker'>;
19
19
  /**
20
20
  * List of accepted [provider keys](https://www.seam.co/docs/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-brands-to-display-in-your-connect-webviews).
21
21
  */
@@ -5,7 +5,7 @@ export type ConnectedAccount = {
5
5
  /**
6
6
  * List of capabilities that were accepted during the account connection process.
7
7
  */
8
- accepted_capabilities: Array<'lock' | 'thermostat' | 'noise_sensor' | 'access_control' | 'camera'>;
8
+ accepted_capabilities: Array<'lock' | 'thermostat' | 'noise_sensor' | 'access_control' | 'camera' | 'speaker'>;
9
9
  /**
10
10
  * Type of connected account.
11
11
  */
@@ -19,6 +19,18 @@ export type DeviceProvider = {
19
19
  * Indicates whether the thermostat supports simultaneous heating and cooling.
20
20
  */
21
21
  can_hvac_heat_cool?: boolean | undefined;
22
+ /**
23
+ * Indicates whether the speaker supports muting and unmuting.
24
+ */
25
+ can_mute_speaker?: boolean | undefined;
26
+ /**
27
+ * Indicates whether the speaker supports pausing and resuming playback.
28
+ */
29
+ can_pause_speaker_playback?: boolean | undefined;
30
+ /**
31
+ * Indicates whether the speaker supports playing a chime.
32
+ */
33
+ can_play_speaker_chime?: boolean | undefined;
22
34
  /**
23
35
  * Indicates whether the device supports programming offline access codes.
24
36
  */
@@ -51,6 +63,10 @@ export type DeviceProvider = {
51
63
  * Indicates whether the thermostat supports running climate programs.
52
64
  */
53
65
  can_run_thermostat_programs?: boolean | undefined;
66
+ /**
67
+ * Indicates whether the speaker supports setting its volume.
68
+ */
69
+ can_set_speaker_volume?: boolean | undefined;
54
70
  /**
55
71
  * Indicates whether the device supports simulating connection in a sandbox.
56
72
  */
@@ -90,7 +106,7 @@ export type DeviceProvider = {
90
106
  /**
91
107
  * Name of the device provider.
92
108
  */
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' | 'ical' | 'lodgify' | 'hostaway' | 'guesty' | 'acuity_scheduling' | 'omnitec' | 'kisi' | 'aqara';
109
+ 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' | 'ical' | 'lodgify' | 'hostaway' | 'guesty' | 'acuity_scheduling' | 'omnitec' | 'kisi' | 'aqara' | 'sonos';
94
110
  /**
95
111
  * Display name for the device provider.
96
112
  */
@@ -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 and unmuting.
27
+ */
28
+ can_mute_speaker?: boolean | undefined;
29
+ /**
30
+ * Indicates whether the speaker supports pausing and resuming 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
  */
@@ -54,6 +66,10 @@ export type Device = {
54
66
  * Indicates whether the thermostat supports running climate programs.
55
67
  */
56
68
  can_run_thermostat_programs?: boolean | undefined;
69
+ /**
70
+ * Indicates whether the speaker supports setting its volume.
71
+ */
72
+ can_set_speaker_volume?: boolean | undefined;
57
73
  /**
58
74
  * Indicates whether the device supports simulating connection in a sandbox.
59
75
  */
@@ -151,7 +167,7 @@ export type Device = {
151
167
  /**
152
168
  * Type of the device.
153
169
  */
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';
170
+ 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
171
  /**
156
172
  * 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
173
  */
@@ -1591,6 +1607,39 @@ export type Device = {
1591
1607
  */
1592
1608
  model?: string | undefined;
1593
1609
  } | undefined;
1610
+ /**
1611
+ * Metadata for a Sonos speaker.
1612
+ */
1613
+ sonos_metadata?: {
1614
+ /**
1615
+ * Models of the speakers bonded to this speaker, such as surrounds or a subwoofer.
1616
+ */
1617
+ bonded_member_models?: Array<string> | undefined;
1618
+ /**
1619
+ * Color of the speaker, as reported by Sonos.
1620
+ */
1621
+ color?: string | undefined;
1622
+ /**
1623
+ * ID of the Sonos household that the speaker belongs to.
1624
+ */
1625
+ household_id?: string | undefined;
1626
+ /**
1627
+ * Model name of the speaker, as reported by Sonos.
1628
+ */
1629
+ model_display_name?: string | undefined;
1630
+ /**
1631
+ * ID of the Sonos player for the speaker.
1632
+ */
1633
+ player_id?: string | undefined;
1634
+ /**
1635
+ * Name of the speaker, as set in the Sonos app.
1636
+ */
1637
+ player_name?: string | undefined;
1638
+ /**
1639
+ * Software version running on the speaker.
1640
+ */
1641
+ software_version?: string | undefined;
1642
+ } | undefined;
1594
1643
  /**
1595
1644
  * Metadata for a tado° device.
1596
1645
  */
@@ -1977,6 +2026,68 @@ export type Device = {
1977
2026
  */
1978
2027
  time_zone?: string | undefined;
1979
2028
  }> | undefined;
2029
+ /**
2030
+ * Audio state and capabilities of the speaker.
2031
+ */
2032
+ speaker?: {
2033
+ /**
2034
+ * 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.
2035
+ */
2036
+ grouped_with_device_ids: Array<string>;
2037
+ /**
2038
+ * 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.
2039
+ */
2040
+ has_fixed_volume: boolean;
2041
+ /**
2042
+ * Indicates whether the speaker is muted.
2043
+ */
2044
+ is_muted: boolean;
2045
+ /**
2046
+ * 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.
2047
+ */
2048
+ max_volume: number;
2049
+ /**
2050
+ * Minimum volume that you can set on the speaker.
2051
+ */
2052
+ min_volume: number;
2053
+ /**
2054
+ * Content that is currently playing on the speaker.
2055
+ */
2056
+ now_playing?: {
2057
+ /**
2058
+ * Album of the content that is currently playing.
2059
+ */
2060
+ album?: string | undefined;
2061
+ /**
2062
+ * Artist of the content that is currently playing.
2063
+ */
2064
+ artist?: string | undefined;
2065
+ /**
2066
+ * Title of the content that is currently playing.
2067
+ */
2068
+ title?: string | undefined;
2069
+ } | undefined;
2070
+ /**
2071
+ * Playback state of the speaker.
2072
+ */
2073
+ playback_state: 'playing' | 'paused' | 'idle' | 'buffering' | 'unknown';
2074
+ /**
2075
+ * Indicates whether the speaker can play a chime.
2076
+ */
2077
+ supports_chime: boolean;
2078
+ /**
2079
+ * 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.
2080
+ */
2081
+ volume: number;
2082
+ /**
2083
+ * Date and time at which the speaker first reported its current volume.
2084
+ */
2085
+ volume_reported_at?: string | undefined;
2086
+ /**
2087
+ * Increment between the volume values that you can set on the speaker.
2088
+ */
2089
+ volume_step: number;
2090
+ } | undefined;
1980
2091
  /**
1981
2092
  * Supported code lengths for access codes.
1982
2093
  */