@seamapi/types 1.129.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 +35 -6
  2. package/dist/connect.cjs.map +1 -1
  3. package/dist/connect.d.cts +135 -23
  4. package/lib/seam/connect/openapi.d.ts +44 -12
  5. package/lib/seam/connect/openapi.js +35 -6
  6. package/lib/seam/connect/openapi.js.map +1 -1
  7. package/lib/seam/connect/route-types.d.ts +91 -11
  8. package/lib/seam/connect/unstable/models/devices/managed-device.d.ts +44 -0
  9. package/lib/seam/connect/unstable/models/devices/managed-device.js +13 -1
  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 +7 -0
  13. package/package.json +1 -1
  14. package/src/lib/seam/connect/openapi.ts +40 -6
  15. package/src/lib/seam/connect/route-types.ts +91 -11
  16. package/src/lib/seam/connect/unstable/models/devices/managed-device.ts +19 -1
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,11 +826,25 @@ 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: ({
828
836
  allOf: ({
829
837
  properties: {
838
+ appearance: {
839
+ properties: {
840
+ name: {
841
+ description: string;
842
+ type: string;
843
+ };
844
+ };
845
+ required: string[];
846
+ type: string;
847
+ };
830
848
  battery: {
831
849
  description: string;
832
850
  properties: {
@@ -950,6 +968,7 @@ declare const _default: {
950
968
  required: string[];
951
969
  type: string;
952
970
  };
971
+ appearance?: never;
953
972
  battery?: never;
954
973
  battery_level?: never;
955
974
  has_direct_power?: never;
@@ -2384,6 +2403,10 @@ declare const _default: {
2384
2403
  enum: string[];
2385
2404
  type: string;
2386
2405
  };
2406
+ display_name: {
2407
+ description: string;
2408
+ type: string;
2409
+ };
2387
2410
  errors: {
2388
2411
  description: string;
2389
2412
  items: {
@@ -2420,6 +2443,10 @@ declare const _default: {
2420
2443
  };
2421
2444
  type: string;
2422
2445
  };
2446
+ nickname: {
2447
+ description: string;
2448
+ type: string;
2449
+ };
2423
2450
  properties: {
2424
2451
  properties: {
2425
2452
  assa_abloy_credential_service_metadata: {
@@ -12055,20 +12082,25 @@ declare const _default: {
12055
12082
  };
12056
12083
  };
12057
12084
  security: ({
12058
- access_token: never[];
12059
- seam_workspace: never[];
12060
- seam_client_session_token?: never;
12061
- client_session_token?: never;
12085
+ client_session: never[];
12086
+ pat_with_workspace?: never;
12087
+ console_session?: never;
12088
+ api_key?: never;
12062
12089
  } | {
12063
- seam_client_session_token: never[];
12064
- access_token?: never;
12065
- seam_workspace?: never;
12066
- client_session_token?: never;
12090
+ pat_with_workspace: never[];
12091
+ client_session?: never;
12092
+ console_session?: never;
12093
+ api_key?: never;
12067
12094
  } | {
12068
- client_session_token: never[];
12069
- access_token?: never;
12070
- seam_workspace?: never;
12071
- seam_client_session_token?: never;
12095
+ console_session: never[];
12096
+ client_session?: never;
12097
+ pat_with_workspace?: never;
12098
+ api_key?: never;
12099
+ } | {
12100
+ api_key: never[];
12101
+ client_session?: never;
12102
+ pat_with_workspace?: never;
12103
+ console_session?: never;
12072
12104
  })[];
12073
12105
  summary: string;
12074
12106
  tags: string[];
@@ -18869,14 +18901,22 @@ interface Routes {
18869
18901
  device_id: string;
18870
18902
  /** Type of the device. */
18871
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;
18872
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. */
18873
18909
  capabilities_supported: Array<'access_code' | 'lock' | 'noise_detection' | 'thermostat' | 'battery' | 'phone'>;
18874
18910
  /** Properties of the device. */
18875
18911
  properties: (({
18876
18912
  /** Indicates whether the device is online. */
18877
18913
  online: boolean;
18878
- /** 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 */
18879
18915
  name: string;
18916
+ appearance: {
18917
+ /** Name of the device as seen from the provider API and application, not settable through Seam. */
18918
+ name: string;
18919
+ };
18880
18920
  model: {
18881
18921
  /** Display name of the device model. */
18882
18922
  display_name: string;
@@ -19359,14 +19399,22 @@ interface Routes {
19359
19399
  device_id: string;
19360
19400
  /** Type of the device. */
19361
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;
19362
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. */
19363
19407
  capabilities_supported: Array<'access_code' | 'lock' | 'noise_detection' | 'thermostat' | 'battery' | 'phone'>;
19364
19408
  /** Properties of the device. */
19365
19409
  properties: (({
19366
19410
  /** Indicates whether the device is online. */
19367
19411
  online: boolean;
19368
- /** 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 */
19369
19413
  name: string;
19414
+ appearance: {
19415
+ /** Name of the device as seen from the provider API and application, not settable through Seam. */
19416
+ name: string;
19417
+ };
19370
19418
  model: {
19371
19419
  /** Display name of the device model. */
19372
19420
  display_name: string;
@@ -19877,7 +19925,7 @@ interface Routes {
19877
19925
  created_at: string;
19878
19926
  is_managed: false;
19879
19927
  properties: {
19880
- /** 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 */
19881
19929
  name: string;
19882
19930
  /** Indicates whether the device is online. */
19883
19931
  online: boolean;
@@ -19962,7 +20010,7 @@ interface Routes {
19962
20010
  created_at: string;
19963
20011
  is_managed: false;
19964
20012
  properties: {
19965
- /** 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 */
19966
20014
  name: string;
19967
20015
  /** Indicates whether the device is online. */
19968
20016
  online: boolean;
@@ -20172,14 +20220,22 @@ interface Routes {
20172
20220
  device_id: string;
20173
20221
  /** Type of the device. */
20174
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;
20175
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. */
20176
20228
  capabilities_supported: Array<'access_code' | 'lock' | 'noise_detection' | 'thermostat' | 'battery' | 'phone'>;
20177
20229
  /** Properties of the device. */
20178
20230
  properties: (({
20179
20231
  /** Indicates whether the device is online. */
20180
20232
  online: boolean;
20181
- /** 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 */
20182
20234
  name: string;
20235
+ appearance: {
20236
+ /** Name of the device as seen from the provider API and application, not settable through Seam. */
20237
+ name: string;
20238
+ };
20183
20239
  model: {
20184
20240
  /** Display name of the device model. */
20185
20241
  display_name: string;
@@ -20639,14 +20695,22 @@ interface Routes {
20639
20695
  device_id: string;
20640
20696
  /** Type of the device. */
20641
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;
20642
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. */
20643
20703
  capabilities_supported: Array<'access_code' | 'lock' | 'noise_detection' | 'thermostat' | 'battery' | 'phone'>;
20644
20704
  /** Properties of the device. */
20645
20705
  properties: (({
20646
20706
  /** Indicates whether the device is online. */
20647
20707
  online: boolean;
20648
- /** 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 */
20649
20709
  name: string;
20710
+ appearance: {
20711
+ /** Name of the device as seen from the provider API and application, not settable through Seam. */
20712
+ name: string;
20713
+ };
20650
20714
  model: {
20651
20715
  /** Display name of the device model. */
20652
20716
  display_name: string;
@@ -21129,14 +21193,22 @@ interface Routes {
21129
21193
  device_id: string;
21130
21194
  /** Type of the device. */
21131
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;
21132
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. */
21133
21201
  capabilities_supported: Array<'access_code' | 'lock' | 'noise_detection' | 'thermostat' | 'battery' | 'phone'>;
21134
21202
  /** Properties of the device. */
21135
21203
  properties: (({
21136
21204
  /** Indicates whether the device is online. */
21137
21205
  online: boolean;
21138
- /** 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 */
21139
21207
  name: string;
21208
+ appearance: {
21209
+ /** Name of the device as seen from the provider API and application, not settable through Seam. */
21210
+ name: string;
21211
+ };
21140
21212
  model: {
21141
21213
  /** Display name of the device model. */
21142
21214
  display_name: string;
@@ -21596,14 +21668,22 @@ interface Routes {
21596
21668
  device_id: string;
21597
21669
  /** Type of the device. */
21598
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;
21599
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. */
21600
21676
  capabilities_supported: Array<'access_code' | 'lock' | 'noise_detection' | 'thermostat' | 'battery' | 'phone'>;
21601
21677
  /** Properties of the device. */
21602
21678
  properties: (({
21603
21679
  /** Indicates whether the device is online. */
21604
21680
  online: boolean;
21605
- /** 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 */
21606
21682
  name: string;
21683
+ appearance: {
21684
+ /** Name of the device as seen from the provider API and application, not settable through Seam. */
21685
+ name: string;
21686
+ };
21607
21687
  model: {
21608
21688
  /** Display name of the device model. */
21609
21689
  display_name: string;
@@ -22369,6 +22449,10 @@ interface Routes {
22369
22449
  /** Unique identifier for the device. */
22370
22450
  device_id: string;
22371
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;
22372
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. */
22373
22457
  capabilities_supported: Array<'access_code' | 'lock' | 'noise_detection' | 'thermostat' | 'battery' | 'phone'>;
22374
22458
  properties: {
@@ -22438,6 +22522,10 @@ interface Routes {
22438
22522
  /** Unique identifier for the device. */
22439
22523
  device_id: string;
22440
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;
22441
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. */
22442
22530
  capabilities_supported: Array<'access_code' | 'lock' | 'noise_detection' | 'thermostat' | 'battery' | 'phone'>;
22443
22531
  properties: {
@@ -22692,14 +22780,22 @@ interface Routes {
22692
22780
  device_id: string;
22693
22781
  /** Type of the device. */
22694
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;
22695
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. */
22696
22788
  capabilities_supported: Array<'access_code' | 'lock' | 'noise_detection' | 'thermostat' | 'battery' | 'phone'>;
22697
22789
  /** Properties of the device. */
22698
22790
  properties: (({
22699
22791
  /** Indicates whether the device is online. */
22700
22792
  online: boolean;
22701
- /** 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 */
22702
22794
  name: string;
22795
+ appearance: {
22796
+ /** Name of the device as seen from the provider API and application, not settable through Seam. */
22797
+ name: string;
22798
+ };
22703
22799
  model: {
22704
22800
  /** Display name of the device model. */
22705
22801
  display_name: string;
@@ -23258,14 +23354,22 @@ interface Routes {
23258
23354
  device_id: string;
23259
23355
  /** Type of the device. */
23260
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;
23261
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. */
23262
23362
  capabilities_supported: Array<'access_code' | 'lock' | 'noise_detection' | 'thermostat' | 'battery' | 'phone'>;
23263
23363
  /** Properties of the device. */
23264
23364
  properties: (({
23265
23365
  /** Indicates whether the device is online. */
23266
23366
  online: boolean;
23267
- /** 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 */
23268
23368
  name: string;
23369
+ appearance: {
23370
+ /** Name of the device as seen from the provider API and application, not settable through Seam. */
23371
+ name: string;
23372
+ };
23269
23373
  model: {
23270
23374
  /** Display name of the device model. */
23271
23375
  display_name: string;
@@ -24009,14 +24113,22 @@ interface Routes {
24009
24113
  device_id: string;
24010
24114
  /** Type of the device. */
24011
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;
24012
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. */
24013
24121
  capabilities_supported: Array<'access_code' | 'lock' | 'noise_detection' | 'thermostat' | 'battery' | 'phone'>;
24014
24122
  /** Properties of the device. */
24015
24123
  properties: (({
24016
24124
  /** Indicates whether the device is online. */
24017
24125
  online: boolean;
24018
- /** 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 */
24019
24127
  name: string;
24128
+ appearance: {
24129
+ /** Name of the device as seen from the provider API and application, not settable through Seam. */
24130
+ name: string;
24131
+ };
24020
24132
  model: {
24021
24133
  /** Display name of the device model. */
24022
24134
  display_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,11 +752,25 @@ 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: ({
754
762
  allOf: ({
755
763
  properties: {
764
+ appearance: {
765
+ properties: {
766
+ name: {
767
+ description: string;
768
+ type: string;
769
+ };
770
+ };
771
+ required: string[];
772
+ type: string;
773
+ };
756
774
  battery: {
757
775
  description: string;
758
776
  properties: {
@@ -876,6 +894,7 @@ declare const _default: {
876
894
  required: string[];
877
895
  type: string;
878
896
  };
897
+ appearance?: never;
879
898
  battery?: never;
880
899
  battery_level?: never;
881
900
  has_direct_power?: never;
@@ -2310,6 +2329,10 @@ declare const _default: {
2310
2329
  enum: string[];
2311
2330
  type: string;
2312
2331
  };
2332
+ display_name: {
2333
+ description: string;
2334
+ type: string;
2335
+ };
2313
2336
  errors: {
2314
2337
  description: string;
2315
2338
  items: {
@@ -2346,6 +2369,10 @@ declare const _default: {
2346
2369
  };
2347
2370
  type: string;
2348
2371
  };
2372
+ nickname: {
2373
+ description: string;
2374
+ type: string;
2375
+ };
2349
2376
  properties: {
2350
2377
  properties: {
2351
2378
  assa_abloy_credential_service_metadata: {
@@ -11981,20 +12008,25 @@ declare const _default: {
11981
12008
  };
11982
12009
  };
11983
12010
  security: ({
11984
- access_token: never[];
11985
- seam_workspace: never[];
11986
- seam_client_session_token?: never;
11987
- client_session_token?: never;
12011
+ client_session: never[];
12012
+ pat_with_workspace?: never;
12013
+ console_session?: never;
12014
+ api_key?: never;
11988
12015
  } | {
11989
- seam_client_session_token: never[];
11990
- access_token?: never;
11991
- seam_workspace?: never;
11992
- client_session_token?: never;
12016
+ pat_with_workspace: never[];
12017
+ client_session?: never;
12018
+ console_session?: never;
12019
+ api_key?: never;
11993
12020
  } | {
11994
- client_session_token: never[];
11995
- access_token?: never;
11996
- seam_workspace?: never;
11997
- seam_client_session_token?: never;
12021
+ console_session: never[];
12022
+ client_session?: never;
12023
+ pat_with_workspace?: never;
12024
+ api_key?: never;
12025
+ } | {
12026
+ api_key: never[];
12027
+ client_session?: never;
12028
+ pat_with_workspace?: never;
12029
+ console_session?: never;
11998
12030
  })[];
11999
12031
  summary: string;
12000
12032
  tags: string[];
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
  {
@@ -635,6 +643,16 @@ export default {
635
643
  allOf: [
636
644
  {
637
645
  properties: {
646
+ appearance: {
647
+ properties: {
648
+ name: {
649
+ description: 'Name of the device as seen from the provider API and application, not settable through Seam.',
650
+ type: 'string',
651
+ },
652
+ },
653
+ required: ['name'],
654
+ type: 'object',
655
+ },
638
656
  battery: {
639
657
  description: 'Represents the current status of the battery charge level. Values are "critical," which indicates an extremely low level, suggesting imminent shutdown or an urgent need for charging; "low," which signifies that the battery is under the preferred threshold and should be charged soon; "good," which denotes a satisfactory charge level, adequate for normal use without the immediate need for recharging; and "full," which represents a battery that is fully charged, providing the maximum duration of usage.',
640
658
  properties: {
@@ -700,7 +718,7 @@ export default {
700
718
  type: 'object',
701
719
  },
702
720
  name: {
703
- description: 'Name of the device. 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',
704
722
  type: 'string',
705
723
  },
706
724
  offline_access_codes_enabled: {
@@ -728,7 +746,7 @@ export default {
728
746
  type: 'boolean',
729
747
  },
730
748
  },
731
- required: ['online', 'name', 'model'],
749
+ required: ['online', 'name', 'appearance', 'model'],
732
750
  type: 'object',
733
751
  },
734
752
  {
@@ -1669,6 +1687,7 @@ export default {
1669
1687
  required: [
1670
1688
  'device_id',
1671
1689
  'device_type',
1690
+ 'display_name',
1672
1691
  'capabilities_supported',
1673
1692
  'properties',
1674
1693
  'location',
@@ -1844,6 +1863,10 @@ export default {
1844
1863
  type: 'string',
1845
1864
  },
1846
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
+ },
1847
1870
  errors: {
1848
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.',
1849
1872
  items: {
@@ -1876,6 +1899,10 @@ export default {
1876
1899
  },
1877
1900
  type: 'object',
1878
1901
  },
1902
+ nickname: {
1903
+ description: 'Optional nickname to describe the device, settable through Seam',
1904
+ type: 'string',
1905
+ },
1879
1906
  properties: {
1880
1907
  properties: {
1881
1908
  assa_abloy_credential_service_metadata: {
@@ -1920,6 +1947,7 @@ export default {
1920
1947
  required: [
1921
1948
  'device_id',
1922
1949
  'device_type',
1950
+ 'display_name',
1923
1951
  'capabilities_supported',
1924
1952
  'properties',
1925
1953
  'location',
@@ -2163,7 +2191,7 @@ export default {
2163
2191
  type: 'object',
2164
2192
  },
2165
2193
  name: {
2166
- 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',
2167
2195
  type: 'string',
2168
2196
  },
2169
2197
  offline_access_codes_enabled: {
@@ -9133,9 +9161,10 @@ export default {
9133
9161
  401: { description: 'Unauthorized' },
9134
9162
  },
9135
9163
  security: [
9136
- { access_token: [], seam_workspace: [] },
9137
- { seam_client_session_token: [] },
9138
- { client_session_token: [] },
9164
+ { client_session: [] },
9165
+ { pat_with_workspace: [] },
9166
+ { console_session: [] },
9167
+ { api_key: [] },
9139
9168
  ],
9140
9169
  summary: '/locks/unlock_door',
9141
9170
  tags: ['/locks'],