@seamapi/types 1.793.0 → 1.794.0

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

@@ -1889,6 +1889,77 @@ export type Routes = {
                     /** Indicates whether the access code can be overridden. When false, the maximum number of overrides has been reached. */
                     is_overridable?: boolean | undefined;
                 } | null) | undefined;
+                /** Collection of pending mutations for the access code. Indicates changes that Seam is in the process of pushing to the device. */
+                pending_mutations: ({
+                    /** Date and time at which the mutation was created. */
+                    created_at: string;
+                    /** Detailed description of the mutation. */
+                    message: string;
+                    /** Mutation code to indicate that Seam is in the process of setting an access code on the device. */
+                    mutation_code: 'creating';
+                } | {
+                    /** Date and time at which the mutation was created. */
+                    created_at: string;
+                    /** Detailed description of the mutation. */
+                    message: string;
+                    /** Mutation code to indicate that Seam is in the process of removing an access code from the device. */
+                    mutation_code: 'deleting';
+                } | {
+                    /** Date and time at which the mutation was created. */
+                    created_at: string;
+                    /** Detailed description of the mutation. */
+                    message: string;
+                    /** Mutation code to indicate that Seam is in the process of pushing an updated PIN code to the device. */
+                    mutation_code: 'updating_code';
+                    /** Previous code configuration. */
+                    from: {
+                        /** Previous PIN code. */
+                        code: string | null;
+                    };
+                    /** New code configuration. */
+                    to: {
+                        /** New PIN code. */
+                        code: string | null;
+                    };
+                } | {
+                    /** Date and time at which the mutation was created. */
+                    created_at: string;
+                    /** Detailed description of the mutation. */
+                    message: string;
+                    /** Mutation code to indicate that Seam is in the process of pushing an updated access code name to the device. */
+                    mutation_code: 'updating_name';
+                    /** Previous name configuration. */
+                    from: {
+                        /** Previous access code name. */
+                        name: string | null;
+                    };
+                    /** New name configuration. */
+                    to: {
+                        /** New access code name. */
+                        name: string | null;
+                    };
+                } | {
+                    /** Date and time at which the mutation was created. */
+                    created_at: string;
+                    /** Detailed description of the mutation. */
+                    message: string;
+                    /** Mutation code to indicate that Seam is in the process of pushing updated access code time frame to the device. */
+                    mutation_code: 'updating_time_frame';
+                    /** Previous time frame configuration. */
+                    from: {
+                        /** Previous start time for the access code. */
+                        starts_at: string | null;
+                        /** Previous end time for the access code. */
+                        ends_at: string | null;
+                    };
+                    /** New time frame configuration. */
+                    to: {
+                        /** New start time for the access code. */
+                        starts_at: string | null;
+                        /** New end time for the access code. */
+                        ends_at: string | null;
+                    };
+                })[];
             };
         };
         maxDuration: undefined;
@@ -2437,6 +2508,77 @@ export type Routes = {
                     /** Indicates whether the access code can be overridden. When false, the maximum number of overrides has been reached. */
                     is_overridable?: boolean | undefined;
                 } | null) | undefined;
+                /** Collection of pending mutations for the access code. Indicates changes that Seam is in the process of pushing to the device. */
+                pending_mutations: ({
+                    /** Date and time at which the mutation was created. */
+                    created_at: string;
+                    /** Detailed description of the mutation. */
+                    message: string;
+                    /** Mutation code to indicate that Seam is in the process of setting an access code on the device. */
+                    mutation_code: 'creating';
+                } | {
+                    /** Date and time at which the mutation was created. */
+                    created_at: string;
+                    /** Detailed description of the mutation. */
+                    message: string;
+                    /** Mutation code to indicate that Seam is in the process of removing an access code from the device. */
+                    mutation_code: 'deleting';
+                } | {
+                    /** Date and time at which the mutation was created. */
+                    created_at: string;
+                    /** Detailed description of the mutation. */
+                    message: string;
+                    /** Mutation code to indicate that Seam is in the process of pushing an updated PIN code to the device. */
+                    mutation_code: 'updating_code';
+                    /** Previous code configuration. */
+                    from: {
+                        /** Previous PIN code. */
+                        code: string | null;
+                    };
+                    /** New code configuration. */
+                    to: {
+                        /** New PIN code. */
+                        code: string | null;
+                    };
+                } | {
+                    /** Date and time at which the mutation was created. */
+                    created_at: string;
+                    /** Detailed description of the mutation. */
+                    message: string;
+                    /** Mutation code to indicate that Seam is in the process of pushing an updated access code name to the device. */
+                    mutation_code: 'updating_name';
+                    /** Previous name configuration. */
+                    from: {
+                        /** Previous access code name. */
+                        name: string | null;
+                    };
+                    /** New name configuration. */
+                    to: {
+                        /** New access code name. */
+                        name: string | null;
+                    };
+                } | {
+                    /** Date and time at which the mutation was created. */
+                    created_at: string;
+                    /** Detailed description of the mutation. */
+                    message: string;
+                    /** Mutation code to indicate that Seam is in the process of pushing updated access code time frame to the device. */
+                    mutation_code: 'updating_time_frame';
+                    /** Previous time frame configuration. */
+                    from: {
+                        /** Previous start time for the access code. */
+                        starts_at: string | null;
+                        /** Previous end time for the access code. */
+                        ends_at: string | null;
+                    };
+                    /** New time frame configuration. */
+                    to: {
+                        /** New start time for the access code. */
+                        starts_at: string | null;
+                        /** New end time for the access code. */
+                        ends_at: string | null;
+                    };
+                })[];
             }[];
         };
         maxDuration: undefined;
@@ -4333,6 +4475,77 @@ export type Routes = {
                     /** Indicates whether the access code can be overridden. When false, the maximum number of overrides has been reached. */
                     is_overridable?: boolean | undefined;
                 } | null) | undefined;
+                /** Collection of pending mutations for the access code. Indicates changes that Seam is in the process of pushing to the device. */
+                pending_mutations: ({
+                    /** Date and time at which the mutation was created. */
+                    created_at: string;
+                    /** Detailed description of the mutation. */
+                    message: string;
+                    /** Mutation code to indicate that Seam is in the process of setting an access code on the device. */
+                    mutation_code: 'creating';
+                } | {
+                    /** Date and time at which the mutation was created. */
+                    created_at: string;
+                    /** Detailed description of the mutation. */
+                    message: string;
+                    /** Mutation code to indicate that Seam is in the process of removing an access code from the device. */
+                    mutation_code: 'deleting';
+                } | {
+                    /** Date and time at which the mutation was created. */
+                    created_at: string;
+                    /** Detailed description of the mutation. */
+                    message: string;
+                    /** Mutation code to indicate that Seam is in the process of pushing an updated PIN code to the device. */
+                    mutation_code: 'updating_code';
+                    /** Previous code configuration. */
+                    from: {
+                        /** Previous PIN code. */
+                        code: string | null;
+                    };
+                    /** New code configuration. */
+                    to: {
+                        /** New PIN code. */
+                        code: string | null;
+                    };
+                } | {
+                    /** Date and time at which the mutation was created. */
+                    created_at: string;
+                    /** Detailed description of the mutation. */
+                    message: string;
+                    /** Mutation code to indicate that Seam is in the process of pushing an updated access code name to the device. */
+                    mutation_code: 'updating_name';
+                    /** Previous name configuration. */
+                    from: {
+                        /** Previous access code name. */
+                        name: string | null;
+                    };
+                    /** New name configuration. */
+                    to: {
+                        /** New access code name. */
+                        name: string | null;
+                    };
+                } | {
+                    /** Date and time at which the mutation was created. */
+                    created_at: string;
+                    /** Detailed description of the mutation. */
+                    message: string;
+                    /** Mutation code to indicate that Seam is in the process of pushing updated access code time frame to the device. */
+                    mutation_code: 'updating_time_frame';
+                    /** Previous time frame configuration. */
+                    from: {
+                        /** Previous start time for the access code. */
+                        starts_at: string | null;
+                        /** Previous end time for the access code. */
+                        ends_at: string | null;
+                    };
+                    /** New time frame configuration. */
+                    to: {
+                        /** New start time for the access code. */
+                        starts_at: string | null;
+                        /** New end time for the access code. */
+                        ends_at: string | null;
+                    };
+                })[];
             };
         };
         maxDuration: undefined;
@@ -4929,6 +5142,77 @@ export type Routes = {
                     /** Indicates whether the access code can be overridden. When false, the maximum number of overrides has been reached. */
                     is_overridable?: boolean | undefined;
                 } | null) | undefined;
+                /** Collection of pending mutations for the access code. Indicates changes that Seam is in the process of pushing to the device. */
+                pending_mutations: ({
+                    /** Date and time at which the mutation was created. */
+                    created_at: string;
+                    /** Detailed description of the mutation. */
+                    message: string;
+                    /** Mutation code to indicate that Seam is in the process of setting an access code on the device. */
+                    mutation_code: 'creating';
+                } | {
+                    /** Date and time at which the mutation was created. */
+                    created_at: string;
+                    /** Detailed description of the mutation. */
+                    message: string;
+                    /** Mutation code to indicate that Seam is in the process of removing an access code from the device. */
+                    mutation_code: 'deleting';
+                } | {
+                    /** Date and time at which the mutation was created. */
+                    created_at: string;
+                    /** Detailed description of the mutation. */
+                    message: string;
+                    /** Mutation code to indicate that Seam is in the process of pushing an updated PIN code to the device. */
+                    mutation_code: 'updating_code';
+                    /** Previous code configuration. */
+                    from: {
+                        /** Previous PIN code. */
+                        code: string | null;
+                    };
+                    /** New code configuration. */
+                    to: {
+                        /** New PIN code. */
+                        code: string | null;
+                    };
+                } | {
+                    /** Date and time at which the mutation was created. */
+                    created_at: string;
+                    /** Detailed description of the mutation. */
+                    message: string;
+                    /** Mutation code to indicate that Seam is in the process of pushing an updated access code name to the device. */
+                    mutation_code: 'updating_name';
+                    /** Previous name configuration. */
+                    from: {
+                        /** Previous access code name. */
+                        name: string | null;
+                    };
+                    /** New name configuration. */
+                    to: {
+                        /** New access code name. */
+                        name: string | null;
+                    };
+                } | {
+                    /** Date and time at which the mutation was created. */
+                    created_at: string;
+                    /** Detailed description of the mutation. */
+                    message: string;
+                    /** Mutation code to indicate that Seam is in the process of pushing updated access code time frame to the device. */
+                    mutation_code: 'updating_time_frame';
+                    /** Previous time frame configuration. */
+                    from: {
+                        /** Previous start time for the access code. */
+                        starts_at: string | null;
+                        /** Previous end time for the access code. */
+                        ends_at: string | null;
+                    };
+                    /** New time frame configuration. */
+                    to: {
+                        /** New start time for the access code. */
+                        starts_at: string | null;
+                        /** New end time for the access code. */
+                        ends_at: string | null;
+                    };
+                })[];
             }[];
             /** Information about the current page of results. */
             pagination: {
@@ -5468,6 +5752,77 @@ export type Routes = {
                     /** Indicates whether the access code can be overridden. When false, the maximum number of overrides has been reached. */
                     is_overridable?: boolean | undefined;
                 } | null) | undefined;
+                /** Collection of pending mutations for the access code. Indicates changes that Seam is in the process of pushing to the device. */
+                pending_mutations: ({
+                    /** Date and time at which the mutation was created. */
+                    created_at: string;
+                    /** Detailed description of the mutation. */
+                    message: string;
+                    /** Mutation code to indicate that Seam is in the process of setting an access code on the device. */
+                    mutation_code: 'creating';
+                } | {
+                    /** Date and time at which the mutation was created. */
+                    created_at: string;
+                    /** Detailed description of the mutation. */
+                    message: string;
+                    /** Mutation code to indicate that Seam is in the process of removing an access code from the device. */
+                    mutation_code: 'deleting';
+                } | {
+                    /** Date and time at which the mutation was created. */
+                    created_at: string;
+                    /** Detailed description of the mutation. */
+                    message: string;
+                    /** Mutation code to indicate that Seam is in the process of pushing an updated PIN code to the device. */
+                    mutation_code: 'updating_code';
+                    /** Previous code configuration. */
+                    from: {
+                        /** Previous PIN code. */
+                        code: string | null;
+                    };
+                    /** New code configuration. */
+                    to: {
+                        /** New PIN code. */
+                        code: string | null;
+                    };
+                } | {
+                    /** Date and time at which the mutation was created. */
+                    created_at: string;
+                    /** Detailed description of the mutation. */
+                    message: string;
+                    /** Mutation code to indicate that Seam is in the process of pushing an updated access code name to the device. */
+                    mutation_code: 'updating_name';
+                    /** Previous name configuration. */
+                    from: {
+                        /** Previous access code name. */
+                        name: string | null;
+                    };
+                    /** New name configuration. */
+                    to: {
+                        /** New access code name. */
+                        name: string | null;
+                    };
+                } | {
+                    /** Date and time at which the mutation was created. */
+                    created_at: string;
+                    /** Detailed description of the mutation. */
+                    message: string;
+                    /** Mutation code to indicate that Seam is in the process of pushing updated access code time frame to the device. */
+                    mutation_code: 'updating_time_frame';
+                    /** Previous time frame configuration. */
+                    from: {
+                        /** Previous start time for the access code. */
+                        starts_at: string | null;
+                        /** Previous end time for the access code. */
+                        ends_at: string | null;
+                    };
+                    /** New time frame configuration. */
+                    to: {
+                        /** New start time for the access code. */
+                        starts_at: string | null;
+                        /** New end time for the access code. */
+                        ends_at: string | null;
+                    };
+                })[];
             };
             /** Represents a smart lock [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).
           
@@ -5984,6 +6339,77 @@ export type Routes = {
                     /** Indicates whether the access code can be overridden. When false, the maximum number of overrides has been reached. */
                     is_overridable?: boolean | undefined;
                 } | null) | undefined;
+                /** Collection of pending mutations for the access code. Indicates changes that Seam is in the process of pushing to the device. */
+                pending_mutations: ({
+                    /** Date and time at which the mutation was created. */
+                    created_at: string;
+                    /** Detailed description of the mutation. */
+                    message: string;
+                    /** Mutation code to indicate that Seam is in the process of setting an access code on the device. */
+                    mutation_code: 'creating';
+                } | {
+                    /** Date and time at which the mutation was created. */
+                    created_at: string;
+                    /** Detailed description of the mutation. */
+                    message: string;
+                    /** Mutation code to indicate that Seam is in the process of removing an access code from the device. */
+                    mutation_code: 'deleting';
+                } | {
+                    /** Date and time at which the mutation was created. */
+                    created_at: string;
+                    /** Detailed description of the mutation. */
+                    message: string;
+                    /** Mutation code to indicate that Seam is in the process of pushing an updated PIN code to the device. */
+                    mutation_code: 'updating_code';
+                    /** Previous code configuration. */
+                    from: {
+                        /** Previous PIN code. */
+                        code: string | null;
+                    };
+                    /** New code configuration. */
+                    to: {
+                        /** New PIN code. */
+                        code: string | null;
+                    };
+                } | {
+                    /** Date and time at which the mutation was created. */
+                    created_at: string;
+                    /** Detailed description of the mutation. */
+                    message: string;
+                    /** Mutation code to indicate that Seam is in the process of pushing an updated access code name to the device. */
+                    mutation_code: 'updating_name';
+                    /** Previous name configuration. */
+                    from: {
+                        /** Previous access code name. */
+                        name: string | null;
+                    };
+                    /** New name configuration. */
+                    to: {
+                        /** New access code name. */
+                        name: string | null;
+                    };
+                } | {
+                    /** Date and time at which the mutation was created. */
+                    created_at: string;
+                    /** Detailed description of the mutation. */
+                    message: string;
+                    /** Mutation code to indicate that Seam is in the process of pushing updated access code time frame to the device. */
+                    mutation_code: 'updating_time_frame';
+                    /** Previous time frame configuration. */
+                    from: {
+                        /** Previous start time for the access code. */
+                        starts_at: string | null;
+                        /** Previous end time for the access code. */
+                        ends_at: string | null;
+                    };
+                    /** New time frame configuration. */
+                    to: {
+                        /** New start time for the access code. */
+                        starts_at: string | null;
+                        /** New end time for the access code. */
+                        ends_at: string | null;
+                    };
+                })[];
             };
         };
         maxDuration: undefined;
@@ -99662,6 +100088,77 @@ export type Routes = {
                         /** Indicates whether the access code can be overridden. When false, the maximum number of overrides has been reached. */
                         is_overridable?: boolean | undefined;
                     } | null) | undefined;
+                    /** Collection of pending mutations for the access code. Indicates changes that Seam is in the process of pushing to the device. */
+                    pending_mutations: ({
+                        /** Date and time at which the mutation was created. */
+                        created_at: string;
+                        /** Detailed description of the mutation. */
+                        message: string;
+                        /** Mutation code to indicate that Seam is in the process of setting an access code on the device. */
+                        mutation_code: 'creating';
+                    } | {
+                        /** Date and time at which the mutation was created. */
+                        created_at: string;
+                        /** Detailed description of the mutation. */
+                        message: string;
+                        /** Mutation code to indicate that Seam is in the process of removing an access code from the device. */
+                        mutation_code: 'deleting';
+                    } | {
+                        /** Date and time at which the mutation was created. */
+                        created_at: string;
+                        /** Detailed description of the mutation. */
+                        message: string;
+                        /** Mutation code to indicate that Seam is in the process of pushing an updated PIN code to the device. */
+                        mutation_code: 'updating_code';
+                        /** Previous code configuration. */
+                        from: {
+                            /** Previous PIN code. */
+                            code: string | null;
+                        };
+                        /** New code configuration. */
+                        to: {
+                            /** New PIN code. */
+                            code: string | null;
+                        };
+                    } | {
+                        /** Date and time at which the mutation was created. */
+                        created_at: string;
+                        /** Detailed description of the mutation. */
+                        message: string;
+                        /** Mutation code to indicate that Seam is in the process of pushing an updated access code name to the device. */
+                        mutation_code: 'updating_name';
+                        /** Previous name configuration. */
+                        from: {
+                            /** Previous access code name. */
+                            name: string | null;
+                        };
+                        /** New name configuration. */
+                        to: {
+                            /** New access code name. */
+                            name: string | null;
+                        };
+                    } | {
+                        /** Date and time at which the mutation was created. */
+                        created_at: string;
+                        /** Detailed description of the mutation. */
+                        message: string;
+                        /** Mutation code to indicate that Seam is in the process of pushing updated access code time frame to the device. */
+                        mutation_code: 'updating_time_frame';
+                        /** Previous time frame configuration. */
+                        from: {
+                            /** Previous start time for the access code. */
+                            starts_at: string | null;
+                            /** Previous end time for the access code. */
+                            ends_at: string | null;
+                        };
+                        /** New time frame configuration. */
+                        to: {
+                            /** New start time for the access code. */
+                            starts_at: string | null;
+                            /** New end time for the access code. */
+                            ends_at: string | null;
+                        };
+                    })[];
                 }[] | undefined;
                 thermostat_daily_programs?: {
                     /** ID of the thermostat daily program. */

package/package.json

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

package/src/lib/seam/connect/models/access-codes/managed-access-code.ts

@@ -1,6 +1,7 @@
 import { z } from 'zod'
 
 import { device_and_connected_account_error_options } from '../devices/index.js'
+import { access_code_pending_mutations } from './pending-mutations.js'
 
 const common_access_code_error = z.object({
   message: z
@@ -714,6 +715,11 @@ export const access_code = z.object({
     .describe(
       'Metadata for a dormakaba Oracode managed access code. Only present for access codes from dormakaba Oracode devices.',
     ),
+  pending_mutations: z
+    .array(access_code_pending_mutations)
+    .describe(
+      'Collection of pending mutations for the access code. Indicates changes that Seam is in the process of pushing to the device.',
+    ),
 }).describe(`
   ---
   route_path: /access_codes

package/src/lib/seam/connect/models/access-codes/pending-mutations.ts

@@ -123,12 +123,30 @@ export type AccessCodePendingMutation = z.infer<
   typeof access_code_pending_mutations
 >
 
+// Internal fields stored in the DB but stripped from public API responses.
+// Used to track the delete+recreate flow for providers that don't support
+// in-place updates (e.g. Schlage, August).
+const internal_recreate_fields = z.object({
+  must_be_recreated_on_device: z.boolean().optional(),
+  is_being_removed: z.boolean().optional(),
+  is_being_created: z.boolean().optional(),
+})
+
 const _access_code_pending_mutations_map = z.object({
   creating: creating.optional().nullable(),
   deleting: deleting.optional().nullable(),
-  updating_code: updating_code.optional().nullable(),
-  updating_name: updating_name.optional().nullable(),
-  updating_time_frame: updating_time_frame.optional().nullable(),
+  updating_code: updating_code
+    .merge(internal_recreate_fields)
+    .optional()
+    .nullable(),
+  updating_name: updating_name
+    .merge(internal_recreate_fields)
+    .optional()
+    .nullable(),
+  updating_time_frame: updating_time_frame
+    .merge(internal_recreate_fields)
+    .optional()
+    .nullable(),
 })
 
 export type AccessCodePendingMutationsMap = z.infer<