@seamapi/types 1.327.0 → 1.329.0

package/src/lib/seam/connect/models/events/enrollment-automations.ts

@@ -11,13 +11,15 @@ const enrollment_automation_event = common_event.extend({
     ),
 })
 
-export const enrollment_automation_deleted_event = enrollment_automation_event
-  .extend({
+export const enrollment_automation_deleted_event =
+  enrollment_automation_event.extend({
     event_type: z.literal('enrollment_automation.deleted'),
-  })
-  .describe(
-    'An [enrollment automation](https://docs.seam.co/latest/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system#prepare-the-phones-for-a-user-identity-to-start-receiving-mobile-credentials-using-an-enrollment-aut) was deleted.',
-  )
+  }).describe(`
+    ---
+    route_path: /user_identities/enrollment_automations
+    ---
+    An [enrollment automation](https://docs.seam.co/latest/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system#prepare-the-phones-for-a-user-identity-to-start-receiving-mobile-credentials-using-an-enrollment-aut) was deleted.
+  `)
 
 export type EnrollmentAutomationDeletedEvent = z.infer<
   typeof enrollment_automation_deleted_event

package/src/lib/seam/connect/models/events/phones.ts

@@ -11,11 +11,14 @@ const phone_event = common_event.extend({
     ),
 })
 
-export const phone_deactivated_event = phone_event
-  .extend({
-    event_type: z.literal('phone.deactivated'),
-  })
-  .describe('A phone device was deactivated.')
+export const phone_deactivated_event = phone_event.extend({
+  event_type: z.literal('phone.deactivated'),
+}).describe(`
+    ---
+    route_path: /phones
+    ---
+    A phone device was deactivated.
+  `)
 
 export type PhoneDeactivatedEvent = z.infer<typeof phone_deactivated_event>
 

package/src/lib/seam/connect/models/events/seam-event.ts

@@ -20,7 +20,11 @@ export const seam_event = z.discriminatedUnion('event_type', [
   ...device_events,
   ...enrollment_automation_events,
   ...phone_events,
-])
+]).describe(`
+  ---
+  route_path: /events
+  ---
+`)
 
 export type SeamEvent = z.infer<typeof seam_event>
 

package/src/lib/seam/connect/models/noise-sensors/noise-threshold.ts

@@ -8,6 +8,10 @@ export const noise_threshold = z.object({
   starts_daily_at: z.string(), // TODO: zoned_time
   ends_daily_at: z.string(), // TODO: zoned_time
   noise_threshold_decibels: z.number(),
-})
+}).describe(`
+  ---
+  route_path: /noise_sensors/noise_thresholds
+  ---
+`)
 
 export type NoiseThreshold = z.infer<typeof noise_threshold>

package/src/lib/seam/connect/models/thermostats/thermostat-schedule.ts

@@ -1,70 +1,68 @@
 import { z } from 'zod'
 
-export const thermostat_schedule = z
-  .object({
-    thermostat_schedule_id: z
-      .string()
-      .uuid()
-      .describe('ID of the thermostat schedule.'),
-    device_id: z
-      .string()
-      .uuid()
-      .describe('ID of the desired thermostat device.'),
-    name: z
-      .string()
-      .optional()
-      .describe('User-friendly name to identify the thermostat schedule.'),
-    climate_preset_key: z
-      .string()
-      .describe(
-        'Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the thermostat schedule.',
-      ),
-    max_override_period_minutes: z
-      .number()
-      .int()
-      .nonnegative()
-      .describe(
-        "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).",
-      ),
-    starts_at: z
-      .string()
-      .datetime()
-      .describe(
-        'Date and time at which the thermostat schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.',
-      ),
-    unstable_is_override_allowed: z
-      .boolean()
-      .optional()
-      .describe(
-        `
+export const thermostat_schedule = z.object({
+  thermostat_schedule_id: z
+    .string()
+    .uuid()
+    .describe('ID of the thermostat schedule.'),
+  device_id: z.string().uuid().describe('ID of the desired thermostat device.'),
+  name: z
+    .string()
+    .optional()
+    .describe('User-friendly name to identify the thermostat schedule.'),
+  climate_preset_key: z
+    .string()
+    .describe(
+      'Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the thermostat schedule.',
+    ),
+  max_override_period_minutes: z
+    .number()
+    .int()
+    .nonnegative()
+    .describe(
+      "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).",
+    ),
+  starts_at: z
+    .string()
+    .datetime()
+    .describe(
+      'Date and time at which the thermostat schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.',
+    ),
+  unstable_is_override_allowed: z
+    .boolean()
+    .optional()
+    .describe(
+      `
         ---
         undocumented: Unstable
         ---
         Indicates whether a person at the thermostat can change the thermostat's settings.`,
-      ),
-    ends_at: z
-      .string()
-      .datetime()
-      .describe(
-        'Date and time at which the thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.',
-      ),
-    created_at: z
-      .string()
-      .datetime()
-      .describe('Date and time at which the thermostat schedule was created.'),
-    errors: z
-      .array(
-        z.object({
-          error_code: z.string(),
-          message: z.string(),
-        }),
-      )
-      .describe(
-        'Array of errors associated with the thermostat schedule. Each error object within the array contains two fields: `error_code` and `message`. `error_code` is a string that uniquely identifies the type of error, enabling quick recognition and categorization of the issue. `message` provides a more detailed description of the error, offering insights into the issue and potentially how to rectify it.',
-      ),
-  })
-  .describe(
-    'Represents a [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules) that activates a configured [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) on a [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) at a specified starting time and deactivates the climate preset at a specified ending time.',
-  )
+    ),
+  ends_at: z
+    .string()
+    .datetime()
+    .describe(
+      'Date and time at which the thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.',
+    ),
+  created_at: z
+    .string()
+    .datetime()
+    .describe('Date and time at which the thermostat schedule was created.'),
+  errors: z
+    .array(
+      z.object({
+        error_code: z.string(),
+        message: z.string(),
+      }),
+    )
+    .describe(
+      'Array of errors associated with the thermostat schedule. Each error object within the array contains two fields: `error_code` and `message`. `error_code` is a string that uniquely identifies the type of error, enabling quick recognition and categorization of the issue. `message` provides a more detailed description of the error, offering insights into the issue and potentially how to rectify it.',
+    ),
+}).describe(`
+  ---
+  route_path: /thermostats/schedules
+  ---
+  Represents a [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules) that activates a configured [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) on a [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) at a specified starting time and deactivates the climate preset at a specified ending time.
+`)
 
 export type ThermostatSchedule = z.infer<typeof thermostat_schedule>

package/src/lib/seam/connect/models/user-identities/user-identity.ts

@@ -2,39 +2,40 @@ import { z } from 'zod'
 
 import { phone_number } from '../phone-number.js'
 
-export const user_identity = z
-  .object({
-    user_identity_id: z.string().uuid().describe('ID of the user identity.'),
-    user_identity_key: z
-      .string()
-      .min(1)
-      .nullable()
-      .describe('Unique key for the user identity.'),
-    email_address: z
-      .string()
-      .email()
-      .nullable()
-      .describe('Unique email address for the user identity.'),
-    phone_number: phone_number
-      .nullable()
-      .describe(
-        'Unique phone number for the user identity in [E.164 format](https://www.itu.int/rec/T-REC-E.164/en) (for example, +15555550100).',
-      ),
-    display_name: z.string().min(1),
-    full_name: z.string().min(1).nullable(),
-    created_at: z
-      .string()
-      .datetime()
-      .describe('Date and time at which the user identity was created.'),
-    workspace_id: z
-      .string()
-      .uuid()
-      .describe(
-        'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the user identity.',
-      ),
-  })
-  .describe(
-    'Represents a [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) associated with an application user account.',
-  )
+export const user_identity = z.object({
+  user_identity_id: z.string().uuid().describe('ID of the user identity.'),
+  user_identity_key: z
+    .string()
+    .min(1)
+    .nullable()
+    .describe('Unique key for the user identity.'),
+  email_address: z
+    .string()
+    .email()
+    .nullable()
+    .describe('Unique email address for the user identity.'),
+  phone_number: phone_number
+    .nullable()
+    .describe(
+      'Unique phone number for the user identity in [E.164 format](https://www.itu.int/rec/T-REC-E.164/en) (for example, +15555550100).',
+    ),
+  display_name: z.string().min(1),
+  full_name: z.string().min(1).nullable(),
+  created_at: z
+    .string()
+    .datetime()
+    .describe('Date and time at which the user identity was created.'),
+  workspace_id: z
+    .string()
+    .uuid()
+    .describe(
+      'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the user identity.',
+    ),
+}).describe(`
+  ---
+  route_path: /user_identities
+  ---
+  Represents a [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) associated with an application user account.
+`)
 
 export type UserIdentity = z.output<typeof user_identity>

package/src/lib/seam/connect/models/webhooks/webhook.ts

@@ -5,6 +5,10 @@ export const webhook = z.object({
   url: z.string(),
   event_types: z.array(z.string()).optional(),
   secret: z.string().optional(),
-})
+}).describe(`
+  ---
+  route_path: /webhooks
+  ---
+`)
 
 export type Webhook = z.infer<typeof webhook>

package/src/lib/seam/connect/models/workspaces/workspace.ts

@@ -16,6 +16,10 @@ export const workspace = z.object({
   `,
     )
     .nullable(),
-})
+}).describe(`
+  ---
+  route_path: /workspaces
+  ---
+`)
 
 export type Workspace = z.infer<typeof workspace>