@seamapi/types 1.738.0 → 1.740.0

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

@@ -14188,6 +14188,18 @@ export type Routes = {
                       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
             }[]
@@ -19652,6 +19664,18 @@ export type Routes = {
                 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
       }
@@ -19835,6 +19859,18 @@ export type Routes = {
                 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
       }[]
@@ -20256,6 +20292,18 @@ export type Routes = {
                     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. */
@@ -20476,6 +20524,18 @@ export type Routes = {
                 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
       }
@@ -20657,6 +20717,18 @@ export type Routes = {
                 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
       }[]
@@ -27211,6 +27283,18 @@ export type Routes = {
                     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. */
@@ -27511,6 +27595,18 @@ export type Routes = {
                     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. */
@@ -27799,6 +27895,18 @@ export type Routes = {
                     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. */
@@ -28310,6 +28418,18 @@ export type Routes = {
                     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. */
@@ -28594,6 +28714,18 @@ export type Routes = {
                     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. */
@@ -69297,6 +69429,243 @@ 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'
@@ -99801,6 +100170,18 @@ export type Routes = {
                     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. */
@@ -102680,6 +103061,18 @@ export type Routes = {
                           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. */
@@ -102870,6 +103263,18 @@ export type Routes = {
                       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
             }[]
@@ -104635,6 +105040,18 @@ export type Routes = {
                           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. */
@@ -104825,6 +105242,18 @@ export type Routes = {
                       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
             }[]