fix: Description typos (#1234)

Author: seambot

src/lib/seam/connect/models/acs/acs-access-group.ts

@@ -29,12 +29,12 @@ const common_acs_access_group = z.object({
   name: z.string().describe('Name of the access group.'),
   access_group_type: acs_access_group_external_type.describe(`
     ---
-    deprecated: use external_type
+    deprecated: Use \`external_type\`.
     ---
   `),
   access_group_type_display_name: z.string().describe(`
     ---
-    deprecated: use external_type_display_name
+    deprecated: Use \`external_type_display_name\`.
     ---
     `),
   display_name: z.string(),
@@ -54,11 +54,9 @@ const common_acs_access_group = z.object({
 
 export const acs_access_group = common_acs_access_group.extend({
   is_managed: z.literal(true),
-}).describe(`
-    Group that defines the entrances to which a set of users has access and, in some cases, the access schedule for these entrances and users.
-    
-    The \`acs_access_group\` object represents an [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups) within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems).
-  `)
+})
+  .describe(`Group that defines the entrances to which a set of users has access and, in some cases, the access schedule for these entrances and users.
+The \`acs_access_group\` object represents an [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups) within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems).`)
 export const unmanaged_acs_access_group = common_acs_access_group.extend({
   is_managed: z.literal(false),
 })

src/lib/seam/connect/models/acs/acs-credential.ts

@@ -144,10 +144,8 @@ function getAcsCredentialDescription(is_managed = true): string {
     : 'unmanaged_acs_credential'
   const management_clause = is_managed ? '' : ', which is not managed by Seam,'
 
-  return `
-      Means by which a user gains access at an entrance.
-
-      The \`${resource_name}\` object${management_clause} represents a credential that provides an ACS user access within an access control system. For each acs_credential object, you define the access method. You can also specify additional properties, such as a code.`.trim()
+  return `Means by which a user gains access at an entrance.
+The \`${resource_name}\` object${management_clause} represents a credential that provides an ACS user access within an access control system. For each acs_credential object, you define the access method. You can also specify additional properties, such as a code.`.trim()
 }
 
 export const acs_credential_on_encoder = z.object({

src/lib/seam/connect/models/acs/acs-entrance.ts

@@ -8,30 +8,34 @@ import {
   acs_entrance_visionline_metadata,
 } from './metadata/index.js'
 
-export const acs_entrance = z.object({
-  acs_system_id: z
-    .string()
-    .uuid()
-    .describe('ID of the access control system that contains the entrance.'),
-  acs_entrance_id: z.string().uuid().describe('ID of the entrance.'),
-  created_at: z
-    .string()
-    .datetime()
-    .describe('Date and time at which the entrance was created.'),
-  display_name: z.string().describe('Display name for the entrance.'),
-  errors: z.array(
-    z.object({
-      error_code: z.string(),
-      message: z.string(),
-    }),
-  ),
-  latch_metadata: acs_entrance_latch_metadata.optional(),
-  visionline_metadata: acs_entrance_visionline_metadata.optional(),
-  salto_ks_metadata: acs_entrance_salto_ks_metadata.optional(),
-  dormakaba_community_metadata:
-    acs_entrance_dormakaba_community_metadata.optional(),
-  assa_abloy_vostio_metadata:
-    acs_entrance_assa_abloy_vostio_metadata.optional(),
-})
+export const acs_entrance = z
+  .object({
+    acs_system_id: z
+      .string()
+      .uuid()
+      .describe('ID of the access control system that contains the entrance.'),
+    acs_entrance_id: z.string().uuid().describe('ID of the entrance.'),
+    created_at: z
+      .string()
+      .datetime()
+      .describe('Date and time at which the entrance was created.'),
+    display_name: z.string().describe('Display name for the entrance.'),
+    errors: z.array(
+      z.object({
+        error_code: z.string(),
+        message: z.string(),
+      }),
+    ),
+    latch_metadata: acs_entrance_latch_metadata.optional(),
+    visionline_metadata: acs_entrance_visionline_metadata.optional(),
+    salto_ks_metadata: acs_entrance_salto_ks_metadata.optional(),
+    dormakaba_community_metadata:
+      acs_entrance_dormakaba_community_metadata.optional(),
+    assa_abloy_vostio_metadata:
+      acs_entrance_assa_abloy_vostio_metadata.optional(),
+  })
+  .describe(
+    'Represents an [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems).',
+  )
 
 export type AcsEntrance = z.infer<typeof acs_entrance>

src/lib/seam/connect/models/acs/acs-user.ts

@@ -235,15 +235,23 @@ const common_acs_user = z
   .merge(user_fields)
 
 export const acs_user = common_acs_user.merge(
-  z.object({
-    is_managed: z.literal(true),
-  }),
+  z
+    .object({
+      is_managed: z.literal(true),
+    })
+    .describe(
+      'Represents a [user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in an [access control system](https://docs.seam.co/latest/capability-guides/access-systems).',
+    ),
 )
 
 export const unmanaged_acs_user = common_acs_user.merge(
-  z.object({
-    is_managed: z.literal(false),
-  }),
+  z
+    .object({
+      is_managed: z.literal(false),
+    })
+    .describe(
+      'Represents an unmanaged [user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) in an [access control system](https://docs.seam.co/latest/capability-guides/access-systems).',
+    ),
 )
 
 export type AcsUser = z.output<typeof acs_user>

src/lib/seam/connect/models/schedule.ts

@@ -1,8 +1,18 @@
 import { z } from 'zod'
 
 export const start_end_schedule = z.object({
-  starts_at: z.string().datetime(),
-  ends_at: z.string().datetime(),
+  starts_at: z
+    .string()
+    .datetime()
+    .describe(
+      "Date and time at which the user's access starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.",
+    ),
+  ends_at: z
+    .string()
+    .datetime()
+    .describe(
+      "Date and time at which the user's access ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.",
+    ),
 })
 
 // export const schedule = z.union([