@seamapi/types 1.186.0 → 1.187.0

package/dist/connect.cjs

@@ -11,6 +11,11 @@ var __export = (target, all) => {
 // src/lib/seam/connect/schemas.ts
 var schemas_exports = {};
 __export(schemas_exports, {
+  acs_access_group: () => acs_access_group,
+  acs_credential: () => acs_credential,
+  acs_entrance: () => acs_entrance,
+  acs_system: () => acs_system,
+  acs_user: () => acs_user,
   action_attempt: () => action_attempt,
   client_session: () => client_session,
   connect_webview: () => connect_webview,
@@ -21,6 +26,180 @@ __export(schemas_exports, {
   webhook: () => webhook,
   workspace: () => workspace
 });
+var acs_access_group_external_type = zod.z.enum([
+  "pti_unit",
+  "pti_access_level",
+  "salto_access_group",
+  "brivo_group"
+]);
+var acs_access_group = zod.z.object({
+  acs_access_group_id: zod.z.string().uuid(),
+  acs_system_id: zod.z.string().uuid(),
+  workspace_id: zod.z.string().uuid(),
+  name: zod.z.string(),
+  access_group_type: acs_access_group_external_type.describe(`
+    ---
+    deprecated: use external_type
+    ---
+  `),
+  access_group_type_display_name: zod.z.string().describe(`
+    ---
+    deprecated: use external_type_display_name
+    ---
+    `),
+  display_name: zod.z.string(),
+  external_type: acs_access_group_external_type,
+  external_type_display_name: zod.z.string(),
+  created_at: zod.z.string().datetime()
+});
+var acs_entrance_latch_metadata = zod.z.object({
+  accessibility_type: zod.z.string(),
+  door_name: zod.z.string(),
+  door_type: zod.z.string(),
+  is_connected: zod.z.boolean()
+});
+var acs_entrance_visionline_metadata = zod.z.object({
+  door_name: zod.z.string(),
+  door_category: zod.z.enum([
+    "entrance",
+    "guest",
+    "elevator reader",
+    "common",
+    "common (PMS)"
+  ]),
+  profiles: zod.z.array(
+    zod.z.object({
+      visionline_door_profile_id: zod.z.string(),
+      visionline_door_profile_type: zod.z.enum(["BLE", "commonDoor", "touch"])
+    })
+  ).optional()
+});
+var acs_credential_visionline_metadata = zod.z.object({
+  card_function_type: zod.z.enum(["guest", "staff"]),
+  joiner_acs_credential_ids: zod.z.array(zod.z.string().uuid()).optional(),
+  guest_acs_entrance_ids: zod.z.array(zod.z.string().uuid()).optional(),
+  common_acs_entrance_ids: zod.z.array(zod.z.string().uuid()).optional()
+});
+
+// src/lib/seam/connect/models/acs/acs-credential.ts
+var acs_credential_external_type = zod.z.enum([
+  "pti_card",
+  "brivo_credential",
+  "hid_credential",
+  "visionline_card"
+]);
+var acs_credential_access_method_type = zod.z.enum([
+  "code",
+  "card",
+  "mobile_key"
+]);
+var acs_credential = zod.z.object({
+  acs_credential_id: zod.z.string().uuid(),
+  acs_user_id: zod.z.string().uuid().optional(),
+  acs_credential_pool_id: zod.z.string().uuid().optional(),
+  acs_system_id: zod.z.string().uuid(),
+  parent_acs_credential_id: zod.z.string().uuid().optional(),
+  display_name: zod.z.string().min(1),
+  code: zod.z.string().optional().nullable(),
+  access_method: acs_credential_access_method_type,
+  external_type: acs_credential_external_type.optional(),
+  external_type_display_name: zod.z.string().optional(),
+  created_at: zod.z.string().datetime(),
+  workspace_id: zod.z.string().uuid(),
+  starts_at: zod.z.string().optional(),
+  ends_at: zod.z.string().optional(),
+  errors: zod.z.array(
+    zod.z.object({
+      error_code: zod.z.string(),
+      message: zod.z.string()
+    })
+  ),
+  warnings: zod.z.array(
+    zod.z.object({
+      warning_code: zod.z.string(),
+      message: zod.z.string()
+    })
+  ),
+  is_multi_phone_sync_credential: zod.z.boolean().optional(),
+  is_latest_desired_state_synced_with_provider: zod.z.boolean().optional(),
+  latest_desired_state_synced_with_provider_at: zod.z.string().datetime().optional(),
+  visionline_metadata: acs_credential_visionline_metadata.optional()
+});
+var acs_entrance = zod.z.object({
+  acs_system_id: zod.z.string().uuid(),
+  acs_entrance_id: zod.z.string().uuid(),
+  created_at: zod.z.string().datetime(),
+  display_name: zod.z.string(),
+  errors: zod.z.array(
+    zod.z.object({
+      error_code: zod.z.string(),
+      message: zod.z.string()
+    })
+  ),
+  latch_metadata: acs_entrance_latch_metadata.optional(),
+  visionline_metadata: acs_entrance_visionline_metadata.optional()
+});
+var acs_system_capability_flags = zod.z.object({
+  can_automate_enrollment: zod.z.boolean().optional(),
+  can_create_acs_access_groups: zod.z.boolean().optional(),
+  can_remove_acs_users_from_acs_access_groups: zod.z.boolean().optional(),
+  can_add_acs_users_to_acs_access_groups: zod.z.boolean().optional()
+});
+var acs_system_external_type = zod.z.enum([
+  "pti_site",
+  "alta_org",
+  "salto_site",
+  "brivo_account",
+  "hid_credential_manager_organization",
+  "visionline_system",
+  "assa_abloy_credential_service",
+  "latch_building"
+]);
+var common_acs_system_error = zod.z.object({
+  created_at: zod.z.string().datetime(),
+  message: zod.z.string()
+});
+var seam_bridge_disconnected = common_acs_system_error.extend({
+  error_code: zod.z.literal("seam_bridge_disconnected")
+});
+var visionline_instance_unreachable = common_acs_system_error.extend({
+  error_code: zod.z.literal("visionline_instance_unreachable")
+});
+var acs_system_error = zod.z.union([
+  seam_bridge_disconnected,
+  visionline_instance_unreachable
+]);
+zod.z.object({
+  seam_bridge_disconnected: seam_bridge_disconnected.optional().nullable(),
+  visionline_instance_unreachable: visionline_instance_unreachable.optional().nullable()
+});
+var acs_system_warning = zod.z.object({});
+zod.z.object({});
+var acs_system = zod.z.object({
+  acs_system_id: zod.z.string().uuid(),
+  external_type: acs_system_external_type.optional(),
+  external_type_display_name: zod.z.string().optional(),
+  system_type: acs_system_external_type.describe(
+    `
+      ---
+      deprecated: use external_type
+      ---
+      `
+  ).optional(),
+  system_type_display_name: zod.z.string().optional().describe(`
+      ---
+      deprecated: use external_type_display_name
+      ---
+      `),
+  name: zod.z.string(),
+  created_at: zod.z.string().datetime(),
+  workspace_id: zod.z.string().uuid(),
+  connected_account_ids: zod.z.array(zod.z.string().uuid()),
+  image_url: zod.z.string(),
+  image_alt_text: zod.z.string(),
+  errors: zod.z.array(acs_system_error),
+  warnings: zod.z.array(acs_system_warning)
+}).merge(acs_system_capability_flags);
 var phone_number = zod.z.coerce.string().trim().refine(
   (val) => {
     return /^\+[1-9]\d{1,14}$/.test(val);
@@ -29,6 +208,46 @@ var phone_number = zod.z.coerce.string().trim().refine(
     message: "Phone number must be in E.164 format: +14155552671"
   }
 );
+var start_end_schedule = zod.z.object({
+  starts_at: zod.z.string().datetime(),
+  ends_at: zod.z.string().datetime()
+});
+var schedule = start_end_schedule;
+
+// src/lib/seam/connect/models/acs/acs-user.ts
+var acs_user_external_type = zod.z.enum([
+  "pti_user",
+  "brivo_user",
+  "hid_credential_manager_user",
+  "salto_site_user",
+  "latch_user"
+]);
+var user_fields = zod.z.object({
+  full_name: zod.z.string().optional(),
+  email: zod.z.string().email().optional().describe(`
+    ---
+    deprecated: use email_address.
+    ---
+    `),
+  email_address: zod.z.string().email().optional(),
+  phone_number: phone_number.optional()
+});
+var acs_user = zod.z.object({
+  acs_user_id: zod.z.string().uuid(),
+  acs_system_id: zod.z.string().uuid(),
+  hid_acs_system_id: zod.z.string().uuid().optional(),
+  workspace_id: zod.z.string().uuid(),
+  created_at: zod.z.string().datetime(),
+  display_name: zod.z.string(),
+  external_type: acs_user_external_type.optional(),
+  external_type_display_name: zod.z.string().optional(),
+  is_suspended: zod.z.boolean(),
+  access_schedule: schedule.optional(),
+  user_identity_id: zod.z.string().optional(),
+  user_identity_full_name: zod.z.string().nullable().optional(),
+  user_identity_email_address: zod.z.string().nullable().optional(),
+  user_identity_phone_number: zod.z.string().nullable().optional()
+}).merge(user_fields);
 var common_action_attempt = zod.z.object({
   action_attempt_id: zod.z.string().uuid().describe(`
     ---
@@ -1197,7 +1416,6 @@ var openapi_default = {
             type: "array"
           },
           latch_metadata: {
-            nullable: true,
             properties: {
               accessibility_type: { type: "string" },
               door_name: { type: "string" },
@@ -1213,7 +1431,6 @@ var openapi_default = {
             type: "object"
           },
           visionline_metadata: {
-            nullable: true,
             properties: {
               door_category: {
                 enum: [
@@ -1249,13 +1466,11 @@ var openapi_default = {
           }
         },
         required: [
-          "acs_entrance_id",
-          "display_name",
           "acs_system_id",
+          "acs_entrance_id",
           "created_at",
-          "latch_metadata",
-          "errors",
-          "visionline_metadata"
+          "display_name",
+          "errors"
         ],
         type: "object"
       },
@@ -1266,7 +1481,10 @@ var openapi_default = {
           can_automate_enrollment: { type: "boolean" },
           can_create_acs_access_groups: { type: "boolean" },
           can_remove_acs_users_from_acs_access_groups: { type: "boolean" },
-          connected_account_ids: { items: { type: "string" }, type: "array" },
+          connected_account_ids: {
+            items: { format: "uuid", type: "string" },
+            type: "array"
+          },
           created_at: { format: "date-time", type: "string" },
           errors: {
             items: {
@@ -2633,6 +2851,8 @@ var openapi_default = {
           can_program_online_access_codes: { type: "boolean" },
           can_remotely_lock: { type: "boolean" },
           can_remotely_unlock: { type: "boolean" },
+          can_simulate_connection: { type: "boolean" },
+          can_simulate_disconnection: { type: "boolean" },
           can_simulate_removal: { type: "boolean" },
           capabilities_supported: {
             description: 'Collection of capabilities that the device supports when connected to Seam. Values are "access_code," which indicates that the device can manage and utilize digital PIN codes for secure access; "lock," which indicates that the device controls a door locking mechanism, enabling the remote opening and closing of doors and other entry points; "noise_detection," which indicates that the device supports monitoring and responding to ambient noise levels; "thermostat," which indicates that the device can regulate and adjust indoor temperatures; and "battery," which indicates that the device can manage battery life and health.',
@@ -4025,6 +4245,8 @@ var openapi_default = {
           can_program_online_access_codes: { type: "boolean" },
           can_remotely_lock: { type: "boolean" },
           can_remotely_unlock: { type: "boolean" },
+          can_simulate_connection: { type: "boolean" },
+          can_simulate_disconnection: { type: "boolean" },
           can_simulate_removal: { type: "boolean" },
           capabilities_supported: {
             description: 'Collection of capabilities that the device supports when connected to Seam. Values are "access_code," which indicates that the device can manage and utilize digital PIN codes for secure access; "lock," which indicates that the device controls a door locking mechanism, enabling the remote opening and closing of doors and other entry points; "noise_detection," which indicates that the device supports monitoring and responding to ambient noise levels; "thermostat," which indicates that the device can regulate and adjust indoor temperatures; and "battery," which indicates that the device can manage battery life and health.',
@@ -4237,6 +4459,8 @@ var openapi_default = {
           can_program_online_access_codes: { type: "boolean" },
           can_remotely_lock: { type: "boolean" },
           can_remotely_unlock: { type: "boolean" },
+          can_simulate_connection: { type: "boolean" },
+          can_simulate_disconnection: { type: "boolean" },
           can_simulate_removal: { type: "boolean" },
           capabilities_supported: {
             description: 'Collection of capabilities that the device supports when connected to Seam. Values are "access_code," which indicates that the device can manage and utilize digital PIN codes for secure access; "lock," which indicates that the device controls a door locking mechanism, enabling the remote opening and closing of doors and other entry points; "noise_detection," which indicates that the device supports monitoring and responding to ambient noise levels; "thermostat," which indicates that the device can regulate and adjust indoor temperatures; and "battery," which indicates that the device can manage battery life and health.',
@@ -9051,7 +9275,9 @@ var openapi_default = {
                         "can_remotely_lock",
                         "can_program_offline_access_codes",
                         "can_program_online_access_codes",
-                        "can_simulate_removal"
+                        "can_simulate_removal",
+                        "can_simulate_connection",
+                        "can_simulate_disconnection"
                       ],
                       type: "string"
                     },
@@ -9064,7 +9290,9 @@ var openapi_default = {
                         "can_remotely_lock",
                         "can_program_offline_access_codes",
                         "can_program_online_access_codes",
-                        "can_simulate_removal"
+                        "can_simulate_removal",
+                        "can_simulate_connection",
+                        "can_simulate_disconnection"
                       ],
                       type: "string"
                     },
@@ -9211,6 +9439,88 @@ var openapi_default = {
         "x-fern-sdk-return-value": "device_providers"
       }
     },
+    "/devices/simulate/connect": {
+      post: {
+        operationId: "devicesSimulateConnectPost",
+        requestBody: {
+          content: {
+            "application/json": {
+              schema: {
+                properties: { device_id: { format: "uuid", type: "string" } },
+                required: ["device_id"],
+                type: "object"
+              }
+            }
+          }
+        },
+        responses: {
+          200: {
+            content: {
+              "application/json": {
+                schema: {
+                  properties: { ok: { type: "boolean" } },
+                  required: ["ok"],
+                  type: "object"
+                }
+              }
+            },
+            description: "OK"
+          },
+          400: { description: "Bad Request" },
+          401: { description: "Unauthorized" }
+        },
+        security: [
+          { api_key: [] },
+          { pat_with_workspace: [] },
+          { console_session: [] }
+        ],
+        summary: "/devices/simulate/connect",
+        tags: ["/devices"],
+        "x-fern-sdk-group-name": ["devices", "simulate"],
+        "x-fern-sdk-method-name": "connect"
+      }
+    },
+    "/devices/simulate/disconnect": {
+      post: {
+        operationId: "devicesSimulateDisconnectPost",
+        requestBody: {
+          content: {
+            "application/json": {
+              schema: {
+                properties: { device_id: { format: "uuid", type: "string" } },
+                required: ["device_id"],
+                type: "object"
+              }
+            }
+          }
+        },
+        responses: {
+          200: {
+            content: {
+              "application/json": {
+                schema: {
+                  properties: { ok: { type: "boolean" } },
+                  required: ["ok"],
+                  type: "object"
+                }
+              }
+            },
+            description: "OK"
+          },
+          400: { description: "Bad Request" },
+          401: { description: "Unauthorized" }
+        },
+        security: [
+          { api_key: [] },
+          { pat_with_workspace: [] },
+          { console_session: [] }
+        ],
+        summary: "/devices/simulate/disconnect",
+        tags: ["/devices"],
+        "x-fern-sdk-group-name": ["devices", "simulate"],
+        "x-fern-sdk-method-name": "disconnect"
+      }
+    },
     "/devices/simulate/remove": {
       post: {
         operationId: "devicesSimulateRemovePost",
@@ -9442,7 +9752,9 @@ var openapi_default = {
                         "can_remotely_lock",
                         "can_program_offline_access_codes",
                         "can_program_online_access_codes",
-                        "can_simulate_removal"
+                        "can_simulate_removal",
+                        "can_simulate_connection",
+                        "can_simulate_disconnection"
                       ],
                       type: "string"
                     },
@@ -9455,7 +9767,9 @@ var openapi_default = {
                         "can_remotely_lock",
                         "can_program_offline_access_codes",
                         "can_program_online_access_codes",
-                        "can_simulate_removal"
+                        "can_simulate_removal",
+                        "can_simulate_connection",
+                        "can_simulate_disconnection"
                       ],
                       type: "string"
                     },
@@ -10187,7 +10501,9 @@ var openapi_default = {
                         "can_remotely_lock",
                         "can_program_offline_access_codes",
                         "can_program_online_access_codes",
-                        "can_simulate_removal"
+                        "can_simulate_removal",
+                        "can_simulate_connection",
+                        "can_simulate_disconnection"
                       ],
                       type: "string"
                     },
@@ -10200,7 +10516,9 @@ var openapi_default = {
                         "can_remotely_lock",
                         "can_program_offline_access_codes",
                         "can_program_online_access_codes",
-                        "can_simulate_removal"
+                        "can_simulate_removal",
+                        "can_simulate_connection",
+                        "can_simulate_disconnection"
                       ],
                       type: "string"
                     },
@@ -11890,7 +12208,9 @@ var openapi_default = {
                         "can_remotely_lock",
                         "can_program_offline_access_codes",
                         "can_program_online_access_codes",
-                        "can_simulate_removal"
+                        "can_simulate_removal",
+                        "can_simulate_connection",
+                        "can_simulate_disconnection"
                       ],
                       type: "string"
                     },
@@ -11903,7 +12223,9 @@ var openapi_default = {
                         "can_remotely_lock",
                         "can_program_offline_access_codes",
                         "can_program_online_access_codes",
-                        "can_simulate_removal"
+                        "can_simulate_removal",
+                        "can_simulate_connection",
+                        "can_simulate_disconnection"
                       ],
                       type: "string"
                     },