@seamapi/types 1.327.0 → 1.329.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@seamapi/types",
-  "version": "1.327.0",
+  "version": "1.329.0",
   "description": "TypeScript types for the Seam API.",
   "type": "module",
   "main": "index.js",

package/src/lib/seam/connect/models/access-codes/managed-access-code.ts

@@ -138,6 +138,10 @@ export const access_code = z.object({
     .describe(
       'Indicates whether the access code is intended for use in offline scenarios. If "true," this code can be created on a device without a network connection.',
     ),
-})
+}).describe(`
+  ---
+  route_path: /access_codes
+  ---
+`)
 
 export type AccessCode = z.infer<typeof access_code>

package/src/lib/seam/connect/models/access-codes/unmanaged-access-code.ts

@@ -19,6 +19,10 @@ export const unmanaged_access_code = access_code
   .extend({
     is_managed: z.literal(false),
     status: z.enum(['set']),
-  })
+  }).describe(`
+    ---
+    route_path: /access_codes/unmanaged
+    ---
+  `)
 
 export type UnmanagedAccessCode = z.infer<typeof unmanaged_access_code>

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

@@ -100,9 +100,13 @@ 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(`
+    ---
+    route_path: /acs/access_groups
+    ---
+    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),
 })

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

@@ -14,6 +14,10 @@ export const acs_credential_pool = z.object({
   external_type_display_name: z.string(),
   created_at: z.string().datetime(),
   workspace_id: z.string().uuid(),
-})
+}).describe(`
+  ---
+  route_path: /acs/credential_pools
+  ---
+`)
 
 export type AcsCredentialPool = z.output<typeof acs_credential_pool>

package/src/lib/seam/connect/models/acs/acs-credential-provisioning-automation.ts

@@ -6,42 +6,45 @@ export const acs_credential_provisioning_automation = z.object({
   user_identity_id: z.string().uuid(),
   created_at: z.string().datetime(),
   workspace_id: z.string().uuid(),
-})
+}).describe(`
+  ---
+  route_path: /acs/credential_provisioning_automations
+  ---
+`)
 
-export const enrollment_automation = z
-  .object({
-    enrollment_automation_id: z
-      .string()
-      .uuid()
-      .describe('ID of the enrollment automation.'),
-    credential_manager_acs_system_id: z
-      .string()
-      .uuid()
-      .describe(
-        'ID of the associated [ACS system](https://docs.seam.co/latest/capability-guides/access-systems) that serves as the credential manager.',
-      ),
-    user_identity_id: z
-      .string()
-      .uuid()
-      .describe(
-        'ID of the associated [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).',
-      ),
-    created_at: z
-      .string()
-      .datetime()
-      .describe(
-        'Date and time at which the enrollment automation was created.',
-      ),
-    workspace_id: z
-      .string()
-      .uuid()
-      .describe(
-        'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the enrollment automation.',
-      ),
-  })
-  .describe(
-    'Represents an [enrollment automation](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system) within the [Seam mobile access solution](https://docs.seam.co/latest/capability-guides/mobile-access-in-development).',
-  )
+export const enrollment_automation = z.object({
+  enrollment_automation_id: z
+    .string()
+    .uuid()
+    .describe('ID of the enrollment automation.'),
+  credential_manager_acs_system_id: z
+    .string()
+    .uuid()
+    .describe(
+      'ID of the associated [ACS system](https://docs.seam.co/latest/capability-guides/access-systems) that serves as the credential manager.',
+    ),
+  user_identity_id: z
+    .string()
+    .uuid()
+    .describe(
+      'ID of the associated [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).',
+    ),
+  created_at: z
+    .string()
+    .datetime()
+    .describe('Date and time at which the enrollment automation was created.'),
+  workspace_id: z
+    .string()
+    .uuid()
+    .describe(
+      'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the enrollment automation.',
+    ),
+}).describe(`
+  ---
+  route_path: /user_identities/enrollment_automations
+  ---
+  Represents an [enrollment automation](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system) within the [Seam mobile access solution](https://docs.seam.co/latest/capability-guides/mobile-access-in-development).
+`)
 
 export type EnrollmentAutomation = z.output<typeof enrollment_automation>
 

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

@@ -81,6 +81,16 @@ export const unknown_issue_with_acs_credential = common_acs_credential_warning
       'This issue may affect the proper functioning of this credential.',
   )
 
+const needs_to_be_reissued = common_acs_credential_warning
+  .extend({
+    warning_code: z
+      .literal('needs_to_be_reissued')
+      .describe(warning_code_description),
+  })
+  .describe(
+    'Access permissions for this [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) have changed. [Reissue](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners/creating-and-encoding-card-based-credentials) (re-encode) this credential. This issue may affect the proper functioning of the credential.',
+  )
+
 const acs_credential_warning = z
   .union([
     waiting_to_be_issued,
@@ -88,6 +98,7 @@ const acs_credential_warning = z
     schedule_modified,
     being_deleted,
     unknown_issue_with_acs_credential,
+    needs_to_be_reissued,
   ])
   .describe('Warning associated with the `acs_credential`.')
 
@@ -101,6 +112,7 @@ const acs_credential_warning_map = z.object({
   unknown_issue_with_acs_credential: unknown_issue_with_acs_credential
     .optional()
     .nullable(),
+  needs_to_be_reissued: needs_to_be_reissued.optional().nullable(),
 })
 
 export type AcsCredentialWarningMap = z.infer<typeof acs_credential_warning_map>

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

@@ -9,35 +9,36 @@ import {
 } from './metadata/index.js'
 import { acs_entrance_salto_space_metadata } from './metadata/salto-space.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(),
-    salto_space_metadata: acs_entrance_salto_space_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 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(),
+  salto_space_metadata: acs_entrance_salto_space_metadata.optional(),
+}).describe(`
+  ---
+  route_path: /acs/entrances
+  ---
+  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>

package/src/lib/seam/connect/models/acs/acs-system.ts

@@ -296,9 +296,11 @@ export const acs_system = z
       .array(acs_system_warning)
       .describe('Warnings associated with the `acs_system`.'),
   })
-  .merge(acs_system_capability_flags)
-  .describe(
-    'Represents an [access control system](https://docs.seam.co/latest/capability-guides/access-systems).',
-  )
+  .merge(acs_system_capability_flags).describe(`
+    ---
+    route_path: /acs/systems
+    ---
+    Represents an [access control system](https://docs.seam.co/latest/capability-guides/access-systems).
+  `)
 
 export type AcsSystem = z.output<typeof acs_system>

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

@@ -273,15 +273,16 @@ const common_acs_user = z
   })
   .merge(user_fields)
 
-export const acs_user = common_acs_user
-  .merge(
-    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 acs_user = common_acs_user.merge(
+  z.object({
+    is_managed: z.literal(true),
+  }),
+).describe(`
+    ---
+    route_path: /acs/users
+    ---
+    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(

package/src/lib/seam/connect/models/acs/metadata/dormakaba-community.ts

@@ -2,7 +2,6 @@ import { z } from 'zod'
 
 export const acs_entrance_dormakaba_community_metadata = z.object({
   access_point_name: z.string(),
-  common_area_number: z.number().optional(),
 })
 
 export type AcsEntranceDormakabaCommunityMetadata = z.infer<

package/src/lib/seam/connect/models/action-attempts/action-attempt.ts

@@ -20,6 +20,10 @@ export const action_attempt = z.union([
   ...set_hvac_mode_action_attempt.options,
   ...activate_climate_preset_action_attempt.options,
   ...deprecated_action_attempts,
-])
+]).describe(`
+  ---
+  route_path: /action_attempts
+  ---
+`)
 
 export type ActionAttempt = z.infer<typeof action_attempt>

package/src/lib/seam/connect/models/client-sessions/client-session.ts

@@ -11,6 +11,10 @@ export const client_session = z.object({
   connected_account_ids: z.array(z.string().uuid()),
   connect_webview_ids: z.array(z.string().uuid()),
   user_identity_ids: z.array(z.string().uuid()),
-})
+}).describe(`
+  ---
+  route_path: /client_sessions
+  ---
+`)
 
 export type ClientSession = z.infer<typeof client_session>

package/src/lib/seam/connect/models/connect-webviews/connect-webview.ts

@@ -44,6 +44,10 @@ export const connect_webview = z.object({
   wait_for_device_creation: z.boolean(),
   authorized_at: z.string().datetime().nullable(),
   selected_provider: z.string().nullable(),
-})
+}).describe(`
+  ---
+  route_path: /connect_webviews
+  ---
+`)
 
 export type ConnectWebview = z.infer<typeof connect_webview>

package/src/lib/seam/connect/models/connected-accounts/connected-account.ts

@@ -61,6 +61,10 @@ export const connected_account = z.object({
   warnings: z.array(connected_account_warning),
   custom_metadata,
   automatically_manage_new_devices: z.boolean(),
-})
+}).describe(`
+  ---
+  route_path: /connected_accounts
+  ---
+`)
 
 export type ConnectedAccount = z.infer<typeof connected_account>

package/src/lib/seam/connect/models/devices/device-provider.ts

@@ -133,6 +133,10 @@ export const device_provider = z
     image_url: z.string(),
     provider_categories: z.array(z.enum(PUBLIC_PROVIDER_CATEGORIES)),
   })
-  .extend(device_capability_flags.shape)
+  .extend(device_capability_flags.shape).describe(`
+    ---
+    route_path: /devices
+    ---
+  `)
 
 export type DeviceProvider = z.infer<typeof device_provider>

package/src/lib/seam/connect/models/devices/device.ts

@@ -370,6 +370,10 @@ export const device = z
       .describe('Indicates whether Seam manages the device.'),
     custom_metadata,
   })
-  .merge(device_capability_flags)
+  .merge(device_capability_flags).describe(`
+    ---
+    route_path: /devices
+    ---
+  `)
 
 export type Device = z.infer<typeof device>

package/src/lib/seam/connect/models/devices/phone.ts

@@ -12,4 +12,8 @@ export const phone = device
   .extend({
     device_type: z.enum(['android_phone', 'ios_phone']),
   })
-  .merge(z.object({ properties: phone_specific_properties }))
+  .merge(z.object({ properties: phone_specific_properties })).describe(`
+    ---
+    route_path: /phones
+    ---
+  `)

package/src/lib/seam/connect/models/devices/unmanaged-device.ts

@@ -34,6 +34,10 @@ export const unmanaged_device = device
       model: true,
     }),
   })
-  .merge(device_capability_flags)
+  .merge(device_capability_flags).describe(`
+    ---
+    route_path: /devices/unmanaged
+    ---
+  `)
 
 export type UnmanagedDevice = z.infer<typeof unmanaged_device>