@seamapi/types 1.396.0 → 1.397.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.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@seamapi/types",
3
- "version": "1.396.0",
3
+ "version": "1.397.0",
4
4
  "description": "TypeScript types for the Seam API.",
5
5
  "type": "module",
6
6
  "main": "index.js",
@@ -177,41 +177,6 @@ export const acs_users_warnings = z
177
177
 
178
178
  export type AcsUsersWarningMap = z.infer<typeof acs_users_warning_map>
179
179
 
180
- const common_acs_user_modification = z.object({
181
- created_at: z
182
- .string()
183
- .datetime()
184
- .describe('Date and time at which this modification was requested.'),
185
- message: z.string().describe('Detailed description of the modification.'),
186
- })
187
-
188
- const acs_user_suspension_state_modification = common_acs_user_modification
189
- .extend({
190
- modification_code: z.literal('suspension_state'),
191
- })
192
- .describe(
193
- "Indicates that the [ACS user's](https://docs.seam.co/latest/capability-guides/access-systems/user-management) `is_suspended` state was updated on Seam and will soon be applied to the ACS user on the [access control system](https://docs.seam.co/latest/capability-guides/access-systems).",
194
- )
195
-
196
- const acs_user_profile_modification = common_acs_user_modification
197
- .extend({
198
- modification_code: z.literal('profile'),
199
- })
200
- .describe(
201
- "Indicates that the [ACS user's](https://docs.seam.co/latest/capability-guides/access-systems/user-management) profile details (name, email, phone) were updated on Seam and will soon be applied to the ACS user on the [access control system](https://docs.seam.co/latest/capability-guides/access-systems).",
202
- )
203
-
204
- export const acs_user_unapplied_modification_map = z.object({
205
- suspension_state: acs_user_suspension_state_modification
206
- .optional()
207
- .nullable(),
208
- profile: acs_user_profile_modification.optional().nullable(),
209
- })
210
-
211
- export type AcsUserUnappliedModificationMap = z.infer<
212
- typeof acs_user_unapplied_modification_map
213
- >
214
-
215
180
  const user_fields = z.object({
216
181
  full_name: z
217
182
  .string()
@@ -70,6 +70,7 @@ export const THERMOSTAT_DEVICE_TYPE = {
70
70
  HONEYWELL_RESIDEO_THERMOSTAT: 'honeywell_resideo_thermostat',
71
71
  TADO_THERMOSTAT: 'tado_thermostat',
72
72
  SENSI_THERMOSTAT: 'sensi_thermostat',
73
+ SMARTTHINGS_THERMOSTAT: 'smartthings_thermostat',
73
74
  } as const
74
75
 
75
76
  type ThermostatDeviceTypeFromMapping =
@@ -1,25 +1,34 @@
1
1
  import { z } from 'zod'
2
2
 
3
- export const thermostat_daily_program_period = z.object({
4
- starts_at_time: z
5
- .string()
6
- .regex(/^([01]\d|2[0-3]):([0-5]\d):([0-5]\d)$/)
7
- .describe(
8
- 'Time at which the thermostat daily program entry starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.',
9
- ),
10
- climate_preset_key: z
11
- .string()
12
- .describe(
13
- 'Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to activate at the starts_at_time.',
14
- ),
15
- })
3
+ export const thermostat_daily_program_period = z
4
+ .object({
5
+ starts_at_time: z
6
+ .string()
7
+ .regex(/^([01]\d|2[0-3]):([0-5]\d):([0-5]\d)$/)
8
+ .describe(
9
+ 'Time at which the thermostat daily program period starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.',
10
+ ),
11
+ climate_preset_key: z
12
+ .string()
13
+ .describe(
14
+ 'Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to activate at the `starts_at_time`.',
15
+ ),
16
+ })
17
+ .describe(
18
+ 'Period for a thermostat daily program. Consists of a starts at time and the key that identifies the configured climate preset to apply at the starting time.',
19
+ )
16
20
 
17
21
  export const thermostat_daily_program = z.object({
18
22
  thermostat_daily_program_id: z
19
23
  .string()
20
24
  .uuid()
21
25
  .describe('ID of the thermostat daily program.'),
22
- device_id: z.string().uuid().describe('ID of the desired thermostat device.'),
26
+ device_id: z
27
+ .string()
28
+ .uuid()
29
+ .describe(
30
+ 'ID of the thermostat device on which the thermostat daily program is configured.',
31
+ ),
23
32
  name: z
24
33
  .string()
25
34
  .nullable()
@@ -39,7 +48,12 @@ export const thermostat_daily_program = z.object({
39
48
  .describe(
40
49
  'Date and time at which the thermostat daily program was created.',
41
50
  ),
42
- })
51
+ }).describe(`
52
+ ---
53
+ route_path: /thermostats/thermostat_daily_programs
54
+ ---
55
+ Represents a thermostat daily program, consisting of a set of periods, each of which has a starting time and the key that identifies the climate preset to apply at the starting time.
56
+ `)
43
57
 
44
58
  export const thermostat_weekly_program = z.object({
45
59
  monday_program_id: z