@seamapi/types 1.312.2 → 1.313.1

package/lib/seam/connect/models/action-attempts/action-attempt.d.ts

@@ -1309,13 +1309,13 @@ export declare const action_attempt: z.ZodUnion<[z.ZodObject<z.objectUtil.extend
         type: "action_attempt_expired";
         message: string;
     }>, z.ZodObject<{
-        type: z.ZodLiteral<"no_card_on_encoder">;
+        type: z.ZodLiteral<"no_credential_on_encoder">;
         message: z.ZodString;
     }, "strip", z.ZodTypeAny, {
-        type: "no_card_on_encoder";
+        type: "no_credential_on_encoder";
         message: string;
     }, {
-        type: "no_card_on_encoder";
+        type: "no_credential_on_encoder";
         message: string;
     }>]>;
 }>, "strip", z.ZodTypeAny, {
@@ -1326,7 +1326,7 @@ export declare const action_attempt: z.ZodUnion<[z.ZodObject<z.objectUtil.extend
         type: "action_attempt_expired";
         message: string;
     } | {
-        type: "no_card_on_encoder";
+        type: "no_credential_on_encoder";
         message: string;
     };
     status: "error";
@@ -1341,7 +1341,7 @@ export declare const action_attempt: z.ZodUnion<[z.ZodObject<z.objectUtil.extend
         type: "action_attempt_expired";
         message: string;
     } | {
-        type: "no_card_on_encoder";
+        type: "no_credential_on_encoder";
         message: string;
     };
     status: "error";
@@ -2079,13 +2079,13 @@ export declare const action_attempt: z.ZodUnion<[z.ZodObject<z.objectUtil.extend
         type: "action_attempt_expired";
         message: string;
     }>, z.ZodObject<{
-        type: z.ZodLiteral<"no_card_on_encoder">;
+        type: z.ZodLiteral<"no_credential_on_encoder">;
         message: z.ZodString;
     }, "strip", z.ZodTypeAny, {
-        type: "no_card_on_encoder";
+        type: "no_credential_on_encoder";
         message: string;
     }, {
-        type: "no_card_on_encoder";
+        type: "no_credential_on_encoder";
         message: string;
     }>, z.ZodObject<{
         type: z.ZodLiteral<"incompatible_card_format">;
@@ -2105,7 +2105,7 @@ export declare const action_attempt: z.ZodUnion<[z.ZodObject<z.objectUtil.extend
         type: "action_attempt_expired";
         message: string;
     } | {
-        type: "no_card_on_encoder";
+        type: "no_credential_on_encoder";
         message: string;
     } | {
         type: "incompatible_card_format";
@@ -2123,7 +2123,7 @@ export declare const action_attempt: z.ZodUnion<[z.ZodObject<z.objectUtil.extend
         type: "action_attempt_expired";
         message: string;
     } | {
-        type: "no_card_on_encoder";
+        type: "no_credential_on_encoder";
         message: string;
     } | {
         type: "incompatible_card_format";

package/lib/seam/connect/models/action-attempts/encode-credential.d.ts

@@ -730,13 +730,13 @@ export declare const encode_credential_action_attempt: z.ZodDiscriminatedUnion<"
         type: "action_attempt_expired";
         message: string;
     }>, z.ZodObject<{
-        type: z.ZodLiteral<"no_card_on_encoder">;
+        type: z.ZodLiteral<"no_credential_on_encoder">;
         message: z.ZodString;
     }, "strip", z.ZodTypeAny, {
-        type: "no_card_on_encoder";
+        type: "no_credential_on_encoder";
         message: string;
     }, {
-        type: "no_card_on_encoder";
+        type: "no_credential_on_encoder";
         message: string;
     }>, z.ZodObject<{
         type: z.ZodLiteral<"incompatible_card_format">;
@@ -756,7 +756,7 @@ export declare const encode_credential_action_attempt: z.ZodDiscriminatedUnion<"
         type: "action_attempt_expired";
         message: string;
     } | {
-        type: "no_card_on_encoder";
+        type: "no_credential_on_encoder";
         message: string;
     } | {
         type: "incompatible_card_format";
@@ -774,7 +774,7 @@ export declare const encode_credential_action_attempt: z.ZodDiscriminatedUnion<"
         type: "action_attempt_expired";
         message: string;
     } | {
-        type: "no_card_on_encoder";
+        type: "no_credential_on_encoder";
         message: string;
     } | {
         type: "incompatible_card_format";

package/lib/seam/connect/models/action-attempts/encode-credential.js

@@ -2,8 +2,8 @@ import { z } from 'zod';
 import { acs_credential, unmanaged_acs_credential, } from '../acs/acs-credential.js';
 import { common_action_attempt_errors, common_failed_action_attempt, common_pending_action_attempt, common_succeeded_action_attempt, } from './common.js';
 const action_type = z.literal('ENCODE_CREDENTIAL');
-const no_card_on_encoder_error = z.object({
-    type: z.literal('no_card_on_encoder'),
+const no_credential_on_encoder_error = z.object({
+    type: z.literal('no_credential_on_encoder'),
     message: z.string(),
 });
 const incompatible_card_format_error = z.object({
@@ -12,7 +12,7 @@ const incompatible_card_format_error = z.object({
 });
 const error = z.union([
     ...common_action_attempt_errors,
-    no_card_on_encoder_error,
+    no_credential_on_encoder_error,
     incompatible_card_format_error,
 ]);
 const result = acs_credential.or(unmanaged_acs_credential);

package/lib/seam/connect/models/action-attempts/encode-credential.js.map

@@ -1 +1 @@
-{"version":3,"file":"encode-credential.js","sourceRoot":"","sources":["../../../../../src/lib/seam/connect/models/action-attempts/encode-credential.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAEvB,OAAO,EACL,cAAc,EACd,wBAAwB,GACzB,MAAM,0BAA0B,CAAA;AACjC,OAAO,EACL,4BAA4B,EAC5B,4BAA4B,EAC5B,6BAA6B,EAC7B,+BAA+B,GAChC,MAAM,aAAa,CAAA;AAEpB,MAAM,WAAW,GAAG,CAAC,CAAC,OAAO,CAAC,mBAAmB,CAAC,CAAA;AAElD,MAAM,wBAAwB,GAAG,CAAC,CAAC,MAAM,CAAC;IACxC,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,oBAAoB,CAAC;IACrC,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE;CACpB,CAAC,CAAA;AAEF,MAAM,8BAA8B,GAAG,CAAC,CAAC,MAAM,CAAC;IAC9C,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,0BAA0B,CAAC;IAC3C,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE;CACpB,CAAC,CAAA;AAEF,MAAM,KAAK,GAAG,CAAC,CAAC,KAAK,CAAC;IACpB,GAAG,4BAA4B;IAC/B,wBAAwB;IACxB,8BAA8B;CAC/B,CAAC,CAAA;AAEF,MAAM,MAAM,GAAG,cAAc,CAAC,EAAE,CAAC,wBAAwB,CAAC,CAAA;AAE1D,MAAM,CAAC,MAAM,gCAAgC,GAAG,CAAC,CAAC,kBAAkB,CAAC,QAAQ,EAAE;IAC7E,6BAA6B;SAC1B,MAAM,CAAC;QACN,WAAW;KACZ,CAAC;SACD,QAAQ,CAAC,iDAAiD,CAAC;IAC9D,+BAA+B;SAC5B,MAAM,CAAC;QACN,WAAW;QACX,MAAM;KACP,CAAC;SACD,QAAQ,CAAC,2DAA2D,CAAC;IACxE,4BAA4B;SACzB,MAAM,CAAC,EAAE,WAAW,EAAE,KAAK,EAAE,CAAC;SAC9B,QAAQ,CAAC,wDAAwD,CAAC;CACtE,CAAC,CAAA"}
+{"version":3,"file":"encode-credential.js","sourceRoot":"","sources":["../../../../../src/lib/seam/connect/models/action-attempts/encode-credential.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAEvB,OAAO,EACL,cAAc,EACd,wBAAwB,GACzB,MAAM,0BAA0B,CAAA;AACjC,OAAO,EACL,4BAA4B,EAC5B,4BAA4B,EAC5B,6BAA6B,EAC7B,+BAA+B,GAChC,MAAM,aAAa,CAAA;AAEpB,MAAM,WAAW,GAAG,CAAC,CAAC,OAAO,CAAC,mBAAmB,CAAC,CAAA;AAElD,MAAM,8BAA8B,GAAG,CAAC,CAAC,MAAM,CAAC;IAC9C,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,0BAA0B,CAAC;IAC3C,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE;CACpB,CAAC,CAAA;AAEF,MAAM,8BAA8B,GAAG,CAAC,CAAC,MAAM,CAAC;IAC9C,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,0BAA0B,CAAC;IAC3C,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE;CACpB,CAAC,CAAA;AAEF,MAAM,KAAK,GAAG,CAAC,CAAC,KAAK,CAAC;IACpB,GAAG,4BAA4B;IAC/B,8BAA8B;IAC9B,8BAA8B;CAC/B,CAAC,CAAA;AAEF,MAAM,MAAM,GAAG,cAAc,CAAC,EAAE,CAAC,wBAAwB,CAAC,CAAA;AAE1D,MAAM,CAAC,MAAM,gCAAgC,GAAG,CAAC,CAAC,kBAAkB,CAAC,QAAQ,EAAE;IAC7E,6BAA6B;SAC1B,MAAM,CAAC;QACN,WAAW;KACZ,CAAC;SACD,QAAQ,CAAC,iDAAiD,CAAC;IAC9D,+BAA+B;SAC5B,MAAM,CAAC;QACN,WAAW;QACX,MAAM;KACP,CAAC;SACD,QAAQ,CAAC,2DAA2D,CAAC;IACxE,4BAA4B;SACzB,MAAM,CAAC,EAAE,WAAW,EAAE,KAAK,EAAE,CAAC;SAC9B,QAAQ,CAAC,wDAAwD,CAAC;CACtE,CAAC,CAAA"}

package/lib/seam/connect/models/action-attempts/scan-credential.d.ts

@@ -1153,13 +1153,13 @@ export declare const scan_credential_action_attempt: z.ZodDiscriminatedUnion<"st
         type: "action_attempt_expired";
         message: string;
     }>, z.ZodObject<{
-        type: z.ZodLiteral<"no_card_on_encoder">;
+        type: z.ZodLiteral<"no_credential_on_encoder">;
         message: z.ZodString;
     }, "strip", z.ZodTypeAny, {
-        type: "no_card_on_encoder";
+        type: "no_credential_on_encoder";
         message: string;
     }, {
-        type: "no_card_on_encoder";
+        type: "no_credential_on_encoder";
         message: string;
     }>]>;
 }>, "strip", z.ZodTypeAny, {
@@ -1170,7 +1170,7 @@ export declare const scan_credential_action_attempt: z.ZodDiscriminatedUnion<"st
         type: "action_attempt_expired";
         message: string;
     } | {
-        type: "no_card_on_encoder";
+        type: "no_credential_on_encoder";
         message: string;
     };
     status: "error";
@@ -1185,7 +1185,7 @@ export declare const scan_credential_action_attempt: z.ZodDiscriminatedUnion<"st
         type: "action_attempt_expired";
         message: string;
     } | {
-        type: "no_card_on_encoder";
+        type: "no_credential_on_encoder";
         message: string;
     };
     status: "error";

package/lib/seam/connect/models/action-attempts/scan-credential.js

@@ -2,13 +2,13 @@ import { z } from 'zod';
 import { acs_credential, acs_credential_on_encoder, unmanaged_acs_credential, } from '../acs/acs-credential.js';
 import { common_action_attempt_errors, common_failed_action_attempt, common_pending_action_attempt, common_succeeded_action_attempt, } from './common.js';
 const action_type = z.literal('SCAN_CREDENTIAL');
-const no_card_on_encoder_error = z.object({
-    type: z.literal('no_card_on_encoder'),
+const no_credential_on_encoder_error = z.object({
+    type: z.literal('no_credential_on_encoder'),
     message: z.string(),
 });
 const error = z.union([
     ...common_action_attempt_errors,
-    no_card_on_encoder_error,
+    no_credential_on_encoder_error,
 ]);
 const warning = z.object({
     warning_code: z.union([

package/lib/seam/connect/models/action-attempts/scan-credential.js.map

@@ -1 +1 @@
-{"version":3,"file":"scan-credential.js","sourceRoot":"","sources":["../../../../../src/lib/seam/connect/models/action-attempts/scan-credential.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAEvB,OAAO,EACL,cAAc,EACd,yBAAyB,EACzB,wBAAwB,GACzB,MAAM,0BAA0B,CAAA;AACjC,OAAO,EACL,4BAA4B,EAC5B,4BAA4B,EAC5B,6BAA6B,EAC7B,+BAA+B,GAChC,MAAM,aAAa,CAAA;AAEpB,MAAM,WAAW,GAAG,CAAC,CAAC,OAAO,CAAC,iBAAiB,CAAC,CAAA;AAEhD,MAAM,wBAAwB,GAAG,CAAC,CAAC,MAAM,CAAC;IACxC,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,oBAAoB,CAAC;IACrC,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE;CACpB,CAAC,CAAA;AAEF,MAAM,KAAK,GAAG,CAAC,CAAC,KAAK,CAAC;IACpB,GAAG,4BAA4B;IAC/B,wBAAwB;CACzB,CAAC,CAAA;AAEF,MAAM,OAAO,GAAG,CAAC,CAAC,MAAM,CAAC;IACvB,YAAY,EAAE,CAAC,CAAC,KAAK,CAAC;QACpB,CAAC,CAAC,OAAO,CAAC,uCAAuC,CAAC;QAClD,CAAC,CAAC,OAAO,CAAC,kCAAkC,CAAC;KAC9C,CAAC;IACF,eAAe,EAAE,CAAC,CAAC,MAAM,EAAE;CAC5B,CAAC,CAAA;AAEF,MAAM,sBAAsB,GAAG,cAAc,CAAC,EAAE,CAAC,wBAAwB,CAAC,CAAA;AAE1E,MAAM,MAAM,GAAG,CAAC,CAAC,MAAM,CAAC;IACtB,yBAAyB,EAAE,yBAAyB;SACjD,QAAQ,EAAE;SACV,QAAQ,CAAC,yDAAyD,CAAC;IACtE,sBAAsB,EAAE,sBAAsB;SAC3C,QAAQ,EAAE;SACV,QAAQ,CAAC,yDAAyD,CAAC;IACtE,QAAQ,EAAE,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC;CAC3B,CAAC,CAAA;AAEF,MAAM,CAAC,MAAM,8BAA8B,GAAG,CAAC,CAAC,kBAAkB,CAAC,QAAQ,EAAE;IAC3E,6BAA6B;SAC1B,MAAM,CAAC;QACN,WAAW;KACZ,CAAC;SACD,QAAQ,CAAC,gDAAgD,CAAC;IAC7D,+BAA+B;SAC5B,MAAM,CAAC;QACN,WAAW;QACX,MAAM;KACP,CAAC;SACD,QAAQ,CAAC,0DAA0D,CAAC;IACvE,4BAA4B;SACzB,MAAM,CAAC,EAAE,WAAW,EAAE,KAAK,EAAE,CAAC;SAC9B,QAAQ,CAAC,uDAAuD,CAAC;CACrE,CAAC,CAAA"}
+{"version":3,"file":"scan-credential.js","sourceRoot":"","sources":["../../../../../src/lib/seam/connect/models/action-attempts/scan-credential.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAEvB,OAAO,EACL,cAAc,EACd,yBAAyB,EACzB,wBAAwB,GACzB,MAAM,0BAA0B,CAAA;AACjC,OAAO,EACL,4BAA4B,EAC5B,4BAA4B,EAC5B,6BAA6B,EAC7B,+BAA+B,GAChC,MAAM,aAAa,CAAA;AAEpB,MAAM,WAAW,GAAG,CAAC,CAAC,OAAO,CAAC,iBAAiB,CAAC,CAAA;AAEhD,MAAM,8BAA8B,GAAG,CAAC,CAAC,MAAM,CAAC;IAC9C,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,0BAA0B,CAAC;IAC3C,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE;CACpB,CAAC,CAAA;AAEF,MAAM,KAAK,GAAG,CAAC,CAAC,KAAK,CAAC;IACpB,GAAG,4BAA4B;IAC/B,8BAA8B;CAC/B,CAAC,CAAA;AAEF,MAAM,OAAO,GAAG,CAAC,CAAC,MAAM,CAAC;IACvB,YAAY,EAAE,CAAC,CAAC,KAAK,CAAC;QACpB,CAAC,CAAC,OAAO,CAAC,uCAAuC,CAAC;QAClD,CAAC,CAAC,OAAO,CAAC,kCAAkC,CAAC;KAC9C,CAAC;IACF,eAAe,EAAE,CAAC,CAAC,MAAM,EAAE;CAC5B,CAAC,CAAA;AAEF,MAAM,sBAAsB,GAAG,cAAc,CAAC,EAAE,CAAC,wBAAwB,CAAC,CAAA;AAE1E,MAAM,MAAM,GAAG,CAAC,CAAC,MAAM,CAAC;IACtB,yBAAyB,EAAE,yBAAyB;SACjD,QAAQ,EAAE;SACV,QAAQ,CAAC,yDAAyD,CAAC;IACtE,sBAAsB,EAAE,sBAAsB;SAC3C,QAAQ,EAAE;SACV,QAAQ,CAAC,yDAAyD,CAAC;IACtE,QAAQ,EAAE,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC;CAC3B,CAAC,CAAA;AAEF,MAAM,CAAC,MAAM,8BAA8B,GAAG,CAAC,CAAC,kBAAkB,CAAC,QAAQ,EAAE;IAC3E,6BAA6B;SAC1B,MAAM,CAAC;QACN,WAAW;KACZ,CAAC;SACD,QAAQ,CAAC,gDAAgD,CAAC;IAC7D,+BAA+B;SAC5B,MAAM,CAAC;QACN,WAAW;QACX,MAAM;KACP,CAAC;SACD,QAAQ,CAAC,0DAA0D,CAAC;IACvE,4BAA4B;SACzB,MAAM,CAAC,EAAE,WAAW,EAAE,KAAK,EAAE,CAAC;SAC9B,QAAQ,CAAC,uDAAuD,CAAC;CACrE,CAAC,CAAA"}

package/lib/seam/connect/models/events/common.js

@@ -1,28 +1,14 @@
 import { z } from 'zod';
 export const common_event = z.object({
-    event_id: z.string().uuid().describe(`
-    ---
-    title: Event ID
-    ---
-    The ID of the event.
-  `),
-    workspace_id: z.string().uuid().describe(`
-    ---
-    title: Workspace ID
-    ---
-    The ID of the workspace.
-  `),
-    created_at: z.string().datetime().describe(`
-    ---
-    title: Created At
-    ---
-    The time when the event was created.
-  `),
-    occurred_at: z.string().datetime().describe(`
-    ---
-    title: Occurred At
-    ---
-    The time when the event occurred.
-  `),
+    event_id: z.string().uuid().describe('ID of the event.'),
+    workspace_id: z
+        .string()
+        .uuid()
+        .describe('ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces).'),
+    created_at: z
+        .string()
+        .datetime()
+        .describe('Time at which the event was created.'),
+    occurred_at: z.string().datetime().describe('Time when the event occurred.'),
 });
 //# sourceMappingURL=common.js.map

package/lib/seam/connect/models/events/common.js.map

@@ -1 +1 @@
-{"version":3,"file":"common.js","sourceRoot":"","sources":["../../../../../src/lib/seam/connect/models/events/common.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAEvB,MAAM,CAAC,MAAM,YAAY,GAAG,CAAC,CAAC,MAAM,CAAC;IACnC,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,CAAC,QAAQ,CAAC;;;;;GAKpC,CAAC;IACF,YAAY,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,CAAC,QAAQ,CAAC;;;;;GAKxC,CAAC;IACF,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC;;;;;GAK1C,CAAC;IACF,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC;;;;;GAK3C,CAAC;CACH,CAAC,CAAA"}
+{"version":3,"file":"common.js","sourceRoot":"","sources":["../../../../../src/lib/seam/connect/models/events/common.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAEvB,MAAM,CAAC,MAAM,YAAY,GAAG,CAAC,CAAC,MAAM,CAAC;IACnC,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,CAAC,QAAQ,CAAC,kBAAkB,CAAC;IACxD,YAAY,EAAE,CAAC;SACZ,MAAM,EAAE;SACR,IAAI,EAAE;SACN,QAAQ,CACP,8EAA8E,CAC/E;IACH,UAAU,EAAE,CAAC;SACV,MAAM,EAAE;SACR,QAAQ,EAAE;SACV,QAAQ,CAAC,sCAAsC,CAAC;IACnD,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,+BAA+B,CAAC;CAC7E,CAAC,CAAA"}

package/lib/seam/connect/models/events/devices.js

@@ -2,54 +2,26 @@ import { z } from 'zod';
 import { climate_setting } from '../thermostats/climate-preset.js';
 import { common_event } from './common.js';
 const device_event = common_event.extend({
-    device_id: z.string().uuid().describe(`
-    ---
-    title: Device ID
-    ---
-    ID of the device.
-  `),
-    connected_account_id: z.string().uuid().describe(`
-    ---
-    title: Connected Account ID
-    ---
-    ID of the connected account.
-  `),
+    device_id: z.string().uuid().describe('ID of the device.'),
+    connected_account_id: z
+        .string()
+        .uuid()
+        .describe('ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).'),
 });
-const battery_level = z.number().min(0).max(1).describe(`
-  ---
-  title: Battery Level
-  ---
-  Fractional number 0 to 1.0 indicating amount of battery in device, as reported by device.
-`);
-const device_battery_status = z.enum(['critical', 'low', 'good', 'full'])
-    .describe(`
-  ---
-  title: Battery Status
-  ---
-  Enum representing the battery status calculated from numeric battery_level value, one of 'critical' | 'low' | 'good' | 'full'
-`);
-const disconnection_error_code = z.enum([
-    'account_disconnected',
-    'hub_disconnected',
-    'device_disconnected',
-]).describe(`
-  ---
-  title: Event Error Code
-  ---
-  The error code associated with the event, if any.
-`);
-export const lock_method = z.enum([
-    'keycode',
-    'manual',
-    'automatic',
-    'unknown',
-    'seamapi',
-]).describe(`
-  ---
-  title: Lock Lock/Unlock Method
-  ---
-  Method by which a lock device was locked or unlocked. When the method is \`keycode\`, the \`access_code_id\` will reference the Seam access code which was used, if reported by the device.
-`);
+const battery_level = z
+    .number()
+    .min(0)
+    .max(1)
+    .describe('Number in the range 0 to 1.0 indicating the amount of battery in the device, as reported by the device.');
+const device_battery_status = z
+    .enum(['critical', 'low', 'good', 'full'])
+    .describe('Battery status of the device, calculated from the numeric `battery_level` value.');
+const disconnection_error_code = z
+    .enum(['account_disconnected', 'hub_disconnected', 'device_disconnected'])
+    .describe('Error code associated with the disconnection event, if any.');
+export const lock_method = z
+    .enum(['keycode', 'manual', 'automatic', 'unknown', 'seamapi'])
+    .describe('Method by which a lock device was locked or unlocked. When the method is `keycode`, the `access_code_id` indicates the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) that was used, if reported by the device.');
 export const device_connected_event = device_event
     .extend({
     event_type: z.literal('device.connected'),
@@ -59,39 +31,39 @@ export const device_added_event = device_event
     .extend({
     event_type: z.literal('device.added'),
 })
-    .describe('A device has been added or reconnected to Seam.');
+    .describe('A device was added or reconnected to Seam.');
 export const device_converted_to_unmanaged_event = device_event
     .extend({
     event_type: z.literal('device.converted_to_unmanaged'),
 })
-    .describe('An unmanaged device was successfully converted to a managed device.');
+    .describe('An [unmanaged device](https://docs.seam.co/latest/core-concepts/devices/managed-and-unmanaged-devices) was successfully converted to a managed device.');
 export const unmanaged_device_converted_to_managed_event = device_event
     .extend({
     event_type: z.literal('device.unmanaged.converted_to_managed'),
 })
-    .describe('A managed device was successfully converted to an unmanaged device.');
+    .describe('A managed device was successfully converted to an [unmanaged device](https://docs.seam.co/latest/core-concepts/devices/managed-and-unmanaged-devices).');
 export const unmanaged_device_connected_event = device_event
     .extend({
     event_type: z.literal('device.unmanaged.connected'),
 })
-    .describe('An unmanaged device was connected to Seam');
+    .describe('An [unmanaged device](https://docs.seam.co/latest/core-concepts/devices/managed-and-unmanaged-devices) was connected to Seam.');
 export const device_disconnected_event = device_event
     .extend({
     event_type: z.literal('device.disconnected'),
     error_code: disconnection_error_code,
 })
-    .describe('A device was disconnected');
+    .describe('A device was disconnected from Seam.');
 export const unmanaged_device_disconnected_event = device_event
     .extend({
     event_type: z.literal('device.unmanaged.disconnected'),
     error_code: disconnection_error_code,
 })
-    .describe('An unmanaged device was disconnected');
+    .describe('An [unmanaged device](https://docs.seam.co/latest/core-concepts/devices/managed-and-unmanaged-devices) was disconnected from Seam.');
 export const device_tampered_event = device_event
     .extend({
     event_type: z.literal('device.tampered'),
 })
-    .describe('A device detected that it was tampered with, e.g., opened or moved.');
+    .describe('A device detected that it was tampered with, for example, opened or moved.');
 export const device_low_battery_event = device_event
     .extend({
     event_type: z.literal('device.low_battery'),
@@ -104,27 +76,27 @@ export const device_battery_status_changed_event = device_event
     battery_status: device_battery_status,
     battery_level,
 })
-    .describe('A device battery status changed since the last battery status changed event.');
+    .describe('A device battery status changed since the last `battery_status_changed` event.');
 export const device_removed_event = device_event
     .extend({
     event_type: z.literal('device.removed'),
 })
-    .describe('A device was removed externally from the connected account.');
+    .describe('A device was removed externally from the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).');
 export const device_deleted_event = device_event
     .extend({
     event_type: z.literal('device.deleted'),
 })
-    .describe('A device was deleted.');
+    .describe('A device was [deleted](https://docs.seam.co/latest/api/devices/delete).');
 export const device_third_party_integration_detected_event = device_event
     .extend({
     event_type: z.literal('device.third_party_integration_detected'),
 })
-    .describe('Seam detected a device is using a third party integration that will interfere with Seam device management.');
+    .describe('Seam detected that a device is using a third-party integration that will interfere with Seam device management.');
 export const device_third_party_integration_no_longer_detected_event = device_event
     .extend({
     event_type: z.literal('device.third_party_integration_no_longer_detected'),
 })
-    .describe('Seam detected a device is no longer using a third party integration that was interfering with Seam device management.');
+    .describe('Seam detected that a device is no longer using a third-party integration that was interfering with Seam device management.');
 export const device_salto_privacy_mode_activated_event = device_event
     .extend({
     event_type: z.literal('device.salto.privacy_mode_activated'),
@@ -144,80 +116,123 @@ export const device_connection_stabilized_event = device_event
     .extend({
     event_type: z.literal('device.connection_stabilized'),
 })
-    .describe('Seam detected a previously flaky device connection stabilized.');
+    .describe('Seam detected that a previously-flaky device connection stabilized.');
 export const device_error_subscription_required_event = device_event
     .extend({
     event_type: z.literal('device.error.subscription_required'),
 })
-    .describe('A third party subscription is required to use all device features.');
+    .describe('A third-party subscription is required to use all device features.');
 export const device_error_subscription_required_resolved_event = device_event
     .extend({
     event_type: z.literal('device.error.subscription_required.resolved'),
 })
-    .describe('A third party subscription is active or no longer-required to use all device features.');
+    .describe('A third-party subscription is active or no longer required to use all device features.');
 export const device_accessory_keypad_connected_event = device_event
     .extend({
     event_type: z.literal('device.accessory_keypad_connected'),
 })
-    .describe('A accessory keypad was connected to a device.');
+    .describe('An accessory keypad was connected to a device.');
 export const device_accessory_keypad_disconnected_event = device_event
     .extend({
     event_type: z.literal('device.accessory_keypad_disconnected'),
 })
-    .describe('A accessory keypad was disconnected to a device.');
+    .describe('An accessory keypad was disconnected from a device.');
 export const noise_sensor_noise_threshold_triggered_event = device_event
     .extend({
     event_type: z.literal('noise_sensor.noise_threshold_triggered'),
-    noise_level_decibels: z.number().optional(),
-    noise_level_nrs: z.number().optional(),
-    noise_threshold_id: z.string().uuid().optional(),
-    noise_threshold_name: z.string().optional(),
+    noise_level_decibels: z
+        .number()
+        .optional()
+        .describe('Detected noise level in decibels.'),
+    noise_level_nrs: z
+        .number()
+        .optional()
+        .describe('Detected noise level in Noiseaware Noise Risk Score (NRS).'),
+    noise_threshold_id: z
+        .string()
+        .uuid()
+        .optional()
+        .describe('ID of the [noise threshold](https://docs.seam.co/latest/capability-guides/noise-sensors#what-is-a-threshold) that was triggered.'),
+    noise_threshold_name: z
+        .string()
+        .optional()
+        .describe('Name of the [noise threshold](https://docs.seam.co/latest/capability-guides/noise-sensors#what-is-a-threshold) that was triggered.'),
     // TODO: remove metadata from this event
     noiseaware_metadata: z.record(z.unknown()).optional().describe(`
       ---
       title: Noiseaware Metadata
       ---
-      Metadata from the Noiseaware API.
+      Metadata from Noiseaware.
     `),
     minut_metadata: z.record(z.unknown()).optional().describe(`
       ---
       title: Minut Metadata
       ---
-      Metadata from the Minut API.
+      Metadata from Minut.
     `),
 })
-    .describe('Extended periods of noise or noise exceeding a threshold was detected.');
+    .describe('Extended periods of noise or noise exceeding a [threshold](https://docs.seam.co/latest/capability-guides/noise-sensors#what-is-a-threshold) were detected.');
 export const lock_locked_event = device_event
     .extend({
     event_type: z.literal('lock.locked'),
-    access_code_id: z.string().uuid().optional(),
-    action_attempt_id: z.string().uuid().optional(),
-    method: lock_method,
+    access_code_id: z
+        .string()
+        .uuid()
+        .optional()
+        .describe('ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) that was used to lock the device.'),
+    action_attempt_id: z
+        .string()
+        .uuid()
+        .optional()
+        .describe('ID of the [action attempt](https://docs.seam.co/latest/core-concepts/action-attempts) associated with the lock action.'),
+    method: lock_method.describe('Method by which a lock device was locked. When the method is `keycode`, the `access_code_id` indicates the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) that was used, if reported by the device.'),
 })
     .describe('A lock was locked.');
 export const lock_unlocked_event = device_event
     .extend({
     event_type: z.literal('lock.unlocked'),
-    access_code_id: z.string().uuid().optional(),
-    action_attempt_id: z.string().uuid().optional(),
-    method: lock_method,
+    access_code_id: z
+        .string()
+        .uuid()
+        .optional()
+        .describe('ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) that was used to unlock the device.'),
+    action_attempt_id: z
+        .string()
+        .uuid()
+        .optional()
+        .describe('ID of the [action attempt](https://docs.seam.co/latest/core-concepts/action-attempts) associated with the unlock action.'),
+    method: lock_method.describe('Method by which a lock device was unlocked. When the method is `keycode`, the `access_code_id` indicates the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) that was used, if reported by the device.'),
 })
     .describe('A lock was unlocked.');
 export const lock_access_denied_event = device_event
     .extend({
     event_type: z.literal('lock.access_denied'),
-    access_code_id: z.string().uuid().optional(),
+    access_code_id: z
+        .string()
+        .uuid()
+        .optional()
+        .describe('ID of the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) that was used in the unlock attempts.'),
 })
     .describe('The lock denied access to a user after one or more consecutive invalid attempts to unlock the device.');
 export const thermostat_climate_preset_activated_event = device_event
     .extend({
     event_type: z.literal('thermostat.climate_preset_activated'),
-    thermostat_schedule_id: z.string().uuid().nullable(),
-    climate_preset_key: z.string(),
-    is_fallback_climate_preset: z.boolean(),
+    thermostat_schedule_id: z
+        .string()
+        .uuid()
+        .nullable()
+        .describe('ID of the [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules) that prompted the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to be activated.'),
+    climate_preset_key: z
+        .string()
+        .describe('Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) that was activated.'),
+    is_fallback_climate_preset: z
+        .boolean()
+        .describe('Indicates whether the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) that was activated is the [fallback climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets/setting-the-fallback-climate-preset) for the thermostat.'),
 })
-    .describe('A thermostat climate preset was activated.');
-export const thermostat_manually_adjusted_method = z.enum(['seam', 'external']);
+    .describe('A thermostat [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) was activated.');
+export const thermostat_manually_adjusted_method = z
+    .enum(['seam', 'external'])
+    .describe('Method used to adjust the thermostat manually. `seam` indicates that the Seam API, Seam CLI, or Seam Console was used to adjust the thermostat.');
 export const thermostat_manually_adjusted_event = device_event
     .extend({
     event_type: z.literal('thermostat.manually_adjusted'),
@@ -231,29 +246,61 @@ export const thermostat_manually_adjusted_event = device_event
     cooling_set_point_fahrenheit: true,
     heating_set_point_fahrenheit: true,
 }))
-    .describe('A thermostat was manually adjusted.');
+    .describe('A thermostat was adjusted manually.');
 export const temperature_threshold_exceeded_event = device_event
     .extend({
     event_type: z.literal('thermostat.temperature_threshold_exceeded'),
-    temperature_celsius: z.number(),
-    temperature_fahrenheit: z.number(),
-    upper_limit_celsius: z.number().nullable(),
-    upper_limit_fahrenheit: z.number().nullable(),
-    lower_limit_celsius: z.number().nullable(),
-    lower_limit_fahrenheit: z.number().nullable(),
+    temperature_celsius: z
+        .number()
+        .describe('Temperature, in °C, reported by the thermostat.'),
+    temperature_fahrenheit: z
+        .number()
+        .describe('Temperature, in °F, reported by the thermostat.'),
+    upper_limit_celsius: z
+        .number()
+        .nullable()
+        .describe('Upper temperature limit, in °C, defined by the set [threshold](https://docs.seam.co/latest/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds).'),
+    upper_limit_fahrenheit: z
+        .number()
+        .nullable()
+        .describe('Upper temperature limit, in °F, defined by the set [threshold](https://docs.seam.co/latest/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds).'),
+    lower_limit_celsius: z
+        .number()
+        .nullable()
+        .describe('Lower temperature limit, in °C, defined by the set [threshold](https://docs.seam.co/latest/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds).'),
+    lower_limit_fahrenheit: z
+        .number()
+        .nullable()
+        .describe('Lower temperature limit, in °F, defined by the set [threshold](https://docs.seam.co/latest/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds).'),
 })
-    .describe("A thermostat's temperature reading exceeded the set threshold.");
+    .describe("A thermostat's temperature reading exceeded the set [threshold](https://docs.seam.co/latest/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds).");
 export const temperature_threshold_no_longer_exceeded_event = device_event
     .extend({
     event_type: z.literal('thermostat.temperature_threshold_no_longer_exceeded'),
-    temperature_celsius: z.number(),
-    temperature_fahrenheit: z.number(),
-    upper_limit_celsius: z.number().nullable(),
-    upper_limit_fahrenheit: z.number().nullable(),
-    lower_limit_celsius: z.number().nullable(),
-    lower_limit_fahrenheit: z.number().nullable(),
+    temperature_celsius: z
+        .number()
+        .describe('Temperature, in °C, reported by the thermostat.'),
+    temperature_fahrenheit: z
+        .number()
+        .describe('Temperature, in °F, reported by the thermostat.'),
+    upper_limit_celsius: z
+        .number()
+        .nullable()
+        .describe('Upper temperature limit, in °C, defined by the set [threshold](https://docs.seam.co/latest/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds).'),
+    upper_limit_fahrenheit: z
+        .number()
+        .nullable()
+        .describe('Upper temperature limit, in °F, defined by the set [threshold](https://docs.seam.co/latest/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds).'),
+    lower_limit_celsius: z
+        .number()
+        .nullable()
+        .describe('Lower temperature limit, in °C, defined by the set [threshold](https://docs.seam.co/latest/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds).'),
+    lower_limit_fahrenheit: z
+        .number()
+        .nullable()
+        .describe('Lower temperature limit, in °F, defined by the set [threshold](https://docs.seam.co/latest/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds).'),
 })
-    .describe("A thermostat's temperature reading is no longer exceeding the set threshold.");
+    .describe("A thermostat's temperature reading no longer exceeds the set [threshold](https://docs.seam.co/latest/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds).");
 export const device_events = [
     device_connected_event,
     device_added_event,