@seamapi/types 1.311.0 → 1.311.1

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.
@@ -20612,6 +20612,8 @@ export interface Routes {
20612
20612
  jsonBody: {
20613
20613
  /** ID of the desired thermostat device. */
20614
20614
  device_id: string;
20615
+ /** Indicates whether a person at the thermostat or using the API can change the thermostat's settings.
20616
+ * @deprecated Use 'thermostat_schedule.is_override_allowed' */
20615
20617
  manual_override_allowed?: boolean;
20616
20618
  /** Unique key to identify the climate preset. */
20617
20619
  climate_preset_key: string;
@@ -24611,12 +24613,13 @@ export interface Routes {
24611
24613
  name?: string | undefined;
24612
24614
  /** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the thermostat schedule. */
24613
24615
  climate_preset_key: string;
24614
- /** Number of minutes for which a person at the thermostat can change the thermostat's settings after the activation of the scheduled climate preset. See also [Specifying Manual Override Permissions](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions). */
24616
+ /** Number of minutes for which a person at the thermostat or using the API can change the thermostat's settings after the activation of the scheduled climate preset. See also [Specifying Manual Override Permissions](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions). */
24615
24617
  max_override_period_minutes?: number;
24616
24618
  /** Date and time at which the thermostat schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
24617
24619
  starts_at: string;
24618
24620
  /** Date and time at which the thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
24619
24621
  ends_at: string;
24622
+ /** Indicates whether a person at the thermostat or using the API can change the thermostat's settings while the schedule is active. See also [Specifying Manual Override Permissions](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions). */
24620
24623
  is_override_allowed?: boolean | undefined;
24621
24624
  };
24622
24625
  commonParams: {};
@@ -24743,12 +24746,13 @@ export interface Routes {
24743
24746
  name?: string | undefined;
24744
24747
  /** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the thermostat schedule. */
24745
24748
  climate_preset_key?: string | undefined;
24746
- /** Number of minutes for which a person at the thermostat can change the thermostat's settings after the activation of the scheduled climate preset. See also [Specifying Manual Override Permissions](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions). */
24749
+ /** Number of minutes for which a person at the thermostat or using the API can change the thermostat's settings after the activation of the scheduled climate preset. See also [Specifying Manual Override Permissions](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions). */
24747
24750
  max_override_period_minutes?: number | undefined;
24748
24751
  /** Date and time at which the thermostat schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
24749
24752
  starts_at?: string | undefined;
24750
24753
  /** Date and time at which the thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
24751
24754
  ends_at?: string | undefined;
24755
+ /** Indicates whether a person at the thermostat or using the API can change the thermostat's settings while the schedule is active. See also [Specifying Manual Override Permissions](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions). */
24752
24756
  is_override_allowed?: boolean | undefined;
24753
24757
  };
24754
24758
  commonParams: {};
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@seamapi/types",
3
- "version": "1.311.0",
3
+ "version": "1.311.1",
4
4
  "description": "TypeScript types for the Seam API.",
5
5
  "type": "module",
6
6
  "main": "index.js",
@@ -16729,7 +16729,15 @@ export default {
16729
16729
  enum: ['off', 'heat', 'cool', 'heat_cool'],
16730
16730
  type: 'string',
16731
16731
  },
16732
- manual_override_allowed: { default: true, type: 'boolean' },
16732
+ manual_override_allowed: {
16733
+ default: true,
16734
+ deprecated: true,
16735
+ description:
16736
+ "Indicates whether a person at the thermostat or using the API can change the thermostat's settings.",
16737
+ type: 'boolean',
16738
+ 'x-deprecated':
16739
+ "Use 'thermostat_schedule.is_override_allowed'",
16740
+ },
16733
16741
  name: {
16734
16742
  default: null,
16735
16743
  description:
@@ -17438,11 +17446,16 @@ export default {
17438
17446
  'Date and time at which the thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.',
17439
17447
  type: 'string',
17440
17448
  },
17441
- is_override_allowed: { default: false, type: 'boolean' },
17449
+ is_override_allowed: {
17450
+ default: false,
17451
+ description:
17452
+ "Indicates whether a person at the thermostat or using the API can change the thermostat's settings while the schedule is active. See also [Specifying Manual Override Permissions](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions).",
17453
+ type: 'boolean',
17454
+ },
17442
17455
  max_override_period_minutes: {
17443
17456
  default: 0,
17444
17457
  description:
17445
- "Number of minutes for which a person at the thermostat can change the thermostat's settings after the activation of the scheduled climate preset. See also [Specifying Manual Override Permissions](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions).",
17458
+ "Number of minutes for which a person at the thermostat or using the API can change the thermostat's settings after the activation of the scheduled climate preset. See also [Specifying Manual Override Permissions](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions).",
17446
17459
  minimum: 0,
17447
17460
  type: 'integer',
17448
17461
  },
@@ -17700,10 +17713,14 @@ export default {
17700
17713
  'Date and time at which the thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.',
17701
17714
  type: 'string',
17702
17715
  },
17703
- is_override_allowed: { type: 'boolean' },
17716
+ is_override_allowed: {
17717
+ description:
17718
+ "Indicates whether a person at the thermostat or using the API can change the thermostat's settings while the schedule is active. See also [Specifying Manual Override Permissions](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions).",
17719
+ type: 'boolean',
17720
+ },
17704
17721
  max_override_period_minutes: {
17705
17722
  description:
17706
- "Number of minutes for which a person at the thermostat can change the thermostat's settings after the activation of the scheduled climate preset. See also [Specifying Manual Override Permissions](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions).",
17723
+ "Number of minutes for which a person at the thermostat or using the API can change the thermostat's settings after the activation of the scheduled climate preset. See also [Specifying Manual Override Permissions](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions).",
17707
17724
  minimum: 0,
17708
17725
  type: 'integer',
17709
17726
  },
@@ -17776,10 +17793,14 @@ export default {
17776
17793
  'Date and time at which the thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.',
17777
17794
  type: 'string',
17778
17795
  },
17779
- is_override_allowed: { type: 'boolean' },
17796
+ is_override_allowed: {
17797
+ description:
17798
+ "Indicates whether a person at the thermostat or using the API can change the thermostat's settings while the schedule is active. See also [Specifying Manual Override Permissions](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions).",
17799
+ type: 'boolean',
17800
+ },
17780
17801
  max_override_period_minutes: {
17781
17802
  description:
17782
- "Number of minutes for which a person at the thermostat can change the thermostat's settings after the activation of the scheduled climate preset. See also [Specifying Manual Override Permissions](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions).",
17803
+ "Number of minutes for which a person at the thermostat or using the API can change the thermostat's settings after the activation of the scheduled climate preset. See also [Specifying Manual Override Permissions](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions).",
17783
17804
  minimum: 0,
17784
17805
  type: 'integer',
17785
17806
  },
@@ -25782,6 +25782,8 @@ export interface Routes {
25782
25782
  jsonBody: {
25783
25783
  /** ID of the desired thermostat device. */
25784
25784
  device_id: string
25785
+ /** Indicates whether a person at the thermostat or using the API can change the thermostat's settings.
25786
+ * @deprecated Use 'thermostat_schedule.is_override_allowed' */
25785
25787
  manual_override_allowed?: boolean
25786
25788
  /** Unique key to identify the climate preset. */
25787
25789
  climate_preset_key: string
@@ -30900,12 +30902,13 @@ export interface Routes {
30900
30902
  name?: string | undefined
30901
30903
  /** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the thermostat schedule. */
30902
30904
  climate_preset_key: string
30903
- /** Number of minutes for which a person at the thermostat can change the thermostat's settings after the activation of the scheduled climate preset. See also [Specifying Manual Override Permissions](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions). */
30905
+ /** Number of minutes for which a person at the thermostat or using the API can change the thermostat's settings after the activation of the scheduled climate preset. See also [Specifying Manual Override Permissions](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions). */
30904
30906
  max_override_period_minutes?: number
30905
30907
  /** Date and time at which the thermostat schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
30906
30908
  starts_at: string
30907
30909
  /** Date and time at which the thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
30908
30910
  ends_at: string
30911
+ /** Indicates whether a person at the thermostat or using the API can change the thermostat's settings while the schedule is active. See also [Specifying Manual Override Permissions](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions). */
30909
30912
  is_override_allowed?: boolean | undefined
30910
30913
  }
30911
30914
  commonParams: {}
@@ -31032,12 +31035,13 @@ export interface Routes {
31032
31035
  name?: string | undefined
31033
31036
  /** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the thermostat schedule. */
31034
31037
  climate_preset_key?: string | undefined
31035
- /** Number of minutes for which a person at the thermostat can change the thermostat's settings after the activation of the scheduled climate preset. See also [Specifying Manual Override Permissions](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions). */
31038
+ /** Number of minutes for which a person at the thermostat or using the API can change the thermostat's settings after the activation of the scheduled climate preset. See also [Specifying Manual Override Permissions](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions). */
31036
31039
  max_override_period_minutes?: number | undefined
31037
31040
  /** Date and time at which the thermostat schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
31038
31041
  starts_at?: string | undefined
31039
31042
  /** Date and time at which the thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
31040
31043
  ends_at?: string | undefined
31044
+ /** Indicates whether a person at the thermostat or using the API can change the thermostat's settings while the schedule is active. See also [Specifying Manual Override Permissions](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions). */
31041
31045
  is_override_allowed?: boolean | undefined
31042
31046
  }
31043
31047
  commonParams: {}