@seamapi/types 1.871.0 → 1.872.0

package/dist/index.cjs

@@ -2306,12 +2306,31 @@ var common_access_code_error = zod.z.object({
   created_at: zod.z.string().datetime().optional().describe("Date and time at which Seam created the error.")
 });
 var error_code_description3 = "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.";
+var provider_issue = common_access_code_error.extend({
+  error_code: zod.z.literal("provider_issue").describe(error_code_description3)
+}).describe(
+  "Indicates a provider-specific issue that prevents the access code from being set or managed. Check the error message for details."
+);
 var smartthings_failed_to_set_access_code_error = common_access_code_error.extend({
   error_code: zod.z.literal("smartthings_failed_to_set_access_code").describe(error_code_description3)
-}).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.
+    `
+);
 var smartthings_failed_to_set_after_multiple_retries = common_access_code_error.extend({
   error_code: zod.z.literal("smartthings_failed_to_set_after_multiple_retries").describe(error_code_description3)
-}).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.
+    `
+);
 var modified_field = zod.z.object({
   field: zod.z.string().describe(
     "The name of the field that was changed (e.g. `code`, `starts_at`, `ends_at`)."
@@ -2379,20 +2398,58 @@ var kwikset_unable_to_confirm_deletion = common_access_code_error.extend({
 var kwikset_insufficient_permissions = common_access_code_error.extend({
   error_code: zod.z.literal("kwikset_insufficient_permissions").describe(error_code_description3)
 }).describe(
-  "Admin role required\u2014insufficient 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\u2014insufficient 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.
+    `
 );
 var august_lock_invalid_code_length = common_access_code_error.extend({
   error_code: zod.z.literal("august_lock_invalid_code_length").describe(error_code_description3)
-}).describe("Invalid code length for August lock.");
+}).describe(
+  `
+    ---
+    deprecated: Use \`provider_issue\` instead.
+    ---
+    Invalid code length for August lock.
+    `
+);
 var august_lock_temporarily_offline_error = common_access_code_error.extend({
   error_code: zod.z.literal("august_lock_temporarily_offline").describe(error_code_description3)
-}).describe("August lock is temporarily offline.");
+}).describe(
+  `
+    ---
+    deprecated: Use \`provider_issue\` instead.
+    ---
+    August lock is temporarily offline.
+    `
+);
 var august_lock_missing_keypad = common_access_code_error.extend({
   error_code: zod.z.literal("august_lock_missing_keypad").describe(error_code_description3)
-}).describe("August lock is missing a keypad.");
+}).describe(
+  `
+    ---
+    deprecated: Use \`provider_issue\` instead.
+    ---
+    August lock is missing a keypad.
+    `
+);
+var access_code_inactive_error = common_access_code_error.extend({
+  error_code: zod.z.literal("access_code_inactive").describe(error_code_description3)
+}).describe(
+  "Indicates that the access code is disabled or inactive on the device. The code exists but will not grant access until re-enabled."
+);
 var salto_ks_user_not_subscribed = common_access_code_error.extend({
   error_code: zod.z.literal("salto_ks_user_not_subscribed").describe(error_code_description3)
-}).describe("Salto site user is not subscribed.");
+}).describe(
+  `
+    ---
+    deprecated: Use \`access_code_inactive\` instead.
+    ---
+    Salto site user is not subscribed.
+    `
+);
 var wyze_duplicate_code_name = common_access_code_error.extend({
   error_code: zod.z.literal("wyze_duplicate_code_name").describe(error_code_description3)
 }).describe(
@@ -2416,17 +2473,30 @@ var wyze_potential_duplicate_code = common_access_code_error.extend({
 var dormakaba_oracode_invalid_time_range = common_access_code_error.extend({
   error_code: zod.z.literal("dormakaba_oracode_invalid_time_range").describe(error_code_description3)
 }).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.
+    `
 );
 var keynest_unsupported_third_party_locker = common_access_code_error.extend({
   error_code: zod.z.literal("keynest_unsupported_third_party_locker").describe(error_code_description3)
-}).describe("KeyNest locker is not supported.");
+}).describe(
+  `
+    ---
+    deprecated: Use \`provider_issue\` instead.
+    ---
+    KeyNest locker is not supported.
+    `
+);
 var replaced_by_newer_access_code = common_access_code_error.extend({
   error_code: zod.z.literal("replaced_by_newer_access_code").describe(error_code_description3)
 }).describe(
   "This access code was overridden on the device by a newer access code programmed to the same slot."
 );
 var access_code_error = zod.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,
@@ -2441,6 +2511,7 @@ var access_code_error = zod.z.discriminatedUnion("error_code", [
   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,
@@ -2452,6 +2523,7 @@ var access_code_error = zod.z.discriminatedUnion("error_code", [
   "Errors associated with the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes)."
 );
 zod.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: smartthings_failed_to_set_after_multiple_retries.optional().nullable(),
   failed_to_set_on_device: failed_to_set_on_device.optional().nullable(),
@@ -2467,6 +2539,7 @@ zod.z.object({
   august_lock_invalid_code_length: august_lock_invalid_code_length.optional().nullable(),
   august_lock_temporarily_offline: august_lock_temporarily_offline_error.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(),
   wyze_duplicate_code_name: wyze_duplicate_code_name.optional().nullable(),
   wyze_potential_duplicate_code: wyze_potential_duplicate_code.optional().nullable(),
@@ -2508,9 +2581,21 @@ var schlage_detected_duplicate = common_access_code_warning.extend({
     Duplicate access code detected.
     `
 );
+var provider_issue_warning = common_access_code_warning.extend({
+  warning_code: zod.z.literal("provider_issue").describe(warning_code_description3)
+}).describe(
+  "Indicates a provider-specific issue that may affect the access code. Check the warning message for details."
+);
 var schlage_creation_outage = common_access_code_warning.extend({
   warning_code: zod.z.literal("schlage_creation_outage").describe(warning_code_description3)
-}).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.
+    `
+);
 var schlage_access_code_ambiguous_timezone_dst_risk = common_access_code_warning.extend({
   warning_code: zod.z.literal("schlage_access_code_ambiguous_timezone_dst_risk").describe(warning_code_description3)
 }).describe(
@@ -2560,6 +2645,7 @@ var being_deleted2 = common_access_code_warning.extend({
   warning_code: zod.z.literal("being_deleted").describe(warning_code_description3)
 }).describe("Access code is being deleted.");
 var access_code_warning = zod.z.discriminatedUnion("warning_code", [
+  provider_issue_warning,
   smartthings_failed_to_set_access_code_warning,
   schlage_detected_duplicate,
   schlage_creation_outage,
@@ -2580,6 +2666,7 @@ var access_code_warning = zod.z.discriminatedUnion("warning_code", [
   "Warnings associated with the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes)."
 );
 zod.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(),
   schlage_creation_outage: schlage_creation_outage.optional().nullable(),
@@ -7236,6 +7323,33 @@ var openapi = {
               discriminator: { propertyName: "error_code" },
               oneOf: [
                 {
+                  description: "Indicates a provider-specific issue that prevents the access code from being set or managed. Check the error message for details.",
+                  properties: {
+                    created_at: {
+                      description: "Date and time at which Seam created the error.",
+                      format: "date-time",
+                      type: "string"
+                    },
+                    error_code: {
+                      description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
+                      enum: ["provider_issue"],
+                      type: "string"
+                    },
+                    is_access_code_error: {
+                      description: "Indicates that this is an access code error.",
+                      enum: [true],
+                      type: "boolean"
+                    },
+                    message: {
+                      description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
+                      type: "string"
+                    }
+                  },
+                  required: ["message", "is_access_code_error", "error_code"],
+                  type: "object"
+                },
+                {
+                  deprecated: true,
                   description: "Failed to set code on SmartThings device.",
                   properties: {
                     created_at: {
@@ -7259,9 +7373,11 @@ var openapi = {
                     }
                   },
                   required: ["message", "is_access_code_error", "error_code"],
-                  type: "object"
+                  type: "object",
+                  "x-deprecated": "Handled by the generic `failed_to_set_on_device` system."
                 },
                 {
+                  deprecated: true,
                   description: "Failed to set code after multiple retries.",
                   properties: {
                     created_at: {
@@ -7287,7 +7403,8 @@ var openapi = {
                     }
                   },
                   required: ["message", "is_access_code_error", "error_code"],
-                  type: "object"
+                  type: "object",
+                  "x-deprecated": "Handled by the generic `failed_to_set_on_device` system."
                 },
                 {
                   description: "Failed to set code on device.",
@@ -7567,6 +7684,7 @@ var openapi = {
                   type: "object"
                 },
                 {
+                  deprecated: true,
                   description: "Invalid code length for August lock.",
                   properties: {
                     created_at: {
@@ -7590,9 +7708,11 @@ var openapi = {
                     }
                   },
                   required: ["message", "is_access_code_error", "error_code"],
-                  type: "object"
+                  type: "object",
+                  "x-deprecated": "Use `provider_issue` instead."
                 },
                 {
+                  deprecated: true,
                   description: "August lock is missing a keypad.",
                   properties: {
                     created_at: {
@@ -7616,9 +7736,11 @@ var openapi = {
                     }
                   },
                   required: ["message", "is_access_code_error", "error_code"],
-                  type: "object"
+                  type: "object",
+                  "x-deprecated": "Use `provider_issue` instead."
                 },
                 {
+                  deprecated: true,
                   description: "August lock is temporarily offline.",
                   properties: {
                     created_at: {
@@ -7642,9 +7764,37 @@ var openapi = {
                     }
                   },
                   required: ["message", "is_access_code_error", "error_code"],
+                  type: "object",
+                  "x-deprecated": "Use `provider_issue` instead."
+                },
+                {
+                  description: "Indicates that the access code is disabled or inactive on the device. The code exists but will not grant access until re-enabled.",
+                  properties: {
+                    created_at: {
+                      description: "Date and time at which Seam created the error.",
+                      format: "date-time",
+                      type: "string"
+                    },
+                    error_code: {
+                      description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
+                      enum: ["access_code_inactive"],
+                      type: "string"
+                    },
+                    is_access_code_error: {
+                      description: "Indicates that this is an access code error.",
+                      enum: [true],
+                      type: "boolean"
+                    },
+                    message: {
+                      description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
+                      type: "string"
+                    }
+                  },
+                  required: ["message", "is_access_code_error", "error_code"],
                   type: "object"
                 },
                 {
+                  deprecated: true,
                   description: "Salto site user is not subscribed.",
                   properties: {
                     created_at: {
@@ -7668,7 +7818,8 @@ var openapi = {
                     }
                   },
                   required: ["message", "is_access_code_error", "error_code"],
-                  type: "object"
+                  type: "object",
+                  "x-deprecated": "Use `access_code_inactive` instead."
                 },
                 {
                   deprecated: true,
@@ -7727,6 +7878,7 @@ var openapi = {
                   "x-deprecated": "Use `duplicate_code_on_device` instead."
                 },
                 {
+                  deprecated: true,
                   description: "No Dormakaba Oracode user levels configured for the requested time range.",
                   properties: {
                     created_at: {
@@ -7750,9 +7902,11 @@ var openapi = {
                     }
                   },
                   required: ["message", "is_access_code_error", "error_code"],
-                  type: "object"
+                  type: "object",
+                  "x-deprecated": "Use `provider_issue` instead."
                 },
                 {
+                  deprecated: true,
                   description: "Admin role required\u2014insufficient 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.",
                   properties: {
                     created_at: {
@@ -7776,9 +7930,11 @@ var openapi = {
                     }
                   },
                   required: ["message", "is_access_code_error", "error_code"],
-                  type: "object"
+                  type: "object",
+                  "x-deprecated": "Use `provider_issue` instead."
                 },
                 {
+                  deprecated: true,
                   description: "KeyNest locker is not supported.",
                   properties: {
                     created_at: {
@@ -7802,7 +7958,8 @@ var openapi = {
                     }
                   },
                   required: ["message", "is_access_code_error", "error_code"],
-                  type: "object"
+                  type: "object",
+                  "x-deprecated": "Use `provider_issue` instead."
                 },
                 {
                   description: "This access code was overridden on the device by a newer access code programmed to the same slot.",
@@ -8646,6 +8803,27 @@ var openapi = {
               description: "Warnings associated with the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).",
               discriminator: { propertyName: "warning_code" },
               oneOf: [
+                {
+                  description: "Indicates a provider-specific issue that may affect the access code. Check the warning message for details.",
+                  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: ["provider_issue"],
+                      type: "string"
+                    }
+                  },
+                  required: ["message", "warning_code"],
+                  type: "object"
+                },
                 {
                   description: "Failed to set code on SmartThings device.",
                   properties: {
@@ -8691,6 +8869,7 @@ var openapi = {
                   "x-deprecated": "Use `duplicate_code_on_device` error instead."
                 },
                 {
+                  deprecated: true,
                   description: "Received an error when attempting to create this code.",
                   properties: {
                     created_at: {
@@ -8709,7 +8888,8 @@ var openapi = {
                     }
                   },
                   required: ["message", "warning_code"],
-                  type: "object"
+                  type: "object",
+                  "x-deprecated": "Use `provider_issue` instead."
                 },
                 {
                   description: "The Schlage device's timezone is ambiguous and this code's schedule crosses a daylight-saving transition in at least one plausible timezone. A 1-hour safety buffer has been applied to the side of the schedule affected by the transition (`ends_at` for spring-forward, `starts_at` for fall-back) so the code stays active through the shift \u2014 the code may be usable up to 1 hour beyond your requested window. Set the device's timezone via `/devices/report_provider_metadata` to clear the buffer and guarantee exact DST handling.",
@@ -31796,6 +31976,33 @@ var openapi = {
               discriminator: { propertyName: "error_code" },
               oneOf: [
                 {
+                  description: "Indicates a provider-specific issue that prevents the access code from being set or managed. Check the error message for details.",
+                  properties: {
+                    created_at: {
+                      description: "Date and time at which Seam created the error.",
+                      format: "date-time",
+                      type: "string"
+                    },
+                    error_code: {
+                      description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
+                      enum: ["provider_issue"],
+                      type: "string"
+                    },
+                    is_access_code_error: {
+                      description: "Indicates that this is an access code error.",
+                      enum: [true],
+                      type: "boolean"
+                    },
+                    message: {
+                      description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
+                      type: "string"
+                    }
+                  },
+                  required: ["message", "is_access_code_error", "error_code"],
+                  type: "object"
+                },
+                {
+                  deprecated: true,
                   description: "Failed to set code on SmartThings device.",
                   properties: {
                     created_at: {
@@ -31819,9 +32026,11 @@ var openapi = {
                     }
                   },
                   required: ["message", "is_access_code_error", "error_code"],
-                  type: "object"
+                  type: "object",
+                  "x-deprecated": "Handled by the generic `failed_to_set_on_device` system."
                 },
                 {
+                  deprecated: true,
                   description: "Failed to set code after multiple retries.",
                   properties: {
                     created_at: {
@@ -31847,7 +32056,8 @@ var openapi = {
                     }
                   },
                   required: ["message", "is_access_code_error", "error_code"],
-                  type: "object"
+                  type: "object",
+                  "x-deprecated": "Handled by the generic `failed_to_set_on_device` system."
                 },
                 {
                   description: "Failed to set code on device.",
@@ -32127,6 +32337,7 @@ var openapi = {
                   type: "object"
                 },
                 {
+                  deprecated: true,
                   description: "Invalid code length for August lock.",
                   properties: {
                     created_at: {
@@ -32150,9 +32361,11 @@ var openapi = {
                     }
                   },
                   required: ["message", "is_access_code_error", "error_code"],
-                  type: "object"
+                  type: "object",
+                  "x-deprecated": "Use `provider_issue` instead."
                 },
                 {
+                  deprecated: true,
                   description: "August lock is missing a keypad.",
                   properties: {
                     created_at: {
@@ -32176,9 +32389,11 @@ var openapi = {
                     }
                   },
                   required: ["message", "is_access_code_error", "error_code"],
-                  type: "object"
+                  type: "object",
+                  "x-deprecated": "Use `provider_issue` instead."
                 },
                 {
+                  deprecated: true,
                   description: "August lock is temporarily offline.",
                   properties: {
                     created_at: {
@@ -32202,9 +32417,37 @@ var openapi = {
                     }
                   },
                   required: ["message", "is_access_code_error", "error_code"],
+                  type: "object",
+                  "x-deprecated": "Use `provider_issue` instead."
+                },
+                {
+                  description: "Indicates that the access code is disabled or inactive on the device. The code exists but will not grant access until re-enabled.",
+                  properties: {
+                    created_at: {
+                      description: "Date and time at which Seam created the error.",
+                      format: "date-time",
+                      type: "string"
+                    },
+                    error_code: {
+                      description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
+                      enum: ["access_code_inactive"],
+                      type: "string"
+                    },
+                    is_access_code_error: {
+                      description: "Indicates that this is an access code error.",
+                      enum: [true],
+                      type: "boolean"
+                    },
+                    message: {
+                      description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
+                      type: "string"
+                    }
+                  },
+                  required: ["message", "is_access_code_error", "error_code"],
                   type: "object"
                 },
                 {
+                  deprecated: true,
                   description: "Salto site user is not subscribed.",
                   properties: {
                     created_at: {
@@ -32228,7 +32471,8 @@ var openapi = {
                     }
                   },
                   required: ["message", "is_access_code_error", "error_code"],
-                  type: "object"
+                  type: "object",
+                  "x-deprecated": "Use `access_code_inactive` instead."
                 },
                 {
                   deprecated: true,
@@ -32287,6 +32531,7 @@ var openapi = {
                   "x-deprecated": "Use `duplicate_code_on_device` instead."
                 },
                 {
+                  deprecated: true,
                   description: "No Dormakaba Oracode user levels configured for the requested time range.",
                   properties: {
                     created_at: {
@@ -32310,9 +32555,11 @@ var openapi = {
                     }
                   },
                   required: ["message", "is_access_code_error", "error_code"],
-                  type: "object"
+                  type: "object",
+                  "x-deprecated": "Use `provider_issue` instead."
                 },
                 {
+                  deprecated: true,
                   description: "Admin role required\u2014insufficient 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.",
                   properties: {
                     created_at: {
@@ -32336,9 +32583,11 @@ var openapi = {
                     }
                   },
                   required: ["message", "is_access_code_error", "error_code"],
-                  type: "object"
+                  type: "object",
+                  "x-deprecated": "Use `provider_issue` instead."
                 },
                 {
+                  deprecated: true,
                   description: "KeyNest locker is not supported.",
                   properties: {
                     created_at: {
@@ -32362,7 +32611,8 @@ var openapi = {
                     }
                   },
                   required: ["message", "is_access_code_error", "error_code"],
-                  type: "object"
+                  type: "object",
+                  "x-deprecated": "Use `provider_issue` instead."
                 },
                 {
                   description: "This access code was overridden on the device by a newer access code programmed to the same slot.",
@@ -32923,6 +33173,27 @@ var openapi = {
               description: "Warnings associated with the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).",
               discriminator: { propertyName: "warning_code" },
               oneOf: [
+                {
+                  description: "Indicates a provider-specific issue that may affect the access code. Check the warning message for details.",
+                  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: ["provider_issue"],
+                      type: "string"
+                    }
+                  },
+                  required: ["message", "warning_code"],
+                  type: "object"
+                },
                 {
                   description: "Failed to set code on SmartThings device.",
                   properties: {
@@ -32968,6 +33239,7 @@ var openapi = {
                   "x-deprecated": "Use `duplicate_code_on_device` error instead."
                 },
                 {
+                  deprecated: true,
                   description: "Received an error when attempting to create this code.",
                   properties: {
                     created_at: {
@@ -32986,7 +33258,8 @@ var openapi = {
                     }
                   },
                   required: ["message", "warning_code"],
-                  type: "object"
+                  type: "object",
+                  "x-deprecated": "Use `provider_issue` instead."
                 },
                 {
                   description: "The Schlage device's timezone is ambiguous and this code's schedule crosses a daylight-saving transition in at least one plausible timezone. A 1-hour safety buffer has been applied to the side of the schedule affected by the transition (`ends_at` for spring-forward, `starts_at` for fall-back) so the code stays active through the shift \u2014 the code may be usable up to 1 hour beyond your requested window. Set the device's timezone via `/devices/report_provider_metadata` to clear the buffer and guarantee exact DST handling.",