@seamapi/types 1.196.0 → 1.197.0

package/lib/seam/devicedb/models/manufacturer.d.ts

@@ -58,8 +58,8 @@ export declare const manufacturer: z.ZodObject<{
     seam_api_guide: z.ZodOptional<z.ZodString>;
     description: z.ZodOptional<z.ZodString>;
 }, "strip", z.ZodTypeAny, {
-    display_name: string;
     manufacturer_id: string;
+    display_name: string;
     integration: "beta" | "stable" | "planned" | "unsupported" | "inquire";
     integration_support_level: "beta" | "stable" | "planned" | "unsupported" | "inquire";
     is_connect_webview_supported: boolean;
@@ -86,8 +86,8 @@ export declare const manufacturer: z.ZodObject<{
     seam_api_guide?: string | undefined;
     description?: string | undefined;
 }, {
-    display_name: string;
     manufacturer_id: string;
+    display_name: string;
     integration: "beta" | "stable" | "planned" | "unsupported" | "inquire";
     integration_support_level: "beta" | "stable" | "planned" | "unsupported" | "inquire";
     is_connect_webview_supported: boolean;

package/lib/seam/devicedb/route-specs.d.ts

@@ -57,8 +57,8 @@ export declare const routes: {
                     seam_api_guide: z.ZodOptional<z.ZodString>;
                     description: z.ZodOptional<z.ZodString>;
                 }, "device_model_count">, "strip", z.ZodTypeAny, {
-                    display_name: string;
                     manufacturer_id: string;
+                    display_name: string;
                     integration: "beta" | "stable" | "planned" | "unsupported" | "inquire";
                     integration_support_level: "beta" | "stable" | "planned" | "unsupported" | "inquire";
                     is_connect_webview_supported: boolean;
@@ -84,8 +84,8 @@ export declare const routes: {
                     us_customer_support_contact_url?: string | undefined;
                     seam_api_guide?: string | undefined;
                 }, {
-                    display_name: string;
                     manufacturer_id: string;
+                    display_name: string;
                     integration: "beta" | "stable" | "planned" | "unsupported" | "inquire";
                     integration_support_level: "beta" | "stable" | "planned" | "unsupported" | "inquire";
                     is_connect_webview_supported: boolean;
@@ -214,8 +214,8 @@ export declare const routes: {
                 display_name: string;
                 device_model_id: string;
                 manufacturer: {
-                    display_name: string;
                     manufacturer_id: string;
+                    display_name: string;
                     integration: "beta" | "stable" | "planned" | "unsupported" | "inquire";
                     integration_support_level: "beta" | "stable" | "planned" | "unsupported" | "inquire";
                     is_connect_webview_supported: boolean;
@@ -274,8 +274,8 @@ export declare const routes: {
                 display_name: string;
                 device_model_id: string;
                 manufacturer: {
-                    display_name: string;
                     manufacturer_id: string;
+                    display_name: string;
                     integration: "beta" | "stable" | "planned" | "unsupported" | "inquire";
                     integration_support_level: "beta" | "stable" | "planned" | "unsupported" | "inquire";
                     is_connect_webview_supported: boolean;
@@ -575,8 +575,8 @@ export declare const routes: {
                 display_name: string;
                 device_model_id: string;
                 manufacturer: {
-                    display_name: string;
                     manufacturer_id: string;
+                    display_name: string;
                     integration: "beta" | "stable" | "planned" | "unsupported" | "inquire";
                     integration_support_level: "beta" | "stable" | "planned" | "unsupported" | "inquire";
                     is_connect_webview_supported: boolean;
@@ -652,8 +652,8 @@ export declare const routes: {
                 display_name: string;
                 device_model_id: string;
                 manufacturer: {
-                    display_name: string;
                     manufacturer_id: string;
+                    display_name: string;
                     integration: "beta" | "stable" | "planned" | "unsupported" | "inquire";
                     integration_support_level: "beta" | "stable" | "planned" | "unsupported" | "inquire";
                     is_connect_webview_supported: boolean;
@@ -720,8 +720,8 @@ export declare const routes: {
                 display_name: string;
                 device_model_id: string;
                 manufacturer: {
-                    display_name: string;
                     manufacturer_id: string;
+                    display_name: string;
                     integration: "beta" | "stable" | "planned" | "unsupported" | "inquire";
                     integration_support_level: "beta" | "stable" | "planned" | "unsupported" | "inquire";
                     is_connect_webview_supported: boolean;
@@ -794,8 +794,8 @@ export declare const routes: {
                 display_name: string;
                 device_model_id: string;
                 manufacturer: {
-                    display_name: string;
                     manufacturer_id: string;
+                    display_name: string;
                     integration: "beta" | "stable" | "planned" | "unsupported" | "inquire";
                     integration_support_level: "beta" | "stable" | "planned" | "unsupported" | "inquire";
                     is_connect_webview_supported: boolean;
@@ -856,8 +856,8 @@ export declare const routes: {
                 display_name: string;
                 device_model_id: string;
                 manufacturer: {
-                    display_name: string;
                     manufacturer_id: string;
+                    display_name: string;
                     integration: "beta" | "stable" | "planned" | "unsupported" | "inquire";
                     integration_support_level: "beta" | "stable" | "planned" | "unsupported" | "inquire";
                     is_connect_webview_supported: boolean;
@@ -930,8 +930,8 @@ export declare const routes: {
                 display_name: string;
                 device_model_id: string;
                 manufacturer: {
-                    display_name: string;
                     manufacturer_id: string;
+                    display_name: string;
                     integration: "beta" | "stable" | "planned" | "unsupported" | "inquire";
                     integration_support_level: "beta" | "stable" | "planned" | "unsupported" | "inquire";
                     is_connect_webview_supported: boolean;
@@ -994,8 +994,8 @@ export declare const routes: {
                 display_name: string;
                 device_model_id: string;
                 manufacturer: {
-                    display_name: string;
                     manufacturer_id: string;
+                    display_name: string;
                     integration: "beta" | "stable" | "planned" | "unsupported" | "inquire";
                     integration_support_level: "beta" | "stable" | "planned" | "unsupported" | "inquire";
                     is_connect_webview_supported: boolean;
@@ -1071,8 +1071,8 @@ export declare const routes: {
                 display_name: string;
                 device_model_id: string;
                 manufacturer: {
-                    display_name: string;
                     manufacturer_id: string;
+                    display_name: string;
                     integration: "beta" | "stable" | "planned" | "unsupported" | "inquire";
                     integration_support_level: "beta" | "stable" | "planned" | "unsupported" | "inquire";
                     is_connect_webview_supported: boolean;
@@ -1139,8 +1139,8 @@ export declare const routes: {
                 display_name: string;
                 device_model_id: string;
                 manufacturer: {
-                    display_name: string;
                     manufacturer_id: string;
+                    display_name: string;
                     integration: "beta" | "stable" | "planned" | "unsupported" | "inquire";
                     integration_support_level: "beta" | "stable" | "planned" | "unsupported" | "inquire";
                     is_connect_webview_supported: boolean;
@@ -1213,8 +1213,8 @@ export declare const routes: {
                 display_name: string;
                 device_model_id: string;
                 manufacturer: {
-                    display_name: string;
                     manufacturer_id: string;
+                    display_name: string;
                     integration: "beta" | "stable" | "planned" | "unsupported" | "inquire";
                     integration_support_level: "beta" | "stable" | "planned" | "unsupported" | "inquire";
                     is_connect_webview_supported: boolean;
@@ -1275,8 +1275,8 @@ export declare const routes: {
                 display_name: string;
                 device_model_id: string;
                 manufacturer: {
-                    display_name: string;
                     manufacturer_id: string;
+                    display_name: string;
                     integration: "beta" | "stable" | "planned" | "unsupported" | "inquire";
                     integration_support_level: "beta" | "stable" | "planned" | "unsupported" | "inquire";
                     is_connect_webview_supported: boolean;
@@ -1349,8 +1349,8 @@ export declare const routes: {
                 display_name: string;
                 device_model_id: string;
                 manufacturer: {
-                    display_name: string;
                     manufacturer_id: string;
+                    display_name: string;
                     integration: "beta" | "stable" | "planned" | "unsupported" | "inquire";
                     integration_support_level: "beta" | "stable" | "planned" | "unsupported" | "inquire";
                     is_connect_webview_supported: boolean;
@@ -1488,8 +1488,8 @@ export declare const routes: {
                     seam_api_guide: z.ZodOptional<z.ZodString>;
                     description: z.ZodOptional<z.ZodString>;
                 }, "device_model_count">, "strip", z.ZodTypeAny, {
-                    display_name: string;
                     manufacturer_id: string;
+                    display_name: string;
                     integration: "beta" | "stable" | "planned" | "unsupported" | "inquire";
                     integration_support_level: "beta" | "stable" | "planned" | "unsupported" | "inquire";
                     is_connect_webview_supported: boolean;
@@ -1515,8 +1515,8 @@ export declare const routes: {
                     us_customer_support_contact_url?: string | undefined;
                     seam_api_guide?: string | undefined;
                 }, {
-                    display_name: string;
                     manufacturer_id: string;
+                    display_name: string;
                     integration: "beta" | "stable" | "planned" | "unsupported" | "inquire";
                     integration_support_level: "beta" | "stable" | "planned" | "unsupported" | "inquire";
                     is_connect_webview_supported: boolean;
@@ -1645,8 +1645,8 @@ export declare const routes: {
                 display_name: string;
                 device_model_id: string;
                 manufacturer: {
-                    display_name: string;
                     manufacturer_id: string;
+                    display_name: string;
                     integration: "beta" | "stable" | "planned" | "unsupported" | "inquire";
                     integration_support_level: "beta" | "stable" | "planned" | "unsupported" | "inquire";
                     is_connect_webview_supported: boolean;
@@ -1705,8 +1705,8 @@ export declare const routes: {
                 display_name: string;
                 device_model_id: string;
                 manufacturer: {
-                    display_name: string;
                     manufacturer_id: string;
+                    display_name: string;
                     integration: "beta" | "stable" | "planned" | "unsupported" | "inquire";
                     integration_support_level: "beta" | "stable" | "planned" | "unsupported" | "inquire";
                     is_connect_webview_supported: boolean;
@@ -2006,8 +2006,8 @@ export declare const routes: {
                 display_name: string;
                 device_model_id: string;
                 manufacturer: {
-                    display_name: string;
                     manufacturer_id: string;
+                    display_name: string;
                     integration: "beta" | "stable" | "planned" | "unsupported" | "inquire";
                     integration_support_level: "beta" | "stable" | "planned" | "unsupported" | "inquire";
                     is_connect_webview_supported: boolean;
@@ -2125,8 +2125,8 @@ export declare const routes: {
                 display_name: string;
                 device_model_id: string;
                 manufacturer: {
-                    display_name: string;
                     manufacturer_id: string;
+                    display_name: string;
                     integration: "beta" | "stable" | "planned" | "unsupported" | "inquire";
                     integration_support_level: "beta" | "stable" | "planned" | "unsupported" | "inquire";
                     is_connect_webview_supported: boolean;
@@ -2295,8 +2295,8 @@ export declare const routes: {
                 seam_api_guide: z.ZodOptional<z.ZodString>;
                 description: z.ZodOptional<z.ZodString>;
             }, "strip", z.ZodTypeAny, {
-                display_name: string;
                 manufacturer_id: string;
+                display_name: string;
                 integration: "beta" | "stable" | "planned" | "unsupported" | "inquire";
                 integration_support_level: "beta" | "stable" | "planned" | "unsupported" | "inquire";
                 is_connect_webview_supported: boolean;
@@ -2323,8 +2323,8 @@ export declare const routes: {
                 seam_api_guide?: string | undefined;
                 description?: string | undefined;
             }, {
-                display_name: string;
                 manufacturer_id: string;
+                display_name: string;
                 integration: "beta" | "stable" | "planned" | "unsupported" | "inquire";
                 integration_support_level: "beta" | "stable" | "planned" | "unsupported" | "inquire";
                 is_connect_webview_supported: boolean;
@@ -2353,8 +2353,8 @@ export declare const routes: {
             }>;
         }, "strip", z.ZodTypeAny, {
             manufacturer: {
-                display_name: string;
                 manufacturer_id: string;
+                display_name: string;
                 integration: "beta" | "stable" | "planned" | "unsupported" | "inquire";
                 integration_support_level: "beta" | "stable" | "planned" | "unsupported" | "inquire";
                 is_connect_webview_supported: boolean;
@@ -2383,8 +2383,8 @@ export declare const routes: {
             };
         }, {
             manufacturer: {
-                display_name: string;
                 manufacturer_id: string;
+                display_name: string;
                 integration: "beta" | "stable" | "planned" | "unsupported" | "inquire";
                 integration_support_level: "beta" | "stable" | "planned" | "unsupported" | "inquire";
                 is_connect_webview_supported: boolean;
@@ -2475,8 +2475,8 @@ export declare const routes: {
                 seam_api_guide: z.ZodOptional<z.ZodString>;
                 description: z.ZodOptional<z.ZodString>;
             }, "strip", z.ZodTypeAny, {
-                display_name: string;
                 manufacturer_id: string;
+                display_name: string;
                 integration: "beta" | "stable" | "planned" | "unsupported" | "inquire";
                 integration_support_level: "beta" | "stable" | "planned" | "unsupported" | "inquire";
                 is_connect_webview_supported: boolean;
@@ -2503,8 +2503,8 @@ export declare const routes: {
                 seam_api_guide?: string | undefined;
                 description?: string | undefined;
             }, {
-                display_name: string;
                 manufacturer_id: string;
+                display_name: string;
                 integration: "beta" | "stable" | "planned" | "unsupported" | "inquire";
                 integration_support_level: "beta" | "stable" | "planned" | "unsupported" | "inquire";
                 is_connect_webview_supported: boolean;
@@ -2533,8 +2533,8 @@ export declare const routes: {
             }>, "many">;
         }, "strip", z.ZodTypeAny, {
             manufacturers: {
-                display_name: string;
                 manufacturer_id: string;
+                display_name: string;
                 integration: "beta" | "stable" | "planned" | "unsupported" | "inquire";
                 integration_support_level: "beta" | "stable" | "planned" | "unsupported" | "inquire";
                 is_connect_webview_supported: boolean;
@@ -2563,8 +2563,8 @@ export declare const routes: {
             }[];
         }, {
             manufacturers: {
-                display_name: string;
                 manufacturer_id: string;
+                display_name: string;
                 integration: "beta" | "stable" | "planned" | "unsupported" | "inquire";
                 integration_support_level: "beta" | "stable" | "planned" | "unsupported" | "inquire";
                 is_connect_webview_supported: boolean;

package/package.json

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

package/src/lib/seam/connect/model-types.ts

@@ -1,5 +1,7 @@
 export type {
   AccessCode,
+  AccessCodeError,
+  AccessCodeWarning,
   AcsAccessGroup,
   AcsCredential,
   AcsEntrance,
@@ -9,10 +11,14 @@ export type {
   ClientSession,
   ClimateSettingSchedule,
   ConnectedAccount,
+  ConnectedAccountError,
+  ConnectedAccountWarning,
   ConnectWebview,
   CustomMetadata,
   Device,
+  DeviceError,
   DeviceProvider,
+  DeviceWarning,
   NoiseThreshold,
   SeamEvent,
   SeamEventType,

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

@@ -1,5 +1,29 @@
 import { z } from 'zod'
 
+import { connected_account_error } from '../connected-accounts/index.js'
+import { device_error } from '../devices/index.js'
+
+const common_access_code_error = z.object({
+  message: z.string(),
+  is_access_code_error: z.literal(true),
+})
+
+const common_access_code_warning = z.object({
+  message: z.string(),
+})
+
+const access_code_error = common_access_code_error.extend({
+  error_code: z.string(),
+})
+
+export type AccessCodeError = z.infer<typeof access_code_error>
+
+const access_code_warning = common_access_code_warning.extend({
+  warning_code: z.string(),
+})
+
+export type AccessCodeWarning = z.infer<typeof access_code_warning>
+
 export const access_code = z.object({
   common_code_key: z
     .string()
@@ -51,12 +75,12 @@ export const access_code = z.object({
     .datetime()
     .describe('Date and time at which the access code was created.'),
   errors: z
-    .any()
+    .array(z.union([access_code_error, device_error, connected_account_error]))
     .describe(
       'Collection of errors associated with the access code, structured in a dictionary format. A unique "error_code" keys each error. Each error entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the error. "created_at" is a date that indicates when the error was generated. This structure enables detailed tracking and timely response to critical issues.',
     ),
   warnings: z
-    .any()
+    .array(access_code_warning)
     .describe(
       'Collection of warnings associated with the access code, structured in a dictionary format. A unique "warning_code" keys each warning. Each warning entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the warning. "created_at" is a date that indicates when the warning was generated. This structure enables detailed tracking and timely response to potential issues that are not critical but that may require attention.',
     ),

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

@@ -2,6 +2,27 @@ import { z } from 'zod'
 
 import { custom_metadata } from '../custom-metadata.js'
 
+const common_connected_account_error = z.object({
+  message: z.string(),
+  is_connected_account_error: z.literal(true),
+})
+
+const common_connected_account_warning = z.object({
+  message: z.string(),
+})
+
+export const connected_account_error = common_connected_account_error.extend({
+  error_code: z.string(),
+})
+
+export type ConnectedAccountError = z.infer<typeof connected_account_error>
+
+const connected_account_warning = common_connected_account_warning.extend({
+  warning_code: z.string(),
+})
+
+export type ConnectedAccountWarning = z.infer<typeof connected_account_warning>
+
 export const connected_account = z.object({
   connected_account_id: z.string().uuid().optional(),
   created_at: z.string().datetime().optional(),
@@ -16,8 +37,8 @@ export const connected_account = z.object({
     .optional(),
   account_type: z.string().optional(),
   account_type_display_name: z.string(),
-  errors: z.any(),
-  warnings: z.any(),
+  errors: z.array(connected_account_error),
+  warnings: z.array(connected_account_warning),
   custom_metadata,
   automatically_manage_new_devices: z.boolean(),
 })

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

@@ -2,6 +2,7 @@ import { z } from 'zod'
 
 import { schemas as devicedb_schemas } from '@seamapi/types/devicedb'
 
+import { connected_account_error } from '../connected-accounts/index.js'
 import { custom_metadata } from '../custom-metadata.js'
 import { capabilities } from './capabilities-supported.js'
 import { capability_properties } from './capability-properties/index.js'
@@ -20,6 +21,27 @@ export const battery_status = z.enum(['critical', 'low', 'good', 'full'])
 
 export type BatteryStatus = z.infer<typeof battery_status>
 
+const common_device_error = z.object({
+  message: z.string(),
+  is_device_error: z.literal(true),
+})
+
+const common_device_warning = z.object({
+  message: z.string(),
+})
+
+export const device_error = common_device_error.extend({
+  error_code: z.string(),
+})
+
+export type DeviceError = z.infer<typeof device_error>
+
+const device_warning = common_device_warning.extend({
+  warning_code: z.string(),
+})
+
+export type DeviceWarning = z.infer<typeof device_warning>
+
 export const common_device_properties = z.object({
   online: z.boolean().describe('Indicates whether the device is online.'),
   name: z.string().describe(`
@@ -215,22 +237,12 @@ export const device = z
         'Unique identifier for the Seam workspace associated with the device.',
       ),
     errors: z
-      .array(
-        z.object({
-          error_code: z.string(),
-          message: z.string(),
-        }),
-      )
+      .array(z.union([device_error, connected_account_error]))
       .describe(
         'Array of errors associated with the device. Each error object within the array contains two fields: "error_code" and "message." "error_code" is a string that uniquely identifies the type of error, enabling quick recognition and categorization of the issue. "message" provides a more detailed description of the error, offering insights into the issue and potentially how to rectify it.',
       ),
     warnings: z
-      .array(
-        z.object({
-          warning_code: z.string(),
-          message: z.string(),
-        }),
-      )
+      .array(device_warning)
       .describe(
         'Array of warnings associated with the device. Each warning object within the array contains two fields: "warning_code" and "message." "warning_code" is a string that uniquely identifies the type of warning, enabling quick recognition and categorization of the issue. "message" provides a more detailed description of the warning, offering insights into the issue and potentially how to rectify it.',
       ),

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

@@ -282,7 +282,11 @@ export type DeviceAccessoryKeypadDisconnectedEvent = z.infer<
 export const noise_sensor_noise_threshold_triggered_event = device_event
   .extend({
     event_type: z.literal('noise_sensor.noise_threshold_triggered'),
-    // TODO: import from ../devices
+    noise_level_decibels: z.number().optional(),
+    noise_level_nrs: z.number().optional(),
+    noise_threshold_id: z.string().uuid().optional(),
+    noise_threshold_name: z.string().optional(),
+    // TODO: remove metadata from this event
     noiseaware_metadata: z.record(z.unknown()).optional().describe(`
       ---
       title: Noiseaware Metadata