@seamapi/types 1.952.0 → 1.953.0

package/dist/connect.d.cts

@@ -28888,6 +28888,16 @@ declare const seam_event: z.ZodDiscriminatedUnion<"event_type", [z.ZodObject<{
     acs_user_id: z.ZodOptional<z.ZodString>;
     acs_entrance_id: z.ZodOptional<z.ZodString>;
     device_id: z.ZodOptional<z.ZodString>;
+    reason: z.ZodOptional<z.ZodObject<{
+        reason_code: z.ZodEnum<["unknown_code", "expired_code", "blocklisted_code", "too_many_attempts", "blocked_by_privacy_mode", "credential_error"]>;
+        message: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        message: string;
+        reason_code: "unknown_code" | "expired_code" | "blocklisted_code" | "too_many_attempts" | "blocked_by_privacy_mode" | "credential_error";
+    }, {
+        message: string;
+        reason_code: "unknown_code" | "expired_code" | "blocklisted_code" | "too_many_attempts" | "blocked_by_privacy_mode" | "credential_error";
+    }>>;
 }, "strip", z.ZodTypeAny, {
     workspace_id: string;
     created_at: string;
@@ -28898,6 +28908,10 @@ declare const seam_event: z.ZodDiscriminatedUnion<"event_type", [z.ZodObject<{
     device_id?: string | undefined;
     customer_key?: string | undefined;
     access_code_id?: string | undefined;
+    reason?: {
+        message: string;
+        reason_code: "unknown_code" | "expired_code" | "blocklisted_code" | "too_many_attempts" | "blocked_by_privacy_mode" | "credential_error";
+    } | undefined;
     user_identity_id?: string | undefined;
     acs_user_id?: string | undefined;
     acs_entrance_id?: string | undefined;
@@ -28915,6 +28929,10 @@ declare const seam_event: z.ZodDiscriminatedUnion<"event_type", [z.ZodObject<{
     device_id?: string | undefined;
     customer_key?: string | undefined;
     access_code_id?: string | undefined;
+    reason?: {
+        message: string;
+        reason_code: "unknown_code" | "expired_code" | "blocklisted_code" | "too_many_attempts" | "blocked_by_privacy_mode" | "credential_error";
+    } | undefined;
     user_identity_id?: string | undefined;
     acs_user_id?: string | undefined;
     acs_entrance_id?: string | undefined;
@@ -78277,6 +78295,13 @@ type Routes = {
               ID of the ACS entrance associated with the access-denied event.
              */
                 acs_entrance_id?: string | undefined;
+                /** Why access was denied, when the provider reports a determinable cause. Omitted when unknown. */
+                reason?: {
+                    /** Normalized reason a lock denied access. Provider-agnostic; not all providers report every value. */
+                    reason_code: 'unknown_code' | 'expired_code' | 'blocklisted_code' | 'too_many_attempts' | 'blocked_by_privacy_mode' | 'credential_error';
+                    /** Human-readable explanation of why access was denied. */
+                    message: string;
+                } | undefined;
             } | {
                 /** ID of the event. */
                 event_id: string;
@@ -81536,6 +81561,13 @@ type Routes = {
                   ID of the ACS entrance associated with the access-denied event.
                  */
                 acs_entrance_id?: string | undefined;
+                /** Why access was denied, when the provider reports a determinable cause. Omitted when unknown. */
+                reason?: {
+                    /** Normalized reason a lock denied access. Provider-agnostic; not all providers report every value. */
+                    reason_code: 'unknown_code' | 'expired_code' | 'blocklisted_code' | 'too_many_attempts' | 'blocked_by_privacy_mode' | 'credential_error';
+                    /** Human-readable explanation of why access was denied. */
+                    message: string;
+                } | undefined;
             } | {
                 /** ID of the event. */
                 event_id: string;
@@ -111300,6 +111332,13 @@ type Routes = {
                   ID of the ACS entrance associated with the access-denied event.
                  */
                 acs_entrance_id?: string | undefined;
+                /** Why access was denied, when the provider reports a determinable cause. Omitted when unknown. */
+                reason?: {
+                    /** Normalized reason a lock denied access. Provider-agnostic; not all providers report every value. */
+                    reason_code: 'unknown_code' | 'expired_code' | 'blocklisted_code' | 'too_many_attempts' | 'blocked_by_privacy_mode' | 'credential_error';
+                    /** Human-readable explanation of why access was denied. */
+                    message: string;
+                } | undefined;
             } | {
                 /** ID of the event. */
                 event_id: string;
@@ -149395,6 +149434,13 @@ type Routes = {
                     ID of the ACS entrance associated with the access-denied event.
                    */
                     acs_entrance_id?: string | undefined;
+                    /** Why access was denied, when the provider reports a determinable cause. Omitted when unknown. */
+                    reason?: {
+                        /** Normalized reason a lock denied access. Provider-agnostic; not all providers report every value. */
+                        reason_code: 'unknown_code' | 'expired_code' | 'blocklisted_code' | 'too_many_attempts' | 'blocked_by_privacy_mode' | 'credential_error';
+                        /** Human-readable explanation of why access was denied. */
+                        message: string;
+                    } | undefined;
                 } | {
                     /** ID of the event. */
                     event_id: string;

package/dist/index.cjs

@@ -5616,6 +5616,16 @@ var common_event_warning = zod.z.object({
 }).describe(
   "Warning associated with the resource, including the warning code, message, and creation timestamp."
 );
+var lock_access_denied_reason = zod.z.enum([
+  "unknown_code",
+  "expired_code",
+  "blocklisted_code",
+  "too_many_attempts",
+  "blocked_by_privacy_mode",
+  "credential_error"
+]).describe(
+  "Normalized reason a lock denied access. Provider-agnostic; not all providers report every value."
+);
 
 // src/lib/seam/connect/models/events/access-codes.ts
 var access_code_event = common_event.extend({
@@ -6782,7 +6792,13 @@ var lock_access_denied_event = device_event.extend({
       ---
       ID of the ACS entrance associated with the access-denied event.
     `),
-  device_id: zod.z.string().uuid().optional().describe("ID of the affected device.")
+  device_id: zod.z.string().uuid().optional().describe("ID of the affected device."),
+  reason: zod.z.object({
+    reason_code: lock_access_denied_reason,
+    message: zod.z.string().describe("Human-readable explanation of why access was denied.")
+  }).optional().describe(
+    "Why access was denied, when the provider reports a determinable cause. Omitted when unknown."
+  )
 }).describe(`
   ---
   route_path: /locks
@@ -31035,6 +31051,29 @@ var openapi = {
                 format: "date-time",
                 type: "string"
               },
+              reason: {
+                description: "Why access was denied, when the provider reports a determinable cause. Omitted when unknown.",
+                properties: {
+                  message: {
+                    description: "Human-readable explanation of why access was denied.",
+                    type: "string"
+                  },
+                  reason_code: {
+                    description: "Normalized reason a lock denied access. Provider-agnostic; not all providers report every value.",
+                    enum: [
+                      "unknown_code",
+                      "expired_code",
+                      "blocklisted_code",
+                      "too_many_attempts",
+                      "blocked_by_privacy_mode",
+                      "credential_error"
+                    ],
+                    type: "string"
+                  }
+                },
+                required: ["reason_code", "message"],
+                type: "object"
+              },
               user_identity_id: {
                 description: "\n      undocumented: Unreleased.\n      ---\n      ID of the user identity associated with the access-denied event.\n    ",
                 format: "uuid",