@seamapi/http 2.39.0 → 2.41.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.
@@ -27,18 +27,6 @@ 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 and unmuting.
32
- */
33
- can_mute_speaker?: boolean | undefined
34
- /**
35
- * Indicates whether the speaker supports pausing and resuming 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
42
30
  /**
43
31
  * Indicates whether the device supports programming offline access codes.
44
32
  */
@@ -71,10 +59,6 @@ export type Device = {
71
59
  * Indicates whether the thermostat supports running climate programs.
72
60
  */
73
61
  can_run_thermostat_programs?: boolean | undefined
74
- /**
75
- * Indicates whether the speaker supports setting its volume.
76
- */
77
- can_set_speaker_volume?: boolean | undefined
78
62
  /**
79
63
  * Indicates whether the device supports simulating connection in a sandbox.
80
64
  */
@@ -1818,7 +1802,7 @@ export type Device = {
1818
1802
  */
1819
1803
  device_name?: string | undefined
1820
1804
  /**
1821
- * Set to true when the device does not support the /dual-setpoints API endpoint.
1805
+ * Deprecated. Seam no longer sets this field.
1822
1806
  */
1823
1807
  dual_setpoints_not_supported?: boolean | undefined
1824
1808
  /**
@@ -1850,41 +1834,6 @@ export type Device = {
1850
1834
  model?: string | undefined
1851
1835
  }
1852
1836
  | undefined
1853
- /**
1854
- * Metadata for a Sonos speaker.
1855
- */
1856
- sonos_metadata?:
1857
- | {
1858
- /**
1859
- * Models of the speakers bonded to this speaker, such as surrounds or a subwoofer.
1860
- */
1861
- bonded_member_models?: Array<string> | undefined
1862
- /**
1863
- * Color of the speaker, as reported by Sonos.
1864
- */
1865
- color?: string | undefined
1866
- /**
1867
- * ID of the Sonos household that the speaker belongs to.
1868
- */
1869
- household_id?: string | undefined
1870
- /**
1871
- * Model name of the speaker, as reported by Sonos.
1872
- */
1873
- model_display_name?: string | undefined
1874
- /**
1875
- * ID of the Sonos player for the speaker.
1876
- */
1877
- player_id?: string | undefined
1878
- /**
1879
- * Name of the speaker, as set in the Sonos app.
1880
- */
1881
- player_name?: string | undefined
1882
- /**
1883
- * Software version running on the speaker.
1884
- */
1885
- software_version?: string | undefined
1886
- }
1887
- | undefined
1888
1837
  /**
1889
1838
  * Metadata for a tado° device.
1890
1839
  */
@@ -2326,81 +2275,6 @@ export type Device = {
2326
2275
  time_zone?: string | undefined
2327
2276
  }>
2328
2277
  | undefined
2329
- /**
2330
- * Audio state and capabilities of the speaker.
2331
- */
2332
- speaker?:
2333
- | {
2334
- /**
2335
- * 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.
2336
- */
2337
- grouped_with_device_ids: Array<string>
2338
-
2339
- /**
2340
- * 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.
2341
- */
2342
- has_fixed_volume: boolean
2343
-
2344
- /**
2345
- * Indicates whether the speaker is muted.
2346
- */
2347
- is_muted: boolean
2348
-
2349
- /**
2350
- * 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.
2351
- */
2352
- max_volume: number
2353
-
2354
- /**
2355
- * Minimum volume that you can set on the speaker.
2356
- */
2357
- min_volume: number
2358
-
2359
- /**
2360
- * Content that is currently playing on the speaker.
2361
- */
2362
- now_playing?:
2363
- | {
2364
- /**
2365
- * Album of the content that is currently playing.
2366
- */
2367
- album?: string | undefined
2368
- /**
2369
- * Artist of the content that is currently playing.
2370
- */
2371
- artist?: string | undefined
2372
- /**
2373
- * Title of the content that is currently playing.
2374
- */
2375
- title?: string | undefined
2376
- }
2377
- | undefined
2378
- /**
2379
- * Playback state of the speaker.
2380
- */
2381
- playback_state:
2382
- 'playing' | 'paused' | 'idle' | 'buffering' | 'unknown'
2383
-
2384
- /**
2385
- * Indicates whether the speaker can play a chime.
2386
- */
2387
- supports_chime: boolean
2388
-
2389
- /**
2390
- * 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.
2391
- */
2392
- volume: number
2393
-
2394
- /**
2395
- * Date and time at which the speaker first reported its current volume.
2396
- */
2397
- volume_reported_at?: string | undefined
2398
- /**
2399
- * Increment between the volume values that you can set on the speaker.
2400
- */
2401
- volume_step: number
2402
- }
2403
- | undefined
2404
2278
  /**
2405
2279
  * Supported code lengths for access codes.
2406
2280
  */
@@ -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
  /**
@@ -342,19 +342,22 @@ export type UnmanagedAccessGrant = {
342
342
  */
343
343
  warning_code: 'updating_access_times'
344
344
  } /**
345
- * Indicates that the requested PIN code was already in use on a device, so a different code was assigned.
345
+ * Indicates that the requested PIN code could not be used, so a different code was assigned. For example, the code was already in use on a device, or the access system rejected it because it did not meet its PIN rules.
346
346
  */
347
347
  | {
348
+ /**
349
+ * ID of the access method whose requested code was unavailable. Present when an access system, such as Salto KS, assigned a different code.
350
+ */
351
+ access_method_id?: string | undefined
348
352
  /**
349
353
  * Date and time at which Seam created the warning.
350
354
  */
351
355
  created_at: string
352
356
 
353
357
  /**
354
- * ID of the device where the requested code was unavailable.
358
+ * ID of the device where the requested code was unavailable. Present when the code was set directly on a device.
355
359
  */
356
- device_id: string
357
-
360
+ device_id?: string | undefined
358
361
  /**
359
362
  * Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
360
363
  */
@@ -367,6 +367,34 @@ export type UnmanagedAccessMethod = {
367
367
  * Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
368
368
  */
369
369
  warning_code: 'user_identity_missing_phone_number'
370
+ } /**
371
+ * Indicates that the access system could not use the PIN code requested for this [access method](https://www.seam.co/docs/use-cases/granting-access/creating-an-access-grant), for example because it did not meet the access system's PIN rules, so the access system assigned a different code. Give the recipient the assigned code.
372
+ */
373
+ | {
374
+ /**
375
+ * Date and time at which Seam created the warning.
376
+ */
377
+ created_at: string
378
+
379
+ /**
380
+ * Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
381
+ */
382
+ message: string
383
+
384
+ /**
385
+ * The PIN code that was assigned instead.
386
+ */
387
+ new_code: string
388
+
389
+ /**
390
+ * The originally requested PIN code that could not be used.
391
+ */
392
+ original_code: string
393
+
394
+ /**
395
+ * Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
396
+ */
397
+ warning_code: 'requested_code_unavailable'
370
398
  }
371
399
  >
372
400
 
@@ -27,18 +27,6 @@ export type UnmanagedDevice = {
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 and unmuting.
32
- */
33
- can_mute_speaker?: boolean | undefined
34
- /**
35
- * Indicates whether the speaker supports pausing and resuming 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
42
30
  /**
43
31
  * Indicates whether the device supports programming offline access codes.
44
32
  */
@@ -71,10 +59,6 @@ export type UnmanagedDevice = {
71
59
  * Indicates whether the thermostat supports running climate programs.
72
60
  */
73
61
  can_run_thermostat_programs?: boolean | undefined
74
- /**
75
- * Indicates whether the speaker supports setting its volume.
76
- */
77
- can_set_speaker_volume?: boolean | undefined
78
62
  /**
79
63
  * Indicates whether the device supports simulating connection in a sandbox.
80
64
  */
@@ -912,7 +912,9 @@ export type CustomersCreatePortalParameters = {
912
912
  * Whether to exclude the option to select a locale within the portal UI.
913
913
  */
914
914
  exclude_locale_picker?: boolean | undefined
915
-
915
+ /**
916
+ * 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.
917
+ */
916
918
  features?:
917
919
  | {
918
920
  /**
@@ -936,6 +938,10 @@ export type CustomersCreatePortalParameters = {
936
938
  * Indicates whether the customer can customize their notification settings, such as the low-battery alert threshold.
937
939
  */
938
940
  allow_notification_customization?: boolean | undefined
941
+ /**
942
+ * Indicates whether the customer can customize the sound automation rules for their properties.
943
+ */
944
+ allow_sound_automation_rule_customization?: boolean | undefined
939
945
  /**
940
946
  * Whether to exclude this feature from the portal.
941
947
  */
@@ -1008,6 +1014,10 @@ export type CustomersCreatePortalParameters = {
1008
1014
  * Whether to exclude this feature from the portal.
1009
1015
  */
1010
1016
  exclude?: boolean | undefined
1017
+ /**
1018
+ * Indicates whether to prevent the customer from converting their devices between managed and unmanaged. Managed devices are billed.
1019
+ */
1020
+ exclude_device_management?: boolean | undefined
1011
1021
  /**
1012
1022
  * Indicates whether the customer can manage reservations for their properties.
1013
1023
  */
@@ -523,6 +523,10 @@ export type UserIdentitiesCreateParameters = {
523
523
  * 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.
524
524
  */
525
525
  acs_system_ids?: Array<string> | undefined
526
+ /**
527
+ * 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.
528
+ */
529
+ customer_key?: string | undefined
526
530
  /**
527
531
  * Unique email address for the new user identity.
528
532
  */
@@ -1,3 +1,3 @@
1
- const seamapiJavascriptHttpVersion = '2.39.0'
1
+ const seamapiJavascriptHttpVersion = '2.41.0'
2
2
 
3
3
  export default seamapiJavascriptHttpVersion