@seamapi/types 1.271.1 → 1.273.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;
             }>;
@@ -4955,6 +5000,7 @@ export interface Routes {
                         nest_device_id: string;
                         device_name: string;
                         custom_name: string;
+                        display_name?: string | undefined;
                     } | undefined;
                     ecobee_metadata?: {
                         ecobee_device_id: string;
@@ -8930,6 +8976,7 @@ export interface Routes {
                         nest_device_id: string;
                         device_name: string;
                         custom_name: string;
+                        display_name?: string | undefined;
                     } | undefined;
                     ecobee_metadata?: {
                         ecobee_device_id: string;
@@ -9395,6 +9442,7 @@ export interface Routes {
                         nest_device_id: string;
                         device_name: string;
                         custom_name: string;
+                        display_name?: string | undefined;
                     } | undefined;
                     ecobee_metadata?: {
                         ecobee_device_id: string;
@@ -10260,6 +10308,7 @@ export interface Routes {
                         nest_device_id: string;
                         device_name: string;
                         custom_name: string;
+                        display_name?: string | undefined;
                     } | undefined;
                     ecobee_metadata?: {
                         ecobee_device_id: string;
@@ -10700,6 +10749,7 @@ export interface Routes {
                         nest_device_id: string;
                         device_name: string;
                         custom_name: string;
+                        display_name?: string | undefined;
                     } | undefined;
                     ecobee_metadata?: {
                         ecobee_device_id: string;
@@ -11165,6 +11215,7 @@ export interface Routes {
                         nest_device_id: string;
                         device_name: string;
                         custom_name: string;
+                        display_name?: string | undefined;
                     } | undefined;
                     ecobee_metadata?: {
                         ecobee_device_id: string;
@@ -11605,6 +11656,7 @@ export interface Routes {
                         nest_device_id: string;
                         device_name: string;
                         custom_name: string;
+                        display_name?: string | undefined;
                     } | undefined;
                     ecobee_metadata?: {
                         ecobee_device_id: string;
@@ -13390,6 +13442,7 @@ export interface Routes {
                         nest_device_id: string;
                         device_name: string;
                         custom_name: string;
+                        display_name?: string | undefined;
                     } | undefined;
                     ecobee_metadata?: {
                         ecobee_device_id: string;
@@ -13830,6 +13883,7 @@ export interface Routes {
                         nest_device_id: string;
                         device_name: string;
                         custom_name: string;
+                        display_name?: string | undefined;
                     } | undefined;
                     ecobee_metadata?: {
                         ecobee_device_id: string;
@@ -17778,6 +17832,7 @@ export interface Routes {
                         nest_device_id: string;
                         device_name: string;
                         custom_name: string;
+                        display_name?: string | undefined;
                     } | undefined;
                     ecobee_metadata?: {
                         ecobee_device_id: string;
@@ -19535,6 +19590,7 @@ export interface Routes {
                         nest_device_id: string;
                         device_name: string;
                         custom_name: string;
+                        display_name?: string | undefined;
                     } | undefined;
                     ecobee_metadata?: {
                         ecobee_device_id: string;
@@ -19975,6 +20031,7 @@ export interface Routes {
                         nest_device_id: string;
                         device_name: string;
                         custom_name: string;
+                        display_name?: string | undefined;
                     } | undefined;
                     ecobee_metadata?: {
                         ecobee_device_id: string;
@@ -22033,6 +22090,7 @@ export interface Routes {
                         nest_device_id: string;
                         device_name: string;
                         custom_name: string;
+                        display_name?: string | undefined;
                     } | undefined;
                     ecobee_metadata?: {
                         ecobee_device_id: string;
@@ -22475,6 +22533,7 @@ export interface Routes {
                         nest_device_id: string;
                         device_name: string;
                         custom_name: string;
+                        display_name?: string | undefined;
                     } | undefined;
                     ecobee_metadata?: {
                         ecobee_device_id: string;

package/package.json

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

@@ -188,6 +188,7 @@ export const device_metadata = z
       nest_device_id: z.string(),
       device_name: z.string(), // set by Google
       custom_name: z.string(), // set by device owner
+      display_name: z.string().optional(),
     }),
 
     ecobee_metadata: z.object({