@seamapi/types 1.5.0 → 1.7.0

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

@@ -1 +1 @@
-export { access_code_code_constraint, any_device_type, battery_status, capabilities, climate_setting, climate_setting_schedule, common_device_properties, lock_device_type, managed_device, noise_sensor_device_type, thermostat_device_type, unmanaged_device, } from './models/index.js';
+export { access_code_code_constraint, acs_access_group, acs_access_group_type, acs_system, acs_system_type, acs_user, any_device_type, battery_status, capabilities, climate_setting, climate_setting_schedule, common_device_properties, lock_device_type, managed_device, noise_sensor_device_type, thermostat_device_type, unmanaged_device, } from './models/index.js';

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

@@ -1,2 +1,2 @@
-export { access_code_code_constraint, any_device_type, battery_status, capabilities, climate_setting, climate_setting_schedule, common_device_properties, lock_device_type, managed_device, noise_sensor_device_type, thermostat_device_type, unmanaged_device, } from './models/index.js';
+export { access_code_code_constraint, acs_access_group, acs_access_group_type, acs_system, acs_system_type, acs_user, any_device_type, battery_status, capabilities, climate_setting, climate_setting_schedule, common_device_properties, lock_device_type, managed_device, noise_sensor_device_type, thermostat_device_type, unmanaged_device, } from './models/index.js';
 //# sourceMappingURL=schemas.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"schemas.js","sourceRoot":"","sources":["../../../../src/lib/seam/connect/unstable/schemas.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,2BAA2B,EAC3B,eAAe,EACf,cAAc,EACd,YAAY,EACZ,eAAe,EACf,wBAAwB,EACxB,wBAAwB,EACxB,gBAAgB,EAChB,cAAc,EACd,wBAAwB,EACxB,sBAAsB,EACtB,gBAAgB,GACjB,MAAM,mBAAmB,CAAA"}
+{"version":3,"file":"schemas.js","sourceRoot":"","sources":["../../../../src/lib/seam/connect/unstable/schemas.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,2BAA2B,EAC3B,gBAAgB,EAChB,qBAAqB,EACrB,UAAU,EACV,eAAe,EACf,QAAQ,EACR,eAAe,EACf,cAAc,EACd,YAAY,EACZ,eAAe,EACf,wBAAwB,EACxB,wBAAwB,EACxB,gBAAgB,EAChB,cAAc,EACd,wBAAwB,EACxB,sBAAsB,EACtB,gBAAgB,GACjB,MAAM,mBAAmB,CAAA"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@seamapi/types",
-  "version": "1.5.0",
+  "version": "1.7.0",
   "description": "TypeScript types for the Seam API.",
   "type": "module",
   "main": "index.js",
@@ -65,26 +65,26 @@
   "peerDependencies": {
     "zod": "^3.21.4"
   },
+  "dependencies": {
+    "type-fest": "^4.1.0"
+  },
   "devDependencies": {
     "@types/node": "^18.11.18",
     "concurrently": "^8.2.0",
     "del-cli": "^5.0.0",
     "eslint": "^8.9.0",
-    "eslint-config-prettier": "^8.4.0",
+    "eslint-config-prettier": "^9.0.0",
     "eslint-config-standard": "^17.1.0",
-    "eslint-config-standard-with-typescript": "^36.0.0",
+    "eslint-config-standard-with-typescript": "^39.0.0",
     "eslint-plugin-node": "^11.1.0",
     "eslint-plugin-simple-import-sort": "^10.0.0",
-    "eslint-plugin-unused-imports": "^2.0.0",
-    "patch-package": "^7.0.1",
+    "eslint-plugin-unused-imports": "^3.0.0",
+    "patch-package": "^8.0.0",
     "prettier": "^3.0.0",
     "tsc-alias": "^1.8.2",
     "tsup": "^7.1.0",
     "tsx": "^3.12.1",
     "typescript": "^5.0.2",
     "zod": "^3.21.4"
-  },
-  "dependencies": {
-    "type-fest": "^4.1.0"
   }
 }

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

@@ -478,11 +478,66 @@ export interface Routes {
         acs_system_id: string
         workspace_id: string
         name: string
-        acs_access_group_type: 'pti_unit'
-        created_at: string | Date
+        access_group_type: 'pti_unit'
+        access_group_type_display_name: string
+        created_at: string
       }
     }
   }
+  '/acs/access_groups/delete': {
+    route: '/acs/access_groups/delete'
+    method: 'DELETE' | 'POST'
+    queryParams: {}
+    jsonBody: {}
+    commonParams: {
+      acs_access_group_id: string
+    }
+    formData: {}
+    jsonResponse: {}
+  }
+  '/acs/access_groups/get': {
+    route: '/acs/access_groups/get'
+    method: 'GET' | 'POST'
+    queryParams: {}
+    jsonBody: {}
+    commonParams: {
+      acs_access_group_id: string
+    }
+    formData: {}
+    jsonResponse: {
+      acs_access_group: {
+        acs_access_group_id: string
+        acs_system_id: string
+        workspace_id: string
+        name: string
+        access_group_type: 'pti_unit'
+        access_group_type_display_name: string
+        created_at: string
+      }
+    }
+  }
+  '/acs/access_groups/list': {
+    route: '/acs/access_groups/list'
+    method: 'GET' | 'POST'
+    queryParams: {}
+    jsonBody: {}
+    commonParams: {
+      acs_access_system_id?: string | undefined
+      acs_user_id?: string | undefined
+    }
+    formData: {}
+    jsonResponse: {
+      acs_access_groups: Array<{
+        acs_access_group_id: string
+        acs_system_id: string
+        workspace_id: string
+        name: string
+        access_group_type: 'pti_unit'
+        access_group_type_display_name: string
+        created_at: string
+      }>
+    }
+  }
   '/acs/access_groups/update': {
     route: '/acs/access_groups/update'
     method: 'POST' | 'PATCH'
@@ -508,8 +563,9 @@ export interface Routes {
       acs_system: {
         acs_system_id: string
         system_type: 'pti_site' | 'alta_org'
+        system_type_display_name: string
         name: string
-        created_at: string | Date
+        created_at: string
       }
     }
   }
@@ -524,8 +580,9 @@ export interface Routes {
       acs_systems: Array<{
         acs_system_id: string
         system_type: 'pti_site' | 'alta_org'
+        system_type_display_name: string
         name: string
-        created_at: string | Date
+        created_at: string
       }>
     }
   }
@@ -548,9 +605,10 @@ export interface Routes {
     jsonBody: {}
     commonParams: {
       acs_system_id: string
-      name?: string | undefined
-      email?: string | undefined
       acs_access_group_ids?: string[]
+      full_name?: string | undefined
+      email?: string | undefined
+      phone_number?: string | undefined
     }
     formData: {}
     jsonResponse: {
@@ -558,11 +616,69 @@ export interface Routes {
         acs_user_id: string
         acs_system_id: string
         workspace_id: string
-        name: string
-        created_at: string | Date
+        created_at: string
+        display_name: string
+        full_name?: string | undefined
+        email?: string | undefined
+        phone_number?: string | undefined
       }
     }
   }
+  '/acs/users/delete': {
+    route: '/acs/users/delete'
+    method: 'DELETE' | 'POST'
+    queryParams: {}
+    jsonBody: {}
+    commonParams: {
+      acs_user_id: string
+    }
+    formData: {}
+    jsonResponse: {}
+  }
+  '/acs/users/get': {
+    route: '/acs/users/get'
+    method: 'GET' | 'POST'
+    queryParams: {}
+    jsonBody: {}
+    commonParams: {
+      acs_user_id: string
+    }
+    formData: {}
+    jsonResponse: {
+      acs_user: {
+        acs_user_id: string
+        acs_system_id: string
+        workspace_id: string
+        created_at: string
+        display_name: string
+        full_name?: string | undefined
+        email?: string | undefined
+        phone_number?: string | undefined
+      }
+    }
+  }
+  '/acs/users/list': {
+    route: '/acs/users/list'
+    method: 'GET' | 'POST'
+    queryParams: {}
+    jsonBody: {}
+    commonParams: {
+      acs_system_id: string
+    }
+    formData: {}
+    jsonResponse: {
+      acs_users: Array<{
+        acs_user_id: string
+        acs_system_id: string
+        workspace_id: string
+        created_at: string
+        display_name: string
+        full_name?: string | undefined
+        email?: string | undefined
+        phone_number?: string | undefined
+      }>
+    }
+  }
   '/acs/users/remove_from_access_group': {
     route: '/acs/users/remove_from_access_group'
     method: 'POST' | 'PATCH'
@@ -582,8 +698,9 @@ export interface Routes {
     jsonBody: {}
     commonParams: {
       acs_user_id: string
-      name?: (string | null) | undefined
-      email?: (string | null) | undefined
+      full_name?: string | undefined
+      email?: string | undefined
+      phone_number?: string | undefined
     }
     formData: {}
     jsonResponse: {}
@@ -948,6 +1065,7 @@ export interface Routes {
             }
           | undefined
         account_type?: string | undefined
+        account_type_display_name: string
         errors?: any
         warnings?: any
         custom_metadata?:
@@ -977,6 +1095,7 @@ export interface Routes {
             }
           | undefined
         account_type?: string | undefined
+        account_type_display_name: string
         errors?: any
         warnings?: any
         custom_metadata?:

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

@@ -1,5 +1,10 @@
 export type {
   AccessCodeConstraint,
+  AcsAccessGroup,
+  AcsAccessGroupType,
+  AcsSystem,
+  AcsSystemType,
+  AcsUser,
   AnyDeviceType,
   BatteryStatus,
   Capabilities,

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

@@ -0,0 +1,17 @@
+import { z } from 'zod'
+
+export const acs_access_group_type = z.enum(['pti_unit'])
+
+export type AcsAccessGroupType = z.infer<typeof acs_access_group_type>
+
+export const acs_access_group = z.object({
+  acs_access_group_id: z.string().uuid(),
+  acs_system_id: z.string().uuid(),
+  workspace_id: z.string().uuid(),
+  name: z.string(),
+  access_group_type: acs_access_group_type,
+  access_group_type_display_name: z.string(),
+  created_at: z.string().datetime(),
+})
+
+export type AcsAccessGroup = z.output<typeof acs_access_group>

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

@@ -0,0 +1,3 @@
+export * from './access_group.js'
+export * from './system.js'
+export * from './user.js'

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

@@ -0,0 +1,15 @@
+import { z } from 'zod'
+
+export const acs_system_type = z.enum(['pti_site', 'alta_org'])
+
+export type AcsSystemType = z.infer<typeof acs_system_type>
+
+export const acs_system = z.object({
+  acs_system_id: z.string().uuid(),
+  system_type: acs_system_type,
+  system_type_display_name: z.string(),
+  name: z.string(),
+  created_at: z.string().datetime(),
+})
+
+export type AcsSystem = z.output<typeof acs_system>

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

@@ -0,0 +1,31 @@
+import { z } from 'zod'
+
+const user_fields = z.object({
+  full_name: z.string().optional(),
+  email: z.string().email().optional(),
+  phone_number: z.coerce
+    .string()
+    .trim()
+    .refine(
+      (val) => {
+        // https://www.twilio.com/docs/glossary/what-e164
+        return /^\+[1-9]\d{1,14}$/.test(val)
+      },
+      {
+        message: 'Phone number must be in E.164 format: +14155552671',
+      },
+    )
+    .optional(),
+})
+
+export const acs_user = z
+  .object({
+    acs_user_id: z.string().uuid(),
+    acs_system_id: z.string().uuid(),
+    workspace_id: z.string().uuid(),
+    created_at: z.string().datetime(),
+    display_name: z.string(),
+  })
+  .merge(user_fields)
+
+export type AcsUser = z.output<typeof acs_user>

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

@@ -1,3 +1,4 @@
+export * from './acs/index.js'
 export * from './capabilities-supported.js'
 export * from './capability-properties/index.js'
 export * from './device-type.js'

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

@@ -1,5 +1,10 @@
 export {
   access_code_code_constraint,
+  acs_access_group,
+  acs_access_group_type,
+  acs_system,
+  acs_system_type,
+  acs_user,
   any_device_type,
   battery_status,
   capabilities,