@seamapi/types 1.272.0 → 1.274.0

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

@@ -3204,7 +3204,9 @@ export interface Routes {
         queryParams: {};
         jsonBody: {};
         commonParams: {
+            /** ID of the desired access group. */
             acs_access_group_id: string;
+            /** ID of the desired user. */
             acs_user_id: string;
         };
         formData: {};
@@ -3216,14 +3218,24 @@ export interface Routes {
         queryParams: {};
         jsonBody: {};
         commonParams: {
+            /** ID of the desired access group. */
             acs_access_group_id: string;
         };
         formData: {};
         jsonResponse: {
+            /**
+              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).
+             */
             acs_access_group: {
+                /** ID of the access group. */
                 acs_access_group_id: string;
+                /** ID of the access control system that contains the access group. */
                 acs_system_id: string;
+                /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the access group. */
                 workspace_id: string;
+                /** Name of the access group. */
                 name: string;
                 /**
                  * @deprecated use external_type */
@@ -3232,8 +3244,11 @@ export interface Routes {
                  * @deprecated use external_type_display_name */
                 access_group_type_display_name: string;
                 display_name: string;
+                /** Brand-specific terminology for the access group type. */
                 external_type: 'pti_unit' | 'pti_access_level' | 'salto_access_group' | 'brivo_group';
+                /** Display name that corresponds to the brand-specific terminology for the access group type. */
                 external_type_display_name: string;
+                /** Date and time at which the access group was created. */
                 created_at: string;
                 is_managed: true;
             };
@@ -3245,15 +3260,21 @@ export interface Routes {
         queryParams: {};
         jsonBody: {};
         commonParams: {
+            /** ID of the access control system for which you want to retrieve all access groups. */
             acs_system_id?: string | undefined;
+            /** ID of the user for which you want to retrieve all access groups. */
             acs_user_id?: string | undefined;
         };
         formData: {};
         jsonResponse: {
             acs_access_groups: Array<{
+                /** ID of the access group. */
                 acs_access_group_id: string;
+                /** ID of the access control system that contains the access group. */
                 acs_system_id: string;
+                /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the access group. */
                 workspace_id: string;
+                /** Name of the access group. */
                 name: string;
                 /**
                  * @deprecated use external_type */
@@ -3262,8 +3283,11 @@ export interface Routes {
                  * @deprecated use external_type_display_name */
                 access_group_type_display_name: string;
                 display_name: string;
+                /** Brand-specific terminology for the access group type. */
                 external_type: 'pti_unit' | 'pti_access_level' | 'salto_access_group' | 'brivo_group';
+                /** Display name that corresponds to the brand-specific terminology for the access group type. */
                 external_type_display_name: string;
+                /** Date and time at which the access group was created. */
                 created_at: string;
                 is_managed: true;
             }>;
@@ -3275,6 +3299,7 @@ export interface Routes {
         queryParams: {};
         jsonBody: {};
         commonParams: {
+            /** ID of the access group for which you want to retrieve all accessible entrances. */
             acs_access_group_id: string;
         };
         formData: {};
@@ -3325,6 +3350,7 @@ export interface Routes {
         queryParams: {};
         jsonBody: {};
         commonParams: {
+            /** ID of the access group for which you want to retrieve all users. */
             acs_access_group_id: string;
         };
         formData: {};
@@ -3425,7 +3451,9 @@ export interface Routes {
         queryParams: {};
         jsonBody: {};
         commonParams: {
+            /** ID of the desired access group. */
             acs_access_group_id: string;
+            /** ID of the desired user. */
             acs_user_id: string;
         };
         formData: {};
@@ -3437,14 +3465,19 @@ export interface Routes {
         queryParams: {};
         jsonBody: {};
         commonParams: {
+            /** ID of the desired unmanaged access group. */
             acs_access_group_id: string;
         };
         formData: {};
         jsonResponse: {
             acs_access_group: {
+                /** ID of the access group. */
                 acs_access_group_id: string;
+                /** ID of the access control system that contains the access group. */
                 acs_system_id: string;
+                /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the access group. */
                 workspace_id: string;
+                /** Name of the access group. */
                 name: string;
                 /**
                  * @deprecated use external_type */
@@ -3453,8 +3486,11 @@ export interface Routes {
                  * @deprecated use external_type_display_name */
                 access_group_type_display_name: string;
                 display_name: string;
+                /** Brand-specific terminology for the access group type. */
                 external_type: 'pti_unit' | 'pti_access_level' | 'salto_access_group' | 'brivo_group';
+                /** Display name that corresponds to the brand-specific terminology for the access group type. */
                 external_type_display_name: string;
+                /** Date and time at which the access group was created. */
                 created_at: string;
                 is_managed: false;
             };
@@ -3466,15 +3502,21 @@ export interface Routes {
         queryParams: {};
         jsonBody: {};
         commonParams: {
+            /** ID of the access control system for which you want to retrieve all unmanaged access groups. */
             acs_system_id?: string | undefined;
+            /** ID of the user for which you want to retrieve all unmanaged access groups. */
             acs_user_id?: string | undefined;
         };
         formData: {};
         jsonResponse: {
             acs_access_groups: Array<{
+                /** ID of the access group. */
                 acs_access_group_id: string;
+                /** ID of the access control system that contains the access group. */
                 acs_system_id: string;
+                /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the access group. */
                 workspace_id: string;
+                /** Name of the access group. */
                 name: string;
                 /**
                  * @deprecated use external_type */
@@ -3483,8 +3525,11 @@ export interface Routes {
                  * @deprecated use external_type_display_name */
                 access_group_type_display_name: string;
                 display_name: string;
+                /** Brand-specific terminology for the access group type. */
                 external_type: 'pti_unit' | 'pti_access_level' | 'salto_access_group' | 'brivo_group';
+                /** Display name that corresponds to the brand-specific terminology for the access group type. */
                 external_type_display_name: string;
+                /** Date and time at which the access group was created. */
                 created_at: string;
                 is_managed: false;
             }>;
@@ -4855,6 +4900,10 @@ export interface Routes {
                         device_name: string;
                         model_number: string;
                     } | undefined;
+                    /**
+                          ---
+                          deprecated: Use `salto_ks_metadata ` instead.
+                           */
                     salto_metadata?: {
                         lock_id: string;
                         customer_reference: string;
@@ -4863,6 +4912,14 @@ export interface Routes {
                         locked_state: string;
                         model?: string | undefined;
                     } | undefined;
+                    salto_ks_metadata?: {
+                        lock_id: string;
+                        customer_reference: string;
+                        lock_type: string;
+                        battery_level: string;
+                        locked_state: string;
+                        model?: string | undefined;
+                    } | undefined;
                     genie_metadata?: {
                         device_name: string;
                         door_name: string;
@@ -8831,6 +8888,10 @@ export interface Routes {
                         device_name: string;
                         model_number: string;
                     } | undefined;
+                    /**
+                          ---
+                          deprecated: Use `salto_ks_metadata ` instead.
+                           */
                     salto_metadata?: {
                         lock_id: string;
                         customer_reference: string;
@@ -8839,6 +8900,14 @@ export interface Routes {
                         locked_state: string;
                         model?: string | undefined;
                     } | undefined;
+                    salto_ks_metadata?: {
+                        lock_id: string;
+                        customer_reference: string;
+                        lock_type: string;
+                        battery_level: string;
+                        locked_state: string;
+                        model?: string | undefined;
+                    } | undefined;
                     genie_metadata?: {
                         device_name: string;
                         door_name: string;
@@ -9297,6 +9366,10 @@ export interface Routes {
                         device_name: string;
                         model_number: string;
                     } | undefined;
+                    /**
+                          ---
+                          deprecated: Use `salto_ks_metadata ` instead.
+                           */
                     salto_metadata?: {
                         lock_id: string;
                         customer_reference: string;
@@ -9305,6 +9378,14 @@ export interface Routes {
                         locked_state: string;
                         model?: string | undefined;
                     } | undefined;
+                    salto_ks_metadata?: {
+                        lock_id: string;
+                        customer_reference: string;
+                        lock_type: string;
+                        battery_level: string;
+                        locked_state: string;
+                        model?: string | undefined;
+                    } | undefined;
                     genie_metadata?: {
                         device_name: string;
                         door_name: string;
@@ -10163,6 +10244,10 @@ export interface Routes {
                         device_name: string;
                         model_number: string;
                     } | undefined;
+                    /**
+                          ---
+                          deprecated: Use `salto_ks_metadata ` instead.
+                           */
                     salto_metadata?: {
                         lock_id: string;
                         customer_reference: string;
@@ -10171,6 +10256,14 @@ export interface Routes {
                         locked_state: string;
                         model?: string | undefined;
                     } | undefined;
+                    salto_ks_metadata?: {
+                        lock_id: string;
+                        customer_reference: string;
+                        lock_type: string;
+                        battery_level: string;
+                        locked_state: string;
+                        model?: string | undefined;
+                    } | undefined;
                     genie_metadata?: {
                         device_name: string;
                         door_name: string;
@@ -10604,6 +10697,10 @@ export interface Routes {
                         device_name: string;
                         model_number: string;
                     } | undefined;
+                    /**
+                          ---
+                          deprecated: Use `salto_ks_metadata ` instead.
+                           */
                     salto_metadata?: {
                         lock_id: string;
                         customer_reference: string;
@@ -10612,6 +10709,14 @@ export interface Routes {
                         locked_state: string;
                         model?: string | undefined;
                     } | undefined;
+                    salto_ks_metadata?: {
+                        lock_id: string;
+                        customer_reference: string;
+                        lock_type: string;
+                        battery_level: string;
+                        locked_state: string;
+                        model?: string | undefined;
+                    } | undefined;
                     genie_metadata?: {
                         device_name: string;
                         door_name: string;
@@ -11070,6 +11175,10 @@ export interface Routes {
                         device_name: string;
                         model_number: string;
                     } | undefined;
+                    /**
+                          ---
+                          deprecated: Use `salto_ks_metadata ` instead.
+                           */
                     salto_metadata?: {
                         lock_id: string;
                         customer_reference: string;
@@ -11078,6 +11187,14 @@ export interface Routes {
                         locked_state: string;
                         model?: string | undefined;
                     } | undefined;
+                    salto_ks_metadata?: {
+                        lock_id: string;
+                        customer_reference: string;
+                        lock_type: string;
+                        battery_level: string;
+                        locked_state: string;
+                        model?: string | undefined;
+                    } | undefined;
                     genie_metadata?: {
                         device_name: string;
                         door_name: string;
@@ -11511,6 +11628,10 @@ export interface Routes {
                         device_name: string;
                         model_number: string;
                     } | undefined;
+                    /**
+                          ---
+                          deprecated: Use `salto_ks_metadata ` instead.
+                           */
                     salto_metadata?: {
                         lock_id: string;
                         customer_reference: string;
@@ -11519,6 +11640,14 @@ export interface Routes {
                         locked_state: string;
                         model?: string | undefined;
                     } | undefined;
+                    salto_ks_metadata?: {
+                        lock_id: string;
+                        customer_reference: string;
+                        lock_type: string;
+                        battery_level: string;
+                        locked_state: string;
+                        model?: string | undefined;
+                    } | undefined;
                     genie_metadata?: {
                         device_name: string;
                         door_name: string;
@@ -13297,6 +13426,10 @@ export interface Routes {
                         device_name: string;
                         model_number: string;
                     } | undefined;
+                    /**
+                          ---
+                          deprecated: Use `salto_ks_metadata ` instead.
+                           */
                     salto_metadata?: {
                         lock_id: string;
                         customer_reference: string;
@@ -13305,6 +13438,14 @@ export interface Routes {
                         locked_state: string;
                         model?: string | undefined;
                     } | undefined;
+                    salto_ks_metadata?: {
+                        lock_id: string;
+                        customer_reference: string;
+                        lock_type: string;
+                        battery_level: string;
+                        locked_state: string;
+                        model?: string | undefined;
+                    } | undefined;
                     genie_metadata?: {
                         device_name: string;
                         door_name: string;
@@ -13738,6 +13879,10 @@ export interface Routes {
                         device_name: string;
                         model_number: string;
                     } | undefined;
+                    /**
+                          ---
+                          deprecated: Use `salto_ks_metadata ` instead.
+                           */
                     salto_metadata?: {
                         lock_id: string;
                         customer_reference: string;
@@ -13746,6 +13891,14 @@ export interface Routes {
                         locked_state: string;
                         model?: string | undefined;
                     } | undefined;
+                    salto_ks_metadata?: {
+                        lock_id: string;
+                        customer_reference: string;
+                        lock_type: string;
+                        battery_level: string;
+                        locked_state: string;
+                        model?: string | undefined;
+                    } | undefined;
                     genie_metadata?: {
                         device_name: string;
                         door_name: string;
@@ -17687,6 +17840,10 @@ export interface Routes {
                         device_name: string;
                         model_number: string;
                     } | undefined;
+                    /**
+                          ---
+                          deprecated: Use `salto_ks_metadata ` instead.
+                           */
                     salto_metadata?: {
                         lock_id: string;
                         customer_reference: string;
@@ -17695,6 +17852,14 @@ export interface Routes {
                         locked_state: string;
                         model?: string | undefined;
                     } | undefined;
+                    salto_ks_metadata?: {
+                        lock_id: string;
+                        customer_reference: string;
+                        lock_type: string;
+                        battery_level: string;
+                        locked_state: string;
+                        model?: string | undefined;
+                    } | undefined;
                     genie_metadata?: {
                         device_name: string;
                         door_name: string;
@@ -19445,6 +19610,10 @@ export interface Routes {
                         device_name: string;
                         model_number: string;
                     } | undefined;
+                    /**
+                          ---
+                          deprecated: Use `salto_ks_metadata ` instead.
+                           */
                     salto_metadata?: {
                         lock_id: string;
                         customer_reference: string;
@@ -19453,6 +19622,14 @@ export interface Routes {
                         locked_state: string;
                         model?: string | undefined;
                     } | undefined;
+                    salto_ks_metadata?: {
+                        lock_id: string;
+                        customer_reference: string;
+                        lock_type: string;
+                        battery_level: string;
+                        locked_state: string;
+                        model?: string | undefined;
+                    } | undefined;
                     genie_metadata?: {
                         device_name: string;
                         door_name: string;
@@ -19886,6 +20063,10 @@ export interface Routes {
                         device_name: string;
                         model_number: string;
                     } | undefined;
+                    /**
+                          ---
+                          deprecated: Use `salto_ks_metadata ` instead.
+                           */
                     salto_metadata?: {
                         lock_id: string;
                         customer_reference: string;
@@ -19894,6 +20075,14 @@ export interface Routes {
                         locked_state: string;
                         model?: string | undefined;
                     } | undefined;
+                    salto_ks_metadata?: {
+                        lock_id: string;
+                        customer_reference: string;
+                        lock_type: string;
+                        battery_level: string;
+                        locked_state: string;
+                        model?: string | undefined;
+                    } | undefined;
                     genie_metadata?: {
                         device_name: string;
                         door_name: string;
@@ -21945,6 +22134,10 @@ export interface Routes {
                         device_name: string;
                         model_number: string;
                     } | undefined;
+                    /**
+                          ---
+                          deprecated: Use `salto_ks_metadata ` instead.
+                           */
                     salto_metadata?: {
                         lock_id: string;
                         customer_reference: string;
@@ -21953,6 +22146,14 @@ export interface Routes {
                         locked_state: string;
                         model?: string | undefined;
                     } | undefined;
+                    salto_ks_metadata?: {
+                        lock_id: string;
+                        customer_reference: string;
+                        lock_type: string;
+                        battery_level: string;
+                        locked_state: string;
+                        model?: string | undefined;
+                    } | undefined;
                     genie_metadata?: {
                         device_name: string;
                         door_name: string;
@@ -22388,6 +22589,10 @@ export interface Routes {
                         device_name: string;
                         model_number: string;
                     } | undefined;
+                    /**
+                          ---
+                          deprecated: Use `salto_ks_metadata ` instead.
+                           */
                     salto_metadata?: {
                         lock_id: string;
                         customer_reference: string;
@@ -22396,6 +22601,14 @@ export interface Routes {
                         locked_state: string;
                         model?: string | undefined;
                     } | undefined;
+                    salto_ks_metadata?: {
+                        lock_id: string;
+                        customer_reference: string;
+                        lock_type: string;
+                        battery_level: string;
+                        locked_state: string;
+                        model?: string | undefined;
+                    } | undefined;
                     genie_metadata?: {
                         device_name: string;
                         door_name: string;

package/package.json

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

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

@@ -13,10 +13,20 @@ export type AcsAccessGroupExternalType = z.infer<
 >
 
 const common_acs_access_group = z.object({
-  acs_access_group_id: z.string().uuid(),
-  acs_system_id: z.string().uuid(),
-  workspace_id: z.string().uuid(),
-  name: z.string(),
+  acs_access_group_id: z.string().uuid().describe('ID of the access group.'),
+  acs_system_id: z
+    .string()
+    .uuid()
+    .describe(
+      'ID of the access control system that contains the access group.',
+    ),
+  workspace_id: z
+    .string()
+    .uuid()
+    .describe(
+      'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the access group.',
+    ),
+  name: z.string().describe('Name of the access group.'),
   access_group_type: acs_access_group_external_type.describe(`
     ---
     deprecated: use external_type
@@ -28,14 +38,27 @@ const common_acs_access_group = z.object({
     ---
     `),
   display_name: z.string(),
-  external_type: acs_access_group_external_type,
-  external_type_display_name: z.string(),
-  created_at: z.string().datetime(),
+  external_type: acs_access_group_external_type.describe(
+    'Brand-specific terminology for the access group type.',
+  ),
+  external_type_display_name: z
+    .string()
+    .describe(
+      'Display name that corresponds to the brand-specific terminology for the access group type.',
+    ),
+  created_at: z
+    .string()
+    .datetime()
+    .describe('Date and time at which the access group was created.'),
 })
 
 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).
+  `)
 export const unmanaged_acs_access_group = common_acs_access_group.extend({
   is_managed: z.literal(false),
 })

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

@@ -72,7 +72,6 @@ export const device_metadata = z
       device_name: z.string(),
       model_number: z.string(),
     }),
-
     salto_metadata: z.object({
       lock_id: z.string(),
       customer_reference: z.string(),
@@ -80,6 +79,17 @@ export const device_metadata = z
       battery_level: z.string(),
       locked_state: z.string(),
       model: z.string().optional(),
+    }).describe(`
+    ---
+    deprecated: Use \`salto_ks_metadata \` instead.
+    `),
+    salto_ks_metadata: z.object({
+      lock_id: z.string(),
+      customer_reference: z.string(),
+      lock_type: z.string(),
+      battery_level: z.string(),
+      locked_state: z.string(),
+      model: z.string().optional(),
     }),
 
     genie_metadata: z.object({