@seamapi/types 1.18.6 → 1.19.0

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

@@ -47,11 +47,20 @@ export default {
       },
       acs_access_group: {
         properties: {
-          access_group_type: { enum: ['pti_unit'], type: 'string' },
-          access_group_type_display_name: { type: 'string' },
+          access_group_type: {
+            description: 'deprecated: use external_type',
+            enum: ['pti_unit'],
+            type: 'string',
+          },
+          access_group_type_display_name: {
+            description: 'deprecated: use external_type_display_name',
+            type: 'string',
+          },
           acs_access_group_id: { format: 'uuid', type: 'string' },
           acs_system_id: { format: 'uuid', type: 'string' },
           created_at: { format: 'date-time', type: 'string' },
+          external_type: { enum: ['pti_unit'], type: 'string' },
+          external_type_display_name: { type: 'string' },
           name: { type: 'string' },
           workspace_id: { format: 'uuid', type: 'string' },
         },
@@ -62,6 +71,8 @@ export default {
           'name',
           'access_group_type',
           'access_group_type_display_name',
+          'external_type',
+          'external_type_display_name',
           'created_at',
         ],
         type: 'object',
@@ -70,12 +81,23 @@ export default {
         properties: {
           acs_system_id: { format: 'uuid', type: 'string' },
           created_at: { format: 'date-time', type: 'string' },
+          external_type: { enum: ['pti_site', 'alta_org'], type: 'string' },
+          external_type_display_name: { type: 'string' },
           name: { type: 'string' },
-          system_type: { enum: ['pti_site', 'alta_org'], type: 'string' },
-          system_type_display_name: { type: 'string' },
+          system_type: {
+            description: 'deprecated: use external_type',
+            enum: ['pti_site', 'alta_org'],
+            type: 'string',
+          },
+          system_type_display_name: {
+            description: 'deprecated: use external_type_display_name',
+            type: 'string',
+          },
         },
         required: [
           'acs_system_id',
+          'external_type',
+          'external_type_display_name',
           'system_type',
           'system_type_display_name',
           'name',
@@ -90,6 +112,8 @@ export default {
           created_at: { format: 'date-time', type: 'string' },
           display_name: { type: 'string' },
           email: { format: 'email', type: 'string' },
+          external_type: { enum: ['pti_user'], type: 'string' },
+          external_type_display_name: { type: 'string' },
           full_name: { type: 'string' },
           is_being_deleted: { type: 'boolean' },
           phone_number: { nullable: true, type: 'string' },
@@ -101,6 +125,8 @@ export default {
           'workspace_id',
           'created_at',
           'display_name',
+          'external_type',
+          'external_type_display_name',
           'is_being_deleted',
         ],
         type: 'object',
@@ -2269,7 +2295,10 @@ export default {
           content: {
             'application/json': {
               schema: {
-                properties: { device_id: { format: 'uuid', type: 'string' } },
+                properties: {
+                  device_id: { format: 'uuid', type: 'string' },
+                  user_identifier_key: { type: 'string' },
+                },
                 required: ['device_id'],
                 type: 'object',
               },
@@ -3054,6 +3083,8 @@ export default {
                         acs_user_id: { format: 'uuid', type: 'string' },
                         code: { nullable: true, type: 'string' },
                         created_at: { format: 'date-time', type: 'string' },
+                        external_type: { enum: ['pti_card'], type: 'string' },
+                        external_type_display_name: { type: 'string' },
                         workspace_id: { format: 'uuid', type: 'string' },
                       },
                       required: [
@@ -3061,6 +3092,8 @@ export default {
                         'acs_user_id',
                         'acs_system_id',
                         'code',
+                        'external_type',
+                        'external_type_display_name',
                         'created_at',
                         'workspace_id',
                       ],
@@ -3161,6 +3194,8 @@ export default {
                         acs_user_id: { format: 'uuid', type: 'string' },
                         code: { nullable: true, type: 'string' },
                         created_at: { format: 'date-time', type: 'string' },
+                        external_type: { enum: ['pti_card'], type: 'string' },
+                        external_type_display_name: { type: 'string' },
                         workspace_id: { format: 'uuid', type: 'string' },
                       },
                       required: [
@@ -3168,6 +3203,8 @@ export default {
                         'acs_user_id',
                         'acs_system_id',
                         'code',
+                        'external_type',
+                        'external_type_display_name',
                         'created_at',
                         'workspace_id',
                       ],
@@ -3224,6 +3261,8 @@ export default {
                           acs_user_id: { format: 'uuid', type: 'string' },
                           code: { nullable: true, type: 'string' },
                           created_at: { format: 'date-time', type: 'string' },
+                          external_type: { enum: ['pti_card'], type: 'string' },
+                          external_type_display_name: { type: 'string' },
                           workspace_id: { format: 'uuid', type: 'string' },
                         },
                         required: [
@@ -3231,6 +3270,8 @@ export default {
                           'acs_user_id',
                           'acs_system_id',
                           'code',
+                          'external_type',
+                          'external_type_display_name',
                           'created_at',
                           'workspace_id',
                         ],
@@ -3639,6 +3680,88 @@ export default {
         'x-fern-sdk-method-name': 'remove_from_access_group',
       },
     },
+    '/acs/users/suspend': {
+      post: {
+        operationId: 'acsUsersSuspendPost',
+        requestBody: {
+          content: {
+            'application/json': {
+              schema: {
+                properties: { acs_user_id: { format: 'uuid', type: 'string' } },
+                required: ['acs_user_id'],
+                type: 'object',
+              },
+            },
+          },
+        },
+        responses: {
+          200: {
+            content: {
+              'application/json': {
+                schema: {
+                  properties: { ok: { type: 'boolean' } },
+                  required: ['ok'],
+                  type: 'object',
+                },
+              },
+            },
+            description: 'OK',
+          },
+          400: { description: 'Bad Request' },
+          401: { description: 'Unauthorized' },
+        },
+        security: [
+          { access_token: [], seam_workspace: [] },
+          { seam_client_session_token: [] },
+          { client_session_token: [] },
+        ],
+        summary: '/acs/users/suspend',
+        tags: [],
+        'x-fern-sdk-group-name': ['acs', 'users'],
+        'x-fern-sdk-method-name': 'suspend',
+      },
+    },
+    '/acs/users/unsuspend': {
+      post: {
+        operationId: 'acsUsersUnsuspendPost',
+        requestBody: {
+          content: {
+            'application/json': {
+              schema: {
+                properties: { acs_user_id: { format: 'uuid', type: 'string' } },
+                required: ['acs_user_id'],
+                type: 'object',
+              },
+            },
+          },
+        },
+        responses: {
+          200: {
+            content: {
+              'application/json': {
+                schema: {
+                  properties: { ok: { type: 'boolean' } },
+                  required: ['ok'],
+                  type: 'object',
+                },
+              },
+            },
+            description: 'OK',
+          },
+          400: { description: 'Bad Request' },
+          401: { description: 'Unauthorized' },
+        },
+        security: [
+          { access_token: [], seam_workspace: [] },
+          { seam_client_session_token: [] },
+          { client_session_token: [] },
+        ],
+        summary: '/acs/users/unsuspend',
+        tags: [],
+        'x-fern-sdk-group-name': ['acs', 'users'],
+        'x-fern-sdk-method-name': 'unsuspend',
+      },
+    },
     '/acs/users/update': {
       patch: {
         operationId: 'acsUsersUpdatePatch',

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

@@ -389,6 +389,7 @@ export interface Routes {
     jsonBody: {}
     commonParams: {
       device_id: string
+      user_identifier_key?: string | undefined
     }
     formData: {}
     jsonResponse: {
@@ -499,8 +500,12 @@ export interface Routes {
         acs_system_id: string
         workspace_id: string
         name: string
+        /** deprecated: use external_type */
         access_group_type: 'pti_unit'
+        /** deprecated: use external_type_display_name */
         access_group_type_display_name: string
+        external_type: 'pti_unit'
+        external_type_display_name: string
         created_at: string
       }
     }
@@ -531,8 +536,12 @@ export interface Routes {
         acs_system_id: string
         workspace_id: string
         name: string
+        /** deprecated: use external_type */
         access_group_type: 'pti_unit'
+        /** deprecated: use external_type_display_name */
         access_group_type_display_name: string
+        external_type: 'pti_unit'
+        external_type_display_name: string
         created_at: string
       }
     }
@@ -553,8 +562,12 @@ export interface Routes {
         acs_system_id: string
         workspace_id: string
         name: string
+        /** deprecated: use external_type */
         access_group_type: 'pti_unit'
+        /** deprecated: use external_type_display_name */
         access_group_type_display_name: string
+        external_type: 'pti_unit'
+        external_type_display_name: string
         created_at: string
       }>
     }
@@ -575,6 +588,8 @@ export interface Routes {
         workspace_id: string
         created_at: string
         display_name: string
+        external_type: 'pti_user'
+        external_type_display_name: string
         is_being_deleted: boolean
         full_name?: string | undefined
         email?: string | undefined
@@ -622,6 +637,8 @@ export interface Routes {
         acs_user_id: string
         acs_system_id: string
         code: string | null
+        external_type: 'pti_card'
+        external_type_display_name: string
         created_at: string
         workspace_id: string
       }
@@ -653,6 +670,8 @@ export interface Routes {
         acs_user_id: string
         acs_system_id: string
         code: string | null
+        external_type: 'pti_card'
+        external_type_display_name: string
         created_at: string
         workspace_id: string
       }
@@ -673,6 +692,8 @@ export interface Routes {
         acs_user_id: string
         acs_system_id: string
         code: string | null
+        external_type: 'pti_card'
+        external_type_display_name: string
         created_at: string
         workspace_id: string
       }>
@@ -690,7 +711,11 @@ export interface Routes {
     jsonResponse: {
       acs_system: {
         acs_system_id: string
+        external_type: 'pti_site' | 'alta_org'
+        external_type_display_name: string
+        /** deprecated: use external_type */
         system_type: 'pti_site' | 'alta_org'
+        /** deprecated: use external_type_display_name */
         system_type_display_name: string
         name: string
         created_at: string
@@ -709,7 +734,11 @@ export interface Routes {
     jsonResponse: {
       acs_systems: Array<{
         acs_system_id: string
+        external_type: 'pti_site' | 'alta_org'
+        external_type_display_name: string
+        /** deprecated: use external_type */
         system_type: 'pti_site' | 'alta_org'
+        /** deprecated: use external_type_display_name */
         system_type_display_name: string
         name: string
         created_at: string
@@ -748,6 +777,8 @@ export interface Routes {
         workspace_id: string
         created_at: string
         display_name: string
+        external_type: 'pti_user'
+        external_type_display_name: string
         is_being_deleted: boolean
         full_name?: string | undefined
         email?: string | undefined
@@ -782,6 +813,8 @@ export interface Routes {
         workspace_id: string
         created_at: string
         display_name: string
+        external_type: 'pti_user'
+        external_type_display_name: string
         is_being_deleted: boolean
         full_name?: string | undefined
         email?: string | undefined
@@ -805,6 +838,8 @@ export interface Routes {
         workspace_id: string
         created_at: string
         display_name: string
+        external_type: 'pti_user'
+        external_type_display_name: string
         is_being_deleted: boolean
         full_name?: string | undefined
         email?: string | undefined
@@ -824,6 +859,28 @@ export interface Routes {
     formData: {}
     jsonResponse: {}
   }
+  '/acs/users/suspend': {
+    route: '/acs/users/suspend'
+    method: 'POST'
+    queryParams: {}
+    jsonBody: {}
+    commonParams: {
+      acs_user_id: string
+    }
+    formData: {}
+    jsonResponse: {}
+  }
+  '/acs/users/unsuspend': {
+    route: '/acs/users/unsuspend'
+    method: 'POST'
+    queryParams: {}
+    jsonBody: {}
+    commonParams: {
+      acs_user_id: string
+    }
+    formData: {}
+    jsonResponse: {}
+  }
   '/acs/users/update': {
     route: '/acs/users/update'
     method: 'POST' | 'PATCH'

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

@@ -1,10 +1,13 @@
 export type {
   AccessCodeConstraint,
   AcsAccessGroup,
-  AcsAccessGroupType,
+  AcsAccessGroupExternalType,
+  AcsCredential,
+  AcsCredentialExternalType,
   AcsSystem,
-  AcsSystemType,
+  AcsSystemExternalType,
   AcsUser,
+  AcsUserExternalType,
   AnyDeviceType,
   BatteryStatus,
   Capabilities,

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

@@ -1,17 +1,25 @@
 import { z } from 'zod'
 
 // If changed, update seam.acs_access_group.access_group_type check constraint
-export const acs_access_group_type = z.enum(['pti_unit'])
+export const acs_access_group_external_type = z.enum(['pti_unit'])
 
-export type AcsAccessGroupType = z.infer<typeof acs_access_group_type>
+export type AcsAccessGroupExternalType = z.infer<
+  typeof acs_access_group_external_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(),
+  access_group_type: acs_access_group_external_type.describe(
+    'deprecated: use external_type',
+  ),
+  access_group_type_display_name: z
+    .string()
+    .describe('deprecated: use external_type_display_name'),
+  external_type: acs_access_group_external_type,
+  external_type_display_name: z.string(),
   created_at: z.string().datetime(),
 })
 

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

@@ -1,10 +1,18 @@
 import { z } from 'zod'
 
+export const acs_credential_external_type = z.enum(['pti_card'])
+
+export type AcsCredentialExternalType = z.infer<
+  typeof acs_credential_external_type
+>
+
 export const acs_credential = z.object({
   acs_credential_id: z.string().uuid(),
   acs_user_id: z.string().uuid(),
   acs_system_id: z.string().uuid(),
   code: z.string().nullable(),
+  external_type: acs_credential_external_type,
+  external_type_display_name: z.string(),
   // TODO: credential_type: z.enum([...]) we don't know what enum types we want yet
   created_at: z.string().datetime(),
   workspace_id: z.string().uuid(),

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

@@ -1,14 +1,20 @@
 import { z } from 'zod'
 
 // If changed, update seam.acs_system.system_type check constraint
-export const acs_system_type = z.enum(['pti_site', 'alta_org'])
+export const acs_system_external_type = z.enum(['pti_site', 'alta_org'])
 
-export type AcsSystemType = z.infer<typeof acs_system_type>
+export type AcsSystemExternalType = z.infer<typeof acs_system_external_type>
 
 export const acs_system = z.object({
   acs_system_id: z.string().uuid(),
-  system_type: acs_system_type,
-  system_type_display_name: z.string(),
+  external_type: acs_system_external_type,
+  external_type_display_name: z.string(),
+  system_type: acs_system_external_type.describe(
+    'deprecated: use external_type',
+  ),
+  system_type_display_name: z
+    .string()
+    .describe('deprecated: use external_type_display_name'),
   name: z.string(),
   created_at: z.string().datetime(),
 })

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

@@ -1,5 +1,9 @@
 import { z } from 'zod'
 
+export const acs_user_external_type = z.enum(['pti_user'])
+
+export type AcsUserExternalType = z.infer<typeof acs_user_external_type>
+
 const phone_number = z.coerce
   .string()
   .trim()
@@ -26,6 +30,8 @@ export const acs_user = z
     workspace_id: z.string().uuid(),
     created_at: z.string().datetime(),
     display_name: z.string(),
+    external_type: acs_user_external_type,
+    external_type_display_name: z.string(),
     is_being_deleted: z.boolean(),
   })
   .merge(user_fields)

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

@@ -1,11 +1,13 @@
 export {
   access_code_code_constraint,
   acs_access_group,
-  acs_access_group_type,
+  acs_access_group_external_type,
   acs_credential,
+  acs_credential_external_type,
   acs_system,
-  acs_system_type,
+  acs_system_external_type,
   acs_user,
+  acs_user_external_type,
   any_device_type,
   battery_status,
   capabilities,

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

@@ -6,7 +6,7 @@ export const manufacturer = z.object({
   manufacturer_id: z.string().uuid(),
   display_name: z.string(),
   logo: image_reference.optional(),
-  integration: z.enum(['stable', 'beta', 'planned', 'unsupported']),
+  integration: z.enum(['stable', 'beta', 'planned', 'unsupported', 'inquire']),
   is_connect_webview_supported: z.boolean(),
   requires_seam_support_to_add_account: z.boolean(),
 })

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

@@ -21,7 +21,7 @@ export interface Routes {
                 height: number
               }
             | undefined
-          integration: 'stable' | 'beta' | 'planned' | 'unsupported'
+          integration: 'stable' | 'beta' | 'planned' | 'unsupported' | 'inquire'
           is_connect_webview_supported: boolean
           requires_seam_support_to_add_account: boolean
         }
@@ -116,7 +116,7 @@ export interface Routes {
       main_category?: string | undefined
       manufacturer_id?: string | undefined
       integration_status?:
-        | ('stable' | 'beta' | 'planned' | 'unsupported')
+        | ('stable' | 'beta' | 'planned' | 'unsupported' | 'inquire')
         | undefined
       text_search?: string | undefined
     }
@@ -137,7 +137,12 @@ export interface Routes {
                   height: number
                 }
               | undefined
-            integration: 'stable' | 'beta' | 'planned' | 'unsupported'
+            integration:
+              | 'stable'
+              | 'beta'
+              | 'planned'
+              | 'unsupported'
+              | 'inquire'
             is_connect_webview_supported: boolean
             requires_seam_support_to_add_account: boolean
           }
@@ -246,7 +251,7 @@ export interface Routes {
               height: number
             }
           | undefined
-        integration: 'stable' | 'beta' | 'planned' | 'unsupported'
+        integration: 'stable' | 'beta' | 'planned' | 'unsupported' | 'inquire'
         is_connect_webview_supported: boolean
         requires_seam_support_to_add_account: boolean
       }
@@ -270,7 +275,7 @@ export interface Routes {
               height: number
             }
           | undefined
-        integration: 'stable' | 'beta' | 'planned' | 'unsupported'
+        integration: 'stable' | 'beta' | 'planned' | 'unsupported' | 'inquire'
         is_connect_webview_supported: boolean
         requires_seam_support_to_add_account: boolean
       }>