@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.
Files changed (10) hide show
  1. package/dist/connect.cjs +23 -7
  2. package/dist/connect.cjs.map +1 -1
  3. package/dist/connect.d.cts +12 -2
  4. package/lib/seam/connect/openapi.d.ts +6 -0
  5. package/lib/seam/connect/openapi.js +23 -7
  6. package/lib/seam/connect/openapi.js.map +1 -1
  7. package/lib/seam/connect/route-types.d.ts +6 -2
  8. package/package.json +1 -1
  9. package/src/lib/seam/connect/openapi.ts +28 -7
  10. package/src/lib/seam/connect/route-types.ts +6 -2
package/dist/connect.d.cts CHANGED
@@ -28899,7 +28899,10 @@ declare const _default: {
28899
28899
  };
28900
28900
  manual_override_allowed: {
28901
28901
  default: boolean;
28902
+ deprecated: boolean;
28903
+ description: string;
28902
28904
  type: string;
28905
+ 'x-deprecated': string;
28903
28906
  };
28904
28907
  name: {
28905
28908
  default: null;
@@ -29583,6 +29586,7 @@ declare const _default: {
29583
29586
  };
29584
29587
  is_override_allowed: {
29585
29588
  default: boolean;
29589
+ description: string;
29586
29590
  type: string;
29587
29591
  };
29588
29592
  max_override_period_minutes: {
@@ -29918,6 +29922,7 @@ declare const _default: {
29918
29922
  type: string;
29919
29923
  };
29920
29924
  is_override_allowed: {
29925
+ description: string;
29921
29926
  type: string;
29922
29927
  };
29923
29928
  max_override_period_minutes: {
@@ -30013,6 +30018,7 @@ declare const _default: {
30013
30018
  type: string;
30014
30019
  };
30015
30020
  is_override_allowed: {
30021
+ description: string;
30016
30022
  type: string;
30017
30023
  };
30018
30024
  max_override_period_minutes: {
@@ -53827,6 +53833,8 @@ interface Routes {
53827
53833
  jsonBody: {
53828
53834
  /** ID of the desired thermostat device. */
53829
53835
  device_id: string;
53836
+ /** Indicates whether a person at the thermostat or using the API can change the thermostat's settings.
53837
+ * @deprecated Use 'thermostat_schedule.is_override_allowed' */
53830
53838
  manual_override_allowed?: boolean;
53831
53839
  /** Unique key to identify the climate preset. */
53832
53840
  climate_preset_key: string;
@@ -57826,12 +57834,13 @@ interface Routes {
57826
57834
  name?: string | undefined;
57827
57835
  /** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the thermostat schedule. */
57828
57836
  climate_preset_key: string;
57829
- /** 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). */
57837
+ /** 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). */
57830
57838
  max_override_period_minutes?: number;
57831
57839
  /** Date and time at which the thermostat schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
57832
57840
  starts_at: string;
57833
57841
  /** Date and time at which the thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
57834
57842
  ends_at: string;
57843
+ /** 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). */
57835
57844
  is_override_allowed?: boolean | undefined;
57836
57845
  };
57837
57846
  commonParams: {};
@@ -57958,12 +57967,13 @@ interface Routes {
57958
57967
  name?: string | undefined;
57959
57968
  /** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the thermostat schedule. */
57960
57969
  climate_preset_key?: string | undefined;
57961
- /** 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). */
57970
+ /** 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). */
57962
57971
  max_override_period_minutes?: number | undefined;
57963
57972
  /** Date and time at which the thermostat schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
57964
57973
  starts_at?: string | undefined;
57965
57974
  /** Date and time at which the thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
57966
57975
  ends_at?: string | undefined;
57976
+ /** 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). */
57967
57977
  is_override_allowed?: boolean | undefined;
57968
57978
  };
57969
57979
  commonParams: {};
package/lib/seam/connect/openapi.d.ts CHANGED
@@ -16518,7 +16518,10 @@ declare const _default: {
16518
16518
  };
16519
16519
  manual_override_allowed: {
16520
16520
  default: boolean;
16521
+ deprecated: boolean;
16522
+ description: string;
16521
16523
  type: string;
16524
+ 'x-deprecated': string;
16522
16525
  };
16523
16526
  name: {
16524
16527
  default: null;
@@ -17202,6 +17205,7 @@ declare const _default: {
17202
17205
  };
17203
17206
  is_override_allowed: {
17204
17207
  default: boolean;
17208
+ description: string;
17205
17209
  type: string;
17206
17210
  };
17207
17211
  max_override_period_minutes: {
@@ -17537,6 +17541,7 @@ declare const _default: {
17537
17541
  type: string;
17538
17542
  };
17539
17543
  is_override_allowed: {
17544
+ description: string;
17540
17545
  type: string;
17541
17546
  };
17542
17547
  max_override_period_minutes: {
@@ -17632,6 +17637,7 @@ declare const _default: {
17632
17637
  type: string;
17633
17638
  };
17634
17639
  is_override_allowed: {
17640
+ description: string;
17635
17641
  type: string;
17636
17642
  };
17637
17643
  max_override_period_minutes: {
package/lib/seam/connect/openapi.js CHANGED
@@ -16001,7 +16001,13 @@ export default {
16001
16001
  enum: ['off', 'heat', 'cool', 'heat_cool'],
16002
16002
  type: 'string',
16003
16003
  },
16004
- manual_override_allowed: { default: true, type: 'boolean' },
16004
+ manual_override_allowed: {
16005
+ default: true,
16006
+ deprecated: true,
16007
+ description: "Indicates whether a person at the thermostat or using the API can change the thermostat's settings.",
16008
+ type: 'boolean',
16009
+ 'x-deprecated': "Use 'thermostat_schedule.is_override_allowed'",
16010
+ },
16005
16011
  name: {
16006
16012
  default: null,
16007
16013
  description: 'User-friendly name to identify the climate preset.',
@@ -16683,10 +16689,14 @@ export default {
16683
16689
  description: 'Date and time at which the thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.',
16684
16690
  type: 'string',
16685
16691
  },
16686
- is_override_allowed: { default: false, type: 'boolean' },
16692
+ is_override_allowed: {
16693
+ default: false,
16694
+ description: "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).",
16695
+ type: 'boolean',
16696
+ },
16687
16697
  max_override_period_minutes: {
16688
16698
  default: 0,
16689
- description: "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).",
16699
+ description: "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).",
16690
16700
  minimum: 0,
16691
16701
  type: 'integer',
16692
16702
  },
@@ -16935,9 +16945,12 @@ export default {
16935
16945
  description: 'Date and time at which the thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.',
16936
16946
  type: 'string',
16937
16947
  },
16938
- is_override_allowed: { type: 'boolean' },
16948
+ is_override_allowed: {
16949
+ description: "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).",
16950
+ type: 'boolean',
16951
+ },
16939
16952
  max_override_period_minutes: {
16940
- description: "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).",
16953
+ description: "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).",
16941
16954
  minimum: 0,
16942
16955
  type: 'integer',
16943
16956
  },
@@ -17005,9 +17018,12 @@ export default {
17005
17018
  description: 'Date and time at which the thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.',
17006
17019
  type: 'string',
17007
17020
  },
17008
- is_override_allowed: { type: 'boolean' },
17021
+ is_override_allowed: {
17022
+ description: "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).",
17023
+ type: 'boolean',
17024
+ },
17009
17025
  max_override_period_minutes: {
17010
- description: "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).",
17026
+ description: "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).",
17011
17027
  minimum: 0,
17012
17028
  type: 'integer',
17013
17029
  },