@seamapi/types 1.327.0 → 1.328.0

package/lib/seam/connect/route-types.d.ts

@@ -25,6 +25,7 @@ export interface Routes {
         commonParams: {};
         formData: {};
         jsonResponse: {
+            /**  */
             action_attempt: {
                 /** The ID of the action attempt. */
                 action_attempt_id: string;
@@ -817,6 +818,7 @@ export interface Routes {
                     message: string;
                 };
             };
+            /**  */
             access_code: {
                 /** Unique identifier for a group of access codes that share the same code. */
                 common_code_key: string | null;
@@ -1102,6 +1104,7 @@ export interface Routes {
         };
         formData: {};
         jsonResponse: {
+            /**  */
             action_attempt: {
                 /** The ID of the action attempt. */
                 action_attempt_id: string;
@@ -1924,6 +1927,7 @@ export interface Routes {
         };
         formData: {};
         jsonResponse: {
+            /**  */
             access_code: {
                 /** Unique identifier for a group of access codes that share the same code. */
                 common_code_key: string | null;
@@ -2194,6 +2198,7 @@ export interface Routes {
         commonParams: {};
         formData: {};
         jsonResponse: {
+            /**  */
             backup_access_code: {
                 /** Unique identifier for a group of access codes that share the same code. */
                 common_code_key: string | null;
@@ -2316,6 +2321,7 @@ export interface Routes {
                 /** 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. */
                 is_offline_access_code: boolean;
             };
+            /**  */
             access_code: {
                 /** Unique identifier for a group of access codes that share the same code. */
                 common_code_key: string | null;
@@ -2452,6 +2458,7 @@ export interface Routes {
         commonParams: {};
         formData: {};
         jsonResponse: {
+            /**  */
             access_code: {
                 /** Nature of the access code. Values are "ongoing" for access codes that are active continuously until deactivated manually or "time_bound" for access codes that have a specific duration. */
                 type: 'time_bound' | 'ongoing';
@@ -2580,6 +2587,7 @@ export interface Routes {
         };
         formData: {};
         jsonResponse: {
+            /**  */
             action_attempt: {
                 /** The ID of the action attempt. */
                 action_attempt_id: string;
@@ -3386,6 +3394,7 @@ export interface Routes {
         };
         formData: {};
         jsonResponse: {
+            /**  */
             access_code: {
                 /** Nature of the access code. Values are "ongoing" for access codes that are active continuously until deactivated manually or "time_bound" for access codes that have a specific duration. */
                 type: 'time_bound' | 'ongoing';
@@ -3644,6 +3653,7 @@ export interface Routes {
         commonParams: {};
         formData: {};
         jsonResponse: {
+            /**  */
             action_attempt: {
                 /** The ID of the action attempt. */
                 action_attempt_id: string;
@@ -4612,7 +4622,6 @@ export interface Routes {
                 } | undefined;
                 dormakaba_community_metadata?: {
                     access_point_name: string;
-                    common_area_number?: number | undefined;
                 } | undefined;
                 assa_abloy_vostio_metadata?: {
                     door_type: 'CommonDoor' | 'EntranceDoor' | 'GuestDoor' | 'Elevator';
@@ -4875,6 +4884,7 @@ export interface Routes {
         };
         formData: {};
         jsonResponse: {
+            /**  */
             acs_credential_provisioning_automation: {
                 acs_credential_provisioning_automation_id: string;
                 credential_manager_acs_system_id: string;
@@ -5556,7 +5566,6 @@ export interface Routes {
                 } | undefined;
                 dormakaba_community_metadata?: {
                     access_point_name: string;
-                    common_area_number?: number | undefined;
                 } | undefined;
                 assa_abloy_vostio_metadata?: {
                     door_type: 'CommonDoor' | 'EntranceDoor' | 'GuestDoor' | 'Elevator';
@@ -6037,6 +6046,7 @@ export interface Routes {
         };
         formData: {};
         jsonResponse: {
+            /**  */
             action_attempt: {
                 /** The ID of the action attempt. */
                 action_attempt_id: string;
@@ -6888,6 +6898,7 @@ export interface Routes {
         };
         formData: {};
         jsonResponse: {
+            /**  */
             action_attempt: {
                 /** The ID of the action attempt. */
                 action_attempt_id: string;
@@ -7811,7 +7822,6 @@ export interface Routes {
                 } | undefined;
                 dormakaba_community_metadata?: {
                     access_point_name: string;
-                    common_area_number?: number | undefined;
                 } | undefined;
                 assa_abloy_vostio_metadata?: {
                     door_type: 'CommonDoor' | 'EntranceDoor' | 'GuestDoor' | 'Elevator';
@@ -7890,7 +7900,6 @@ export interface Routes {
                 } | undefined;
                 dormakaba_community_metadata?: {
                     access_point_name: string;
-                    common_area_number?: number | undefined;
                 } | undefined;
                 assa_abloy_vostio_metadata?: {
                     door_type: 'CommonDoor' | 'EntranceDoor' | 'GuestDoor' | 'Elevator';
@@ -8809,7 +8818,6 @@ export interface Routes {
                 } | undefined;
                 dormakaba_community_metadata?: {
                     access_point_name: string;
-                    common_area_number?: number | undefined;
                 } | undefined;
                 assa_abloy_vostio_metadata?: {
                     door_type: 'CommonDoor' | 'EntranceDoor' | 'GuestDoor' | 'Elevator';
@@ -9122,6 +9130,7 @@ export interface Routes {
         };
         formData: {};
         jsonResponse: {
+            /**  */
             action_attempt: {
                 /** The ID of the action attempt. */
                 action_attempt_id: string;
@@ -10734,6 +10743,7 @@ export interface Routes {
         commonParams: {};
         formData: {};
         jsonResponse: {
+            /**  */
             client_session: {
                 client_session_id: string;
                 workspace_id: string;
@@ -10770,6 +10780,7 @@ export interface Routes {
         };
         formData: {};
         jsonResponse: {
+            /**  */
             client_session: {
                 client_session_id: string;
                 workspace_id: string;
@@ -10798,6 +10809,7 @@ export interface Routes {
         commonParams: {};
         formData: {};
         jsonResponse: {
+            /**  */
             client_session: {
                 client_session_id: string;
                 workspace_id: string;
@@ -10826,6 +10838,7 @@ export interface Routes {
         };
         formData: {};
         jsonResponse: {
+            /**  */
             client_session: {
                 client_session_id: string;
                 workspace_id: string;
@@ -10896,6 +10909,7 @@ export interface Routes {
         commonParams: {};
         formData: {};
         jsonResponse: {
+            /**  */
             connect_webview: {
                 connect_webview_id: string;
                 workspace_id: string;
@@ -10944,6 +10958,7 @@ export interface Routes {
         };
         formData: {};
         jsonResponse: {
+            /**  */
             connect_webview: {
                 connect_webview_id: string;
                 workspace_id: string;
@@ -11036,6 +11051,7 @@ export interface Routes {
         };
         formData: {};
         jsonResponse: {
+            /**  */
             connected_account: {
                 connected_account_id?: string | undefined;
                 created_at?: string | undefined;
@@ -11121,6 +11137,7 @@ export interface Routes {
         commonParams: {};
         formData: {};
         jsonResponse: {
+            /**  */
             connected_account: {
                 connected_account_id?: string | undefined;
                 created_at?: string | undefined;
@@ -11173,6 +11190,7 @@ export interface Routes {
         };
         formData: {};
         jsonResponse: {
+            /**  */
             device: {
                 /** Unique identifier for the device. */
                 device_id: string;
@@ -12447,6 +12465,7 @@ export interface Routes {
         };
         formData: {};
         jsonResponse: {
+            /**  */
             device: {
                 /** Unique identifier for the device. */
                 device_id: string;
@@ -12845,6 +12864,7 @@ export interface Routes {
         };
         formData: {};
         jsonResponse: {
+            /**  */
             event?: ({
                 /** ID of the event. */
                 event_id: string;
@@ -15188,6 +15208,7 @@ export interface Routes {
         };
         formData: {};
         jsonResponse: {
+            /**  */
             lock: {
                 /** Unique identifier for the device. */
                 device_id: string;
@@ -15769,6 +15790,7 @@ export interface Routes {
                 can_simulate_connection?: boolean | undefined;
                 can_simulate_disconnection?: boolean | undefined;
             };
+            /**  */
             device: {
                 /** Unique identifier for the device. */
                 device_id: string;
@@ -17562,6 +17584,7 @@ export interface Routes {
         commonParams: {};
         formData: {};
         jsonResponse: {
+            /**  */
             action_attempt: {
                 /** The ID of the action attempt. */
                 action_attempt_id: string;
@@ -18367,6 +18390,7 @@ export interface Routes {
         commonParams: {};
         formData: {};
         jsonResponse: {
+            /**  */
             action_attempt: {
                 /** The ID of the action attempt. */
                 action_attempt_id: string;
@@ -19171,6 +19195,7 @@ export interface Routes {
         };
         formData: {};
         jsonResponse: {
+            /**  */
             network: {
                 network_id: string;
                 workspace_id: string;
@@ -20410,6 +20435,7 @@ export interface Routes {
         commonParams: {};
         formData: {};
         jsonResponse: {
+            /**  */
             action_attempt: {
                 /** The ID of the action attempt. */
                 action_attempt_id: string;
@@ -21202,6 +21228,7 @@ export interface Routes {
                     message: string;
                 };
             };
+            /**  */
             noise_threshold: {
                 noise_threshold_id: string;
                 device_id: string;
@@ -21225,6 +21252,7 @@ export interface Routes {
         commonParams: {};
         formData: {};
         jsonResponse: {
+            /**  */
             action_attempt: {
                 /** The ID of the action attempt. */
                 action_attempt_id: string;
@@ -22029,6 +22057,7 @@ export interface Routes {
         };
         formData: {};
         jsonResponse: {
+            /**  */
             noise_threshold: {
                 noise_threshold_id: string;
                 device_id: string;
@@ -22079,6 +22108,7 @@ export interface Routes {
         commonParams: {};
         formData: {};
         jsonResponse: {
+            /**  */
             action_attempt: {
                 /** The ID of the action attempt. */
                 action_attempt_id: string;
@@ -23054,6 +23084,7 @@ export interface Routes {
         commonParams: {};
         formData: {};
         jsonResponse: {
+            /**  */
             phone: {
                 /** Unique identifier for the device. */
                 device_id: string;
@@ -23190,6 +23221,7 @@ export interface Routes {
         commonParams: {};
         formData: {};
         jsonResponse: {
+            /**  */
             action_attempt: {
                 /** The ID of the action attempt. */
                 action_attempt_id: string;
@@ -24001,6 +24033,7 @@ export interface Routes {
         commonParams: {};
         formData: {};
         jsonResponse: {
+            /**  */
             action_attempt: {
                 /** The ID of the action attempt. */
                 action_attempt_id: string;
@@ -24853,6 +24886,7 @@ export interface Routes {
         };
         formData: {};
         jsonResponse: {
+            /**  */
             thermostat: {
                 /** Unique identifier for the device. */
                 device_id: string;
@@ -25453,6 +25487,7 @@ export interface Routes {
         commonParams: {};
         formData: {};
         jsonResponse: {
+            /**  */
             action_attempt: {
                 /** The ID of the action attempt. */
                 action_attempt_id: string;
@@ -26268,6 +26303,7 @@ export interface Routes {
         commonParams: {};
         formData: {};
         jsonResponse: {
+            /**  */
             action_attempt: {
                 /** The ID of the action attempt. */
                 action_attempt_id: string;
@@ -28274,6 +28310,7 @@ export interface Routes {
         commonParams: {};
         formData: {};
         jsonResponse: {
+            /**  */
             action_attempt: {
                 /** The ID of the action attempt. */
                 action_attempt_id: string;
@@ -29265,6 +29302,7 @@ export interface Routes {
         commonParams: {};
         formData: {};
         jsonResponse: {
+            /**  */
             action_attempt: {
                 /** The ID of the action attempt. */
                 action_attempt_id: string;
@@ -30099,6 +30137,7 @@ export interface Routes {
         commonParams: {};
         formData: {};
         jsonResponse: {
+            /**  */
             action_attempt: {
                 /** The ID of the action attempt. */
                 action_attempt_id: string;
@@ -32637,6 +32676,7 @@ export interface Routes {
         commonParams: {};
         formData: {};
         jsonResponse: {
+            /**  */
             webhook: {
                 webhook_id: string;
                 url: string;
@@ -32666,6 +32706,7 @@ export interface Routes {
         };
         formData: {};
         jsonResponse: {
+            /**  */
             webhook: {
                 webhook_id: string;
                 url: string;
@@ -32720,6 +32761,7 @@ export interface Routes {
         commonParams: {};
         formData: {};
         jsonResponse: {
+            /**  */
             workspace: {
                 workspace_id: string;
                 name: string;
@@ -32739,6 +32781,7 @@ export interface Routes {
         commonParams: {};
         formData: {};
         jsonResponse: {
+            /**  */
             workspace: {
                 workspace_id: string;
                 name: string;
@@ -32777,6 +32820,7 @@ export interface Routes {
         commonParams: {};
         formData: {};
         jsonResponse: {
+            /**  */
             action_attempt: {
                 /** The ID of the action attempt. */
                 action_attempt_id: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@seamapi/types",
-  "version": "1.327.0",
+  "version": "1.328.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-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(