@seamapi/types 1.60.1 → 1.62.0

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

@@ -246,7 +246,7 @@ export default {
           },
           email_address: { format: 'email', type: 'string' },
           external_type: {
-            enum: ['pti_user', 'brivo_user', 'hid_cm_user'],
+            enum: ['pti_user', 'brivo_user', 'hid_cm_user', 'salto_site_user'],
             type: 'string',
           },
           external_type_display_name: { type: 'string' },
@@ -469,6 +469,7 @@ export default {
         properties: {
           account_type: { type: 'string' },
           account_type_display_name: { type: 'string' },
+          automatically_manage_new_devices: { type: 'boolean' },
           connected_account_id: { format: 'uuid', type: 'string' },
           created_at: { format: 'date-time', type: 'string' },
           custom_metadata: {
@@ -496,7 +497,10 @@ export default {
           },
           warnings: { nullable: true },
         },
-        required: ['account_type_display_name'],
+        required: [
+          'account_type_display_name',
+          'automatically_manage_new_devices',
+        ],
         type: 'object',
       },
       device: {
@@ -1847,6 +1851,19 @@ export default {
           is_managed: { enum: [false], type: 'boolean' },
           properties: {
             properties: {
+              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.',
+                properties: {
+                  level: { maximum: 1, minimum: 0, type: 'number' },
+                  status: {
+                    enum: ['critical', 'low', 'good', 'full'],
+                    type: 'string',
+                  },
+                },
+                required: ['level', 'status'],
+                type: 'object',
+              },
               battery_level: {
                 description:
                   'Indicates the battery level of the device as a decimal value between 0 and 1, inclusive.',
@@ -1854,19 +1871,63 @@ export default {
                 minimum: 0,
                 type: 'number',
               },
-              image_alt_text: { type: 'string' },
-              image_url: { type: 'string' },
-              manufacturer: { type: 'string' },
+              image_alt_text: {
+                description: 'Alt text for the device image.',
+                type: 'string',
+              },
+              image_url: {
+                description: 'Image URL for the device.',
+                format: 'uri',
+                type: 'string',
+              },
+              manufacturer: {
+                description: 'Manufacturer of the device.',
+                type: 'string',
+              },
               model: {
                 properties: {
-                  display_name: { type: 'string' },
-                  manufacturer_display_name: { type: 'string' },
+                  accessory_keypad_supported: {
+                    description:
+                      'Indicates whether the device supports an accessory keypad.',
+                    type: 'boolean',
+                  },
+                  display_name: {
+                    description: 'Display name of the device model.',
+                    type: 'string',
+                  },
+                  manufacturer_display_name: {
+                    description:
+                      'Display name that corresponds to the manufacturer-specific terminology for the device.',
+                    type: 'string',
+                  },
+                  offline_access_codes_supported: {
+                    description:
+                      'Indicates whether the device supports offline access codes.',
+                    type: 'boolean',
+                  },
+                  online_access_codes_supported: {
+                    description:
+                      'Indicates whether the device supports online access codes.',
+                    type: 'boolean',
+                  },
                 },
                 required: ['display_name', 'manufacturer_display_name'],
                 type: 'object',
               },
-              name: { type: 'string' },
-              online: { type: 'boolean' },
+              name: {
+                description:
+                  'Name of the device. Enables administrators and users to identify the device easily, especially when there are numerous devices.',
+                type: 'string',
+              },
+              offline_access_codes_enabled: {
+                description:
+                  'Indicates whether it is currently possible to use offline access codes for the device.',
+                type: 'boolean',
+              },
+              online: {
+                description: 'Indicates whether the device is online.',
+                type: 'boolean',
+              },
               online_access_codes_enabled: {
                 description:
                   'Indicates whether it is currently possible to use online access codes for the device.',
@@ -1979,6 +2040,11 @@ export default {
         scheme: 'bearer',
         type: 'http',
       },
+      user_session_without_workspace: {
+        bearerFormat: 'User Session Token',
+        scheme: 'bearer',
+        type: 'http',
+      },
     },
   },
   info: { title: 'Seam Connect', version: '1.0.0' },
@@ -2571,9 +2637,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: '/access_codes/unmanaged/convert_to_managed',
         tags: ['/access_codes'],
@@ -2615,9 +2682,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: '/access_codes/unmanaged/convert_to_managed',
         tags: ['/access_codes'],
@@ -2664,9 +2732,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: '/access_codes/unmanaged/delete',
         tags: ['/access_codes'],
@@ -2714,9 +2783,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: '/access_codes/unmanaged/get',
         tags: ['/access_codes'],
@@ -2767,9 +2837,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: '/access_codes/unmanaged/list',
         tags: ['/access_codes'],
@@ -2815,9 +2886,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: '/access_codes/unmanaged/update',
         tags: ['/access_codes'],
@@ -2859,9 +2931,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: '/access_codes/unmanaged/update',
         tags: ['/access_codes'],
@@ -3129,9 +3202,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: '/acs/access_groups/add_user',
         tags: [],
@@ -3171,9 +3245,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: '/acs/access_groups/add_user',
         tags: [],
@@ -3218,9 +3293,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: '/acs/access_groups/get',
         tags: [],
@@ -3316,9 +3392,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: '/acs/access_groups/list_users',
         tags: [],
@@ -6132,6 +6209,56 @@ export default {
         'x-fern-sdk-return-value': 'connected_accounts',
       },
     },
+    '/connected_accounts/update': {
+      post: {
+        operationId: 'connectedAccountsUpdatePost',
+        requestBody: {
+          content: {
+            'application/json': {
+              schema: {
+                properties: {
+                  automatically_manage_new_devices: { type: 'boolean' },
+                  connected_account_id: { format: 'uuid', type: 'string' },
+                },
+                required: ['connected_account_id'],
+                type: 'object',
+              },
+            },
+          },
+        },
+        responses: {
+          200: {
+            content: {
+              'application/json': {
+                schema: {
+                  properties: {
+                    connected_account: {
+                      $ref: '#/components/schemas/connected_account',
+                    },
+                    ok: { type: 'boolean' },
+                  },
+                  required: ['connected_account', 'ok'],
+                  type: 'object',
+                },
+              },
+            },
+            description: 'OK',
+          },
+          400: { description: 'Bad Request' },
+          401: { description: 'Unauthorized' },
+        },
+        security: [
+          { pat_with_workspace: [] },
+          { console_session: [] },
+          { api_key: [] },
+        ],
+        summary: '/connected_accounts/update',
+        tags: ['/connected_accounts'],
+        'x-fern-sdk-group-name': ['connected_accounts'],
+        'x-fern-sdk-method-name': 'update',
+        'x-fern-sdk-return-value': 'connected_account',
+      },
+    },
     '/devices/delete': {
       post: {
         operationId: 'devicesDeletePost',
@@ -10052,9 +10179,12 @@ export default {
           401: { description: 'Unauthorized' },
         },
         security: [
-          { access_token: [], seam_workspace: [] },
-          { seam_client_session_token: [] },
-          { client_session_token: [] },
+          { pat_with_workspace: [] },
+          { pat_without_workspace: [] },
+          { user_session: [] },
+          { user_session_without_workspace: [] },
+          { api_key: [] },
+          { client_session: [] },
         ],
         summary: '/workspaces/list',
         tags: ['/workspaces'],
@@ -10085,9 +10215,12 @@ export default {
           401: { description: 'Unauthorized' },
         },
         security: [
-          { access_token: [], seam_workspace: [] },
-          { seam_client_session_token: [] },
-          { client_session_token: [] },
+          { pat_with_workspace: [] },
+          { pat_without_workspace: [] },
+          { user_session: [] },
+          { user_session_without_workspace: [] },
+          { api_key: [] },
+          { client_session: [] },
         ],
         summary: '/workspaces/list',
         tags: ['/workspaces'],

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

@@ -733,7 +733,11 @@ export interface Routes {
         workspace_id: string
         created_at: string
         display_name: string
-        external_type: 'pti_user' | 'brivo_user' | 'hid_cm_user'
+        external_type:
+          | 'pti_user'
+          | 'brivo_user'
+          | 'hid_cm_user'
+          | 'salto_site_user'
         external_type_display_name: string
         is_suspended: boolean
         full_name?: string | undefined
@@ -1123,7 +1127,11 @@ export interface Routes {
         workspace_id: string
         created_at: string
         display_name: string
-        external_type: 'pti_user' | 'brivo_user' | 'hid_cm_user'
+        external_type:
+          | 'pti_user'
+          | 'brivo_user'
+          | 'hid_cm_user'
+          | 'salto_site_user'
         external_type_display_name: string
         is_suspended: boolean
         full_name?: string | undefined
@@ -1162,7 +1170,11 @@ export interface Routes {
         workspace_id: string
         created_at: string
         display_name: string
-        external_type: 'pti_user' | 'brivo_user' | 'hid_cm_user'
+        external_type:
+          | 'pti_user'
+          | 'brivo_user'
+          | 'hid_cm_user'
+          | 'salto_site_user'
         external_type_display_name: string
         is_suspended: boolean
         full_name?: string | undefined
@@ -1190,7 +1202,11 @@ export interface Routes {
         workspace_id: string
         created_at: string
         display_name: string
-        external_type: 'pti_user' | 'brivo_user' | 'hid_cm_user'
+        external_type:
+          | 'pti_user'
+          | 'brivo_user'
+          | 'hid_cm_user'
+          | 'salto_site_user'
         external_type_display_name: string
         is_suspended: boolean
         full_name?: string | undefined
@@ -1687,6 +1703,7 @@ export interface Routes {
         custom_metadata?:
           | Record<string, string | number | boolean | null>
           | undefined
+        automatically_manage_new_devices: boolean
       }
     }
   }
@@ -1717,9 +1734,44 @@ export interface Routes {
         custom_metadata?:
           | Record<string, string | number | boolean | null>
           | undefined
+        automatically_manage_new_devices: boolean
       }>
     }
   }
+  '/connected_accounts/update': {
+    route: '/connected_accounts/update'
+    method: 'POST'
+    queryParams: {}
+    jsonBody: {
+      connected_account_id: string
+      automatically_manage_new_devices?: boolean | undefined
+    }
+    commonParams: {}
+    formData: {}
+    jsonResponse: {
+      connected_account: {
+        connected_account_id?: string | undefined
+        created_at?: string | undefined
+        user_identifier?:
+          | {
+              username?: string | undefined
+              api_url?: string | undefined
+              email?: string | undefined
+              phone?: string | undefined
+              exclusive?: boolean | undefined
+            }
+          | undefined
+        account_type?: string | undefined
+        account_type_display_name: string
+        errors?: any
+        warnings?: any
+        custom_metadata?:
+          | Record<string, string | number | boolean | null>
+          | undefined
+        automatically_manage_new_devices: boolean
+      }
+    }
+  }
   '/devices/delete': {
     route: '/devices/delete'
     method: 'DELETE' | 'POST'
@@ -3218,19 +3270,41 @@ 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: string
+          /** Indicates whether the device is online. */
           online: boolean
+          /** Manufacturer of the device. */
           manufacturer?: string | undefined
+          /** Image URL for the device. */
           image_url?: string | undefined
+          /** Alt text for the device image. */
           image_alt_text?: string | undefined
-          model: {
-            display_name: string
-            manufacturer_display_name: string
-          }
           /** Indicates the battery level of the device as a decimal value between 0 and 1, inclusive. */
           battery_level?: number | undefined
+          /** 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. */
+          battery?:
+            | {
+                level: number
+                status: 'critical' | 'low' | 'good' | 'full'
+              }
+            | undefined
           /** Indicates whether it is currently possible to use online access codes for the device. */
           online_access_codes_enabled?: boolean | undefined
+          /** Indicates whether it is currently possible to use offline access codes for the device. */
+          offline_access_codes_enabled?: boolean | undefined
+          model: {
+            /** Display name of the device model. */
+            display_name: string
+            /** Display name that corresponds to the manufacturer-specific terminology for the device. */
+            manufacturer_display_name: string
+            /** Indicates whether the device supports offline access codes. */
+            offline_access_codes_supported?: boolean | undefined
+            /** Indicates whether the device supports online access codes. */
+            online_access_codes_supported?: boolean | undefined
+            /** Indicates whether the device supports an accessory keypad. */
+            accessory_keypad_supported?: boolean | undefined
+          }
         }
       }
     }
@@ -3410,19 +3484,41 @@ 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: string
+          /** Indicates whether the device is online. */
           online: boolean
+          /** Manufacturer of the device. */
           manufacturer?: string | undefined
+          /** Image URL for the device. */
           image_url?: string | undefined
+          /** Alt text for the device image. */
           image_alt_text?: string | undefined
-          model: {
-            display_name: string
-            manufacturer_display_name: string
-          }
           /** Indicates the battery level of the device as a decimal value between 0 and 1, inclusive. */
           battery_level?: number | undefined
+          /** 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. */
+          battery?:
+            | {
+                level: number
+                status: 'critical' | 'low' | 'good' | 'full'
+              }
+            | undefined
           /** Indicates whether it is currently possible to use online access codes for the device. */
           online_access_codes_enabled?: boolean | undefined
+          /** Indicates whether it is currently possible to use offline access codes for the device. */
+          offline_access_codes_enabled?: boolean | undefined
+          model: {
+            /** Display name of the device model. */
+            display_name: string
+            /** Display name that corresponds to the manufacturer-specific terminology for the device. */
+            manufacturer_display_name: string
+            /** Indicates whether the device supports offline access codes. */
+            offline_access_codes_supported?: boolean | undefined
+            /** Indicates whether the device supports online access codes. */
+            online_access_codes_supported?: boolean | undefined
+            /** Indicates whether the device supports an accessory keypad. */
+            accessory_keypad_supported?: boolean | undefined
+          }
         }
       }>
     }
@@ -9026,7 +9122,11 @@ export interface Routes {
         workspace_id: string
         created_at: string
         display_name: string
-        external_type: 'pti_user' | 'brivo_user' | 'hid_cm_user'
+        external_type:
+          | 'pti_user'
+          | 'brivo_user'
+          | 'hid_cm_user'
+          | 'salto_site_user'
         external_type_display_name: string
         is_suspended: boolean
         full_name?: string | undefined

package/src/lib/seam/connect/unstable/models/acs/user.ts

@@ -4,6 +4,7 @@ export const acs_user_external_type = z.enum([
   'pti_user',
   'brivo_user',
   'hid_cm_user',
+  'salto_site_user',
 ])
 
 export type AcsUserExternalType = z.infer<typeof acs_user_external_type>

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

@@ -1,6 +1,6 @@
 import { z } from 'zod'
 
-import { managed_device } from './managed-device.js'
+import { common_device_properties, managed_device } from './managed-device.js'
 
 export const unmanaged_device = managed_device
   .pick({
@@ -15,31 +15,17 @@ export const unmanaged_device = managed_device
   })
   .extend({
     is_managed: z.literal(false),
-    // todo: should pick from the managed_device schema instead of re-defining
-    properties: z.object({
-      name: z.string(),
-      online: z.boolean(),
-      manufacturer: z.string().optional(),
-      image_url: z.string().optional(),
-      image_alt_text: z.string().optional(),
-      model: z.object({
-        display_name: z.string(),
-        manufacturer_display_name: z.string(),
-      }),
-      battery_level: z
-        .number()
-        .min(0)
-        .max(1)
-        .optional()
-        .describe(
-          'Indicates the battery level of the device as a decimal value between 0 and 1, inclusive.',
-        ),
-      online_access_codes_enabled: z
-        .boolean()
-        .describe(
-          'Indicates whether it is currently possible to use online access codes for the device.',
-        )
-        .optional(),
+    properties: common_device_properties.pick({
+      name: true,
+      online: true,
+      manufacturer: true,
+      image_url: true,
+      image_alt_text: true,
+      battery_level: true,
+      battery: true,
+      online_access_codes_enabled: true,
+      offline_access_codes_enabled: true,
+      model: true,
     }),
   })