@seamapi/types 1.163.0 → 1.164.0

package/dist/connect.cjs

@@ -1,6 +1,26 @@
 'use strict';
 
-var zod = require('zod');
+var z10 = require('zod');
+
+function _interopNamespace(e) {
+  if (e && e.__esModule) return e;
+  var n = Object.create(null);
+  if (e) {
+    Object.keys(e).forEach(function (k) {
+      if (k !== 'default') {
+        var d = Object.getOwnPropertyDescriptor(e, k);
+        Object.defineProperty(n, k, d.get ? d : {
+          enumerable: true,
+          get: function () { return e[k]; }
+        });
+      }
+    });
+  }
+  n.default = e;
+  return Object.freeze(n);
+}
+
+var z10__namespace = /*#__PURE__*/_interopNamespace(z10);
 
 var __defProp = Object.defineProperty;
 var __export = (target, all) => {
@@ -12,59 +32,518 @@ var __export = (target, all) => {
 var schemas_exports = {};
 __export(schemas_exports, {
   connect_webview: () => connect_webview,
-  custom_metadata: () => custom_metadata
+  custom_metadata: () => custom_metadata,
+  seam_event: () => seam_event
 });
-zod.z.record(
-  zod.z.string().max(40),
-  zod.z.union([zod.z.string().max(500), zod.z.boolean(), zod.z.null()])
+z10.z.record(
+  z10.z.string().max(40),
+  z10.z.union([z10.z.string().max(500), z10.z.boolean(), z10.z.null()])
 ).refine((val) => Object.keys(val).length <= 50, {
   message: "Custom metadata is limited to a maximum of 50 keys"
 });
-var custom_metadata = zod.z.record(
-  zod.z.string(),
-  zod.z.union([zod.z.string(), zod.z.boolean()])
+var custom_metadata = z10.z.record(
+  z10.z.string(),
+  z10.z.union([z10.z.string(), z10.z.boolean()])
 );
 
 // src/lib/seam/connect/models/connect-webviews/connect-webview.ts
-var connect_webview_device_selection_mode = zod.z.enum([
+var connect_webview_device_selection_mode = z10.z.enum([
   "none",
   "single",
   "multiple"
 ]);
-var connect_webview = zod.z.object({
-  connect_webview_id: zod.z.string().uuid(),
-  workspace_id: zod.z.string().uuid(),
-  created_at: zod.z.string().datetime(),
-  connected_account_id: zod.z.string().uuid().nullable(),
-  url: zod.z.string().url(),
+var connect_webview = z10.z.object({
+  connect_webview_id: z10.z.string().uuid(),
+  workspace_id: z10.z.string().uuid(),
+  created_at: z10.z.string().datetime(),
+  connected_account_id: z10.z.string().uuid().nullable(),
+  url: z10.z.string().url(),
   device_selection_mode: connect_webview_device_selection_mode,
   // TODO: Use enum value.
-  accepted_providers: zod.z.array(zod.z.string()),
-  accepted_devices: zod.z.array(zod.z.string()).describe(
+  accepted_providers: z10.z.array(z10.z.string()),
+  accepted_devices: z10.z.array(z10.z.string()).describe(
     `
       ---
       deprecated: Unused. Will be removed.
       ---
       `
   ),
-  any_device_allowed: zod.z.boolean().describe(
+  any_device_allowed: z10.z.boolean().describe(
     `
       ---
       deprecated: Unused. Will be removed.
       ---
       `
   ),
-  any_provider_allowed: zod.z.boolean(),
-  login_successful: zod.z.boolean(),
-  status: zod.z.enum(["pending", "failed", "authorized"]),
-  custom_redirect_url: zod.z.string().url().nullable(),
-  custom_redirect_failure_url: zod.z.string().url().nullable(),
+  any_provider_allowed: z10.z.boolean(),
+  login_successful: z10.z.boolean(),
+  status: z10.z.enum(["pending", "failed", "authorized"]),
+  custom_redirect_url: z10.z.string().url().nullable(),
+  custom_redirect_failure_url: z10.z.string().url().nullable(),
   custom_metadata,
-  automatically_manage_new_devices: zod.z.boolean(),
-  wait_for_device_creation: zod.z.boolean(),
-  authorized_at: zod.z.string().datetime().nullable(),
-  selected_provider: zod.z.string().nullable()
+  automatically_manage_new_devices: z10.z.boolean(),
+  wait_for_device_creation: z10.z.boolean(),
+  authorized_at: z10.z.string().datetime().nullable(),
+  selected_provider: z10.z.string().nullable()
+});
+var common_event = z10__namespace.object({
+  workspace_id: z10__namespace.string().uuid().describe(`
+    ---
+    title: Workspace ID
+    ---
+    The ID of the workspace.
+  `),
+  created_at: z10__namespace.string().datetime().describe(`
+    ---
+    title: Created At
+    ---
+    The time when the event was created.
+  `),
+  occurred_at: z10__namespace.string().datetime().describe(`
+    ---
+    title: Occurred At
+    ---
+    The time when the event occurred.
+  `)
+});
+
+// src/lib/seam/connect/models/events/access-codes.ts
+var access_code_event = common_event.extend({
+  access_code_id: z10__namespace.string().uuid().describe(`
+    ---
+    title: Access Code ID
+    ---
+    The ID of the access code.
+  `),
+  device_id: z10__namespace.string().uuid().describe(`
+    ---
+    title: Device ID
+    ---
+    The ID of the device.
+  `),
+  connected_account_id: z10__namespace.string().uuid().describe(`
+    ---
+    title: Connected Account ID
+    ---
+    The ID of the connected account.
+  `)
+});
+var code = z10__namespace.string().describe(`
+  ---
+  title: Access Code
+  ---
+  The code of the access code.
+`);
+var access_code_created_event = access_code_event.extend({
+  event_type: z10__namespace.literal("access_code.created")
+}).describe("An access code was created.");
+var access_code_changed_event = access_code_event.extend({
+  event_type: z10__namespace.literal("access_code.changed")
+}).describe("An access code was changed.");
+var access_code_scheduled_on_device_event = access_code_event.extend({
+  event_type: z10__namespace.literal("access_code.scheduled_on_device"),
+  code
+}).describe("An access code was natively scheduled on a device.");
+var access_code_set_on_device_event = access_code_event.extend({
+  event_type: z10__namespace.literal("access_code.set_on_device"),
+  code
+}).describe("An access code was set on a device.");
+var access_code_removed_from_device_event = access_code_event.extend({
+  event_type: z10__namespace.literal("access_code.removed_from_device")
+}).describe("An access code was removed from a device.");
+var access_code_delay_in_setting_on_device_event = access_code_event.extend({
+  event_type: z10__namespace.literal("access_code.delay_in_setting_on_device")
+}).describe(
+  "There was an unusually long delay in setting an access code on a device."
+);
+var access_code_failed_to_set_on_device_event = access_code_event.extend({
+  event_type: z10__namespace.literal("access_code.failed_to_set_on_device")
+}).describe("An access code failed to be set on a device.");
+var access_code_deleted_event = access_code_event.extend({
+  event_type: z10__namespace.literal("access_code.deleted"),
+  code: code.nullable()
+}).describe("An access code was deleted.");
+var access_code_delay_in_removing_from_device_event = access_code_event.extend({
+  event_type: z10__namespace.literal("access_code.delay_in_removing_from_device")
+}).describe(
+  "There was an unusually long delay in removing an access code from a device."
+);
+var access_code_failed_to_remove_from_device_event = access_code_event.extend({
+  event_type: z10__namespace.literal("access_code.failed_to_remove_from_device")
+}).describe("An access code failed to be removed from a device.");
+var access_code_modified_external_to_seam_event = access_code_event.extend({
+  event_type: z10__namespace.literal("access_code.modified_external_to_seam")
+}).describe("An access code was modified external to Seam.");
+var access_code_deleted_external_to_seam_event = access_code_event.extend({
+  event_type: z10__namespace.literal("access_code.deleted_external_to_seam")
+}).describe("An access code was deleted external to Seam.");
+var access_code_backup_access_code_pulled_event = access_code_event.extend({
+  event_type: z10__namespace.literal("access_code.backup_access_code_pulled"),
+  backup_access_code_id: z10__namespace.string()
+}).describe(
+  "A backup access code was pulled from the backup access code pool and set on a device."
+);
+var unmanaged_access_code_converted_to_managed_event = access_code_event.extend({
+  event_type: z10__namespace.literal("access_code.unmanaged.converted_to_managed")
+}).describe(
+  "An unmanaged access code was successfully converted to a managed access code."
+);
+var unmanaged_access_code_failed_to_convert_to_managed_event = access_code_event.extend({
+  event_type: z10__namespace.literal(
+    "access_code.unmanaged.failed_to_convert_to_managed"
+  )
+}).describe(
+  "An unmanaged access code failed to be converted to a managed access code."
+);
+var unmanaged_access_code_created_event = access_code_event.extend({
+  event_type: z10__namespace.literal("access_code.unmanaged.created")
+}).describe("An unmanaged access code was created on a device.");
+var unmanaged_access_code_removed_event = access_code_event.extend({
+  event_type: z10__namespace.literal("access_code.unmanaged.removed")
+}).describe("An unmanaged access code was removed from a device.");
+var access_code_events = [
+  access_code_created_event,
+  access_code_changed_event,
+  access_code_scheduled_on_device_event,
+  access_code_set_on_device_event,
+  access_code_removed_from_device_event,
+  access_code_delay_in_setting_on_device_event,
+  access_code_failed_to_set_on_device_event,
+  access_code_deleted_event,
+  access_code_delay_in_removing_from_device_event,
+  access_code_failed_to_remove_from_device_event,
+  access_code_modified_external_to_seam_event,
+  access_code_deleted_external_to_seam_event,
+  access_code_backup_access_code_pulled_event,
+  unmanaged_access_code_converted_to_managed_event,
+  unmanaged_access_code_failed_to_convert_to_managed_event,
+  unmanaged_access_code_created_event,
+  unmanaged_access_code_removed_event
+];
+var common_acs_event = common_event.extend({
+  connected_account_id: z10__namespace.string().uuid().describe(`
+    ---
+    title: Connected Account ID
+    ---
+    ID of the connected account.
+  `),
+  acs_system_id: z10__namespace.string().uuid().describe(`
+    ---
+    title: ACS System ID
+    ---
+    ID of the ACS system.
+  `)
+});
+
+// src/lib/seam/connect/models/events/acs/credentials.ts
+var acs_credential_event = common_acs_event.extend({
+  acs_credential_id: z10__namespace.string().uuid()
+});
+var acs_credential_deleted_event = acs_credential_event.extend({
+  event_type: z10__namespace.literal("acs_credential.deleted")
+}).describe("An ACS credential was deleted.");
+var acs_credential_events = [acs_credential_deleted_event];
+var acs_user_event = common_acs_event.extend({
+  acs_user_id: z10__namespace.string().uuid()
+});
+var acs_user_deleted_event = acs_user_event.extend({
+  event_type: z10__namespace.literal("acs_user.deleted")
+}).describe("An ACS user was deleted.");
+var acs_user_events = [acs_user_deleted_event];
+
+// src/lib/seam/connect/models/events/acs/index.ts
+var acs_events = [
+  ...acs_credential_events,
+  ...acs_user_events
+];
+var client_session_event = common_event.extend({
+  client_session_id: z10__namespace.string().uuid().describe(`
+    ---
+    title: Client Session ID
+    ---
+    ID of the client session.
+  `)
+});
+var client_session_deleted_event = client_session_event.extend({
+  event_type: z10__namespace.literal("client_session.deleted")
+}).describe("A client session was deleted.");
+var client_session_events = [client_session_deleted_event];
+var connected_account_event = common_event.extend({
+  connected_account_id: z10__namespace.string().uuid().describe(`
+    ---
+    title: Connected Account ID
+    ---
+    ID of the connected account.
+  `)
+});
+var connect_webview_id = z10__namespace.string().uuid().describe(`
+  ---
+  title: Connect Webview ID
+  ---
+  ID of the connect webview.
+`);
+var connected_account_connected_event = connected_account_event.extend({
+  event_type: z10__namespace.literal("connected_account.connected"),
+  connect_webview_id
+}).describe(
+  "A connected account was connected for the first time, was reconnected after being disconnected."
+);
+var connected_account_created_event = connected_account_event.extend({
+  event_type: z10__namespace.literal("connected_account.created"),
+  connect_webview_id
+}).describe("A connected account was created.");
+var connected_account_successful_login_event = connected_account_event.extend({
+  event_type: z10__namespace.literal("connected_account.successful_login"),
+  connect_webview_id
+}).describe("A connected account had a successful connect webview login.");
+var connected_account_disconnected_event = connected_account_event.extend({
+  event_type: z10__namespace.literal("connected_account.disconnected")
+}).describe("A connected account was disconnected.");
+var connected_account_completed_first_sync_event = connected_account_event.extend({
+  event_type: z10__namespace.literal("connected_account.completed_first_sync")
+}).describe(
+  "A connected account completed the first sync with Seam and devices are now available."
+);
+var connected_account_deleted_event = connected_account_event.extend({
+  event_type: z10__namespace.literal("connected_account.deleted")
+}).describe("A connected account was deleted.");
+var connected_account_completed_first_sync_after_reconnection_event = connected_account_event.extend({
+  event_type: z10__namespace.literal(
+    "connected_account.completed_first_sync_after_reconnection"
+  )
+}).describe(
+  "A connected account completed the first sync after reconnection with Seam and devices are now available."
+);
+var connected_account_events = [
+  connected_account_connected_event,
+  connected_account_created_event,
+  connected_account_successful_login_event,
+  connected_account_disconnected_event,
+  connected_account_completed_first_sync_event,
+  connected_account_deleted_event,
+  connected_account_completed_first_sync_after_reconnection_event
+];
+var device_event = common_event.extend({
+  device_id: z10__namespace.string().uuid().describe(`
+    ---
+    title: Device ID
+    ---
+    ID of the device.
+  `),
+  connected_account_id: z10__namespace.string().uuid().describe(`
+    ---
+    title: Connected Account ID
+    ---
+    ID of the connected account.
+  `)
 });
+var battery_level = z10__namespace.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.
+`);
+var device_battery_status = z10__namespace.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'
+`);
+var disconnection_error_code = z10__namespace.enum([
+  "account_disconnected",
+  "hub_disconnected",
+  "device_disconnected"
+]).describe(`
+  ---
+  title: Event Error Code
+  ---
+  The error code associated with the event, if any.
+`);
+var lock_method = z10__namespace.enum(["keycode", "manual", "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.
+`);
+var device_connected_event = device_event.extend({
+  event_type: z10__namespace.literal("device.connected")
+}).describe("A new device was connected to Seam.");
+var device_converted_to_unmanaged_event = device_event.extend({
+  event_type: z10__namespace.literal("device.converted_to_unmanaged")
+}).describe(
+  "An unmanaged device was successfully converted to a managed device."
+);
+var unmanaged_device_converted_to_managed_event = device_event.extend({
+  event_type: z10__namespace.literal("device.unmanaged.converted_to_managed")
+}).describe(
+  "A managed device was successfully converted to an unmanaged device."
+);
+var unmanaged_device_connected_event = device_event.extend({
+  event_type: z10__namespace.literal("device.unmanaged.connected")
+}).describe("An unmanaged device was connected to Seam");
+var device_disconnected_event = device_event.extend({
+  event_type: z10__namespace.literal("device.disconnected"),
+  error_code: disconnection_error_code
+}).describe("A device was disconnected");
+var unmanaged_device_disconnected_event = device_event.extend({
+  event_type: z10__namespace.literal("device.unmanaged.disconnected"),
+  error_code: disconnection_error_code
+}).describe("An unmanaged device was disconnected");
+var device_tampered_event = device_event.extend({
+  event_type: z10__namespace.literal("device.tampered")
+}).describe(
+  "A device detected that it was tampered with, e.g., opened or moved."
+);
+var device_low_battery_event = device_event.extend({
+  event_type: z10__namespace.literal("device.low_battery"),
+  battery_level
+}).describe("A device battery level dropped below the low threshold.");
+var device_battery_status_changed_event = device_event.extend({
+  event_type: z10__namespace.literal("device.battery_status_changed"),
+  battery_status: device_battery_status,
+  battery_level
+}).describe(
+  "A device battery status changed since the last battery status changed event."
+);
+var device_removed_event = device_event.extend({
+  event_type: z10__namespace.literal("device.removed")
+}).describe("A device was removed externally from the connected account.");
+var device_deleted_event = device_event.extend({
+  event_type: z10__namespace.literal("device.deleted")
+}).describe("A device was deleted.");
+var device_third_party_integration_detected_event = device_event.extend({
+  event_type: z10__namespace.literal("device.third_party_integration_detected")
+}).describe(
+  "Seam detected a device is using a third party integration that will interfere with Seam device management."
+);
+var device_third_party_integration_no_longer_detected_event = device_event.extend({
+  event_type: z10__namespace.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."
+);
+var device_salto_privacy_mode_activated_event = device_event.extend({
+  event_type: z10__namespace.literal("device.salto.privacy_mode_activated")
+}).describe("A Salto device activated privacy mode.");
+var device_salto_privacy_mode_deactivated_event = device_event.extend({
+  event_type: z10__namespace.literal("device.salto.privacy_mode_deactivated")
+}).describe("A Salto device deactivated privacy mode.");
+var device_connection_became_flaky_event = device_event.extend({
+  event_type: z10__namespace.literal("device.connection_became_flaky")
+}).describe("Seam detected a flaky device connection.");
+var device_connection_stabilized_event = device_event.extend({
+  event_type: z10__namespace.literal("device.connection_stabilized")
+}).describe("Seam detected a previously flaky device connection stabilized.");
+var device_error_subscription_required_event = device_event.extend({
+  event_type: z10__namespace.literal("device.error.subscription_required")
+}).describe(
+  "A third party subscription is required to use all device features."
+);
+var device_error_subscription_required_resolved_event = device_event.extend({
+  event_type: z10__namespace.literal("device.error.subscription_required.resolved")
+}).describe(
+  "A third party subscription is active or no longer-required to use all device features."
+);
+var device_accessory_keypad_connected_event = device_event.extend({
+  event_type: z10__namespace.literal("device.accessory_keypad_connected")
+}).describe("A accessory keypad was connected to a device.");
+var device_accessory_keypad_disconnected_event = device_event.extend({
+  event_type: z10__namespace.literal("device.accessory_keypad_disconnected")
+}).describe("A accessory keypad was disconnected to a device.");
+var noise_sensor_noise_threshold_triggered_event = device_event.extend({
+  event_type: z10__namespace.literal("noise_sensor.noise_threshold_triggered"),
+  // TODO: import from ../devices
+  noiseaware_metadata: z10__namespace.record(z10__namespace.unknown()).optional().describe(`
+      ---
+      title: Noiseaware Metadata
+      ---
+      Metadata from the Noiseaware API.
+    `),
+  minut_metadata: z10__namespace.record(z10__namespace.unknown()).optional().describe(`
+      ---
+      title: Minut Metadata
+      ---
+      Metadata from the Minut API.
+    `)
+}).describe(
+  "Extended periods of noise or noise exceeding a threshold was detected."
+);
+var lock_locked_event = device_event.extend({
+  event_type: z10__namespace.literal("lock.locked"),
+  access_code_id: z10__namespace.string().uuid().optional(),
+  action_attempt_id: z10__namespace.string().uuid().optional(),
+  method: lock_method
+}).describe("A lock was locked.");
+var lock_unlocked_event = device_event.extend({
+  event_type: z10__namespace.literal("lock.unlocked"),
+  access_code_id: z10__namespace.string().uuid().optional(),
+  action_attempt_id: z10__namespace.string().uuid().optional(),
+  method: lock_method
+}).describe("A lock was unlocked.");
+var device_events = [
+  device_connected_event,
+  device_converted_to_unmanaged_event,
+  unmanaged_device_converted_to_managed_event,
+  unmanaged_device_connected_event,
+  device_disconnected_event,
+  unmanaged_device_disconnected_event,
+  device_tampered_event,
+  device_low_battery_event,
+  device_battery_status_changed_event,
+  device_removed_event,
+  device_deleted_event,
+  device_third_party_integration_detected_event,
+  device_third_party_integration_no_longer_detected_event,
+  device_salto_privacy_mode_activated_event,
+  device_salto_privacy_mode_deactivated_event,
+  device_connection_became_flaky_event,
+  device_connection_stabilized_event,
+  device_error_subscription_required_event,
+  device_error_subscription_required_resolved_event,
+  device_accessory_keypad_connected_event,
+  device_accessory_keypad_disconnected_event,
+  noise_sensor_noise_threshold_triggered_event,
+  lock_locked_event,
+  lock_unlocked_event
+];
+var enrollment_automation_event = common_event.extend({
+  enrollment_automation_id: z10__namespace.string().uuid().describe(`
+    ---
+    title: Enrollment Automation ID
+    ---
+    ID of the enrollment automation.
+  `)
+});
+var enrollment_automation_deleted_event = enrollment_automation_event.extend({
+  event_type: z10__namespace.literal("enrollment_automation.deleted")
+}).describe("An enrollment automation was deleted.");
+var enrollment_automation_events = [
+  enrollment_automation_deleted_event
+];
+var phone_event = common_event.extend({
+  device_id: z10__namespace.string().uuid().describe(`
+    ---
+    title: Device ID
+    ---
+    ID of the device.
+  `)
+});
+var phone_deactivated_event = phone_event.extend({
+  event_type: z10__namespace.literal("phone.deactivated")
+}).describe("A phone device was deactivated.");
+var phone_events = [phone_deactivated_event];
+
+// src/lib/seam/connect/models/events/seam-event.ts
+var seam_event = z10__namespace.discriminatedUnion("event_type", [
+  ...access_code_events,
+  ...acs_events,
+  ...client_session_events,
+  ...connected_account_events,
+  ...device_events,
+  ...enrollment_automation_events,
+  ...phone_events
+]);
 
 // src/lib/seam/connect/openapi.ts
 var openapi_default = {
@@ -7865,6 +8344,8 @@ var openapi_default = {
                       "device.connection_stabilized",
                       "device.error.subscription_required",
                       "device.error.subscription_required.resolved",
+                      "device.accessory_keypad_connected",
+                      "device.accessory_keypad_disconnected",
                       "access_code.created",
                       "access_code.changed",
                       "access_code.scheduled_on_device",
@@ -7922,6 +8403,8 @@ var openapi_default = {
                         "device.connection_stabilized",
                         "device.error.subscription_required",
                         "device.error.subscription_required.resolved",
+                        "device.accessory_keypad_connected",
+                        "device.accessory_keypad_disconnected",
                         "access_code.created",
                         "access_code.changed",
                         "access_code.scheduled_on_device",