@seamapi/types 1.1109.0 → 1.1111.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.
@@ -14220,8 +14220,12 @@ export type Routes = {
14220
14220
  household_id?: (string | undefined) | undefined;
14221
14221
  /** ID of the Sonos player for the speaker. */
14222
14222
  player_id?: (string | undefined) | undefined;
14223
+ /** Name of the speaker, as set in the Sonos app. */
14224
+ player_name?: (string | undefined) | undefined;
14223
14225
  /** Model name of the speaker, as reported by Sonos. */
14224
14226
  model_display_name?: (string | undefined) | undefined;
14227
+ /** Color of the speaker, as reported by Sonos. */
14228
+ color?: (string | undefined) | undefined;
14225
14229
  /** Software version running on the speaker. */
14226
14230
  software_version?: (string | undefined) | undefined;
14227
14231
  /** Models of the speakers bonded to this speaker, such as surrounds or a subwoofer. */
@@ -22041,8 +22045,12 @@ export type Routes = {
22041
22045
  household_id?: (string | undefined) | undefined;
22042
22046
  /** ID of the Sonos player for the speaker. */
22043
22047
  player_id?: (string | undefined) | undefined;
22048
+ /** Name of the speaker, as set in the Sonos app. */
22049
+ player_name?: (string | undefined) | undefined;
22044
22050
  /** Model name of the speaker, as reported by Sonos. */
22045
22051
  model_display_name?: (string | undefined) | undefined;
22052
+ /** Color of the speaker, as reported by Sonos. */
22053
+ color?: (string | undefined) | undefined;
22046
22054
  /** Software version running on the speaker. */
22047
22055
  software_version?: (string | undefined) | undefined;
22048
22056
  /** Models of the speakers bonded to this speaker, such as surrounds or a subwoofer. */
@@ -45576,7 +45584,7 @@ export type Routes = {
45576
45584
  /** Associate the Connect Webview, the connected account, and all resources under the connected account with a customer. If the connected account already exists, it will be associated with the customer. If the connected account already exists, but is already associated with a customer, the Connect Webview will show an error. */
45577
45585
  customer_key?: string | undefined;
45578
45586
  /** Accepted device provider keys as an alternative to `provider_category`. Use this parameter to specify accepted providers explicitly. See [Customize the Brands to Display in Your Connect Webviews](https://www.seam.co/docs/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-brands-to-display-in-your-connect-webviews). To list all provider keys, use [`/devices/list_device_providers`](https://www.seam.co/docs/api/devices/list_device_providers) with no filters. */
45579
- accepted_providers?: ('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' | 'yale_access' | 'hid_cm' | 'google_nest' | 'slack')[] | undefined;
45587
+ accepted_providers?: ('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' | 'yale_access' | 'hid_cm' | 'google_nest' | 'slack')[] | undefined;
45580
45588
  /** Specifies the category of providers that you want to include. To list all providers within a category, use [`/devices/list_device_providers`](https://www.seam.co/docs/api/devices/list_device_providers) with the desired `provider_category` filter. */
45581
45589
  provider_category?: ('stable' | 'consumer_smartlocks' | 'beta' | 'thermostats' | 'noise_sensors' | 'access_control_systems' | 'cameras' | 'connectors' | 'internal_beta') | undefined;
45582
45590
  /** Custom metadata that you want to associate with the Connect Webview. Supports up to 50 JSON key:value pairs, with key names up to 40 characters long that cannot contain a period (.). [Adding custom metadata to a Connect Webview](https://www.seam.co/docs/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview) enables you to store custom information, like customer details or internal IDs from your application. The custom metadata is then transferred to any [connected accounts](https://www.seam.co/docs/core-concepts/connected-accounts) that were connected using the Connect Webview, making it easy to find and filter these resources in your [workspace](https://www.seam.co/docs/core-concepts/workspaces). You can also [filter Connect Webviews by custom metadata](https://www.seam.co/docs/core-concepts/connect-webviews/filtering-connect-webviews-by-custom-metadata). Set a key to `null` or to an empty string to remove that key from the custom metadata. */
@@ -48164,8 +48172,12 @@ export type Routes = {
48164
48172
  household_id?: (string | undefined) | undefined;
48165
48173
  /** ID of the Sonos player for the speaker. */
48166
48174
  player_id?: (string | undefined) | undefined;
48175
+ /** Name of the speaker, as set in the Sonos app. */
48176
+ player_name?: (string | undefined) | undefined;
48167
48177
  /** Model name of the speaker, as reported by Sonos. */
48168
48178
  model_display_name?: (string | undefined) | undefined;
48179
+ /** Color of the speaker, as reported by Sonos. */
48180
+ color?: (string | undefined) | undefined;
48169
48181
  /** Software version running on the speaker. */
48170
48182
  software_version?: (string | undefined) | undefined;
48171
48183
  /** Models of the speakers bonded to this speaker, such as surrounds or a subwoofer. */
@@ -49032,7 +49044,7 @@ export type Routes = {
49032
49044
  /** Array of device types for which you want to list devices. */
49033
49045
  device_types?: (('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')[] | undefined;
49034
49046
  /** Manufacturer for which you want to list devices. */
49035
- manufacturer?: ('akuvox' | 'august' | 'avigilon_alta' | 'brivo' | 'butterflymx' | 'doorking' | 'four_suites' | 'genie' | 'igloo' | 'keywe' | 'kwikset' | 'linear' | 'nuki' | 'philia' | 'salto' | 'samsung' | 'schlage' | 'seam' | 'unknown' | 'wyze' | 'yale' | 'two_n' | 'ttlock' | 'igloohome' | 'controlbyweb' | 'tedee' | 'keyincode' | 'akiles' | 'aqara' | 'ecobee' | 'eufy' | 'dormakaba_oracode' | 'dormakaba_oracode_iho' | 'honeywell_resideo' | 'keynest' | 'korelock' | 'lockly' | 'minut' | 'nest' | 'noiseaware' | 'sensi' | 'smartthings' | 'tado' | 'ultraloq' | 'ring' | 'tapo' | 'arlo' | 'reolink' | 'ical' | 'lodgify' | 'hostaway' | 'guesty' | 'acuity_scheduling' | 'omnitec' | 'kisi' | 'slack' | 'yacan') | undefined;
49047
+ manufacturer?: ('akuvox' | 'august' | 'avigilon_alta' | 'brivo' | 'butterflymx' | 'doorking' | 'four_suites' | 'genie' | 'igloo' | 'keywe' | 'kwikset' | 'linear' | 'nuki' | 'philia' | 'salto' | 'samsung' | 'schlage' | 'seam' | 'unknown' | 'wyze' | 'yale' | 'two_n' | 'ttlock' | 'igloohome' | 'controlbyweb' | 'tedee' | 'keyincode' | 'akiles' | 'aqara' | 'ecobee' | 'eufy' | 'dormakaba_oracode' | 'dormakaba_oracode_iho' | 'honeywell_resideo' | 'keynest' | 'korelock' | 'lockly' | 'minut' | 'nest' | 'noiseaware' | 'sensi' | 'smartthings' | 'tado' | 'ultraloq' | 'ring' | 'tapo' | 'arlo' | 'reolink' | 'ical' | 'lodgify' | 'hostaway' | 'guesty' | 'acuity_scheduling' | 'omnitec' | 'kisi' | 'slack' | 'yacan' | 'sonos') | undefined;
49036
49048
  /** Array of device IDs for which you want to list devices. */
49037
49049
  device_ids?: string[] | undefined;
49038
49050
  /** Numerical limit on the number of devices to return. */
@@ -49811,8 +49823,12 @@ export type Routes = {
49811
49823
  household_id?: (string | undefined) | undefined;
49812
49824
  /** ID of the Sonos player for the speaker. */
49813
49825
  player_id?: (string | undefined) | undefined;
49826
+ /** Name of the speaker, as set in the Sonos app. */
49827
+ player_name?: (string | undefined) | undefined;
49814
49828
  /** Model name of the speaker, as reported by Sonos. */
49815
49829
  model_display_name?: (string | undefined) | undefined;
49830
+ /** Color of the speaker, as reported by Sonos. */
49831
+ color?: (string | undefined) | undefined;
49816
49832
  /** Software version running on the speaker. */
49817
49833
  software_version?: (string | undefined) | undefined;
49818
49834
  /** Models of the speakers bonded to this speaker, such as surrounds or a subwoofer. */
@@ -50682,7 +50698,7 @@ export type Routes = {
50682
50698
  jsonResponse: {
50683
50699
  device_providers: {
50684
50700
  /** Name of the device provider. */
50685
- 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';
50701
+ 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';
50686
50702
  /** Display name for the device provider. */
50687
50703
  display_name: string;
50688
50704
  /** Image URL for the device provider. */
@@ -51391,7 +51407,7 @@ export type Routes = {
51391
51407
  /** Array of device types for which you want to list devices. */
51392
51408
  device_types?: (('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')[] | undefined;
51393
51409
  /** Manufacturer for which you want to list devices. */
51394
- manufacturer?: ('akuvox' | 'august' | 'avigilon_alta' | 'brivo' | 'butterflymx' | 'doorking' | 'four_suites' | 'genie' | 'igloo' | 'keywe' | 'kwikset' | 'linear' | 'nuki' | 'philia' | 'salto' | 'samsung' | 'schlage' | 'seam' | 'unknown' | 'wyze' | 'yale' | 'two_n' | 'ttlock' | 'igloohome' | 'controlbyweb' | 'tedee' | 'keyincode' | 'akiles' | 'aqara' | 'ecobee' | 'eufy' | 'dormakaba_oracode' | 'dormakaba_oracode_iho' | 'honeywell_resideo' | 'keynest' | 'korelock' | 'lockly' | 'minut' | 'nest' | 'noiseaware' | 'sensi' | 'smartthings' | 'tado' | 'ultraloq' | 'ring' | 'tapo' | 'arlo' | 'reolink' | 'ical' | 'lodgify' | 'hostaway' | 'guesty' | 'acuity_scheduling' | 'omnitec' | 'kisi' | 'slack' | 'yacan') | undefined;
51410
+ manufacturer?: ('akuvox' | 'august' | 'avigilon_alta' | 'brivo' | 'butterflymx' | 'doorking' | 'four_suites' | 'genie' | 'igloo' | 'keywe' | 'kwikset' | 'linear' | 'nuki' | 'philia' | 'salto' | 'samsung' | 'schlage' | 'seam' | 'unknown' | 'wyze' | 'yale' | 'two_n' | 'ttlock' | 'igloohome' | 'controlbyweb' | 'tedee' | 'keyincode' | 'akiles' | 'aqara' | 'ecobee' | 'eufy' | 'dormakaba_oracode' | 'dormakaba_oracode_iho' | 'honeywell_resideo' | 'keynest' | 'korelock' | 'lockly' | 'minut' | 'nest' | 'noiseaware' | 'sensi' | 'smartthings' | 'tado' | 'ultraloq' | 'ring' | 'tapo' | 'arlo' | 'reolink' | 'ical' | 'lodgify' | 'hostaway' | 'guesty' | 'acuity_scheduling' | 'omnitec' | 'kisi' | 'slack' | 'yacan' | 'sonos') | undefined;
51395
51411
  /** Array of device IDs for which you want to list devices. */
51396
51412
  device_ids?: string[] | undefined;
51397
51413
  /** Timestamp by which to limit returned devices. Returns devices created before this timestamp. */
@@ -62133,8 +62149,12 @@ export type Routes = {
62133
62149
  household_id?: (string | undefined) | undefined;
62134
62150
  /** ID of the Sonos player for the speaker. */
62135
62151
  player_id?: (string | undefined) | undefined;
62152
+ /** Name of the speaker, as set in the Sonos app. */
62153
+ player_name?: (string | undefined) | undefined;
62136
62154
  /** Model name of the speaker, as reported by Sonos. */
62137
62155
  model_display_name?: (string | undefined) | undefined;
62156
+ /** Color of the speaker, as reported by Sonos. */
62157
+ color?: (string | undefined) | undefined;
62138
62158
  /** Software version running on the speaker. */
62139
62159
  software_version?: (string | undefined) | undefined;
62140
62160
  /** Models of the speakers bonded to this speaker, such as surrounds or a subwoofer. */
@@ -63730,8 +63750,12 @@ export type Routes = {
63730
63750
  household_id?: (string | undefined) | undefined;
63731
63751
  /** ID of the Sonos player for the speaker. */
63732
63752
  player_id?: (string | undefined) | undefined;
63753
+ /** Name of the speaker, as set in the Sonos app. */
63754
+ player_name?: (string | undefined) | undefined;
63733
63755
  /** Model name of the speaker, as reported by Sonos. */
63734
63756
  model_display_name?: (string | undefined) | undefined;
63757
+ /** Color of the speaker, as reported by Sonos. */
63758
+ color?: (string | undefined) | undefined;
63735
63759
  /** Software version running on the speaker. */
63736
63760
  software_version?: (string | undefined) | undefined;
63737
63761
  /** Models of the speakers bonded to this speaker, such as surrounds or a subwoofer. */
@@ -65350,8 +65374,12 @@ export type Routes = {
65350
65374
  household_id?: (string | undefined) | undefined;
65351
65375
  /** ID of the Sonos player for the speaker. */
65352
65376
  player_id?: (string | undefined) | undefined;
65377
+ /** Name of the speaker, as set in the Sonos app. */
65378
+ player_name?: (string | undefined) | undefined;
65353
65379
  /** Model name of the speaker, as reported by Sonos. */
65354
65380
  model_display_name?: (string | undefined) | undefined;
65381
+ /** Color of the speaker, as reported by Sonos. */
65382
+ color?: (string | undefined) | undefined;
65355
65383
  /** Software version running on the speaker. */
65356
65384
  software_version?: (string | undefined) | undefined;
65357
65385
  /** Models of the speakers bonded to this speaker, such as surrounds or a subwoofer. */
@@ -66946,8 +66974,12 @@ export type Routes = {
66946
66974
  household_id?: (string | undefined) | undefined;
66947
66975
  /** ID of the Sonos player for the speaker. */
66948
66976
  player_id?: (string | undefined) | undefined;
66977
+ /** Name of the speaker, as set in the Sonos app. */
66978
+ player_name?: (string | undefined) | undefined;
66949
66979
  /** Model name of the speaker, as reported by Sonos. */
66950
66980
  model_display_name?: (string | undefined) | undefined;
66981
+ /** Color of the speaker, as reported by Sonos. */
66982
+ color?: (string | undefined) | undefined;
66951
66983
  /** Software version running on the speaker. */
66952
66984
  software_version?: (string | undefined) | undefined;
66953
66985
  /** Models of the speakers bonded to this speaker, such as surrounds or a subwoofer. */
@@ -76913,8 +76945,12 @@ export type Routes = {
76913
76945
  household_id?: (string | undefined) | undefined;
76914
76946
  /** ID of the Sonos player for the speaker. */
76915
76947
  player_id?: (string | undefined) | undefined;
76948
+ /** Name of the speaker, as set in the Sonos app. */
76949
+ player_name?: (string | undefined) | undefined;
76916
76950
  /** Model name of the speaker, as reported by Sonos. */
76917
76951
  model_display_name?: (string | undefined) | undefined;
76952
+ /** Color of the speaker, as reported by Sonos. */
76953
+ color?: (string | undefined) | undefined;
76918
76954
  /** Software version running on the speaker. */
76919
76955
  software_version?: (string | undefined) | undefined;
76920
76956
  /** Models of the speakers bonded to this speaker, such as surrounds or a subwoofer. */
@@ -78509,8 +78545,12 @@ export type Routes = {
78509
78545
  household_id?: (string | undefined) | undefined;
78510
78546
  /** ID of the Sonos player for the speaker. */
78511
78547
  player_id?: (string | undefined) | undefined;
78548
+ /** Name of the speaker, as set in the Sonos app. */
78549
+ player_name?: (string | undefined) | undefined;
78512
78550
  /** Model name of the speaker, as reported by Sonos. */
78513
78551
  model_display_name?: (string | undefined) | undefined;
78552
+ /** Color of the speaker, as reported by Sonos. */
78553
+ color?: (string | undefined) | undefined;
78514
78554
  /** Software version running on the speaker. */
78515
78555
  software_version?: (string | undefined) | undefined;
78516
78556
  /** Models of the speakers bonded to this speaker, such as surrounds or a subwoofer. */
@@ -102078,8 +102118,12 @@ export type Routes = {
102078
102118
  household_id?: (string | undefined) | undefined;
102079
102119
  /** ID of the Sonos player for the speaker. */
102080
102120
  player_id?: (string | undefined) | undefined;
102121
+ /** Name of the speaker, as set in the Sonos app. */
102122
+ player_name?: (string | undefined) | undefined;
102081
102123
  /** Model name of the speaker, as reported by Sonos. */
102082
102124
  model_display_name?: (string | undefined) | undefined;
102125
+ /** Color of the speaker, as reported by Sonos. */
102126
+ color?: (string | undefined) | undefined;
102083
102127
  /** Software version running on the speaker. */
102084
102128
  software_version?: (string | undefined) | undefined;
102085
102129
  /** Models of the speakers bonded to this speaker, such as surrounds or a subwoofer. */
@@ -125501,8 +125545,12 @@ export type Routes = {
125501
125545
  household_id?: (string | undefined) | undefined;
125502
125546
  /** ID of the Sonos player for the speaker. */
125503
125547
  player_id?: (string | undefined) | undefined;
125548
+ /** Name of the speaker, as set in the Sonos app. */
125549
+ player_name?: (string | undefined) | undefined;
125504
125550
  /** Model name of the speaker, as reported by Sonos. */
125505
125551
  model_display_name?: (string | undefined) | undefined;
125552
+ /** Color of the speaker, as reported by Sonos. */
125553
+ color?: (string | undefined) | undefined;
125506
125554
  /** Software version running on the speaker. */
125507
125555
  software_version?: (string | undefined) | undefined;
125508
125556
  /** Models of the speakers bonded to this speaker, such as surrounds or a subwoofer. */
@@ -131287,8 +131335,12 @@ export type Routes = {
131287
131335
  household_id?: (string | undefined) | undefined;
131288
131336
  /** ID of the Sonos player for the speaker. */
131289
131337
  player_id?: (string | undefined) | undefined;
131338
+ /** Name of the speaker, as set in the Sonos app. */
131339
+ player_name?: (string | undefined) | undefined;
131290
131340
  /** Model name of the speaker, as reported by Sonos. */
131291
131341
  model_display_name?: (string | undefined) | undefined;
131342
+ /** Color of the speaker, as reported by Sonos. */
131343
+ color?: (string | undefined) | undefined;
131292
131344
  /** Software version running on the speaker. */
131293
131345
  software_version?: (string | undefined) | undefined;
131294
131346
  /** Models of the speakers bonded to this speaker, such as surrounds or a subwoofer. */
@@ -132883,8 +132935,12 @@ export type Routes = {
132883
132935
  household_id?: (string | undefined) | undefined;
132884
132936
  /** ID of the Sonos player for the speaker. */
132885
132937
  player_id?: (string | undefined) | undefined;
132938
+ /** Name of the speaker, as set in the Sonos app. */
132939
+ player_name?: (string | undefined) | undefined;
132886
132940
  /** Model name of the speaker, as reported by Sonos. */
132887
132941
  model_display_name?: (string | undefined) | undefined;
132942
+ /** Color of the speaker, as reported by Sonos. */
132943
+ color?: (string | undefined) | undefined;
132888
132944
  /** Software version running on the speaker. */
132889
132945
  software_version?: (string | undefined) | undefined;
132890
132946
  /** Models of the speakers bonded to this speaker, such as surrounds or a subwoofer. */
@@ -143793,8 +143849,12 @@ export type Routes = {
143793
143849
  household_id?: (string | undefined) | undefined;
143794
143850
  /** ID of the Sonos player for the speaker. */
143795
143851
  player_id?: (string | undefined) | undefined;
143852
+ /** Name of the speaker, as set in the Sonos app. */
143853
+ player_name?: (string | undefined) | undefined;
143796
143854
  /** Model name of the speaker, as reported by Sonos. */
143797
143855
  model_display_name?: (string | undefined) | undefined;
143856
+ /** Color of the speaker, as reported by Sonos. */
143857
+ color?: (string | undefined) | undefined;
143798
143858
  /** Software version running on the speaker. */
143799
143859
  software_version?: (string | undefined) | undefined;
143800
143860
  /** Models of the speakers bonded to this speaker, such as surrounds or a subwoofer. */
@@ -145391,8 +145451,12 @@ export type Routes = {
145391
145451
  household_id?: (string | undefined) | undefined;
145392
145452
  /** ID of the Sonos player for the speaker. */
145393
145453
  player_id?: (string | undefined) | undefined;
145454
+ /** Name of the speaker, as set in the Sonos app. */
145455
+ player_name?: (string | undefined) | undefined;
145394
145456
  /** Model name of the speaker, as reported by Sonos. */
145395
145457
  model_display_name?: (string | undefined) | undefined;
145458
+ /** Color of the speaker, as reported by Sonos. */
145459
+ color?: (string | undefined) | undefined;
145396
145460
  /** Software version running on the speaker. */
145397
145461
  software_version?: (string | undefined) | undefined;
145398
145462
  /** Models of the speakers bonded to this speaker, such as surrounds or a subwoofer. */
@@ -148332,8 +148396,12 @@ export type Routes = {
148332
148396
  household_id?: (string | undefined) | undefined;
148333
148397
  /** ID of the Sonos player for the speaker. */
148334
148398
  player_id?: (string | undefined) | undefined;
148399
+ /** Name of the speaker, as set in the Sonos app. */
148400
+ player_name?: (string | undefined) | undefined;
148335
148401
  /** Model name of the speaker, as reported by Sonos. */
148336
148402
  model_display_name?: (string | undefined) | undefined;
148403
+ /** Color of the speaker, as reported by Sonos. */
148404
+ color?: (string | undefined) | undefined;
148337
148405
  /** Software version running on the speaker. */
148338
148406
  software_version?: (string | undefined) | undefined;
148339
148407
  /** Models of the speakers bonded to this speaker, such as surrounds or a subwoofer. */
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@seamapi/types",
3
- "version": "1.1109.0",
3
+ "version": "1.1111.0",
4
4
  "description": "TypeScript types for the Seam API.",
5
5
  "type": "module",
6
6
  "main": "index.js",
@@ -1334,10 +1334,18 @@ export const device_metadata = z
1334
1334
  .string()
1335
1335
  .optional()
1336
1336
  .describe('ID of the Sonos player for the speaker.'),
1337
+ player_name: z
1338
+ .string()
1339
+ .optional()
1340
+ .describe('Name of the speaker, as set in the Sonos app.'),
1337
1341
  model_display_name: z
1338
1342
  .string()
1339
1343
  .optional()
1340
1344
  .describe('Model name of the speaker, as reported by Sonos.'),
1345
+ color: z
1346
+ .string()
1347
+ .optional()
1348
+ .describe('Color of the speaker, as reported by Sonos.'),
1341
1349
  software_version: z
1342
1350
  .string()
1343
1351
  .optional()
@@ -72,6 +72,7 @@ export const DEVICE_PROVIDERS = {
72
72
  OMNITEC: 'omnitec',
73
73
  KISI: 'kisi',
74
74
  AQARA: 'aqara',
75
+ SONOS: 'sonos',
75
76
  } as const
76
77
 
77
78
  export type DeviceProviderName =
@@ -16881,6 +16881,11 @@ const openapi: OpenAPISpec = {
16881
16881
  items: { type: 'string' },
16882
16882
  type: 'array',
16883
16883
  },
16884
+ color: {
16885
+ description:
16886
+ 'Color of the speaker, as reported by Sonos.',
16887
+ type: 'string',
16888
+ },
16884
16889
  household_id: {
16885
16890
  description:
16886
16891
  'ID of the Sonos household that the speaker belongs to.',
@@ -16896,6 +16901,11 @@ const openapi: OpenAPISpec = {
16896
16901
  'ID of the Sonos player for the speaker.',
16897
16902
  type: 'string',
16898
16903
  },
16904
+ player_name: {
16905
+ description:
16906
+ 'Name of the speaker, as set in the Sonos app.',
16907
+ type: 'string',
16908
+ },
16899
16909
  software_version: {
16900
16910
  description:
16901
16911
  'Software version running on the speaker.',
@@ -19493,6 +19503,7 @@ const openapi: OpenAPISpec = {
19493
19503
  'omnitec',
19494
19504
  'kisi',
19495
19505
  'aqara',
19506
+ 'sonos',
19496
19507
  ],
19497
19508
  type: 'string',
19498
19509
  },
@@ -49974,6 +49985,7 @@ const openapi: OpenAPISpec = {
49974
49985
  'omnitec',
49975
49986
  'kisi',
49976
49987
  'aqara',
49988
+ 'sonos',
49977
49989
  'yale_access',
49978
49990
  'hid_cm',
49979
49991
  'google_nest',
@@ -53854,6 +53866,7 @@ const openapi: OpenAPISpec = {
53854
53866
  'kisi',
53855
53867
  'slack',
53856
53868
  'yacan',
53869
+ 'sonos',
53857
53870
  ],
53858
53871
  type: 'string',
53859
53872
  },
@@ -56190,6 +56203,7 @@ const openapi: OpenAPISpec = {
56190
56203
  'kisi',
56191
56204
  'slack',
56192
56205
  'yacan',
56206
+ 'sonos',
56193
56207
  ],
56194
56208
  type: 'string',
56195
56209
  },
@@ -16369,8 +16369,12 @@ export type Routes = {
16369
16369
  household_id?: (string | undefined) | undefined
16370
16370
  /** ID of the Sonos player for the speaker. */
16371
16371
  player_id?: (string | undefined) | undefined
16372
+ /** Name of the speaker, as set in the Sonos app. */
16373
+ player_name?: (string | undefined) | undefined
16372
16374
  /** Model name of the speaker, as reported by Sonos. */
16373
16375
  model_display_name?: (string | undefined) | undefined
16376
+ /** Color of the speaker, as reported by Sonos. */
16377
+ color?: (string | undefined) | undefined
16374
16378
  /** Software version running on the speaker. */
16375
16379
  software_version?: (string | undefined) | undefined
16376
16380
  /** Models of the speakers bonded to this speaker, such as surrounds or a subwoofer. */
@@ -25665,8 +25669,12 @@ export type Routes = {
25665
25669
  household_id?: (string | undefined) | undefined
25666
25670
  /** ID of the Sonos player for the speaker. */
25667
25671
  player_id?: (string | undefined) | undefined
25672
+ /** Name of the speaker, as set in the Sonos app. */
25673
+ player_name?: (string | undefined) | undefined
25668
25674
  /** Model name of the speaker, as reported by Sonos. */
25669
25675
  model_display_name?: (string | undefined) | undefined
25676
+ /** Color of the speaker, as reported by Sonos. */
25677
+ color?: (string | undefined) | undefined
25670
25678
  /** Software version running on the speaker. */
25671
25679
  software_version?: (string | undefined) | undefined
25672
25680
  /** Models of the speakers bonded to this speaker, such as surrounds or a subwoofer. */
@@ -53226,6 +53234,7 @@ export type Routes = {
53226
53234
  | 'omnitec'
53227
53235
  | 'kisi'
53228
53236
  | 'aqara'
53237
+ | 'sonos'
53229
53238
  | 'yale_access'
53230
53239
  | 'hid_cm'
53231
53240
  | 'google_nest'
@@ -56343,8 +56352,12 @@ export type Routes = {
56343
56352
  household_id?: (string | undefined) | undefined
56344
56353
  /** ID of the Sonos player for the speaker. */
56345
56354
  player_id?: (string | undefined) | undefined
56355
+ /** Name of the speaker, as set in the Sonos app. */
56356
+ player_name?: (string | undefined) | undefined
56346
56357
  /** Model name of the speaker, as reported by Sonos. */
56347
56358
  model_display_name?: (string | undefined) | undefined
56359
+ /** Color of the speaker, as reported by Sonos. */
56360
+ color?: (string | undefined) | undefined
56348
56361
  /** Software version running on the speaker. */
56349
56362
  software_version?: (string | undefined) | undefined
56350
56363
  /** Models of the speakers bonded to this speaker, such as surrounds or a subwoofer. */
@@ -57563,6 +57576,7 @@ export type Routes = {
57563
57576
  | 'kisi'
57564
57577
  | 'slack'
57565
57578
  | 'yacan'
57579
+ | 'sonos'
57566
57580
  )
57567
57581
  | undefined
57568
57582
  /** Array of device IDs for which you want to list devices. */
@@ -58613,8 +58627,12 @@ export type Routes = {
58613
58627
  household_id?: (string | undefined) | undefined
58614
58628
  /** ID of the Sonos player for the speaker. */
58615
58629
  player_id?: (string | undefined) | undefined
58630
+ /** Name of the speaker, as set in the Sonos app. */
58631
+ player_name?: (string | undefined) | undefined
58616
58632
  /** Model name of the speaker, as reported by Sonos. */
58617
58633
  model_display_name?: (string | undefined) | undefined
58634
+ /** Color of the speaker, as reported by Sonos. */
58635
+ color?: (string | undefined) | undefined
58618
58636
  /** Software version running on the speaker. */
58619
58637
  software_version?: (string | undefined) | undefined
58620
58638
  /** Models of the speakers bonded to this speaker, such as surrounds or a subwoofer. */
@@ -59759,6 +59777,7 @@ export type Routes = {
59759
59777
  | 'omnitec'
59760
59778
  | 'kisi'
59761
59779
  | 'aqara'
59780
+ | 'sonos'
59762
59781
  /** Display name for the device provider. */
59763
59782
  display_name: string
59764
59783
  /** Image URL for the device provider. */
@@ -62033,6 +62052,7 @@ export type Routes = {
62033
62052
  | 'kisi'
62034
62053
  | 'slack'
62035
62054
  | 'yacan'
62055
+ | 'sonos'
62036
62056
  )
62037
62057
  | undefined
62038
62058
  /** Array of device IDs for which you want to list devices. */
@@ -74584,8 +74604,12 @@ export type Routes = {
74584
74604
  household_id?: (string | undefined) | undefined
74585
74605
  /** ID of the Sonos player for the speaker. */
74586
74606
  player_id?: (string | undefined) | undefined
74607
+ /** Name of the speaker, as set in the Sonos app. */
74608
+ player_name?: (string | undefined) | undefined
74587
74609
  /** Model name of the speaker, as reported by Sonos. */
74588
74610
  model_display_name?: (string | undefined) | undefined
74611
+ /** Color of the speaker, as reported by Sonos. */
74612
+ color?: (string | undefined) | undefined
74589
74613
  /** Software version running on the speaker. */
74590
74614
  software_version?: (string | undefined) | undefined
74591
74615
  /** Models of the speakers bonded to this speaker, such as surrounds or a subwoofer. */
@@ -76586,8 +76610,12 @@ export type Routes = {
76586
76610
  household_id?: (string | undefined) | undefined
76587
76611
  /** ID of the Sonos player for the speaker. */
76588
76612
  player_id?: (string | undefined) | undefined
76613
+ /** Name of the speaker, as set in the Sonos app. */
76614
+ player_name?: (string | undefined) | undefined
76589
76615
  /** Model name of the speaker, as reported by Sonos. */
76590
76616
  model_display_name?: (string | undefined) | undefined
76617
+ /** Color of the speaker, as reported by Sonos. */
76618
+ color?: (string | undefined) | undefined
76591
76619
  /** Software version running on the speaker. */
76592
76620
  software_version?: (string | undefined) | undefined
76593
76621
  /** Models of the speakers bonded to this speaker, such as surrounds or a subwoofer. */
@@ -78717,8 +78745,12 @@ export type Routes = {
78717
78745
  household_id?: (string | undefined) | undefined
78718
78746
  /** ID of the Sonos player for the speaker. */
78719
78747
  player_id?: (string | undefined) | undefined
78748
+ /** Name of the speaker, as set in the Sonos app. */
78749
+ player_name?: (string | undefined) | undefined
78720
78750
  /** Model name of the speaker, as reported by Sonos. */
78721
78751
  model_display_name?: (string | undefined) | undefined
78752
+ /** Color of the speaker, as reported by Sonos. */
78753
+ color?: (string | undefined) | undefined
78722
78754
  /** Software version running on the speaker. */
78723
78755
  software_version?: (string | undefined) | undefined
78724
78756
  /** Models of the speakers bonded to this speaker, such as surrounds or a subwoofer. */
@@ -80718,8 +80750,12 @@ export type Routes = {
80718
80750
  household_id?: (string | undefined) | undefined
80719
80751
  /** ID of the Sonos player for the speaker. */
80720
80752
  player_id?: (string | undefined) | undefined
80753
+ /** Name of the speaker, as set in the Sonos app. */
80754
+ player_name?: (string | undefined) | undefined
80721
80755
  /** Model name of the speaker, as reported by Sonos. */
80722
80756
  model_display_name?: (string | undefined) | undefined
80757
+ /** Color of the speaker, as reported by Sonos. */
80758
+ color?: (string | undefined) | undefined
80723
80759
  /** Software version running on the speaker. */
80724
80760
  software_version?: (string | undefined) | undefined
80725
80761
  /** Models of the speakers bonded to this speaker, such as surrounds or a subwoofer. */
@@ -92414,8 +92450,12 @@ export type Routes = {
92414
92450
  household_id?: (string | undefined) | undefined
92415
92451
  /** ID of the Sonos player for the speaker. */
92416
92452
  player_id?: (string | undefined) | undefined
92453
+ /** Name of the speaker, as set in the Sonos app. */
92454
+ player_name?: (string | undefined) | undefined
92417
92455
  /** Model name of the speaker, as reported by Sonos. */
92418
92456
  model_display_name?: (string | undefined) | undefined
92457
+ /** Color of the speaker, as reported by Sonos. */
92458
+ color?: (string | undefined) | undefined
92419
92459
  /** Software version running on the speaker. */
92420
92460
  software_version?: (string | undefined) | undefined
92421
92461
  /** Models of the speakers bonded to this speaker, such as surrounds or a subwoofer. */
@@ -94415,8 +94455,12 @@ export type Routes = {
94415
94455
  household_id?: (string | undefined) | undefined
94416
94456
  /** ID of the Sonos player for the speaker. */
94417
94457
  player_id?: (string | undefined) | undefined
94458
+ /** Name of the speaker, as set in the Sonos app. */
94459
+ player_name?: (string | undefined) | undefined
94418
94460
  /** Model name of the speaker, as reported by Sonos. */
94419
94461
  model_display_name?: (string | undefined) | undefined
94462
+ /** Color of the speaker, as reported by Sonos. */
94463
+ color?: (string | undefined) | undefined
94420
94464
  /** Software version running on the speaker. */
94421
94465
  software_version?: (string | undefined) | undefined
94422
94466
  /** Models of the speakers bonded to this speaker, such as surrounds or a subwoofer. */
@@ -121921,8 +121965,12 @@ export type Routes = {
121921
121965
  household_id?: (string | undefined) | undefined
121922
121966
  /** ID of the Sonos player for the speaker. */
121923
121967
  player_id?: (string | undefined) | undefined
121968
+ /** Name of the speaker, as set in the Sonos app. */
121969
+ player_name?: (string | undefined) | undefined
121924
121970
  /** Model name of the speaker, as reported by Sonos. */
121925
121971
  model_display_name?: (string | undefined) | undefined
121972
+ /** Color of the speaker, as reported by Sonos. */
121973
+ color?: (string | undefined) | undefined
121926
121974
  /** Software version running on the speaker. */
121927
121975
  software_version?: (string | undefined) | undefined
121928
121976
  /** Models of the speakers bonded to this speaker, such as surrounds or a subwoofer. */
@@ -149287,8 +149335,12 @@ export type Routes = {
149287
149335
  household_id?: (string | undefined) | undefined
149288
149336
  /** ID of the Sonos player for the speaker. */
149289
149337
  player_id?: (string | undefined) | undefined
149338
+ /** Name of the speaker, as set in the Sonos app. */
149339
+ player_name?: (string | undefined) | undefined
149290
149340
  /** Model name of the speaker, as reported by Sonos. */
149291
149341
  model_display_name?: (string | undefined) | undefined
149342
+ /** Color of the speaker, as reported by Sonos. */
149343
+ color?: (string | undefined) | undefined
149292
149344
  /** Software version running on the speaker. */
149293
149345
  software_version?: (string | undefined) | undefined
149294
149346
  /** Models of the speakers bonded to this speaker, such as surrounds or a subwoofer. */
@@ -156167,8 +156219,12 @@ export type Routes = {
156167
156219
  household_id?: (string | undefined) | undefined
156168
156220
  /** ID of the Sonos player for the speaker. */
156169
156221
  player_id?: (string | undefined) | undefined
156222
+ /** Name of the speaker, as set in the Sonos app. */
156223
+ player_name?: (string | undefined) | undefined
156170
156224
  /** Model name of the speaker, as reported by Sonos. */
156171
156225
  model_display_name?: (string | undefined) | undefined
156226
+ /** Color of the speaker, as reported by Sonos. */
156227
+ color?: (string | undefined) | undefined
156172
156228
  /** Software version running on the speaker. */
156173
156229
  software_version?: (string | undefined) | undefined
156174
156230
  /** Models of the speakers bonded to this speaker, such as surrounds or a subwoofer. */
@@ -158168,8 +158224,12 @@ export type Routes = {
158168
158224
  household_id?: (string | undefined) | undefined
158169
158225
  /** ID of the Sonos player for the speaker. */
158170
158226
  player_id?: (string | undefined) | undefined
158227
+ /** Name of the speaker, as set in the Sonos app. */
158228
+ player_name?: (string | undefined) | undefined
158171
158229
  /** Model name of the speaker, as reported by Sonos. */
158172
158230
  model_display_name?: (string | undefined) | undefined
158231
+ /** Color of the speaker, as reported by Sonos. */
158232
+ color?: (string | undefined) | undefined
158173
158233
  /** Software version running on the speaker. */
158174
158234
  software_version?: (string | undefined) | undefined
158175
158235
  /** Models of the speakers bonded to this speaker, such as surrounds or a subwoofer. */
@@ -170847,8 +170907,12 @@ export type Routes = {
170847
170907
  household_id?: (string | undefined) | undefined
170848
170908
  /** ID of the Sonos player for the speaker. */
170849
170909
  player_id?: (string | undefined) | undefined
170910
+ /** Name of the speaker, as set in the Sonos app. */
170911
+ player_name?: (string | undefined) | undefined
170850
170912
  /** Model name of the speaker, as reported by Sonos. */
170851
170913
  model_display_name?: (string | undefined) | undefined
170914
+ /** Color of the speaker, as reported by Sonos. */
170915
+ color?: (string | undefined) | undefined
170852
170916
  /** Software version running on the speaker. */
170853
170917
  software_version?: (string | undefined) | undefined
170854
170918
  /** Models of the speakers bonded to this speaker, such as surrounds or a subwoofer. */
@@ -172850,8 +172914,12 @@ export type Routes = {
172850
172914
  household_id?: (string | undefined) | undefined
172851
172915
  /** ID of the Sonos player for the speaker. */
172852
172916
  player_id?: (string | undefined) | undefined
172917
+ /** Name of the speaker, as set in the Sonos app. */
172918
+ player_name?: (string | undefined) | undefined
172853
172919
  /** Model name of the speaker, as reported by Sonos. */
172854
172920
  model_display_name?: (string | undefined) | undefined
172921
+ /** Color of the speaker, as reported by Sonos. */
172922
+ color?: (string | undefined) | undefined
172855
172923
  /** Software version running on the speaker. */
172856
172924
  software_version?: (string | undefined) | undefined
172857
172925
  /** Models of the speakers bonded to this speaker, such as surrounds or a subwoofer. */
@@ -176428,8 +176496,12 @@ export type Routes = {
176428
176496
  household_id?: (string | undefined) | undefined
176429
176497
  /** ID of the Sonos player for the speaker. */
176430
176498
  player_id?: (string | undefined) | undefined
176499
+ /** Name of the speaker, as set in the Sonos app. */
176500
+ player_name?: (string | undefined) | undefined
176431
176501
  /** Model name of the speaker, as reported by Sonos. */
176432
176502
  model_display_name?: (string | undefined) | undefined
176503
+ /** Color of the speaker, as reported by Sonos. */
176504
+ color?: (string | undefined) | undefined
176433
176505
  /** Software version running on the speaker. */
176434
176506
  software_version?: (string | undefined) | undefined
176435
176507
  /** Models of the speakers bonded to this speaker, such as surrounds or a subwoofer. */