@seamapi/types 1.42.1 → 1.44.0

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

@@ -632,7 +632,7 @@ export interface Routes {
         workspace_id: string
         created_at: string
         display_name: string
-        external_type: 'pti_user'
+        external_type: 'pti_user' | 'brivo_user'
         external_type_display_name: string
         is_suspended: boolean
         full_name?: string | undefined
@@ -667,6 +667,18 @@ export interface Routes {
     formData: {}
     jsonResponse: {}
   }
+  '/acs/credentials/assign': {
+    route: '/acs/credentials/assign'
+    method: 'PATCH' | 'POST'
+    queryParams: {}
+    jsonBody: {
+      acs_user_id: string
+      acs_credential_id: string
+    }
+    commonParams: {}
+    formData: {}
+    jsonResponse: {}
+  }
   '/acs/credentials/create': {
     route: '/acs/credentials/create'
     method: 'POST'
@@ -680,10 +692,10 @@ export interface Routes {
     jsonResponse: {
       acs_credential: {
         acs_credential_id: string
-        acs_user_id: string
+        acs_user_id?: string | undefined
         acs_system_id: string
         code: string | null
-        external_type: 'pti_card'
+        external_type: 'pti_card' | 'brivo_credential'
         external_type_display_name: string
         created_at: string
         workspace_id: string
@@ -713,10 +725,10 @@ export interface Routes {
     jsonResponse: {
       acs_credential: {
         acs_credential_id: string
-        acs_user_id: string
+        acs_user_id?: string | undefined
         acs_system_id: string
         code: string | null
-        external_type: 'pti_card'
+        external_type: 'pti_card' | 'brivo_credential'
         external_type_display_name: string
         created_at: string
         workspace_id: string
@@ -743,16 +755,28 @@ export interface Routes {
     jsonResponse: {
       acs_credentials: Array<{
         acs_credential_id: string
-        acs_user_id: string
+        acs_user_id?: string | undefined
         acs_system_id: string
         code: string | null
-        external_type: 'pti_card'
+        external_type: 'pti_card' | 'brivo_credential'
         external_type_display_name: string
         created_at: string
         workspace_id: string
       }>
     }
   }
+  '/acs/credentials/unassign': {
+    route: '/acs/credentials/unassign'
+    method: 'PATCH' | 'POST'
+    queryParams: {}
+    jsonBody: {
+      acs_user_id: string
+      acs_credential_id: string
+    }
+    commonParams: {}
+    formData: {}
+    jsonResponse: {}
+  }
   '/acs/systems/get': {
     route: '/acs/systems/get'
     method: 'GET' | 'POST'
@@ -817,15 +841,16 @@ export interface Routes {
     route: '/acs/users/create'
     method: 'POST'
     queryParams: {}
-    jsonBody: {}
-    commonParams: {
+    jsonBody: {
       acs_system_id: string
       acs_access_group_ids?: string[]
       full_name?: string | undefined
       /** Deprecated: use email_address. */
       email?: string | undefined
       phone_number?: string | undefined
+      email_address?: string | undefined
     }
+    commonParams: {}
     formData: {}
     jsonResponse: {
       acs_user: {
@@ -834,7 +859,7 @@ export interface Routes {
         workspace_id: string
         created_at: string
         display_name: string
-        external_type: 'pti_user'
+        external_type: 'pti_user' | 'brivo_user'
         external_type_display_name: string
         is_suspended: boolean
         full_name?: string | undefined
@@ -872,7 +897,7 @@ export interface Routes {
         workspace_id: string
         created_at: string
         display_name: string
-        external_type: 'pti_user'
+        external_type: 'pti_user' | 'brivo_user'
         external_type_display_name: string
         is_suspended: boolean
         full_name?: string | undefined
@@ -899,7 +924,7 @@ export interface Routes {
         workspace_id: string
         created_at: string
         display_name: string
-        external_type: 'pti_user'
+        external_type: 'pti_user' | 'brivo_user'
         external_type_display_name: string
         is_suspended: boolean
         full_name?: string | undefined
@@ -948,14 +973,15 @@ export interface Routes {
     route: '/acs/users/update'
     method: 'PATCH' | 'POST'
     queryParams: {}
-    jsonBody: {}
-    commonParams: {
+    jsonBody: {
       acs_user_id: string
       full_name?: string | undefined
       /** Deprecated: use email_address. */
       email?: string | undefined
       phone_number?: string | undefined
+      email_address?: string | undefined
     }
+    commonParams: {}
     formData: {}
     jsonResponse: {}
   }
@@ -1247,6 +1273,13 @@ export interface Routes {
         created_at: string
         login_successful: boolean
         status: 'pending' | 'failed' | 'authorized'
+        custom_redirect_url: string | null
+        custom_redirect_failure_url: string | null
+        custom_metadata: Record<string, string | number | null | boolean>
+        automatically_manage_new_devices: boolean
+        wait_for_device_creation: boolean
+        authorized_at: string | null
+        selected_provider: string | null
       }
     }
   }
@@ -1284,6 +1317,13 @@ export interface Routes {
         created_at: string
         login_successful: boolean
         status: 'pending' | 'failed' | 'authorized'
+        custom_redirect_url: string | null
+        custom_redirect_failure_url: string | null
+        custom_metadata: Record<string, string | number | null | boolean>
+        automatically_manage_new_devices: boolean
+        wait_for_device_creation: boolean
+        authorized_at: string | null
+        selected_provider: string | null
       }
     }
   }
@@ -1310,6 +1350,13 @@ export interface Routes {
         created_at: string
         login_successful: boolean
         status: 'pending' | 'failed' | 'authorized'
+        custom_redirect_url: string | null
+        custom_redirect_failure_url: string | null
+        custom_metadata: Record<string, string | number | null | boolean>
+        automatically_manage_new_devices: boolean
+        wait_for_device_creation: boolean
+        authorized_at: string | null
+        selected_provider: string | null
       }>
     }
   }
@@ -1466,6 +1513,9 @@ export interface Routes {
           model: {
             display_name: string
             manufacturer_display_name: string
+            offline_access_codes_supported?: boolean | undefined
+            access_codes_supported?: boolean | undefined
+            accessory_keypad_supported?: boolean | undefined
           }
           has_direct_power?: boolean | undefined
           battery_level?: number | undefined
@@ -1479,7 +1529,13 @@ export interface Routes {
           image_url?: string | undefined
           image_alt_text?: string | undefined
           serial_number?: string | undefined
+          /** Currently possible to use online access codes */
+          online_access_codes_enabled?: boolean | undefined
+          /** Currently possible to use offline access codes */
+          offline_access_codes_enabled?: boolean | undefined
+          /** Deprecated: use model.offline_access_codes_enabled. */
           supports_accessory_keypad?: boolean | undefined
+          /** Deprecated: use model.accessory_keypad_supported. */
           supports_offline_access_codes?: boolean | undefined
         } & {
           august_metadata?:
@@ -2164,6 +2220,9 @@ export interface Routes {
           model: {
             display_name: string
             manufacturer_display_name: string
+            offline_access_codes_supported?: boolean | undefined
+            access_codes_supported?: boolean | undefined
+            accessory_keypad_supported?: boolean | undefined
           }
           has_direct_power?: boolean | undefined
           battery_level?: number | undefined
@@ -2177,7 +2236,13 @@ export interface Routes {
           image_url?: string | undefined
           image_alt_text?: string | undefined
           serial_number?: string | undefined
+          /** Currently possible to use online access codes */
+          online_access_codes_enabled?: boolean | undefined
+          /** Currently possible to use offline access codes */
+          offline_access_codes_enabled?: boolean | undefined
+          /** Deprecated: use model.offline_access_codes_enabled. */
           supports_accessory_keypad?: boolean | undefined
+          /** Deprecated: use model.accessory_keypad_supported. */
           supports_offline_access_codes?: boolean | undefined
         } & {
           august_metadata?:
@@ -3279,6 +3344,9 @@ export interface Routes {
           model: {
             display_name: string
             manufacturer_display_name: string
+            offline_access_codes_supported?: boolean | undefined
+            access_codes_supported?: boolean | undefined
+            accessory_keypad_supported?: boolean | undefined
           }
           has_direct_power?: boolean | undefined
           battery_level?: number | undefined
@@ -3292,7 +3360,13 @@ export interface Routes {
           image_url?: string | undefined
           image_alt_text?: string | undefined
           serial_number?: string | undefined
+          /** Currently possible to use online access codes */
+          online_access_codes_enabled?: boolean | undefined
+          /** Currently possible to use offline access codes */
+          offline_access_codes_enabled?: boolean | undefined
+          /** Deprecated: use model.offline_access_codes_enabled. */
           supports_accessory_keypad?: boolean | undefined
+          /** Deprecated: use model.accessory_keypad_supported. */
           supports_offline_access_codes?: boolean | undefined
         } & {
           august_metadata?:
@@ -3856,6 +3930,9 @@ export interface Routes {
           model: {
             display_name: string
             manufacturer_display_name: string
+            offline_access_codes_supported?: boolean | undefined
+            access_codes_supported?: boolean | undefined
+            accessory_keypad_supported?: boolean | undefined
           }
           has_direct_power?: boolean | undefined
           battery_level?: number | undefined
@@ -3869,7 +3946,13 @@ export interface Routes {
           image_url?: string | undefined
           image_alt_text?: string | undefined
           serial_number?: string | undefined
+          /** Currently possible to use online access codes */
+          online_access_codes_enabled?: boolean | undefined
+          /** Currently possible to use offline access codes */
+          offline_access_codes_enabled?: boolean | undefined
+          /** Deprecated: use model.offline_access_codes_enabled. */
           supports_accessory_keypad?: boolean | undefined
+          /** Deprecated: use model.accessory_keypad_supported. */
           supports_offline_access_codes?: boolean | undefined
         } & {
           august_metadata?:
@@ -4554,6 +4637,9 @@ export interface Routes {
           model: {
             display_name: string
             manufacturer_display_name: string
+            offline_access_codes_supported?: boolean | undefined
+            access_codes_supported?: boolean | undefined
+            accessory_keypad_supported?: boolean | undefined
           }
           has_direct_power?: boolean | undefined
           battery_level?: number | undefined
@@ -4567,7 +4653,13 @@ export interface Routes {
           image_url?: string | undefined
           image_alt_text?: string | undefined
           serial_number?: string | undefined
+          /** Currently possible to use online access codes */
+          online_access_codes_enabled?: boolean | undefined
+          /** Currently possible to use offline access codes */
+          offline_access_codes_enabled?: boolean | undefined
+          /** Deprecated: use model.offline_access_codes_enabled. */
           supports_accessory_keypad?: boolean | undefined
+          /** Deprecated: use model.accessory_keypad_supported. */
           supports_offline_access_codes?: boolean | undefined
         } & {
           august_metadata?:
@@ -5131,6 +5223,9 @@ export interface Routes {
           model: {
             display_name: string
             manufacturer_display_name: string
+            offline_access_codes_supported?: boolean | undefined
+            access_codes_supported?: boolean | undefined
+            accessory_keypad_supported?: boolean | undefined
           }
           has_direct_power?: boolean | undefined
           battery_level?: number | undefined
@@ -5144,7 +5239,13 @@ export interface Routes {
           image_url?: string | undefined
           image_alt_text?: string | undefined
           serial_number?: string | undefined
+          /** Currently possible to use online access codes */
+          online_access_codes_enabled?: boolean | undefined
+          /** Currently possible to use offline access codes */
+          offline_access_codes_enabled?: boolean | undefined
+          /** Deprecated: use model.offline_access_codes_enabled. */
           supports_accessory_keypad?: boolean | undefined
+          /** Deprecated: use model.accessory_keypad_supported. */
           supports_offline_access_codes?: boolean | undefined
         } & {
           august_metadata?:
@@ -6143,6 +6244,9 @@ export interface Routes {
           model: {
             display_name: string
             manufacturer_display_name: string
+            offline_access_codes_supported?: boolean | undefined
+            access_codes_supported?: boolean | undefined
+            accessory_keypad_supported?: boolean | undefined
           }
           has_direct_power?: boolean | undefined
           battery_level?: number | undefined
@@ -6156,7 +6260,13 @@ export interface Routes {
           image_url?: string | undefined
           image_alt_text?: string | undefined
           serial_number?: string | undefined
+          /** Currently possible to use online access codes */
+          online_access_codes_enabled?: boolean | undefined
+          /** Currently possible to use offline access codes */
+          offline_access_codes_enabled?: boolean | undefined
+          /** Deprecated: use model.offline_access_codes_enabled. */
           supports_accessory_keypad?: boolean | undefined
+          /** Deprecated: use model.accessory_keypad_supported. */
           supports_offline_access_codes?: boolean | undefined
         } & {
           august_metadata?:
@@ -6871,6 +6981,9 @@ export interface Routes {
           model: {
             display_name: string
             manufacturer_display_name: string
+            offline_access_codes_supported?: boolean | undefined
+            access_codes_supported?: boolean | undefined
+            accessory_keypad_supported?: boolean | undefined
           }
           has_direct_power?: boolean | undefined
           battery_level?: number | undefined
@@ -6884,7 +6997,13 @@ export interface Routes {
           image_url?: string | undefined
           image_alt_text?: string | undefined
           serial_number?: string | undefined
+          /** Currently possible to use online access codes */
+          online_access_codes_enabled?: boolean | undefined
+          /** Currently possible to use offline access codes */
+          offline_access_codes_enabled?: boolean | undefined
+          /** Deprecated: use model.offline_access_codes_enabled. */
           supports_accessory_keypad?: boolean | undefined
+          /** Deprecated: use model.accessory_keypad_supported. */
           supports_offline_access_codes?: boolean | undefined
         } & {
           august_metadata?:
@@ -7574,6 +7693,9 @@ export interface Routes {
           model: {
             display_name: string
             manufacturer_display_name: string
+            offline_access_codes_supported?: boolean | undefined
+            access_codes_supported?: boolean | undefined
+            accessory_keypad_supported?: boolean | undefined
           }
           has_direct_power?: boolean | undefined
           battery_level?: number | undefined
@@ -7587,7 +7709,13 @@ export interface Routes {
           image_url?: string | undefined
           image_alt_text?: string | undefined
           serial_number?: string | undefined
+          /** Currently possible to use online access codes */
+          online_access_codes_enabled?: boolean | undefined
+          /** Currently possible to use offline access codes */
+          offline_access_codes_enabled?: boolean | undefined
+          /** Deprecated: use model.offline_access_codes_enabled. */
           supports_accessory_keypad?: boolean | undefined
+          /** Deprecated: use model.accessory_keypad_supported. */
           supports_offline_access_codes?: boolean | undefined
         } & {
           august_metadata?:
@@ -8128,7 +8256,7 @@ export interface Routes {
         workspace_id: string
         created_at: string
         display_name: string
-        external_type: 'pti_user'
+        external_type: 'pti_user' | 'brivo_user'
         external_type_display_name: string
         is_suspended: boolean
         full_name?: string | undefined

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

@@ -1 +1 @@
-export type { ConnectWebview } from './models/index.js'
+export type { ConnectWebview, CustomMetadata } from './models/index.js'

package/src/lib/seam/connect/stable/models/connect-webview.ts

@@ -1,5 +1,7 @@
 import { z } from 'zod'
 
+import { custom_metadata } from './custom-metadata.js'
+
 export const connect_webview = z.object({
   connect_webview_id: z.string().uuid(),
   connected_account_id: z.string().uuid().optional(),
@@ -13,6 +15,13 @@ export const connect_webview = z.object({
   created_at: z.string().datetime(),
   login_successful: z.boolean(),
   status: z.enum(['pending', 'failed', 'authorized']),
+  custom_redirect_url: z.string().url().nullable(),
+  custom_redirect_failure_url: z.string().url().nullable(),
+  custom_metadata,
+  automatically_manage_new_devices: z.boolean(),
+  wait_for_device_creation: z.boolean(),
+  authorized_at: z.string().datetime().nullable(),
+  selected_provider: z.string().nullable(),
 })
 
 export type ConnectWebview = z.infer<typeof connect_webview>

package/src/lib/seam/connect/stable/models/custom-metadata.ts

@@ -0,0 +1,12 @@
+import { z } from 'zod'
+
+export const custom_metadata = z
+  .record(
+    z.string().max(40),
+    z.union([z.string().max(500), z.number(), z.null(), z.boolean()]),
+  )
+  .refine((val) => Object.keys(val).length <= 50, {
+    message: 'Custom metadata is limited to a maximum of 50 keys',
+  })
+
+export type CustomMetadata = z.infer<typeof custom_metadata>

package/src/lib/seam/connect/stable/models/index.ts

@@ -1 +1,2 @@
 export * from './connect-webview.js'
+export * from './custom-metadata.js'

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

@@ -1 +1 @@
-export { connect_webview } from './models/index.js'
+export { connect_webview, custom_metadata } from './models/index.js'

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

@@ -1,6 +1,9 @@
 import { z } from 'zod'
 
-export const acs_credential_external_type = z.enum(['pti_card'])
+export const acs_credential_external_type = z.enum([
+  'pti_card',
+  'brivo_credential',
+])
 
 export type AcsCredentialExternalType = z.infer<
   typeof acs_credential_external_type
@@ -8,7 +11,7 @@ export type AcsCredentialExternalType = z.infer<
 
 export const acs_credential = z.object({
   acs_credential_id: z.string().uuid(),
-  acs_user_id: z.string().uuid(),
+  acs_user_id: z.string().uuid().optional(),
   acs_system_id: z.string().uuid(),
   code: z.string().nullable(),
   external_type: acs_credential_external_type,

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

@@ -1,6 +1,6 @@
 import { z } from 'zod'
 
-export const acs_user_external_type = z.enum(['pti_user'])
+export const acs_user_external_type = z.enum(['pti_user', 'brivo_user'])
 
 export type AcsUserExternalType = z.infer<typeof acs_user_external_type>
 

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

@@ -16,6 +16,10 @@ export const common_device_properties = z.object({
   model: z.object({
     display_name: z.string(),
     manufacturer_display_name: z.string(),
+
+    offline_access_codes_supported: z.boolean().optional(),
+    access_codes_supported: z.boolean().optional(),
+    accessory_keypad_supported: z.boolean().optional(),
   }),
   has_direct_power: z.boolean().optional(),
   battery_level: z.number().min(0).max(1).optional(),
@@ -30,8 +34,25 @@ export const common_device_properties = z.object({
   image_url: z.string().url().optional(),
   image_alt_text: z.string().optional(),
   serial_number: z.string().optional(),
-  supports_accessory_keypad: z.boolean().optional(),
-  supports_offline_access_codes: z.boolean().optional(),
+
+  online_access_codes_enabled: z
+    .boolean()
+    .describe('Currently possible to use online access codes')
+    .optional(),
+  offline_access_codes_enabled: z
+    .boolean()
+    .describe('Currently possible to use offline access codes')
+    .optional(),
+
+  // Deprecated legacy capability support props
+  supports_accessory_keypad: z
+    .boolean()
+    .describe('Deprecated: use model.offline_access_codes_enabled.')
+    .optional(),
+  supports_offline_access_codes: z
+    .boolean()
+    .describe('Deprecated: use model.accessory_keypad_supported.')
+    .optional(),
 })
 
 export const managed_device = z.object({