@seamapi/types 1.365.0 → 1.367.0

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

@@ -7026,6 +7026,54 @@ export interface Routes {
                     message: string;
                     error_code: 'failed_to_delete_on_acs_system';
                 }>;
+                /**  */
+                pending_modifications?: Array<{
+                    created_at: string;
+                    modification_code: 'profile';
+                    modified_from: {
+                        email_address?: (string | null) | undefined;
+                        full_name?: (string | null) | undefined;
+                        phone_number?: ((string | undefined) | null) | undefined;
+                    };
+                    modified_to: {
+                        email_address?: (string | null) | undefined;
+                        full_name?: (string | null) | undefined;
+                        phone_number?: ((string | undefined) | null) | undefined;
+                    };
+                } | {
+                    created_at: string;
+                    modification_code: 'access_schedule';
+                    modified_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. */
+                        ends_at: string | null;
+                    };
+                    modified_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. */
+                        ends_at: string | null;
+                    };
+                } | {
+                    created_at: string;
+                    modification_code: 'suspension_state';
+                    modified_from: {
+                        is_suspended: boolean;
+                    };
+                    modified_to: {
+                        is_suspended: boolean;
+                    };
+                } | {
+                    created_at: string;
+                    modification_code: 'acs_access_group_membership';
+                    modified_from: {
+                        acs_access_group_id: string | null;
+                    };
+                    modified_to: {
+                        acs_access_group_id: string | null;
+                    };
+                }> | undefined;
                 /** Full name of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). */
                 full_name?: string | undefined;
                 /**
@@ -11209,6 +11257,54 @@ export interface Routes {
                     message: string;
                     error_code: 'failed_to_delete_on_acs_system';
                 }>;
+                /**  */
+                pending_modifications?: Array<{
+                    created_at: string;
+                    modification_code: 'profile';
+                    modified_from: {
+                        email_address?: (string | null) | undefined;
+                        full_name?: (string | null) | undefined;
+                        phone_number?: ((string | undefined) | null) | undefined;
+                    };
+                    modified_to: {
+                        email_address?: (string | null) | undefined;
+                        full_name?: (string | null) | undefined;
+                        phone_number?: ((string | undefined) | null) | undefined;
+                    };
+                } | {
+                    created_at: string;
+                    modification_code: 'access_schedule';
+                    modified_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. */
+                        ends_at: string | null;
+                    };
+                    modified_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. */
+                        ends_at: string | null;
+                    };
+                } | {
+                    created_at: string;
+                    modification_code: 'suspension_state';
+                    modified_from: {
+                        is_suspended: boolean;
+                    };
+                    modified_to: {
+                        is_suspended: boolean;
+                    };
+                } | {
+                    created_at: string;
+                    modification_code: 'acs_access_group_membership';
+                    modified_from: {
+                        acs_access_group_id: string | null;
+                    };
+                    modified_to: {
+                        acs_access_group_id: string | null;
+                    };
+                }> | undefined;
                 /** Full name of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). */
                 full_name?: string | undefined;
                 /**
@@ -11335,6 +11431,54 @@ export interface Routes {
                     message: string;
                     error_code: 'failed_to_delete_on_acs_system';
                 }>;
+                /**  */
+                pending_modifications?: Array<{
+                    created_at: string;
+                    modification_code: 'profile';
+                    modified_from: {
+                        email_address?: (string | null) | undefined;
+                        full_name?: (string | null) | undefined;
+                        phone_number?: ((string | undefined) | null) | undefined;
+                    };
+                    modified_to: {
+                        email_address?: (string | null) | undefined;
+                        full_name?: (string | null) | undefined;
+                        phone_number?: ((string | undefined) | null) | undefined;
+                    };
+                } | {
+                    created_at: string;
+                    modification_code: 'access_schedule';
+                    modified_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. */
+                        ends_at: string | null;
+                    };
+                    modified_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. */
+                        ends_at: string | null;
+                    };
+                } | {
+                    created_at: string;
+                    modification_code: 'suspension_state';
+                    modified_from: {
+                        is_suspended: boolean;
+                    };
+                    modified_to: {
+                        is_suspended: boolean;
+                    };
+                } | {
+                    created_at: string;
+                    modification_code: 'acs_access_group_membership';
+                    modified_from: {
+                        acs_access_group_id: string | null;
+                    };
+                    modified_to: {
+                        acs_access_group_id: string | null;
+                    };
+                }> | undefined;
                 /** Full name of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). */
                 full_name?: string | undefined;
                 /**
@@ -11461,6 +11605,54 @@ export interface Routes {
                     message: string;
                     error_code: 'failed_to_delete_on_acs_system';
                 }>;
+                /**  */
+                pending_modifications?: Array<{
+                    created_at: string;
+                    modification_code: 'profile';
+                    modified_from: {
+                        email_address?: (string | null) | undefined;
+                        full_name?: (string | null) | undefined;
+                        phone_number?: ((string | undefined) | null) | undefined;
+                    };
+                    modified_to: {
+                        email_address?: (string | null) | undefined;
+                        full_name?: (string | null) | undefined;
+                        phone_number?: ((string | undefined) | null) | undefined;
+                    };
+                } | {
+                    created_at: string;
+                    modification_code: 'access_schedule';
+                    modified_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. */
+                        ends_at: string | null;
+                    };
+                    modified_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. */
+                        ends_at: string | null;
+                    };
+                } | {
+                    created_at: string;
+                    modification_code: 'suspension_state';
+                    modified_from: {
+                        is_suspended: boolean;
+                    };
+                    modified_to: {
+                        is_suspended: boolean;
+                    };
+                } | {
+                    created_at: string;
+                    modification_code: 'acs_access_group_membership';
+                    modified_from: {
+                        acs_access_group_id: string | null;
+                    };
+                    modified_to: {
+                        acs_access_group_id: string | null;
+                    };
+                }> | undefined;
                 /** Full name of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). */
                 full_name?: string | undefined;
                 /**
@@ -11696,6 +11888,54 @@ export interface Routes {
                     message: string;
                     error_code: 'failed_to_delete_on_acs_system';
                 }>;
+                /**  */
+                pending_modifications?: Array<{
+                    created_at: string;
+                    modification_code: 'profile';
+                    modified_from: {
+                        email_address?: (string | null) | undefined;
+                        full_name?: (string | null) | undefined;
+                        phone_number?: ((string | undefined) | null) | undefined;
+                    };
+                    modified_to: {
+                        email_address?: (string | null) | undefined;
+                        full_name?: (string | null) | undefined;
+                        phone_number?: ((string | undefined) | null) | undefined;
+                    };
+                } | {
+                    created_at: string;
+                    modification_code: 'access_schedule';
+                    modified_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. */
+                        ends_at: string | null;
+                    };
+                    modified_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. */
+                        ends_at: string | null;
+                    };
+                } | {
+                    created_at: string;
+                    modification_code: 'suspension_state';
+                    modified_from: {
+                        is_suspended: boolean;
+                    };
+                    modified_to: {
+                        is_suspended: boolean;
+                    };
+                } | {
+                    created_at: string;
+                    modification_code: 'acs_access_group_membership';
+                    modified_from: {
+                        acs_access_group_id: string | null;
+                    };
+                    modified_to: {
+                        acs_access_group_id: string | null;
+                    };
+                }> | undefined;
                 /** Full name of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). */
                 full_name?: string | undefined;
                 /**
@@ -11812,6 +12052,54 @@ export interface Routes {
                     message: string;
                     error_code: 'failed_to_delete_on_acs_system';
                 }>;
+                /**  */
+                pending_modifications?: Array<{
+                    created_at: string;
+                    modification_code: 'profile';
+                    modified_from: {
+                        email_address?: (string | null) | undefined;
+                        full_name?: (string | null) | undefined;
+                        phone_number?: ((string | undefined) | null) | undefined;
+                    };
+                    modified_to: {
+                        email_address?: (string | null) | undefined;
+                        full_name?: (string | null) | undefined;
+                        phone_number?: ((string | undefined) | null) | undefined;
+                    };
+                } | {
+                    created_at: string;
+                    modification_code: 'access_schedule';
+                    modified_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. */
+                        ends_at: string | null;
+                    };
+                    modified_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. */
+                        ends_at: string | null;
+                    };
+                } | {
+                    created_at: string;
+                    modification_code: 'suspension_state';
+                    modified_from: {
+                        is_suspended: boolean;
+                    };
+                    modified_to: {
+                        is_suspended: boolean;
+                    };
+                } | {
+                    created_at: string;
+                    modification_code: 'acs_access_group_membership';
+                    modified_from: {
+                        acs_access_group_id: string | null;
+                    };
+                    modified_to: {
+                        acs_access_group_id: string | null;
+                    };
+                }> | undefined;
                 /** Full name of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). */
                 full_name?: string | undefined;
                 /**
@@ -27883,6 +28171,27 @@ export interface Routes {
                 bridge_client_name: string;
                 bridge_client_time_zone: string;
                 bridge_client_machine_identifier_key: string;
+                errors: Array<{
+                    message: string;
+                    created_at: string;
+                    /** 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;
+                    /** Tailscale proxy's SOCKS server is unhealthy */
+                    is_tailscale_proxy_socks_server_healthy: boolean;
+                    /** Tailscale proxy cannot reach the Tailscale network */
+                    can_tailscale_proxy_reach_tailscale_network: boolean;
+                    /** Tailscale proxy cannot reach the bridge */
+                    can_tailscale_proxy_reach_bridge: boolean;
+                    /** Bridge's SOCKS server is unhealthy */
+                    is_bridge_socks_server_healthy: boolean;
+                } | {
+                    message: string;
+                    created_at: string;
+                    /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
+                    error_code: 'no_communication_from_bridge';
+                }>;
             };
         };
     };
@@ -27906,6 +28215,27 @@ export interface Routes {
                 bridge_client_name: string;
                 bridge_client_time_zone: string;
                 bridge_client_machine_identifier_key: string;
+                errors: Array<{
+                    message: string;
+                    created_at: string;
+                    /** 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;
+                    /** Tailscale proxy's SOCKS server is unhealthy */
+                    is_tailscale_proxy_socks_server_healthy: boolean;
+                    /** Tailscale proxy cannot reach the Tailscale network */
+                    can_tailscale_proxy_reach_tailscale_network: boolean;
+                    /** Tailscale proxy cannot reach the bridge */
+                    can_tailscale_proxy_reach_bridge: boolean;
+                    /** Bridge's SOCKS server is unhealthy */
+                    is_bridge_socks_server_healthy: boolean;
+                } | {
+                    message: string;
+                    created_at: string;
+                    /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
+                    error_code: 'no_communication_from_bridge';
+                }>;
             };
         };
     };
@@ -27929,6 +28259,27 @@ export interface Routes {
                 bridge_client_name: string;
                 bridge_client_time_zone: string;
                 bridge_client_machine_identifier_key: string;
+                errors: Array<{
+                    message: string;
+                    created_at: string;
+                    /** 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;
+                    /** Tailscale proxy's SOCKS server is unhealthy */
+                    is_tailscale_proxy_socks_server_healthy: boolean;
+                    /** Tailscale proxy cannot reach the Tailscale network */
+                    can_tailscale_proxy_reach_tailscale_network: boolean;
+                    /** Tailscale proxy cannot reach the bridge */
+                    can_tailscale_proxy_reach_bridge: boolean;
+                    /** Bridge's SOCKS server is unhealthy */
+                    is_bridge_socks_server_healthy: boolean;
+                } | {
+                    message: string;
+                    created_at: string;
+                    /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
+                    error_code: 'no_communication_from_bridge';
+                }>;
             };
         };
     };
@@ -38705,6 +39056,54 @@ export interface Routes {
                     message: string;
                     error_code: 'failed_to_delete_on_acs_system';
                 }>;
+                /**  */
+                pending_modifications?: Array<{
+                    created_at: string;
+                    modification_code: 'profile';
+                    modified_from: {
+                        email_address?: (string | null) | undefined;
+                        full_name?: (string | null) | undefined;
+                        phone_number?: ((string | undefined) | null) | undefined;
+                    };
+                    modified_to: {
+                        email_address?: (string | null) | undefined;
+                        full_name?: (string | null) | undefined;
+                        phone_number?: ((string | undefined) | null) | undefined;
+                    };
+                } | {
+                    created_at: string;
+                    modification_code: 'access_schedule';
+                    modified_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. */
+                        ends_at: string | null;
+                    };
+                    modified_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. */
+                        ends_at: string | null;
+                    };
+                } | {
+                    created_at: string;
+                    modification_code: 'suspension_state';
+                    modified_from: {
+                        is_suspended: boolean;
+                    };
+                    modified_to: {
+                        is_suspended: boolean;
+                    };
+                } | {
+                    created_at: string;
+                    modification_code: 'acs_access_group_membership';
+                    modified_from: {
+                        acs_access_group_id: string | null;
+                    };
+                    modified_to: {
+                        acs_access_group_id: string | null;
+                    };
+                }> | undefined;
                 /** Full name of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management). */
                 full_name?: string | undefined;
                 /**

package/package.json

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

package/src/lib/seam/connect/models/acs/{acs-user.ts → acs-users/acs-user.ts}

@@ -1,7 +1,8 @@
 import { z } from 'zod'
 
-import { phone_number } from '../phone-number.js'
-import { schedule } from '../schedule.js'
+import { phone_number } from '../../phone-number.js'
+import { schedule } from '../../schedule.js'
+import { acs_user_pending_modification } from './pending-modifications.js'
 
 export const acs_user_external_type = z.enum([
   'pti_user',
@@ -323,6 +324,12 @@ const common_acs_user = z
       .describe(
         'Errors associated with the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).',
       ),
+    pending_modifications: z.array(acs_user_pending_modification).optional()
+      .describe(`
+      ---
+      undocumented: Experimental.
+      ---
+      `),
   })
   .merge(user_fields)
 

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

@@ -0,0 +1,2 @@
+export * from './acs-user.js'
+export * from './pending-modifications.js'

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

@@ -0,0 +1,56 @@
+import { z } from 'zod'
+
+import { phone_number } from '../../phone-number.js'
+import { schedule } from '../../schedule.js'
+
+const common_pending_modification = z.object({
+  created_at: z.string().datetime(),
+})
+
+const acs_user_profile = z.object({
+  email_address: z.string().email().nullable(),
+  full_name: z.string().nullable(),
+  phone_number: phone_number.optional().nullable(),
+})
+
+const profile_pending_modification = common_pending_modification.extend({
+  modification_code: z.literal('profile'),
+  modified_from: acs_user_profile.partial(),
+  modified_to: acs_user_profile.partial(),
+})
+
+const access_schedule_pending_modification = common_pending_modification.extend(
+  {
+    modification_code: z.literal('access_schedule'),
+    modified_from: schedule,
+    modified_to: schedule,
+  },
+)
+
+const suspension_state_pending_modification =
+  common_pending_modification.extend({
+    modification_code: z.literal('suspension_state'),
+    modified_from: z.object({ is_suspended: z.boolean() }),
+    modified_to: z.object({ is_suspended: z.boolean() }),
+  })
+
+const acs_access_group_membership_pending_modification =
+  common_pending_modification.extend({
+    modification_code: z.literal('acs_access_group_membership'),
+    modified_from: z.object({
+      acs_access_group_id: z.string().uuid().nullable(),
+    }),
+    modified_to: z.object({
+      acs_access_group_id: z.string().uuid().nullable(),
+    }),
+  })
+
+export const acs_user_pending_modification = z.discriminatedUnion(
+  'modification_code',
+  [
+    profile_pending_modification,
+    access_schedule_pending_modification,
+    suspension_state_pending_modification,
+    acs_access_group_membership_pending_modification,
+  ],
+)

package/src/lib/seam/connect/models/acs/index.ts

@@ -5,5 +5,5 @@ export * from './acs-credential-provisioning-automation.js'
 export * from './acs-encoder.js'
 export * from './acs-entrance.js'
 export * from './acs-system.js'
-export * from './acs-user.js'
+export * from './acs-users/index.js'
 export * from './metadata/index.js'

package/src/lib/seam/connect/models/bridges/bridge_client_session.ts

@@ -1,5 +1,66 @@
 import { z } from 'zod'
 
+const common_bridge_client_session_error = z.object({
+  message: z.string(),
+  created_at: z.string().datetime(),
+})
+
+const error_code_description =
+  'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.'
+
+export const bridge_lan_unreachable = common_bridge_client_session_error
+  .extend({
+    error_code: z
+      .literal('bridge_lan_unreachable')
+      .describe(error_code_description),
+    is_tailscale_proxy_reachable: z
+      .boolean()
+      .describe('Seam cannot reach the tailscale proxy'),
+    is_tailscale_proxy_socks_server_healthy: z
+      .boolean()
+      .describe("Tailscale proxy's SOCKS server is unhealthy"),
+    can_tailscale_proxy_reach_tailscale_network: z
+      .boolean()
+      .describe('Tailscale proxy cannot reach the Tailscale network'),
+    can_tailscale_proxy_reach_bridge: z
+      .boolean()
+      .describe('Tailscale proxy cannot reach the bridge'),
+    is_bridge_socks_server_healthy: z
+      .boolean()
+      .describe("Bridge's SOCKS server is unhealthy"),
+  })
+  .describe("Seam cannot reach the bridge's LAN")
+
+export const no_communication_from_bridge = common_bridge_client_session_error
+  .extend({
+    error_code: z
+      .literal('no_communication_from_bridge')
+      .describe(error_code_description),
+  })
+  .describe('Bridge has stopped communicating with Seam')
+
+export const bridge_client_session_error = z
+  .discriminatedUnion('error_code', [
+    bridge_lan_unreachable,
+    no_communication_from_bridge,
+  ])
+  .describe('Error associated with the `bridge_client_session`.')
+
+export type BridgeClientSessionError = z.infer<
+  typeof bridge_client_session_error
+>
+
+const bridge_client_session_error_map = z.object({
+  bridge_lan_unreachable: bridge_lan_unreachable.optional().nullable(),
+  no_communication_from_bridge: no_communication_from_bridge
+    .optional()
+    .nullable(),
+})
+
+export type BridgeClientSessionErrorMap = z.infer<
+  typeof bridge_client_session_error_map
+>
+
 export const bridge_client_session = z.object({
   created_at: z.string().datetime(),
   bridge_client_session_id: z.string().uuid(),
@@ -11,6 +72,7 @@ export const bridge_client_session = z.object({
   bridge_client_name: z.string(),
   bridge_client_time_zone: z.string(),
   bridge_client_machine_identifier_key: z.string(),
+  errors: z.array(bridge_client_session_error),
 }).describe(`
   ---
   route_path: /seam/bridge/v1/bridge_client_sessions