@seamapi/types 1.377.0 → 1.379.0

package/lib/seam/connect/route-types.d.ts

@@ -8370,12 +8370,15 @@ export interface Routes {
                 /**  */
                 pending_mutations?: Array<{
                     created_at: string;
+                    message: string;
                     mutation_code: 'creating';
                 } | {
                     created_at: string;
+                    message: string;
                     mutation_code: 'deleting';
                 } | {
                     created_at: string;
+                    message: string;
                     mutation_code: 'updating_user_information';
                     from: {
                         email_address?: (string | null) | undefined;
@@ -8389,21 +8392,19 @@ export interface Routes {
                     };
                 } | {
                     created_at: string;
+                    message: string;
                     mutation_code: 'updating_access_schedule';
                     from: {
-                        /** Date and time at which the user's access starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
-                        starts_at: string;
-                        /** Date and time at which the user's access ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
+                        starts_at: string | null;
                         ends_at: string | null;
                     };
                     to: {
-                        /** Date and time at which the user's access starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
-                        starts_at: string;
-                        /** Date and time at which the user's access ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
+                        starts_at: string | null;
                         ends_at: string | null;
                     };
                 } | {
                     created_at: string;
+                    message: string;
                     mutation_code: 'updating_suspension_state';
                     from: {
                         is_suspended: boolean;
@@ -8413,6 +8414,7 @@ export interface Routes {
                     };
                 } | {
                     created_at: string;
+                    message: string;
                     mutation_code: 'updating_group_membership';
                     from: {
                         acs_access_group_id: string | null;
@@ -10880,6 +10882,54 @@ export interface Routes {
             };
         };
     };
+    '/acs/encoders/get': {
+        route: '/acs/encoders/get';
+        method: 'GET' | 'POST';
+        queryParams: {};
+        jsonBody: {};
+        commonParams: {
+            /** ID of the desired encoder. */
+            acs_encoder_id: string;
+        };
+        formData: {};
+        jsonResponse: {
+            /** Represents a hardware device that encodes [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) data onto physical cards within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems).
+          
+          Some access control systems require credentials to be encoded onto plastic key cards using a card encoder. This process involves the following two key steps:
+          
+          1. Credential creation
+             Configure the access parameters for the credential.
+          2. Card encoding
+             Write the credential data onto the card using a compatible card encoder.
+          
+          Separately, the Seam API also supports card scanning, which enables you to scan and read the encoded data on a card. You can use this action to confirm consistency with access control system records or diagnose discrepancies if needed.
+          
+           See [Working with Card Encoders and Scanners](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners).
+          
+          To verify if your access control system requires a card encoder, see the corresponding [system integration guide](https://docs.seam.co/latest/device-and-system-integration-guides/overview#access-control-systems). */
+            acs_encoder: {
+                /** ID of the [encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners. */
+                acs_encoder_id: string;
+                /** ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners). */
+                acs_system_id: string;
+                /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the [encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners). */
+                workspace_id: string;
+                /** Errors associated with the [encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners). */
+                errors: Array<{
+                    /** Date and time at which Seam created the error. */
+                    created_at: string;
+                    /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
+                    message: string;
+                    /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
+                    error_code: 'acs_encoder_removed';
+                }>;
+                /** Date and time at which the [encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners) was created. */
+                created_at: string;
+                /** Display name for the [encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners). */
+                display_name: string;
+            };
+        };
+    };
     '/acs/encoders/list': {
         route: '/acs/encoders/list';
         method: 'GET' | 'POST';
@@ -12819,12 +12869,15 @@ export interface Routes {
                 /**  */
                 pending_mutations?: Array<{
                     created_at: string;
+                    message: string;
                     mutation_code: 'creating';
                 } | {
                     created_at: string;
+                    message: string;
                     mutation_code: 'deleting';
                 } | {
                     created_at: string;
+                    message: string;
                     mutation_code: 'updating_user_information';
                     from: {
                         email_address?: (string | null) | undefined;
@@ -12838,21 +12891,19 @@ export interface Routes {
                     };
                 } | {
                     created_at: string;
+                    message: string;
                     mutation_code: 'updating_access_schedule';
                     from: {
-                        /** Date and time at which the user's access starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
-                        starts_at: string;
-                        /** Date and time at which the user's access ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
+                        starts_at: string | null;
                         ends_at: string | null;
                     };
                     to: {
-                        /** Date and time at which the user's access starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
-                        starts_at: string;
-                        /** Date and time at which the user's access ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
+                        starts_at: string | null;
                         ends_at: string | null;
                     };
                 } | {
                     created_at: string;
+                    message: string;
                     mutation_code: 'updating_suspension_state';
                     from: {
                         is_suspended: boolean;
@@ -12862,6 +12913,7 @@ export interface Routes {
                     };
                 } | {
                     created_at: string;
+                    message: string;
                     mutation_code: 'updating_group_membership';
                     from: {
                         acs_access_group_id: string | null;
@@ -13003,12 +13055,15 @@ export interface Routes {
                 /**  */
                 pending_mutations?: Array<{
                     created_at: string;
+                    message: string;
                     mutation_code: 'creating';
                 } | {
                     created_at: string;
+                    message: string;
                     mutation_code: 'deleting';
                 } | {
                     created_at: string;
+                    message: string;
                     mutation_code: 'updating_user_information';
                     from: {
                         email_address?: (string | null) | undefined;
@@ -13022,21 +13077,19 @@ export interface Routes {
                     };
                 } | {
                     created_at: string;
+                    message: string;
                     mutation_code: 'updating_access_schedule';
                     from: {
-                        /** Date and time at which the user's access starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
-                        starts_at: string;
-                        /** Date and time at which the user's access ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
+                        starts_at: string | null;
                         ends_at: string | null;
                     };
                     to: {
-                        /** Date and time at which the user's access starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
-                        starts_at: string;
-                        /** Date and time at which the user's access ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
+                        starts_at: string | null;
                         ends_at: string | null;
                     };
                 } | {
                     created_at: string;
+                    message: string;
                     mutation_code: 'updating_suspension_state';
                     from: {
                         is_suspended: boolean;
@@ -13046,6 +13099,7 @@ export interface Routes {
                     };
                 } | {
                     created_at: string;
+                    message: string;
                     mutation_code: 'updating_group_membership';
                     from: {
                         acs_access_group_id: string | null;
@@ -13183,12 +13237,15 @@ export interface Routes {
                 /**  */
                 pending_mutations?: Array<{
                     created_at: string;
+                    message: string;
                     mutation_code: 'creating';
                 } | {
                     created_at: string;
+                    message: string;
                     mutation_code: 'deleting';
                 } | {
                     created_at: string;
+                    message: string;
                     mutation_code: 'updating_user_information';
                     from: {
                         email_address?: (string | null) | undefined;
@@ -13202,21 +13259,19 @@ export interface Routes {
                     };
                 } | {
                     created_at: string;
+                    message: string;
                     mutation_code: 'updating_access_schedule';
                     from: {
-                        /** Date and time at which the user's access starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
-                        starts_at: string;
-                        /** Date and time at which the user's access ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
+                        starts_at: string | null;
                         ends_at: string | null;
                     };
                     to: {
-                        /** Date and time at which the user's access starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
-                        starts_at: string;
-                        /** Date and time at which the user's access ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
+                        starts_at: string | null;
                         ends_at: string | null;
                     };
                 } | {
                     created_at: string;
+                    message: string;
                     mutation_code: 'updating_suspension_state';
                     from: {
                         is_suspended: boolean;
@@ -13226,6 +13281,7 @@ export interface Routes {
                     };
                 } | {
                     created_at: string;
+                    message: string;
                     mutation_code: 'updating_group_membership';
                     from: {
                         acs_access_group_id: string | null;
@@ -13472,12 +13528,15 @@ export interface Routes {
                 /**  */
                 pending_mutations?: Array<{
                     created_at: string;
+                    message: string;
                     mutation_code: 'creating';
                 } | {
                     created_at: string;
+                    message: string;
                     mutation_code: 'deleting';
                 } | {
                     created_at: string;
+                    message: string;
                     mutation_code: 'updating_user_information';
                     from: {
                         email_address?: (string | null) | undefined;
@@ -13491,21 +13550,19 @@ export interface Routes {
                     };
                 } | {
                     created_at: string;
+                    message: string;
                     mutation_code: 'updating_access_schedule';
                     from: {
-                        /** Date and time at which the user's access starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
-                        starts_at: string;
-                        /** Date and time at which the user's access ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
+                        starts_at: string | null;
                         ends_at: string | null;
                     };
                     to: {
-                        /** Date and time at which the user's access starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
-                        starts_at: string;
-                        /** Date and time at which the user's access ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
+                        starts_at: string | null;
                         ends_at: string | null;
                     };
                 } | {
                     created_at: string;
+                    message: string;
                     mutation_code: 'updating_suspension_state';
                     from: {
                         is_suspended: boolean;
@@ -13515,6 +13572,7 @@ export interface Routes {
                     };
                 } | {
                     created_at: string;
+                    message: string;
                     mutation_code: 'updating_group_membership';
                     from: {
                         acs_access_group_id: string | null;
@@ -13642,12 +13700,15 @@ export interface Routes {
                 /**  */
                 pending_mutations?: Array<{
                     created_at: string;
+                    message: string;
                     mutation_code: 'creating';
                 } | {
                     created_at: string;
+                    message: string;
                     mutation_code: 'deleting';
                 } | {
                     created_at: string;
+                    message: string;
                     mutation_code: 'updating_user_information';
                     from: {
                         email_address?: (string | null) | undefined;
@@ -13661,21 +13722,19 @@ export interface Routes {
                     };
                 } | {
                     created_at: string;
+                    message: string;
                     mutation_code: 'updating_access_schedule';
                     from: {
-                        /** Date and time at which the user's access starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
-                        starts_at: string;
-                        /** Date and time at which the user's access ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
+                        starts_at: string | null;
                         ends_at: string | null;
                     };
                     to: {
-                        /** Date and time at which the user's access starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
-                        starts_at: string;
-                        /** Date and time at which the user's access ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
+                        starts_at: string | null;
                         ends_at: string | null;
                     };
                 } | {
                     created_at: string;
+                    message: string;
                     mutation_code: 'updating_suspension_state';
                     from: {
                         is_suspended: boolean;
@@ -13685,6 +13744,7 @@ export interface Routes {
                     };
                 } | {
                     created_at: string;
+                    message: string;
                     mutation_code: 'updating_group_membership';
                     from: {
                         acs_access_group_id: string | null;
@@ -30505,15 +30565,15 @@ export interface Routes {
                     /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
                     error_code: 'bridge_lan_unreachable';
                     /** Seam cannot reach the tailscale proxy */
-                    is_tailscale_proxy_reachable: boolean;
+                    is_tailscale_proxy_reachable: boolean | null;
                     /** Tailscale proxy's SOCKS server is unhealthy */
-                    is_tailscale_proxy_socks_server_healthy: boolean;
+                    is_tailscale_proxy_socks_server_healthy: boolean | null;
                     /** Tailscale proxy cannot reach the Tailscale network */
-                    can_tailscale_proxy_reach_tailscale_network: boolean;
+                    can_tailscale_proxy_reach_tailscale_network: boolean | null;
                     /** Tailscale proxy cannot reach the bridge */
-                    can_tailscale_proxy_reach_bridge: boolean;
+                    can_tailscale_proxy_reach_bridge: boolean | null;
                     /** Bridge's SOCKS server is unhealthy */
-                    is_bridge_socks_server_healthy: boolean;
+                    is_bridge_socks_server_healthy: boolean | null;
                 } | {
                     message: string;
                     created_at: string;
@@ -30549,15 +30609,15 @@ export interface Routes {
                     /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
                     error_code: 'bridge_lan_unreachable';
                     /** Seam cannot reach the tailscale proxy */
-                    is_tailscale_proxy_reachable: boolean;
+                    is_tailscale_proxy_reachable: boolean | null;
                     /** Tailscale proxy's SOCKS server is unhealthy */
-                    is_tailscale_proxy_socks_server_healthy: boolean;
+                    is_tailscale_proxy_socks_server_healthy: boolean | null;
                     /** Tailscale proxy cannot reach the Tailscale network */
-                    can_tailscale_proxy_reach_tailscale_network: boolean;
+                    can_tailscale_proxy_reach_tailscale_network: boolean | null;
                     /** Tailscale proxy cannot reach the bridge */
-                    can_tailscale_proxy_reach_bridge: boolean;
+                    can_tailscale_proxy_reach_bridge: boolean | null;
                     /** Bridge's SOCKS server is unhealthy */
-                    is_bridge_socks_server_healthy: boolean;
+                    is_bridge_socks_server_healthy: boolean | null;
                 } | {
                     message: string;
                     created_at: string;
@@ -30593,15 +30653,15 @@ export interface Routes {
                     /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
                     error_code: 'bridge_lan_unreachable';
                     /** Seam cannot reach the tailscale proxy */
-                    is_tailscale_proxy_reachable: boolean;
+                    is_tailscale_proxy_reachable: boolean | null;
                     /** Tailscale proxy's SOCKS server is unhealthy */
-                    is_tailscale_proxy_socks_server_healthy: boolean;
+                    is_tailscale_proxy_socks_server_healthy: boolean | null;
                     /** Tailscale proxy cannot reach the Tailscale network */
-                    can_tailscale_proxy_reach_tailscale_network: boolean;
+                    can_tailscale_proxy_reach_tailscale_network: boolean | null;
                     /** Tailscale proxy cannot reach the bridge */
-                    can_tailscale_proxy_reach_bridge: boolean;
+                    can_tailscale_proxy_reach_bridge: boolean | null;
                     /** Bridge's SOCKS server is unhealthy */
-                    is_bridge_socks_server_healthy: boolean;
+                    is_bridge_socks_server_healthy: boolean | null;
                 } | {
                     message: string;
                     created_at: string;
@@ -42067,12 +42127,15 @@ export interface Routes {
                 /**  */
                 pending_mutations?: Array<{
                     created_at: string;
+                    message: string;
                     mutation_code: 'creating';
                 } | {
                     created_at: string;
+                    message: string;
                     mutation_code: 'deleting';
                 } | {
                     created_at: string;
+                    message: string;
                     mutation_code: 'updating_user_information';
                     from: {
                         email_address?: (string | null) | undefined;
@@ -42086,21 +42149,19 @@ export interface Routes {
                     };
                 } | {
                     created_at: string;
+                    message: string;
                     mutation_code: 'updating_access_schedule';
                     from: {
-                        /** Date and time at which the user's access starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
-                        starts_at: string;
-                        /** Date and time at which the user's access ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
+                        starts_at: string | null;
                         ends_at: string | null;
                     };
                     to: {
-                        /** Date and time at which the user's access starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
-                        starts_at: string;
-                        /** Date and time at which the user's access ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
+                        starts_at: string | null;
                         ends_at: string | null;
                     };
                 } | {
                     created_at: string;
+                    message: string;
                     mutation_code: 'updating_suspension_state';
                     from: {
                         is_suspended: boolean;
@@ -42110,6 +42171,7 @@ export interface Routes {
                     };
                 } | {
                     created_at: string;
+                    message: string;
                     mutation_code: 'updating_group_membership';
                     from: {
                         acs_access_group_id: string | null;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@seamapi/types",
-  "version": "1.377.0",
+  "version": "1.379.0",
   "description": "TypeScript types for the Seam API.",
   "type": "module",
   "main": "index.js",

package/src/lib/seam/connect/models/acs/acs-users/pending-mutations.ts

@@ -1,10 +1,10 @@
 import { z } from 'zod'
 
 import { phone_number } from '../../phone-number.js'
-import { schedule } from '../../schedule.js'
 
 const common_pending_mutation = z.object({
   created_at: z.string().datetime(),
+  message: z.string(),
 })
 
 const creating = common_pending_mutation.extend({
@@ -28,10 +28,15 @@ export const updating_user_information_mutation =
     to: acs_user_info.partial(),
   })
 
+const access_schedule = z.object({
+  starts_at: z.string().datetime().nullable(),
+  ends_at: z.string().datetime().nullable(),
+})
+
 const updating_access_schedule_mutation = common_pending_mutation.extend({
   mutation_code: z.literal('updating_access_schedule'),
-  from: schedule,
-  to: schedule,
+  from: access_schedule,
+  to: access_schedule,
 })
 
 const updating_suspension_state_mutation = common_pending_mutation.extend({
@@ -67,6 +72,16 @@ export type AcsUserPendingMutation = z.infer<typeof acs_user_pending_mutations>
 export const acs_user_pending_mutations_map = z.object({
   creating: creating.optional().nullable(),
   deleting: deleting.optional().nullable(),
+  updating_access_schedule: updating_access_schedule_mutation
+    .optional()
+    .nullable(),
+  updating_group_membership: z
+    .map(z.string().uuid(), updating_group_membership_mutation)
+    .optional()
+    .nullable(),
+  updating_suspension_state: updating_suspension_state_mutation
+    .optional()
+    .nullable(),
   'updating_user_information.full_name': common_pending_mutation
     .extend({
       mutation_code: z.literal('updating_user_information'),

package/src/lib/seam/connect/models/bridges/bridge-client-session.ts

@@ -15,18 +15,23 @@ export const bridge_lan_unreachable = common_bridge_client_session_error
       .describe(error_code_description),
     is_tailscale_proxy_reachable: z
       .boolean()
+      .nullable()
       .describe('Seam cannot reach the tailscale proxy'),
     is_tailscale_proxy_socks_server_healthy: z
       .boolean()
+      .nullable()
       .describe("Tailscale proxy's SOCKS server is unhealthy"),
     can_tailscale_proxy_reach_tailscale_network: z
       .boolean()
+      .nullable()
       .describe('Tailscale proxy cannot reach the Tailscale network'),
     can_tailscale_proxy_reach_bridge: z
       .boolean()
+      .nullable()
       .describe('Tailscale proxy cannot reach the bridge'),
     is_bridge_socks_server_healthy: z
       .boolean()
+      .nullable()
       .describe("Bridge's SOCKS server is unhealthy"),
   })
   .describe("Seam cannot reach the bridge's LAN")