@seamapi/types 1.406.7 → 1.406.9

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

@@ -3725,6 +3725,7 @@ export interface Routes {
         queryParams: {};
         jsonBody: {};
         commonParams: {
+            customer_ids?: string[] | undefined;
             /** ID of the device for which you want to list access codes. Specify either `device_id` or `access_code_ids`. */
             device_id?: string | undefined;
             /** IDs of the access codes that you want to retrieve. Specify either `device_id` or `access_code_ids`. */
@@ -8905,6 +8906,8 @@ export interface Routes {
                 acs_system_id: string;
                 /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the access group. */
                 workspace_id: string;
+                /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) that contains the access group. */
+                connected_account_id: string;
                 /** Name of the access group. */
                 name: string;
                 /**
@@ -8955,6 +8958,8 @@ export interface Routes {
                 acs_system_id: string;
                 /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the access group. */
                 workspace_id: string;
+                /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) that contains the access group. */
+                connected_account_id: string;
                 /** Name of the access group. */
                 name: string;
                 /**
@@ -9292,6 +9297,8 @@ export interface Routes {
                 acs_system_id: string;
                 /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the access group. */
                 workspace_id: string;
+                /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) that contains the access group. */
+                connected_account_id: string;
                 /** Name of the access group. */
                 name: string;
                 /**
@@ -9340,6 +9347,8 @@ export interface Routes {
                 acs_system_id: string;
                 /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the access group. */
                 workspace_id: string;
+                /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) that contains the access group. */
+                connected_account_id: string;
                 /** Name of the access group. */
                 name: string;
                 /**
@@ -13032,6 +13041,8 @@ export interface Routes {
                 acs_encoder_id: string;
                 /** ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners). */
                 acs_system_id: string;
+                /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) that contains the [encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners). */
+                connected_account_id: string;
                 /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the [encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners). */
                 workspace_id: string;
                 /** Errors associated with the [encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners). */
@@ -13078,6 +13089,8 @@ export interface Routes {
                 acs_encoder_id: string;
                 /** ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners). */
                 acs_system_id: string;
+                /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) that contains the [encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners). */
+                connected_account_id: string;
                 /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the [encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners). */
                 workspace_id: string;
                 /** Errors associated with the [encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners). */
@@ -34848,11 +34861,11 @@ export interface Routes {
             connected_account_ids?: string[] | undefined;
             /** ID of the Connect Webview for which you want to list devices. */
             connect_webview_id?: string | undefined;
-            /** Device type by which to filter devices. */
+            /** Device type of the noise sensors that you want to list. */
             device_type?: ('noiseaware_activity_zone' | 'minut_sensor') | undefined;
-            /** Array of device types by which to filter devices. */
+            /** Device types of the noise sensors that you want to list. */
             device_types?: Array<'noiseaware_activity_zone' | 'minut_sensor'> | undefined;
-            /** Manufacturer by which to filter devices. */
+            /** Manufacturers of the noise sensors that you want to list. */
             manufacturer?: ('minut' | 'noiseaware') | undefined;
             /** Array of device IDs for which you want to list devices. */
             device_ids?: string[] | undefined;
@@ -37288,12 +37301,19 @@ export interface Routes {
         method: 'POST';
         queryParams: {};
         jsonBody: {
+            /** ID of the device for which you want to create a noise threshold. */
             device_id: string;
+            /**  */
             sync?: boolean;
+            /** Name of the new noise threshold. */
             name?: string | undefined;
+            /** Time at which the new noise threshold should become active daily. */
             starts_daily_at: string;
+            /** Time at which the new noise threshold should become inactive daily. */
             ends_daily_at: string;
+            /** Noise level in decibels for the new noise threshold. */
             noise_threshold_decibels?: number | undefined;
+            /** Noise level in Noiseaware Noise Risk Score (NRS) for the new noise threshold. This parameter is only relevant for [Noiseaware sensors](https://docs.seam.co/latest/device-and-system-integration-guides/noiseaware-sensors). */
             noise_threshold_nrs?: number | undefined;
         };
         commonParams: {};
@@ -38402,14 +38422,21 @@ export interface Routes {
                     message: string;
                 };
             };
-            /**  */
+            /** Represents a [noise threshold](https://docs.seam.co/latest/capability-guides/noise-sensors/configure-noise-threshold-settings) for a [noise sensor](https://docs.seam.co/latest/capability-guides/noise-sensors). Thresholds represent the limits of noise tolerated at a property, which can be customized for each hour of the day. Each device has its own default thresholds, but you can use the Seam API to modify them. */
             noise_threshold: {
+                /** Unique identifier for the noise threshold. */
                 noise_threshold_id: string;
+                /** Unique identifier for the device that contains the noise threshold. */
                 device_id: string;
+                /** Name of the noise threshold. */
                 name: string;
+                /** Noise level in Noiseaware Noise Risk Score (NRS) for the noise threshold. This parameter is only relevant for [Noiseaware sensors](https://docs.seam.co/latest/device-and-system-integration-guides/noiseaware-sensors). */
                 noise_threshold_nrs?: number | undefined;
+                /** Time at which the noise threshold should become active daily. */
                 starts_daily_at: string;
+                /** Time at which the noise threshold should become inactive daily. */
                 ends_daily_at: string;
+                /** Noise level in decibels for the noise threshold. */
                 noise_threshold_decibels: number;
             };
         };
@@ -38419,8 +38446,11 @@ export interface Routes {
         method: 'DELETE' | 'POST';
         queryParams: {};
         jsonBody: {
+            /** ID of the noise threshold that you want to delete. */
             noise_threshold_id: string;
+            /** ID of the device that contains the noise threshold that you want to delete. */
             device_id: string;
+            /**  */
             sync?: boolean;
         };
         commonParams: {};
@@ -39537,18 +39567,26 @@ export interface Routes {
         queryParams: {};
         jsonBody: {};
         commonParams: {
+            /** ID of the noise threshold that you want to get. */
             noise_threshold_id: string;
         };
         formData: {};
         jsonResponse: {
-            /**  */
+            /** Represents a [noise threshold](https://docs.seam.co/latest/capability-guides/noise-sensors/configure-noise-threshold-settings) for a [noise sensor](https://docs.seam.co/latest/capability-guides/noise-sensors). Thresholds represent the limits of noise tolerated at a property, which can be customized for each hour of the day. Each device has its own default thresholds, but you can use the Seam API to modify them. */
             noise_threshold: {
+                /** Unique identifier for the noise threshold. */
                 noise_threshold_id: string;
+                /** Unique identifier for the device that contains the noise threshold. */
                 device_id: string;
+                /** Name of the noise threshold. */
                 name: string;
+                /** Noise level in Noiseaware Noise Risk Score (NRS) for the noise threshold. This parameter is only relevant for [Noiseaware sensors](https://docs.seam.co/latest/device-and-system-integration-guides/noiseaware-sensors). */
                 noise_threshold_nrs?: number | undefined;
+                /** Time at which the noise threshold should become active daily. */
                 starts_daily_at: string;
+                /** Time at which the noise threshold should become inactive daily. */
                 ends_daily_at: string;
+                /** Noise level in decibels for the noise threshold. */
                 noise_threshold_decibels: number;
             };
         };
@@ -39559,18 +39597,27 @@ export interface Routes {
         queryParams: {};
         jsonBody: {};
         commonParams: {
+            /** ID of the device for which you want to list noise thresholds. */
             device_id: string;
+            /** Enables you to limit the returned noise thresholds by whether they are programmed on the noise sensor. To list only noise thresholds that are programmed on the noise sensor, set this parameter to `true`. To list only noise thresholds that are not programmed on the noise sensor, se this parameter to `false`. */
             is_programmed?: boolean | undefined;
         };
         formData: {};
         jsonResponse: {
             noise_thresholds: Array<{
+                /** Unique identifier for the noise threshold. */
                 noise_threshold_id: string;
+                /** Unique identifier for the device that contains the noise threshold. */
                 device_id: string;
+                /** Name of the noise threshold. */
                 name: string;
+                /** Noise level in Noiseaware Noise Risk Score (NRS) for the noise threshold. This parameter is only relevant for [Noiseaware sensors](https://docs.seam.co/latest/device-and-system-integration-guides/noiseaware-sensors). */
                 noise_threshold_nrs?: number | undefined;
+                /** Time at which the noise threshold should become active daily. */
                 starts_daily_at: string;
+                /** Time at which the noise threshold should become inactive daily. */
                 ends_daily_at: string;
+                /** Noise level in decibels for the noise threshold. */
                 noise_threshold_decibels: number;
             }>;
         };
@@ -39580,13 +39627,21 @@ export interface Routes {
         method: 'PATCH' | 'POST' | 'PUT';
         queryParams: {};
         jsonBody: {
+            /** ID of the noise threshold that you want to update. */
             noise_threshold_id: string;
+            /** ID of the device that contains the noise threshold that you want to update. */
             device_id: string;
+            /**  */
             sync?: boolean;
+            /** Name of the noise threshold that you want to update. */
             name?: string | undefined;
+            /** Time at which the noise threshold should become active daily. */
             starts_daily_at?: string | undefined;
+            /** Time at which the noise threshold should become inactive daily. */
             ends_daily_at?: string | undefined;
+            /** Noise level in decibels for the noise threshold. */
             noise_threshold_decibels?: number | undefined;
+            /** Noise level in Noiseaware Noise Risk Score (NRS) for the noise threshold. This parameter is only relevant for [Noiseaware sensors](https://docs.seam.co/latest/device-and-system-integration-guides/noiseaware-sensors). */
             noise_threshold_nrs?: number | undefined;
         };
         commonParams: {};
@@ -40702,6 +40757,7 @@ export interface Routes {
         method: 'POST';
         queryParams: {};
         jsonBody: {
+            /** ID of the device for which you want to simulate the triggering of a noise threshold. */
             device_id: string;
         };
         commonParams: {};
@@ -41543,6 +41599,32 @@ export interface Routes {
             };
         };
     };
+    '/seam/partner/v1/building_blocks/spaces/auto_map': {
+        route: '/seam/partner/v1/building_blocks/spaces/auto_map';
+        method: 'GET' | 'POST';
+        queryParams: {};
+        jsonBody: {};
+        commonParams: {
+            collection_key: string;
+        };
+        formData: {};
+        jsonResponse: {
+            spaces: Array<{
+                name: string;
+                partner_resource_key: string;
+                devices: Array<{
+                    device_id: string;
+                    device_type: 'lock' | 'thermostat' | 'sensor';
+                    name: string;
+                }>;
+                acs_entrances: Array<{
+                    acs_entrance_id: string;
+                    name: string;
+                }>;
+                needs_review?: boolean | undefined;
+            }>;
+        };
+    };
     '/seam/partner/v1/resources/list': {
         route: '/seam/partner/v1/resources/list';
         method: 'GET' | 'POST';
@@ -56207,22 +56289,97 @@ export interface Routes {
             };
         };
     };
+    '/unstable_partner/building_blocks/connect_accounts': {
+        route: '/unstable_partner/building_blocks/connect_accounts';
+        method: 'POST';
+        queryParams: {};
+        jsonBody: {};
+        commonParams: {
+            customer_key: string;
+        };
+        formData: {};
+        jsonResponse: {
+            /**  */
+            magic_link: {
+                url: string;
+                building_block_type: 'connect_accounts' | 'manage_devices' | 'organize_spaces';
+                customer_key: string;
+                expires_at: string;
+                workspace_id: string;
+                created_at: string;
+            };
+        };
+    };
     '/unstable_partner/building_blocks/generate_magic_link': {
         route: '/unstable_partner/building_blocks/generate_magic_link';
         method: 'POST' | 'GET';
         queryParams: {};
         jsonBody: {};
         commonParams: {
-            building_block_type: 'connect_account' | 'manage_devices';
+            building_block_type: 'connect_accounts';
             customer_key: string;
+        } | {
+            building_block_type: 'manage_devices';
+            customer_key: string;
+        } | {
+            building_block_type: 'organize_spaces';
+            customer_key: string;
+            collection_key: string;
+        };
+        formData: {};
+        jsonResponse: {
+            /**  */
+            magic_link: {
+                url: string;
+                building_block_type: 'connect_accounts' | 'manage_devices' | 'organize_spaces';
+                customer_key: string;
+                expires_at: string;
+                workspace_id: string;
+                created_at: string;
+            };
+        };
+    };
+    '/unstable_partner/building_blocks/manage_devices': {
+        route: '/unstable_partner/building_blocks/manage_devices';
+        method: 'POST';
+        queryParams: {};
+        jsonBody: {};
+        commonParams: {
+            customer_key: string;
+        };
+        formData: {};
+        jsonResponse: {
+            /**  */
+            magic_link: {
+                url: string;
+                building_block_type: 'connect_accounts' | 'manage_devices' | 'organize_spaces';
+                customer_key: string;
+                expires_at: string;
+                workspace_id: string;
+                created_at: string;
+            };
+        };
+    };
+    '/unstable_partner/building_blocks/organize_spaces': {
+        route: '/unstable_partner/building_blocks/organize_spaces';
+        method: 'POST';
+        queryParams: {};
+        jsonBody: {};
+        commonParams: {
+            customer_key: string;
+            partner_resources: Array<{
+                partner_resource_key: string;
+                name: string;
+                description?: string | undefined;
+                custom_metadata?: Record<string, string> | undefined;
+            }>;
         };
         formData: {};
         jsonResponse: {
             /**  */
             magic_link: {
                 url: string;
-                building_block_type: 'connect_account' | 'manage_devices';
-                customer_id: string;
+                building_block_type: 'connect_accounts' | 'manage_devices' | 'organize_spaces';
                 customer_key: string;
                 expires_at: string;
                 workspace_id: string;

package/package.json

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

package/src/lib/seam/connect/internal/schemas.ts

@@ -21,6 +21,7 @@ export {
   bridge,
   bridge_client_session,
   bridge_connected_system,
+  building_block_type,
   capabilities,
   climate_preset,
   climate_setting,
@@ -55,6 +56,7 @@ export {
   thermostat_capability_properties,
   thermostat_device_type,
   thermostat_schedule,
+  typed_partner_resource,
   unmanaged_access_code,
   unmanaged_device,
   user_identity,

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

@@ -68,6 +68,12 @@ const common_acs_access_group = z.object({
     .describe(
       'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the access group.',
     ),
+  connected_account_id: z
+    .string()
+    .uuid()
+    .describe(
+      'ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) that contains the access group.',
+    ),
   name: z.string().describe('Name of the access group.'),
   access_group_type: acs_access_group_external_type.describe(`
     ---
@@ -104,7 +110,7 @@ export const acs_access_group = common_acs_access_group.extend({
     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.
-    
+
     Some access control systems use [access group](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups), which are sets of users, combined with sets of permissions. These permissions include both the set of areas or assets that the users can access and the schedule during which the users can access these areas or assets. Instead of assigning access rights individually to each access control system user, which can be time-consuming and error-prone, administrators can assign users to an access group, thereby ensuring that the users inherit all the permissions associated with the access group. Using access groups streamlines the process of managing large numbers of access control system users, especially in bigger organizations or complexes.
 
     To learn whether your access control system supports access groups, see the corresponding [system integration guide](https://docs.seam.co/latest/device-and-system-integration-guides/overview#access-control-systems).

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

@@ -46,6 +46,12 @@ export const acs_encoder = z.object({
     .describe(
       'ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners).',
     ),
+  connected_account_id: z
+    .string()
+    .uuid()
+    .describe(
+      'ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) that contains the [encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners).',
+    ),
   workspace_id: z
     .string()
     .uuid()

package/src/lib/seam/connect/models/noise-sensors/noise-threshold.ts

@@ -1,17 +1,39 @@
 import { z } from 'zod'
 
 export const noise_threshold = z.object({
-  noise_threshold_id: z.string().uuid(),
-  device_id: z.string().uuid(),
-  name: z.string(),
-  noise_threshold_nrs: z.number().optional(),
-  starts_daily_at: z.string(), // TODO: zoned_time
-  ends_daily_at: z.string(), // TODO: zoned_time
-  noise_threshold_decibels: z.number(),
+  noise_threshold_id: z
+    .string()
+    .uuid()
+    .describe('Unique identifier for the noise threshold.'),
+  device_id: z
+    .string()
+    .uuid()
+    .describe(
+      'Unique identifier for the device that contains the noise threshold.',
+    ),
+  name: z.string().describe('Name of the noise threshold.'),
+  noise_threshold_nrs: z
+    .number()
+    .optional()
+    .describe(
+      'Noise level in Noiseaware Noise Risk Score (NRS) for the noise threshold. This parameter is only relevant for [Noiseaware sensors](https://docs.seam.co/latest/device-and-system-integration-guides/noiseaware-sensors).',
+    ),
+  starts_daily_at: z
+    .string()
+    .describe('Time at which the noise threshold should become active daily.'), // TODO: zoned_time
+  ends_daily_at: z
+    .string()
+    .describe(
+      'Time at which the noise threshold should become inactive daily.',
+    ), // TODO: zoned_time
+  noise_threshold_decibels: z
+    .number()
+    .describe('Noise level in decibels for the noise threshold.'),
 }).describe(`
   ---
   route_path: /noise_sensors/noise_thresholds
   ---
+  Represents a [noise threshold](https://docs.seam.co/latest/capability-guides/noise-sensors/configure-noise-threshold-settings) for a [noise sensor](https://docs.seam.co/latest/capability-guides/noise-sensors). Thresholds represent the limits of noise tolerated at a property, which can be customized for each hour of the day. Each device has its own default thresholds, but you can use the Seam API to modify them.
 `)
 
 export type NoiseThreshold = z.infer<typeof noise_threshold>

package/src/lib/seam/connect/models/partner/magic-link.ts

@@ -1,9 +1,16 @@
 import { z } from 'zod'
 
+export const building_block_type = z.enum([
+  'connect_accounts',
+  'manage_devices',
+  'organize_spaces',
+])
+
+export type BuildingBlockType = z.infer<typeof building_block_type>
+
 export const magic_link = z.object({
   url: z.string().url(),
-  building_block_type: z.enum(['connect_account', 'manage_devices']),
-  customer_id: z.string().uuid(),
+  building_block_type,
   customer_key: z.string(),
   expires_at: z.string().datetime(),
   workspace_id: z.string().uuid(),

package/src/lib/seam/connect/models/partner/resources.ts

@@ -27,3 +27,16 @@ export const partner_resource = z.object({
   `)
 
 export type PartnerResource = z.infer<typeof partner_resource>
+
+export const typed_partner_resource = z.object({
+  partner_resource_key: z.string(),
+
+  name: z.string(),
+  description: z.string().optional(),
+  custom_metadata: z.record(z.string(), z.string()).optional(),
+}).describe(`
+  ---
+  undocumented: Unreleased.
+  route_path: /unstable_partner/resources
+  ---
+  `)