@seamapi/types 1.870.0 → 1.872.0

package/package.json

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

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

@@ -22,13 +22,28 @@ const common_access_code_error = z.object({
 const error_code_description =
   'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.'
 
+const provider_issue = common_access_code_error
+  .extend({
+    error_code: z.literal('provider_issue').describe(error_code_description),
+  })
+  .describe(
+    'Indicates a provider-specific issue that prevents the access code from being set or managed. Check the error message for details.',
+  )
+
 const smartthings_failed_to_set_access_code_error = common_access_code_error
   .extend({
     error_code: z
       .literal('smartthings_failed_to_set_access_code')
       .describe(error_code_description),
   })
-  .describe('Failed to set code on SmartThings device.')
+  .describe(
+    `
+    ---
+    deprecated: Handled by the generic \`failed_to_set_on_device\` system.
+    ---
+    Failed to set code on SmartThings device.
+    `,
+  )
 
 const smartthings_failed_to_set_after_multiple_retries =
   common_access_code_error
@@ -37,13 +52,42 @@ const smartthings_failed_to_set_after_multiple_retries =
         .literal('smartthings_failed_to_set_after_multiple_retries')
         .describe(error_code_description),
     })
-    .describe('Failed to set code after multiple retries.')
+    .describe(
+      `
+    ---
+    deprecated: Handled by the generic \`failed_to_set_on_device\` system.
+    ---
+    Failed to set code after multiple retries.
+    `,
+    )
+
+const modified_field = z.object({
+  field: z
+    .string()
+    .describe(
+      'The name of the field that was changed (e.g. `code`, `starts_at`, `ends_at`).',
+    ),
+  from: z.string().nullable().describe('The previous value of the field.'),
+  to: z.string().nullable().describe('The new value of the field.'),
+})
 
 const code_modified_external_to_seam_error = common_access_code_error
   .extend({
     error_code: z
       .literal('code_modified_external_to_seam')
       .describe(error_code_description),
+    change_type: z
+      .enum(['modified', 'removed'])
+      .optional()
+      .describe(
+        "Indicates the type of external modification. `modified` means the code's PIN or schedule was changed. `removed` means the code was deleted from the device.",
+      ),
+    modified_fields: z
+      .array(modified_field)
+      .optional()
+      .describe(
+        'List of fields that were changed externally, with their previous and new values.',
+      ),
   })
   .describe(
     'Code was modified or removed externally after Seam successfully set it on the device.',
@@ -150,7 +194,12 @@ const kwikset_insufficient_permissions = common_access_code_error
       .describe(error_code_description),
   })
   .describe(
-    '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.',
+    `
+    ---
+    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.
+    `,
   )
 
 const august_lock_invalid_code_length = common_access_code_error
@@ -159,7 +208,14 @@ const august_lock_invalid_code_length = common_access_code_error
       .literal('august_lock_invalid_code_length')
       .describe(error_code_description),
   })
-  .describe('Invalid code length for August lock.')
+  .describe(
+    `
+    ---
+    deprecated: Use \`provider_issue\` instead.
+    ---
+    Invalid code length for August lock.
+    `,
+  )
 
 const august_lock_temporarily_offline_error = common_access_code_error
   .extend({
@@ -167,7 +223,14 @@ const august_lock_temporarily_offline_error = common_access_code_error
       .literal('august_lock_temporarily_offline')
       .describe(error_code_description),
   })
-  .describe('August lock is temporarily offline.')
+  .describe(
+    `
+    ---
+    deprecated: Use \`provider_issue\` instead.
+    ---
+    August lock is temporarily offline.
+    `,
+  )
 
 const august_lock_missing_keypad = common_access_code_error
   .extend({
@@ -175,7 +238,24 @@ const august_lock_missing_keypad = common_access_code_error
       .literal('august_lock_missing_keypad')
       .describe(error_code_description),
   })
-  .describe('August lock is missing a keypad.')
+  .describe(
+    `
+    ---
+    deprecated: Use \`provider_issue\` instead.
+    ---
+    August lock is missing a keypad.
+    `,
+  )
+
+const access_code_inactive_error = common_access_code_error
+  .extend({
+    error_code: z
+      .literal('access_code_inactive')
+      .describe(error_code_description),
+  })
+  .describe(
+    'Indicates that the access code is disabled or inactive on the device. The code exists but will not grant access until re-enabled.',
+  )
 
 const salto_ks_user_not_subscribed = common_access_code_error
   .extend({
@@ -183,7 +263,14 @@ const salto_ks_user_not_subscribed = common_access_code_error
       .literal('salto_ks_user_not_subscribed')
       .describe(error_code_description),
   })
-  .describe('Salto site user is not subscribed.')
+  .describe(
+    `
+    ---
+    deprecated: Use \`access_code_inactive\` instead.
+    ---
+    Salto site user is not subscribed.
+    `,
+  )
 
 const wyze_duplicate_code_name = common_access_code_error
   .extend({
@@ -222,7 +309,12 @@ const dormakaba_oracode_invalid_time_range = common_access_code_error
       .describe(error_code_description),
   })
   .describe(
-    'No Dormakaba Oracode user levels configured for the requested time range.',
+    `
+    ---
+    deprecated: Use \`provider_issue\` instead.
+    ---
+    No Dormakaba Oracode user levels configured for the requested time range.
+    `,
   )
 
 const keynest_unsupported_third_party_locker = common_access_code_error
@@ -231,7 +323,14 @@ const keynest_unsupported_third_party_locker = common_access_code_error
       .literal('keynest_unsupported_third_party_locker')
       .describe(error_code_description),
   })
-  .describe('KeyNest locker is not supported.')
+  .describe(
+    `
+    ---
+    deprecated: Use \`provider_issue\` instead.
+    ---
+    KeyNest locker is not supported.
+    `,
+  )
 
 const replaced_by_newer_access_code = common_access_code_error
   .extend({
@@ -245,6 +344,7 @@ const replaced_by_newer_access_code = common_access_code_error
 
 const access_code_error = z
   .discriminatedUnion('error_code', [
+    provider_issue,
     smartthings_failed_to_set_access_code_error,
     smartthings_failed_to_set_after_multiple_retries,
     failed_to_set_on_device,
@@ -260,6 +360,7 @@ const access_code_error = z
     august_lock_invalid_code_length,
     august_lock_missing_keypad,
     august_lock_temporarily_offline_error,
+    access_code_inactive_error,
     salto_ks_user_not_subscribed,
     wyze_duplicate_code_name,
     wyze_potential_duplicate_code,
@@ -275,6 +376,7 @@ const access_code_error = z
 export type AccessCodeError = z.infer<typeof access_code_error>
 
 const _access_code_error_map = z.object({
+  provider_issue: provider_issue.optional().nullable(),
   smartthings_failed_to_set_access_code:
     smartthings_failed_to_set_access_code_error.optional().nullable(),
   smartthings_failed_to_set_after_multiple_retries:
@@ -312,6 +414,7 @@ const _access_code_error_map = z.object({
     .optional()
     .nullable(),
   august_lock_missing_keypad: august_lock_missing_keypad.optional().nullable(),
+  access_code_inactive: access_code_inactive_error.optional().nullable(),
   salto_ks_user_not_subscribed: salto_ks_user_not_subscribed
     .optional()
     .nullable(),
@@ -369,6 +472,18 @@ const code_modified_external_to_seam_warning = common_access_code_warning
     warning_code: z
       .literal('code_modified_external_to_seam')
       .describe(warning_code_description),
+    change_type: z
+      .enum(['modified', 'removed'])
+      .optional()
+      .describe(
+        "Indicates the type of external modification. `modified` means the code's PIN or schedule was changed. `removed` means the code was deleted from the device.",
+      ),
+    modified_fields: z
+      .array(modified_field)
+      .optional()
+      .describe(
+        'List of fields that were changed externally, with their previous and new values.',
+      ),
   })
   .describe(
     'Code was modified or removed externally after Seam successfully set it on the device.',
@@ -389,13 +504,30 @@ const schlage_detected_duplicate = common_access_code_warning
     `,
   )
 
+const provider_issue_warning = common_access_code_warning
+  .extend({
+    warning_code: z
+      .literal('provider_issue')
+      .describe(warning_code_description),
+  })
+  .describe(
+    'Indicates a provider-specific issue that may affect the access code. Check the warning message for details.',
+  )
+
 const schlage_creation_outage = common_access_code_warning
   .extend({
     warning_code: z
       .literal('schlage_creation_outage')
       .describe(warning_code_description),
   })
-  .describe('Received an error when attempting to create this code.')
+  .describe(
+    `
+    ---
+    deprecated: Use \`provider_issue\` instead.
+    ---
+    Received an error when attempting to create this code.
+    `,
+  )
 
 const schlage_access_code_ambiguous_timezone_dst_risk =
   common_access_code_warning
@@ -501,6 +633,7 @@ const being_deleted = common_access_code_warning
 
 const access_code_warning = z
   .discriminatedUnion('warning_code', [
+    provider_issue_warning,
     smartthings_failed_to_set_access_code_warning,
     schlage_detected_duplicate,
     schlage_creation_outage,
@@ -525,6 +658,7 @@ const access_code_warning = z
 export type AccessCodeWarning = z.infer<typeof access_code_warning>
 
 const _access_code_warning_map = z.object({
+  provider_issue: provider_issue_warning.optional().nullable(),
   smartthings_failed_to_set_access_code:
     smartthings_failed_to_set_access_code_warning.optional().nullable(),
   schlage_detected_duplicate: schlage_detected_duplicate.optional().nullable(),