@seamapi/http 2.40.0 → 2.42.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-code.d.ts +1 -1
- package/lib/resources/access-grant.d.ts +19 -0
- package/lib/resources/action-attempt.d.ts +0 -325
- package/lib/resources/device-provider.d.ts +0 -24
- package/lib/resources/device.d.ts +0 -119
- package/lib/resources/unmanaged-access-code.d.ts +1 -1
- package/lib/resources/unmanaged-access-grant.d.ts +19 -0
- package/lib/resources/unmanaged-device.d.ts +0 -24
- package/lib/routes/customers/customers.d.ts +3 -0
- package/lib/routes/user-identities/user-identities.d.ts +4 -0
- package/lib/version.d.ts +1 -1
- package/lib/version.js +1 -1
- package/package.json +2 -2
- package/src/lib/resources/access-code.ts +1 -1
- package/src/lib/resources/access-grant.ts +23 -0
- package/src/lib/resources/action-attempt.ts +0 -395
- package/src/lib/resources/device-provider.ts +0 -24
- package/src/lib/resources/device.ts +0 -134
- package/src/lib/resources/unmanaged-access-code.ts +1 -1
- package/src/lib/resources/unmanaged-access-grant.ts +23 -0
- package/src/lib/resources/unmanaged-device.ts +0 -24
- package/src/lib/routes/customers/customers.ts +3 -1
- package/src/lib/routes/user-identities/user-identities.ts +4 -0
- package/src/lib/version.ts +1 -1
|
@@ -262,7 +262,7 @@ export type AccessCode = {
|
|
|
262
262
|
*/
|
|
263
263
|
message: string;
|
|
264
264
|
} /**
|
|
265
|
-
* Seam was unable to issue this access code before its start time, so the recipient may be unable to unlock the device. This usually points to a problem that needs attention, such as an offline or disconnected device.
|
|
265
|
+
* Seam was unable to issue this access code before its start time, so the recipient may be unable to unlock the device. This usually points to a problem that needs attention, such as an offline or disconnected device. This error clears automatically if the access code is eventually issued.
|
|
266
266
|
*/ | {
|
|
267
267
|
/**
|
|
268
268
|
* Date and time at which Seam created the error.
|
|
@@ -382,6 +382,25 @@ export type AccessGrant = {
|
|
|
382
382
|
* Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
|
|
383
383
|
*/
|
|
384
384
|
warning_code: 'device_time_constraints_violated';
|
|
385
|
+
} /**
|
|
386
|
+
* Indicates that one of this access grant's access methods no longer grants access because of a change outside Seam, for example its card was encoded again for another credential. Seam does not replace the access method; issue a new one if the user still needs it.
|
|
387
|
+
*/ | {
|
|
388
|
+
/**
|
|
389
|
+
* ID of the access method whose access was revoked.
|
|
390
|
+
*/
|
|
391
|
+
access_method_id: string;
|
|
392
|
+
/**
|
|
393
|
+
* Date and time at which Seam created the warning.
|
|
394
|
+
*/
|
|
395
|
+
created_at: string;
|
|
396
|
+
/**
|
|
397
|
+
* Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
|
|
398
|
+
*/
|
|
399
|
+
message: string;
|
|
400
|
+
/**
|
|
401
|
+
* Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
|
|
402
|
+
*/
|
|
403
|
+
warning_code: 'access_revoked';
|
|
385
404
|
}>;
|
|
386
405
|
/**
|
|
387
406
|
* ID of the Seam workspace associated with the Access Grant.
|
|
@@ -1851,331 +1851,6 @@ export type ActionAttempt = {
|
|
|
1851
1851
|
*/
|
|
1852
1852
|
result: null;
|
|
1853
1853
|
status: 'error';
|
|
1854
|
-
} | {
|
|
1855
|
-
/**
|
|
1856
|
-
* ID of the action attempt.
|
|
1857
|
-
*/
|
|
1858
|
-
action_attempt_id: string;
|
|
1859
|
-
/**
|
|
1860
|
-
* Action attempt to track the status of setting the volume on a speaker.
|
|
1861
|
-
*/
|
|
1862
|
-
action_type: 'SET_SPEAKER_VOLUME';
|
|
1863
|
-
/**
|
|
1864
|
-
* Error associated with the action.
|
|
1865
|
-
*/
|
|
1866
|
-
error: null;
|
|
1867
|
-
/**
|
|
1868
|
-
* Result of the action.
|
|
1869
|
-
*/
|
|
1870
|
-
result: {};
|
|
1871
|
-
status: 'success';
|
|
1872
|
-
} | {
|
|
1873
|
-
/**
|
|
1874
|
-
* ID of the action attempt.
|
|
1875
|
-
*/
|
|
1876
|
-
action_attempt_id: string;
|
|
1877
|
-
/**
|
|
1878
|
-
* Action attempt to track the status of setting the volume on a speaker.
|
|
1879
|
-
*/
|
|
1880
|
-
action_type: 'SET_SPEAKER_VOLUME';
|
|
1881
|
-
/**
|
|
1882
|
-
* Error associated with the action.
|
|
1883
|
-
*/
|
|
1884
|
-
error: null;
|
|
1885
|
-
/**
|
|
1886
|
-
* Result of the action.
|
|
1887
|
-
*/
|
|
1888
|
-
result: null;
|
|
1889
|
-
status: 'pending';
|
|
1890
|
-
} | {
|
|
1891
|
-
/**
|
|
1892
|
-
* ID of the action attempt.
|
|
1893
|
-
*/
|
|
1894
|
-
action_attempt_id: string;
|
|
1895
|
-
/**
|
|
1896
|
-
* Action attempt to track the status of setting the volume on a speaker.
|
|
1897
|
-
*/
|
|
1898
|
-
action_type: 'SET_SPEAKER_VOLUME';
|
|
1899
|
-
/**
|
|
1900
|
-
* Error associated with the action.
|
|
1901
|
-
*/
|
|
1902
|
-
error: {
|
|
1903
|
-
/**
|
|
1904
|
-
* Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
|
|
1905
|
-
*/
|
|
1906
|
-
message: string;
|
|
1907
|
-
/**
|
|
1908
|
-
* Type of the error.
|
|
1909
|
-
*/
|
|
1910
|
-
type: string;
|
|
1911
|
-
};
|
|
1912
|
-
/**
|
|
1913
|
-
* Result of the action.
|
|
1914
|
-
*/
|
|
1915
|
-
result: null;
|
|
1916
|
-
status: 'error';
|
|
1917
|
-
} | {
|
|
1918
|
-
/**
|
|
1919
|
-
* ID of the action attempt.
|
|
1920
|
-
*/
|
|
1921
|
-
action_attempt_id: string;
|
|
1922
|
-
/**
|
|
1923
|
-
* Action attempt to track the status of muting or unmuting a speaker.
|
|
1924
|
-
*/
|
|
1925
|
-
action_type: 'SET_SPEAKER_MUTE';
|
|
1926
|
-
/**
|
|
1927
|
-
* Error associated with the action.
|
|
1928
|
-
*/
|
|
1929
|
-
error: null;
|
|
1930
|
-
/**
|
|
1931
|
-
* Result of the action.
|
|
1932
|
-
*/
|
|
1933
|
-
result: {};
|
|
1934
|
-
status: 'success';
|
|
1935
|
-
} | {
|
|
1936
|
-
/**
|
|
1937
|
-
* ID of the action attempt.
|
|
1938
|
-
*/
|
|
1939
|
-
action_attempt_id: string;
|
|
1940
|
-
/**
|
|
1941
|
-
* Action attempt to track the status of muting or unmuting a speaker.
|
|
1942
|
-
*/
|
|
1943
|
-
action_type: 'SET_SPEAKER_MUTE';
|
|
1944
|
-
/**
|
|
1945
|
-
* Error associated with the action.
|
|
1946
|
-
*/
|
|
1947
|
-
error: null;
|
|
1948
|
-
/**
|
|
1949
|
-
* Result of the action.
|
|
1950
|
-
*/
|
|
1951
|
-
result: null;
|
|
1952
|
-
status: 'pending';
|
|
1953
|
-
} | {
|
|
1954
|
-
/**
|
|
1955
|
-
* ID of the action attempt.
|
|
1956
|
-
*/
|
|
1957
|
-
action_attempt_id: string;
|
|
1958
|
-
/**
|
|
1959
|
-
* Action attempt to track the status of muting or unmuting a speaker.
|
|
1960
|
-
*/
|
|
1961
|
-
action_type: 'SET_SPEAKER_MUTE';
|
|
1962
|
-
/**
|
|
1963
|
-
* Error associated with the action.
|
|
1964
|
-
*/
|
|
1965
|
-
error: {
|
|
1966
|
-
/**
|
|
1967
|
-
* Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
|
|
1968
|
-
*/
|
|
1969
|
-
message: string;
|
|
1970
|
-
/**
|
|
1971
|
-
* Type of the error.
|
|
1972
|
-
*/
|
|
1973
|
-
type: string;
|
|
1974
|
-
};
|
|
1975
|
-
/**
|
|
1976
|
-
* Result of the action.
|
|
1977
|
-
*/
|
|
1978
|
-
result: null;
|
|
1979
|
-
status: 'error';
|
|
1980
|
-
} | {
|
|
1981
|
-
/**
|
|
1982
|
-
* ID of the action attempt.
|
|
1983
|
-
*/
|
|
1984
|
-
action_attempt_id: string;
|
|
1985
|
-
/**
|
|
1986
|
-
* Action attempt to track the status of pausing playback on a speaker.
|
|
1987
|
-
*/
|
|
1988
|
-
action_type: 'PAUSE_SPEAKER_PLAYBACK';
|
|
1989
|
-
/**
|
|
1990
|
-
* Error associated with the action.
|
|
1991
|
-
*/
|
|
1992
|
-
error: null;
|
|
1993
|
-
/**
|
|
1994
|
-
* Result of the action.
|
|
1995
|
-
*/
|
|
1996
|
-
result: {
|
|
1997
|
-
/**
|
|
1998
|
-
* IDs of the speakers whose playback was paused, including speakers grouped with the requested speaker.
|
|
1999
|
-
*/
|
|
2000
|
-
affected_device_ids: Array<string>;
|
|
2001
|
-
};
|
|
2002
|
-
status: 'success';
|
|
2003
|
-
} | {
|
|
2004
|
-
/**
|
|
2005
|
-
* ID of the action attempt.
|
|
2006
|
-
*/
|
|
2007
|
-
action_attempt_id: string;
|
|
2008
|
-
/**
|
|
2009
|
-
* Action attempt to track the status of pausing playback on a speaker.
|
|
2010
|
-
*/
|
|
2011
|
-
action_type: 'PAUSE_SPEAKER_PLAYBACK';
|
|
2012
|
-
/**
|
|
2013
|
-
* Error associated with the action.
|
|
2014
|
-
*/
|
|
2015
|
-
error: null;
|
|
2016
|
-
/**
|
|
2017
|
-
* Result of the action.
|
|
2018
|
-
*/
|
|
2019
|
-
result: null;
|
|
2020
|
-
status: 'pending';
|
|
2021
|
-
} | {
|
|
2022
|
-
/**
|
|
2023
|
-
* ID of the action attempt.
|
|
2024
|
-
*/
|
|
2025
|
-
action_attempt_id: string;
|
|
2026
|
-
/**
|
|
2027
|
-
* Action attempt to track the status of pausing playback on a speaker.
|
|
2028
|
-
*/
|
|
2029
|
-
action_type: 'PAUSE_SPEAKER_PLAYBACK';
|
|
2030
|
-
/**
|
|
2031
|
-
* Error associated with the action.
|
|
2032
|
-
*/
|
|
2033
|
-
error: {
|
|
2034
|
-
/**
|
|
2035
|
-
* Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
|
|
2036
|
-
*/
|
|
2037
|
-
message: string;
|
|
2038
|
-
/**
|
|
2039
|
-
* Type of the error.
|
|
2040
|
-
*/
|
|
2041
|
-
type: string;
|
|
2042
|
-
};
|
|
2043
|
-
/**
|
|
2044
|
-
* Result of the action.
|
|
2045
|
-
*/
|
|
2046
|
-
result: null;
|
|
2047
|
-
status: 'error';
|
|
2048
|
-
} | {
|
|
2049
|
-
/**
|
|
2050
|
-
* ID of the action attempt.
|
|
2051
|
-
*/
|
|
2052
|
-
action_attempt_id: string;
|
|
2053
|
-
/**
|
|
2054
|
-
* Action attempt to track the status of resuming playback on a speaker.
|
|
2055
|
-
*/
|
|
2056
|
-
action_type: 'RESUME_SPEAKER_PLAYBACK';
|
|
2057
|
-
/**
|
|
2058
|
-
* Error associated with the action.
|
|
2059
|
-
*/
|
|
2060
|
-
error: null;
|
|
2061
|
-
/**
|
|
2062
|
-
* Result of the action.
|
|
2063
|
-
*/
|
|
2064
|
-
result: {
|
|
2065
|
-
/**
|
|
2066
|
-
* IDs of the speakers whose playback was resumed, including speakers grouped with the requested speaker.
|
|
2067
|
-
*/
|
|
2068
|
-
affected_device_ids: Array<string>;
|
|
2069
|
-
};
|
|
2070
|
-
status: 'success';
|
|
2071
|
-
} | {
|
|
2072
|
-
/**
|
|
2073
|
-
* ID of the action attempt.
|
|
2074
|
-
*/
|
|
2075
|
-
action_attempt_id: string;
|
|
2076
|
-
/**
|
|
2077
|
-
* Action attempt to track the status of resuming playback on a speaker.
|
|
2078
|
-
*/
|
|
2079
|
-
action_type: 'RESUME_SPEAKER_PLAYBACK';
|
|
2080
|
-
/**
|
|
2081
|
-
* Error associated with the action.
|
|
2082
|
-
*/
|
|
2083
|
-
error: null;
|
|
2084
|
-
/**
|
|
2085
|
-
* Result of the action.
|
|
2086
|
-
*/
|
|
2087
|
-
result: null;
|
|
2088
|
-
status: 'pending';
|
|
2089
|
-
} | {
|
|
2090
|
-
/**
|
|
2091
|
-
* ID of the action attempt.
|
|
2092
|
-
*/
|
|
2093
|
-
action_attempt_id: string;
|
|
2094
|
-
/**
|
|
2095
|
-
* Action attempt to track the status of resuming playback on a speaker.
|
|
2096
|
-
*/
|
|
2097
|
-
action_type: 'RESUME_SPEAKER_PLAYBACK';
|
|
2098
|
-
/**
|
|
2099
|
-
* Error associated with the action.
|
|
2100
|
-
*/
|
|
2101
|
-
error: {
|
|
2102
|
-
/**
|
|
2103
|
-
* Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
|
|
2104
|
-
*/
|
|
2105
|
-
message: string;
|
|
2106
|
-
/**
|
|
2107
|
-
* Type of the error.
|
|
2108
|
-
*/
|
|
2109
|
-
type: string;
|
|
2110
|
-
};
|
|
2111
|
-
/**
|
|
2112
|
-
* Result of the action.
|
|
2113
|
-
*/
|
|
2114
|
-
result: null;
|
|
2115
|
-
status: 'error';
|
|
2116
|
-
} | {
|
|
2117
|
-
/**
|
|
2118
|
-
* ID of the action attempt.
|
|
2119
|
-
*/
|
|
2120
|
-
action_attempt_id: string;
|
|
2121
|
-
/**
|
|
2122
|
-
* Action attempt to track the status of playing a chime on a speaker.
|
|
2123
|
-
*/
|
|
2124
|
-
action_type: 'PLAY_SPEAKER_CHIME';
|
|
2125
|
-
/**
|
|
2126
|
-
* Error associated with the action.
|
|
2127
|
-
*/
|
|
2128
|
-
error: null;
|
|
2129
|
-
/**
|
|
2130
|
-
* Result of the action.
|
|
2131
|
-
*/
|
|
2132
|
-
result: {};
|
|
2133
|
-
status: 'success';
|
|
2134
|
-
} | {
|
|
2135
|
-
/**
|
|
2136
|
-
* ID of the action attempt.
|
|
2137
|
-
*/
|
|
2138
|
-
action_attempt_id: string;
|
|
2139
|
-
/**
|
|
2140
|
-
* Action attempt to track the status of playing a chime on a speaker.
|
|
2141
|
-
*/
|
|
2142
|
-
action_type: 'PLAY_SPEAKER_CHIME';
|
|
2143
|
-
/**
|
|
2144
|
-
* Error associated with the action.
|
|
2145
|
-
*/
|
|
2146
|
-
error: null;
|
|
2147
|
-
/**
|
|
2148
|
-
* Result of the action.
|
|
2149
|
-
*/
|
|
2150
|
-
result: null;
|
|
2151
|
-
status: 'pending';
|
|
2152
|
-
} | {
|
|
2153
|
-
/**
|
|
2154
|
-
* ID of the action attempt.
|
|
2155
|
-
*/
|
|
2156
|
-
action_attempt_id: string;
|
|
2157
|
-
/**
|
|
2158
|
-
* Action attempt to track the status of playing a chime on a speaker.
|
|
2159
|
-
*/
|
|
2160
|
-
action_type: 'PLAY_SPEAKER_CHIME';
|
|
2161
|
-
/**
|
|
2162
|
-
* Error associated with the action.
|
|
2163
|
-
*/
|
|
2164
|
-
error: {
|
|
2165
|
-
/**
|
|
2166
|
-
* Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
|
|
2167
|
-
*/
|
|
2168
|
-
message: string;
|
|
2169
|
-
/**
|
|
2170
|
-
* Type of the error.
|
|
2171
|
-
*/
|
|
2172
|
-
type: string;
|
|
2173
|
-
};
|
|
2174
|
-
/**
|
|
2175
|
-
* Result of the action.
|
|
2176
|
-
*/
|
|
2177
|
-
result: null;
|
|
2178
|
-
status: 'error';
|
|
2179
1854
|
} | {
|
|
2180
1855
|
/**
|
|
2181
1856
|
* ID of the action attempt.
|
|
@@ -19,18 +19,6 @@ 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.
|
|
24
|
-
*/
|
|
25
|
-
can_mute_speaker?: boolean | undefined;
|
|
26
|
-
/**
|
|
27
|
-
* Indicates whether the speaker supports pausing 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;
|
|
34
22
|
/**
|
|
35
23
|
* Indicates whether the device supports programming offline access codes.
|
|
36
24
|
*/
|
|
@@ -59,18 +47,10 @@ export type DeviceProvider = {
|
|
|
59
47
|
* Indicates whether the device supports remote unlocking.
|
|
60
48
|
*/
|
|
61
49
|
can_remotely_unlock?: boolean | undefined;
|
|
62
|
-
/**
|
|
63
|
-
* Indicates whether the speaker supports resuming playback.
|
|
64
|
-
*/
|
|
65
|
-
can_resume_speaker_playback?: boolean | undefined;
|
|
66
50
|
/**
|
|
67
51
|
* Indicates whether the thermostat supports running climate programs.
|
|
68
52
|
*/
|
|
69
53
|
can_run_thermostat_programs?: boolean | undefined;
|
|
70
|
-
/**
|
|
71
|
-
* Indicates whether the speaker supports setting its volume.
|
|
72
|
-
*/
|
|
73
|
-
can_set_speaker_volume?: boolean | undefined;
|
|
74
54
|
/**
|
|
75
55
|
* Indicates whether the device supports simulating connection in a sandbox.
|
|
76
56
|
*/
|
|
@@ -107,10 +87,6 @@ export type DeviceProvider = {
|
|
|
107
87
|
* Indicates whether the lock supports unlocking with an access code.
|
|
108
88
|
*/
|
|
109
89
|
can_unlock_with_code?: boolean | undefined;
|
|
110
|
-
/**
|
|
111
|
-
* Indicates whether the speaker supports unmuting.
|
|
112
|
-
*/
|
|
113
|
-
can_unmute_speaker?: boolean | undefined;
|
|
114
90
|
/**
|
|
115
91
|
* Name of the device provider.
|
|
116
92
|
*/
|
|
@@ -22,18 +22,6 @@ 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;
|
|
37
25
|
/**
|
|
38
26
|
* Indicates whether the device supports programming offline access codes.
|
|
39
27
|
*/
|
|
@@ -62,18 +50,10 @@ export type Device = {
|
|
|
62
50
|
* Indicates whether the device supports remote unlocking.
|
|
63
51
|
*/
|
|
64
52
|
can_remotely_unlock?: boolean | undefined;
|
|
65
|
-
/**
|
|
66
|
-
* Indicates whether the speaker supports resuming playback.
|
|
67
|
-
*/
|
|
68
|
-
can_resume_speaker_playback?: boolean | undefined;
|
|
69
53
|
/**
|
|
70
54
|
* Indicates whether the thermostat supports running climate programs.
|
|
71
55
|
*/
|
|
72
56
|
can_run_thermostat_programs?: boolean | undefined;
|
|
73
|
-
/**
|
|
74
|
-
* Indicates whether the speaker supports setting its volume.
|
|
75
|
-
*/
|
|
76
|
-
can_set_speaker_volume?: boolean | undefined;
|
|
77
57
|
/**
|
|
78
58
|
* Indicates whether the device supports simulating connection in a sandbox.
|
|
79
59
|
*/
|
|
@@ -110,10 +90,6 @@ export type Device = {
|
|
|
110
90
|
* Indicates whether the lock supports unlocking with an access code.
|
|
111
91
|
*/
|
|
112
92
|
can_unlock_with_code?: boolean | undefined;
|
|
113
|
-
/**
|
|
114
|
-
* Indicates whether the speaker supports unmuting.
|
|
115
|
-
*/
|
|
116
|
-
can_unmute_speaker?: boolean | undefined;
|
|
117
93
|
/**
|
|
118
94
|
* 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).
|
|
119
95
|
*/
|
|
@@ -1615,39 +1591,6 @@ export type Device = {
|
|
|
1615
1591
|
*/
|
|
1616
1592
|
model?: string | undefined;
|
|
1617
1593
|
} | 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;
|
|
1651
1594
|
/**
|
|
1652
1595
|
* Metadata for a tado° device.
|
|
1653
1596
|
*/
|
|
@@ -2034,68 +1977,6 @@ export type Device = {
|
|
|
2034
1977
|
*/
|
|
2035
1978
|
time_zone?: string | undefined;
|
|
2036
1979
|
}> | 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;
|
|
2099
1980
|
/**
|
|
2100
1981
|
* Supported code lengths for access codes.
|
|
2101
1982
|
*/
|
|
@@ -268,7 +268,7 @@ export type UnmanagedAccessCode = {
|
|
|
268
268
|
*/
|
|
269
269
|
message: string;
|
|
270
270
|
} /**
|
|
271
|
-
* Seam was unable to issue this access code before its start time, so the recipient may be unable to unlock the device. This usually points to a problem that needs attention, such as an offline or disconnected device.
|
|
271
|
+
* Seam was unable to issue this access code before its start time, so the recipient may be unable to unlock the device. This usually points to a problem that needs attention, such as an offline or disconnected device. This error clears automatically if the access code is eventually issued.
|
|
272
272
|
*/ | {
|
|
273
273
|
/**
|
|
274
274
|
* Date and time at which Seam created the error.
|
|
@@ -362,6 +362,25 @@ export type UnmanagedAccessGrant = {
|
|
|
362
362
|
* Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
|
|
363
363
|
*/
|
|
364
364
|
warning_code: 'device_time_constraints_violated';
|
|
365
|
+
} /**
|
|
366
|
+
* Indicates that one of this access grant's access methods no longer grants access because of a change outside Seam, for example its card was encoded again for another credential. Seam does not replace the access method; issue a new one if the user still needs it.
|
|
367
|
+
*/ | {
|
|
368
|
+
/**
|
|
369
|
+
* ID of the access method whose access was revoked.
|
|
370
|
+
*/
|
|
371
|
+
access_method_id: string;
|
|
372
|
+
/**
|
|
373
|
+
* Date and time at which Seam created the warning.
|
|
374
|
+
*/
|
|
375
|
+
created_at: string;
|
|
376
|
+
/**
|
|
377
|
+
* Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
|
|
378
|
+
*/
|
|
379
|
+
message: string;
|
|
380
|
+
/**
|
|
381
|
+
* Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
|
|
382
|
+
*/
|
|
383
|
+
warning_code: 'access_revoked';
|
|
365
384
|
}>;
|
|
366
385
|
/**
|
|
367
386
|
* ID of the Seam workspace associated with the Access Grant.
|
|
@@ -22,18 +22,6 @@ export type UnmanagedDevice = {
|
|
|
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;
|
|
37
25
|
/**
|
|
38
26
|
* Indicates whether the device supports programming offline access codes.
|
|
39
27
|
*/
|
|
@@ -62,18 +50,10 @@ export type UnmanagedDevice = {
|
|
|
62
50
|
* Indicates whether the device supports remote unlocking.
|
|
63
51
|
*/
|
|
64
52
|
can_remotely_unlock?: boolean | undefined;
|
|
65
|
-
/**
|
|
66
|
-
* Indicates whether the speaker supports resuming playback.
|
|
67
|
-
*/
|
|
68
|
-
can_resume_speaker_playback?: boolean | undefined;
|
|
69
53
|
/**
|
|
70
54
|
* Indicates whether the thermostat supports running climate programs.
|
|
71
55
|
*/
|
|
72
56
|
can_run_thermostat_programs?: boolean | undefined;
|
|
73
|
-
/**
|
|
74
|
-
* Indicates whether the speaker supports setting its volume.
|
|
75
|
-
*/
|
|
76
|
-
can_set_speaker_volume?: boolean | undefined;
|
|
77
57
|
/**
|
|
78
58
|
* Indicates whether the device supports simulating connection in a sandbox.
|
|
79
59
|
*/
|
|
@@ -110,10 +90,6 @@ export type UnmanagedDevice = {
|
|
|
110
90
|
* Indicates whether the lock supports unlocking with an access code.
|
|
111
91
|
*/
|
|
112
92
|
can_unlock_with_code?: boolean | undefined;
|
|
113
|
-
/**
|
|
114
|
-
* Indicates whether the speaker supports unmuting.
|
|
115
|
-
*/
|
|
116
|
-
can_unmute_speaker?: boolean | undefined;
|
|
117
93
|
/**
|
|
118
94
|
* 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).
|
|
119
95
|
*/
|
|
@@ -667,6 +667,9 @@ export type CustomersCreatePortalParameters = {
|
|
|
667
667
|
* Whether to exclude the option to select a locale within the portal UI.
|
|
668
668
|
*/
|
|
669
669
|
exclude_locale_picker?: boolean | undefined;
|
|
670
|
+
/**
|
|
671
|
+
* Features to include in the portal. Settings you omit use the portal's customization profile, then the Seam default. Settings you pass take precedence over the customization profile's, so changing the profile doesn't change them.
|
|
672
|
+
*/
|
|
670
673
|
features?: {
|
|
671
674
|
/**
|
|
672
675
|
* Configuration for the configure feature.
|
|
@@ -120,6 +120,10 @@ export type UserIdentitiesCreateParameters = {
|
|
|
120
120
|
* List of access system IDs to associate with the new user identity through access system users. If there's no user with the same email address or phone number in the specified access systems, a new access system user is created. If there is an existing user with the same email or phone number in the specified access systems, the user is linked to the user identity.
|
|
121
121
|
*/
|
|
122
122
|
acs_system_ids?: Array<string> | undefined;
|
|
123
|
+
/**
|
|
124
|
+
* Customer key of the customer that owns the new user identity. Set it when the user identity will be used in access grants created through that customer's client session or Customer Portal.
|
|
125
|
+
*/
|
|
126
|
+
customer_key?: string | undefined;
|
|
123
127
|
/**
|
|
124
128
|
* Unique email address for the new user identity.
|
|
125
129
|
*/
|
package/lib/version.d.ts
CHANGED
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
declare const seamapiJavascriptHttpVersion = "2.
|
|
1
|
+
declare const seamapiJavascriptHttpVersion = "2.42.0";
|
|
2
2
|
export default seamapiJavascriptHttpVersion;
|
package/lib/version.js
CHANGED