@seamapi/types 1.396.0 → 1.396.1

package/dist/connect.cjs

@@ -156,15 +156,19 @@ var climate_preset = zod.z.object({
 var climate_setting = climate_preset.partial();
 var thermostat_daily_program_period = zod.z.object({
   starts_at_time: zod.z.string().regex(/^([01]\d|2[0-3]):([0-5]\d):([0-5]\d)$/).describe(
-    "Time at which the thermostat daily program entry starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format."
+    "Time at which the thermostat daily program period starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format."
   ),
   climate_preset_key: zod.z.string().describe(
-    "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."
+    "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`."
   )
-});
+}).describe(
+  "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."
+);
 var thermostat_daily_program = zod.z.object({
   thermostat_daily_program_id: zod.z.string().uuid().describe("ID of the thermostat daily program."),
-  device_id: zod.z.string().uuid().describe("ID of the desired thermostat device."),
+  device_id: zod.z.string().uuid().describe(
+    "ID of the thermostat device on which the thermostat daily program is configured."
+  ),
   name: zod.z.string().nullable().describe("User-friendly name to identify the thermostat daily program."),
   periods: zod.z.array(thermostat_daily_program_period).describe("Array of thermostat daily program periods."),
   workspace_id: zod.z.string().uuid().describe(
@@ -173,7 +177,12 @@ var thermostat_daily_program = zod.z.object({
   created_at: zod.z.string().datetime().describe(
     "Date and time at which the thermostat daily program was created."
   )
-});
+}).describe(`
+  ---
+  route_path: /thermostats/thermostat_daily_programs
+  ---
+  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.
+`);
 var thermostat_weekly_program = zod.z.object({
   monday_program_id: zod.z.string().uuid().nullable().describe("ID of the thermostat daily program to run on Mondays."),
   tuesday_program_id: zod.z.string().uuid().nullable().describe("ID of the thermostat daily program to run on Tuesdays."),
@@ -2686,24 +2695,6 @@ var acs_users_warnings = zod.z.discriminatedUnion("warning_code", [
 ]).describe(
   "Warnings associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management)."
 );
-var common_acs_user_modification = zod.z.object({
-  created_at: zod.z.string().datetime().describe("Date and time at which this modification was requested."),
-  message: zod.z.string().describe("Detailed description of the modification.")
-});
-var acs_user_suspension_state_modification = common_acs_user_modification.extend({
-  modification_code: zod.z.literal("suspension_state")
-}).describe(
-  "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)."
-);
-var acs_user_profile_modification = common_acs_user_modification.extend({
-  modification_code: zod.z.literal("profile")
-}).describe(
-  "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)."
-);
-zod.z.object({
-  suspension_state: acs_user_suspension_state_modification.optional().nullable(),
-  profile: acs_user_profile_modification.optional().nullable()
-});
 var user_fields = zod.z.object({
   full_name: zod.z.string().trim().min(1).optional().describe(
     "Full name of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management)."
@@ -13035,6 +13026,7 @@ var openapi_default = {
                       },
                       thermostat_daily_programs: {
                         items: {
+                          description: "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.",
                           properties: {
                             created_at: {
                               description: "Date and time at which the thermostat daily program was created.",
@@ -13042,7 +13034,7 @@ var openapi_default = {
                               type: "string"
                             },
                             device_id: {
-                              description: "ID of the desired thermostat device.",
+                              description: "ID of the thermostat device on which the thermostat daily program is configured.",
                               format: "uuid",
                               type: "string"
                             },
@@ -13054,13 +13046,14 @@ var openapi_default = {
                             periods: {
                               description: "Array of thermostat daily program periods.",
                               items: {
+                                description: "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.",
                                 properties: {
                                   climate_preset_key: {
-                                    description: "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.",
+                                    description: "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`.",
                                     type: "string"
                                   },
                                   starts_at_time: {
-                                    description: "Time at which the thermostat daily program entry starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.",
+                                    description: "Time at which the thermostat daily program period starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.",
                                     pattern: "^([01]\\d|2[0-3]):([0-5]\\d):([0-5]\\d)$",
                                     type: "string"
                                   }
@@ -13092,7 +13085,8 @@ var openapi_default = {
                             "workspace_id",
                             "created_at"
                           ],
-                          type: "object"
+                          type: "object",
+                          "x-route-path": "/thermostats/thermostat_daily_programs"
                         },
                         type: "array"
                       },
@@ -32593,11 +32587,11 @@ var openapi_default = {
               schema: {
                 properties: {
                   climate_preset_key: {
-                    description: "Climate preset key of the desired climate preset.",
+                    description: "Climate preset key of the climate preset that you want to activate.",
                     type: "string"
                   },
                   device_id: {
-                    description: "ID of the desired thermostat device.",
+                    description: "ID of the thermostat device for which you want to activate a climate preset.",
                     format: "uuid",
                     type: "string"
                   }
@@ -32664,7 +32658,7 @@ var openapi_default = {
                     type: "number"
                   },
                   device_id: {
-                    description: "ID of the desired thermostat device.",
+                    description: "ID of the thermostat device that you want to set to cool mode.",
                     format: "uuid",
                     type: "string"
                   },
@@ -32741,7 +32735,7 @@ var openapi_default = {
                     type: "number"
                   },
                   device_id: {
-                    description: "ID of the desired thermostat device.",
+                    description: "ID of the thermostat device for which you want create a climate preset.",
                     format: "uuid",
                     type: "string"
                   },
@@ -32817,7 +32811,7 @@ var openapi_default = {
     },
     "/thermostats/daily_programs/create": {
       post: {
-        description: "Creates a thermostat daily program.",
+        description: "Creates a thermostat daily program. A daily program consists of a set of periods, where each period includes a start time and the key of a configured climate preset. Once you have defined a daily program, you can assign it to one or more days within a weekly program.",
         operationId: "thermostatsDailyProgramsCreatePost",
         requestBody: {
           content: {
@@ -32825,7 +32819,7 @@ var openapi_default = {
               schema: {
                 properties: {
                   device_id: {
-                    description: "ID of the desired thermostat device.",
+                    description: "ID of the thermostat device for which you want to create a daily program.",
                     format: "uuid",
                     type: "string"
                   },
@@ -32836,13 +32830,14 @@ var openapi_default = {
                   periods: {
                     description: "Array of thermostat daily program periods.",
                     items: {
+                      description: "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.",
                       properties: {
                         climate_preset_key: {
-                          description: "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.",
+                          description: "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`.",
                           type: "string"
                         },
                         starts_at_time: {
-                          description: "Time at which the thermostat daily program entry starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.",
+                          description: "Time at which the thermostat daily program period starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.",
                           pattern: "^([01]\\d|2[0-3]):([0-5]\\d):([0-5]\\d)$",
                           type: "string"
                         }
@@ -32867,6 +32862,7 @@ var openapi_default = {
                   properties: {
                     ok: { type: "boolean" },
                     thermostat_daily_program: {
+                      description: "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.",
                       properties: {
                         created_at: {
                           description: "Date and time at which the thermostat daily program was created.",
@@ -32874,7 +32870,7 @@ var openapi_default = {
                           type: "string"
                         },
                         device_id: {
-                          description: "ID of the desired thermostat device.",
+                          description: "ID of the thermostat device on which the thermostat daily program is configured.",
                           format: "uuid",
                           type: "string"
                         },
@@ -32886,13 +32882,14 @@ var openapi_default = {
                         periods: {
                           description: "Array of thermostat daily program periods.",
                           items: {
+                            description: "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.",
                             properties: {
                               climate_preset_key: {
-                                description: "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.",
+                                description: "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`.",
                                 type: "string"
                               },
                               starts_at_time: {
-                                description: "Time at which the thermostat daily program entry starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.",
+                                description: "Time at which the thermostat daily program period starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.",
                                 pattern: "^([01]\\d|2[0-3]):([0-5]\\d):([0-5]\\d)$",
                                 type: "string"
                               }
@@ -32921,7 +32918,8 @@ var openapi_default = {
                         "workspace_id",
                         "created_at"
                       ],
-                      type: "object"
+                      type: "object",
+                      "x-route-path": "/thermostats/thermostat_daily_programs"
                     }
                   },
                   required: ["thermostat_daily_program", "ok"],
@@ -32946,8 +32944,7 @@ var openapi_default = {
         "x-fern-sdk-method-name": "create",
         "x-fern-sdk-return-value": "thermostat_daily_program",
         "x-response-key": "thermostat_daily_program",
-        "x-title": "Create a Thermostat Daily Program",
-        "x-undocumented": "Unreleased."
+        "x-title": "Create a Thermostat Daily Program"
       }
     },
     "/thermostats/daily_programs/delete": {
@@ -32960,7 +32957,7 @@ var openapi_default = {
               schema: {
                 properties: {
                   thermostat_daily_program_id: {
-                    description: "ID of the desired thermostat schedule.",
+                    description: "ID of the thermostat daily program that you want to delete.",
                     format: "uuid",
                     type: "string"
                   }
@@ -32998,13 +32995,12 @@ var openapi_default = {
         "x-fern-sdk-group-name": ["thermostats", "daily_programs"],
         "x-fern-sdk-method-name": "delete",
         "x-response-key": null,
-        "x-title": "Delete a Thermostat Daily Program",
-        "x-undocumented": "Unreleased."
+        "x-title": "Delete a Thermostat Daily Program"
       }
     },
     "/thermostats/daily_programs/update": {
       patch: {
-        description: "Updates a specified thermostat daily program.",
+        description: "Updates a specified thermostat daily program. The periods that you specify overwrite any existing periods for the daily program.",
         operationId: "thermostatsDailyProgramsUpdatePatch",
         requestBody: {
           content: {
@@ -33012,19 +33008,20 @@ var openapi_default = {
               schema: {
                 properties: {
                   name: {
-                    description: "User-friendly name to identify the thermostat daily program.",
+                    description: "User-friendly name to identify the thermostat daily program that you want to update.",
                     type: "string"
                   },
                   periods: {
-                    description: "Array of thermostat daily program periods.",
+                    description: "Array of thermostat daily program periods. The periods that you specify overwrite any existing periods for the daily program.",
                     items: {
+                      description: "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.",
                       properties: {
                         climate_preset_key: {
-                          description: "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.",
+                          description: "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`.",
                           type: "string"
                         },
                         starts_at_time: {
-                          description: "Time at which the thermostat daily program entry starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.",
+                          description: "Time at which the thermostat daily program period starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.",
                           pattern: "^([01]\\d|2[0-3]):([0-5]\\d):([0-5]\\d)$",
                           type: "string"
                         }
@@ -33035,7 +33032,7 @@ var openapi_default = {
                     type: "array"
                   },
                   thermostat_daily_program_id: {
-                    description: "ID of the desired thermostat daily program.",
+                    description: "ID of the thermostat daily program that you want to update.",
                     format: "uuid",
                     type: "string"
                   }
@@ -33078,11 +33075,10 @@ var openapi_default = {
         "x-action-attempt-type": "PUSH_THERMOSTAT_PROGRAMS",
         "x-fern-ignore": true,
         "x-response-key": "action_attempt",
-        "x-title": "Update a Thermostat Daily Program",
-        "x-undocumented": "Unreleased."
+        "x-title": "Update a Thermostat Daily Program"
       },
       post: {
-        description: "Updates a specified thermostat daily program.",
+        description: "Updates a specified thermostat daily program. The periods that you specify overwrite any existing periods for the daily program.",
         operationId: "thermostatsDailyProgramsUpdatePost",
         requestBody: {
           content: {
@@ -33090,19 +33086,20 @@ var openapi_default = {
               schema: {
                 properties: {
                   name: {
-                    description: "User-friendly name to identify the thermostat daily program.",
+                    description: "User-friendly name to identify the thermostat daily program that you want to update.",
                     type: "string"
                   },
                   periods: {
-                    description: "Array of thermostat daily program periods.",
+                    description: "Array of thermostat daily program periods. The periods that you specify overwrite any existing periods for the daily program.",
                     items: {
+                      description: "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.",
                       properties: {
                         climate_preset_key: {
-                          description: "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.",
+                          description: "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`.",
                           type: "string"
                         },
                         starts_at_time: {
-                          description: "Time at which the thermostat daily program entry starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.",
+                          description: "Time at which the thermostat daily program period starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.",
                           pattern: "^([01]\\d|2[0-3]):([0-5]\\d):([0-5]\\d)$",
                           type: "string"
                         }
@@ -33113,7 +33110,7 @@ var openapi_default = {
                     type: "array"
                   },
                   thermostat_daily_program_id: {
-                    description: "ID of the desired thermostat daily program.",
+                    description: "ID of the thermostat daily program that you want to update.",
                     format: "uuid",
                     type: "string"
                   }
@@ -33158,8 +33155,7 @@ var openapi_default = {
         "x-fern-sdk-method-name": "update",
         "x-fern-sdk-return-value": "action_attempt",
         "x-response-key": "action_attempt",
-        "x-title": "Update a Thermostat Daily Program",
-        "x-undocumented": "Unreleased."
+        "x-title": "Update a Thermostat Daily Program"
       }
     },
     "/thermostats/delete_climate_preset": {
@@ -33172,11 +33168,11 @@ var openapi_default = {
               schema: {
                 properties: {
                   climate_preset_key: {
-                    description: "Climate preset key of the desired climate preset.",
+                    description: "Climate preset key of the climate preset that you want to delete.",
                     type: "string"
                   },
                   device_id: {
-                    description: "ID of the desired thermostat device.",
+                    description: "ID of the thermostat device for which you want to delete a climate preset.",
                     format: "uuid",
                     type: "string"
                   }
@@ -33227,12 +33223,12 @@ var openapi_default = {
               schema: {
                 properties: {
                   device_id: {
-                    description: "ID of the desired thermostat device.",
+                    description: "ID of the thermostat device that you want to retrieve.",
                     format: "uuid",
                     type: "string"
                   },
                   name: {
-                    description: "User-friendly name of the desired thermostat device.",
+                    description: "User-friendly name of the thermostat device that you want to retrieve.",
                     type: "string"
                   }
                 },
@@ -33287,7 +33283,7 @@ var openapi_default = {
               schema: {
                 properties: {
                   device_id: {
-                    description: "ID of the desired thermostat device.",
+                    description: "ID of the thermostat device that you want to set to heat mode.",
                     format: "uuid",
                     type: "string"
                   },
@@ -33370,7 +33366,7 @@ var openapi_default = {
                     type: "number"
                   },
                   device_id: {
-                    description: "ID of the desired thermostat device.",
+                    description: "ID of the thermostat device that you want to set to heat-cool mode.",
                     format: "uuid",
                     type: "string"
                   },
@@ -33479,7 +33475,7 @@ var openapi_default = {
                     type: "array"
                   },
                   device_type: {
-                    description: "Device type by which to filter devices.",
+                    description: "Device type by which to filter thermostat devices.",
                     enum: [
                       "ecobee_thermostat",
                       "nest_thermostat",
@@ -33490,7 +33486,7 @@ var openapi_default = {
                     type: "string"
                   },
                   device_types: {
-                    description: "Array of device types by which to filter devices.",
+                    description: "Array of device types by which to filter thermostat devices.",
                     items: {
                       enum: [
                         "ecobee_thermostat",
@@ -33550,7 +33546,7 @@ var openapi_default = {
                     type: "number"
                   },
                   manufacturer: {
-                    description: "Manufacturer by which to filter devices.",
+                    description: "Manufacturer by which to filter thermostat devices.",
                     enum: [
                       "ecobee",
                       "honeywell_resideo",
@@ -33632,7 +33628,7 @@ var openapi_default = {
               schema: {
                 properties: {
                   device_id: {
-                    description: "ID of the desired thermostat device.",
+                    description: "ID of the thermostat device that you want to set to off mode.",
                     format: "uuid",
                     type: "string"
                   },
@@ -34108,11 +34104,11 @@ var openapi_default = {
               schema: {
                 properties: {
                   climate_preset_key: {
-                    description: "Climate preset key of the desired climate preset.",
+                    description: "Climate preset key of the climate preset that you want to set as the fallback climate preset.",
                     type: "string"
                   },
                   device_id: {
-                    description: "ID of the desired thermostat device.",
+                    description: "ID of the thermostat device for which you want to set the fallback climate preset.",
                     format: "uuid",
                     type: "string"
                   }
@@ -34161,7 +34157,11 @@ var openapi_default = {
             "application/json": {
               schema: {
                 properties: {
-                  device_id: { format: "uuid", type: "string" },
+                  device_id: {
+                    description: "ID of the thermostat device for which you want to set the fan mode.",
+                    format: "uuid",
+                    type: "string"
+                  },
                   fan_mode: {
                     deprecated: true,
                     enum: ["auto", "on", "circulate"],
@@ -34235,7 +34235,7 @@ var openapi_default = {
                   {
                     properties: {
                       device_id: {
-                        description: "ID of the desired thermostat device.",
+                        description: "ID of the thermostat device for which you want to set the HVAC mode.",
                         format: "uuid",
                         type: "string"
                       },
@@ -34257,7 +34257,7 @@ var openapi_default = {
                         type: "number"
                       },
                       device_id: {
-                        description: "ID of the desired thermostat device.",
+                        description: "ID of the thermostat device for which you want to set the HVAC mode.",
                         format: "uuid",
                         type: "string"
                       },
@@ -34269,7 +34269,7 @@ var openapi_default = {
                   {
                     properties: {
                       device_id: {
-                        description: "ID of the desired thermostat device.",
+                        description: "ID of the thermostat device for which you want to set the HVAC mode.",
                         format: "uuid",
                         type: "string"
                       },
@@ -34301,7 +34301,7 @@ var openapi_default = {
                         type: "number"
                       },
                       device_id: {
-                        description: "ID of the desired thermostat device.",
+                        description: "ID of the thermostat device for which you want to set the HVAC mode.",
                         format: "uuid",
                         type: "string"
                       },
@@ -34375,7 +34375,7 @@ var openapi_default = {
               schema: {
                 properties: {
                   device_id: {
-                    description: "ID of the desired thermostat device.",
+                    description: "ID of the thermostat device for which you want to set a temperature threshold.",
                     format: "uuid",
                     type: "string"
                   },
@@ -34450,7 +34450,7 @@ var openapi_default = {
               schema: {
                 properties: {
                   device_id: {
-                    description: "ID of the desired thermostat device.",
+                    description: "ID of the thermostat device for which you want to set a temperature threshold.",
                     format: "uuid",
                     type: "string"
                   },
@@ -34750,7 +34750,7 @@ var openapi_default = {
                     type: "number"
                   },
                   device_id: {
-                    description: "ID of the desired thermostat device.",
+                    description: "ID of the thermostat device for which you want to update a climate preset.",
                     format: "uuid",
                     type: "string"
                   },
@@ -34848,7 +34848,7 @@ var openapi_default = {
                     type: "number"
                   },
                   device_id: {
-                    description: "ID of the desired thermostat device.",
+                    description: "ID of the thermostat device for which you want to update a climate preset.",
                     format: "uuid",
                     type: "string"
                   },
@@ -34927,7 +34927,7 @@ var openapi_default = {
     },
     "/thermostats/update_weekly_program": {
       post: {
-        description: "Activates a thermostat weekly program.",
+        description: "Updates the thermostat weekly program for a thermostat device. To configure a weekly program, specify the ID of the daily program that you want to use for each day of the week. When you update a weekly program, the set of programs that you specify overwrites any previous weekly program for the thermostat.",
         operationId: "thermostatsUpdateWeeklyProgramPost",
         requestBody: {
           content: {
@@ -34935,7 +34935,7 @@ var openapi_default = {
               schema: {
                 properties: {
                   device_id: {
-                    description: "ID of the thermostat device that the weekly program is for.",
+                    description: "ID of the thermostat device for which you want to update the weekly program.",
                     format: "uuid",
                     type: "string"
                   },
@@ -35022,8 +35022,7 @@ var openapi_default = {
         "x-fern-sdk-method-name": "update_weekly_program",
         "x-fern-sdk-return-value": "action_attempt",
         "x-response-key": "action_attempt",
-        "x-title": "Activate a Thermostat Weekly Program",
-        "x-undocumented": "Unreleased."
+        "x-title": "Update the Thermostat Weekly Program"
       }
     },
     "/unstable_access_grants/create": {