@seamapi/types 1.128.0 → 1.130.0

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

@@ -2239,6 +2239,12 @@ export interface Routes {
           online: boolean
           /** Name of the device. Enables administrators and users to identify the device easily, especially when there are numerous devices. */
           name: string
+          /** Optional nickname to describe the device, settable through Seam. Enables administrators and users to identify the device easily, especially when there are numerous devices. */
+          nickname?: string | undefined
+          appearance: {
+            /** Name of the device as seen from the provider API and application, not settable through Seam. */
+            name: string
+          }
           model: {
             /** Display name of the device model. */
             display_name: string
@@ -3045,6 +3051,12 @@ export interface Routes {
           online: boolean
           /** Name of the device. Enables administrators and users to identify the device easily, especially when there are numerous devices. */
           name: string
+          /** Optional nickname to describe the device, settable through Seam. Enables administrators and users to identify the device easily, especially when there are numerous devices. */
+          nickname?: string | undefined
+          appearance: {
+            /** Name of the device as seen from the provider API and application, not settable through Seam. */
+            name: string
+          }
           model: {
             /** Display name of the device model. */
             display_name: string
@@ -4414,6 +4426,12 @@ export interface Routes {
           online: boolean
           /** Name of the device. Enables administrators and users to identify the device easily, especially when there are numerous devices. */
           name: string
+          /** Optional nickname to describe the device, settable through Seam. Enables administrators and users to identify the device easily, especially when there are numerous devices. */
+          nickname?: string | undefined
+          appearance: {
+            /** Name of the device as seen from the provider API and application, not settable through Seam. */
+            name: string
+          }
           model: {
             /** Display name of the device model. */
             display_name: string
@@ -5092,6 +5110,12 @@ export interface Routes {
           online: boolean
           /** Name of the device. Enables administrators and users to identify the device easily, especially when there are numerous devices. */
           name: string
+          /** Optional nickname to describe the device, settable through Seam. Enables administrators and users to identify the device easily, especially when there are numerous devices. */
+          nickname?: string | undefined
+          appearance: {
+            /** Name of the device as seen from the provider API and application, not settable through Seam. */
+            name: string
+          }
           model: {
             /** Display name of the device model. */
             display_name: string
@@ -5898,6 +5922,12 @@ export interface Routes {
           online: boolean
           /** Name of the device. Enables administrators and users to identify the device easily, especially when there are numerous devices. */
           name: string
+          /** Optional nickname to describe the device, settable through Seam. Enables administrators and users to identify the device easily, especially when there are numerous devices. */
+          nickname?: string | undefined
+          appearance: {
+            /** Name of the device as seen from the provider API and application, not settable through Seam. */
+            name: string
+          }
           model: {
             /** Display name of the device model. */
             display_name: string
@@ -6576,6 +6606,12 @@ export interface Routes {
           online: boolean
           /** Name of the device. Enables administrators and users to identify the device easily, especially when there are numerous devices. */
           name: string
+          /** Optional nickname to describe the device, settable through Seam. Enables administrators and users to identify the device easily, especially when there are numerous devices. */
+          nickname?: string | undefined
+          appearance: {
+            /** Name of the device as seen from the provider API and application, not settable through Seam. */
+            name: string
+          }
           model: {
             /** Display name of the device model. */
             display_name: string
@@ -7829,7 +7865,33 @@ export interface Routes {
     }
     commonParams: {}
     formData: {}
-    jsonResponse: {}
+    jsonResponse: {
+      action_attempt:
+        | {
+            status: 'success'
+            action_type: string
+            action_attempt_id: string
+            result?: any
+            error: null
+          }
+        | {
+            status: 'pending'
+            action_type: string
+            action_attempt_id: string
+            result: null
+            error: null
+          }
+        | {
+            status: 'error'
+            action_type: string
+            action_attempt_id: string
+            result: null
+            error: {
+              type: string
+              message: string
+            }
+          }
+    }
   }
   '/thermostats/get': {
     route: '/thermostats/get'
@@ -7893,6 +7955,12 @@ export interface Routes {
           online: boolean
           /** Name of the device. Enables administrators and users to identify the device easily, especially when there are numerous devices. */
           name: string
+          /** Optional nickname to describe the device, settable through Seam. Enables administrators and users to identify the device easily, especially when there are numerous devices. */
+          nickname?: string | undefined
+          appearance: {
+            /** Name of the device as seen from the provider API and application, not settable through Seam. */
+            name: string
+          }
           model: {
             /** Display name of the device model. */
             display_name: string
@@ -8534,7 +8602,33 @@ export interface Routes {
     }
     commonParams: {}
     formData: {}
-    jsonResponse: {}
+    jsonResponse: {
+      action_attempt:
+        | {
+            status: 'success'
+            action_type: string
+            action_attempt_id: string
+            result?: any
+            error: null
+          }
+        | {
+            status: 'pending'
+            action_type: string
+            action_attempt_id: string
+            result: null
+            error: null
+          }
+        | {
+            status: 'error'
+            action_type: string
+            action_attempt_id: string
+            result: null
+            error: {
+              type: string
+              message: string
+            }
+          }
+    }
   }
   '/thermostats/heat_cool': {
     route: '/thermostats/heat_cool'
@@ -8550,7 +8644,33 @@ export interface Routes {
     }
     commonParams: {}
     formData: {}
-    jsonResponse: {}
+    jsonResponse: {
+      action_attempt:
+        | {
+            status: 'success'
+            action_type: string
+            action_attempt_id: string
+            result?: any
+            error: null
+          }
+        | {
+            status: 'pending'
+            action_type: string
+            action_attempt_id: string
+            result: null
+            error: null
+          }
+        | {
+            status: 'error'
+            action_type: string
+            action_attempt_id: string
+            result: null
+            error: {
+              type: string
+              message: string
+            }
+          }
+    }
   }
   '/thermostats/list': {
     route: '/thermostats/list'
@@ -8729,6 +8849,12 @@ export interface Routes {
           online: boolean
           /** Name of the device. Enables administrators and users to identify the device easily, especially when there are numerous devices. */
           name: string
+          /** Optional nickname to describe the device, settable through Seam. Enables administrators and users to identify the device easily, especially when there are numerous devices. */
+          nickname?: string | undefined
+          appearance: {
+            /** Name of the device as seen from the provider API and application, not settable through Seam. */
+            name: string
+          }
           model: {
             /** Display name of the device model. */
             display_name: string
@@ -9368,7 +9494,33 @@ export interface Routes {
     }
     commonParams: {}
     formData: {}
-    jsonResponse: {}
+    jsonResponse: {
+      action_attempt:
+        | {
+            status: 'success'
+            action_type: string
+            action_attempt_id: string
+            result?: any
+            error: null
+          }
+        | {
+            status: 'pending'
+            action_type: string
+            action_attempt_id: string
+            result: null
+            error: null
+          }
+        | {
+            status: 'error'
+            action_type: string
+            action_attempt_id: string
+            result: null
+            error: {
+              type: string
+              message: string
+            }
+          }
+    }
   }
   '/thermostats/set_fan_mode': {
     route: '/thermostats/set_fan_mode'
@@ -9382,7 +9534,33 @@ export interface Routes {
     }
     commonParams: {}
     formData: {}
-    jsonResponse: {}
+    jsonResponse: {
+      action_attempt:
+        | {
+            status: 'success'
+            action_type: string
+            action_attempt_id: string
+            result?: any
+            error: null
+          }
+        | {
+            status: 'pending'
+            action_type: string
+            action_attempt_id: string
+            result: null
+            error: null
+          }
+        | {
+            status: 'error'
+            action_type: string
+            action_attempt_id: string
+            result: null
+            error: {
+              type: string
+              message: string
+            }
+          }
+    }
   }
   '/thermostats/update': {
     route: '/thermostats/update'
@@ -9647,6 +9825,12 @@ export interface Routes {
           online: boolean
           /** Name of the device. Enables administrators and users to identify the device easily, especially when there are numerous devices. */
           name: string
+          /** Optional nickname to describe the device, settable through Seam. Enables administrators and users to identify the device easily, especially when there are numerous devices. */
+          nickname?: string | undefined
+          appearance: {
+            /** Name of the device as seen from the provider API and application, not settable through Seam. */
+            name: string
+          }
           model: {
             /** Display name of the device model. */
             display_name: string

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

@@ -21,6 +21,19 @@ export const common_device_properties = z.object({
     .describe(
       'Name of the device. Enables administrators and users to identify the device easily, especially when there are numerous devices.',
     ),
+  nickname: z
+    .string()
+    .optional()
+    .describe(
+      'Optional nickname to describe the device, settable through Seam. Enables administrators and users to identify the device easily, especially when there are numerous devices.',
+    ),
+  appearance: z.object({
+    name: z
+      .string()
+      .describe(
+        'Name of the device as seen from the provider API and application, not settable through Seam.',
+      ),
+  }),
   model: z.object({
     display_name: z.string().describe('Display name of the device model.'),
     manufacturer_display_name: z