@seamapi/types 1.869.0 → 1.871.0

package/dist/connect.cjs

@@ -2312,8 +2312,21 @@ var smartthings_failed_to_set_access_code_error = common_access_code_error.exten
 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.");
+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`)."
+  ),
+  from: zod.z.string().nullable().describe("The previous value of the field."),
+  to: zod.z.string().nullable().describe("The new value of the field.")
+});
 var code_modified_external_to_seam_error = common_access_code_error.extend({
-  error_code: zod.z.literal("code_modified_external_to_seam").describe(error_code_description3)
+  error_code: zod.z.literal("code_modified_external_to_seam").describe(error_code_description3),
+  change_type: zod.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: zod.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."
 );
@@ -2338,13 +2351,30 @@ var duplicate_code_attempt_prevented = common_access_code_error.extend({
 var no_space_for_access_code_on_device = common_access_code_error.extend({
   error_code: zod.z.literal("no_space_for_access_code_on_device").describe(error_code_description3)
 }).describe("No space for access code on device.");
+var access_code_state_unconfirmed = common_access_code_error.extend({
+  error_code: zod.z.literal("access_code_state_unconfirmed").describe(error_code_description3)
+}).describe(
+  "Indicates that the provider cannot confirm whether the access code was set or removed on the device."
+);
 var kwikset_unable_to_confirm_code = common_access_code_error.extend({
   error_code: zod.z.literal("kwikset_unable_to_confirm_code").describe(error_code_description3)
-}).describe("Unable to confirm that the access code is set on Kwikset device.");
+}).describe(
+  `
+    ---
+    deprecated: Use \`access_code_state_unconfirmed\` instead.
+    ---
+    Unable to confirm that the access code is set on Kwikset device.
+    `
+);
 var kwikset_unable_to_confirm_deletion = common_access_code_error.extend({
   error_code: zod.z.literal("kwikset_unable_to_confirm_deletion").describe(error_code_description3)
 }).describe(
-  "Unable to confirm the deletion of the access code on Kwikset device."
+  `
+    ---
+    deprecated: Use \`access_code_state_unconfirmed\` instead.
+    ---
+    Unable to confirm the deletion of the access code on Kwikset device.
+    `
 );
 var kwikset_insufficient_permissions = common_access_code_error.extend({
   error_code: zod.z.literal("kwikset_insufficient_permissions").describe(error_code_description3)
@@ -2404,6 +2434,7 @@ var access_code_error = zod.z.discriminatedUnion("error_code", [
   duplicate_code_on_device,
   duplicate_code_attempt_prevented,
   no_space_for_access_code_on_device,
+  access_code_state_unconfirmed,
   kwikset_unable_to_confirm_code,
   kwikset_unable_to_confirm_deletion,
   code_modified_external_to_seam_error,
@@ -2428,6 +2459,7 @@ zod.z.object({
   no_space_for_access_code_on_device: no_space_for_access_code_on_device.optional().nullable(),
   duplicate_code_on_device: duplicate_code_on_device.optional().nullable(),
   duplicate_code_attempt_prevented: duplicate_code_attempt_prevented.optional().nullable(),
+  access_code_state_unconfirmed: access_code_state_unconfirmed.optional().nullable(),
   kwikset_unable_to_confirm_code: kwikset_unable_to_confirm_code.optional().nullable(),
   kwikset_unable_to_confirm_deletion: kwikset_unable_to_confirm_deletion.optional().nullable(),
   kwikset_insufficient_permissions: kwikset_insufficient_permissions.optional().nullable(),
@@ -2456,7 +2488,13 @@ var august_lock_temporarily_offline_warning = common_access_code_warning.extend(
   warning_code: zod.z.literal("august_lock_temporarily_offline").describe(error_code_description3)
 }).describe("August lock is temporarily offline.");
 var code_modified_external_to_seam_warning = common_access_code_warning.extend({
-  warning_code: zod.z.literal("code_modified_external_to_seam").describe(warning_code_description3)
+  warning_code: zod.z.literal("code_modified_external_to_seam").describe(warning_code_description3),
+  change_type: zod.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: zod.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."
 );
@@ -2498,10 +2536,20 @@ var management_transferred = common_access_code_warning.extend({
 var kwikset_unable_to_confirm_code_warning = common_access_code_warning.extend({
   warning_code: zod.z.literal("kwikset_unable_to_confirm_code").describe(warning_code_description3)
 }).describe("Unable to confirm that the access code is set on Kwikset device.");
+var access_code_inactive = common_access_code_warning.extend({
+  warning_code: zod.z.literal("access_code_inactive").describe(warning_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 ultraloq_access_code_disabled = common_access_code_warning.extend({
   warning_code: zod.z.literal("ultraloq_access_code_disabled").describe(warning_code_description3)
 }).describe(
-  "Access code is disabled on Ultraloq device. Re-enable through the Ultraloq mobile app."
+  `
+    ---
+    deprecated: Use \`access_code_inactive\` instead.
+    ---
+    Access code is disabled on Ultraloq device. Re-enable through the Ultraloq mobile app.
+    `
 );
 var using_backup_access_code = common_access_code_warning.extend({
   warning_code: zod.z.literal("using_backup_access_code").describe(warning_code_description3)
@@ -2524,6 +2572,7 @@ var access_code_warning = zod.z.discriminatedUnion("warning_code", [
   igloo_algopin_must_be_used_within_24_hours,
   management_transferred,
   kwikset_unable_to_confirm_code_warning,
+  access_code_inactive,
   ultraloq_access_code_disabled,
   using_backup_access_code,
   being_deleted2
@@ -2543,6 +2592,7 @@ zod.z.object({
   igloo_algopin_must_be_used_within_24_hours: igloo_algopin_must_be_used_within_24_hours.optional().nullable(),
   management_transferred: management_transferred.optional().nullable(),
   kwikset_unable_to_confirm_code_warning: kwikset_unable_to_confirm_code_warning.optional().nullable(),
+  access_code_inactive: access_code_inactive.optional().nullable(),
   ultraloq_access_code_disabled: ultraloq_access_code_disabled.optional().nullable(),
   using_backup_access_code: using_backup_access_code.optional().nullable(),
   being_deleted: being_deleted2.optional().nullable()
@@ -7380,6 +7430,33 @@ var openapi = {
                   type: "object"
                 },
                 {
+                  description: "Indicates that the provider cannot confirm whether the access code was set or removed on the device.",
+                  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_state_unconfirmed"],
+                      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: "Unable to confirm that the access code is set on Kwikset device.",
                   properties: {
                     created_at: {
@@ -7403,9 +7480,11 @@ var openapi = {
                     }
                   },
                   required: ["message", "is_access_code_error", "error_code"],
-                  type: "object"
+                  type: "object",
+                  "x-deprecated": "Use `access_code_state_unconfirmed` instead."
                 },
                 {
+                  deprecated: true,
                   description: "Unable to confirm the deletion of the access code on Kwikset device.",
                   properties: {
                     created_at: {
@@ -7429,11 +7508,17 @@ var openapi = {
                     }
                   },
                   required: ["message", "is_access_code_error", "error_code"],
-                  type: "object"
+                  type: "object",
+                  "x-deprecated": "Use `access_code_state_unconfirmed` instead."
                 },
                 {
                   description: "Code was modified or removed externally after Seam successfully set it on the device.",
                   properties: {
+                    change_type: {
+                      description: "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.",
+                      enum: ["modified", "removed"],
+                      type: "string"
+                    },
                     created_at: {
                       description: "Date and time at which Seam created the error.",
                       format: "date-time",
@@ -7452,6 +7537,30 @@ var openapi = {
                     message: {
                       description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
                       type: "string"
+                    },
+                    modified_fields: {
+                      description: "List of fields that were changed externally, with their previous and new values.",
+                      items: {
+                        properties: {
+                          field: {
+                            description: "The name of the field that was changed (e.g. `code`, `starts_at`, `ends_at`).",
+                            type: "string"
+                          },
+                          from: {
+                            description: "The previous value of the field.",
+                            nullable: true,
+                            type: "string"
+                          },
+                          to: {
+                            description: "The new value of the field.",
+                            nullable: true,
+                            type: "string"
+                          }
+                        },
+                        required: ["field", "from", "to"],
+                        type: "object"
+                      },
+                      type: "array"
                     }
                   },
                   required: ["message", "is_access_code_error", "error_code"],
@@ -8626,6 +8735,11 @@ var openapi = {
                 {
                   description: "Code was modified or removed externally after Seam successfully set it on the device.",
                   properties: {
+                    change_type: {
+                      description: "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.",
+                      enum: ["modified", "removed"],
+                      type: "string"
+                    },
                     created_at: {
                       description: "Date and time at which Seam created the warning.",
                       format: "date-time",
@@ -8635,6 +8749,30 @@ var openapi = {
                       description: "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.",
                       type: "string"
                     },
+                    modified_fields: {
+                      description: "List of fields that were changed externally, with their previous and new values.",
+                      items: {
+                        properties: {
+                          field: {
+                            description: "The name of the field that was changed (e.g. `code`, `starts_at`, `ends_at`).",
+                            type: "string"
+                          },
+                          from: {
+                            description: "The previous value of the field.",
+                            nullable: true,
+                            type: "string"
+                          },
+                          to: {
+                            description: "The new value of the field.",
+                            nullable: true,
+                            type: "string"
+                          }
+                        },
+                        required: ["field", "from", "to"],
+                        type: "object"
+                      },
+                      type: "array"
+                    },
                     warning_code: {
                       description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
                       enum: ["code_modified_external_to_seam"],
@@ -8792,6 +8930,28 @@ var openapi = {
                   type: "object"
                 },
                 {
+                  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 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: ["access_code_inactive"],
+                      type: "string"
+                    }
+                  },
+                  required: ["message", "warning_code"],
+                  type: "object"
+                },
+                {
+                  deprecated: true,
                   description: "Access code is disabled on Ultraloq device. Re-enable through the Ultraloq mobile app.",
                   properties: {
                     created_at: {
@@ -8810,7 +8970,8 @@ var openapi = {
                     }
                   },
                   required: ["message", "warning_code"],
-                  type: "object"
+                  type: "object",
+                  "x-deprecated": "Use `access_code_inactive` instead."
                 },
                 {
                   description: "A backup access code has been pulled and is being used in place of this access code.",
@@ -31829,6 +31990,33 @@ var openapi = {
                   type: "object"
                 },
                 {
+                  description: "Indicates that the provider cannot confirm whether the access code was set or removed on the device.",
+                  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_state_unconfirmed"],
+                      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: "Unable to confirm that the access code is set on Kwikset device.",
                   properties: {
                     created_at: {
@@ -31852,9 +32040,11 @@ var openapi = {
                     }
                   },
                   required: ["message", "is_access_code_error", "error_code"],
-                  type: "object"
+                  type: "object",
+                  "x-deprecated": "Use `access_code_state_unconfirmed` instead."
                 },
                 {
+                  deprecated: true,
                   description: "Unable to confirm the deletion of the access code on Kwikset device.",
                   properties: {
                     created_at: {
@@ -31878,11 +32068,17 @@ var openapi = {
                     }
                   },
                   required: ["message", "is_access_code_error", "error_code"],
-                  type: "object"
+                  type: "object",
+                  "x-deprecated": "Use `access_code_state_unconfirmed` instead."
                 },
                 {
                   description: "Code was modified or removed externally after Seam successfully set it on the device.",
                   properties: {
+                    change_type: {
+                      description: "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.",
+                      enum: ["modified", "removed"],
+                      type: "string"
+                    },
                     created_at: {
                       description: "Date and time at which Seam created the error.",
                       format: "date-time",
@@ -31901,6 +32097,30 @@ var openapi = {
                     message: {
                       description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
                       type: "string"
+                    },
+                    modified_fields: {
+                      description: "List of fields that were changed externally, with their previous and new values.",
+                      items: {
+                        properties: {
+                          field: {
+                            description: "The name of the field that was changed (e.g. `code`, `starts_at`, `ends_at`).",
+                            type: "string"
+                          },
+                          from: {
+                            description: "The previous value of the field.",
+                            nullable: true,
+                            type: "string"
+                          },
+                          to: {
+                            description: "The new value of the field.",
+                            nullable: true,
+                            type: "string"
+                          }
+                        },
+                        required: ["field", "from", "to"],
+                        type: "object"
+                      },
+                      type: "array"
                     }
                   },
                   required: ["message", "is_access_code_error", "error_code"],
@@ -32792,6 +33012,11 @@ var openapi = {
                 {
                   description: "Code was modified or removed externally after Seam successfully set it on the device.",
                   properties: {
+                    change_type: {
+                      description: "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.",
+                      enum: ["modified", "removed"],
+                      type: "string"
+                    },
                     created_at: {
                       description: "Date and time at which Seam created the warning.",
                       format: "date-time",
@@ -32801,6 +33026,30 @@ var openapi = {
                       description: "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.",
                       type: "string"
                     },
+                    modified_fields: {
+                      description: "List of fields that were changed externally, with their previous and new values.",
+                      items: {
+                        properties: {
+                          field: {
+                            description: "The name of the field that was changed (e.g. `code`, `starts_at`, `ends_at`).",
+                            type: "string"
+                          },
+                          from: {
+                            description: "The previous value of the field.",
+                            nullable: true,
+                            type: "string"
+                          },
+                          to: {
+                            description: "The new value of the field.",
+                            nullable: true,
+                            type: "string"
+                          }
+                        },
+                        required: ["field", "from", "to"],
+                        type: "object"
+                      },
+                      type: "array"
+                    },
                     warning_code: {
                       description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
                       enum: ["code_modified_external_to_seam"],
@@ -32958,6 +33207,28 @@ var openapi = {
                   type: "object"
                 },
                 {
+                  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 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: ["access_code_inactive"],
+                      type: "string"
+                    }
+                  },
+                  required: ["message", "warning_code"],
+                  type: "object"
+                },
+                {
+                  deprecated: true,
                   description: "Access code is disabled on Ultraloq device. Re-enable through the Ultraloq mobile app.",
                   properties: {
                     created_at: {
@@ -32976,7 +33247,8 @@ var openapi = {
                     }
                   },
                   required: ["message", "warning_code"],
-                  type: "object"
+                  type: "object",
+                  "x-deprecated": "Use `access_code_inactive` instead."
                 },
                 {
                   description: "A backup access code has been pulled and is being used in place of this access code.",