@seamapi/types 1.738.0 → 1.740.0

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

@@ -12356,6 +12356,17 @@ export type Routes = {
                             /** New entrance ID. */
                             acs_entrance_id: 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 a scheduled user membership change is pending for this access group. */
+                        mutation_code: 'deferring_user_membership_update';
+                        /** ID of the user involved in the scheduled change. */
+                        acs_user_id: string;
+                        /** Whether the user is scheduled to be added to or removed from this access group. */
+                        variant: 'adding' | 'removing';
                     })[];
                     is_managed: true;
                 }[] | undefined;
@@ -17059,6 +17070,17 @@ export type Routes = {
                         /** New entrance ID. */
                         acs_entrance_id: 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 a scheduled user membership change is pending for this access group. */
+                    mutation_code: 'deferring_user_membership_update';
+                    /** ID of the user involved in the scheduled change. */
+                    acs_user_id: string;
+                    /** Whether the user is scheduled to be added to or removed from this access group. */
+                    variant: 'adding' | 'removing';
                 })[];
                 is_managed: true;
             };
@@ -17216,6 +17238,17 @@ export type Routes = {
                         /** New entrance ID. */
                         acs_entrance_id: 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 a scheduled user membership change is pending for this access group. */
+                    mutation_code: 'deferring_user_membership_update';
+                    /** ID of the user involved in the scheduled change. */
+                    acs_user_id: string;
+                    /** Whether the user is scheduled to be added to or removed from this access group. */
+                    variant: 'adding' | 'removing';
                 })[];
                 is_managed: true;
             }[];
@@ -17575,6 +17608,17 @@ export type Routes = {
                         /** New access group ID. */
                         acs_access_group_id: 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 a scheduled access group membership change is pending for this user. */
+                    mutation_code: 'deferring_group_membership_update';
+                    /** ID of the access group involved in the scheduled change. */
+                    acs_access_group_id: string;
+                    /** Whether the user is scheduled to be added to or removed from the access group. */
+                    variant: 'adding' | 'removing';
                 })[] | undefined;
                 /** The last time an internal sync job completed for this access system user. */
                 last_successful_sync_at: string | null;
@@ -17766,6 +17810,17 @@ export type Routes = {
                         /** New entrance ID. */
                         acs_entrance_id: 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 a scheduled user membership change is pending for this access group. */
+                    mutation_code: 'deferring_user_membership_update';
+                    /** ID of the user involved in the scheduled change. */
+                    acs_user_id: string;
+                    /** Whether the user is scheduled to be added to or removed from this access group. */
+                    variant: 'adding' | 'removing';
                 })[];
                 is_managed: false;
             };
@@ -17921,6 +17976,17 @@ export type Routes = {
                         /** New entrance ID. */
                         acs_entrance_id: 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 a scheduled user membership change is pending for this access group. */
+                    mutation_code: 'deferring_user_membership_update';
+                    /** ID of the user involved in the scheduled change. */
+                    acs_user_id: string;
+                    /** Whether the user is scheduled to be added to or removed from this access group. */
+                    variant: 'adding' | 'removing';
                 })[];
                 is_managed: false;
             }[];
@@ -23506,6 +23572,17 @@ export type Routes = {
                         /** New access group ID. */
                         acs_access_group_id: 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 a scheduled access group membership change is pending for this user. */
+                    mutation_code: 'deferring_group_membership_update';
+                    /** ID of the access group involved in the scheduled change. */
+                    acs_access_group_id: string;
+                    /** Whether the user is scheduled to be added to or removed from the access group. */
+                    variant: 'adding' | 'removing';
                 })[] | undefined;
                 /** The last time an internal sync job completed for this access system user. */
                 last_successful_sync_at: string | null;
@@ -23770,6 +23847,17 @@ export type Routes = {
                         /** New access group ID. */
                         acs_access_group_id: 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 a scheduled access group membership change is pending for this user. */
+                    mutation_code: 'deferring_group_membership_update';
+                    /** ID of the access group involved in the scheduled change. */
+                    acs_access_group_id: string;
+                    /** Whether the user is scheduled to be added to or removed from the access group. */
+                    variant: 'adding' | 'removing';
                 })[] | undefined;
                 /** The last time an internal sync job completed for this access system user. */
                 last_successful_sync_at: string | null;
@@ -24022,6 +24110,17 @@ export type Routes = {
                         /** New access group ID. */
                         acs_access_group_id: 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 a scheduled access group membership change is pending for this user. */
+                    mutation_code: 'deferring_group_membership_update';
+                    /** ID of the access group involved in the scheduled change. */
+                    acs_access_group_id: string;
+                    /** Whether the user is scheduled to be added to or removed from the access group. */
+                    variant: 'adding' | 'removing';
                 })[] | undefined;
                 /** The last time an internal sync job completed for this access system user. */
                 last_successful_sync_at: string | null;
@@ -24468,6 +24567,17 @@ export type Routes = {
                         /** New access group ID. */
                         acs_access_group_id: 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 a scheduled access group membership change is pending for this user. */
+                    mutation_code: 'deferring_group_membership_update';
+                    /** ID of the access group involved in the scheduled change. */
+                    acs_access_group_id: string;
+                    /** Whether the user is scheduled to be added to or removed from the access group. */
+                    variant: 'adding' | 'removing';
                 })[] | undefined;
                 /** The last time an internal sync job completed for this access system user. */
                 last_successful_sync_at: string | null;
@@ -24716,6 +24826,17 @@ export type Routes = {
                         /** New access group ID. */
                         acs_access_group_id: 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 a scheduled access group membership change is pending for this user. */
+                    mutation_code: 'deferring_group_membership_update';
+                    /** ID of the access group involved in the scheduled change. */
+                    acs_access_group_id: string;
+                    /** Whether the user is scheduled to be added to or removed from the access group. */
+                    variant: 'adding' | 'removing';
                 })[] | undefined;
                 /** The last time an internal sync job completed for this access system user. */
                 last_successful_sync_at: string | null;
@@ -58370,6 +58491,179 @@ export type Routes = {
         };
         maxDuration: undefined;
     };
+    '/seam/customer/v1/customers/automations/get': {
+        route: '/seam/customer/v1/customers/automations/get';
+        method: 'GET' | 'POST';
+        queryParams: {};
+        jsonBody: {};
+        commonParams: {
+            /** Key of the customer. */
+            customer_key: string;
+        };
+        formData: {};
+        jsonResponse: {
+            automation: {
+                access_rules?: {
+                    reservation_created?: {
+                        rule: 'reservation_created';
+                        config: {
+                            access_methods: ('card' | 'mobile_key' | 'code')[];
+                            method_issuance_strategy: 'first_available' | 'first_two_available' | 'all_available';
+                            card_count_on_reservation_create?: number | undefined;
+                            code_count_on_reservation_create?: number | undefined;
+                            instant_key_max_use_count?: number | undefined;
+                        };
+                    } | undefined;
+                    reservation_time_updated?: {
+                        rule: 'reservation_time_updated';
+                        config?: {} | undefined;
+                    } | undefined;
+                    reservation_spaces_updated?: {
+                        rule: 'reservation_spaces_updated';
+                        config?: {} | undefined;
+                    } | undefined;
+                    reservation_deleted?: {
+                        rule: 'reservation_deleted';
+                        config?: {} | undefined;
+                    } | undefined;
+                    space_name_updated?: {
+                        rule: 'space_name_updated';
+                        config?: {} | undefined;
+                    } | undefined;
+                    user_identity_name_updated?: {
+                        rule: 'user_identity_name_updated';
+                        config?: {} | undefined;
+                    } | undefined;
+                    staff_member_name_updated?: {
+                        rule: 'staff_member_name_updated';
+                        config?: {} | undefined;
+                    } | undefined;
+                    staff_member_created?: {
+                        rule: 'staff_member_created';
+                        config: {};
+                    } | undefined;
+                } | undefined;
+                climate_rules?: {
+                    rules: {
+                        reservation_created?: {
+                            occupied_preset_key?: string | undefined;
+                            automated_occupied_preset?: {
+                                mode: 'heat' | 'cool' | 'auto';
+                                heating_set_point_celsius?: number | undefined;
+                                heating_set_point_fahrenheit?: number | undefined;
+                                cooling_set_point_celsius?: number | undefined;
+                                cooling_set_point_fahrenheit?: number | undefined;
+                                fan_mode: 'on' | 'auto' | 'circulate';
+                                is_override_allowed: boolean;
+                                max_override_period_minutes: number;
+                            } | undefined;
+                            unoccupied_preset_key?: string | undefined;
+                            automated_unoccupied_preset?: {
+                                mode: 'heat' | 'cool' | 'auto';
+                                heating_set_point_celsius?: number | undefined;
+                                heating_set_point_fahrenheit?: number | undefined;
+                                cooling_set_point_celsius?: number | undefined;
+                                cooling_set_point_fahrenheit?: number | undefined;
+                                fan_mode: 'on' | 'auto' | 'circulate';
+                                is_override_allowed: boolean;
+                                max_override_period_minutes: number;
+                            } | undefined;
+                            precondition_minutes_before_reservation?: number | undefined;
+                        } | undefined;
+                        reservation_time_updated?: {} | undefined;
+                        reservation_deleted?: {} | undefined;
+                    };
+                } | undefined;
+            };
+        };
+        maxDuration: undefined;
+    };
+    '/seam/customer/v1/customers/automations/update': {
+        route: '/seam/customer/v1/customers/automations/update';
+        method: 'PATCH' | 'POST';
+        queryParams: {};
+        jsonBody: {
+            /** Key of the customer. */
+            customer_key: string;
+            /** Access automation rules configuration. */
+            access_rules?: {
+                reservation_created?: {
+                    rule: 'reservation_created';
+                    config: {
+                        access_methods: ('card' | 'mobile_key' | 'code')[];
+                        method_issuance_strategy: 'first_available' | 'first_two_available' | 'all_available';
+                        card_count_on_reservation_create?: number | undefined;
+                        code_count_on_reservation_create?: number | undefined;
+                        instant_key_max_use_count?: number | undefined;
+                    };
+                } | undefined;
+                reservation_time_updated?: {
+                    rule: 'reservation_time_updated';
+                    config?: {} | undefined;
+                } | undefined;
+                reservation_spaces_updated?: {
+                    rule: 'reservation_spaces_updated';
+                    config?: {} | undefined;
+                } | undefined;
+                reservation_deleted?: {
+                    rule: 'reservation_deleted';
+                    config?: {} | undefined;
+                } | undefined;
+                space_name_updated?: {
+                    rule: 'space_name_updated';
+                    config?: {} | undefined;
+                } | undefined;
+                user_identity_name_updated?: {
+                    rule: 'user_identity_name_updated';
+                    config?: {} | undefined;
+                } | undefined;
+                staff_member_name_updated?: {
+                    rule: 'staff_member_name_updated';
+                    config?: {} | undefined;
+                } | undefined;
+                staff_member_created?: {
+                    rule: 'staff_member_created';
+                    config: {};
+                } | undefined;
+            } | undefined;
+            /** Climate automation rules configuration. */
+            climate_rules?: {
+                rules?: {
+                    reservation_created?: {
+                        occupied_preset_key?: string | undefined;
+                        automated_occupied_preset?: {
+                            mode: 'heat' | 'cool' | 'auto';
+                            heating_set_point_celsius?: number | undefined;
+                            heating_set_point_fahrenheit?: number | undefined;
+                            cooling_set_point_celsius?: number | undefined;
+                            cooling_set_point_fahrenheit?: number | undefined;
+                            fan_mode: 'on' | 'auto' | 'circulate';
+                            is_override_allowed: boolean;
+                            max_override_period_minutes: number;
+                        } | undefined;
+                        unoccupied_preset_key?: string | undefined;
+                        automated_unoccupied_preset?: {
+                            mode: 'heat' | 'cool' | 'auto';
+                            heating_set_point_celsius?: number | undefined;
+                            heating_set_point_fahrenheit?: number | undefined;
+                            cooling_set_point_celsius?: number | undefined;
+                            cooling_set_point_fahrenheit?: number | undefined;
+                            fan_mode: 'on' | 'auto' | 'circulate';
+                            is_override_allowed: boolean;
+                            max_override_period_minutes: number;
+                        } | undefined;
+                        precondition_minutes_before_reservation?: number | undefined;
+                    } | undefined;
+                    reservation_time_updated?: {} | undefined;
+                    reservation_deleted?: {} | undefined;
+                } | undefined;
+            } | undefined;
+        };
+        commonParams: {};
+        formData: {};
+        jsonResponse: {};
+        maxDuration: undefined;
+    };
     '/seam/customer/v1/customers/list': {
         route: '/seam/customer/v1/customers/list';
         method: 'GET' | 'POST';
@@ -84147,6 +84441,17 @@ export type Routes = {
                         /** New access group ID. */
                         acs_access_group_id: 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 a scheduled access group membership change is pending for this user. */
+                    mutation_code: 'deferring_group_membership_update';
+                    /** ID of the access group involved in the scheduled change. */
+                    acs_access_group_id: string;
+                    /** Whether the user is scheduled to be added to or removed from the access group. */
+                    variant: 'adding' | 'removing';
                 })[] | undefined;
                 /** The last time an internal sync job completed for this access system user. */
                 last_successful_sync_at: string | null;
@@ -86522,6 +86827,17 @@ export type Routes = {
                             /** New access group ID. */
                             acs_access_group_id: 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 a scheduled access group membership change is pending for this user. */
+                        mutation_code: 'deferring_group_membership_update';
+                        /** ID of the access group involved in the scheduled change. */
+                        acs_access_group_id: string;
+                        /** Whether the user is scheduled to be added to or removed from the access group. */
+                        variant: 'adding' | 'removing';
                     })[] | undefined;
                     /** The last time an internal sync job completed for this access system user. */
                     last_successful_sync_at: string | null;
@@ -86681,6 +86997,17 @@ export type Routes = {
                             /** New entrance ID. */
                             acs_entrance_id: 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 a scheduled user membership change is pending for this access group. */
+                        mutation_code: 'deferring_user_membership_update';
+                        /** ID of the user involved in the scheduled change. */
+                        acs_user_id: string;
+                        /** Whether the user is scheduled to be added to or removed from this access group. */
+                        variant: 'adding' | 'removing';
                     })[];
                     is_managed: true;
                 }[] | undefined;
@@ -88189,6 +88516,17 @@ export type Routes = {
                             /** New access group ID. */
                             acs_access_group_id: 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 a scheduled access group membership change is pending for this user. */
+                        mutation_code: 'deferring_group_membership_update';
+                        /** ID of the access group involved in the scheduled change. */
+                        acs_access_group_id: string;
+                        /** Whether the user is scheduled to be added to or removed from the access group. */
+                        variant: 'adding' | 'removing';
                     })[] | undefined;
                     /** The last time an internal sync job completed for this access system user. */
                     last_successful_sync_at: string | null;
@@ -88348,6 +88686,17 @@ export type Routes = {
                             /** New entrance ID. */
                             acs_entrance_id: 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 a scheduled user membership change is pending for this access group. */
+                        mutation_code: 'deferring_user_membership_update';
+                        /** ID of the user involved in the scheduled change. */
+                        acs_user_id: string;
+                        /** Whether the user is scheduled to be added to or removed from this access group. */
+                        variant: 'adding' | 'removing';
                     })[];
                     is_managed: false;
                 }[] | undefined;

package/package.json

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

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

@@ -135,6 +135,27 @@ const updating_entrance_membership = common_pending_mutation
     'Seam is in the process of pushing an entrance membership update to the integrated access system.',
   )
 
+const deferring_user_membership_update = common_pending_mutation
+  .extend({
+    mutation_code: z
+      .literal('deferring_user_membership_update')
+      .describe(
+        'Mutation code to indicate that a scheduled user membership change is pending for this access group.',
+      ),
+    acs_user_id: z
+      .string()
+      .uuid()
+      .describe('ID of the user involved in the scheduled change.'),
+    variant: z
+      .enum(['adding', 'removing'])
+      .describe(
+        'Whether the user is scheduled to be added to or removed from this access group.',
+      ),
+  })
+  .describe(
+    'A scheduled user membership change is pending for this access group.',
+  )
+
 export const acs_access_group_pending_mutations = z.discriminatedUnion(
   'mutation_code',
   [
@@ -144,6 +165,7 @@ export const acs_access_group_pending_mutations = z.discriminatedUnion(
     updating_access_schedule,
     updating_user_membership,
     updating_entrance_membership,
+    deferring_user_membership_update,
   ],
 )
 
@@ -164,6 +186,10 @@ const _acs_access_group_pending_mutations_map = z.object({
     .record(z.string().uuid(), updating_entrance_membership)
     .optional()
     .nullable(),
+  deferring_user_membership_update: z
+    .record(z.string().uuid(), deferring_user_membership_update)
+    .optional()
+    .nullable(),
 })
 
 export type AcsAccessGroupPendingMutationsMap = z.infer<

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

@@ -158,6 +158,27 @@ const updating_group_membership_mutation = common_pending_mutation
     'Seam is in the process of pushing an access group membership update to the integrated access system.',
   )
 
+const deferring_group_membership_update_mutation = common_pending_mutation
+  .extend({
+    mutation_code: z
+      .literal('deferring_group_membership_update')
+      .describe(
+        'Mutation code to indicate that a scheduled access group membership change is pending for this user.',
+      ),
+    acs_access_group_id: z
+      .string()
+      .uuid()
+      .describe('ID of the access group involved in the scheduled change.'),
+    variant: z
+      .enum(['adding', 'removing'])
+      .describe(
+        'Whether the user is scheduled to be added to or removed from the access group.',
+      ),
+  })
+  .describe(
+    'A scheduled access group membership change is pending for this user.',
+  )
+
 export const acs_user_pending_mutations = z.discriminatedUnion(
   'mutation_code',
   [
@@ -168,6 +189,7 @@ export const acs_user_pending_mutations = z.discriminatedUnion(
     updating_access_schedule_mutation,
     updating_suspension_state_mutation,
     updating_group_membership_mutation,
+    deferring_group_membership_update_mutation,
   ],
 )
 
@@ -184,6 +206,10 @@ const _acs_user_pending_mutations_map = z.object({
     .record(z.string().uuid(), updating_group_membership_mutation)
     .optional()
     .nullable(),
+  deferring_group_membership_update: z
+    .record(z.string().uuid(), deferring_group_membership_update_mutation)
+    .optional()
+    .nullable(),
   updating_suspension_state: updating_suspension_state_mutation
     .optional()
     .nullable(),