@seamapi/types 1.179.0 → 1.181.0

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

@@ -2921,6 +2921,7 @@ export interface Routes {
                     ---
                      */
                 access_group_type_display_name: string;
+                display_name: string;
                 external_type: 'pti_unit' | 'pti_access_level' | 'salto_access_group' | 'brivo_group';
                 external_type_display_name: string;
                 created_at: string;
@@ -2955,6 +2956,7 @@ export interface Routes {
                     ---
                      */
                 access_group_type_display_name: string;
+                display_name: string;
                 external_type: 'pti_unit' | 'pti_access_level' | 'salto_access_group' | 'brivo_group';
                 external_type_display_name: string;
                 created_at: string;
@@ -5144,14 +5146,14 @@ export interface Routes {
         jsonResponse: {
             client_session: {
                 client_session_id: string;
-                user_identifier_key: string | null;
+                workspace_id: string;
                 created_at: string;
                 token: string;
+                user_identifier_key: string | null;
                 device_count: number;
                 connected_account_ids: string[];
                 connect_webview_ids: string[];
                 user_identity_ids: string[];
-                workspace_id: string;
             };
         };
     };
@@ -5179,14 +5181,14 @@ export interface Routes {
         jsonResponse: {
             client_session: {
                 client_session_id: string;
-                user_identifier_key: string | null;
+                workspace_id: string;
                 created_at: string;
                 token: string;
+                user_identifier_key: string | null;
                 device_count: number;
                 connected_account_ids: string[];
                 connect_webview_ids: string[];
                 user_identity_ids: string[];
-                workspace_id: string;
             };
         };
     };
@@ -5206,14 +5208,14 @@ export interface Routes {
         jsonResponse: {
             client_session: {
                 client_session_id: string;
-                user_identifier_key: string | null;
+                workspace_id: string;
                 created_at: string;
                 token: string;
+                user_identifier_key: string | null;
                 device_count: number;
                 connected_account_ids: string[];
                 connect_webview_ids: string[];
                 user_identity_ids: string[];
-                workspace_id: string;
             };
         };
     };
@@ -5233,14 +5235,14 @@ export interface Routes {
         jsonResponse: {
             client_session: {
                 client_session_id: string;
-                user_identifier_key: string | null;
+                workspace_id: string;
                 created_at: string;
                 token: string;
+                user_identifier_key: string | null;
                 device_count: number;
                 connected_account_ids: string[];
                 connect_webview_ids: string[];
                 user_identity_ids: string[];
-                workspace_id: string;
             };
         };
     };
@@ -5260,14 +5262,14 @@ export interface Routes {
         jsonResponse: {
             client_sessions: Array<{
                 client_session_id: string;
-                user_identifier_key: string | null;
+                workspace_id: string;
                 created_at: string;
                 token: string;
+                user_identifier_key: string | null;
                 device_count: number;
                 connected_account_ids: string[];
                 connect_webview_ids: string[];
                 user_identity_ids: string[];
-                workspace_id: string;
             }>;
         };
     };

package/lib/seam/connect/schemas.d.ts

@@ -1 +1 @@
-export { action_attempt, connect_webview, custom_metadata, seam_event, workspace, } from './models/index.js';
+export { action_attempt, client_session, connect_webview, custom_metadata, seam_event, workspace, } from './models/index.js';

package/lib/seam/connect/schemas.js

@@ -1,2 +1,2 @@
-export { action_attempt, connect_webview, custom_metadata, seam_event, workspace, } from './models/index.js';
+export { action_attempt, client_session, connect_webview, custom_metadata, seam_event, workspace, } from './models/index.js';
 //# sourceMappingURL=schemas.js.map

package/lib/seam/connect/schemas.js.map

@@ -1 +1 @@
-{"version":3,"file":"schemas.js","sourceRoot":"","sources":["../../../src/lib/seam/connect/schemas.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,cAAc,EACd,eAAe,EACf,eAAe,EACf,UAAU,EACV,SAAS,GACV,MAAM,mBAAmB,CAAA"}
+{"version":3,"file":"schemas.js","sourceRoot":"","sources":["../../../src/lib/seam/connect/schemas.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,cAAc,EACd,cAAc,EACd,eAAe,EACf,eAAe,EACf,UAAU,EACV,SAAS,GACV,MAAM,mBAAmB,CAAA"}

package/package.json

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

package/src/lib/seam/connect/internal/enums.ts

@@ -1,9 +1,12 @@
 export {
+  ALL_DEVICE_PROVIDERS,
   LOCK_DEVICE_TYPE,
   LOCK_DEVICE_TYPE_LIST,
   NOISE_SENSOR_DEVICE_TYPE,
   NOISE_SENSOR_DEVICE_TYPE_LIST,
   PHONE_DEVICE_TYPE,
+  PROVIDER_CATEGORIES,
+  PUBLIC_PROVIDER_CATEGORIES,
   THERMOSTAT_DEVICE_TYPE,
   THERMOSTAT_DEVICE_TYPE_LIST,
 } from '../models/index.js'

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

@@ -21,9 +21,11 @@ export {
   climate_setting_schedule,
   common_device_properties,
   connect_webview_device_selection_mode,
+  connected_account,
   custom_metadata_input,
   device_capability_flags,
   device_metadata,
+  device_provider,
   dormakaba_oracode_time_slot,
   enrollment_automation,
   fan_mode_setting,
@@ -31,6 +33,7 @@ export {
   managed_access_code,
   managed_device,
   noise_sensor_device_type,
+  noise_threshold,
   phone,
   phone_number,
   thermostat_capability_properties,
@@ -38,6 +41,6 @@ export {
   unmanaged_access_code,
   unmanaged_device,
   user_identity,
-  workspace,
+  webhook,
 } from '../models/index.js'
 export * from '../schemas.js'

package/src/lib/seam/connect/models/acs/access_group.ts

@@ -27,6 +27,7 @@ export const acs_access_group = z.object({
     deprecated: use external_type_display_name
     ---
     `),
+  display_name: z.string(),
   external_type: acs_access_group_external_type,
   external_type_display_name: z.string(),
   created_at: z.string().datetime(),

package/src/lib/seam/connect/models/acs/seam-bridge.ts

@@ -5,26 +5,32 @@ const common_seam_bridge_error = z.object({
   message: z.string(),
 })
 
-const connection_failure = common_seam_bridge_error.extend({
-  error_code: z.literal('connection_failure'),
+const seam_bridge_unreachable = common_seam_bridge_error.extend({
+  error_code: z.literal('seam_bridge_unreachable'),
 })
-const bridge_tunnel_failed = common_seam_bridge_error.extend({
-  error_code: z.literal('bridge_tunnel_failed'),
+const failed_to_create_tunnel = common_seam_bridge_error.extend({
+  error_code: z.literal('failed_to_create_tunnel'),
 })
-const bridge_proxy_failure = common_seam_bridge_error.extend({
-  error_code: z.literal('bridge_proxy_failure'),
+const failed_to_create_proxy = common_seam_bridge_error.extend({
+  error_code: z.literal('failed_to_create_proxy'),
+})
+
+const managed_by_other_account = common_seam_bridge_error.extend({
+  error_code: z.literal('managed_by_other_account'),
 })
 
 export const seam_bridge_error_map = z.object({
-  bridge_tunnel_failed: bridge_tunnel_failed.optional().nullable(),
-  bridge_proxy_failure: bridge_proxy_failure.optional().nullable(),
-  connection_failure: connection_failure.optional().nullable(),
+  failed_to_create_tunnel: failed_to_create_tunnel.optional().nullable(),
+  failed_to_create_proxy: failed_to_create_proxy.optional().nullable(),
+  seam_bridge_unreachable: seam_bridge_unreachable.optional().nullable(),
+  managed_by_other_account: managed_by_other_account.optional().nullable(),
 })
 
 export const seam_bridge_error = z.union([
-  connection_failure,
-  bridge_proxy_failure,
-  bridge_tunnel_failed,
+  seam_bridge_unreachable,
+  failed_to_create_proxy,
+  failed_to_create_tunnel,
+  managed_by_other_account,
 ])
 
 export type SeamBridgeErrorMap = z.infer<typeof seam_bridge_error_map>

package/src/lib/seam/connect/models/client-sessions/client-session.ts

@@ -0,0 +1,13 @@
+import { z } from 'zod'
+
+export const client_session = z.object({
+  client_session_id: z.string().uuid(),
+  workspace_id: z.string().uuid(),
+  created_at: z.string().datetime(),
+  token: z.string(),
+  user_identifier_key: z.string().nullable(),
+  device_count: z.number(),
+  connected_account_ids: z.array(z.string().uuid()),
+  connect_webview_ids: z.array(z.string().uuid()),
+  user_identity_ids: z.array(z.string().uuid()),
+})

package/src/lib/seam/connect/models/client-sessions/index.ts

@@ -0,0 +1 @@
+export * from './client-session.js'

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

@@ -0,0 +1,23 @@
+import { z } from 'zod'
+
+import { custom_metadata } from '../custom-metadata.js'
+
+export const connected_account = z.object({
+  connected_account_id: z.string().uuid().optional(),
+  created_at: z.string().datetime().optional(),
+  user_identifier: z
+    .object({
+      username: z.string().optional(),
+      api_url: z.string().optional(),
+      email: z.string().optional(),
+      phone: z.string().optional(),
+      exclusive: z.boolean().optional(),
+    })
+    .optional(),
+  account_type: z.string().optional(),
+  account_type_display_name: z.string(),
+  errors: z.any(),
+  warnings: z.any(),
+  custom_metadata,
+  automatically_manage_new_devices: z.boolean(),
+})

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

@@ -0,0 +1 @@
+export * from './connected-account.js'

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

@@ -0,0 +1,116 @@
+import { z } from 'zod'
+
+export const DEVICE_PROVIDERS = {
+  AKUVOX: 'akuvox',
+  AUGUST: 'august',
+  AVIGILON_ALTA: 'avigilon_alta',
+  BRIVO: 'brivo',
+  BUTTERFLYMX: 'butterflymx',
+  SCHLAGE: 'schlage',
+  SMARTTHINGS: 'smartthings',
+  YALE: 'yale',
+  GENIE: 'genie',
+  DOORKING: 'doorking',
+  SALTO: 'salto',
+  LOCKLY: 'lockly',
+  TTLOCK: 'ttlock',
+  LINEAR: 'linear',
+  NOISEAWARE: 'noiseaware',
+  NUKI: 'nuki',
+  SEAM_RELAY_ADMIN: 'seam_relay_admin',
+  IGLOO: 'igloo',
+  KWIKSET: 'kwikset',
+  MINUT: 'minut',
+  MY_2N: 'my_2n',
+  CONTROLBYWEB: 'controlbyweb',
+  NEST: 'nest',
+  IGLOOHOME: 'igloohome',
+  ECOBEE: 'ecobee',
+  HUBITAT: 'hubitat',
+  FOUR_SUITES: 'four_suites',
+  DORMAKABA_ORACODE: 'dormakaba_oracode',
+  PTI: 'pti',
+  WYZE: 'wyze',
+  SEAM_PASSPORT: 'seam_passport',
+  VISIONLINE: 'visionline',
+  ASSA_ABLOY_CREDENTIAL_SERVICE: 'assa_abloy_credential_service',
+  SEAM_BRIDGE: 'seam_bridge',
+  TEDEE: 'tedee',
+  HONEYWELL_RESIDEO: 'honeywell_resideo',
+  LATCH: 'latch',
+} as const
+
+export type DeviceProvider =
+  (typeof DEVICE_PROVIDERS)[keyof typeof DEVICE_PROVIDERS]
+
+export const ALL_DEVICE_PROVIDERS: [DeviceProvider, ...DeviceProvider[]] =
+  Object.values(DEVICE_PROVIDERS) as any
+
+export type ProviderCategory = keyof typeof PROVIDER_CATEGORY_MAP
+
+export const PROVIDER_CATEGORY_MAP = {
+  stable: [
+    'august',
+    'avigilon_alta',
+    'brivo',
+    'schlage',
+    'smartthings',
+    'yale',
+    'nuki',
+    'salto',
+    'controlbyweb',
+    'minut',
+    'my_2n',
+    'kwikset',
+    'ttlock',
+    'noiseaware',
+    'igloohome',
+    'ecobee',
+    'four_suites',
+    'lockly',
+    'wyze',
+    'nest',
+    'tedee',
+    'seam_bridge',
+    'honeywell_resideo',
+    'visionline',
+    'assa_abloy_credential_service',
+    'latch',
+  ],
+
+  consumer_smartlocks: [
+    'august',
+    'schlage',
+    'yale',
+    'smartthings',
+    'nuki',
+    'ttlock',
+    'kwikset',
+    'igloohome',
+    'wyze',
+  ],
+
+  thermostats: ['ecobee', 'nest'],
+  noise_sensors: ['minut', 'noiseaware'],
+  access_control_systems: [
+    'pti',
+    'visionline',
+    'assa_abloy_credential_service',
+    'latch',
+  ],
+
+  internal_beta: ALL_DEVICE_PROVIDERS,
+} as const satisfies Record<string, readonly DeviceProvider[]>
+
+export const PROVIDER_CATEGORIES: [ProviderCategory, ...ProviderCategory[]] =
+  Object.keys(PROVIDER_CATEGORY_MAP) as any
+
+export const PUBLIC_PROVIDER_CATEGORIES: typeof PROVIDER_CATEGORIES =
+  PROVIDER_CATEGORIES.filter((category) => category !== 'internal_beta') as any
+
+export const device_provider = z.object({
+  device_provider_name: z.enum(ALL_DEVICE_PROVIDERS),
+  display_name: z.string(),
+  image_url: z.string(),
+  provider_categories: z.array(z.enum(PUBLIC_PROVIDER_CATEGORIES)),
+})

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

@@ -1,6 +1,8 @@
 export * from './capabilities-supported.js'
 export * from './device-metadata.js'
+export * from './device-provider.js'
 export * from './device-type.js'
 export * from './managed-device.js'
+export * from './noise-threshold.js'
 export * from './phone.js'
 export * from './unmanaged-device.js'

package/src/lib/seam/connect/models/devices/noise-threshold.ts

@@ -0,0 +1,11 @@
+import { z } from 'zod'
+
+export const noise_threshold = z.object({
+  noise_threshold_id: z.string().uuid(),
+  device_id: z.string().uuid(),
+  name: z.string(),
+  noise_threshold_nrs: z.number().optional(),
+  starts_daily_at: z.string(), // TODO: zoned_time
+  ends_daily_at: z.string(), // TODO: zoned_time
+  noise_threshold_decibels: z.number(),
+})

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

@@ -2,10 +2,13 @@ export * from './access-codes/index.js'
 export * from './acs/index.js'
 export * from './action-attempts/index.js'
 export * from './capability-properties/index.js'
+export * from './client-sessions/index.js'
 export * from './connect-webviews/index.js'
+export * from './connected-accounts/index.js'
 export * from './custom-metadata.js'
 export * from './devices/index.js'
 export * from './events/index.js'
 export * from './phone-number.js'
 export * from './user-identities/index.js'
+export * from './webhooks/index.js'
 export * from './workspaces/index.js'

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

@@ -0,0 +1 @@
+export * from './webhook.js'

package/src/lib/seam/connect/models/webhooks/webhook.ts

@@ -0,0 +1,8 @@
+import { z } from 'zod'
+
+export const webhook = z.object({
+  webhook_id: z.string(),
+  url: z.string(),
+  event_types: z.array(z.string()).optional(),
+  secret: z.string().optional(),
+})

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

@@ -158,6 +158,7 @@ export default {
           acs_access_group_id: { format: 'uuid', type: 'string' },
           acs_system_id: { format: 'uuid', type: 'string' },
           created_at: { format: 'date-time', type: 'string' },
+          display_name: { type: 'string' },
           external_type: {
             enum: [
               'pti_unit',
@@ -178,6 +179,7 @@ export default {
           'name',
           'access_group_type',
           'access_group_type_display_name',
+          'display_name',
           'external_type',
           'external_type_display_name',
           'created_at',
@@ -1635,14 +1637,14 @@ export default {
         },
         required: [
           'client_session_id',
-          'user_identifier_key',
+          'workspace_id',
           'created_at',
           'token',
+          'user_identifier_key',
           'device_count',
           'connected_account_ids',
           'connect_webview_ids',
           'user_identity_ids',
-          'workspace_id',
         ],
         type: 'object',
       },
@@ -9217,6 +9219,7 @@ export default {
           401: { description: 'Unauthorized' },
         },
         security: [
+          { client_session: [] },
           { api_key: [] },
           { pat_with_workspace: [] },
           { console_session: [] },
@@ -9911,6 +9914,7 @@ export default {
           401: { description: 'Unauthorized' },
         },
         security: [
+          { client_session: [] },
           { api_key: [] },
           { pat_with_workspace: [] },
           { console_session: [] },

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

@@ -3105,6 +3105,7 @@ export interface Routes {
             ---
              */
         access_group_type_display_name: string
+        display_name: string
         external_type:
           | 'pti_unit'
           | 'pti_access_level'
@@ -3147,6 +3148,7 @@ export interface Routes {
             ---
              */
         access_group_type_display_name: string
+        display_name: string
         external_type:
           | 'pti_unit'
           | 'pti_access_level'
@@ -5641,14 +5643,14 @@ export interface Routes {
     jsonResponse: {
       client_session: {
         client_session_id: string
-        user_identifier_key: string | null
+        workspace_id: string
         created_at: string
         token: string
+        user_identifier_key: string | null
         device_count: number
         connected_account_ids: string[]
         connect_webview_ids: string[]
         user_identity_ids: string[]
-        workspace_id: string
       }
     }
   }
@@ -5676,14 +5678,14 @@ export interface Routes {
     jsonResponse: {
       client_session: {
         client_session_id: string
-        user_identifier_key: string | null
+        workspace_id: string
         created_at: string
         token: string
+        user_identifier_key: string | null
         device_count: number
         connected_account_ids: string[]
         connect_webview_ids: string[]
         user_identity_ids: string[]
-        workspace_id: string
       }
     }
   }
@@ -5703,14 +5705,14 @@ export interface Routes {
     jsonResponse: {
       client_session: {
         client_session_id: string
-        user_identifier_key: string | null
+        workspace_id: string
         created_at: string
         token: string
+        user_identifier_key: string | null
         device_count: number
         connected_account_ids: string[]
         connect_webview_ids: string[]
         user_identity_ids: string[]
-        workspace_id: string
       }
     }
   }
@@ -5730,14 +5732,14 @@ export interface Routes {
     jsonResponse: {
       client_session: {
         client_session_id: string
-        user_identifier_key: string | null
+        workspace_id: string
         created_at: string
         token: string
+        user_identifier_key: string | null
         device_count: number
         connected_account_ids: string[]
         connect_webview_ids: string[]
         user_identity_ids: string[]
-        workspace_id: string
       }
     }
   }
@@ -5757,14 +5759,14 @@ export interface Routes {
     jsonResponse: {
       client_sessions: Array<{
         client_session_id: string
-        user_identifier_key: string | null
+        workspace_id: string
         created_at: string
         token: string
+        user_identifier_key: string | null
         device_count: number
         connected_account_ids: string[]
         connect_webview_ids: string[]
         user_identity_ids: string[]
-        workspace_id: string
       }>
     }
   }

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

@@ -1,5 +1,6 @@
 export {
   action_attempt,
+  client_session,
   connect_webview,
   custom_metadata,
   seam_event,