@seamapi/types 1.1003.0 → 1.1005.0

package/src/lib/seam/devicedb/models/manufacturer.ts

@@ -1,54 +0,0 @@
-import { z } from 'zod'
-
-import { image_reference } from './image-reference.js'
-
-export const manufacturer_integration_support_level = z.enum([
-  'stable',
-  'beta',
-  'planned',
-  'unsupported',
-  'inquire',
-])
-
-export type ManufacturerIntegrationSupportLevel = z.infer<
-  typeof manufacturer_integration_support_level
->
-
-export const manufacturer_annotation_code = z.enum(['subscription_required'])
-
-export type ManufacturerAnnotationCode = z.infer<
-  typeof manufacturer_annotation_code
->
-
-export const manufacturer_annotation = z.object({
-  annotation_code: manufacturer_annotation_code,
-  message: z.string().trim().nonempty(),
-})
-
-export type ManufacturerAnnotation = z.infer<typeof manufacturer_annotation>
-
-export const manufacturer = z.object({
-  manufacturer_id: z.string().uuid(),
-  display_name: z.string(),
-  logo: image_reference.optional(),
-  /** @deprecated */
-  integration: manufacturer_integration_support_level,
-  integration_support_level: manufacturer_integration_support_level,
-  is_connect_webview_supported: z.boolean(),
-  requires_seam_support_to_add_account: z.boolean(),
-  device_model_count: z.number(),
-  annotations: z.array(manufacturer_annotation),
-  website: z.string().url().optional(),
-  legal_name: z.string().optional(),
-  parent_organization: z.string().optional(),
-  headquarters: z.array(z.string()).optional(),
-  countries_of_origin: z.array(z.string()).optional(),
-  founding_year: z.string().optional(),
-  us_customer_support_tel: z.string().optional(),
-  us_customer_support_email: z.string().email().optional(),
-  us_customer_support_contact_url: z.string().url().optional(),
-  seam_api_guide: z.string().optional(),
-  description: z.string().optional(),
-})
-
-export type Manufacturer = z.infer<typeof manufacturer>

package/src/lib/seam/devicedb/route-specs.ts

@@ -1,63 +0,0 @@
-import { z } from 'zod'
-
-import * as schemas from './models/index.js'
-
-const dot_path = z.string().regex(/^([a-z])[a-z_.]*[a-z]+$/)
-
-export const routes = {
-  '/api/v1/device_models/get': {
-    auth: 'publishable_key',
-    methods: ['GET', 'OPTIONS'],
-    queryParams: z.object({
-      device_model_id: z.string().uuid(),
-    }),
-    jsonResponse: z.object({
-      device_model: schemas.device_model_v1,
-    }),
-  },
-  '/api/v1/device_models/list': {
-    auth: 'publishable_key',
-    methods: ['GET', 'OPTIONS'],
-    queryParams: z.object({
-      main_category: schemas.device_category.optional(),
-      manufacturer_id: z.string().uuid().optional(),
-      manufacturer_ids: z.string().uuid().array().optional(),
-      /** @deprecated */
-      integration_status: schemas.manufacturer.shape.integration.optional(),
-      integration_support_levels: z
-        .array(schemas.manufacturer_integration_support_level)
-        .optional(),
-      text_search: z.string().optional(),
-      include_if: z.array(dot_path).optional(),
-      exclude_if: z.array(dot_path).optional(),
-    }),
-    jsonResponse: z.object({
-      device_models: schemas.device_model_v1.array(),
-    }),
-  },
-  '/api/v1/manufacturers/get': {
-    auth: 'publishable_key',
-    methods: ['GET', 'OPTIONS'],
-    queryParams: z.object({
-      manufacturer_id: z.string().uuid(),
-    }),
-    jsonResponse: z.object({
-      manufacturer: schemas.manufacturer,
-    }),
-  },
-  '/api/v1/manufacturers/list': {
-    auth: 'publishable_key',
-    methods: ['GET', 'OPTIONS'],
-    queryParams: z.object({
-      /** @deprecated */
-      integration_status: schemas.manufacturer.shape.integration.optional(),
-      integration_support_levels: z
-        .array(schemas.manufacturer_integration_support_level)
-        .optional(),
-      liqe_query: z.string().optional(),
-    }),
-    jsonResponse: z.object({
-      manufacturers: schemas.manufacturer.array(),
-    }),
-  },
-} as const

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

@@ -1,450 +0,0 @@
-export interface Routes {
-  '/v1/device_models/get': {
-    route: '/v1/device_models/get'
-    method: 'GET' | 'OPTIONS'
-    queryParams: {
-      device_model_id: string
-    }
-    jsonBody: {}
-    commonParams: {}
-    formData: {}
-    jsonResponse: {
-      device_model: {
-        device_model_id: string
-        manufacturer: {
-          manufacturer_id: string
-          display_name: string
-          logo?:
-            | {
-                url: string
-                width: number
-                height: number
-              }
-            | undefined
-          integration: 'stable' | 'beta' | 'planned' | 'unsupported' | 'inquire'
-          integration_support_level:
-            'stable' | 'beta' | 'planned' | 'unsupported' | 'inquire'
-          is_connect_webview_supported: boolean
-          requires_seam_support_to_add_account: boolean
-          annotations: Array<{
-            annotation_code: 'subscription_required'
-            message: string
-          }>
-          website?: string | undefined
-          legal_name?: string | undefined
-          parent_organization?: string | undefined
-          headquarters?: string[] | undefined
-          countries_of_origin?: string[] | undefined
-          founding_year?: string | undefined
-          us_customer_support_tel?: string | undefined
-          us_customer_support_email?: string | undefined
-          us_customer_support_contact_url?: string | undefined
-          seam_api_guide?: string | undefined
-          description?: string | undefined
-        }
-        is_device_supported: boolean
-        display_name: string
-        description: string
-        product_url?: string | undefined
-        main_connection_type: 'wifi' | 'zwave' | 'zigbee' | 'unknown'
-        hardware: {
-          has_physical_key?: boolean | undefined
-        }
-        aesthetic_variants: Array<{
-          slug: string
-          display_name: string
-          primary_color_hex?: string | undefined
-          manufacturer_sku?: string | undefined
-          front_image?:
-            | {
-                url: string
-                width: number
-                height: number
-              }
-            | undefined
-          back_image?:
-            | {
-                url: string
-                width: number
-                height: number
-              }
-            | undefined
-          images: Array<{
-            url: string
-            width: number
-            height: number
-          }>
-        }>
-        power_sources: Array<
-          | 'battery'
-          | 'hardwired'
-          | 'mechanical_harvesting'
-          | 'wireless'
-          | 'ethernet'
-        >
-      } & (
-        | {
-            main_category: 'smartlock'
-            physical_properties: {
-              lock_type:
-                | 'deadbolt'
-                | 'lever'
-                | 'mortise'
-                | 'lockbox'
-                | 'cylinder'
-                | 'padlock'
-                | 'locker'
-                | 'unknown'
-              has_physical_key: boolean
-              has_camera: boolean
-            }
-            software_features: {
-              can_remotely_unlock: boolean
-              can_program_access_codes: boolean
-              can_program_access_schedules: boolean
-              can_program_access_codes_offline: boolean
-            }
-            can_remotely_lock?: true | undefined
-            can_remotely_unlock?: true | undefined
-            can_program_offline_access_codes?: true | undefined
-            can_program_online_access_codes?: true | undefined
-          }
-        | {
-            main_category: 'sensor'
-            physical_properties: {
-              has_noise_sensor: boolean
-              has_humidity_sensor: boolean
-              has_temperature_sensor: boolean
-              has_occupancy_detection: boolean
-            }
-          }
-        | {
-            main_category: 'thermostat'
-            physical_properties: {
-              available_modes: Array<'heat' | 'cool' | 'fan' | 'eco'>
-              is_heat_pump_compatible: boolean
-              has_occupancy_detection: boolean
-              supports_demand_response: boolean
-              has_humidity_sensor: boolean
-              has_temperature_sensor: boolean
-              supports_emergency_heating_mode: boolean
-            }
-            software_features: {
-              can_program_climate_schedules: boolean
-            }
-            can_hvac_heat?: true | undefined
-            can_hvac_cool?: true | undefined
-            can_hvac_heat_cool?: true | undefined
-            can_turn_off_hvac?: true | undefined
-          }
-        | {
-            main_category: 'relay'
-          }
-        | {
-            main_category: 'intercom'
-            physical_properties: {
-              has_camera: boolean
-              has_rfid_reader?: boolean
-              has_nfc_reader?: boolean
-              has_wiegand_interface?: boolean
-            }
-            software_features: {
-              can_remotely_unlock: boolean
-              can_program_access_codes: boolean
-              can_unlock_with_face_recognition?: boolean
-              supports_onvif?: boolean
-            }
-          }
-        | {
-            main_category: 'accessory'
-          }
-      )
-    }
-  }
-  '/v1/device_models/list': {
-    route: '/v1/device_models/list'
-    method: 'GET' | 'OPTIONS'
-    queryParams: {
-      main_category?:
-        | (
-            | 'smartlock'
-            | 'sensor'
-            | 'thermostat'
-            | 'relay'
-            | 'intercom'
-            | 'accessory'
-          )
-        | undefined
-      manufacturer_id?: string | undefined
-      manufacturer_ids?: string[] | undefined
-      integration_status?:
-        ('stable' | 'beta' | 'planned' | 'unsupported' | 'inquire') | undefined
-      integration_support_levels?:
-        | Array<'stable' | 'beta' | 'planned' | 'unsupported' | 'inquire'>
-        | undefined
-      text_search?: string | undefined
-      include_if?: string[] | undefined
-      exclude_if?: string[] | undefined
-    }
-    jsonBody: {}
-    commonParams: {}
-    formData: {}
-    jsonResponse: {
-      device_models: Array<
-        {
-          device_model_id: string
-          manufacturer: {
-            manufacturer_id: string
-            display_name: string
-            logo?:
-              | {
-                  url: string
-                  width: number
-                  height: number
-                }
-              | undefined
-            integration:
-              'stable' | 'beta' | 'planned' | 'unsupported' | 'inquire'
-            integration_support_level:
-              'stable' | 'beta' | 'planned' | 'unsupported' | 'inquire'
-            is_connect_webview_supported: boolean
-            requires_seam_support_to_add_account: boolean
-            annotations: Array<{
-              annotation_code: 'subscription_required'
-              message: string
-            }>
-            website?: string | undefined
-            legal_name?: string | undefined
-            parent_organization?: string | undefined
-            headquarters?: string[] | undefined
-            countries_of_origin?: string[] | undefined
-            founding_year?: string | undefined
-            us_customer_support_tel?: string | undefined
-            us_customer_support_email?: string | undefined
-            us_customer_support_contact_url?: string | undefined
-            seam_api_guide?: string | undefined
-            description?: string | undefined
-          }
-          is_device_supported: boolean
-          display_name: string
-          description: string
-          product_url?: string | undefined
-          main_connection_type: 'wifi' | 'zwave' | 'zigbee' | 'unknown'
-          hardware: {
-            has_physical_key?: boolean | undefined
-          }
-          aesthetic_variants: Array<{
-            slug: string
-            display_name: string
-            primary_color_hex?: string | undefined
-            manufacturer_sku?: string | undefined
-            front_image?:
-              | {
-                  url: string
-                  width: number
-                  height: number
-                }
-              | undefined
-            back_image?:
-              | {
-                  url: string
-                  width: number
-                  height: number
-                }
-              | undefined
-            images: Array<{
-              url: string
-              width: number
-              height: number
-            }>
-          }>
-          power_sources: Array<
-            | 'battery'
-            | 'hardwired'
-            | 'mechanical_harvesting'
-            | 'wireless'
-            | 'ethernet'
-          >
-        } & (
-          | {
-              main_category: 'smartlock'
-              physical_properties: {
-                lock_type:
-                  | 'deadbolt'
-                  | 'lever'
-                  | 'mortise'
-                  | 'lockbox'
-                  | 'cylinder'
-                  | 'padlock'
-                  | 'locker'
-                  | 'unknown'
-                has_physical_key: boolean
-                has_camera: boolean
-              }
-              software_features: {
-                can_remotely_unlock: boolean
-                can_program_access_codes: boolean
-                can_program_access_schedules: boolean
-                can_program_access_codes_offline: boolean
-              }
-              can_remotely_lock?: true | undefined
-              can_remotely_unlock?: true | undefined
-              can_program_offline_access_codes?: true | undefined
-              can_program_online_access_codes?: true | undefined
-            }
-          | {
-              main_category: 'sensor'
-              physical_properties: {
-                has_noise_sensor: boolean
-                has_humidity_sensor: boolean
-                has_temperature_sensor: boolean
-                has_occupancy_detection: boolean
-              }
-            }
-          | {
-              main_category: 'thermostat'
-              physical_properties: {
-                available_modes: Array<'heat' | 'cool' | 'fan' | 'eco'>
-                is_heat_pump_compatible: boolean
-                has_occupancy_detection: boolean
-                supports_demand_response: boolean
-                has_humidity_sensor: boolean
-                has_temperature_sensor: boolean
-                supports_emergency_heating_mode: boolean
-              }
-              software_features: {
-                can_program_climate_schedules: boolean
-              }
-              can_hvac_heat?: true | undefined
-              can_hvac_cool?: true | undefined
-              can_hvac_heat_cool?: true | undefined
-              can_turn_off_hvac?: true | undefined
-            }
-          | {
-              main_category: 'relay'
-            }
-          | {
-              main_category: 'intercom'
-              physical_properties: {
-                has_camera: boolean
-                has_rfid_reader?: boolean
-                has_nfc_reader?: boolean
-                has_wiegand_interface?: boolean
-              }
-              software_features: {
-                can_remotely_unlock: boolean
-                can_program_access_codes: boolean
-                can_unlock_with_face_recognition?: boolean
-                supports_onvif?: boolean
-              }
-            }
-          | {
-              main_category: 'accessory'
-            }
-        )
-      >
-    }
-  }
-  '/v1/manufacturers/get': {
-    route: '/v1/manufacturers/get'
-    method: 'GET' | 'OPTIONS'
-    queryParams: {
-      manufacturer_id: string
-    }
-    jsonBody: {}
-    commonParams: {}
-    formData: {}
-    jsonResponse: {
-      manufacturer: {
-        manufacturer_id: string
-        display_name: string
-        logo?:
-          | {
-              url: string
-              width: number
-              height: number
-            }
-          | undefined
-        integration: 'stable' | 'beta' | 'planned' | 'unsupported' | 'inquire'
-        integration_support_level:
-          'stable' | 'beta' | 'planned' | 'unsupported' | 'inquire'
-        is_connect_webview_supported: boolean
-        requires_seam_support_to_add_account: boolean
-        device_model_count: number
-        annotations: Array<{
-          annotation_code: 'subscription_required'
-          message: string
-        }>
-        website?: string | undefined
-        legal_name?: string | undefined
-        parent_organization?: string | undefined
-        headquarters?: string[] | undefined
-        countries_of_origin?: string[] | undefined
-        founding_year?: string | undefined
-        us_customer_support_tel?: string | undefined
-        us_customer_support_email?: string | undefined
-        us_customer_support_contact_url?: string | undefined
-        seam_api_guide?: string | undefined
-        description?: string | undefined
-      }
-    }
-  }
-  '/v1/manufacturers/list': {
-    route: '/v1/manufacturers/list'
-    method: 'GET' | 'OPTIONS'
-    queryParams: {
-      integration_status?:
-        ('stable' | 'beta' | 'planned' | 'unsupported' | 'inquire') | undefined
-      integration_support_levels?:
-        | Array<'stable' | 'beta' | 'planned' | 'unsupported' | 'inquire'>
-        | undefined
-      liqe_query?: string | undefined
-    }
-    jsonBody: {}
-    commonParams: {}
-    formData: {}
-    jsonResponse: {
-      manufacturers: Array<{
-        manufacturer_id: string
-        display_name: string
-        logo?:
-          | {
-              url: string
-              width: number
-              height: number
-            }
-          | undefined
-        integration: 'stable' | 'beta' | 'planned' | 'unsupported' | 'inquire'
-        integration_support_level:
-          'stable' | 'beta' | 'planned' | 'unsupported' | 'inquire'
-        is_connect_webview_supported: boolean
-        requires_seam_support_to_add_account: boolean
-        device_model_count: number
-        annotations: Array<{
-          annotation_code: 'subscription_required'
-          message: string
-        }>
-        website?: string | undefined
-        legal_name?: string | undefined
-        parent_organization?: string | undefined
-        headquarters?: string[] | undefined
-        countries_of_origin?: string[] | undefined
-        founding_year?: string | undefined
-        us_customer_support_tel?: string | undefined
-        us_customer_support_email?: string | undefined
-        us_customer_support_contact_url?: string | undefined
-        seam_api_guide?: string | undefined
-        description?: string | undefined
-      }>
-    }
-  }
-}
-
-export type RouteResponse<Path extends keyof Routes> =
-  Routes[Path]['jsonResponse']
-
-export type RouteRequestBody<Path extends keyof Routes> =
-  Routes[Path]['jsonBody'] & Routes[Path]['commonParams']
-
-export type RouteRequestParams<Path extends keyof Routes> =
-  Routes[Path]['queryParams'] & Routes[Path]['commonParams']