@seamapi/types 1.377.0 → 1.378.0

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

@@ -8391,15 +8391,11 @@ export interface Routes {
                     created_at: 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;
                     };
                 } | {
@@ -10880,6 +10876,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';
@@ -12840,15 +12884,11 @@ export interface Routes {
                     created_at: 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;
                     };
                 } | {
@@ -13024,15 +13064,11 @@ export interface Routes {
                     created_at: 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;
                     };
                 } | {
@@ -13204,15 +13240,11 @@ export interface Routes {
                     created_at: 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;
                     };
                 } | {
@@ -13493,15 +13525,11 @@ export interface Routes {
                     created_at: 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;
                     };
                 } | {
@@ -13663,15 +13691,11 @@ export interface Routes {
                     created_at: 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;
                     };
                 } | {
@@ -30505,15 +30529,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 +30573,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 +30617,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;
@@ -42088,15 +42112,11 @@ export interface Routes {
                     created_at: 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;
                     };
                 } | {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@seamapi/types",
-  "version": "1.377.0",
+  "version": "1.378.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,7 +1,6 @@
 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(),
@@ -28,10 +27,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 +71,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")

package/src/lib/seam/connect/openapi.ts

@@ -2995,16 +2995,13 @@ export default {
                     from: {
                       properties: {
                         ends_at: {
-                          description:
-                            "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.",
                           format: 'date-time',
                           nullable: true,
                           type: 'string',
                         },
                         starts_at: {
-                          description:
-                            "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.",
                           format: 'date-time',
+                          nullable: true,
                           type: 'string',
                         },
                       },
@@ -3018,16 +3015,13 @@ export default {
                     to: {
                       properties: {
                         ends_at: {
-                          description:
-                            "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.",
                           format: 'date-time',
                           nullable: true,
                           type: 'string',
                         },
                         starts_at: {
-                          description:
-                            "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.",
                           format: 'date-time',
+                          nullable: true,
                           type: 'string',
                         },
                       },
@@ -16085,16 +16079,13 @@ export default {
                     from: {
                       properties: {
                         ends_at: {
-                          description:
-                            "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.",
                           format: 'date-time',
                           nullable: true,
                           type: 'string',
                         },
                         starts_at: {
-                          description:
-                            "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.",
                           format: 'date-time',
+                          nullable: true,
                           type: 'string',
                         },
                       },
@@ -16108,16 +16099,13 @@ export default {
                     to: {
                       properties: {
                         ends_at: {
-                          description:
-                            "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.",
                           format: 'date-time',
                           nullable: true,
                           type: 'string',
                         },
                         starts_at: {
-                          description:
-                            "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.",
                           format: 'date-time',
+                          nullable: true,
                           type: 'string',
                         },
                       },
@@ -20975,6 +20963,61 @@ export default {
         'x-title': 'Encode a Credential',
       },
     },
+    '/acs/encoders/get': {
+      post: {
+        description:
+          'Returns a specified [encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners).',
+        operationId: 'acsEncodersGetPost',
+        requestBody: {
+          content: {
+            'application/json': {
+              schema: {
+                properties: {
+                  acs_encoder_id: {
+                    description: 'ID of the desired encoder.',
+                    format: 'uuid',
+                    type: 'string',
+                  },
+                },
+                required: ['acs_encoder_id'],
+                type: 'object',
+              },
+            },
+          },
+        },
+        responses: {
+          200: {
+            content: {
+              'application/json': {
+                schema: {
+                  properties: {
+                    acs_encoder: { $ref: '#/components/schemas/acs_encoder' },
+                    ok: { type: 'boolean' },
+                  },
+                  required: ['acs_encoder', 'ok'],
+                  type: 'object',
+                },
+              },
+            },
+            description: 'OK',
+          },
+          400: { description: 'Bad Request' },
+          401: { description: 'Unauthorized' },
+        },
+        security: [
+          { pat_with_workspace: [] },
+          { console_session_with_workspace: [] },
+          { api_key: [] },
+        ],
+        summary: '/acs/encoders/get',
+        tags: ['/acs'],
+        'x-fern-sdk-group-name': ['acs', 'encoders'],
+        'x-fern-sdk-method-name': 'get',
+        'x-fern-sdk-return-value': 'acs_encoder',
+        'x-response-key': 'acs_encoder',
+        'x-title': 'Get an Encoder',
+      },
+    },
     '/acs/encoders/list': {
       post: {
         description:
@@ -27075,11 +27118,13 @@ export default {
                                   can_tailscale_proxy_reach_bridge: {
                                     description:
                                       'Tailscale proxy cannot reach the bridge',
+                                    nullable: true,
                                     type: 'boolean',
                                   },
                                   can_tailscale_proxy_reach_tailscale_network: {
                                     description:
                                       'Tailscale proxy cannot reach the Tailscale network',
+                                    nullable: true,
                                     type: 'boolean',
                                   },
                                   created_at: {
@@ -27095,16 +27140,19 @@ export default {
                                   is_bridge_socks_server_healthy: {
                                     description:
                                       "Bridge's SOCKS server is unhealthy",
+                                    nullable: true,
                                     type: 'boolean',
                                   },
                                   is_tailscale_proxy_reachable: {
                                     description:
                                       'Seam cannot reach the tailscale proxy',
+                                    nullable: true,
                                     type: 'boolean',
                                   },
                                   is_tailscale_proxy_socks_server_healthy: {
                                     description:
                                       "Tailscale proxy's SOCKS server is unhealthy",
+                                    nullable: true,
                                     type: 'boolean',
                                   },
                                   message: { type: 'string' },
@@ -27242,11 +27290,13 @@ export default {
                                   can_tailscale_proxy_reach_bridge: {
                                     description:
                                       'Tailscale proxy cannot reach the bridge',
+                                    nullable: true,
                                     type: 'boolean',
                                   },
                                   can_tailscale_proxy_reach_tailscale_network: {
                                     description:
                                       'Tailscale proxy cannot reach the Tailscale network',
+                                    nullable: true,
                                     type: 'boolean',
                                   },
                                   created_at: {
@@ -27262,16 +27312,19 @@ export default {
                                   is_bridge_socks_server_healthy: {
                                     description:
                                       "Bridge's SOCKS server is unhealthy",
+                                    nullable: true,
                                     type: 'boolean',
                                   },
                                   is_tailscale_proxy_reachable: {
                                     description:
                                       'Seam cannot reach the tailscale proxy',
+                                    nullable: true,
                                     type: 'boolean',
                                   },
                                   is_tailscale_proxy_socks_server_healthy: {
                                     description:
                                       "Tailscale proxy's SOCKS server is unhealthy",
+                                    nullable: true,
                                     type: 'boolean',
                                   },
                                   message: { type: 'string' },
@@ -27400,11 +27453,13 @@ export default {
                                   can_tailscale_proxy_reach_bridge: {
                                     description:
                                       'Tailscale proxy cannot reach the bridge',
+                                    nullable: true,
                                     type: 'boolean',
                                   },
                                   can_tailscale_proxy_reach_tailscale_network: {
                                     description:
                                       'Tailscale proxy cannot reach the Tailscale network',
+                                    nullable: true,
                                     type: 'boolean',
                                   },
                                   created_at: {
@@ -27420,16 +27475,19 @@ export default {
                                   is_bridge_socks_server_healthy: {
                                     description:
                                       "Bridge's SOCKS server is unhealthy",
+                                    nullable: true,
                                     type: 'boolean',
                                   },
                                   is_tailscale_proxy_reachable: {
                                     description:
                                       'Seam cannot reach the tailscale proxy',
+                                    nullable: true,
                                     type: 'boolean',
                                   },
                                   is_tailscale_proxy_socks_server_healthy: {
                                     description:
                                       "Tailscale proxy's SOCKS server is unhealthy",
+                                    nullable: true,
                                     type: 'boolean',
                                   },
                                   message: { type: 'string' },
@@ -27568,11 +27626,13 @@ export default {
                                   can_tailscale_proxy_reach_bridge: {
                                     description:
                                       'Tailscale proxy cannot reach the bridge',
+                                    nullable: true,
                                     type: 'boolean',
                                   },
                                   can_tailscale_proxy_reach_tailscale_network: {
                                     description:
                                       'Tailscale proxy cannot reach the Tailscale network',
+                                    nullable: true,
                                     type: 'boolean',
                                   },
                                   created_at: {
@@ -27588,16 +27648,19 @@ export default {
                                   is_bridge_socks_server_healthy: {
                                     description:
                                       "Bridge's SOCKS server is unhealthy",
+                                    nullable: true,
                                     type: 'boolean',
                                   },
                                   is_tailscale_proxy_reachable: {
                                     description:
                                       'Seam cannot reach the tailscale proxy',
+                                    nullable: true,
                                     type: 'boolean',
                                   },
                                   is_tailscale_proxy_socks_server_healthy: {
                                     description:
                                       "Tailscale proxy's SOCKS server is unhealthy",
+                                    nullable: true,
                                     type: 'boolean',
                                   },
                                   message: { type: 'string' },