@seamapi/types 1.130.0 → 1.131.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 (16) hide show
  1. package/dist/connect.cjs +20 -6
  2. package/dist/connect.cjs.map +1 -1
  3. package/dist/connect.d.cts +71 -34
  4. package/lib/seam/connect/openapi.d.ts +16 -5
  5. package/lib/seam/connect/openapi.js +20 -6
  6. package/lib/seam/connect/openapi.js.map +1 -1
  7. package/lib/seam/connect/route-types.d.ts +55 -29
  8. package/lib/seam/connect/unstable/models/devices/managed-device.d.ts +6 -10
  9. package/lib/seam/connect/unstable/models/devices/managed-device.js +8 -5
  10. package/lib/seam/connect/unstable/models/devices/managed-device.js.map +1 -1
  11. package/lib/seam/connect/unstable/models/devices/phone.d.ts +6 -0
  12. package/lib/seam/connect/unstable/models/devices/unmanaged-device.d.ts +0 -1
  13. package/package.json +1 -1
  14. package/src/lib/seam/connect/openapi.ts +24 -7
  15. package/src/lib/seam/connect/route-types.ts +55 -29
  16. package/src/lib/seam/connect/unstable/models/devices/managed-device.ts +12 -7
package/dist/connect.d.cts CHANGED
@@ -786,6 +786,10 @@ declare const _default: {
786
786
  type: string;
787
787
  }[];
788
788
  };
789
+ display_name: {
790
+ description: string;
791
+ type: string;
792
+ };
789
793
  errors: {
790
794
  description: string;
791
795
  items: {
@@ -822,6 +826,10 @@ declare const _default: {
822
826
  };
823
827
  type: string;
824
828
  };
829
+ nickname: {
830
+ description: string;
831
+ type: string;
832
+ };
825
833
  properties: {
826
834
  allOf: ({
827
835
  allOf: ({
@@ -906,10 +914,6 @@ declare const _default: {
906
914
  description: string;
907
915
  type: string;
908
916
  };
909
- nickname: {
910
- description: string;
911
- type: string;
912
- };
913
917
  offline_access_codes_enabled: {
914
918
  description: string;
915
919
  type: string;
@@ -973,7 +977,6 @@ declare const _default: {
973
977
  manufacturer?: never;
974
978
  model?: never;
975
979
  name?: never;
976
- nickname?: never;
977
980
  offline_access_codes_enabled?: never;
978
981
  online?: never;
979
982
  online_access_codes_enabled?: never;
@@ -2400,6 +2403,10 @@ declare const _default: {
2400
2403
  enum: string[];
2401
2404
  type: string;
2402
2405
  };
2406
+ display_name: {
2407
+ description: string;
2408
+ type: string;
2409
+ };
2403
2410
  errors: {
2404
2411
  description: string;
2405
2412
  items: {
@@ -2436,6 +2443,10 @@ declare const _default: {
2436
2443
  };
2437
2444
  type: string;
2438
2445
  };
2446
+ nickname: {
2447
+ description: string;
2448
+ type: string;
2449
+ };
2439
2450
  properties: {
2440
2451
  properties: {
2441
2452
  assa_abloy_credential_service_metadata: {
@@ -18890,16 +18901,18 @@ interface Routes {
18890
18901
  device_id: string;
18891
18902
  /** Type of the device. */
18892
18903
  device_type: ('akuvox_lock' | 'august_lock' | 'brivo_access_point' | 'butterflymx_panel' | 'avigilon_alta_entry' | 'doorking_lock' | 'genie_door' | 'igloo_lock' | 'linear_lock' | 'lockly_lock' | 'kwikset_lock' | 'nuki_lock' | 'salto_lock' | 'schlage_lock' | 'seam_relay' | 'smartthings_lock' | 'wyze_lock' | 'yale_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'hubitat_lock' | 'four_suites_door' | 'dormakaba_oracode_door' | 'tedee_lock') | ('noiseaware_activity_zone' | 'minut_sensor') | ('ecobee_thermostat' | 'nest_thermostat' | 'honeywell_thermostat') | ('ios_phone' | 'android_phone');
18904
+ /** Optional nickname to describe the device, settable through Seam */
18905
+ nickname?: string | undefined;
18906
+ /** 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. */
18907
+ display_name: string;
18893
18908
  /** 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; and "battery," which indicates that the device can manage battery life and health. */
18894
18909
  capabilities_supported: Array<'access_code' | 'lock' | 'noise_detection' | 'thermostat' | 'battery' | 'phone'>;
18895
18910
  /** Properties of the device. */
18896
18911
  properties: (({
18897
18912
  /** Indicates whether the device is online. */
18898
18913
  online: boolean;
18899
- /** Name of the device. Enables administrators and users to identify the device easily, especially when there are numerous devices. */
18914
+ /** Name of the device. Deprecated - use device.display_name instead */
18900
18915
  name: string;
18901
- /** Optional nickname to describe the device, settable through Seam. Enables administrators and users to identify the device easily, especially when there are numerous devices. */
18902
- nickname?: string | undefined;
18903
18916
  appearance: {
18904
18917
  /** Name of the device as seen from the provider API and application, not settable through Seam. */
18905
18918
  name: string;
@@ -19386,16 +19399,18 @@ interface Routes {
19386
19399
  device_id: string;
19387
19400
  /** Type of the device. */
19388
19401
  device_type: ('akuvox_lock' | 'august_lock' | 'brivo_access_point' | 'butterflymx_panel' | 'avigilon_alta_entry' | 'doorking_lock' | 'genie_door' | 'igloo_lock' | 'linear_lock' | 'lockly_lock' | 'kwikset_lock' | 'nuki_lock' | 'salto_lock' | 'schlage_lock' | 'seam_relay' | 'smartthings_lock' | 'wyze_lock' | 'yale_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'hubitat_lock' | 'four_suites_door' | 'dormakaba_oracode_door' | 'tedee_lock') | ('noiseaware_activity_zone' | 'minut_sensor') | ('ecobee_thermostat' | 'nest_thermostat' | 'honeywell_thermostat') | ('ios_phone' | 'android_phone');
19402
+ /** Optional nickname to describe the device, settable through Seam */
19403
+ nickname?: string | undefined;
19404
+ /** 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. */
19405
+ display_name: string;
19389
19406
  /** 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; and "battery," which indicates that the device can manage battery life and health. */
19390
19407
  capabilities_supported: Array<'access_code' | 'lock' | 'noise_detection' | 'thermostat' | 'battery' | 'phone'>;
19391
19408
  /** Properties of the device. */
19392
19409
  properties: (({
19393
19410
  /** Indicates whether the device is online. */
19394
19411
  online: boolean;
19395
- /** Name of the device. Enables administrators and users to identify the device easily, especially when there are numerous devices. */
19412
+ /** Name of the device. Deprecated - use device.display_name instead */
19396
19413
  name: string;
19397
- /** Optional nickname to describe the device, settable through Seam. Enables administrators and users to identify the device easily, especially when there are numerous devices. */
19398
- nickname?: string | undefined;
19399
19414
  appearance: {
19400
19415
  /** Name of the device as seen from the provider API and application, not settable through Seam. */
19401
19416
  name: string;
@@ -19910,7 +19925,7 @@ interface Routes {
19910
19925
  created_at: string;
19911
19926
  is_managed: false;
19912
19927
  properties: {
19913
- /** Name of the device. Enables administrators and users to identify the device easily, especially when there are numerous devices. */
19928
+ /** Name of the device. Deprecated - use device.display_name instead */
19914
19929
  name: string;
19915
19930
  /** Indicates whether the device is online. */
19916
19931
  online: boolean;
@@ -19995,7 +20010,7 @@ interface Routes {
19995
20010
  created_at: string;
19996
20011
  is_managed: false;
19997
20012
  properties: {
19998
- /** Name of the device. Enables administrators and users to identify the device easily, especially when there are numerous devices. */
20013
+ /** Name of the device. Deprecated - use device.display_name instead */
19999
20014
  name: string;
20000
20015
  /** Indicates whether the device is online. */
20001
20016
  online: boolean;
@@ -20205,16 +20220,18 @@ interface Routes {
20205
20220
  device_id: string;
20206
20221
  /** Type of the device. */
20207
20222
  device_type: ('akuvox_lock' | 'august_lock' | 'brivo_access_point' | 'butterflymx_panel' | 'avigilon_alta_entry' | 'doorking_lock' | 'genie_door' | 'igloo_lock' | 'linear_lock' | 'lockly_lock' | 'kwikset_lock' | 'nuki_lock' | 'salto_lock' | 'schlage_lock' | 'seam_relay' | 'smartthings_lock' | 'wyze_lock' | 'yale_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'hubitat_lock' | 'four_suites_door' | 'dormakaba_oracode_door' | 'tedee_lock') | ('noiseaware_activity_zone' | 'minut_sensor') | ('ecobee_thermostat' | 'nest_thermostat' | 'honeywell_thermostat') | ('ios_phone' | 'android_phone');
20223
+ /** Optional nickname to describe the device, settable through Seam */
20224
+ nickname?: string | undefined;
20225
+ /** 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. */
20226
+ display_name: string;
20208
20227
  /** 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; and "battery," which indicates that the device can manage battery life and health. */
20209
20228
  capabilities_supported: Array<'access_code' | 'lock' | 'noise_detection' | 'thermostat' | 'battery' | 'phone'>;
20210
20229
  /** Properties of the device. */
20211
20230
  properties: (({
20212
20231
  /** Indicates whether the device is online. */
20213
20232
  online: boolean;
20214
- /** Name of the device. Enables administrators and users to identify the device easily, especially when there are numerous devices. */
20233
+ /** Name of the device. Deprecated - use device.display_name instead */
20215
20234
  name: string;
20216
- /** Optional nickname to describe the device, settable through Seam. Enables administrators and users to identify the device easily, especially when there are numerous devices. */
20217
- nickname?: string | undefined;
20218
20235
  appearance: {
20219
20236
  /** Name of the device as seen from the provider API and application, not settable through Seam. */
20220
20237
  name: string;
@@ -20678,16 +20695,18 @@ interface Routes {
20678
20695
  device_id: string;
20679
20696
  /** Type of the device. */
20680
20697
  device_type: ('akuvox_lock' | 'august_lock' | 'brivo_access_point' | 'butterflymx_panel' | 'avigilon_alta_entry' | 'doorking_lock' | 'genie_door' | 'igloo_lock' | 'linear_lock' | 'lockly_lock' | 'kwikset_lock' | 'nuki_lock' | 'salto_lock' | 'schlage_lock' | 'seam_relay' | 'smartthings_lock' | 'wyze_lock' | 'yale_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'hubitat_lock' | 'four_suites_door' | 'dormakaba_oracode_door' | 'tedee_lock') | ('noiseaware_activity_zone' | 'minut_sensor') | ('ecobee_thermostat' | 'nest_thermostat' | 'honeywell_thermostat') | ('ios_phone' | 'android_phone');
20698
+ /** Optional nickname to describe the device, settable through Seam */
20699
+ nickname?: string | undefined;
20700
+ /** 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. */
20701
+ display_name: string;
20681
20702
  /** 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; and "battery," which indicates that the device can manage battery life and health. */
20682
20703
  capabilities_supported: Array<'access_code' | 'lock' | 'noise_detection' | 'thermostat' | 'battery' | 'phone'>;
20683
20704
  /** Properties of the device. */
20684
20705
  properties: (({
20685
20706
  /** Indicates whether the device is online. */
20686
20707
  online: boolean;
20687
- /** Name of the device. Enables administrators and users to identify the device easily, especially when there are numerous devices. */
20708
+ /** Name of the device. Deprecated - use device.display_name instead */
20688
20709
  name: string;
20689
- /** Optional nickname to describe the device, settable through Seam. Enables administrators and users to identify the device easily, especially when there are numerous devices. */
20690
- nickname?: string | undefined;
20691
20710
  appearance: {
20692
20711
  /** Name of the device as seen from the provider API and application, not settable through Seam. */
20693
20712
  name: string;
@@ -21174,16 +21193,18 @@ interface Routes {
21174
21193
  device_id: string;
21175
21194
  /** Type of the device. */
21176
21195
  device_type: ('akuvox_lock' | 'august_lock' | 'brivo_access_point' | 'butterflymx_panel' | 'avigilon_alta_entry' | 'doorking_lock' | 'genie_door' | 'igloo_lock' | 'linear_lock' | 'lockly_lock' | 'kwikset_lock' | 'nuki_lock' | 'salto_lock' | 'schlage_lock' | 'seam_relay' | 'smartthings_lock' | 'wyze_lock' | 'yale_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'hubitat_lock' | 'four_suites_door' | 'dormakaba_oracode_door' | 'tedee_lock') | ('noiseaware_activity_zone' | 'minut_sensor') | ('ecobee_thermostat' | 'nest_thermostat' | 'honeywell_thermostat') | ('ios_phone' | 'android_phone');
21196
+ /** Optional nickname to describe the device, settable through Seam */
21197
+ nickname?: string | undefined;
21198
+ /** 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. */
21199
+ display_name: string;
21177
21200
  /** 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; and "battery," which indicates that the device can manage battery life and health. */
21178
21201
  capabilities_supported: Array<'access_code' | 'lock' | 'noise_detection' | 'thermostat' | 'battery' | 'phone'>;
21179
21202
  /** Properties of the device. */
21180
21203
  properties: (({
21181
21204
  /** Indicates whether the device is online. */
21182
21205
  online: boolean;
21183
- /** Name of the device. Enables administrators and users to identify the device easily, especially when there are numerous devices. */
21206
+ /** Name of the device. Deprecated - use device.display_name instead */
21184
21207
  name: string;
21185
- /** Optional nickname to describe the device, settable through Seam. Enables administrators and users to identify the device easily, especially when there are numerous devices. */
21186
- nickname?: string | undefined;
21187
21208
  appearance: {
21188
21209
  /** Name of the device as seen from the provider API and application, not settable through Seam. */
21189
21210
  name: string;
@@ -21647,16 +21668,18 @@ interface Routes {
21647
21668
  device_id: string;
21648
21669
  /** Type of the device. */
21649
21670
  device_type: ('akuvox_lock' | 'august_lock' | 'brivo_access_point' | 'butterflymx_panel' | 'avigilon_alta_entry' | 'doorking_lock' | 'genie_door' | 'igloo_lock' | 'linear_lock' | 'lockly_lock' | 'kwikset_lock' | 'nuki_lock' | 'salto_lock' | 'schlage_lock' | 'seam_relay' | 'smartthings_lock' | 'wyze_lock' | 'yale_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'hubitat_lock' | 'four_suites_door' | 'dormakaba_oracode_door' | 'tedee_lock') | ('noiseaware_activity_zone' | 'minut_sensor') | ('ecobee_thermostat' | 'nest_thermostat' | 'honeywell_thermostat') | ('ios_phone' | 'android_phone');
21671
+ /** Optional nickname to describe the device, settable through Seam */
21672
+ nickname?: string | undefined;
21673
+ /** 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. */
21674
+ display_name: string;
21650
21675
  /** 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; and "battery," which indicates that the device can manage battery life and health. */
21651
21676
  capabilities_supported: Array<'access_code' | 'lock' | 'noise_detection' | 'thermostat' | 'battery' | 'phone'>;
21652
21677
  /** Properties of the device. */
21653
21678
  properties: (({
21654
21679
  /** Indicates whether the device is online. */
21655
21680
  online: boolean;
21656
- /** Name of the device. Enables administrators and users to identify the device easily, especially when there are numerous devices. */
21681
+ /** Name of the device. Deprecated - use device.display_name instead */
21657
21682
  name: string;
21658
- /** Optional nickname to describe the device, settable through Seam. Enables administrators and users to identify the device easily, especially when there are numerous devices. */
21659
- nickname?: string | undefined;
21660
21683
  appearance: {
21661
21684
  /** Name of the device as seen from the provider API and application, not settable through Seam. */
21662
21685
  name: string;
@@ -22426,6 +22449,10 @@ interface Routes {
22426
22449
  /** Unique identifier for the device. */
22427
22450
  device_id: string;
22428
22451
  device_type: 'android_phone' | 'ios_phone';
22452
+ /** Optional nickname to describe the device, settable through Seam */
22453
+ nickname?: string | undefined;
22454
+ /** 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. */
22455
+ display_name: string;
22429
22456
  /** 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; and "battery," which indicates that the device can manage battery life and health. */
22430
22457
  capabilities_supported: Array<'access_code' | 'lock' | 'noise_detection' | 'thermostat' | 'battery' | 'phone'>;
22431
22458
  properties: {
@@ -22495,6 +22522,10 @@ interface Routes {
22495
22522
  /** Unique identifier for the device. */
22496
22523
  device_id: string;
22497
22524
  device_type: 'android_phone' | 'ios_phone';
22525
+ /** Optional nickname to describe the device, settable through Seam */
22526
+ nickname?: string | undefined;
22527
+ /** 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. */
22528
+ display_name: string;
22498
22529
  /** 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; and "battery," which indicates that the device can manage battery life and health. */
22499
22530
  capabilities_supported: Array<'access_code' | 'lock' | 'noise_detection' | 'thermostat' | 'battery' | 'phone'>;
22500
22531
  properties: {
@@ -22749,16 +22780,18 @@ interface Routes {
22749
22780
  device_id: string;
22750
22781
  /** Type of the device. */
22751
22782
  device_type: ('akuvox_lock' | 'august_lock' | 'brivo_access_point' | 'butterflymx_panel' | 'avigilon_alta_entry' | 'doorking_lock' | 'genie_door' | 'igloo_lock' | 'linear_lock' | 'lockly_lock' | 'kwikset_lock' | 'nuki_lock' | 'salto_lock' | 'schlage_lock' | 'seam_relay' | 'smartthings_lock' | 'wyze_lock' | 'yale_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'hubitat_lock' | 'four_suites_door' | 'dormakaba_oracode_door' | 'tedee_lock') | ('noiseaware_activity_zone' | 'minut_sensor') | ('ecobee_thermostat' | 'nest_thermostat' | 'honeywell_thermostat') | ('ios_phone' | 'android_phone');
22783
+ /** Optional nickname to describe the device, settable through Seam */
22784
+ nickname?: string | undefined;
22785
+ /** 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. */
22786
+ display_name: string;
22752
22787
  /** 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; and "battery," which indicates that the device can manage battery life and health. */
22753
22788
  capabilities_supported: Array<'access_code' | 'lock' | 'noise_detection' | 'thermostat' | 'battery' | 'phone'>;
22754
22789
  /** Properties of the device. */
22755
22790
  properties: (({
22756
22791
  /** Indicates whether the device is online. */
22757
22792
  online: boolean;
22758
- /** Name of the device. Enables administrators and users to identify the device easily, especially when there are numerous devices. */
22793
+ /** Name of the device. Deprecated - use device.display_name instead */
22759
22794
  name: string;
22760
- /** Optional nickname to describe the device, settable through Seam. Enables administrators and users to identify the device easily, especially when there are numerous devices. */
22761
- nickname?: string | undefined;
22762
22795
  appearance: {
22763
22796
  /** Name of the device as seen from the provider API and application, not settable through Seam. */
22764
22797
  name: string;
@@ -23321,16 +23354,18 @@ interface Routes {
23321
23354
  device_id: string;
23322
23355
  /** Type of the device. */
23323
23356
  device_type: ('akuvox_lock' | 'august_lock' | 'brivo_access_point' | 'butterflymx_panel' | 'avigilon_alta_entry' | 'doorking_lock' | 'genie_door' | 'igloo_lock' | 'linear_lock' | 'lockly_lock' | 'kwikset_lock' | 'nuki_lock' | 'salto_lock' | 'schlage_lock' | 'seam_relay' | 'smartthings_lock' | 'wyze_lock' | 'yale_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'hubitat_lock' | 'four_suites_door' | 'dormakaba_oracode_door' | 'tedee_lock') | ('noiseaware_activity_zone' | 'minut_sensor') | ('ecobee_thermostat' | 'nest_thermostat' | 'honeywell_thermostat') | ('ios_phone' | 'android_phone');
23357
+ /** Optional nickname to describe the device, settable through Seam */
23358
+ nickname?: string | undefined;
23359
+ /** 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. */
23360
+ display_name: string;
23324
23361
  /** 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; and "battery," which indicates that the device can manage battery life and health. */
23325
23362
  capabilities_supported: Array<'access_code' | 'lock' | 'noise_detection' | 'thermostat' | 'battery' | 'phone'>;
23326
23363
  /** Properties of the device. */
23327
23364
  properties: (({
23328
23365
  /** Indicates whether the device is online. */
23329
23366
  online: boolean;
23330
- /** Name of the device. Enables administrators and users to identify the device easily, especially when there are numerous devices. */
23367
+ /** Name of the device. Deprecated - use device.display_name instead */
23331
23368
  name: string;
23332
- /** Optional nickname to describe the device, settable through Seam. Enables administrators and users to identify the device easily, especially when there are numerous devices. */
23333
- nickname?: string | undefined;
23334
23369
  appearance: {
23335
23370
  /** Name of the device as seen from the provider API and application, not settable through Seam. */
23336
23371
  name: string;
@@ -24078,16 +24113,18 @@ interface Routes {
24078
24113
  device_id: string;
24079
24114
  /** Type of the device. */
24080
24115
  device_type: ('akuvox_lock' | 'august_lock' | 'brivo_access_point' | 'butterflymx_panel' | 'avigilon_alta_entry' | 'doorking_lock' | 'genie_door' | 'igloo_lock' | 'linear_lock' | 'lockly_lock' | 'kwikset_lock' | 'nuki_lock' | 'salto_lock' | 'schlage_lock' | 'seam_relay' | 'smartthings_lock' | 'wyze_lock' | 'yale_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'hubitat_lock' | 'four_suites_door' | 'dormakaba_oracode_door' | 'tedee_lock') | ('noiseaware_activity_zone' | 'minut_sensor') | ('ecobee_thermostat' | 'nest_thermostat' | 'honeywell_thermostat') | ('ios_phone' | 'android_phone');
24116
+ /** Optional nickname to describe the device, settable through Seam */
24117
+ nickname?: string | undefined;
24118
+ /** 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. */
24119
+ display_name: string;
24081
24120
  /** 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; and "battery," which indicates that the device can manage battery life and health. */
24082
24121
  capabilities_supported: Array<'access_code' | 'lock' | 'noise_detection' | 'thermostat' | 'battery' | 'phone'>;
24083
24122
  /** Properties of the device. */
24084
24123
  properties: (({
24085
24124
  /** Indicates whether the device is online. */
24086
24125
  online: boolean;
24087
- /** Name of the device. Enables administrators and users to identify the device easily, especially when there are numerous devices. */
24126
+ /** Name of the device. Deprecated - use device.display_name instead */
24088
24127
  name: string;
24089
- /** Optional nickname to describe the device, settable through Seam. Enables administrators and users to identify the device easily, especially when there are numerous devices. */
24090
- nickname?: string | undefined;
24091
24128
  appearance: {
24092
24129
  /** Name of the device as seen from the provider API and application, not settable through Seam. */
24093
24130
  name: string;
package/lib/seam/connect/openapi.d.ts CHANGED
@@ -712,6 +712,10 @@ declare const _default: {
712
712
  type: string;
713
713
  }[];
714
714
  };
715
+ display_name: {
716
+ description: string;
717
+ type: string;
718
+ };
715
719
  errors: {
716
720
  description: string;
717
721
  items: {
@@ -748,6 +752,10 @@ declare const _default: {
748
752
  };
749
753
  type: string;
750
754
  };
755
+ nickname: {
756
+ description: string;
757
+ type: string;
758
+ };
751
759
  properties: {
752
760
  allOf: ({
753
761
  allOf: ({
@@ -832,10 +840,6 @@ declare const _default: {
832
840
  description: string;
833
841
  type: string;
834
842
  };
835
- nickname: {
836
- description: string;
837
- type: string;
838
- };
839
843
  offline_access_codes_enabled: {
840
844
  description: string;
841
845
  type: string;
@@ -899,7 +903,6 @@ declare const _default: {
899
903
  manufacturer?: never;
900
904
  model?: never;
901
905
  name?: never;
902
- nickname?: never;
903
906
  offline_access_codes_enabled?: never;
904
907
  online?: never;
905
908
  online_access_codes_enabled?: never;
@@ -2326,6 +2329,10 @@ declare const _default: {
2326
2329
  enum: string[];
2327
2330
  type: string;
2328
2331
  };
2332
+ display_name: {
2333
+ description: string;
2334
+ type: string;
2335
+ };
2329
2336
  errors: {
2330
2337
  description: string;
2331
2338
  items: {
@@ -2362,6 +2369,10 @@ declare const _default: {
2362
2369
  };
2363
2370
  type: string;
2364
2371
  };
2372
+ nickname: {
2373
+ description: string;
2374
+ type: string;
2375
+ };
2365
2376
  properties: {
2366
2377
  properties: {
2367
2378
  assa_abloy_credential_service_metadata: {
package/lib/seam/connect/openapi.js CHANGED
@@ -595,6 +595,10 @@ export default {
595
595
  { enum: ['ios_phone', 'android_phone'], type: 'string' },
596
596
  ],
597
597
  },
598
+ display_name: {
599
+ description: '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.',
600
+ type: 'string',
601
+ },
598
602
  errors: {
599
603
  description: 'Array of errors associated with the device. Each error object within the array contains two fields: "error_code" and "message." "error_code" is a string that uniquely identifies the type of error, enabling quick recognition and categorization of the issue. "message" provides a more detailed description of the error, offering insights into the issue and potentially how to rectify it.',
600
604
  items: {
@@ -627,6 +631,10 @@ export default {
627
631
  },
628
632
  type: 'object',
629
633
  },
634
+ nickname: {
635
+ description: 'Optional nickname to describe the device, settable through Seam',
636
+ type: 'string',
637
+ },
630
638
  properties: {
631
639
  allOf: [
632
640
  {
@@ -710,11 +718,7 @@ export default {
710
718
  type: 'object',
711
719
  },
712
720
  name: {
713
- description: 'Name of the device. Enables administrators and users to identify the device easily, especially when there are numerous devices.',
714
- type: 'string',
715
- },
716
- nickname: {
717
- description: 'Optional nickname to describe the device, settable through Seam. Enables administrators and users to identify the device easily, especially when there are numerous devices.',
721
+ description: 'Name of the device. Deprecated - use device.display_name instead',
718
722
  type: 'string',
719
723
  },
720
724
  offline_access_codes_enabled: {
@@ -1683,6 +1687,7 @@ export default {
1683
1687
  required: [
1684
1688
  'device_id',
1685
1689
  'device_type',
1690
+ 'display_name',
1686
1691
  'capabilities_supported',
1687
1692
  'properties',
1688
1693
  'location',
@@ -1858,6 +1863,10 @@ export default {
1858
1863
  type: 'string',
1859
1864
  },
1860
1865
  device_type: { enum: ['android_phone', 'ios_phone'], type: 'string' },
1866
+ display_name: {
1867
+ description: '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.',
1868
+ type: 'string',
1869
+ },
1861
1870
  errors: {
1862
1871
  description: 'Array of errors associated with the device. Each error object within the array contains two fields: "error_code" and "message." "error_code" is a string that uniquely identifies the type of error, enabling quick recognition and categorization of the issue. "message" provides a more detailed description of the error, offering insights into the issue and potentially how to rectify it.',
1863
1872
  items: {
@@ -1890,6 +1899,10 @@ export default {
1890
1899
  },
1891
1900
  type: 'object',
1892
1901
  },
1902
+ nickname: {
1903
+ description: 'Optional nickname to describe the device, settable through Seam',
1904
+ type: 'string',
1905
+ },
1893
1906
  properties: {
1894
1907
  properties: {
1895
1908
  assa_abloy_credential_service_metadata: {
@@ -1934,6 +1947,7 @@ export default {
1934
1947
  required: [
1935
1948
  'device_id',
1936
1949
  'device_type',
1950
+ 'display_name',
1937
1951
  'capabilities_supported',
1938
1952
  'properties',
1939
1953
  'location',
@@ -2177,7 +2191,7 @@ export default {
2177
2191
  type: 'object',
2178
2192
  },
2179
2193
  name: {
2180
- description: 'Name of the device. Enables administrators and users to identify the device easily, especially when there are numerous devices.',
2194
+ description: 'Name of the device. Deprecated - use device.display_name instead',
2181
2195
  type: 'string',
2182
2196
  },
2183
2197
  offline_access_codes_enabled: {