@land-catalyst/batch-data-sdk 1.1.12

package/dist/builders.d.ts

@@ -0,0 +1,821 @@
+/**
+ * BatchData.io Query Builders
+ *
+ * Fluent query builder API for constructing BatchData property subscription requests
+ *
+ * Usage example:
+ * ```typescript
+ * const searchQuery = new SearchCriteriaBuilder("Maricopa County, AZ")
+ *   .address(new AddressSearchCriteriaBuilder()
+ *     .city(new StringFilterBuilder().equals("Phoenix").build())
+ *     .state(new StringFilterBuilder().equals("AZ").build())
+ *     .build())
+ *   .building(new BuildingSearchCriteriaBuilder()
+ *     .yearBuilt(new NumericRangeFilterBuilder().min(1990).max(2020).build())
+ *     .build())
+ *   .build();
+ * ```
+ */
+import { StringFilter, NumericRangeFilter, DateRangeFilter, GeoLocationDistance, GeoLocationBoundingBox, GeoLocationPolygon, AddressSearchCriteria, AssessmentSearchCriteria, BuildingSearchCriteria, CompAddressSearchCriteria, DemographicsSearchCriteria, ForeclosureSearchCriteria, GeneralSearchCriteria, IdsSearchCriteria, IntelSearchCriteria, InvoluntaryLienSearchCriteria, LegalSearchCriteria, ListingSearchCriteria, LotSearchCriteria, OpenLienSearchCriteria, OwnerSearchCriteria, PermitSearchCriteria, PropertyOwnerProfileSearchCriteria, SaleSearchCriteria, TaxSearchCriteria, ValuationSearchCriteria, OrSearchCriteria, SearchCriteria, DeliveryConfig, PropertySubscriptionRequest, QuickListValueWithNot, PropertyLookupRequest, PropertyLookupRequestItem, PropertyLookupRequestAddress, PropertyLookupOptions, PropertyPermitRequest, PropertySearchRequest, PropertySearchAsyncRequest, PropertyLookupAsyncRequest, GeoPoint } from "./types";
+/**
+ * Base interface for all builders
+ */
+export interface Builder<T> {
+    build(): T;
+}
+/**
+ * Type helper that represents the expected setter method signature for a single property.
+ * This can be used to ensure setter methods have the correct signature.
+ *
+ * Note: TypeScript cannot enforce that a class implements methods for ALL properties
+ * of a type at compile time. This type serves as documentation and can help catch
+ * signature mismatches when explicitly typed.
+ */
+export type PropertySetter<T, K extends keyof T> = (value: T[K] | ((builder: Builder<T[K]>) => void)) => Builder<T>;
+/**
+ * Type helper that represents the expected builders storage structure.
+ * For each property K in T, there should be a Builder<T[K]> instance.
+ * This ensures type safety when storing and accessing nested builders.
+ */
+export type BuildersStorage<T> = {
+    [K in keyof T]?: Builder<T[K]>;
+};
+/**
+ * Abstract base class for builders that store nested builders
+ * Handles the common pattern of storing builder instances and building them all at once
+ */
+declare abstract class BaseBuilder<T> implements Builder<T> {
+    protected criteria: Partial<T>;
+    protected builders: BuildersStorage<T>;
+    /**
+     * Helper method to set a property either directly or via a builder configurator.
+     * This extracts the common pattern of checking if a configurator function is provided,
+     * creating/reusing a builder instance, and either calling the configurator or setting
+     * the value directly.
+     *
+     * @param key - The property key to set
+     * @param valueOrConfigurator - Either the direct value or a configurator function
+     * @param builderFactory - Factory function to create a new builder instance if needed
+     * @returns This builder instance for method chaining
+     */
+    protected setPropertyWithBuilder<K extends keyof T, B extends Builder<T[K]>>(key: K, valueOrConfigurator: T[K] | ((builder: B) => void), builderFactory: () => B): this;
+    /**
+     * Helper method that accepts a builder class constructor and infers types from it.
+     * This allows you to pass the builder class directly instead of a factory function.
+     *
+     * @param key - The property key to set
+     * @param valueOrConfigurator - Either the direct value or a configurator function
+     * @param BuilderClass - The builder class constructor (e.g., NumericRangeFilterBuilder)
+     * @returns This builder instance for method chaining
+     */
+    protected setPropertyWithBuilderClass<K extends keyof T, B extends Builder<T[K]>>(key: K, valueOrConfigurator: T[K] | ((builder: B) => void), BuilderClass: new () => B): this;
+    build(): T;
+}
+/**
+ * Base builder for string filters
+ */
+export declare class StringFilterBuilder implements Builder<StringFilter> {
+    private filter;
+    static from(filter: StringFilter): StringFilterBuilder;
+    equals(value: string): this;
+    contains(value: string): this;
+    startsWith(value: string): this;
+    endsWith(value: string): this;
+    inList(values: string[]): this;
+    notInList(values: string[]): this;
+    matches(patterns: string[]): this;
+    build(): StringFilter;
+}
+/**
+ * Base builder for numeric range filters
+ */
+export declare class NumericRangeFilterBuilder implements Builder<NumericRangeFilter> {
+    private filter;
+    static from(filter: NumericRangeFilter): NumericRangeFilterBuilder;
+    min(value: number): this;
+    max(value: number): this;
+    range(min: number, max: number): this;
+    build(): NumericRangeFilter;
+}
+/**
+ * Base builder for date range filters
+ */
+export declare class DateRangeFilterBuilder implements Builder<DateRangeFilter> {
+    private filter;
+    static from(filter: DateRangeFilter): DateRangeFilterBuilder;
+    minDate(date: string): this;
+    maxDate(date: string): this;
+    range(minDate: string, maxDate: string): this;
+    build(): DateRangeFilter;
+}
+/**
+ * Helper class for creating geographic location filters
+ * This is not a builder in the traditional sense - it's a factory that creates
+ * different geo location objects (distance, bounding box, polygon)
+ */
+export declare class GeoLocationFactory {
+    /**
+     * Create a distance-based filter
+     */
+    static distance(latitude: number, longitude: number, options?: {
+        meters?: string;
+        kilometers?: string;
+        feet?: string;
+        yards?: string;
+        miles?: string;
+    }): GeoLocationDistance;
+    /**
+     * Create a bounding box filter
+     */
+    static boundingBox(nwLatitude: number, nwLongitude: number, seLatitude: number, seLongitude: number): GeoLocationBoundingBox;
+    /**
+     * Create a polygon filter
+     */
+    static polygon(points: Array<{
+        latitude: number;
+        longitude: number;
+    }>): GeoLocationPolygon;
+}
+/**
+ * Builder for address search criteria
+ */
+export declare class AddressSearchCriteriaBuilder extends BaseBuilder<AddressSearchCriteria> {
+    protected criteria: AddressSearchCriteria;
+    static from(criteria: AddressSearchCriteria): AddressSearchCriteriaBuilder;
+    street(filter: StringFilter): this;
+    street(configurator: (builder: StringFilterBuilder) => void): this;
+    city(filter: StringFilter): this;
+    city(configurator: (builder: StringFilterBuilder) => void): this;
+    locality(filter: StringFilter): this;
+    locality(configurator: (builder: StringFilterBuilder) => void): this;
+    county(filter: StringFilter): this;
+    county(configurator: (builder: StringFilterBuilder) => void): this;
+    countyFipsCode(filter: StringFilter): this;
+    countyFipsCode(configurator: (builder: StringFilterBuilder) => void): this;
+    state(filter: StringFilter): this;
+    state(configurator: (builder: StringFilterBuilder) => void): this;
+    zip(filter: StringFilter): this;
+    zip(configurator: (builder: StringFilterBuilder) => void): this;
+    unitType(filter: StringFilter): this;
+    unitType(configurator: (builder: StringFilterBuilder) => void): this;
+    formattedStreet(filter: StringFilter): this;
+    formattedStreet(configurator: (builder: StringFilterBuilder) => void): this;
+    streetNoUnit(filter: StringFilter): this;
+    streetNoUnit(configurator: (builder: StringFilterBuilder) => void): this;
+    geoLocationDistance(latitude: number, longitude: number, options?: {
+        meters?: string;
+        kilometers?: string;
+        feet?: string;
+        yards?: string;
+        miles?: string;
+    }): this;
+    geoLocationBoundingBox(nwLatitude: number, nwLongitude: number, seLatitude: number, seLongitude: number): this;
+    geoLocationPolygon(points: Array<{
+        latitude: number;
+        longitude: number;
+    }>): this;
+    initialGeoStatus(filter: StringFilter): this;
+    initialGeoStatus(configurator: (builder: StringFilterBuilder) => void): this;
+    geoStatus(filter: StringFilter): this;
+    geoStatus(configurator: (builder: StringFilterBuilder) => void): this;
+    cityState(filter: StringFilter): this;
+    cityState(configurator: (builder: StringFilterBuilder) => void): this;
+    countyState(filter: StringFilter): this;
+    countyState(configurator: (builder: StringFilterBuilder) => void): this;
+}
+/**
+ * Builder for assessment search criteria
+ */
+export declare class AssessmentSearchCriteriaBuilder extends BaseBuilder<AssessmentSearchCriteria> {
+    protected criteria: AssessmentSearchCriteria;
+    static from(criteria: AssessmentSearchCriteria): AssessmentSearchCriteriaBuilder;
+    assessmentYear(filter: NumericRangeFilter): this;
+    assessmentYear(configurator: (builder: NumericRangeFilterBuilder) => void): this;
+    totalAssessedValue(filter: NumericRangeFilter): this;
+    totalAssessedValue(configurator: (builder: NumericRangeFilterBuilder) => void): this;
+    assessedImprovementValue(filter: NumericRangeFilter): this;
+    assessedImprovementValue(configurator: (builder: NumericRangeFilterBuilder) => void): this;
+    assessedLandValue(filter: NumericRangeFilter): this;
+    assessedLandValue(configurator: (builder: NumericRangeFilterBuilder) => void): this;
+    marketValueYear(filter: NumericRangeFilter): this;
+    marketValueYear(configurator: (builder: NumericRangeFilterBuilder) => void): this;
+    landMarketValue(filter: NumericRangeFilter): this;
+    landMarketValue(configurator: (builder: NumericRangeFilterBuilder) => void): this;
+    improvementMarketValue(filter: NumericRangeFilter): this;
+    improvementMarketValue(configurator: (builder: NumericRangeFilterBuilder) => void): this;
+    totalMarketValue(filter: NumericRangeFilter): this;
+    totalMarketValue(configurator: (builder: NumericRangeFilterBuilder) => void): this;
+}
+/**
+ * Builder for building search criteria
+ */
+export declare class BuildingSearchCriteriaBuilder extends BaseBuilder<BuildingSearchCriteria> {
+    protected criteria: BuildingSearchCriteria;
+    static from(criteria: BuildingSearchCriteria): BuildingSearchCriteriaBuilder;
+    airConditioningSource(filter: StringFilter): this;
+    airConditioningSource(configurator: (builder: StringFilterBuilder) => void): this;
+    basementType(filter: StringFilter): this;
+    basementType(configurator: (builder: StringFilterBuilder) => void): this;
+    totalBuildingAreaSquareFeet(filter: NumericRangeFilter): this;
+    totalBuildingAreaSquareFeet(configurator: (builder: NumericRangeFilterBuilder) => void): this;
+    buildingClass(filter: StringFilter): this;
+    buildingClass(configurator: (builder: StringFilterBuilder) => void): this;
+    buildingCondition(filter: StringFilter): this;
+    buildingCondition(configurator: (builder: StringFilterBuilder) => void): this;
+    buildingQuality(filter: StringFilter): this;
+    buildingQuality(configurator: (builder: StringFilterBuilder) => void): this;
+    buildingType(filter: StringFilter): this;
+    buildingType(configurator: (builder: StringFilterBuilder) => void): this;
+    driveway(filter: StringFilter): this;
+    driveway(configurator: (builder: StringFilterBuilder) => void): this;
+    exteriorWalls(filter: StringFilter): this;
+    exteriorWalls(configurator: (builder: StringFilterBuilder) => void): this;
+    floorCover(filter: StringFilter): this;
+    floorCover(configurator: (builder: StringFilterBuilder) => void): this;
+    garageParkingSpaceCount(filter: NumericRangeFilter): this;
+    garageParkingSpaceCount(configurator: (builder: NumericRangeFilterBuilder) => void): this;
+    garage(filter: StringFilter): this;
+    garage(configurator: (builder: StringFilterBuilder) => void): this;
+    heatSource(filter: StringFilter): this;
+    heatSource(configurator: (builder: StringFilterBuilder) => void): this;
+    heatingFuelType(filter: StringFilter): this;
+    heatingFuelType(configurator: (builder: StringFilterBuilder) => void): this;
+    interiorWalls(filter: StringFilter): this;
+    interiorWalls(configurator: (builder: StringFilterBuilder) => void): this;
+    buildingCount(filter: NumericRangeFilter): this;
+    buildingCount(configurator: (builder: NumericRangeFilterBuilder) => void): this;
+    bathroomCount(filter: NumericRangeFilter): this;
+    bathroomCount(configurator: (builder: NumericRangeFilterBuilder) => void): this;
+    calculatedBathroomCount(filter: NumericRangeFilter): this;
+    calculatedBathroomCount(configurator: (builder: NumericRangeFilterBuilder) => void): this;
+    bedroomCount(filter: NumericRangeFilter): this;
+    bedroomCount(configurator: (builder: NumericRangeFilterBuilder) => void): this;
+    patio(filter: StringFilter): this;
+    patio(configurator: (builder: StringFilterBuilder) => void): this;
+    storyCount(filter: NumericRangeFilter): this;
+    storyCount(configurator: (builder: NumericRangeFilterBuilder) => void): this;
+    features(filter: StringFilter): this;
+    features(configurator: (builder: StringFilterBuilder) => void): this;
+    residentialUnitCount(filter: NumericRangeFilter): this;
+    residentialUnitCount(configurator: (builder: NumericRangeFilterBuilder) => void): this;
+    pool(filter: StringFilter): this;
+    pool(configurator: (builder: StringFilterBuilder) => void): this;
+    porch(filter: StringFilter): this;
+    porch(configurator: (builder: StringFilterBuilder) => void): this;
+    roofCover(filter: StringFilter): this;
+    roofCover(configurator: (builder: StringFilterBuilder) => void): this;
+    roofType(filter: StringFilter): this;
+    roofType(configurator: (builder: StringFilterBuilder) => void): this;
+    sewer(filter: StringFilter): this;
+    sewer(configurator: (builder: StringFilterBuilder) => void): this;
+    style(filter: StringFilter): this;
+    style(configurator: (builder: StringFilterBuilder) => void): this;
+    roomCount(filter: NumericRangeFilter): this;
+    roomCount(configurator: (builder: NumericRangeFilterBuilder) => void): this;
+    unitCount(filter: NumericRangeFilter): this;
+    unitCount(configurator: (builder: NumericRangeFilterBuilder) => void): this;
+    constructionType(filter: StringFilter): this;
+    constructionType(configurator: (builder: StringFilterBuilder) => void): this;
+    waterService(filter: StringFilter): this;
+    waterService(configurator: (builder: StringFilterBuilder) => void): this;
+    yearBuilt(filter: NumericRangeFilter): this;
+    yearBuilt(configurator: (builder: NumericRangeFilterBuilder) => void): this;
+    build(): BuildingSearchCriteria;
+}
+/**
+ * Builder for comp address search criteria
+ */
+export declare class CompAddressSearchCriteriaBuilder implements Builder<CompAddressSearchCriteria> {
+    protected criteria: CompAddressSearchCriteria;
+    static from(criteria: CompAddressSearchCriteria): CompAddressSearchCriteriaBuilder;
+    street(value: string): this;
+    city(value: string): this;
+    state(value: string): this;
+    zip(value: string): this;
+    hash(value: string): this;
+    build(): CompAddressSearchCriteria;
+}
+/**
+ * Builder for demographics search criteria
+ */
+export declare class DemographicsSearchCriteriaBuilder extends BaseBuilder<DemographicsSearchCriteria> {
+    protected criteria: DemographicsSearchCriteria;
+    static from(criteria: DemographicsSearchCriteria): DemographicsSearchCriteriaBuilder;
+    age(filter: NumericRangeFilter): this;
+    age(configurator: (builder: NumericRangeFilterBuilder) => void): this;
+    householdSize(filter: NumericRangeFilter): this;
+    householdSize(configurator: (builder: NumericRangeFilterBuilder) => void): this;
+    income(filter: NumericRangeFilter): this;
+    income(configurator: (builder: NumericRangeFilterBuilder) => void): this;
+    netWorth(filter: NumericRangeFilter): this;
+    netWorth(configurator: (builder: NumericRangeFilterBuilder) => void): this;
+    discretionaryIncome(filter: NumericRangeFilter): this;
+    discretionaryIncome(configurator: (builder: NumericRangeFilterBuilder) => void): this;
+    homeownerRenter(filter: StringFilter): this;
+    homeownerRenter(configurator: (builder: StringFilterBuilder) => void): this;
+    businessOwner(filter: StringFilter): this;
+    businessOwner(configurator: (builder: StringFilterBuilder) => void): this;
+    gender(filter: StringFilter): this;
+    gender(configurator: (builder: StringFilterBuilder) => void): this;
+    hasChildren(value: boolean): this;
+    investments(filter: StringFilter): this;
+    investments(configurator: (builder: StringFilterBuilder) => void): this;
+    demographics(filter: StringFilter): this;
+    demographics(configurator: (builder: StringFilterBuilder) => void): this;
+    religiousAffiliation(filter: StringFilter): this;
+    religiousAffiliation(configurator: (builder: StringFilterBuilder) => void): this;
+}
+/**
+ * Builder for foreclosure search criteria
+ */
+export declare class ForeclosureSearchCriteriaBuilder {
+    private criteria;
+    static from(criteria: ForeclosureSearchCriteria): ForeclosureSearchCriteriaBuilder;
+    status(filter: StringFilter): this;
+    status(configurator: (builder: StringFilterBuilder) => void): this;
+    recordingDate(filter: DateRangeFilter): this;
+    recordingDate(configurator: (builder: DateRangeFilterBuilder) => void): this;
+    auctionDate(filter: DateRangeFilter): this;
+    auctionDate(configurator: (builder: DateRangeFilterBuilder) => void): this;
+    releaseDate(filter: DateRangeFilter): this;
+    releaseDate(configurator: (builder: DateRangeFilterBuilder) => void): this;
+    auctionMinimumBidAmount(filter: NumericRangeFilter): this;
+    auctionMinimumBidAmount(configurator: (builder: NumericRangeFilterBuilder) => void): this;
+    pastDueAmount(filter: NumericRangeFilter): this;
+    pastDueAmount(configurator: (builder: NumericRangeFilterBuilder) => void): this;
+    build(): ForeclosureSearchCriteria;
+}
+/**
+ * Builder for general search criteria
+ */
+export declare class GeneralSearchCriteriaBuilder {
+    private criteria;
+    static from(criteria: GeneralSearchCriteria): GeneralSearchCriteriaBuilder;
+    propertyTypeCategory(filter: StringFilter): this;
+    propertyTypeCategory(configurator: (builder: StringFilterBuilder) => void): this;
+    propertyTypeDetail(filter: StringFilter): this;
+    propertyTypeDetail(configurator: (builder: StringFilterBuilder) => void): this;
+    build(): GeneralSearchCriteria;
+}
+/**
+ * Builder for IDs search criteria
+ */
+export declare class IdsSearchCriteriaBuilder {
+    private criteria;
+    static from(criteria: IdsSearchCriteria): IdsSearchCriteriaBuilder;
+    addressHash(filter: StringFilter): this;
+    addressHash(configurator: (builder: StringFilterBuilder) => void): this;
+    mailingAddressHash(filter: StringFilter): this;
+    mailingAddressHash(configurator: (builder: StringFilterBuilder) => void): this;
+    fipsCode(filter: StringFilter): this;
+    fipsCode(configurator: (builder: StringFilterBuilder) => void): this;
+    apn(filter: StringFilter): this;
+    apn(configurator: (builder: StringFilterBuilder) => void): this;
+    taxId(filter: StringFilter): this;
+    taxId(configurator: (builder: StringFilterBuilder) => void): this;
+    build(): IdsSearchCriteria;
+}
+/**
+ * Builder for intel search criteria
+ */
+export declare class IntelSearchCriteriaBuilder {
+    private criteria;
+    static from(criteria: IntelSearchCriteria): IntelSearchCriteriaBuilder;
+    lastSoldDate(filter: DateRangeFilter): this;
+    lastSoldDate(configurator: (builder: DateRangeFilterBuilder) => void): this;
+    lastSoldPrice(filter: NumericRangeFilter): this;
+    lastSoldPrice(configurator: (builder: NumericRangeFilterBuilder) => void): this;
+    salePropensity(filter: NumericRangeFilter): this;
+    salePropensity(configurator: (builder: NumericRangeFilterBuilder) => void): this;
+    build(): IntelSearchCriteria;
+}
+/**
+ * Builder for involuntary lien search criteria
+ */
+export declare class InvoluntaryLienSearchCriteriaBuilder {
+    private criteria;
+    static from(criteria: InvoluntaryLienSearchCriteria): InvoluntaryLienSearchCriteriaBuilder;
+    lienType(filter: StringFilter): this;
+    lienType(configurator: (builder: StringFilterBuilder) => void): this;
+    lienTypeCode(filter: StringFilter): this;
+    lienTypeCode(configurator: (builder: StringFilterBuilder) => void): this;
+    documentType(filter: StringFilter): this;
+    documentType(configurator: (builder: StringFilterBuilder) => void): this;
+    documentTypeCode(filter: StringFilter): this;
+    documentTypeCode(configurator: (builder: StringFilterBuilder) => void): this;
+    recordingDate(filter: DateRangeFilter): this;
+    recordingDate(configurator: (builder: DateRangeFilterBuilder) => void): this;
+    filingDate(filter: DateRangeFilter): this;
+    filingDate(configurator: (builder: DateRangeFilterBuilder) => void): this;
+    lienAmount(filter: NumericRangeFilter): this;
+    lienAmount(configurator: (builder: NumericRangeFilterBuilder) => void): this;
+    build(): InvoluntaryLienSearchCriteria;
+}
+/**
+ * Builder for legal search criteria
+ */
+export declare class LegalSearchCriteriaBuilder {
+    private criteria;
+    static from(criteria: LegalSearchCriteria): LegalSearchCriteriaBuilder;
+    subdivisionName(filter: StringFilter): this;
+    subdivisionName(configurator: (builder: StringFilterBuilder) => void): this;
+    build(): LegalSearchCriteria;
+}
+/**
+ * Builder for listing search criteria
+ */
+export declare class ListingSearchCriteriaBuilder {
+    private criteria;
+    static from(criteria: ListingSearchCriteria): ListingSearchCriteriaBuilder;
+    description(filter: StringFilter): this;
+    description(configurator: (builder: StringFilterBuilder) => void): this;
+    price(filter: NumericRangeFilter): this;
+    price(configurator: (builder: NumericRangeFilterBuilder) => void): this;
+    daysOnMarket(filter: NumericRangeFilter): this;
+    daysOnMarket(configurator: (builder: NumericRangeFilterBuilder) => void): this;
+    status(filter: StringFilter): this;
+    status(configurator: (builder: StringFilterBuilder) => void): this;
+    statusCategory(filter: StringFilter): this;
+    statusCategory(configurator: (builder: StringFilterBuilder) => void): this;
+    failedListingDate(filter: DateRangeFilter): this;
+    failedListingDate(configurator: (builder: DateRangeFilterBuilder) => void): this;
+    soldDate(filter: DateRangeFilter): this;
+    soldDate(configurator: (builder: DateRangeFilterBuilder) => void): this;
+    build(): ListingSearchCriteria;
+}
+/**
+ * Builder for lot search criteria
+ */
+export declare class LotSearchCriteriaBuilder {
+    private criteria;
+    static from(criteria: LotSearchCriteria): LotSearchCriteriaBuilder;
+    lotSizeAcres(filter: NumericRangeFilter): this;
+    lotSizeAcres(configurator: (builder: NumericRangeFilterBuilder) => void): this;
+    lotDepthFeet(filter: NumericRangeFilter): this;
+    lotDepthFeet(configurator: (builder: NumericRangeFilterBuilder) => void): this;
+    lotFrontageFeet(filter: NumericRangeFilter): this;
+    lotFrontageFeet(configurator: (builder: NumericRangeFilterBuilder) => void): this;
+    lotSizeSquareFeet(filter: NumericRangeFilter): this;
+    lotSizeSquareFeet(configurator: (builder: NumericRangeFilterBuilder) => void): this;
+    zoningCode(filter: StringFilter): this;
+    zoningCode(configurator: (builder: StringFilterBuilder) => void): this;
+    build(): LotSearchCriteria;
+}
+/**
+ * Builder for open lien search criteria
+ */
+export declare class OpenLienSearchCriteriaBuilder {
+    private criteria;
+    static from(criteria: OpenLienSearchCriteria): OpenLienSearchCriteriaBuilder;
+    allLoanTypes(filter: StringFilter): this;
+    juniorLoanTypes(filter: StringFilter): this;
+    totalOpenLienCount(filter: NumericRangeFilter): this;
+    totalOpenLienBalance(filter: NumericRangeFilter): this;
+    firstLoanLtv(filter: NumericRangeFilter): this;
+    firstLoanInterestRate(filter: NumericRangeFilter): this;
+    secondLoanInterestRate(filter: NumericRangeFilter): this;
+    thirdLoanInterestRate(filter: NumericRangeFilter): this;
+    fourthLoanInterestRate(filter: NumericRangeFilter): this;
+    firstLoanType(filter: StringFilter): this;
+    secondLoanType(filter: StringFilter): this;
+    thirdLoanType(filter: StringFilter): this;
+    fourthLoanType(filter: StringFilter): this;
+    firstLoanRecordingDate(filter: DateRangeFilter): this;
+    lastLoanRecordingDate(filter: DateRangeFilter): this;
+    build(): OpenLienSearchCriteria;
+}
+/**
+ * Builder for owner search criteria
+ */
+export declare class OwnerSearchCriteriaBuilder {
+    private criteria;
+    static from(criteria: OwnerSearchCriteria): OwnerSearchCriteriaBuilder;
+    firstName(filter: StringFilter): this;
+    lastName(filter: StringFilter): this;
+    ownerOccupied(value: boolean): this;
+    mailingStreet(filter: StringFilter): this;
+    mailingCity(filter: StringFilter): this;
+    mailingState(filter: StringFilter): this;
+    mailingZip(filter: StringFilter): this;
+    ownerStatusType(filter: StringFilter): this;
+    lengthOfResidenceMonths(filter: NumericRangeFilter): this;
+    lengthOfResidenceYears(filter: NumericRangeFilter): this;
+    ownershipStartDate(filter: DateRangeFilter): this;
+    mailingAddressHash(filter: StringFilter): this;
+    build(): OwnerSearchCriteria;
+}
+/**
+ * Builder for permit search criteria
+ */
+export declare class PermitSearchCriteriaBuilder {
+    private criteria;
+    static from(criteria: PermitSearchCriteria): PermitSearchCriteriaBuilder;
+    permitCount(filter: NumericRangeFilter): this;
+    latestDate(filter: DateRangeFilter): this;
+    earliestDate(filter: DateRangeFilter): this;
+    totalJobValue(filter: NumericRangeFilter): this;
+    allTags(filter: StringFilter): this;
+    build(): PermitSearchCriteria;
+}
+/**
+ * Builder for property owner profile search criteria
+ */
+export declare class PropertyOwnerProfileSearchCriteriaBuilder {
+    private criteria;
+    static from(criteria: PropertyOwnerProfileSearchCriteria): PropertyOwnerProfileSearchCriteriaBuilder;
+    propertiesCount(filter: NumericRangeFilter): this;
+    propertiesTotalEquity(filter: NumericRangeFilter): this;
+    propertiesTotalEstimatedValue(filter: NumericRangeFilter): this;
+    mortgagesTotalBalance(filter: NumericRangeFilter): this;
+    mortgagesCount(filter: NumericRangeFilter): this;
+    mortgagesAverageBalance(filter: NumericRangeFilter): this;
+    build(): PropertyOwnerProfileSearchCriteria;
+}
+/**
+ * Builder for sale search criteria
+ */
+export declare class SaleSearchCriteriaBuilder {
+    private criteria;
+    static from(criteria: SaleSearchCriteria): SaleSearchCriteriaBuilder;
+    lastSalePrice(filter: NumericRangeFilter): this;
+    lastSaleDate(filter: DateRangeFilter): this;
+    lastSaleDocumentType(filter: StringFilter): this;
+    lastSalePricePerSquareFoot(filter: NumericRangeFilter): this;
+    flipLength(filter: NumericRangeFilter): this;
+    flipLengthCategory(filter: NumericRangeFilter): this;
+    flipProfit(filter: NumericRangeFilter): this;
+    build(): SaleSearchCriteria;
+}
+/**
+ * Builder for tax search criteria
+ */
+export declare class TaxSearchCriteriaBuilder {
+    private criteria;
+    static from(criteria: TaxSearchCriteria): TaxSearchCriteriaBuilder;
+    taxDelinquentYear(filter: NumericRangeFilter): this;
+    build(): TaxSearchCriteria;
+}
+/**
+ * Builder for valuation search criteria
+ */
+export declare class ValuationSearchCriteriaBuilder {
+    private criteria;
+    static from(criteria: ValuationSearchCriteria): ValuationSearchCriteriaBuilder;
+    estimatedValue(filter: NumericRangeFilter): this;
+    ltv(filter: NumericRangeFilter): this;
+    equityPercent(filter: NumericRangeFilter): this;
+    build(): ValuationSearchCriteria;
+}
+/**
+ * Builder for OR search criteria
+ */
+export declare class OrSearchCriteriaBuilder {
+    private criteria;
+    static from(criteria: OrSearchCriteria): OrSearchCriteriaBuilder;
+    listing(): {
+        status(filter: StringFilter): StringFilter;
+    };
+    sale(): {
+        lastSaleDate(filter: DateRangeFilter): DateRangeFilter;
+    };
+    build(): OrSearchCriteria;
+}
+/**
+ * Main builder for search criteria
+ *
+ * Note: The API requires a query field (returns 400 without it), even when
+ * address filters are provided. Query appears to be a geographic scope string
+ * (e.g., "US", "AZ", "Maricopa County, AZ"). You can set it via constructor
+ * or using the query() method.
+ */
+export declare class SearchCriteriaBuilder extends BaseBuilder<SearchCriteria> {
+    protected criteria: Partial<SearchCriteria>;
+    /**
+     * Creates a new SearchCriteriaBuilder
+     *
+     * @param query - Geographic scope for the search (e.g., "US", "AZ", "Maricopa County, AZ").
+     *                This is required by the API even when address filters are provided.
+     *                The query defines the geographic boundary/scope for property searches.
+     */
+    constructor(query: string);
+    static from(criteria: SearchCriteria): SearchCriteriaBuilder;
+    /**
+     * Sets the geographic scope for the search
+     *
+     * @param value - Geographic scope string (e.g., "US", "AZ", "Maricopa County, AZ").
+     *                This defines the geographic boundary/scope for property searches.
+     *                Required by the API even when address filters are provided.
+     * @returns This builder instance for method chaining
+     */
+    query(value: string): this;
+    quickList(value: QuickListValueWithNot): this;
+    quickLists(values: QuickListValueWithNot[]): this;
+    orQuickLists(values: QuickListValueWithNot[]): this;
+    address(criteria: AddressSearchCriteria): this;
+    address(configurator: (builder: AddressSearchCriteriaBuilder) => void): this;
+    assessment(criteria: AssessmentSearchCriteria): this;
+    assessment(configurator: (builder: AssessmentSearchCriteriaBuilder) => void): this;
+    building(criteria: BuildingSearchCriteria): this;
+    building(configurator: (builder: BuildingSearchCriteriaBuilder) => void): this;
+    compAddress(criteria: CompAddressSearchCriteria): this;
+    compAddress(configurator: (builder: CompAddressSearchCriteriaBuilder) => void): this;
+    demographics(criteria: DemographicsSearchCriteria): this;
+    demographics(configurator: (builder: DemographicsSearchCriteriaBuilder) => void): this;
+    foreclosure(criteria: ForeclosureSearchCriteria): this;
+    foreclosure(configurator: (builder: ForeclosureSearchCriteriaBuilder) => void): this;
+    general(criteria: GeneralSearchCriteria): this;
+    general(configurator: (builder: GeneralSearchCriteriaBuilder) => void): this;
+    ids(criteria: IdsSearchCriteria): this;
+    ids(configurator: (builder: IdsSearchCriteriaBuilder) => void): this;
+    intel(criteria: IntelSearchCriteria): this;
+    intel(configurator: (builder: IntelSearchCriteriaBuilder) => void): this;
+    involuntaryLien(criteria: InvoluntaryLienSearchCriteria): this;
+    involuntaryLien(configurator: (builder: InvoluntaryLienSearchCriteriaBuilder) => void): this;
+    legal(criteria: LegalSearchCriteria): this;
+    legal(configurator: (builder: LegalSearchCriteriaBuilder) => void): this;
+    listing(criteria: ListingSearchCriteria): this;
+    listing(configurator: (builder: ListingSearchCriteriaBuilder) => void): this;
+    lot(criteria: LotSearchCriteria): this;
+    lot(configurator: (builder: LotSearchCriteriaBuilder) => void): this;
+    openLien(criteria: OpenLienSearchCriteria): this;
+    openLien(configurator: (builder: OpenLienSearchCriteriaBuilder) => void): this;
+    owner(criteria: OwnerSearchCriteria): this;
+    owner(configurator: (builder: OwnerSearchCriteriaBuilder) => void): this;
+    permit(criteria: PermitSearchCriteria): this;
+    permit(configurator: (builder: PermitSearchCriteriaBuilder) => void): this;
+    propertyOwnerProfile(criteria: PropertyOwnerProfileSearchCriteria): this;
+    propertyOwnerProfile(configurator: (builder: PropertyOwnerProfileSearchCriteriaBuilder) => void): this;
+    sale(criteria: SaleSearchCriteria): this;
+    sale(configurator: (builder: SaleSearchCriteriaBuilder) => void): this;
+    tax(criteria: TaxSearchCriteria): this;
+    tax(configurator: (builder: TaxSearchCriteriaBuilder) => void): this;
+    valuation(criteria: ValuationSearchCriteria): this;
+    valuation(configurator: (builder: ValuationSearchCriteriaBuilder) => void): this;
+    or(criteria: OrSearchCriteria[]): this;
+}
+/**
+ * Builder for delivery configuration
+ */
+export declare class DeliveryConfigBuilder {
+    private config;
+    static from(config: DeliveryConfig): DeliveryConfigBuilder;
+    webhook(url: string, headers?: Record<string, string>, errorUrl?: string): this;
+    kinesis(streamName: string, region: string, iamAccessKeyId: string, iamSecretAccessKey: string): this;
+    build(): DeliveryConfig;
+}
+/**
+ * Main builder for property subscription requests
+ */
+export declare class PropertySubscriptionBuilder extends BaseBuilder<PropertySubscriptionRequest> {
+    static from(request: PropertySubscriptionRequest): PropertySubscriptionBuilder;
+    searchCriteria(criteria: SearchCriteria): this;
+    searchCriteria(configurator: (builder: SearchCriteriaBuilder) => void): this;
+    deliveryConfig(config: DeliveryConfig): this;
+    deliveryConfig(configurator: (builder: DeliveryConfigBuilder) => void): this;
+    build(): PropertySubscriptionRequest;
+}
+/**
+ * Builder for property lookup request items
+ */
+export declare class PropertyLookupRequestItemBuilder {
+    private item;
+    static from(item: PropertyLookupRequestItem): PropertyLookupRequestItemBuilder;
+    address(address: PropertyLookupRequestAddress): this;
+    propertyId(propertyId: string): this;
+    hash(hash: string): this;
+    apn(apn: string): this;
+    countyFipsCode(countyFipsCode: string): this;
+    requestId(requestId: string): this;
+    build(): PropertyLookupRequestItem;
+}
+/**
+ * Builder for property lookup options
+ * PropertyLookupOptions has 40+ fields, so a builder provides a cleaner API
+ */
+export declare class PropertyLookupOptionsBuilder {
+    private options;
+    static from(options: PropertyLookupOptions): PropertyLookupOptionsBuilder;
+    pagination(skip: number, take: number): this;
+    skip(skip: number): this;
+    take(take: number): this;
+    showRequests(show: boolean): this;
+    areaPolygon(show: boolean): this;
+    quicklistCounts(show: boolean): this;
+    distance(miles?: number, yards?: number, feet?: number, kilometers?: number, meters?: number): this;
+    boundingBox(nw: GeoPoint, se: GeoPoint): this;
+    bedrooms(min?: number, max?: number): this;
+    bathrooms(min?: number, max?: number): this;
+    stories(min?: number, max?: number): this;
+    area(minPercent?: number, maxPercent?: number): this;
+    yearBuilt(min?: number, max?: number): this;
+    lotSize(minPercent?: number, maxPercent?: number): this;
+    skipTrace(enabled: boolean): this;
+    aggregateLoanTypes(enabled: boolean): this;
+    images(enabled: boolean): this;
+    dateFormat(format: string): this;
+    sort(field: string, order: "asc" | "desc" | "random", sessionId?: string): this;
+    useSubdivision(enabled: boolean): this;
+    build(): PropertyLookupOptions;
+}
+/**
+ * Builder for async property lookup options
+ * Extends PropertyLookupOptionsBuilder with async-specific methods like webhook
+ */
+export declare class AsyncPropertyLookupOptionsBuilder extends PropertyLookupOptionsBuilder {
+    static from(options: PropertyLookupOptions): AsyncPropertyLookupOptionsBuilder;
+    webhook(url: string, errorUrl?: string): this;
+}
+/**
+ * Builder for property lookup requests
+ */
+export declare class PropertyLookupRequestBuilder extends BaseBuilder<PropertyLookupRequest> {
+    private requestItems;
+    static from(request: PropertyLookupRequest): PropertyLookupRequestBuilder;
+    items(items: PropertyLookupRequestItem[]): this;
+    addItem(item: PropertyLookupRequestItem): this;
+    addItemBuilder(builder: PropertyLookupRequestItemBuilder): this;
+    options(options: PropertyLookupOptions): this;
+    options(configurator: (builder: PropertyLookupOptionsBuilder) => void): this;
+    build(): PropertyLookupRequest;
+}
+/**
+ * Builder for property search requests
+ */
+export declare class PropertySearchRequestBuilder extends BaseBuilder<PropertySearchRequest> {
+    static from(request: PropertySearchRequest): PropertySearchRequestBuilder;
+    searchCriteria(criteria: SearchCriteria): this;
+    searchCriteria(configurator: (builder: SearchCriteriaBuilder) => void): this;
+    options(options: PropertyLookupOptions): this;
+    options(configurator: (builder: PropertyLookupOptionsBuilder) => void): this;
+    build(): PropertySearchRequest;
+}
+/**
+ * Builder for property search async requests
+ */
+export declare class PropertySearchAsyncRequestBuilder extends BaseBuilder<PropertySearchAsyncRequest> {
+    static from(request: PropertySearchAsyncRequest): PropertySearchAsyncRequestBuilder;
+    searchCriteria(criteria: SearchCriteria): this;
+    searchCriteria(configurator: (builder: SearchCriteriaBuilder) => void): this;
+    options(options: PropertyLookupOptions): this;
+    options(configurator: (builder: PropertyLookupOptionsBuilder) => void): this;
+    build(): PropertySearchAsyncRequest;
+}
+/**
+ * Builder for property lookup async requests
+ */
+export declare class PropertyLookupAsyncRequestBuilder extends BaseBuilder<PropertyLookupAsyncRequest> {
+    private requestItems;
+    static from(request: PropertyLookupAsyncRequest): PropertyLookupAsyncRequestBuilder;
+    items(items: PropertyLookupRequestItem[]): this;
+    addItem(item: PropertyLookupRequestItem): this;
+    addItemBuilder(builder: PropertyLookupRequestItemBuilder): this;
+    options(options: PropertyLookupOptions): this;
+    options(configurator: (builder: PropertyLookupOptionsBuilder) => void): this;
+    build(): PropertyLookupAsyncRequest;
+}
+/**
+ * Builder for property permit request filters
+ */
+export declare class PropertyPermitRequestBuilder {
+    private request;
+    private options;
+    static from(permitRequest: PropertyPermitRequest): PropertyPermitRequestBuilder;
+    address(address: PropertyLookupRequestAddress): this;
+    hash(hash: string): this;
+    propertyId(propertyId: string): this;
+    apn(apn: string): this;
+    countyFipsCode(countyFipsCode: string): this;
+    allTags(filter: StringFilter): this;
+    allTagsBuilder(filter: StringFilter): this;
+    description(filter: StringFilter): this;
+    descriptionBuilder(filter: StringFilter): this;
+    endDate(filter: DateRangeFilter): this;
+    endDateBuilder(filter: DateRangeFilter): this;
+    fileDate(filter: DateRangeFilter): this;
+    fileDateBuilder(filter: DateRangeFilter): this;
+    finalDate(filter: DateRangeFilter): this;
+    finalDateBuilder(filter: DateRangeFilter): this;
+    issueDate(filter: DateRangeFilter): this;
+    issueDateBuilder(filter: DateRangeFilter): this;
+    jobValue(filter: NumericRangeFilter): this;
+    jobValueBuilder(filter: NumericRangeFilter): this;
+    startDate(filter: DateRangeFilter): this;
+    startDateBuilder(filter: DateRangeFilter): this;
+    status(filter: StringFilter): this;
+    statusBuilder(filter: StringFilter): this;
+    subType(filter: StringFilter): this;
+    subTypeBuilder(filter: StringFilter): this;
+    type(filter: StringFilter): this;
+    typeBuilder(filter: StringFilter): this;
+    pagination(skip: number, take: number): this;
+    skip(skip: number): this;
+    take(take: number): this;
+    sessionId(sessionId: string): this;
+    dateFormat(format: string): this;
+    showRequests(show: boolean): this;
+    showOptions(show: boolean): this;
+    showMeta(show: boolean): this;
+    sort(field: string, order: "asc" | "desc"): this;
+    build(): PropertyPermitRequest;
+}
+export {};