@seamapi/types 1.872.0 → 1.874.0

package/src/lib/seam/connect/models/access-codes/managed-access-code.ts

@@ -187,19 +187,14 @@ const kwikset_unable_to_confirm_deletion = common_access_code_error
     `,
   )
 
-const kwikset_insufficient_permissions = common_access_code_error
+const insufficient_permissions = common_access_code_error
   .extend({
     error_code: z
-      .literal('kwikset_insufficient_permissions')
+      .literal('insufficient_permissions')
       .describe(error_code_description),
   })
   .describe(
-    `
-    ---
-    deprecated: Use \`provider_issue\` instead.
-    ---
-    Admin role required—insufficient permissions to manage PINs on this Kwikset device. Please have a Home Admin update your role in the Kwikset app, or ask them to set the PIN.
-    `,
+    'Admin role required—insufficient permissions to manage PINs on this device. Please have an admin update your role, or ask them to set the PIN.',
   )
 
 const august_lock_invalid_code_length = common_access_code_error
@@ -365,7 +360,7 @@ const access_code_error = z
     wyze_duplicate_code_name,
     wyze_potential_duplicate_code,
     dormakaba_oracode_invalid_time_range,
-    kwikset_insufficient_permissions,
+    insufficient_permissions,
     keynest_unsupported_third_party_locker,
     replaced_by_newer_access_code,
   ])
@@ -401,9 +396,7 @@ const _access_code_error_map = z.object({
   kwikset_unable_to_confirm_deletion: kwikset_unable_to_confirm_deletion
     .optional()
     .nullable(),
-  kwikset_insufficient_permissions: kwikset_insufficient_permissions
-    .optional()
-    .nullable(),
+  insufficient_permissions: insufficient_permissions.optional().nullable(),
   code_modified_external_to_seam_error: code_modified_external_to_seam_error
     .optional()
     .nullable(),

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

@@ -59,11 +59,22 @@ const entrance_setup_required = common_acs_entrance_warning
     'Indicates that this entrance requires additional configuration in the access control system before Seam can fully manage it.',
   )
 
+const salto_ks_privacy_mode = common_acs_entrance_warning
+  .extend({
+    warning_code: z
+      .literal('salto_ks_privacy_mode')
+      .describe(warning_code_description),
+  })
+  .describe(
+    'Indicates that this entrance is in privacy mode. When privacy mode is enabled, access codes, mobile keys, and remote unlocks will not work unless the user has admin access.',
+  )
+
 const acs_entrance_warning = z
   .discriminatedUnion('warning_code', [
     salto_ks_entrance_access_code_support_removed,
     entrance_shares_zone,
     entrance_setup_required,
+    salto_ks_privacy_mode,
   ])
   .describe(
     'Warning associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
@@ -74,6 +85,7 @@ const _acs_entrance_warning_map = z.object({
     salto_ks_entrance_access_code_support_removed.optional().nullable(),
   entrance_shares_zone: entrance_shares_zone.optional().nullable(),
   entrance_setup_required: entrance_setup_required.optional().nullable(),
+  salto_ks_privacy_mode: salto_ks_privacy_mode.optional().nullable(),
 })
 
 export type AcsEntranceWarningMap = z.infer<typeof _acs_entrance_warning_map>
@@ -218,6 +230,12 @@ export const acs_entrance = z
       .describe(
         'Avigilon Alta-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
       ),
+    is_locked: z
+      .boolean()
+      .optional()
+      .describe(
+        'Indicates whether the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) is currently locked.',
+      ),
   })
   .merge(acs_entrance_capability_flags).describe(`
   ---

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

@@ -1,4 +1,4 @@
-import { z } from 'zod'
+import { z, type ZodTypeAny } from 'zod'
 
 import { access_code, unmanaged_access_code } from './access-codes/index.js'
 import { access_grant } from './access-grants/access-grant.js'
@@ -32,7 +32,43 @@ import {
 import { user_identity } from './user-identities/index.js'
 import { workspace } from './workspaces/index.js'
 
-export const batch = z.object({
+type BatchKey =
+  | 'user_identities'
+  | 'workspaces'
+  | 'spaces'
+  | 'devices'
+  | 'connected_accounts'
+  | 'acs_entrances'
+  | 'acs_systems'
+  | 'acs_users'
+  | 'acs_access_groups'
+  | 'acs_encoders'
+  | 'acs_credentials'
+  | 'unmanaged_acs_credentials'
+  | 'action_attempts'
+  | 'client_sessions'
+  | 'unmanaged_acs_users'
+  | 'unmanaged_acs_access_groups'
+  | 'unmanaged_devices'
+  | 'connect_webviews'
+  | 'access_methods'
+  | 'access_grants'
+  | 'events'
+  | 'instant_keys'
+  | 'access_codes'
+  | 'unmanaged_access_codes'
+  | 'thermostat_daily_programs'
+  | 'thermostat_schedules'
+  | 'noise_thresholds'
+  | 'customization_profiles'
+
+// Explicit annotation prevents tsgo TS7056 — the device/access-code
+// discriminated unions push the inferred literal past the serialization cap.
+type BatchShape = z.ZodObject<
+  Record<BatchKey, z.ZodOptional<z.ZodArray<ZodTypeAny>>>
+>
+
+export const batch: BatchShape = z.object({
   user_identities: user_identity.array().optional(),
   workspaces: workspace.array().optional(),
   spaces: space.array().optional(),

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

@@ -524,6 +524,17 @@ const max_access_codes_reached = common_device_warning.extend({
     Indicates that the device has reached its maximum number of active access codes. Delete existing codes before creating new ones.
     `)
 
+const insufficient_permissions = common_device_warning.extend({
+  warning_code: z
+    .literal('insufficient_permissions')
+    .describe(warning_code_description),
+}).describe(`
+    ---
+    variant_group_key: locks
+    ---
+    Indicates that the connected Kwikset account has member-level access to this lock's home. Admin or owner access is required to manage access codes and control the lock remotely.
+    `)
+
 const device_warning = z.discriminatedUnion('warning_code', [
   partial_backup_access_code_pool,
   many_active_backup_codes,
@@ -549,6 +560,7 @@ const device_warning = z.discriminatedUnion('warning_code', [
   accessory_keypad_setup_required,
   unreliable_online_status,
   max_access_codes_reached,
+  insufficient_permissions,
 ])
 
 export type DeviceWarning = z.infer<typeof device_warning>
@@ -606,6 +618,7 @@ export const device_warning_map = z.object({
     .nullable(),
   unreliable_online_status: unreliable_online_status.optional().nullable(),
   max_access_codes_reached: max_access_codes_reached.optional().nullable(),
+  insufficient_permissions: insufficient_permissions.optional().nullable(),
 })
 
 export type DeviceWarningMap = z.infer<typeof device_warning_map>

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

@@ -785,9 +785,8 @@ const openapi: OpenAPISpec = {
                   'x-deprecated': 'Use `provider_issue` instead.',
                 },
                 {
-                  deprecated: true,
                   description:
-                    'Admin role required—insufficient permissions to manage PINs on this Kwikset device. Please have a Home Admin update your role in the Kwikset app, or ask them to set the PIN.',
+                    'Admin role required—insufficient permissions to manage PINs on this device. Please have an admin update your role, or ask them to set the PIN.',
                   properties: {
                     created_at: {
                       description:
@@ -798,7 +797,7 @@ const openapi: OpenAPISpec = {
                     error_code: {
                       description:
                         'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
-                      enum: ['kwikset_insufficient_permissions'],
+                      enum: ['insufficient_permissions'],
                       type: 'string',
                     },
                     is_access_code_error: {
@@ -815,7 +814,6 @@ const openapi: OpenAPISpec = {
                   },
                   required: ['message', 'is_access_code_error', 'error_code'],
                   type: 'object',
-                  'x-deprecated': 'Use `provider_issue` instead.',
                 },
                 {
                   deprecated: true,
@@ -4650,6 +4648,11 @@ const openapi: OpenAPISpec = {
             },
             type: 'object',
           },
+          is_locked: {
+            description:
+              'Indicates whether the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) is currently locked.',
+            type: 'boolean',
+          },
           latch_metadata: {
             description:
               'Latch-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
@@ -4902,6 +4905,31 @@ const openapi: OpenAPISpec = {
                   required: ['created_at', 'message', 'warning_code'],
                   type: 'object',
                 },
+                {
+                  description:
+                    'Indicates that this entrance is in privacy mode. When privacy mode is enabled, access codes, mobile keys, and remote unlocks will not work unless the user has admin access.',
+                  properties: {
+                    created_at: {
+                      description:
+                        'Date and time at which Seam created the warning.',
+                      format: 'date-time',
+                      type: 'string',
+                    },
+                    message: {
+                      description:
+                        'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
+                      type: 'string',
+                    },
+                    warning_code: {
+                      description:
+                        'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
+                      enum: ['salto_ks_privacy_mode'],
+                      type: 'string',
+                    },
+                  },
+                  required: ['created_at', 'message', 'warning_code'],
+                  type: 'object',
+                },
               ],
             },
             type: 'array',
@@ -16624,6 +16652,32 @@ const openapi: OpenAPISpec = {
                   type: 'object',
                   'x-variant-group-key': 'access_codes',
                 },
+                {
+                  description:
+                    "Indicates that the connected Kwikset account has member-level access to this lock's home. Admin or owner access is required to manage access codes and control the lock remotely.",
+                  properties: {
+                    created_at: {
+                      description:
+                        'Date and time at which Seam created the warning.',
+                      format: 'date-time',
+                      type: 'string',
+                    },
+                    message: {
+                      description:
+                        'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
+                      type: 'string',
+                    },
+                    warning_code: {
+                      description:
+                        'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
+                      enum: ['insufficient_permissions'],
+                      type: 'string',
+                    },
+                  },
+                  required: ['message', 'created_at', 'warning_code'],
+                  type: 'object',
+                  'x-variant-group-key': 'locks',
+                },
               ],
             },
             type: 'array',
@@ -26178,6 +26232,11 @@ const openapi: OpenAPISpec = {
                               },
                               type: 'object',
                             },
+                            is_locked: {
+                              description:
+                                'Indicates whether the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) is currently locked.',
+                              type: 'boolean',
+                            },
                             latch_metadata: {
                               description:
                                 'Latch-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
@@ -26454,6 +26513,35 @@ const openapi: OpenAPISpec = {
                                     ],
                                     type: 'object',
                                   },
+                                  {
+                                    description:
+                                      'Indicates that this entrance is in privacy mode. When privacy mode is enabled, access codes, mobile keys, and remote unlocks will not work unless the user has admin access.',
+                                    properties: {
+                                      created_at: {
+                                        description:
+                                          'Date and time at which Seam created the warning.',
+                                        format: 'date-time',
+                                        type: 'string',
+                                      },
+                                      message: {
+                                        description:
+                                          'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
+                                        type: 'string',
+                                      },
+                                      warning_code: {
+                                        description:
+                                          'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
+                                        enum: ['salto_ks_privacy_mode'],
+                                        type: 'string',
+                                      },
+                                    },
+                                    required: [
+                                      'created_at',
+                                      'message',
+                                      'warning_code',
+                                    ],
+                                    type: 'object',
+                                  },
                                 ],
                               },
                               type: 'array',
@@ -28267,9 +28355,8 @@ const openapi: OpenAPISpec = {
                   'x-deprecated': 'Use `provider_issue` instead.',
                 },
                 {
-                  deprecated: true,
                   description:
-                    'Admin role required—insufficient permissions to manage PINs on this Kwikset device. Please have a Home Admin update your role in the Kwikset app, or ask them to set the PIN.',
+                    'Admin role required—insufficient permissions to manage PINs on this device. Please have an admin update your role, or ask them to set the PIN.',
                   properties: {
                     created_at: {
                       description:
@@ -28280,7 +28367,7 @@ const openapi: OpenAPISpec = {
                     error_code: {
                       description:
                         'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
-                      enum: ['kwikset_insufficient_permissions'],
+                      enum: ['insufficient_permissions'],
                       type: 'string',
                     },
                     is_access_code_error: {
@@ -28297,7 +28384,6 @@ const openapi: OpenAPISpec = {
                   },
                   required: ['message', 'is_access_code_error', 'error_code'],
                   type: 'object',
-                  'x-deprecated': 'Use `provider_issue` instead.',
                 },
                 {
                   deprecated: true,
@@ -32854,6 +32940,32 @@ const openapi: OpenAPISpec = {
                   type: 'object',
                   'x-variant-group-key': 'access_codes',
                 },
+                {
+                  description:
+                    "Indicates that the connected Kwikset account has member-level access to this lock's home. Admin or owner access is required to manage access codes and control the lock remotely.",
+                  properties: {
+                    created_at: {
+                      description:
+                        'Date and time at which Seam created the warning.',
+                      format: 'date-time',
+                      type: 'string',
+                    },
+                    message: {
+                      description:
+                        'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
+                      type: 'string',
+                    },
+                    warning_code: {
+                      description:
+                        'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
+                      enum: ['insufficient_permissions'],
+                      type: 'string',
+                    },
+                  },
+                  required: ['message', 'created_at', 'warning_code'],
+                  type: 'object',
+                  'x-variant-group-key': 'locks',
+                },
               ],
             },
             type: 'array',