@seamapi/types 1.202.0 → 1.204.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.
@@ -4195,8 +4195,9 @@ export interface Routes {
4195
4195
  queryParams: {};
4196
4196
  jsonBody: {};
4197
4197
  commonParams: {
4198
+ /** Returns webviews that can be accessed by the provided user_identifier_key. */
4198
4199
  user_identifier_key?: string | undefined;
4199
- /** Returns devices where the webview's custom_metadata contains all of the provided key/value pairs. */
4200
+ /** Returns webviews whose custom_metadata contains all of the provided key/value pairs. */
4200
4201
  custom_metadata_has?: Record<string, string | boolean> | undefined;
4201
4202
  limit?: number;
4202
4203
  };
@@ -4285,7 +4286,9 @@ export interface Routes {
4285
4286
  queryParams: {};
4286
4287
  jsonBody: {};
4287
4288
  commonParams: {
4288
- /** Returns devices where the account's custom_metadata contains all of the provided key/value pairs. */
4289
+ /** Returns accounts that can be accessed by the provided user_identifier_key. */
4290
+ user_identifier_key?: string | undefined;
4291
+ /** Returns accounts whose custom_metadata contains all of the provided key/value pairs. */
4289
4292
  custom_metadata_has?: Record<string, string | boolean> | undefined;
4290
4293
  };
4291
4294
  formData: {};
@@ -5502,6 +5505,13 @@ export interface Routes {
5502
5505
  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_resideo_thermostat') | ('ios_phone' | 'android_phone');
5503
5506
  /** Unique identifier for the account associated with the device. */
5504
5507
  connected_account_id: string;
5508
+ /** Location information for the device. */
5509
+ location: {
5510
+ /** Name of the device location. */
5511
+ location_name?: string | undefined;
5512
+ /** Time zone of the device location. */
5513
+ timezone?: string | undefined;
5514
+ } | null;
5505
5515
  /** 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. */
5506
5516
  capabilities_supported: Array<'access_code' | 'lock' | 'noise_detection' | 'thermostat' | 'battery' | 'phone'>;
5507
5517
  /** Unique identifier for the Seam workspace associated with the device. */
@@ -5614,6 +5624,13 @@ export interface Routes {
5614
5624
  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_resideo_thermostat') | ('ios_phone' | 'android_phone');
5615
5625
  /** Unique identifier for the account associated with the device. */
5616
5626
  connected_account_id: string;
5627
+ /** Location information for the device. */
5628
+ location: {
5629
+ /** Name of the device location. */
5630
+ location_name?: string | undefined;
5631
+ /** Time zone of the device location. */
5632
+ timezone?: string | undefined;
5633
+ } | null;
5617
5634
  /** 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. */
5618
5635
  capabilities_supported: Array<'access_code' | 'lock' | 'noise_detection' | 'thermostat' | 'battery' | 'phone'>;
5619
5636
  /** Unique identifier for the Seam workspace associated with the device. */
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@seamapi/types",
3
- "version": "1.202.0",
3
+ "version": "1.204.0",
4
4
  "description": "TypeScript types for the Seam API.",
5
5
  "type": "module",
6
6
  "main": "index.js",
@@ -90,6 +90,8 @@ export const PROVIDER_CATEGORY_MAP = {
90
90
  'kwikset',
91
91
  'igloohome',
92
92
  'wyze',
93
+ 'lockly',
94
+ 'tedee',
93
95
  ],
94
96
 
95
97
  thermostats: ['ecobee', 'nest'],
@@ -11,6 +11,7 @@ export const unmanaged_device = device
11
11
  device_id: true,
12
12
  device_type: true,
13
13
  connected_account_id: true,
14
+ location: true,
14
15
  capabilities_supported: true,
15
16
  workspace_id: true,
16
17
  errors: true,
@@ -4048,6 +4048,21 @@ export default {
4048
4048
  type: 'array',
4049
4049
  },
4050
4050
  is_managed: { enum: [false], type: 'boolean' },
4051
+ location: {
4052
+ description: 'Location information for the device.',
4053
+ nullable: true,
4054
+ properties: {
4055
+ location_name: {
4056
+ description: 'Name of the device location.',
4057
+ type: 'string',
4058
+ },
4059
+ timezone: {
4060
+ description: 'Time zone of the device location.',
4061
+ type: 'string',
4062
+ },
4063
+ },
4064
+ type: 'object',
4065
+ },
4051
4066
  properties: {
4052
4067
  properties: {
4053
4068
  accessory_keypad: {
@@ -4203,6 +4218,7 @@ export default {
4203
4218
  'device_id',
4204
4219
  'device_type',
4205
4220
  'connected_account_id',
4221
+ 'location',
4206
4222
  'capabilities_supported',
4207
4223
  'workspace_id',
4208
4224
  'errors',
@@ -8289,11 +8305,15 @@ export default {
8289
8305
  oneOf: [{ type: 'string' }, { type: 'boolean' }],
8290
8306
  },
8291
8307
  description:
8292
- "Returns devices where the webview's custom_metadata contains all of the provided key/value pairs.",
8308
+ 'Returns webviews whose custom_metadata contains all of the provided key/value pairs.',
8293
8309
  type: 'object',
8294
8310
  },
8295
8311
  limit: { default: 500, format: 'float', type: 'number' },
8296
- user_identifier_key: { type: 'string' },
8312
+ user_identifier_key: {
8313
+ description:
8314
+ 'Returns webviews that can be accessed by the provided user_identifier_key.',
8315
+ type: 'string',
8316
+ },
8297
8317
  },
8298
8318
  type: 'object',
8299
8319
  },
@@ -8451,9 +8471,14 @@ export default {
8451
8471
  oneOf: [{ type: 'string' }, { type: 'boolean' }],
8452
8472
  },
8453
8473
  description:
8454
- "Returns devices where the account's custom_metadata contains all of the provided key/value pairs.",
8474
+ 'Returns accounts whose custom_metadata contains all of the provided key/value pairs.',
8455
8475
  type: 'object',
8456
8476
  },
8477
+ user_identifier_key: {
8478
+ description:
8479
+ 'Returns accounts that can be accessed by the provided user_identifier_key.',
8480
+ type: 'string',
8481
+ },
8457
8482
  },
8458
8483
  type: 'object',
8459
8484
  },
@@ -4801,8 +4801,9 @@ export interface Routes {
4801
4801
  queryParams: {}
4802
4802
  jsonBody: {}
4803
4803
  commonParams: {
4804
+ /** Returns webviews that can be accessed by the provided user_identifier_key. */
4804
4805
  user_identifier_key?: string | undefined
4805
- /** Returns devices where the webview's custom_metadata contains all of the provided key/value pairs. */
4806
+ /** Returns webviews whose custom_metadata contains all of the provided key/value pairs. */
4806
4807
  custom_metadata_has?: Record<string, string | boolean> | undefined
4807
4808
  limit?: number
4808
4809
  }
@@ -4895,7 +4896,9 @@ export interface Routes {
4895
4896
  queryParams: {}
4896
4897
  jsonBody: {}
4897
4898
  commonParams: {
4898
- /** Returns devices where the account's custom_metadata contains all of the provided key/value pairs. */
4899
+ /** Returns accounts that can be accessed by the provided user_identifier_key. */
4900
+ user_identifier_key?: string | undefined
4901
+ /** Returns accounts whose custom_metadata contains all of the provided key/value pairs. */
4899
4902
  custom_metadata_has?: Record<string, string | boolean> | undefined
4900
4903
  }
4901
4904
  formData: {}
@@ -6783,6 +6786,13 @@ export interface Routes {
6783
6786
  | ('ios_phone' | 'android_phone')
6784
6787
  /** Unique identifier for the account associated with the device. */
6785
6788
  connected_account_id: string
6789
+ /** Location information for the device. */
6790
+ location: {
6791
+ /** Name of the device location. */
6792
+ location_name?: string | undefined
6793
+ /** Time zone of the device location. */
6794
+ timezone?: string | undefined
6795
+ } | null
6786
6796
  /** 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. */
6787
6797
  capabilities_supported: Array<
6788
6798
  | 'access_code'
@@ -7079,6 +7089,13 @@ export interface Routes {
7079
7089
  | ('ios_phone' | 'android_phone')
7080
7090
  /** Unique identifier for the account associated with the device. */
7081
7091
  connected_account_id: string
7092
+ /** Location information for the device. */
7093
+ location: {
7094
+ /** Name of the device location. */
7095
+ location_name?: string | undefined
7096
+ /** Time zone of the device location. */
7097
+ timezone?: string | undefined
7098
+ } | null
7082
7099
  /** 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. */
7083
7100
  capabilities_supported: Array<
7084
7101
  | 'access_code'