@seamapi/types 1.422.0 → 1.423.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.
@@ -1630,8 +1630,8 @@ export declare const unmanaged_device: z.ZodObject<z.objectUtil.extendShape<z.ob
1630
1630
  cooling_set_point_fahrenheit?: number | undefined;
1631
1631
  heating_set_point_fahrenheit?: number | undefined;
1632
1632
  }>, "many">>;
1633
- fallback_climate_preset_key: z.ZodOptional<z.ZodDefault<z.ZodNullable<z.ZodString>>>;
1634
- active_thermostat_schedule: z.ZodOptional<z.ZodDefault<z.ZodNullable<z.ZodObject<{
1633
+ fallback_climate_preset_key: z.ZodOptional<z.ZodNullable<z.ZodString>>;
1634
+ active_thermostat_schedule: z.ZodOptional<z.ZodNullable<z.ZodObject<{
1635
1635
  thermostat_schedule_id: z.ZodString;
1636
1636
  device_id: z.ZodString;
1637
1637
  name: z.ZodNullable<z.ZodString>;
@@ -1682,7 +1682,8 @@ export declare const unmanaged_device: z.ZodObject<z.objectUtil.extendShape<z.ob
1682
1682
  }[];
1683
1683
  max_override_period_minutes?: number | null | undefined;
1684
1684
  is_override_allowed?: boolean | undefined;
1685
- }>>>>;
1685
+ }>>>;
1686
+ active_thermostat_schedule_id: z.ZodOptional<z.ZodNullable<z.ZodString>>;
1686
1687
  thermostat_daily_programs: z.ZodOptional<z.ZodOptional<z.ZodArray<z.ZodObject<{
1687
1688
  thermostat_daily_program_id: z.ZodString;
1688
1689
  device_id: z.ZodString;
@@ -1847,6 +1848,7 @@ export declare const unmanaged_device: z.ZodObject<z.objectUtil.extendShape<z.ob
1847
1848
  max_override_period_minutes?: number | null | undefined;
1848
1849
  is_override_allowed?: boolean | undefined;
1849
1850
  } | null | undefined;
1851
+ active_thermostat_schedule_id?: string | null | undefined;
1850
1852
  thermostat_daily_programs?: {
1851
1853
  name: string | null;
1852
1854
  thermostat_daily_program_id: string;
@@ -1957,6 +1959,7 @@ export declare const unmanaged_device: z.ZodObject<z.objectUtil.extendShape<z.ob
1957
1959
  max_override_period_minutes?: number | null | undefined;
1958
1960
  is_override_allowed?: boolean | undefined;
1959
1961
  } | null | undefined;
1962
+ active_thermostat_schedule_id?: string | null | undefined;
1960
1963
  thermostat_daily_programs?: {
1961
1964
  name: string | null;
1962
1965
  thermostat_daily_program_id: string;
@@ -5831,6 +5831,7 @@ declare const _default: {
5831
5831
  'x-property-group-key': string;
5832
5832
  };
5833
5833
  active_thermostat_schedule?: never;
5834
+ active_thermostat_schedule_id?: never;
5834
5835
  available_climate_presets?: never;
5835
5836
  available_fan_mode_settings?: never;
5836
5837
  available_hvac_mode_settings?: never;
@@ -5863,7 +5864,7 @@ declare const _default: {
5863
5864
  } | {
5864
5865
  properties: {
5865
5866
  active_thermostat_schedule: {
5866
- default: null;
5867
+ deprecated: boolean;
5867
5868
  description: string;
5868
5869
  nullable: boolean;
5869
5870
  properties: {
@@ -5938,9 +5939,17 @@ declare const _default: {
5938
5939
  };
5939
5940
  required: string[];
5940
5941
  type: string;
5942
+ 'x-deprecated': string;
5941
5943
  'x-property-group-key': string;
5942
5944
  'x-route-path': string;
5943
5945
  };
5946
+ active_thermostat_schedule_id: {
5947
+ description: string;
5948
+ format: string;
5949
+ nullable: boolean;
5950
+ type: string;
5951
+ 'x-property-group-key': string;
5952
+ };
5944
5953
  available_climate_presets: {
5945
5954
  description: string;
5946
5955
  items: {
@@ -6172,7 +6181,6 @@ declare const _default: {
6172
6181
  'x-property-group-key': string;
6173
6182
  };
6174
6183
  fallback_climate_preset_key: {
6175
- default: null;
6176
6184
  description: string;
6177
6185
  minLength: number;
6178
6186
  nullable: boolean;
@@ -10250,7 +10250,7 @@ export default {
10250
10250
  {
10251
10251
  properties: {
10252
10252
  active_thermostat_schedule: {
10253
- default: null,
10253
+ deprecated: true,
10254
10254
  description: 'Active [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules).',
10255
10255
  nullable: true,
10256
10256
  properties: {
@@ -10335,9 +10335,17 @@ export default {
10335
10335
  'errors',
10336
10336
  ],
10337
10337
  type: 'object',
10338
+ 'x-deprecated': 'Use `active_thermostat_schedule_id` with `/thermostats/schedules/get` instead.',
10338
10339
  'x-property-group-key': 'thermostats',
10339
10340
  'x-route-path': '/thermostats/schedules',
10340
10341
  },
10342
+ active_thermostat_schedule_id: {
10343
+ description: 'ID of the active [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules).',
10344
+ format: 'uuid',
10345
+ nullable: true,
10346
+ type: 'string',
10347
+ 'x-property-group-key': 'thermostats',
10348
+ },
10341
10349
  available_climate_presets: {
10342
10350
  description: 'Available [climate presets](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) for the thermostat.',
10343
10351
  items: {
@@ -10576,7 +10584,6 @@ export default {
10576
10584
  'x-property-group-key': 'thermostats',
10577
10585
  },
10578
10586
  fallback_climate_preset_key: {
10579
- default: null,
10580
10587
  description: 'Key of the [fallback climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets/setting-the-fallback-climate-preset) for the thermostat.',
10581
10588
  minLength: 1,
10582
10589
  nullable: true,
@@ -21569,7 +21576,7 @@ export default {
21569
21576
  type: 'string',
21570
21577
  },
21571
21578
  name: {
21572
- description: "Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`. To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints. To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components).",
21579
+ description: "Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.\n\n Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`.\n\n To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints.\n\n To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components).",
21573
21580
  type: 'string',
21574
21581
  },
21575
21582
  prefer_native_scheduling: {
@@ -21699,7 +21706,7 @@ export default {
21699
21706
  type: 'string',
21700
21707
  },
21701
21708
  name: {
21702
- description: "Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`. To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints. To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components).",
21709
+ description: "Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.\n\n Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`.\n\n To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints.\n\n To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components).",
21703
21710
  type: 'string',
21704
21711
  },
21705
21712
  prefer_native_scheduling: {
@@ -21820,7 +21827,7 @@ export default {
21820
21827
  type: 'string',
21821
21828
  },
21822
21829
  name: {
21823
- description: "Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`. To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints. To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components).",
21830
+ description: "Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.\n\n Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`.\n\n To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints.\n\n To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components).",
21824
21831
  type: 'string',
21825
21832
  },
21826
21833
  prefer_native_scheduling: {
@@ -23336,7 +23343,7 @@ export default {
23336
23343
  type: 'string',
23337
23344
  },
23338
23345
  name: {
23339
- description: "Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`. To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints. To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components).",
23346
+ description: "Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.\n\n Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`.\n\n To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints.\n\n To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components).",
23340
23347
  type: 'string',
23341
23348
  },
23342
23349
  prefer_native_scheduling: {
@@ -23470,7 +23477,7 @@ export default {
23470
23477
  type: 'string',
23471
23478
  },
23472
23479
  name: {
23473
- description: "Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`. To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints. To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components).",
23480
+ description: "Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.\n\n Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`.\n\n To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints.\n\n To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components).",
23474
23481
  type: 'string',
23475
23482
  },
23476
23483
  prefer_native_scheduling: {
@@ -23604,7 +23611,7 @@ export default {
23604
23611
  type: 'string',
23605
23612
  },
23606
23613
  name: {
23607
- description: "Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`. To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints. To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components).",
23614
+ description: "Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.\n\n Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`.\n\n To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints.\n\n To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components).",
23608
23615
  type: 'string',
23609
23616
  },
23610
23617
  prefer_native_scheduling: {
@@ -23697,7 +23704,7 @@ export default {
23697
23704
  type: 'string',
23698
23705
  },
23699
23706
  name: {
23700
- description: "Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`. To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints. To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components).",
23707
+ description: "Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.\n\n Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`.\n\n To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints.\n\n To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components).",
23701
23708
  type: 'string',
23702
23709
  },
23703
23710
  starts_at: {
@@ -23757,7 +23764,7 @@ export default {
23757
23764
  type: 'string',
23758
23765
  },
23759
23766
  name: {
23760
- description: "Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes. Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`. To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints. To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components).",
23767
+ description: "Name of the new access code. Enables administrators and users to identify the access code easily, especially when there are numerous access codes.\n\n Note that the name provided on Seam is used to identify the code on Seam and is not necessarily the name that will appear in the lock provider's app or on the device. This is because lock providers may have constraints on names, such as length, uniqueness, or characters that can be used. In addition, some lock providers may break down names into components such as `first_name` and `last_name`.\n\n To provide a consistent experience, Seam identifies the code on Seam by its name but may modify the name that appears on the lock provider's app or on the device. For example, Seam may add additional characters or truncate the name to meet provider constraints.\n\n To help your users identify codes set by Seam, Seam provides the name exactly as it appears on the lock provider's app or on the device as a separate property called `appearance`. This is an object with a `name` property and, optionally, `first_name` and `last_name` properties (for providers that break down a name into components).",
23761
23768
  type: 'string',
23762
23769
  },
23763
23770
  starts_at: {