@seamapi/http 2.8.0 → 2.10.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.
@@ -1493,7 +1493,15 @@ export type Device = {
1493
1493
  */
1494
1494
  dual_setpoints_not_supported?: boolean | undefined;
1495
1495
  /**
1496
- * Enforced setpoint range in Celsius for a Sensi device, derived from an OutOfRange API error.
1496
+ * Enforced cooling setpoint range in Celsius for a Sensi device, derived from an OutOfRange API error.
1497
+ */
1498
+ enforced_cooling_setpoint_range_celsius?: Array<number> | undefined;
1499
+ /**
1500
+ * Enforced heating setpoint range in Celsius for a Sensi device, derived from an OutOfRange API error.
1501
+ */
1502
+ enforced_heating_setpoint_range_celsius?: Array<number> | undefined;
1503
+ /**
1504
+ * Legacy combined enforced setpoint range in Celsius for a Sensi device, derived from an OutOfRange API error. Read as a fallback for the per-mode ranges below; no longer written.
1497
1505
  */
1498
1506
  enforced_setpoint_range_celsius?: Array<number> | undefined;
1499
1507
  /**
@@ -56,7 +56,7 @@ export type ConnectWebviewsCreateParameters = {
56
56
  */
57
57
  automatically_manage_new_devices?: boolean | undefined;
58
58
  /**
59
- * Custom metadata that you want to associate with the Connect Webview. Supports up to 50 JSON key:value pairs. [Adding custom metadata to a Connect Webview](https://docs.seam.co/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://docs.seam.co/core-concepts/connected-accounts) that were connected using the Connect Webview, making it easy to find and filter these resources in your [workspace](https://docs.seam.co/core-concepts/workspaces). You can also [filter Connect Webviews by custom metadata](https://docs.seam.co/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.
59
+ * 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://docs.seam.co/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://docs.seam.co/core-concepts/connected-accounts) that were connected using the Connect Webview, making it easy to find and filter these resources in your [workspace](https://docs.seam.co/core-concepts/workspaces). You can also [filter Connect Webviews by custom metadata](https://docs.seam.co/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.
60
60
  */
61
61
  custom_metadata?: Record<string, unknown> | undefined;
62
62
  /**
@@ -123,7 +123,7 @@ export interface ConnectWebviewsGetOptions {
123
123
  }
124
124
  export type ConnectWebviewsListParameters = {
125
125
  /**
126
- * Custom metadata pairs by which you want to [filter Connect Webviews](https://docs.seam.co/core-concepts/connect-webviews/filtering-connect-webviews-by-custom-metadata). Returns Connect Webviews with `custom_metadata` that contains all of the provided key:value pairs. Specify an empty string to match a key that is unset or set to an empty string.
126
+ * Custom metadata pairs by which you want to [filter Connect Webviews](https://docs.seam.co/core-concepts/connect-webviews/filtering-connect-webviews-by-custom-metadata). Returns Connect Webviews with `custom_metadata` that contains all of the provided key:value pairs. Key names cannot contain a period (.). Specify an empty string to match a key that is unset or set to an empty string.
127
127
  */
128
128
  custom_metadata_has?: Record<string, unknown> | undefined;
129
129
  /**
@@ -77,7 +77,7 @@ export interface ConnectedAccountsGetOptions {
77
77
  }
78
78
  export type ConnectedAccountsListParameters = {
79
79
  /**
80
- * Custom metadata pairs by which you want to filter connected accounts. Returns connected accounts with `custom_metadata` that contains all of the provided key:value pairs. Specify an empty string to match a key that is unset or set to an empty string.
80
+ * Custom metadata pairs by which you want to filter connected accounts. Returns connected accounts with `custom_metadata` that contains all of the provided key:value pairs. Key names cannot contain a period (.). Specify an empty string to match a key that is unset or set to an empty string.
81
81
  */
82
82
  custom_metadata_has?: Record<string, unknown> | undefined;
83
83
  /**
@@ -141,7 +141,7 @@ export type ConnectedAccountsUpdateParameters = {
141
141
  */
142
142
  connected_account_id: string;
143
143
  /**
144
- * Custom metadata that you want to associate with the connected account. Entirely replaces the existing custom metadata object. If a new Connect Webview contains custom metadata and is used to reconnect a connected account, the custom metadata from the Connect Webview will entirely replace the entire custom metadata object on the connected account. Supports up to 50 JSON key:value pairs. [Adding custom metadata to a connected account](https://docs.seam.co/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account) enables you to store custom information, like customer details or internal IDs from your application. Then, you can [filter connected accounts by the desired metadata](https://docs.seam.co/core-concepts/connected-accounts/filtering-connected-accounts-by-custom-metadata). Set a key to `null` or to an empty string to remove that key from the custom metadata.
144
+ * Custom metadata that you want to associate with the connected account. Entirely replaces the existing custom metadata object. If a new Connect Webview contains custom metadata and is used to reconnect a connected account, the custom metadata from the Connect Webview will entirely replace the entire custom metadata object on the connected account. 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 connected account](https://docs.seam.co/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account) enables you to store custom information, like customer details or internal IDs from your application. Then, you can [filter connected accounts by the desired metadata](https://docs.seam.co/core-concepts/connected-accounts/filtering-connected-accounts-by-custom-metadata). Set a key to `null` or to an empty string to remove that key from the custom metadata.
145
145
  */
146
146
  custom_metadata?: Record<string, unknown> | undefined;
147
147
  /**
@@ -87,7 +87,7 @@ export type DevicesListParameters = {
87
87
  */
88
88
  created_before?: string | undefined;
89
89
  /**
90
- * Set of key:value [custom metadata](https://docs.seam.co/core-concepts/devices/adding-custom-metadata-to-a-device) pairs for which you want to list devices. Specify an empty string to match a key that is unset or set to an empty string.
90
+ * Set of key:value [custom metadata](https://docs.seam.co/core-concepts/devices/adding-custom-metadata-to-a-device) pairs for which you want to list devices. Key names cannot contain a period (.). Specify an empty string to match a key that is unset or set to an empty string.
91
91
  */
92
92
  custom_metadata_has?: Record<string, unknown> | undefined;
93
93
  /**
@@ -210,7 +210,7 @@ export type DevicesUpdateParameters = {
210
210
  */
211
211
  backup_access_code_pool_enabled?: boolean | undefined;
212
212
  /**
213
- * Custom metadata that you want to associate with the device. Supports up to 50 JSON key:value pairs. [Adding custom metadata to a device](https://docs.seam.co/core-concepts/devices/adding-custom-metadata-to-a-device) enables you to store custom information, like customer details or internal IDs from your application. Then, you can [filter devices by the desired metadata](https://docs.seam.co/core-concepts/devices/filtering-devices-by-custom-metadata). Set a key to `null` or to an empty string to remove that key from the custom metadata.
213
+ * Custom metadata that you want to associate with the device. 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 device](https://docs.seam.co/core-concepts/devices/adding-custom-metadata-to-a-device) enables you to store custom information, like customer details or internal IDs from your application. Then, you can [filter devices by the desired metadata](https://docs.seam.co/core-concepts/devices/filtering-devices-by-custom-metadata). Set a key to `null` or to an empty string to remove that key from the custom metadata.
214
214
  */
215
215
  custom_metadata?: Record<string, unknown> | undefined;
216
216
  /**
@@ -117,7 +117,7 @@ export interface DevicesUnmanagedListOptions {
117
117
  }
118
118
  export type DevicesUnmanagedUpdateParameters = {
119
119
  /**
120
- * Custom metadata that you want to associate with the device. Supports up to 50 JSON key:value pairs. Set a key to `null` or to an empty string to remove that key from the custom metadata.
120
+ * Custom metadata that you want to associate with the device. Supports up to 50 JSON key:value pairs, with key names up to 40 characters long that cannot contain a period (.). Set a key to `null` or to an empty string to remove that key from the custom metadata.
121
121
  */
122
122
  custom_metadata?: Record<string, unknown> | undefined;
123
123
  /**
package/lib/version.d.ts CHANGED
@@ -1,2 +1,2 @@
1
- declare const seamapiJavascriptHttpVersion = "2.8.0";
1
+ declare const seamapiJavascriptHttpVersion = "2.10.0";
2
2
  export default seamapiJavascriptHttpVersion;
package/lib/version.js CHANGED
@@ -1,3 +1,3 @@
1
- const seamapiJavascriptHttpVersion = '2.8.0';
1
+ const seamapiJavascriptHttpVersion = '2.10.0';
2
2
  export default seamapiJavascriptHttpVersion;
3
3
  //# sourceMappingURL=version.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"version.js","sourceRoot":"","sources":["../src/lib/version.ts"],"names":[],"mappings":"AAAA,MAAM,4BAA4B,GAAG,OAAO,CAAA;AAE5C,eAAe,4BAA4B,CAAA"}
1
+ {"version":3,"file":"version.js","sourceRoot":"","sources":["../src/lib/version.ts"],"names":[],"mappings":"AAAA,MAAM,4BAA4B,GAAG,QAAQ,CAAA;AAE7C,eAAe,4BAA4B,CAAA"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@seamapi/http",
3
- "version": "2.8.0",
3
+ "version": "2.10.0",
4
4
  "description": "JavaScript HTTP client for the Seam API written in TypeScript.",
5
5
  "type": "module",
6
6
  "main": "index.js",
@@ -87,7 +87,7 @@
87
87
  "@seamapi/blueprint": "^1.5.1",
88
88
  "@seamapi/fake-seam-connect": "^2.0.4",
89
89
  "@seamapi/smith": "^1.1.0",
90
- "@seamapi/types": "1.1015.0",
90
+ "@seamapi/types": "1.1018.0",
91
91
  "@types/jsonwebtoken": "^9.0.6",
92
92
  "@types/node": "^24.10.9",
93
93
  "ava": "^8.0.1",
@@ -1717,7 +1717,15 @@ export type Device = {
1717
1717
  */
1718
1718
  dual_setpoints_not_supported?: boolean | undefined
1719
1719
  /**
1720
- * Enforced setpoint range in Celsius for a Sensi device, derived from an OutOfRange API error.
1720
+ * Enforced cooling setpoint range in Celsius for a Sensi device, derived from an OutOfRange API error.
1721
+ */
1722
+ enforced_cooling_setpoint_range_celsius?: Array<number> | undefined
1723
+ /**
1724
+ * Enforced heating setpoint range in Celsius for a Sensi device, derived from an OutOfRange API error.
1725
+ */
1726
+ enforced_heating_setpoint_range_celsius?: Array<number> | undefined
1727
+ /**
1728
+ * Legacy combined enforced setpoint range in Celsius for a Sensi device, derived from an OutOfRange API error. Read as a fallback for the per-mode ranges below; no longer written.
1721
1729
  */
1722
1730
  enforced_setpoint_range_celsius?: Array<number> | undefined
1723
1731
  /**
@@ -334,7 +334,7 @@ export type ConnectWebviewsCreateParameters = {
334
334
  */
335
335
  automatically_manage_new_devices?: boolean | undefined
336
336
  /**
337
- * Custom metadata that you want to associate with the Connect Webview. Supports up to 50 JSON key:value pairs. [Adding custom metadata to a Connect Webview](https://docs.seam.co/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://docs.seam.co/core-concepts/connected-accounts) that were connected using the Connect Webview, making it easy to find and filter these resources in your [workspace](https://docs.seam.co/core-concepts/workspaces). You can also [filter Connect Webviews by custom metadata](https://docs.seam.co/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.
337
+ * 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://docs.seam.co/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://docs.seam.co/core-concepts/connected-accounts) that were connected using the Connect Webview, making it easy to find and filter these resources in your [workspace](https://docs.seam.co/core-concepts/workspaces). You can also [filter Connect Webviews by custom metadata](https://docs.seam.co/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.
338
338
  */
339
339
  custom_metadata?: Record<string, unknown> | undefined
340
340
  /**
@@ -422,7 +422,7 @@ export interface ConnectWebviewsGetOptions {}
422
422
 
423
423
  export type ConnectWebviewsListParameters = {
424
424
  /**
425
- * Custom metadata pairs by which you want to [filter Connect Webviews](https://docs.seam.co/core-concepts/connect-webviews/filtering-connect-webviews-by-custom-metadata). Returns Connect Webviews with `custom_metadata` that contains all of the provided key:value pairs. Specify an empty string to match a key that is unset or set to an empty string.
425
+ * Custom metadata pairs by which you want to [filter Connect Webviews](https://docs.seam.co/core-concepts/connect-webviews/filtering-connect-webviews-by-custom-metadata). Returns Connect Webviews with `custom_metadata` that contains all of the provided key:value pairs. Key names cannot contain a period (.). Specify an empty string to match a key that is unset or set to an empty string.
426
426
  */
427
427
  custom_metadata_has?: Record<string, unknown> | undefined
428
428
  /**
@@ -311,7 +311,7 @@ export interface ConnectedAccountsGetOptions {}
311
311
 
312
312
  export type ConnectedAccountsListParameters = {
313
313
  /**
314
- * Custom metadata pairs by which you want to filter connected accounts. Returns connected accounts with `custom_metadata` that contains all of the provided key:value pairs. Specify an empty string to match a key that is unset or set to an empty string.
314
+ * Custom metadata pairs by which you want to filter connected accounts. Returns connected accounts with `custom_metadata` that contains all of the provided key:value pairs. Key names cannot contain a period (.). Specify an empty string to match a key that is unset or set to an empty string.
315
315
  */
316
316
  custom_metadata_has?: Record<string, unknown> | undefined
317
317
  /**
@@ -389,7 +389,7 @@ export type ConnectedAccountsUpdateParameters = {
389
389
  connected_account_id: string
390
390
 
391
391
  /**
392
- * Custom metadata that you want to associate with the connected account. Entirely replaces the existing custom metadata object. If a new Connect Webview contains custom metadata and is used to reconnect a connected account, the custom metadata from the Connect Webview will entirely replace the entire custom metadata object on the connected account. Supports up to 50 JSON key:value pairs. [Adding custom metadata to a connected account](https://docs.seam.co/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account) enables you to store custom information, like customer details or internal IDs from your application. Then, you can [filter connected accounts by the desired metadata](https://docs.seam.co/core-concepts/connected-accounts/filtering-connected-accounts-by-custom-metadata). Set a key to `null` or to an empty string to remove that key from the custom metadata.
392
+ * Custom metadata that you want to associate with the connected account. Entirely replaces the existing custom metadata object. If a new Connect Webview contains custom metadata and is used to reconnect a connected account, the custom metadata from the Connect Webview will entirely replace the entire custom metadata object on the connected account. 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 connected account](https://docs.seam.co/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account) enables you to store custom information, like customer details or internal IDs from your application. Then, you can [filter connected accounts by the desired metadata](https://docs.seam.co/core-concepts/connected-accounts/filtering-connected-accounts-by-custom-metadata). Set a key to `null` or to an empty string to remove that key from the custom metadata.
393
393
  */
394
394
  custom_metadata?: Record<string, unknown> | undefined
395
395
  /**
@@ -313,7 +313,7 @@ export type DevicesListParameters = {
313
313
  */
314
314
  created_before?: string | undefined
315
315
  /**
316
- * Set of key:value [custom metadata](https://docs.seam.co/core-concepts/devices/adding-custom-metadata-to-a-device) pairs for which you want to list devices. Specify an empty string to match a key that is unset or set to an empty string.
316
+ * Set of key:value [custom metadata](https://docs.seam.co/core-concepts/devices/adding-custom-metadata-to-a-device) pairs for which you want to list devices. Key names cannot contain a period (.). Specify an empty string to match a key that is unset or set to an empty string.
317
317
  */
318
318
  custom_metadata_has?: Record<string, unknown> | undefined
319
319
  /**
@@ -1897,7 +1897,7 @@ export type DevicesUpdateParameters = {
1897
1897
  */
1898
1898
  backup_access_code_pool_enabled?: boolean | undefined
1899
1899
  /**
1900
- * Custom metadata that you want to associate with the device. Supports up to 50 JSON key:value pairs. [Adding custom metadata to a device](https://docs.seam.co/core-concepts/devices/adding-custom-metadata-to-a-device) enables you to store custom information, like customer details or internal IDs from your application. Then, you can [filter devices by the desired metadata](https://docs.seam.co/core-concepts/devices/filtering-devices-by-custom-metadata). Set a key to `null` or to an empty string to remove that key from the custom metadata.
1900
+ * Custom metadata that you want to associate with the device. 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 device](https://docs.seam.co/core-concepts/devices/adding-custom-metadata-to-a-device) enables you to store custom information, like customer details or internal IDs from your application. Then, you can [filter devices by the desired metadata](https://docs.seam.co/core-concepts/devices/filtering-devices-by-custom-metadata). Set a key to `null` or to an empty string to remove that key from the custom metadata.
1901
1901
  */
1902
1902
  custom_metadata?: Record<string, unknown> | undefined
1903
1903
  /**
@@ -456,7 +456,7 @@ export interface DevicesUnmanagedListOptions {}
456
456
 
457
457
  export type DevicesUnmanagedUpdateParameters = {
458
458
  /**
459
- * Custom metadata that you want to associate with the device. Supports up to 50 JSON key:value pairs. Set a key to `null` or to an empty string to remove that key from the custom metadata.
459
+ * Custom metadata that you want to associate with the device. Supports up to 50 JSON key:value pairs, with key names up to 40 characters long that cannot contain a period (.). Set a key to `null` or to an empty string to remove that key from the custom metadata.
460
460
  */
461
461
  custom_metadata?: Record<string, unknown> | undefined
462
462
  /**
@@ -1,3 +1,3 @@
1
- const seamapiJavascriptHttpVersion = '2.8.0'
1
+ const seamapiJavascriptHttpVersion = '2.10.0'
2
2
 
3
3
  export default seamapiJavascriptHttpVersion