@seamapi/http - v1.121.0
    Preparing search index...

    Class SeamHttpEndpoints

    Index

    Constructors

    Properties

    Accessors

    /access_codes/create /access_codes/create_multiple /access_codes/delete /access_codes/generate_code /access_codes/get /access_codes/get_timeline /access_codes/list /access_codes/pull_backup_access_code /access_codes/report_device_constraints /access_codes/simulate/create_unmanaged_access_code /access_codes/unmanaged/convert_to_managed /access_codes/unmanaged/delete /access_codes/unmanaged/get /access_codes/unmanaged/list /access_codes/unmanaged/update /access_codes/update /access_codes/update_multiple /access_grants/create /access_grants/delete /access_grants/get /access_grants/get_related /access_grants/list /access_grants/request_access_methods /access_grants/unmanaged/get /access_grants/unmanaged/list /access_grants/unmanaged/update /access_grants/update /access_methods/assign_card /access_methods/delete /access_methods/encode /access_methods/get /access_methods/get_related /access_methods/list /access_methods/unlock_door /access_methods/unmanaged/get /access_methods/unmanaged/list /acs/access_groups/add_user /acs/access_groups/delete /acs/access_groups/get /acs/access_groups/list /acs/access_groups/list_accessible_entrances /acs/access_groups/list_users /acs/access_groups/remove_user /acs/access_groups/unmanaged/get /acs/access_groups/unmanaged/list /acs/credential_pools/list /acs/credential_provisioning_automations/launch /acs/credentials/assign /acs/credentials/create /acs/credentials/create_offline_code /acs/credentials/delete /acs/credentials/get /acs/credentials/list /acs/credentials/list_accessible_entrances /acs/credentials/unassign /acs/credentials/unmanaged/get /acs/credentials/unmanaged/list /acs/credentials/update /acs/encoders/encode_credential /acs/encoders/get /acs/encoders/list /acs/encoders/scan_credential /acs/encoders/scan_to_assign_credential /acs/encoders/simulate/next_credential_encode_will_fail /acs/encoders/simulate/next_credential_encode_will_succeed /acs/encoders/simulate/next_credential_scan_will_fail /acs/encoders/simulate/next_credential_scan_will_succeed /acs/entrances/get /acs/entrances/grant_access /acs/entrances/list /acs/entrances/list_credentials_with_access /acs/entrances/unlock /acs/systems/get /acs/systems/list /acs/systems/list_compatible_credential_manager_acs_systems /acs/systems/report_devices /acs/users/add_to_access_group /acs/users/create /acs/users/delete /acs/users/get /acs/users/list /acs/users/list_accessible_entrances /acs/users/remove_from_access_group /acs/users/revoke_access_to_all_entrances /acs/users/suspend /acs/users/unmanaged/get /acs/users/unmanaged/list /acs/users/unsuspend /acs/users/update /action_attempts/get /action_attempts/list /bridges/get /bridges/list /client_sessions/create /client_sessions/delete /client_sessions/get /client_sessions/get_or_create /client_sessions/grant_access /client_sessions/list /client_sessions/revoke /connect_webviews/create /connect_webviews/delete /connect_webviews/get /connect_webviews/list /connected_accounts/delete /connected_accounts/get /connected_accounts/list /connected_accounts/simulate/disconnect /connected_accounts/sync /connected_accounts/update /customers/create_portal /customers/delete_data /customers/push_data /customers/reservations/create_deep_link /devices/delete /devices/get /devices/list /devices/list_device_providers /devices/report_provider_metadata /devices/simulate/connect /devices/simulate/connect_to_hub /devices/simulate/disconnect /devices/simulate/disconnect_from_hub /devices/simulate/paid_subscription /devices/simulate/remove /devices/unmanaged/get /devices/unmanaged/list /devices/unmanaged/update /devices/update /events/get /events/list /instant_keys/delete /instant_keys/get /instant_keys/list /locks/configure_auto_lock /locks/get /locks/list /locks/lock_door /locks/simulate/keypad_code_entry /locks/simulate/manual_lock_via_keypad /locks/unlock_door /noise_sensors/list /noise_sensors/noise_thresholds/create /noise_sensors/noise_thresholds/delete /noise_sensors/noise_thresholds/get /noise_sensors/noise_thresholds/list /noise_sensors/noise_thresholds/update /noise_sensors/simulate/trigger_noise_threshold /phones/deactivate /phones/get /phones/list /phones/simulate/create_sandbox_phone /seam/console/v1/get_resource_locator /seam/console/v1/lynx_migration/get_property_migration_status /seam/console/v1/lynx_migration/get_reservation_migration_status /seam/console/v1/lynx_migration/list_property_reservations /seam/console/v1/lynx_migration/migrate_property /seam/console/v1/sites/create /seam/console/v1/sites/delete /seam/console/v1/sites/list /seam/console/v1/sites/update /seam/console/v1/timelines/get /seam/console/v1/workspace/feature_flags/list /seam/console/v1/workspace/feature_flags/update /seam/customer/v1/access_grants/list /seam/customer/v1/access_grants/update /seam/customer/v1/access_methods/encode /seam/customer/v1/automation_runs/list /seam/customer/v1/automations/delete /seam/customer/v1/automations/get /seam/customer/v1/automations/update /seam/customer/v1/connector_customers/list /seam/customer/v1/connectors/authorize /seam/customer/v1/connectors/connector_types /seam/customer/v1/connectors/create /seam/customer/v1/connectors/delete /seam/customer/v1/connectors/external_sites/list /seam/customer/v1/connectors/ical/validate-config /seam/customer/v1/connectors/list /seam/customer/v1/connectors/sync /seam/customer/v1/connectors/update /seam/customer/v1/customers/automations/get /seam/customer/v1/customers/automations/update /seam/customer/v1/customers/list /seam/customer/v1/customers/me /seam/customer/v1/customers/open_portal /seam/customer/v1/encoders/list /seam/customer/v1/events/list /seam/customer/v1/portals/get /seam/customer/v1/portals/update /seam/customer/v1/reservations/get /seam/customer/v1/reservations/list /seam/customer/v1/reservations/list_access_grants /seam/customer/v1/settings/get /seam/customer/v1/settings/update /seam/customer/v1/settings/vertical_resource_aliases/get /seam/customer/v1/spaces/create /seam/customer/v1/spaces/list /seam/customer/v1/spaces/list_reservations /seam/customer/v1/spaces/push_common_areas /seam/customer/v1/staff_members/get /seam/customer/v1/staff_members/list /seam/partner/v1/building_blocks/spaces/auto_map /spaces/add_acs_entrances /spaces/add_connected_account /spaces/add_devices /spaces/create /spaces/delete /spaces/get /spaces/get_related /spaces/list /spaces/remove_acs_entrances /spaces/remove_connected_account /spaces/remove_devices /spaces/update /thermostats/activate_climate_preset /thermostats/cool /thermostats/create_climate_preset /thermostats/daily_programs/create /thermostats/daily_programs/delete /thermostats/daily_programs/update /thermostats/delete_climate_preset /thermostats/get /thermostats/heat /thermostats/heat_cool /thermostats/list /thermostats/off /thermostats/schedules/create /thermostats/schedules/delete /thermostats/schedules/get /thermostats/schedules/list /thermostats/schedules/update /thermostats/set_fallback_climate_preset /thermostats/set_fan_mode /thermostats/set_hvac_mode /thermostats/set_temperature_threshold /thermostats/simulate/hvac_mode_adjusted /thermostats/simulate/temperature_reached /thermostats/update_climate_preset /thermostats/update_weekly_program /unstable_partner/building_blocks/connect_accounts /unstable_partner/building_blocks/generate_magic_link /unstable_partner/building_blocks/manage_devices /unstable_partner/building_blocks/organize_spaces /user_identities/add_acs_user /user_identities/create /user_identities/delete /user_identities/enrollment_automations/delete /user_identities/enrollment_automations/get /user_identities/enrollment_automations/launch /user_identities/enrollment_automations/list /user_identities/generate_instant_key /user_identities/get /user_identities/grant_access_to_device /user_identities/list /user_identities/list_accessible_devices /user_identities/list_accessible_entrances /user_identities/list_acs_systems /user_identities/list_acs_users /user_identities/remove_acs_user /user_identities/revoke_access_to_device /user_identities/unmanaged/get /user_identities/unmanaged/list /user_identities/unmanaged/update /user_identities/update /webhooks/create /webhooks/delete /webhooks/get /webhooks/list /webhooks/update /workspaces/create /workspaces/customization_profiles/create /workspaces/customization_profiles/get /workspaces/customization_profiles/list /workspaces/customization_profiles/update /workspaces/customization_profiles/upload_images /workspaces/find_anything /workspaces/get /workspaces/list /workspaces/reset_sandbox /workspaces/update

    Methods

    Constructors

    Properties

    client: AxiosInstance
    defaults: Required<SeamHttpRequestOptions>
    ltsVersion: "1.0.0" = seamApiLtsVersion
    ltsVersion: string = seamApiLtsVersion

    Accessors

    • get "/access_codes/get_timeline"(): (
          parameters: {
              access_code_id: string;
              after?: string;
              before?: string;
              event_types?: (
                  | "access_code.created"
                  | "access_code.changed"
                  | "access_code.name_changed"
                  | "access_code.code_changed"
                  | "access_code.time_frame_changed"
                  | "access_code.mutations_requested"
                  | "access_code.scheduled_on_device"
                  | "access_code.set_on_device"
                  | "access_code.removed_from_device"
                  | "access_code.delay_in_setting_on_device"
                  | "access_code.failed_to_set_on_device"
                  | "access_code.deleted"
                  | "access_code.delay_in_removing_from_device"
                  | "access_code.failed_to_remove_from_device"
                  | "access_code.modified_external_to_seam"
                  | "access_code.deleted_external_to_seam"
                  | "access_code.backup_access_code_pulled"
                  | "access_code.unmanaged.converted_to_managed"
                  | "access_code.unmanaged.failed_to_convert_to_managed"
                  | "access_code.unmanaged.created"
                  | "access_code.unmanaged.removed"
                  | "internal.access_code.programming_started"
                  | "internal.access_code.programming_finished"
              )[];
              limit?: number;
          },
          options?: AccessCodesGetTimelineOptions,
      ) => AccessCodesGetTimelineRequest

      Returns (
          parameters: {
              access_code_id: string;
              after?: string;
              before?: string;
              event_types?: (
                  | "access_code.created"
                  | "access_code.changed"
                  | "access_code.name_changed"
                  | "access_code.code_changed"
                  | "access_code.time_frame_changed"
                  | "access_code.mutations_requested"
                  | "access_code.scheduled_on_device"
                  | "access_code.set_on_device"
                  | "access_code.removed_from_device"
                  | "access_code.delay_in_setting_on_device"
                  | "access_code.failed_to_set_on_device"
                  | "access_code.deleted"
                  | "access_code.delay_in_removing_from_device"
                  | "access_code.failed_to_remove_from_device"
                  | "access_code.modified_external_to_seam"
                  | "access_code.deleted_external_to_seam"
                  | "access_code.backup_access_code_pulled"
                  | "access_code.unmanaged.converted_to_managed"
                  | "access_code.unmanaged.failed_to_convert_to_managed"
                  | "access_code.unmanaged.created"
                  | "access_code.unmanaged.removed"
                  | "internal.access_code.programming_started"
                  | "internal.access_code.programming_finished"
              )[];
              limit?: number;
          },
          options?: AccessCodesGetTimelineOptions,
      ) => AccessCodesGetTimelineRequest

    • get "/acs/access_groups/unmanaged/list"(): (
          parameters?: {
              acs_system_id?: string;
              acs_user_id?: string;
              search?: string;
          },
          options?: AcsAccessGroupsUnmanagedListOptions,
      ) => AcsAccessGroupsUnmanagedListRequest

      Returns (
          parameters?: {
              acs_system_id?: string;
              acs_user_id?: string;
              search?: string;
          },
          options?: AcsAccessGroupsUnmanagedListOptions,
      ) => AcsAccessGroupsUnmanagedListRequest

    • get "/acs/credential_provisioning_automations/launch"(): (
          parameters: {
              acs_credential_pool_id?: string;
              create_credential_manager_user?: boolean;
              credential_manager_acs_system_id: string;
              credential_manager_acs_user_id?: string;
              user_identity_id: string;
          },
          options?: AcsCredentialProvisioningAutomationsLaunchOptions,
      ) => AcsCredentialProvisioningAutomationsLaunchRequest

      Returns (
          parameters: {
              acs_credential_pool_id?: string;
              create_credential_manager_user?: boolean;
              credential_manager_acs_system_id: string;
              credential_manager_acs_user_id?: string;
              user_identity_id: string;
          },
          options?: AcsCredentialProvisioningAutomationsLaunchOptions,
      ) => AcsCredentialProvisioningAutomationsLaunchRequest

    • get "/acs/credentials/create_offline_code"(): (
          parameters: {
              acs_user_id: string;
              allowed_acs_entrance_id: string;
              ends_at?: string;
              is_one_time_use?: boolean;
              starts_at?: string;
          },
          options?: AcsCredentialsCreateOfflineCodeOptions,
      ) => AcsCredentialsCreateOfflineCodeRequest

      Returns (
          parameters: {
              acs_user_id: string;
              allowed_acs_entrance_id: string;
              ends_at?: string;
              is_one_time_use?: boolean;
              starts_at?: string;
          },
          options?: AcsCredentialsCreateOfflineCodeOptions,
      ) => AcsCredentialsCreateOfflineCodeRequest

    • get "/acs/users/unmanaged/list"(): (
          parameters?: {
              acs_system_id?: string;
              limit?: number;
              search?: string;
              user_identity_email_address?: string;
              user_identity_id?: string;
              user_identity_phone_number?: string;
          },
          options?: AcsUsersUnmanagedListOptions,
      ) => AcsUsersUnmanagedListRequest

      Returns (
          parameters?: {
              acs_system_id?: string;
              limit?: number;
              search?: string;
              user_identity_email_address?: string;
              user_identity_id?: string;
              user_identity_phone_number?: string;
          },
          options?: AcsUsersUnmanagedListOptions,
      ) => AcsUsersUnmanagedListRequest

    /locks/simulate/keypad_code_entry

    • get "/seam/console/v1/timelines/get"(): (
          parameters: {
              context_type?: "request" | "job";
              created_after?: Date;
              created_before?: Date;
              created_between?: [Date, Date];
              entry_types?: (
                  | "event"
                  | "resource_created"
                  | "resource_updated"
                  | "resource_deleted"
                  | "provider_call"
                  | "automation_run"
                  | "webhook_processed"
              )[];
              limit?: number;
              page_cursor?: string;
              resource_id: string;
          },
          options?: SeamConsoleV1TimelinesGetOptions,
      ) => SeamConsoleV1TimelinesGetRequest

      Returns (
          parameters: {
              context_type?: "request" | "job";
              created_after?: Date;
              created_before?: Date;
              created_between?: [Date, Date];
              entry_types?: (
                  | "event"
                  | "resource_created"
                  | "resource_updated"
                  | "resource_deleted"
                  | "provider_call"
                  | "automation_run"
                  | "webhook_processed"
              )[];
              limit?: number;
              page_cursor?: string;
              resource_id: string;
          },
          options?: SeamConsoleV1TimelinesGetOptions,
      ) => SeamConsoleV1TimelinesGetRequest

    • get "/seam/console/v1/workspace/feature_flags/update"(): (
          parameters: {
              enabled: boolean;
              feature_flag_name:
                  | "RESERVATION_LEGACY"
                  | "EXPERIMENTAL_DASHBOARD_API_ENABLED"
                  | "ICAL_CONNECTOR"
                  | "VISIONLINE_SERIALIZE_BRIDGE_REQUESTS"
                  | "SALTO_KS_ENTRANCES_ONLY_FOR_SPACES"
                  | "MANAGE_DEVICES_CONFIRMATION_MODAL"
                  | "RECLAIM_ORPHANED_BACKUP_ACCESS_CODES"
                  | "RECONCILE_ORPHANED_SMARTTHINGS_ACCESS_CODES"
                  | "LYNX_MIGRATION_ENABLED"
                  | "AURORA_CUSTOMER_FILTER_ENABLED"
                  | "AUTOMATION_IMMINENT_CHECK_IN_QUEUE";
          },
          options?: SeamConsoleV1WorkspaceFeatureFlagsUpdateOptions,
      ) => SeamConsoleV1WorkspaceFeatureFlagsUpdateRequest

      Returns (
          parameters: {
              enabled: boolean;
              feature_flag_name:
                  | "RESERVATION_LEGACY"
                  | "EXPERIMENTAL_DASHBOARD_API_ENABLED"
                  | "ICAL_CONNECTOR"
                  | "VISIONLINE_SERIALIZE_BRIDGE_REQUESTS"
                  | "SALTO_KS_ENTRANCES_ONLY_FOR_SPACES"
                  | "MANAGE_DEVICES_CONFIRMATION_MODAL"
                  | "RECLAIM_ORPHANED_BACKUP_ACCESS_CODES"
                  | "RECONCILE_ORPHANED_SMARTTHINGS_ACCESS_CODES"
                  | "LYNX_MIGRATION_ENABLED"
                  | "AURORA_CUSTOMER_FILTER_ENABLED"
                  | "AUTOMATION_IMMINENT_CHECK_IN_QUEUE";
          },
          options?: SeamConsoleV1WorkspaceFeatureFlagsUpdateOptions,
      ) => SeamConsoleV1WorkspaceFeatureFlagsUpdateRequest

    • get "/seam/customer/v1/automation_runs/list"(): (
          parameters?: {
              automation_id?: string;
              created_before?: Date;
              limit?: number;
              page_cursor?: string | null;
              partner_resource_id?: string;
              rule?:
                  | "reservation_created"
                  | "reservation_time_updated"
                  | "reservation_deleted"
                  | "space_name_updated";
              success?: boolean;
          },
          options?: SeamCustomerV1AutomationRunsListOptions,
      ) => SeamCustomerV1AutomationRunsListRequest

      Returns (
          parameters?: {
              automation_id?: string;
              created_before?: Date;
              limit?: number;
              page_cursor?: string | null;
              partner_resource_id?: string;
              rule?:
                  | "reservation_created"
                  | "reservation_time_updated"
                  | "reservation_deleted"
                  | "space_name_updated";
              success?: boolean;
          },
          options?: SeamCustomerV1AutomationRunsListOptions,
      ) => SeamCustomerV1AutomationRunsListRequest

    • get "/seam/customer/v1/automations/update"(): (
          parameters?: {
              access_rules?: {
                  reservation_created?: {
                      config: {
                          access_methods: ("code" | "card" | "mobile_key")[];
                          allow_shared_email_and_phone_across_user_identities?: boolean;
                          card_count_on_reservation_create?: number;
                          instant_key_max_use_count?: number;
                          method_issuance_strategy:
                              | "first_available"
                              | "first_two_available"
                              | "all_available";
                          prefer_guest_phone_last4_as_code?: boolean;
                      };
                      rule: "reservation_created";
                  };
                  reservation_deleted?: { config?: {}; rule: "reservation_deleted" };
                  reservation_spaces_updated?: {
                      config?: {};
                      rule: "reservation_spaces_updated";
                  };
                  reservation_time_updated?: {
                      config?: {};
                      rule: "reservation_time_updated";
                  };
                  space_name_updated?: { config?: {}; rule: "space_name_updated" };
                  staff_member_created?: { config: {}; rule: "staff_member_created" };
                  staff_member_name_updated?: {
                      config?: {};
                      rule: "staff_member_name_updated";
                  };
                  user_identity_name_updated?: {
                      config?: {};
                      rule: "user_identity_name_updated";
                  };
              };
              climate_rules?: {
                  rules?: {
                      reservation_created?: {
                          automated_occupied_preset?: {
                              cooling_set_point_celsius?: ...;
                              cooling_set_point_fahrenheit?: ...;
                              fan_mode: ...;
                              heating_set_point_celsius?: ...;
                              heating_set_point_fahrenheit?: ...;
                              is_override_allowed: ...;
                              max_override_period_minutes: ...;
                              mode: ...;
                          };
                          automated_unoccupied_preset?: {
                              cooling_set_point_celsius?: ...;
                              cooling_set_point_fahrenheit?: ...;
                              fan_mode: ...;
                              heating_set_point_celsius?: ...;
                              heating_set_point_fahrenheit?: ...;
                              is_override_allowed: ...;
                              max_override_period_minutes: ...;
                              mode: ...;
                          };
                          occupied_preset_key?: string;
                          precondition_minutes_before_reservation?: number;
                          unoccupied_preset_key?: string;
                      };
                      reservation_deleted?: {};
                      reservation_time_updated?: {};
                  };
              };
              customer_key?: string;
          },
          options?: SeamCustomerV1AutomationsUpdateOptions,
      ) => SeamCustomerV1AutomationsUpdateRequest

      Returns (
          parameters?: {
              access_rules?: {
                  reservation_created?: {
                      config: {
                          access_methods: ("code" | "card" | "mobile_key")[];
                          allow_shared_email_and_phone_across_user_identities?: boolean;
                          card_count_on_reservation_create?: number;
                          instant_key_max_use_count?: number;
                          method_issuance_strategy:
                              | "first_available"
                              | "first_two_available"
                              | "all_available";
                          prefer_guest_phone_last4_as_code?: boolean;
                      };
                      rule: "reservation_created";
                  };
                  reservation_deleted?: { config?: {}; rule: "reservation_deleted" };
                  reservation_spaces_updated?: {
                      config?: {};
                      rule: "reservation_spaces_updated";
                  };
                  reservation_time_updated?: {
                      config?: {};
                      rule: "reservation_time_updated";
                  };
                  space_name_updated?: { config?: {}; rule: "space_name_updated" };
                  staff_member_created?: { config: {}; rule: "staff_member_created" };
                  staff_member_name_updated?: {
                      config?: {};
                      rule: "staff_member_name_updated";
                  };
                  user_identity_name_updated?: {
                      config?: {};
                      rule: "user_identity_name_updated";
                  };
              };
              climate_rules?: {
                  rules?: {
                      reservation_created?: {
                          automated_occupied_preset?: {
                              cooling_set_point_celsius?: ...;
                              cooling_set_point_fahrenheit?: ...;
                              fan_mode: ...;
                              heating_set_point_celsius?: ...;
                              heating_set_point_fahrenheit?: ...;
                              is_override_allowed: ...;
                              max_override_period_minutes: ...;
                              mode: ...;
                          };
                          automated_unoccupied_preset?: {
                              cooling_set_point_celsius?: ...;
                              cooling_set_point_fahrenheit?: ...;
                              fan_mode: ...;
                              heating_set_point_celsius?: ...;
                              heating_set_point_fahrenheit?: ...;
                              is_override_allowed: ...;
                              max_override_period_minutes: ...;
                              mode: ...;
                          };
                          occupied_preset_key?: string;
                          precondition_minutes_before_reservation?: number;
                          unoccupied_preset_key?: string;
                      };
                      reservation_deleted?: {};
                      reservation_time_updated?: {};
                  };
              };
              customer_key?: string;
          },
          options?: SeamCustomerV1AutomationsUpdateOptions,
      ) => SeamCustomerV1AutomationsUpdateRequest

    • get "/seam/customer/v1/connectors/create"(): (
          parameters: {
              config: { [x: string]: unknown };
              connector_type:
                  | "ical"
                  | "lodgify"
                  | "hostaway"
                  | "guesty"
                  | "acuity_scheduling"
                  | "mock"
                  | "mews"
                  | "rms"
                  | "cloudbeds"
                  | "smoobu"
                  | "zonal";
              customer_key?: string;
          },
          options?: SeamCustomerV1ConnectorsCreateOptions,
      ) => SeamCustomerV1ConnectorsCreateRequest

      Returns (
          parameters: {
              config: { [x: string]: unknown };
              connector_type:
                  | "ical"
                  | "lodgify"
                  | "hostaway"
                  | "guesty"
                  | "acuity_scheduling"
                  | "mock"
                  | "mews"
                  | "rms"
                  | "cloudbeds"
                  | "smoobu"
                  | "zonal";
              customer_key?: string;
          },
          options?: SeamCustomerV1ConnectorsCreateOptions,
      ) => SeamCustomerV1ConnectorsCreateRequest

    • get "/seam/customer/v1/connectors/delete"(): (
          parameters: {
              connector_customer_id?: string;
              connector_id: string;
              customer_id?: string;
              customer_key?: string;
              unique_provider_resource_key?: string;
          },
          options?: SeamCustomerV1ConnectorsDeleteOptions,
      ) => SeamCustomerV1ConnectorsDeleteRequest

      Returns (
          parameters: {
              connector_customer_id?: string;
              connector_id: string;
              customer_id?: string;
              customer_key?: string;
              unique_provider_resource_key?: string;
          },
          options?: SeamCustomerV1ConnectorsDeleteOptions,
      ) => SeamCustomerV1ConnectorsDeleteRequest

    • get "/seam/customer/v1/connectors/ical/validate-config"(): (
          parameters: {
              ical_config: {
                  fields: {
                      ends_at: { pattern?: string; source: string; type?: "date" };
                      guest_email?: { pattern?: string; source: string; type?: "date" };
                      guest_name?: { pattern?: string; source: string; type?: "date" };
                      guest_phone?: { pattern?: string; source: string; type?: "date" };
                      reservation_key?: { pattern?: string; source: string; type?: "date" };
                      starts_at: { pattern?: string; source: string; type?: "date" };
                  };
                  filter?: { pattern: string; source: string };
              };
              ical_url: string;
          },
          options?: SeamCustomerV1ConnectorsIcalValidateConfigOptions,
      ) => SeamCustomerV1ConnectorsIcalValidateConfigRequest

      Returns (
          parameters: {
              ical_config: {
                  fields: {
                      ends_at: { pattern?: string; source: string; type?: "date" };
                      guest_email?: { pattern?: string; source: string; type?: "date" };
                      guest_name?: { pattern?: string; source: string; type?: "date" };
                      guest_phone?: { pattern?: string; source: string; type?: "date" };
                      reservation_key?: { pattern?: string; source: string; type?: "date" };
                      starts_at: { pattern?: string; source: string; type?: "date" };
                  };
                  filter?: { pattern: string; source: string };
              };
              ical_url: string;
          },
          options?: SeamCustomerV1ConnectorsIcalValidateConfigOptions,
      ) => SeamCustomerV1ConnectorsIcalValidateConfigRequest

    • get "/seam/customer/v1/connectors/sync"(): (
          parameters: {
              connector_customer_id?: string | null;
              connector_id: string;
              connector_type: string;
              customer_key: string;
              unique_provider_resource_key?: string | null;
          },
          options?: SeamCustomerV1ConnectorsSyncOptions,
      ) => SeamCustomerV1ConnectorsSyncRequest

      Returns (
          parameters: {
              connector_customer_id?: string | null;
              connector_id: string;
              connector_type: string;
              customer_key: string;
              unique_provider_resource_key?: string | null;
          },
          options?: SeamCustomerV1ConnectorsSyncOptions,
      ) => SeamCustomerV1ConnectorsSyncRequest

    • get "/seam/customer/v1/connectors/update"(): (
          parameters: {
              config: { [x: string]: unknown };
              connector_customer_id?: string;
              connector_id: string;
              customer_key?: string;
          },
          options?: SeamCustomerV1ConnectorsUpdateOptions,
      ) => SeamCustomerV1ConnectorsUpdateRequest

      Returns (
          parameters: {
              config: { [x: string]: unknown };
              connector_customer_id?: string;
              connector_id: string;
              customer_key?: string;
          },
          options?: SeamCustomerV1ConnectorsUpdateOptions,
      ) => SeamCustomerV1ConnectorsUpdateRequest

    • get "/seam/customer/v1/customers/automations/update"(): (
          parameters?: {
              access_rules?: {
                  reservation_created?: {
                      config: {
                          access_methods: ("code" | "card" | "mobile_key")[];
                          allow_shared_email_and_phone_across_user_identities?: boolean;
                          card_count_on_reservation_create?: number;
                          instant_key_max_use_count?: number;
                          method_issuance_strategy:
                              | "first_available"
                              | "first_two_available"
                              | "all_available";
                          prefer_guest_phone_last4_as_code?: boolean;
                      };
                      rule: "reservation_created";
                  };
                  reservation_deleted?: { config?: {}; rule: "reservation_deleted" };
                  reservation_spaces_updated?: {
                      config?: {};
                      rule: "reservation_spaces_updated";
                  };
                  reservation_time_updated?: {
                      config?: {};
                      rule: "reservation_time_updated";
                  };
                  space_name_updated?: { config?: {}; rule: "space_name_updated" };
                  staff_member_created?: { config: {}; rule: "staff_member_created" };
                  staff_member_name_updated?: {
                      config?: {};
                      rule: "staff_member_name_updated";
                  };
                  user_identity_name_updated?: {
                      config?: {};
                      rule: "user_identity_name_updated";
                  };
              };
              climate_rules?: {
                  rules?: {
                      reservation_created?: {
                          automated_occupied_preset?: {
                              cooling_set_point_celsius?: ...;
                              cooling_set_point_fahrenheit?: ...;
                              fan_mode: ...;
                              heating_set_point_celsius?: ...;
                              heating_set_point_fahrenheit?: ...;
                              is_override_allowed: ...;
                              max_override_period_minutes: ...;
                              mode: ...;
                          };
                          automated_unoccupied_preset?: {
                              cooling_set_point_celsius?: ...;
                              cooling_set_point_fahrenheit?: ...;
                              fan_mode: ...;
                              heating_set_point_celsius?: ...;
                              heating_set_point_fahrenheit?: ...;
                              is_override_allowed: ...;
                              max_override_period_minutes: ...;
                              mode: ...;
                          };
                          occupied_preset_key?: string;
                          precondition_minutes_before_reservation?: number;
                          unoccupied_preset_key?: string;
                      };
                      reservation_deleted?: {};
                      reservation_time_updated?: {};
                  };
              };
          },
          options?: SeamCustomerV1CustomersAutomationsUpdateOptions,
      ) => SeamCustomerV1CustomersAutomationsUpdateRequest

      Returns (
          parameters?: {
              access_rules?: {
                  reservation_created?: {
                      config: {
                          access_methods: ("code" | "card" | "mobile_key")[];
                          allow_shared_email_and_phone_across_user_identities?: boolean;
                          card_count_on_reservation_create?: number;
                          instant_key_max_use_count?: number;
                          method_issuance_strategy:
                              | "first_available"
                              | "first_two_available"
                              | "all_available";
                          prefer_guest_phone_last4_as_code?: boolean;
                      };
                      rule: "reservation_created";
                  };
                  reservation_deleted?: { config?: {}; rule: "reservation_deleted" };
                  reservation_spaces_updated?: {
                      config?: {};
                      rule: "reservation_spaces_updated";
                  };
                  reservation_time_updated?: {
                      config?: {};
                      rule: "reservation_time_updated";
                  };
                  space_name_updated?: { config?: {}; rule: "space_name_updated" };
                  staff_member_created?: { config: {}; rule: "staff_member_created" };
                  staff_member_name_updated?: {
                      config?: {};
                      rule: "staff_member_name_updated";
                  };
                  user_identity_name_updated?: {
                      config?: {};
                      rule: "user_identity_name_updated";
                  };
              };
              climate_rules?: {
                  rules?: {
                      reservation_created?: {
                          automated_occupied_preset?: {
                              cooling_set_point_celsius?: ...;
                              cooling_set_point_fahrenheit?: ...;
                              fan_mode: ...;
                              heating_set_point_celsius?: ...;
                              heating_set_point_fahrenheit?: ...;
                              is_override_allowed: ...;
                              max_override_period_minutes: ...;
                              mode: ...;
                          };
                          automated_unoccupied_preset?: {
                              cooling_set_point_celsius?: ...;
                              cooling_set_point_fahrenheit?: ...;
                              fan_mode: ...;
                              heating_set_point_celsius?: ...;
                              heating_set_point_fahrenheit?: ...;
                              is_override_allowed: ...;
                              max_override_period_minutes: ...;
                              mode: ...;
                          };
                          occupied_preset_key?: string;
                          precondition_minutes_before_reservation?: number;
                          unoccupied_preset_key?: string;
                      };
                      reservation_deleted?: {};
                      reservation_time_updated?: {};
                  };
              };
          },
          options?: SeamCustomerV1CustomersAutomationsUpdateOptions,
      ) => SeamCustomerV1CustomersAutomationsUpdateRequest

    • get "/seam/customer/v1/customers/list"(): (
          parameters?: {
              limit?: number;
              page_cursor?: string | null;
              search?: string;
          },
          options?: SeamCustomerV1CustomersListOptions,
      ) => SeamCustomerV1CustomersListRequest

      Returns (
          parameters?: {
              limit?: number;
              page_cursor?: string | null;
              search?: string;
          },
          options?: SeamCustomerV1CustomersListOptions,
      ) => SeamCustomerV1CustomersListRequest

    • get "/seam/customer/v1/events/list"(): (
          parameters: {
              between?: (string | Date)[];
              event_type?:
                  | "access_code.created"
                  | "access_code.changed"
                  | "access_code.name_changed"
                  | "access_code.code_changed"
                  | "access_code.time_frame_changed"
                  | "access_code.mutations_requested"
                  | "access_code.scheduled_on_device"
                  | "access_code.set_on_device"
                  | "access_code.removed_from_device"
                  | "access_code.delay_in_setting_on_device"
                  | "access_code.failed_to_set_on_device"
                  | "access_code.deleted"
                  | "access_code.delay_in_removing_from_device"
                  | "access_code.failed_to_remove_from_device"
                  | "access_code.modified_external_to_seam"
                  | "access_code.deleted_external_to_seam"
                  | "access_code.backup_access_code_pulled"
                  | "access_code.unmanaged.converted_to_managed"
                  | "access_code.unmanaged.failed_to_convert_to_managed"
                  | "access_code.unmanaged.created"
                  | "access_code.unmanaged.removed"
                  | "access_grant.created"
                  | "access_grant.deleted"
                  | "access_grant.access_granted_to_all_doors"
                  | "access_grant.access_granted_to_door"
                  | "access_grant.access_to_door_lost"
                  | "access_grant.access_times_changed"
                  | "access_grant.could_not_create_requested_access_methods"
                  | "access_method.issued"
                  | "access_method.revoked"
                  | "access_method.card_encoding_required"
                  | "access_method.deleted"
                  | "access_method.reissued"
                  | "access_method.created"
                  | "access_method.delay_in_issuing"
                  | "access_method.failed_to_issue"
                  | "acs_system.connected"
                  | "acs_system.added"
                  | "acs_system.disconnected"
                  | "acs_credential.deleted"
                  | "acs_credential.issued"
                  | "acs_credential.reissued"
                  | "acs_credential.invalidated"
                  | "acs_user.created"
                  | "acs_user.deleted"
                  | "acs_encoder.added"
                  | "acs_encoder.removed"
                  | "acs_access_group.deleted"
                  | "acs_entrance.added"
                  | "acs_entrance.removed"
                  | "client_session.deleted"
                  | "connected_account.connected"
                  | "connected_account.created"
                  | "connected_account.successful_login"
                  | "connected_account.disconnected"
                  | "connected_account.completed_first_sync"
                  | "connected_account.deleted"
                  | "connected_account.completed_first_sync_after_reconnection"
                  | "connected_account.reauthorization_requested"
                  | "action_attempt.lock_door.succeeded"
                  | "action_attempt.lock_door.failed"
                  | "action_attempt.unlock_door.succeeded"
                  | "action_attempt.unlock_door.failed"
                  | "action_attempt.simulate_keypad_code_entry.succeeded"
                  | "action_attempt.simulate_keypad_code_entry.failed"
                  | "action_attempt.simulate_manual_lock_via_keypad.succeeded"
                  | "action_attempt.simulate_manual_lock_via_keypad.failed"
                  | "connect_webview.login_succeeded"
                  | "connect_webview.login_failed"
                  | "device.connected"
                  | "device.added"
                  | "device.converted_to_unmanaged"
                  | "device.unmanaged.converted_to_managed"
                  | "device.unmanaged.connected"
                  | "device.disconnected"
                  | "device.unmanaged.disconnected"
                  | "device.tampered"
                  | "device.low_battery"
                  | "device.battery_status_changed"
                  | "device.removed"
                  | "device.deleted"
                  | "device.third_party_integration_detected"
                  | "device.third_party_integration_no_longer_detected"
                  | "device.salto.privacy_mode_activated"
                  | "device.salto.privacy_mode_deactivated"
                  | "device.connection_became_flaky"
                  | "device.connection_stabilized"
                  | "device.error.subscription_required"
                  | "device.error.subscription_required.resolved"
                  | "device.accessory_keypad_connected"
                  | "device.accessory_keypad_disconnected"
                  | "noise_sensor.noise_threshold_triggered"
                  | "lock.locked"
                  | "lock.unlocked"
                  | "lock.access_denied"
                  | "thermostat.climate_preset_activated"
                  | "thermostat.manually_adjusted"
                  | "thermostat.temperature_threshold_exceeded"
                  | "thermostat.temperature_threshold_no_longer_exceeded"
                  | "thermostat.temperature_reached_set_point"
                  | "thermostat.temperature_changed"
                  | "device.name_changed"
                  | "camera.activated"
                  | "device.doorbell_rang"
                  | "enrollment_automation.deleted"
                  | "phone.deactivated"
                  | "space.device_membership_changed"
                  | "space.created"
                  | "space.deleted";
              event_types?: (
                  | "access_code.created"
                  | "access_code.changed"
                  | "access_code.name_changed"
                  | "access_code.code_changed"
                  | "access_code.time_frame_changed"
                  | "access_code.mutations_requested"
                  | "access_code.scheduled_on_device"
                  | "access_code.set_on_device"
                  | "access_code.removed_from_device"
                  | "access_code.delay_in_setting_on_device"
                  | "access_code.failed_to_set_on_device"
                  | "access_code.deleted"
                  | "access_code.delay_in_removing_from_device"
                  | "access_code.failed_to_remove_from_device"
                  | "access_code.modified_external_to_seam"
                  | "access_code.deleted_external_to_seam"
                  | "access_code.backup_access_code_pulled"
                  | "access_code.unmanaged.converted_to_managed"
                  | "access_code.unmanaged.failed_to_convert_to_managed"
                  | "access_code.unmanaged.created"
                  | "access_code.unmanaged.removed"
                  | "access_grant.created"
                  | "access_grant.deleted"
                  | "access_grant.access_granted_to_all_doors"
                  | "access_grant.access_granted_to_door"
                  | "access_grant.access_to_door_lost"
                  | "access_grant.access_times_changed"
                  | "access_grant.could_not_create_requested_access_methods"
                  | "access_method.issued"
                  | "access_method.revoked"
                  | "access_method.card_encoding_required"
                  | "access_method.deleted"
                  | "access_method.reissued"
                  | "access_method.created"
                  | "access_method.delay_in_issuing"
                  | "access_method.failed_to_issue"
                  | "acs_system.connected"
                  | "acs_system.added"
                  | "acs_system.disconnected"
                  | "acs_credential.deleted"
                  | "acs_credential.issued"
                  | "acs_credential.reissued"
                  | "acs_credential.invalidated"
                  | "acs_user.created"
                  | "acs_user.deleted"
                  | "acs_encoder.added"
                  | "acs_encoder.removed"
                  | "acs_access_group.deleted"
                  | "acs_entrance.added"
                  | "acs_entrance.removed"
                  | "client_session.deleted"
                  | "connected_account.connected"
                  | "connected_account.created"
                  | "connected_account.successful_login"
                  | "connected_account.disconnected"
                  | "connected_account.completed_first_sync"
                  | "connected_account.deleted"
                  | "connected_account.completed_first_sync_after_reconnection"
                  | "connected_account.reauthorization_requested"
                  | "action_attempt.lock_door.succeeded"
                  | "action_attempt.lock_door.failed"
                  | "action_attempt.unlock_door.succeeded"
                  | "action_attempt.unlock_door.failed"
                  | "action_attempt.simulate_keypad_code_entry.succeeded"
                  | "action_attempt.simulate_keypad_code_entry.failed"
                  | "action_attempt.simulate_manual_lock_via_keypad.succeeded"
                  | "action_attempt.simulate_manual_lock_via_keypad.failed"
                  | "connect_webview.login_succeeded"
                  | "connect_webview.login_failed"
                  | "device.connected"
                  | "device.added"
                  | "device.converted_to_unmanaged"
                  | "device.unmanaged.converted_to_managed"
                  | "device.unmanaged.connected"
                  | "device.disconnected"
                  | "device.unmanaged.disconnected"
                  | "device.tampered"
                  | "device.low_battery"
                  | "device.battery_status_changed"
                  | "device.removed"
                  | "device.deleted"
                  | "device.third_party_integration_detected"
                  | "device.third_party_integration_no_longer_detected"
                  | "device.salto.privacy_mode_activated"
                  | "device.salto.privacy_mode_deactivated"
                  | "device.connection_became_flaky"
                  | "device.connection_stabilized"
                  | "device.error.subscription_required"
                  | "device.error.subscription_required.resolved"
                  | "device.accessory_keypad_connected"
                  | "device.accessory_keypad_disconnected"
                  | "noise_sensor.noise_threshold_triggered"
                  | "lock.locked"
                  | "lock.unlocked"
                  | "lock.access_denied"
                  | "thermostat.climate_preset_activated"
                  | "thermostat.manually_adjusted"
                  | "thermostat.temperature_threshold_exceeded"
                  | "thermostat.temperature_threshold_no_longer_exceeded"
                  | "thermostat.temperature_reached_set_point"
                  | "thermostat.temperature_changed"
                  | "device.name_changed"
                  | "camera.activated"
                  | "device.doorbell_rang"
                  | "enrollment_automation.deleted"
                  | "phone.deactivated"
                  | "space.device_membership_changed"
                  | "space.created"
                  | "space.deleted"
              )[];
              limit?: number;
              since?: string;
              space_id: string;
          },
          options?: SeamCustomerV1EventsListOptions,
      ) => SeamCustomerV1EventsListRequest

      Returns (
          parameters: {
              between?: (string | Date)[];
              event_type?:
                  | "access_code.created"
                  | "access_code.changed"
                  | "access_code.name_changed"
                  | "access_code.code_changed"
                  | "access_code.time_frame_changed"
                  | "access_code.mutations_requested"
                  | "access_code.scheduled_on_device"
                  | "access_code.set_on_device"
                  | "access_code.removed_from_device"
                  | "access_code.delay_in_setting_on_device"
                  | "access_code.failed_to_set_on_device"
                  | "access_code.deleted"
                  | "access_code.delay_in_removing_from_device"
                  | "access_code.failed_to_remove_from_device"
                  | "access_code.modified_external_to_seam"
                  | "access_code.deleted_external_to_seam"
                  | "access_code.backup_access_code_pulled"
                  | "access_code.unmanaged.converted_to_managed"
                  | "access_code.unmanaged.failed_to_convert_to_managed"
                  | "access_code.unmanaged.created"
                  | "access_code.unmanaged.removed"
                  | "access_grant.created"
                  | "access_grant.deleted"
                  | "access_grant.access_granted_to_all_doors"
                  | "access_grant.access_granted_to_door"
                  | "access_grant.access_to_door_lost"
                  | "access_grant.access_times_changed"
                  | "access_grant.could_not_create_requested_access_methods"
                  | "access_method.issued"
                  | "access_method.revoked"
                  | "access_method.card_encoding_required"
                  | "access_method.deleted"
                  | "access_method.reissued"
                  | "access_method.created"
                  | "access_method.delay_in_issuing"
                  | "access_method.failed_to_issue"
                  | "acs_system.connected"
                  | "acs_system.added"
                  | "acs_system.disconnected"
                  | "acs_credential.deleted"
                  | "acs_credential.issued"
                  | "acs_credential.reissued"
                  | "acs_credential.invalidated"
                  | "acs_user.created"
                  | "acs_user.deleted"
                  | "acs_encoder.added"
                  | "acs_encoder.removed"
                  | "acs_access_group.deleted"
                  | "acs_entrance.added"
                  | "acs_entrance.removed"
                  | "client_session.deleted"
                  | "connected_account.connected"
                  | "connected_account.created"
                  | "connected_account.successful_login"
                  | "connected_account.disconnected"
                  | "connected_account.completed_first_sync"
                  | "connected_account.deleted"
                  | "connected_account.completed_first_sync_after_reconnection"
                  | "connected_account.reauthorization_requested"
                  | "action_attempt.lock_door.succeeded"
                  | "action_attempt.lock_door.failed"
                  | "action_attempt.unlock_door.succeeded"
                  | "action_attempt.unlock_door.failed"
                  | "action_attempt.simulate_keypad_code_entry.succeeded"
                  | "action_attempt.simulate_keypad_code_entry.failed"
                  | "action_attempt.simulate_manual_lock_via_keypad.succeeded"
                  | "action_attempt.simulate_manual_lock_via_keypad.failed"
                  | "connect_webview.login_succeeded"
                  | "connect_webview.login_failed"
                  | "device.connected"
                  | "device.added"
                  | "device.converted_to_unmanaged"
                  | "device.unmanaged.converted_to_managed"
                  | "device.unmanaged.connected"
                  | "device.disconnected"
                  | "device.unmanaged.disconnected"
                  | "device.tampered"
                  | "device.low_battery"
                  | "device.battery_status_changed"
                  | "device.removed"
                  | "device.deleted"
                  | "device.third_party_integration_detected"
                  | "device.third_party_integration_no_longer_detected"
                  | "device.salto.privacy_mode_activated"
                  | "device.salto.privacy_mode_deactivated"
                  | "device.connection_became_flaky"
                  | "device.connection_stabilized"
                  | "device.error.subscription_required"
                  | "device.error.subscription_required.resolved"
                  | "device.accessory_keypad_connected"
                  | "device.accessory_keypad_disconnected"
                  | "noise_sensor.noise_threshold_triggered"
                  | "lock.locked"
                  | "lock.unlocked"
                  | "lock.access_denied"
                  | "thermostat.climate_preset_activated"
                  | "thermostat.manually_adjusted"
                  | "thermostat.temperature_threshold_exceeded"
                  | "thermostat.temperature_threshold_no_longer_exceeded"
                  | "thermostat.temperature_reached_set_point"
                  | "thermostat.temperature_changed"
                  | "device.name_changed"
                  | "camera.activated"
                  | "device.doorbell_rang"
                  | "enrollment_automation.deleted"
                  | "phone.deactivated"
                  | "space.device_membership_changed"
                  | "space.created"
                  | "space.deleted";
              event_types?: (
                  | "access_code.created"
                  | "access_code.changed"
                  | "access_code.name_changed"
                  | "access_code.code_changed"
                  | "access_code.time_frame_changed"
                  | "access_code.mutations_requested"
                  | "access_code.scheduled_on_device"
                  | "access_code.set_on_device"
                  | "access_code.removed_from_device"
                  | "access_code.delay_in_setting_on_device"
                  | "access_code.failed_to_set_on_device"
                  | "access_code.deleted"
                  | "access_code.delay_in_removing_from_device"
                  | "access_code.failed_to_remove_from_device"
                  | "access_code.modified_external_to_seam"
                  | "access_code.deleted_external_to_seam"
                  | "access_code.backup_access_code_pulled"
                  | "access_code.unmanaged.converted_to_managed"
                  | "access_code.unmanaged.failed_to_convert_to_managed"
                  | "access_code.unmanaged.created"
                  | "access_code.unmanaged.removed"
                  | "access_grant.created"
                  | "access_grant.deleted"
                  | "access_grant.access_granted_to_all_doors"
                  | "access_grant.access_granted_to_door"
                  | "access_grant.access_to_door_lost"
                  | "access_grant.access_times_changed"
                  | "access_grant.could_not_create_requested_access_methods"
                  | "access_method.issued"
                  | "access_method.revoked"
                  | "access_method.card_encoding_required"
                  | "access_method.deleted"
                  | "access_method.reissued"
                  | "access_method.created"
                  | "access_method.delay_in_issuing"
                  | "access_method.failed_to_issue"
                  | "acs_system.connected"
                  | "acs_system.added"
                  | "acs_system.disconnected"
                  | "acs_credential.deleted"
                  | "acs_credential.issued"
                  | "acs_credential.reissued"
                  | "acs_credential.invalidated"
                  | "acs_user.created"
                  | "acs_user.deleted"
                  | "acs_encoder.added"
                  | "acs_encoder.removed"
                  | "acs_access_group.deleted"
                  | "acs_entrance.added"
                  | "acs_entrance.removed"
                  | "client_session.deleted"
                  | "connected_account.connected"
                  | "connected_account.created"
                  | "connected_account.successful_login"
                  | "connected_account.disconnected"
                  | "connected_account.completed_first_sync"
                  | "connected_account.deleted"
                  | "connected_account.completed_first_sync_after_reconnection"
                  | "connected_account.reauthorization_requested"
                  | "action_attempt.lock_door.succeeded"
                  | "action_attempt.lock_door.failed"
                  | "action_attempt.unlock_door.succeeded"
                  | "action_attempt.unlock_door.failed"
                  | "action_attempt.simulate_keypad_code_entry.succeeded"
                  | "action_attempt.simulate_keypad_code_entry.failed"
                  | "action_attempt.simulate_manual_lock_via_keypad.succeeded"
                  | "action_attempt.simulate_manual_lock_via_keypad.failed"
                  | "connect_webview.login_succeeded"
                  | "connect_webview.login_failed"
                  | "device.connected"
                  | "device.added"
                  | "device.converted_to_unmanaged"
                  | "device.unmanaged.converted_to_managed"
                  | "device.unmanaged.connected"
                  | "device.disconnected"
                  | "device.unmanaged.disconnected"
                  | "device.tampered"
                  | "device.low_battery"
                  | "device.battery_status_changed"
                  | "device.removed"
                  | "device.deleted"
                  | "device.third_party_integration_detected"
                  | "device.third_party_integration_no_longer_detected"
                  | "device.salto.privacy_mode_activated"
                  | "device.salto.privacy_mode_deactivated"
                  | "device.connection_became_flaky"
                  | "device.connection_stabilized"
                  | "device.error.subscription_required"
                  | "device.error.subscription_required.resolved"
                  | "device.accessory_keypad_connected"
                  | "device.accessory_keypad_disconnected"
                  | "noise_sensor.noise_threshold_triggered"
                  | "lock.locked"
                  | "lock.unlocked"
                  | "lock.access_denied"
                  | "thermostat.climate_preset_activated"
                  | "thermostat.manually_adjusted"
                  | "thermostat.temperature_threshold_exceeded"
                  | "thermostat.temperature_threshold_no_longer_exceeded"
                  | "thermostat.temperature_reached_set_point"
                  | "thermostat.temperature_changed"
                  | "device.name_changed"
                  | "camera.activated"
                  | "device.doorbell_rang"
                  | "enrollment_automation.deleted"
                  | "phone.deactivated"
                  | "space.device_membership_changed"
                  | "space.created"
                  | "space.deleted"
              )[];
              limit?: number;
              since?: string;
              space_id: string;
          },
          options?: SeamCustomerV1EventsListOptions,
      ) => SeamCustomerV1EventsListRequest

    • get "/seam/customer/v1/portals/update"(): (
          parameters: {
              customer_portal_id: string;
              portal_configuration: {
                  customer_resources_filters?: {
                      field: string;
                      operation: "=";
                      value: string | boolean;
                  }[];
                  customization_profile_id?: string;
                  deep_link?: {
                      resource_key: string;
                      resource_type: "reservation"
                      | "space";
                  };
                  exclude_locale_picker?: boolean;
                  features?: {
                      configure?: {
                          allow_access_automation_rule_customization?: boolean;
                          allow_climate_automation_rule_customization?: boolean;
                          allow_instant_key_customization?: boolean;
                          exclude?: boolean;
                      };
                      connect?: {
                          accepted_providers?: string[];
                          exclude?: boolean;
                          excluded_providers?: string[];
                      };
                      manage?: {
                          device_management_confirmation?: {
                              body?: string;
                              cancel_button_label?: string;
                              confirm_button_label?: string;
                              title?: string;
                          };
                          events?: { allowed_events?: (...)[]; default_events?: (...)[] };
                          exclude?: boolean;
                          exclude_reservation_management?: boolean;
                          exclude_reservation_technical_details?: boolean;
                          exclude_staff_management?: boolean;
                      };
                      manage_devices?: { exclude?: boolean };
                      organize?: { exclude?: boolean };
                  };
                  is_embedded?: boolean;
                  landing_page?: {
                      manage?: | { space_key: string }
                      | { property_key: string }
                      | { room_key: string }
                      | { common_area_key: string }
                      | { unit_key: string }
                      | { facility_key: string }
                      | { building_key: string }
                      | { listing_key: string }
                      | { property_listing_key: string }
                      | { site_key: string }
                      | { reservation_key: string }
                      | { booking_key: string }
                      | { access_grant_key: string };
                  };
                  locale?: | "en-US"
                  | "pt-PT"
                  | "fr-FR"
                  | "it-IT"
                  | "es-ES"
                  | "de-DE"
                  | "nl-NL"
                  | "el-GR"
                  | "pl-PL"
                  | "ru-RU";
                  navigation_mode?: "full"
                  | "restricted";
                  read_only?: boolean;
              };
          },
          options?: SeamCustomerV1PortalsUpdateOptions,
      ) => SeamCustomerV1PortalsUpdateRequest

      Returns (
          parameters: {
              customer_portal_id: string;
              portal_configuration: {
                  customer_resources_filters?: {
                      field: string;
                      operation: "=";
                      value: string | boolean;
                  }[];
                  customization_profile_id?: string;
                  deep_link?: {
                      resource_key: string;
                      resource_type: "reservation"
                      | "space";
                  };
                  exclude_locale_picker?: boolean;
                  features?: {
                      configure?: {
                          allow_access_automation_rule_customization?: boolean;
                          allow_climate_automation_rule_customization?: boolean;
                          allow_instant_key_customization?: boolean;
                          exclude?: boolean;
                      };
                      connect?: {
                          accepted_providers?: string[];
                          exclude?: boolean;
                          excluded_providers?: string[];
                      };
                      manage?: {
                          device_management_confirmation?: {
                              body?: string;
                              cancel_button_label?: string;
                              confirm_button_label?: string;
                              title?: string;
                          };
                          events?: { allowed_events?: (...)[]; default_events?: (...)[] };
                          exclude?: boolean;
                          exclude_reservation_management?: boolean;
                          exclude_reservation_technical_details?: boolean;
                          exclude_staff_management?: boolean;
                      };
                      manage_devices?: { exclude?: boolean };
                      organize?: { exclude?: boolean };
                  };
                  is_embedded?: boolean;
                  landing_page?: {
                      manage?: | { space_key: string }
                      | { property_key: string }
                      | { room_key: string }
                      | { common_area_key: string }
                      | { unit_key: string }
                      | { facility_key: string }
                      | { building_key: string }
                      | { listing_key: string }
                      | { property_listing_key: string }
                      | { site_key: string }
                      | { reservation_key: string }
                      | { booking_key: string }
                      | { access_grant_key: string };
                  };
                  locale?: | "en-US"
                  | "pt-PT"
                  | "fr-FR"
                  | "it-IT"
                  | "es-ES"
                  | "de-DE"
                  | "nl-NL"
                  | "el-GR"
                  | "pl-PL"
                  | "ru-RU";
                  navigation_mode?: "full"
                  | "restricted";
                  read_only?: boolean;
              };
          },
          options?: SeamCustomerV1PortalsUpdateOptions,
      ) => SeamCustomerV1PortalsUpdateRequest

    • get "/seam/customer/v1/reservations/get"(): (
          parameters?: {
              customer_key?: string;
              reservation_id?: string;
              reservation_key?: string;
          },
          options?: SeamCustomerV1ReservationsGetOptions,
      ) => SeamCustomerV1ReservationsGetRequest

      Returns (
          parameters?: {
              customer_key?: string;
              reservation_id?: string;
              reservation_key?: string;
          },
          options?: SeamCustomerV1ReservationsGetOptions,
      ) => SeamCustomerV1ReservationsGetRequest

    • get "/seam/customer/v1/reservations/list"(): (
          parameters?: {
              between?: (string | Date)[];
              connected_account_id?: string;
              created_after?: Date;
              created_before?: Date;
              customer_key?: string;
              limit?: number;
              page_cursor?: string | null;
              search?: string;
              space_id?: string;
              space_key?: string;
              user_identity_id?: string;
          },
          options?: SeamCustomerV1ReservationsListOptions,
      ) => SeamCustomerV1ReservationsListRequest

      Returns (
          parameters?: {
              between?: (string | Date)[];
              connected_account_id?: string;
              created_after?: Date;
              created_before?: Date;
              customer_key?: string;
              limit?: number;
              page_cursor?: string | null;
              search?: string;
              space_id?: string;
              space_key?: string;
              user_identity_id?: string;
          },
          options?: SeamCustomerV1ReservationsListOptions,
      ) => SeamCustomerV1ReservationsListRequest

    • get "/seam/customer/v1/settings/update"(): (
          parameters?: {
              business_vertical?:
                  | "neutral"
                  | "short_term_rental"
                  | "hospitality"
                  | "multi_family"
                  | "gym_management"
                  | "property_tours";
              slug?: string
              | null;
          },
          options?: SeamCustomerV1SettingsUpdateOptions,
      ) => SeamCustomerV1SettingsUpdateRequest

      Returns (
          parameters?: {
              business_vertical?:
                  | "neutral"
                  | "short_term_rental"
                  | "hospitality"
                  | "multi_family"
                  | "gym_management"
                  | "property_tours";
              slug?: string
              | null;
          },
          options?: SeamCustomerV1SettingsUpdateOptions,
      ) => SeamCustomerV1SettingsUpdateRequest

    • get "/seam/customer/v1/spaces/create"(): (
          parameters: {
              acs_entrance_ids?: string[];
              connected_account_ids?: string[];
              customer_data?: {
                  address?: string | null;
                  default_checkin_time?: string | null;
                  default_checkout_time?: string | null;
                  time_zone?: string | null;
              };
              device_ids?: string[];
              name: string;
              parent_space_key?: string;
              parent_space_name?: string;
              space_key?: string;
          },
          options?: SeamCustomerV1SpacesCreateOptions,
      ) => SeamCustomerV1SpacesCreateRequest

      Returns (
          parameters: {
              acs_entrance_ids?: string[];
              connected_account_ids?: string[];
              customer_data?: {
                  address?: string | null;
                  default_checkin_time?: string | null;
                  default_checkout_time?: string | null;
                  time_zone?: string | null;
              };
              device_ids?: string[];
              name: string;
              parent_space_key?: string;
              parent_space_name?: string;
              space_key?: string;
          },
          options?: SeamCustomerV1SpacesCreateOptions,
      ) => SeamCustomerV1SpacesCreateRequest

    • get "/seam/customer/v1/spaces/list"(): (
          parameters?: {
              connected_account_id?: string;
              parent_space_id?: string;
              parent_space_key?: string;
              search?: string;
              space_key?: string;
          },
          options?: SeamCustomerV1SpacesListOptions,
      ) => SeamCustomerV1SpacesListRequest

      Returns (
          parameters?: {
              connected_account_id?: string;
              parent_space_id?: string;
              parent_space_key?: string;
              search?: string;
              space_key?: string;
          },
          options?: SeamCustomerV1SpacesListOptions,
      ) => SeamCustomerV1SpacesListRequest

    • get "/seam/customer/v1/staff_members/list"(): (
          parameters?: {
              created_before?: Date;
              limit?: number;
              page_cursor?: string | null;
              space_id?: string;
              space_key?: string;
          },
          options?: SeamCustomerV1StaffMembersListOptions,
      ) => SeamCustomerV1StaffMembersListRequest

      Returns (
          parameters?: {
              created_before?: Date;
              limit?: number;
              page_cursor?: string | null;
              space_id?: string;
              space_key?: string;
          },
          options?: SeamCustomerV1StaffMembersListOptions,
      ) => SeamCustomerV1StaffMembersListRequest

    • Returns (
          parameters: {
              building_block_type:
                  | "connect_accounts"
                  | "organize_spaces"
                  | "console"
                  | "manage_devices";
              customer_key: string;
              spaces?: {
                  customer_data?: {
                      address?: string
                      | null;
                      default_checkin_time?: string | null;
                      default_checkout_time?: string | null;
                      time_zone?: string | null;
                  };
                  duration_minutes?: number;
                  geolocation?: { latitude: number; longitude: number };
                  name: string;
                  parent_site_key?: string;
                  space_key: string;
              }[];
          },
          options?: UnstablePartnerBuildingBlocksGenerateMagicLinkOptions,
      ) => UnstablePartnerBuildingBlocksGenerateMagicLinkRequest

    • get "/unstable_partner/building_blocks/organize_spaces"(): (
          parameters: {
              customer_key: string;
              spaces?: {
                  customer_data?: {
                      address?: string | null;
                      default_checkin_time?: string | null;
                      default_checkout_time?: string | null;
                      time_zone?: string | null;
                  };
                  duration_minutes?: number;
                  geolocation?: { latitude: number; longitude: number };
                  name: string;
                  parent_site_key?: string;
                  space_key: string;
              }[];
          },
          options?: UnstablePartnerBuildingBlocksOrganizeSpacesOptions,
      ) => UnstablePartnerBuildingBlocksOrganizeSpacesRequest

      Returns (
          parameters: {
              customer_key: string;
              spaces?: {
                  customer_data?: {
                      address?: string | null;
                      default_checkin_time?: string | null;
                      default_checkout_time?: string | null;
                      time_zone?: string | null;
                  };
                  duration_minutes?: number;
                  geolocation?: { latitude: number; longitude: number };
                  name: string;
                  parent_site_key?: string;
                  space_key: string;
              }[];
          },
          options?: UnstablePartnerBuildingBlocksOrganizeSpacesOptions,
      ) => UnstablePartnerBuildingBlocksOrganizeSpacesRequest

    • get "/user_identities/enrollment_automations/launch"(): (
          parameters: {
              acs_credential_pool_id?: string;
              create_credential_manager_user?: boolean;
              credential_manager_acs_system_id: string;
              credential_manager_acs_user_id?: string;
              user_identity_id: string;
          },
          options?: UserIdentitiesEnrollmentAutomationsLaunchOptions,
      ) => UserIdentitiesEnrollmentAutomationsLaunchRequest

      Returns (
          parameters: {
              acs_credential_pool_id?: string;
              create_credential_manager_user?: boolean;
              credential_manager_acs_system_id: string;
              credential_manager_acs_user_id?: string;
              user_identity_id: string;
          },
          options?: UserIdentitiesEnrollmentAutomationsLaunchOptions,
      ) => UserIdentitiesEnrollmentAutomationsLaunchRequest

    • get "/workspaces/customization_profiles/create"(): (
          parameters?: {
              customer_portal_theme?: {
                  font_family?: string;
                  mono_font_family?: string;
                  primary_color?: string;
                  primary_foreground_color?: string;
                  secondary_color?: string;
                  secondary_foreground_color?: string;
              };
              message_overrides?: { [x: string]: { [x: string]: string } };
              name?: string | null;
              primary_color?: string;
              secondary_color?: string;
          },
          options?: WorkspacesCustomizationProfilesCreateOptions,
      ) => WorkspacesCustomizationProfilesCreateRequest

      Returns (
          parameters?: {
              customer_portal_theme?: {
                  font_family?: string;
                  mono_font_family?: string;
                  primary_color?: string;
                  primary_foreground_color?: string;
                  secondary_color?: string;
                  secondary_foreground_color?: string;
              };
              message_overrides?: { [x: string]: { [x: string]: string } };
              name?: string | null;
              primary_color?: string;
              secondary_color?: string;
          },
          options?: WorkspacesCustomizationProfilesCreateOptions,
      ) => WorkspacesCustomizationProfilesCreateRequest

    • get "/workspaces/customization_profiles/update"(): (
          parameters: {
              customer_portal_theme?:
                  | {
                      font_family?: string;
                      mono_font_family?: string;
                      primary_color?: string;
                      primary_foreground_color?: string;
                      secondary_color?: string;
                      secondary_foreground_color?: string;
                  }
                  | null;
              customization_profile_id: string;
              message_overrides?: { [x: string]: { [x: string]: string } }
              | null;
              name?: string | null;
              primary_color?: string;
              secondary_color?: string;
          },
          options?: WorkspacesCustomizationProfilesUpdateOptions,
      ) => WorkspacesCustomizationProfilesUpdateRequest

      Returns (
          parameters: {
              customer_portal_theme?:
                  | {
                      font_family?: string;
                      mono_font_family?: string;
                      primary_color?: string;
                      primary_foreground_color?: string;
                      secondary_color?: string;
                      secondary_foreground_color?: string;
                  }
                  | null;
              customization_profile_id: string;
              message_overrides?: { [x: string]: { [x: string]: string } }
              | null;
              name?: string | null;
              primary_color?: string;
              secondary_color?: string;
          },
          options?: WorkspacesCustomizationProfilesUpdateOptions,
      ) => WorkspacesCustomizationProfilesUpdateRequest

    Methods

    • Parameters

      • clientSessionToken: string

      Returns Promise<void>

    • Parameters

      • consoleSessionToken: string
      • workspaceId: string
      • options: Omit<
            SeamHttpOptionsWithConsoleSessionToken,
            "consoleSessionToken"
            | "workspaceId",
        > = {}

      Returns SeamHttpEndpoints

    • Parameters

      • personalAccessToken: string
      • workspaceId: string
      • options: Omit<
            SeamHttpOptionsWithPersonalAccessToken,
            "personalAccessToken"
            | "workspaceId",
        > = {}

      Returns SeamHttpEndpoints