@seamapi/types 1.129.0 → 1.131.0

package/src/lib/seam/connect/openapi.ts

@@ -616,6 +616,11 @@ export default {
               { enum: ['ios_phone', 'android_phone'], type: 'string' },
             ],
           },
+          display_name: {
+            description:
+              'Display name of the device, defaults to nickname (if it is set) or properties.appearance.name otherwise. Enables administrators and users to identify the device easily, especially when there are numerous devices.',
+            type: 'string',
+          },
           errors: {
             description:
               '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.',
@@ -649,6 +654,11 @@ export default {
             },
             type: 'object',
           },
+          nickname: {
+            description:
+              'Optional nickname to describe the device, settable through Seam',
+            type: 'string',
+          },
           properties: {
             allOf: [
               {
@@ -657,6 +667,17 @@ export default {
                     allOf: [
                       {
                         properties: {
+                          appearance: {
+                            properties: {
+                              name: {
+                                description:
+                                  'Name of the device as seen from the provider API and application, not settable through Seam.',
+                                type: 'string',
+                              },
+                            },
+                            required: ['name'],
+                            type: 'object',
+                          },
                           battery: {
                             description:
                               'Represents the current status of the battery charge level. Values are "critical," which indicates an extremely low level, suggesting imminent shutdown or an urgent need for charging; "low," which signifies that the battery is under the preferred threshold and should be charged soon; "good," which denotes a satisfactory charge level, adequate for normal use without the immediate need for recharging; and "full," which represents a battery that is fully charged, providing the maximum duration of usage.',
@@ -731,7 +752,7 @@ export default {
                           },
                           name: {
                             description:
-                              'Name of the device. Enables administrators and users to identify the device easily, especially when there are numerous devices.',
+                              'Name of the device. Deprecated - use device.display_name instead',
                             type: 'string',
                           },
                           offline_access_codes_enabled: {
@@ -764,7 +785,7 @@ export default {
                             type: 'boolean',
                           },
                         },
-                        required: ['online', 'name', 'model'],
+                        required: ['online', 'name', 'appearance', 'model'],
                         type: 'object',
                       },
                       {
@@ -1710,6 +1731,7 @@ export default {
         required: [
           'device_id',
           'device_type',
+          'display_name',
           'capabilities_supported',
           'properties',
           'location',
@@ -1887,6 +1909,11 @@ export default {
             type: 'string',
           },
           device_type: { enum: ['android_phone', 'ios_phone'], type: 'string' },
+          display_name: {
+            description:
+              'Display name of the device, defaults to nickname (if it is set) or properties.appearance.name otherwise. Enables administrators and users to identify the device easily, especially when there are numerous devices.',
+            type: 'string',
+          },
           errors: {
             description:
               '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.',
@@ -1920,6 +1947,11 @@ export default {
             },
             type: 'object',
           },
+          nickname: {
+            description:
+              'Optional nickname to describe the device, settable through Seam',
+            type: 'string',
+          },
           properties: {
             properties: {
               assa_abloy_credential_service_metadata: {
@@ -1966,6 +1998,7 @@ export default {
         required: [
           'device_id',
           'device_type',
+          'display_name',
           'capabilities_supported',
           'properties',
           'location',
@@ -2228,7 +2261,7 @@ export default {
               },
               name: {
                 description:
-                  'Name of the device. Enables administrators and users to identify the device easily, especially when there are numerous devices.',
+                  'Name of the device. Deprecated - use device.display_name instead',
                 type: 'string',
               },
               offline_access_codes_enabled: {
@@ -9207,9 +9240,10 @@ export default {
           401: { description: 'Unauthorized' },
         },
         security: [
-          { access_token: [], seam_workspace: [] },
-          { seam_client_session_token: [] },
-          { client_session_token: [] },
+          { client_session: [] },
+          { pat_with_workspace: [] },
+          { console_session: [] },
+          { api_key: [] },
         ],
         summary: '/locks/unlock_door',
         tags: ['/locks'],

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

@@ -2224,6 +2224,10 @@ export interface Routes {
           | ('noiseaware_activity_zone' | 'minut_sensor')
           | ('ecobee_thermostat' | 'nest_thermostat' | 'honeywell_thermostat')
           | ('ios_phone' | 'android_phone')
+        /** Optional nickname to describe the device, settable through Seam */
+        nickname?: string | undefined
+        /** Display name of the device, defaults to nickname (if it is set) or properties.appearance.name otherwise. Enables administrators and users to identify the device easily, especially when there are numerous devices. */
+        display_name: string
         /** Collection of capabilities that the device supports when connected to Seam. Values are "access_code," which indicates that the device can manage and utilize digital PIN codes for secure access; "lock," which indicates that the device controls a door locking mechanism, enabling the remote opening and closing of doors and other entry points; "noise_detection," which indicates that the device supports monitoring and responding to ambient noise levels; "thermostat," which indicates that the device can regulate and adjust indoor temperatures; and "battery," which indicates that the device can manage battery life and health. */
         capabilities_supported: Array<
           | 'access_code'
@@ -2237,8 +2241,12 @@ export interface Routes {
         properties: (({
           /** Indicates whether the device is online. */
           online: boolean
-          /** Name of the device. Enables administrators and users to identify the device easily, especially when there are numerous devices. */
+          /** Name of the device. Deprecated - use device.display_name instead */
           name: string
+          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
@@ -3030,6 +3038,10 @@ export interface Routes {
           | ('noiseaware_activity_zone' | 'minut_sensor')
           | ('ecobee_thermostat' | 'nest_thermostat' | 'honeywell_thermostat')
           | ('ios_phone' | 'android_phone')
+        /** Optional nickname to describe the device, settable through Seam */
+        nickname?: string | undefined
+        /** Display name of the device, defaults to nickname (if it is set) or properties.appearance.name otherwise. Enables administrators and users to identify the device easily, especially when there are numerous devices. */
+        display_name: string
         /** Collection of capabilities that the device supports when connected to Seam. Values are "access_code," which indicates that the device can manage and utilize digital PIN codes for secure access; "lock," which indicates that the device controls a door locking mechanism, enabling the remote opening and closing of doors and other entry points; "noise_detection," which indicates that the device supports monitoring and responding to ambient noise levels; "thermostat," which indicates that the device can regulate and adjust indoor temperatures; and "battery," which indicates that the device can manage battery life and health. */
         capabilities_supported: Array<
           | 'access_code'
@@ -3043,8 +3055,12 @@ export interface Routes {
         properties: (({
           /** Indicates whether the device is online. */
           online: boolean
-          /** Name of the device. Enables administrators and users to identify the device easily, especially when there are numerous devices. */
+          /** Name of the device. Deprecated - use device.display_name instead */
           name: string
+          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
@@ -3816,7 +3832,7 @@ export interface Routes {
         created_at: string
         is_managed: false
         properties: {
-          /** Name of the device. Enables administrators and users to identify the device easily, especially when there are numerous devices. */
+          /** Name of the device. Deprecated - use device.display_name instead */
           name: string
           /** Indicates whether the device is online. */
           online: boolean
@@ -4046,7 +4062,7 @@ export interface Routes {
         created_at: string
         is_managed: false
         properties: {
-          /** Name of the device. Enables administrators and users to identify the device easily, especially when there are numerous devices. */
+          /** Name of the device. Deprecated - use device.display_name instead */
           name: string
           /** Indicates whether the device is online. */
           online: boolean
@@ -4399,6 +4415,10 @@ export interface Routes {
           | ('noiseaware_activity_zone' | 'minut_sensor')
           | ('ecobee_thermostat' | 'nest_thermostat' | 'honeywell_thermostat')
           | ('ios_phone' | 'android_phone')
+        /** Optional nickname to describe the device, settable through Seam */
+        nickname?: string | undefined
+        /** Display name of the device, defaults to nickname (if it is set) or properties.appearance.name otherwise. Enables administrators and users to identify the device easily, especially when there are numerous devices. */
+        display_name: string
         /** Collection of capabilities that the device supports when connected to Seam. Values are "access_code," which indicates that the device can manage and utilize digital PIN codes for secure access; "lock," which indicates that the device controls a door locking mechanism, enabling the remote opening and closing of doors and other entry points; "noise_detection," which indicates that the device supports monitoring and responding to ambient noise levels; "thermostat," which indicates that the device can regulate and adjust indoor temperatures; and "battery," which indicates that the device can manage battery life and health. */
         capabilities_supported: Array<
           | 'access_code'
@@ -4412,8 +4432,12 @@ export interface Routes {
         properties: (({
           /** Indicates whether the device is online. */
           online: boolean
-          /** Name of the device. Enables administrators and users to identify the device easily, especially when there are numerous devices. */
+          /** Name of the device. Deprecated - use device.display_name instead */
           name: string
+          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
@@ -5077,6 +5101,10 @@ export interface Routes {
           | ('noiseaware_activity_zone' | 'minut_sensor')
           | ('ecobee_thermostat' | 'nest_thermostat' | 'honeywell_thermostat')
           | ('ios_phone' | 'android_phone')
+        /** Optional nickname to describe the device, settable through Seam */
+        nickname?: string | undefined
+        /** Display name of the device, defaults to nickname (if it is set) or properties.appearance.name otherwise. Enables administrators and users to identify the device easily, especially when there are numerous devices. */
+        display_name: string
         /** Collection of capabilities that the device supports when connected to Seam. Values are "access_code," which indicates that the device can manage and utilize digital PIN codes for secure access; "lock," which indicates that the device controls a door locking mechanism, enabling the remote opening and closing of doors and other entry points; "noise_detection," which indicates that the device supports monitoring and responding to ambient noise levels; "thermostat," which indicates that the device can regulate and adjust indoor temperatures; and "battery," which indicates that the device can manage battery life and health. */
         capabilities_supported: Array<
           | 'access_code'
@@ -5090,8 +5118,12 @@ export interface Routes {
         properties: (({
           /** Indicates whether the device is online. */
           online: boolean
-          /** Name of the device. Enables administrators and users to identify the device easily, especially when there are numerous devices. */
+          /** Name of the device. Deprecated - use device.display_name instead */
           name: string
+          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
@@ -5883,6 +5915,10 @@ export interface Routes {
           | ('noiseaware_activity_zone' | 'minut_sensor')
           | ('ecobee_thermostat' | 'nest_thermostat' | 'honeywell_thermostat')
           | ('ios_phone' | 'android_phone')
+        /** Optional nickname to describe the device, settable through Seam */
+        nickname?: string | undefined
+        /** Display name of the device, defaults to nickname (if it is set) or properties.appearance.name otherwise. Enables administrators and users to identify the device easily, especially when there are numerous devices. */
+        display_name: string
         /** Collection of capabilities that the device supports when connected to Seam. Values are "access_code," which indicates that the device can manage and utilize digital PIN codes for secure access; "lock," which indicates that the device controls a door locking mechanism, enabling the remote opening and closing of doors and other entry points; "noise_detection," which indicates that the device supports monitoring and responding to ambient noise levels; "thermostat," which indicates that the device can regulate and adjust indoor temperatures; and "battery," which indicates that the device can manage battery life and health. */
         capabilities_supported: Array<
           | 'access_code'
@@ -5896,8 +5932,12 @@ export interface Routes {
         properties: (({
           /** Indicates whether the device is online. */
           online: boolean
-          /** Name of the device. Enables administrators and users to identify the device easily, especially when there are numerous devices. */
+          /** Name of the device. Deprecated - use device.display_name instead */
           name: string
+          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
@@ -6561,6 +6601,10 @@ export interface Routes {
           | ('noiseaware_activity_zone' | 'minut_sensor')
           | ('ecobee_thermostat' | 'nest_thermostat' | 'honeywell_thermostat')
           | ('ios_phone' | 'android_phone')
+        /** Optional nickname to describe the device, settable through Seam */
+        nickname?: string | undefined
+        /** Display name of the device, defaults to nickname (if it is set) or properties.appearance.name otherwise. Enables administrators and users to identify the device easily, especially when there are numerous devices. */
+        display_name: string
         /** Collection of capabilities that the device supports when connected to Seam. Values are "access_code," which indicates that the device can manage and utilize digital PIN codes for secure access; "lock," which indicates that the device controls a door locking mechanism, enabling the remote opening and closing of doors and other entry points; "noise_detection," which indicates that the device supports monitoring and responding to ambient noise levels; "thermostat," which indicates that the device can regulate and adjust indoor temperatures; and "battery," which indicates that the device can manage battery life and health. */
         capabilities_supported: Array<
           | 'access_code'
@@ -6574,8 +6618,12 @@ export interface Routes {
         properties: (({
           /** Indicates whether the device is online. */
           online: boolean
-          /** Name of the device. Enables administrators and users to identify the device easily, especially when there are numerous devices. */
+          /** Name of the device. Deprecated - use device.display_name instead */
           name: string
+          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
@@ -7529,6 +7577,10 @@ export interface Routes {
         /** Unique identifier for the device. */
         device_id: string
         device_type: 'android_phone' | 'ios_phone'
+        /** Optional nickname to describe the device, settable through Seam */
+        nickname?: string | undefined
+        /** Display name of the device, defaults to nickname (if it is set) or properties.appearance.name otherwise. Enables administrators and users to identify the device easily, especially when there are numerous devices. */
+        display_name: string
         /** Collection of capabilities that the device supports when connected to Seam. Values are "access_code," which indicates that the device can manage and utilize digital PIN codes for secure access; "lock," which indicates that the device controls a door locking mechanism, enabling the remote opening and closing of doors and other entry points; "noise_detection," which indicates that the device supports monitoring and responding to ambient noise levels; "thermostat," which indicates that the device can regulate and adjust indoor temperatures; and "battery," which indicates that the device can manage battery life and health. */
         capabilities_supported: Array<
           | 'access_code'
@@ -7607,6 +7659,10 @@ export interface Routes {
         /** Unique identifier for the device. */
         device_id: string
         device_type: 'android_phone' | 'ios_phone'
+        /** Optional nickname to describe the device, settable through Seam */
+        nickname?: string | undefined
+        /** Display name of the device, defaults to nickname (if it is set) or properties.appearance.name otherwise. Enables administrators and users to identify the device easily, especially when there are numerous devices. */
+        display_name: string
         /** Collection of capabilities that the device supports when connected to Seam. Values are "access_code," which indicates that the device can manage and utilize digital PIN codes for secure access; "lock," which indicates that the device controls a door locking mechanism, enabling the remote opening and closing of doors and other entry points; "noise_detection," which indicates that the device supports monitoring and responding to ambient noise levels; "thermostat," which indicates that the device can regulate and adjust indoor temperatures; and "battery," which indicates that the device can manage battery life and health. */
         capabilities_supported: Array<
           | 'access_code'
@@ -7904,6 +7960,10 @@ export interface Routes {
           | ('noiseaware_activity_zone' | 'minut_sensor')
           | ('ecobee_thermostat' | 'nest_thermostat' | 'honeywell_thermostat')
           | ('ios_phone' | 'android_phone')
+        /** Optional nickname to describe the device, settable through Seam */
+        nickname?: string | undefined
+        /** Display name of the device, defaults to nickname (if it is set) or properties.appearance.name otherwise. Enables administrators and users to identify the device easily, especially when there are numerous devices. */
+        display_name: string
         /** Collection of capabilities that the device supports when connected to Seam. Values are "access_code," which indicates that the device can manage and utilize digital PIN codes for secure access; "lock," which indicates that the device controls a door locking mechanism, enabling the remote opening and closing of doors and other entry points; "noise_detection," which indicates that the device supports monitoring and responding to ambient noise levels; "thermostat," which indicates that the device can regulate and adjust indoor temperatures; and "battery," which indicates that the device can manage battery life and health. */
         capabilities_supported: Array<
           | 'access_code'
@@ -7917,8 +7977,12 @@ export interface Routes {
         properties: (({
           /** Indicates whether the device is online. */
           online: boolean
-          /** Name of the device. Enables administrators and users to identify the device easily, especially when there are numerous devices. */
+          /** Name of the device. Deprecated - use device.display_name instead */
           name: string
+          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
@@ -8792,6 +8856,10 @@ export interface Routes {
           | ('noiseaware_activity_zone' | 'minut_sensor')
           | ('ecobee_thermostat' | 'nest_thermostat' | 'honeywell_thermostat')
           | ('ios_phone' | 'android_phone')
+        /** Optional nickname to describe the device, settable through Seam */
+        nickname?: string | undefined
+        /** Display name of the device, defaults to nickname (if it is set) or properties.appearance.name otherwise. Enables administrators and users to identify the device easily, especially when there are numerous devices. */
+        display_name: string
         /** Collection of capabilities that the device supports when connected to Seam. Values are "access_code," which indicates that the device can manage and utilize digital PIN codes for secure access; "lock," which indicates that the device controls a door locking mechanism, enabling the remote opening and closing of doors and other entry points; "noise_detection," which indicates that the device supports monitoring and responding to ambient noise levels; "thermostat," which indicates that the device can regulate and adjust indoor temperatures; and "battery," which indicates that the device can manage battery life and health. */
         capabilities_supported: Array<
           | 'access_code'
@@ -8805,8 +8873,12 @@ export interface Routes {
         properties: (({
           /** Indicates whether the device is online. */
           online: boolean
-          /** Name of the device. Enables administrators and users to identify the device easily, especially when there are numerous devices. */
+          /** Name of the device. Deprecated - use device.display_name instead */
           name: string
+          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
@@ -9762,6 +9834,10 @@ export interface Routes {
           | ('noiseaware_activity_zone' | 'minut_sensor')
           | ('ecobee_thermostat' | 'nest_thermostat' | 'honeywell_thermostat')
           | ('ios_phone' | 'android_phone')
+        /** Optional nickname to describe the device, settable through Seam */
+        nickname?: string | undefined
+        /** Display name of the device, defaults to nickname (if it is set) or properties.appearance.name otherwise. Enables administrators and users to identify the device easily, especially when there are numerous devices. */
+        display_name: string
         /** Collection of capabilities that the device supports when connected to Seam. Values are "access_code," which indicates that the device can manage and utilize digital PIN codes for secure access; "lock," which indicates that the device controls a door locking mechanism, enabling the remote opening and closing of doors and other entry points; "noise_detection," which indicates that the device supports monitoring and responding to ambient noise levels; "thermostat," which indicates that the device can regulate and adjust indoor temperatures; and "battery," which indicates that the device can manage battery life and health. */
         capabilities_supported: Array<
           | 'access_code'
@@ -9775,8 +9851,12 @@ export interface Routes {
         properties: (({
           /** Indicates whether the device is online. */
           online: boolean
-          /** Name of the device. Enables administrators and users to identify the device easily, especially when there are numerous devices. */
+          /** Name of the device. Deprecated - use device.display_name instead */
           name: string
+          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

@@ -19,8 +19,15 @@ export const common_device_properties = z.object({
   name: z
     .string()
     .describe(
-      'Name of the device. Enables administrators and users to identify the device easily, especially when there are numerous devices.',
+      'Name of the device. Deprecated - use device.display_name instead',
     ),
+  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
@@ -100,6 +107,17 @@ export const managed_device = z
   .object({
     device_id: z.string().uuid().describe('Unique identifier for the device.'),
     device_type: any_device_type.describe('Type of the device.'),
+    nickname: z
+      .string()
+      .optional()
+      .describe(
+        'Optional nickname to describe the device, settable through Seam',
+      ),
+    display_name: z
+      .string()
+      .describe(
+        'Display name of the device, defaults to nickname (if it is set) or properties.appearance.name otherwise. Enables administrators and users to identify the device easily, especially when there are numerous devices.',
+      ),
     capabilities_supported: z
       .array(capabilities)
       .describe(