@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.
Files changed (48) hide show
  1. package/lib/resources/access-grant.d.ts +9 -5
  2. package/lib/resources/access-method.d.ts +39 -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 +341 -8
  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 +25 -1
  9. package/lib/resources/device.d.ts +121 -2
  10. package/lib/resources/event.d.ts +1 -1
  11. package/lib/resources/phone.d.ts +702 -10
  12. package/lib/resources/unmanaged-access-grant.d.ts +9 -5
  13. package/lib/resources/unmanaged-access-method.d.ts +39 -1
  14. package/lib/resources/unmanaged-device.d.ts +25 -1
  15. package/lib/routes/connect-webviews/connect-webviews.d.ts +2 -2
  16. package/lib/routes/connected-accounts/connected-accounts.d.ts +1 -1
  17. package/lib/routes/customers/customers.d.ts +21 -0
  18. package/lib/routes/customers/customers.js +1 -0
  19. package/lib/routes/customers/customers.js.map +1 -1
  20. package/lib/routes/devices/devices.d.ts +3 -3
  21. package/lib/routes/devices/unmanaged/unmanaged.d.ts +3 -3
  22. package/lib/routes/seam-http-endpoints.d.ts +1 -0
  23. package/lib/routes/seam-http-endpoints.js +1 -0
  24. package/lib/routes/seam-http-endpoints.js.map +1 -1
  25. package/lib/version.d.ts +1 -1
  26. package/lib/version.js +1 -1
  27. package/package.json +2 -2
  28. package/src/lib/resources/access-grant.ts +9 -6
  29. package/src/lib/resources/access-method.ts +47 -1
  30. package/src/lib/resources/acs-entrance.ts +17 -12
  31. package/src/lib/resources/acs-system.ts +18 -0
  32. package/src/lib/resources/action-attempt.ts +434 -24
  33. package/src/lib/resources/connect-webview.ts +6 -1
  34. package/src/lib/resources/connected-account.ts +6 -1
  35. package/src/lib/resources/device-provider.ts +25 -0
  36. package/src/lib/resources/device.ts +136 -1
  37. package/src/lib/resources/event.ts +1 -0
  38. package/src/lib/resources/phone.ts +855 -22
  39. package/src/lib/resources/unmanaged-access-grant.ts +9 -6
  40. package/src/lib/resources/unmanaged-access-method.ts +47 -1
  41. package/src/lib/resources/unmanaged-device.ts +25 -0
  42. package/src/lib/routes/connect-webviews/connect-webviews.ts +7 -1
  43. package/src/lib/routes/connected-accounts/connected-accounts.ts +6 -1
  44. package/src/lib/routes/customers/customers.ts +21 -0
  45. package/src/lib/routes/devices/devices.ts +3 -0
  46. package/src/lib/routes/devices/unmanaged/unmanaged.ts +3 -0
  47. package/src/lib/routes/seam-http-endpoints.ts +1 -0
  48. package/src/lib/version.ts +1 -1
@@ -27,6 +27,18 @@ export type Device = {
27
27
  * Indicates whether the thermostat supports simultaneous heating and cooling.
28
28
  */
29
29
  can_hvac_heat_cool?: boolean | undefined
30
+ /**
31
+ * Indicates whether the speaker supports muting.
32
+ */
33
+ can_mute_speaker?: boolean | undefined
34
+ /**
35
+ * Indicates whether the speaker supports pausing playback.
36
+ */
37
+ can_pause_speaker_playback?: boolean | undefined
38
+ /**
39
+ * Indicates whether the speaker supports playing a chime.
40
+ */
41
+ can_play_speaker_chime?: boolean | undefined
30
42
  /**
31
43
  * Indicates whether the device supports programming offline access codes.
32
44
  */
@@ -55,10 +67,18 @@ export type Device = {
55
67
  * Indicates whether the device supports remote unlocking.
56
68
  */
57
69
  can_remotely_unlock?: boolean | undefined
70
+ /**
71
+ * Indicates whether the speaker supports resuming playback.
72
+ */
73
+ can_resume_speaker_playback?: boolean | undefined
58
74
  /**
59
75
  * Indicates whether the thermostat supports running climate programs.
60
76
  */
61
77
  can_run_thermostat_programs?: boolean | undefined
78
+ /**
79
+ * Indicates whether the speaker supports setting its volume.
80
+ */
81
+ can_set_speaker_volume?: boolean | undefined
62
82
  /**
63
83
  * Indicates whether the device supports simulating connection in a sandbox.
64
84
  */
@@ -95,6 +115,10 @@ export type Device = {
95
115
  * Indicates whether the lock supports unlocking with an access code.
96
116
  */
97
117
  can_unlock_with_code?: boolean | undefined
118
+ /**
119
+ * Indicates whether the speaker supports unmuting.
120
+ */
121
+ can_unmute_speaker?: boolean | undefined
98
122
  /**
99
123
  * 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).
100
124
  */
@@ -222,6 +246,7 @@ export type Device = {
222
246
  | 'tapo_camera'
223
247
  | 'arlo_camera'
224
248
  | 'reolink_camera'
249
+ | 'sonos_speaker'
225
250
 
226
251
  /**
227
252
  * 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.
@@ -1801,7 +1826,7 @@ export type Device = {
1801
1826
  */
1802
1827
  device_name?: string | undefined
1803
1828
  /**
1804
- * Set to true when the device does not support the /dual-setpoints API endpoint.
1829
+ * Deprecated. Seam no longer sets this field.
1805
1830
  */
1806
1831
  dual_setpoints_not_supported?: boolean | undefined
1807
1832
  /**
@@ -1833,6 +1858,41 @@ export type Device = {
1833
1858
  model?: string | undefined
1834
1859
  }
1835
1860
  | undefined
1861
+ /**
1862
+ * Metadata for a Sonos speaker.
1863
+ */
1864
+ sonos_metadata?:
1865
+ | {
1866
+ /**
1867
+ * Models of the speakers bonded to this speaker, such as surrounds or a subwoofer.
1868
+ */
1869
+ bonded_member_models?: Array<string> | undefined
1870
+ /**
1871
+ * Color of the speaker, as reported by Sonos.
1872
+ */
1873
+ color?: string | undefined
1874
+ /**
1875
+ * ID of the Sonos household that the speaker belongs to.
1876
+ */
1877
+ household_id?: string | undefined
1878
+ /**
1879
+ * Model name of the speaker, as reported by Sonos.
1880
+ */
1881
+ model_display_name?: string | undefined
1882
+ /**
1883
+ * ID of the Sonos player for the speaker.
1884
+ */
1885
+ player_id?: string | undefined
1886
+ /**
1887
+ * Name of the speaker, as set in the Sonos app.
1888
+ */
1889
+ player_name?: string | undefined
1890
+ /**
1891
+ * Software version running on the speaker.
1892
+ */
1893
+ software_version?: string | undefined
1894
+ }
1895
+ | undefined
1836
1896
  /**
1837
1897
  * Metadata for a tado° device.
1838
1898
  */
@@ -2274,6 +2334,81 @@ export type Device = {
2274
2334
  time_zone?: string | undefined
2275
2335
  }>
2276
2336
  | undefined
2337
+ /**
2338
+ * Audio state and capabilities of the speaker.
2339
+ */
2340
+ speaker?:
2341
+ | {
2342
+ /**
2343
+ * 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.
2344
+ */
2345
+ grouped_with_device_ids: Array<string>
2346
+
2347
+ /**
2348
+ * 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.
2349
+ */
2350
+ has_fixed_volume: boolean
2351
+
2352
+ /**
2353
+ * Indicates whether the speaker is muted.
2354
+ */
2355
+ is_muted: boolean
2356
+
2357
+ /**
2358
+ * 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.
2359
+ */
2360
+ max_volume: number
2361
+
2362
+ /**
2363
+ * Minimum volume that you can set on the speaker.
2364
+ */
2365
+ min_volume: number
2366
+
2367
+ /**
2368
+ * Content that is currently playing on the speaker.
2369
+ */
2370
+ now_playing?:
2371
+ | {
2372
+ /**
2373
+ * Album of the content that is currently playing.
2374
+ */
2375
+ album?: string | undefined
2376
+ /**
2377
+ * Artist of the content that is currently playing.
2378
+ */
2379
+ artist?: string | undefined
2380
+ /**
2381
+ * Title of the content that is currently playing.
2382
+ */
2383
+ title?: string | undefined
2384
+ }
2385
+ | undefined
2386
+ /**
2387
+ * Playback state of the speaker.
2388
+ */
2389
+ playback_state:
2390
+ 'playing' | 'paused' | 'idle' | 'buffering' | 'unknown'
2391
+
2392
+ /**
2393
+ * Indicates whether the speaker can play a chime.
2394
+ */
2395
+ supports_chime: boolean
2396
+
2397
+ /**
2398
+ * 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.
2399
+ */
2400
+ volume: number
2401
+
2402
+ /**
2403
+ * Date and time at which the speaker first reported its current volume.
2404
+ */
2405
+ volume_reported_at?: string | undefined
2406
+ /**
2407
+ * Increment between the volume values that you can set on the speaker.
2408
+ */
2409
+ volume_step: number
2410
+ }
2411
+ | undefined
2277
2412
  /**
2278
2413
  * Supported code lengths for access codes.
2279
2414
  */
@@ -5828,6 +5828,7 @@ export type SeamEvent =
5828
5828
  | 'too_many_attempts'
5829
5829
  | 'blocked_by_privacy_mode'
5830
5830
  | 'credential_error'
5831
+ | 'connection_error'
5831
5832
  }
5832
5833
  | undefined
5833
5834
  /**