@land-catalyst/batch-data-sdk 1.2.6 → 1.2.9

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -7,15 +7,51 @@
7
7
  */
8
8
  /**
9
9
  * String filter operators for text-based search criteria
10
- */
11
- export interface StringFilter {
12
- equals?: string;
10
+ *
11
+ * @template T - Optional union type of allowed string values. Defaults to `string` for backward compatibility.
12
+ * When specified, provides type safety for fields with known possible values.
13
+ *
14
+ * @example
15
+ * // Basic usage (backward compatible)
16
+ * const filter: StringFilter = { equals: "any string" };
17
+ *
18
+ * @example
19
+ * // With allowed values for type safety
20
+ * type AirConditioningSource = "Central" | "Chilled Water" | "Evaporative Cooler";
21
+ * const filter: StringFilter<AirConditioningSource> = {
22
+ * equals: "Central", // ✅ Type-safe
23
+ * inList: ["Central", "Chilled Water"] // ✅ Type-safe
24
+ * };
25
+ */
26
+ export interface StringFilter<T extends string = string> {
27
+ /**
28
+ * Exact match - must be one of the allowed values when T is specified
29
+ */
30
+ equals?: T;
31
+ /**
32
+ * Pattern matching - allows any string for substring searches
33
+ */
13
34
  contains?: string;
35
+ /**
36
+ * Pattern matching - allows any string for prefix searches
37
+ */
14
38
  startsWith?: string;
39
+ /**
40
+ * Pattern matching - allows any string for suffix searches
41
+ */
15
42
  endsWith?: string;
16
- inList?: string[];
17
- notInList?: string[];
18
- matches?: string[];
43
+ /**
44
+ * Array of allowed values - elements must be one of the allowed values when T is specified
45
+ */
46
+ inList?: T[];
47
+ /**
48
+ * Array of excluded values - elements must be one of the allowed values when T is specified
49
+ */
50
+ notInList?: T[];
51
+ /**
52
+ * Array of pattern matches - elements must be one of the allowed values when T is specified
53
+ */
54
+ matches?: T[];
19
55
  }
20
56
  /**
21
57
  * Numeric range filter for numeric search criteria
@@ -97,43 +133,80 @@ export interface AssessmentSearchCriteria {
97
133
  improvementMarketValue?: NumericRangeFilter;
98
134
  totalMarketValue?: NumericRangeFilter;
99
135
  }
136
+ export type AirConditioningSource = "Central" | "Chilled Water" | "Evaporative Cooler" | "Geo-Thermal" | "None" | "Office only" | "Other" | "Packaged Unit" | "Partial" | "Refrigeration" | "Ventilation" | "Wall" | "Window Unit" | "Yes";
137
+ export type BasementType = "Basement (not specified)" | "Daylight" | "First FLoor" | "Daylight/Walkout" | "Full Basement" | "Improved Basement (Finished)" | "Partial" | "Partial Basement" | "Unfinished Basement";
138
+ export type BuildingClass = "Buildings having fireproofed reinforced concrete frames carrying all wall, floor and roof loads which are all non-combustible." | "Buildings having fireproofed structural steel frames carrying all wall, floor and roof loads. Wall, floor and roof structures are built of non-combustible materials." | "Buildings having wood or wood and steel frames." | "Exterior walls non-combustible material. Interior partitions and roof structure combustible materials. Floor concrete or wood frame." | "Specialized buildings that do not fit in any of the above categories.";
139
+ export type BuildingCondition = "Average" | "Excellent" | "Fair" | "Good" | "Poor" | "Unsound" | "Very Good";
140
+ export type BuildingQuality = "A" | "A+" | "A-" | "B" | "B+" | "B-" | "C" | "C+" | "C-" | "D" | "D+" | "D-" | "E" | "E+" | "E-";
141
+ export type ConstructionType = "Adobe" | "Brick" | "Concrete" | "Concrete Block" | "Dome" | "Frame" | "Heavy" | "Light" | "Log" | "Manufactured" | "Masonry" | "Metal" | "Mixed" | "Other" | "Steel" | "Stone" | "Tilt-Up" | "Wood";
142
+ export type Driveway = "Asphalt" | "Bomanite" | "Chat" | "Concrete" | "DBrick" | "Driveway" | "Gravel" | "Paver" | "Tile";
143
+ export type ExteriorWalls = "Adobe" | "Aluminum Siding" | "Asbestos Shingle" | "Block" | "Brick" | "Brick Veneer" | "Ceramic Tile" | "Clay Tile" | "Combination" | "Composition" | "Composition/Composite" | "Concrete" | "Concrete Block" | "Concrete Tile" | "EIFS/Synthetic Stucco" | "Fiber Cement Siding" | "Glass" | "Log" | "Marble" | "Masonry" | "Metal" | "Other" | "Rock" | "Shingle (Not Wood)" | "Siding (Alum/Vinyl)" | "Stucco" | "Tile" | "Tilt-up (pre-cast concrete)" | "Vinyl Siding" | "Wood" | "Wood Shingle" | "Wood Siding";
144
+ export type FloorCover = "Asbestos" | "Brick" | "Carpet" | "Ceramic" | "Combination" | "Concrete" | "Cork" | "Covered" | "Dirt/Earth/Soil" | "Epoxy" | "Faux Wood Tile" | "Finished Wood" | "Floating Floor/Laminate" | "Granite" | "Hardwood" | "Linoleum" | "Marble" | "Other" | "Parquet" | "Plywood" | "Slate" | "Softwood" | "Stone" | "Terrazzo" | "Tile" | "Vinyl";
145
+ export type Garage = "Attached Garage" | "Built-in" | "Carport" | "Covered" | "Detached Garage" | "Finished" | "Finished Attached" | "Finished Detached" | "Garage" | "Heated" | "Mixed" | "None" | "Offsite" | "Open" | "Parking Lot" | "Parking Structure" | "Paved/Surfaced" | "Pole" | "Ramp" | "Tuckunder" | "Underground/Basement" | "Unfinished Attached" | "Unfinished Detached" | "Unimproved";
146
+ export type HeatSource = "Baseboard" | "Central" | "Coal" | "Convection" | "Electric" | "Floor/Wall" | "Forced Air Unit" | "Gas" | "Geo-Thermal" | "Gravity" | "Heat Pump" | "Hot Water" | "None" | "Oil" | "Other" | "Partial" | "Propane" | "Radiant" | "Solar" | "Space/Suspended" | "Steam" | "Vent" | "Wood Burning" | "Yes" | "Zone";
147
+ export type HeatingFuelType = "Butane" | "Coal" | "Electric" | "Gas" | "Geo-Thermal" | "None" | "Oil" | "Propane" | "Solar" | "Wood";
148
+ export type InteriorWalls = "Block" | "Brick" | "Cement Board" | "Composition" | "Concrete" | "Decorative/Custom" | "Finished/Painted" | "Glass" | "Gypsum Board" | "Log" | "Masonry" | "Metal" | "Minimum/Plywood" | "Other" | "Paneling" | "Plaster" | "Stone" | "Unfinished" | "Vinyl" | "Wood";
149
+ export type Patio = "Patio" | "Patio - Screened";
150
+ export type Features = "ARBOR/PERGOLA" | "Above-Ground Pool" | "Air Conditioning" | "Alarm System" | "Atrium" | "Attached Garage" | "Audio Sound System" | "Automatic Sprinkler System (irrigation)" | "BOAT LIFT/DAVITS" | "Basketball/Sport Court" | "Boat Dock/Ramp" | "Built-in Garage" | "Carport" | "Cellar" | "Central Air Conditioning" | "Central Vacuum System" | "Chilled Water Air Conditioning" | "Club House" | "Community Pool or Spa" | "Covered Garage" | "Covered Porch" | "Detached Garage" | "Enclosed Pool" | "Evaporative Cooler" | "Exercise Room/Home Gym" | "Fire Sprinkler" | "Fireplace" | "Game/Recreation Room" | "Garage" | "Geo-Thermal Air Conditioning" | "Geo-Thermal Heat" | "Golf Course/Green" | "HANDICAP RAMP/ACCESSIBLE" | "Heated Pool" | "Indoor Pool" | "Intercom System" | "Koi Pond" | "Lanai" | "MOBILE HOME HOOKUP" | "Media Room/Home Theater" | "OVERHEAD DOOR" | "Outdoor Kitchen/Fireplace" | "Panic Room" | "Parking Structure" | "Partial Air Conditioning" | "Patio" | "Pole Garage" | "Pool" | "Porch" | "Portico" | "RV parking" | "Refrigeration Air Conditioning" | "SAUNA/STEAM ROOM" | "STORM/SECURITY SHUTTERS" | "Safe Room/Panic Room" | "Screened Porch" | "Solar Heat" | "Solar Heated Pool" | "Spa" | "Spa or Hot Tub" | "Storm or Tornado Shelter/Cellar" | "Study Library" | "Sun Room" | "Tennis Court" | "Tuckunder Garage" | "Underground/Basement Garage" | "Vinyl In-Ground Pool" | "Wall Air Conditioning" | "Water Feature" | "Wet Bar" | "Wine Cellar";
151
+ export type Pool = "Above-Ground Pool" | "Community Pool or Spa" | "Enclosed" | "Heated Pool" | "In-Ground Pool" | "Indoor Pool" | "Pool & Spa" | "Pool - Yes" | "Solar Heated" | "Spa or Hot Tub (only)" | "Vinyl In-Ground Pool";
152
+ export type Porch = "Porch" | "Porch - Open" | "Porch covered" | "Porch screened" | "Portico (Drive Under)";
153
+ export type RoofCover = "Aluminum" | "Asbestos" | "Asphalt" | "Bermuda" | "Built-Up" | "Ceramic Tile" | "Clay Tile" | "Composition Shingle" | "Concrete" | "Concrete Tile" | "Copper" | "Fiberglass" | "Gravel/Rock" | "Gypsum" | "Masonite/ Cement Shake" | "Metal" | "Other" | "Roll Composition" | "Shingle (Not Wood)" | "Slate" | "Solar" | "Steel" | "Tar & Gravel" | "Tile" | "Tin" | "Urethane" | "Wood" | "Wood Shake/ Shingles";
154
+ export type RoofType = "Bowstring Truss" | "Dome" | "Flat" | "Gable" | "Gable or Hip" | "Gambrel" | "Hip" | "Irr/Cathedral" | "Mansard" | "Prestress Concrete" | "Reinforced Concrete" | "Rigid Frame Bar Joist" | "Sawtooth" | "Shed" | "Steel Frame/Truss" | "Wood Truss";
155
+ export type Sewer = "Municipal" | "None" | "Septic" | "Storm" | "Yes";
156
+ export type Style = "A-Frame" | "Bi-Level" | "Bungalow" | "Cape Cod" | "Cluster" | "Colonial" | "Condominium" | "Contemporary" | "Conventional" | "Cottage" | "Custom" | "Dome" | "Duplex" | "English" | "European" | "French Provincial" | "Georgian" | "High-rise" | "Historical" | "Log Cabin/Rustic" | "Mansion" | "Mediterranean" | "Mobile Home" | "Mobile/Manufactured" | "Modern" | "MultiFamily" | "Other" | "Patio Home" | "Prefab/Modular" | "Quadplex" | "Raised Ranch" | "Ranch/Rambler" | "Row Home" | "Shotgun" | "Spanish" | "Split Foyer" | "Split Level" | "Tiny House" | "TownHouse" | "Traditional" | "Tri-Level" | "Triplex" | "Tudor" | "Unfinished-Under Construction" | "Victorian" | "unknown";
157
+ export type WaterService = "Cistern" | "Municipal" | "None" | "Spring" | "Well" | "Yes";
158
+ export type BusinessOwner = "Accountant" | "Builder" | "Contractor" | "Dealer/Retailer/Storekeeper" | "Distributor/Wholesaler" | "Funeral Director" | "Maker/Manufacturer" | "Owner" | "Partner" | "Self-Employed";
159
+ export type DemographicsValue = "Business Owner" | "Female" | "Has Children" | "Home Owner" | "Male" | "Married" | "Millionaire" | "New Home Owner" | "Pet Owner" | "Recently Moved" | "Religious" | "Renter" | "Single" | "Single Parent" | "Smoker";
160
+ export type Gender = "Female" | "Male";
161
+ export type HomeownerRenter = "Home Owner" | "Renter";
162
+ export type Investments = "Foreign" | "Investment Properties" | "Personal" | "Real Estate" | "Stocks and Bonds";
163
+ export type ReligiousAffiliation = "All" | "Buddhist" | "Catholic" | "Eastern Orthodox" | "Ethiopian Orthodox" | "Greek Orthodox" | "Hindu" | "Islamic" | "Jewish" | "Lutheran" | "Mormon" | "Other" | "Protestant" | "Shinto" | "Sikh";
164
+ export type ForeclosureStatus = "Cancel Due to length of Time and Auction Date" | "Notice of Default and Lis Pendens" | "Notice of Sale" | "Notice of Trustee Sale and Final Judgement" | "REO Release" | "Rescission Recording" | "Rescission Release" | "Transfer Release";
165
+ export type PropertyTypeCategory = "Agricultural" | "Commercial" | "Exempt" | "Industrial" | "Miscellaneous" | "Office" | "Recreational" | "Residential" | "Vacant Land";
166
+ export type PropertyTypeDetail = "Agricultural/Rural" | "Airport" | "Apartment House (5+ Units)" | "Apartments" | "Auto Repair or Garage" | "Bar or Tavern" | "Barber or Hair Salon" | "Boarding House or Rooming House" | "Boat Slips" | "Bulk Storage Tanks" | "Bungalow" | "Cabin" | "Campground or RV Park" | "Car Wash" | "Cemetery" | "Centrally Assessed" | "Charitable or Fraternal Organization" | "Church" | "City" | "Club" | "Cluster Home" | "College" | "Commercial" | "Commercial Building" | "Commercial Condominium (Not Offices)" | "Commercial Office" | "Commercial/Office/Residential (Mixed Use)" | "Commerical/Industrial (Mixed Use)" | "Common Area" | "Community Center" | "Community Shopping Center" | "Condominium Building" | "Condominium Offices" | "Condominium Unit" | "Construction or Contracting Services" | "Convenience Store" | "Cooperative Unit" | "Country Club" | "County Owned" | "Court Apartment (5+ Units)" | "Crop Land" | "Cultural or Historical" | "Dairy Farm" | "Day Care or Preschool Facility" | "Dental Building" | "Department Store" | "Distribution Warehouse" | "Dormitory" | "Drugstore or Pharmacy" | "Duplex" | "Easement" | "Emergency" | "Equipment or Supplies" | "Exempt" | "Factory" | "Farm" | "Fast Food Restaurant or Drive-Through" | "Federal Property" | "Fields or Row Crops" | "Financial Building or Bank" | "Florist" | "Forest" | "Freeway or State Highway" | "Full or Partial" | "Funeral Home or Mortuary" | "Garden Apartment" | "Garden Home" | "Gas Station" | "General" | "Golf Course" | "Government Administrative Office" | "Governmental" | "Governmental or Public Use" | "Grocery or Supermarket" | "Gym or Health Spa" | "Harbor & Marine Transportation" | "Heavy Industrial" | "Heavy Manufacturing" | "High-Rise Apartment" | "Horticulture or Growing Houses" | "Hotel" | "Hotel Resort" | "Hotel/Motel" | "Industrial" | "Industrial Loft Building" | "Industrial Park" | "Institutional" | "Institutional (General)" | "Inventory" | "Irrigation or Flood Control" | "Laboratory or Research Facility" | "Landominium" | "Leasehold Rights" | "Library or Art Gallery" | "Light Industrial" | "Light Manufacturing" | "Livestock Parcel" | "Lodge or Professional Association" | "Lumber or Building Materials Yard" | "Mail Order Showroom or Commercial Warehouse" | "Marina or Yacht Club" | "Marsh or Swamp" | "Medical Building or Clinic" | "Medical Clinic" | "Military" | "Mini-Warehouse or Self-Storage" | "Mining Facility" | "Miscellaneous Residential Improvement" | "Miscellaneous Structures" | "Mobile Home Park or Trailer Park" | "Mobile/Manufactured Home" | "Module or Prefabricated Homes" | "Motel" | "Multi-Family" | "Multi-Family Dwelling" | "Municipal" | "Museum" | "Native American Lands" | "Natural Resources" | "Neighborhood Shopping Center" | "Nightclub or Cocktail Lounge" | "Nursery or Greenhouse" | "Office Building (General)" | "Orchard" | "Other Exempt Property" | "Parcel with Improvements" | "Park" | "Parking Garage or Structure" | "Parking Lot" | "Parochial or Private School" | "Pasture or Meadow" | "Patio Home" | "Personal Property" | "Petroleum & Gas Wells" | "Pipeline or Right-of-Way" | "Planned Unit Development" | "Playground or Picnic Area" | "Plaza or Mini-Mall" | "Possessory Interest" | "Post Office" | "Private Hospital" | "Private Preserve or Open Space" | "Private Utility" | "Processing Plant" | "Professional Building" | "Public College or University" | "Public Hospital" | "Public School" | "Public Utility" | "Quadruplex" | "Quarry" | "R&D" | "Radio or TV Statio" | "Railroad" | "Ranch" | "Range Land" | "Recreation Center" | "Recreational" | "Recreational/Entertainment" | "Redevelopment Agency or Zone" | "Regional Shopping Center or Mall" | "Regulating Districts & Assessments" | "Religious" | "Resevoir or Water Supply" | "Residential" | "Residential Common Area" | "Residential Condominium Development" | "Residential Income (Multi-Family)" | "Residential Parking Garage" | "Residential Storage Space" | "Restaurant" | "Retail Stores" | "Retail/Residential (Mixed Use)" | "Right-of-Way" | "Road" | "Road Right-of-Way" | "Row House" | "Royalty Interest" | "Rural Improved (Non-Residential)" | "Rural/Agricultural" | "Rurual/Agricultural Residence" | "Seasonal" | "Service Shop" | "Service Station" | "Service Station with Food Mart" | "Single Family" | "Skyscraper or High-Rise (Commercial Offices)" | "Social Service or Low Income Housing" | "Special Purpose" | "State Board of Equalization - Special Assessments" | "State Owned" | "Storage Yard" | "Store (Multi-Story)" | "Store/Office" | "Street or Bridge" | "Strip Mall or Enterprise Zone" | "Structures on Leased Land" | "Sub-Surface Rights" | "Surface Rights" | "Telephone or Telegraph Facility" | "Theater" | "Timberland or Forest" | "Timeshare" | "Town or Village Owned" | "Townhouse" | "Transportation & Communications" | "Triplex" | "Truck Crops" | "Truck Terminal" | "Under Construction" | "University or Vocational School" | "Unspecified Improvement" | "Unusable Land" | "Utilities" | "Vacation Residence" | "Vehicle Rental and Sales" | "Veterinary Clinic or Animal Hospital" | "Vineyard" | "Warehouse (Industrial)" | "Waste Disposal or Sewage Plant" | "Waste Land" | "Welfare" | "Wholesale Outlet or Discount Store" | "Working Interest" | "Worship" | "Zero Lot Line";
167
+ export type ZoningCode = "01 - NOT Z" | "01-SINGLE" | "0100:SINGL" | "02 - SINGL" | "1" | "10" | "2F" | "A" | "A-1" | "A1" | "A2" | "AG" | "AR" | "B" | "C" | "C1" | "C2" | "COMMERCIAL" | "GR" | "LAR1" | "LDR" | "M-H" | "MDR" | "MPUD" | "P-D" | "PAD" | "PD" | "PUD" | "R" | "R-1" | "R-10" | "R-15" | "R-1A" | "R-1C" | "R-2" | "R-20" | "R-3" | "R-4" | "R-40" | "R-5" | "R-6" | "R-7" | "R-8" | "R1" | "R1-8" | "R10" | "R12" | "R15" | "R16" | "R1A" | "R1B" | "R1C" | "R2" | "R20" | "R2A" | "R3" | "R3-2" | "R3A" | "R4" | "R4-RESIDEN" | "R40" | "R5" | "R5-RESIDEN" | "R6" | "R60" | "R7" | "R75" | "R8" | "RA" | "RB" | "RC" | "RD" | "RD-5" | "RES" | "RESIDENTIA" | "RI" | "RL" | "RLD-60" | "RM" | "RM1" | "RPD" | "RR" | "RS" | "RS-1" | "RS-1-7" | "RS2" | "RS3" | "RS6" | "RSA5" | "RSF" | "RSF3.5" | "RT" | "SF 5000" | "SF-5" | "SFR" | "SINGLE-FAM" | "SR" | "U/05/00" | "Z298" | "ZO01";
168
+ export type LienType = "Assessment Lien" | "Economic Lien" | "Federal Tax Lien" | "Mechanic's Lien" | "Other" | "State Tax Lien" | "Support Lien";
169
+ export type LienTypeCode = "A" | "B" | "C" | "D" | "E" | "F" | "G";
170
+ export type LoanType = "2nd Mortgage made to cover Down Payment" | "ARM (Adjustable Rate Mortgage as of August, 2009)" | "Amount keyed is an Aggregate amount" | "Assumption" | "Balloon" | "Building or Construction Loan" | "Cash" | "Closed-end Mortgage" | "Commercial" | "Construction Loan" | "Conventional" | "Credit Line (Revolving)" | "FHA" | "Fannie Mae/Freddie Mac" | "Farmers Home Administration" | "Future Advance Clause / Open End Mortgage" | "Future-Advance Mortgage" | "Land Contract" | "Land Contract (Argmt. Of Sale)" | "Line of Credit" | "Loan Amount $1-9 billion" | "Loan Amount $10-99 billion" | "Misc Residential Improvement" | "Modification - Effective as of December 2008" | "Negative Amortization" | "New Conventional" | "Non Purchase Money Mortgage" | "Purchase Money Mortgage" | "Real Conventional" | "Reverse Mortgage" | "Reverse Mortgage (Home Equity Conversion Mortgage)" | "SBA Participation Trust Deed" | "Seller Caryback" | "Seller take-back" | "Stand Alone First" | "Stand Alone Refi (Refinance of Original Loan)" | "Stand Alone Second" | "Standalone Refinance" | "State Veterans" | "USDA" | "Undefined/Multiple Amounts" | "Unknown & Other" | "Unknown (DEFAULT)" | "VA";
171
+ export type OwnerStatusType = "Company Owned" | "Individual";
172
+ export type LastSaleDocumentType = "Administrator's Deed" | "Affidavit" | "Affidavit - Notice of Sale" | "Affidavit Death of Trustee/Successor Trustee (Los Angeles)" | "Affidavit of Death of Joint Tenant" | "Affidavit of Death of Life Tenant" | "Affidavit of Trust or Trust Agreement (Los Angeles)" | "Agreement of Sale" | "Assessor Sales History" | "Assignment Deed (or Condo Deed if Land Use = CND)" | "Assignment of Agreement of Sale (Hawaii)" | "Assignment of Commercial Lease (Hawaii)" | "Assignment of Final Judgement of Foreclosure" | "Assignment of Lease (Leasehold Sale) (Hawaii)" | "Assignment of Sub Agreement of Sale (Hawaii)" | "Assignment of Sub Commercial Lease (Hawaii)" | "Assignment of Sub Lease (Hawaii)" | "Bargain and Sale Deed" | "Beneficiary Deed" | "Beneficiary Deed (Buyer ID = BE)" | "Cancellation of Agreement of Sale (Hawaii)" | "Cash Sale Deed" | "Certificate of Transfer" | "Commercial Lease" | "Commercial Lease (Hawaii)" | "Commissioner's Deed - North Carolina in probate-related transfers. In Hawaii foreclosure-related transfers." | "Commissioners Assignment of Lease (Hawaii)" | "Condominium Deed" | "Conservator's Deed" | "Contract of Sale" | "Corporation Deed" | "Correction Deed" | "Correction Document" | "Declaration" | "Deed" | "Deed in Lieu of Foreclosure" | "Deed of Distribution" | "Deed of Guardian" | "Distress Sale" | "Divorce/Dissolution of Marriage Transfer" | "Exchange" | "Executor's Deed" | "Fiduciary Deed" | "Foreclosure" | "Gift Deed" | "Grant Deed" | "Ground Lease" | "Individual Deed" | "Intra-Familty Transfer" | "Intra-Family Transfer" | "Intrafamily Transfer" | "Intrafamily Transfer & Dissolution" | "Joint Tenancy Deed" | "Land Contract" | "Land Court (Massachusetts)" | "Lease" | "Lease (Hawaii)" | "Leasehold Conv. With Agreement of Sale (Fee Purchase) (Hawaii)" | "Leasehold Conv. with an Agreement of Sale (Hawaii)" | "Legal Action/Court Order" | "Limited Warranty Deed" | "Mineral Rights Deed" | "Mortgage" | "Other" | "Owelty Deed/Owelty Agreement" | "Partial Release of Lis Pendens" | "Partnership Deed" | "Personal Representatives Deed" | "Power of Attorney to Foreclosure Mortgage" | "PreForeclosure Sold" | "Public Action - Common in Florida (Clerks Tax Deed or Tax Deeds or property sold for taxes." | "Quit Claim Deed" | "Quit Claim Deed (arm's length)" | "REO Sale (REO Out)" | "Re-Recorded Partial Release of Lis Pendens" | "Re-Recorded Power of Attorney to Foreclosure" | "Re-recorded Document" | "Receiver's Deed" | "Redemption Deed" | "Referee's Deed - transfer pursuant to a foreclosure sale (NY)" | "Release/Satisfaction of Agreement of Sale (Leasehold) (Hawaii)" | "Satisfaction of Land Contract (WI) or Release/Satisfaction of Agreement of Sale (Fee Property) (HI)" | "Sheriff's Deed" | "Special Master Deed" | "Special Warranty Deed" | "Sub Agreement of Sale (Hawaii)" | "Sub Commercial Lease (Hawaii)" | "Sub Lease" | "Sub Lease (Hawaii)" | "Survivorship Deed" | "Survivorship Deed/Survivorship Property Agreement" | "Transaction History Record" | "Transfer on Death Deed" | "Trustee's Deed" | "Trustee's Deed (Certificate of Title)" | "Vendor's Lien" | "Warranty Deed";
100
173
  /**
101
174
  * Building search criteria
102
175
  */
103
176
  export interface BuildingSearchCriteria {
104
- airConditioningSource?: StringFilter;
105
- basementType?: StringFilter;
177
+ airConditioningSource?: StringFilter<AirConditioningSource>;
178
+ basementType?: StringFilter<BasementType>;
106
179
  totalBuildingAreaSquareFeet?: NumericRangeFilter;
107
- buildingClass?: StringFilter;
108
- buildingCondition?: StringFilter;
109
- buildingQuality?: StringFilter;
180
+ buildingClass?: StringFilter<BuildingClass>;
181
+ buildingCondition?: StringFilter<BuildingCondition>;
182
+ buildingQuality?: StringFilter<BuildingQuality>;
110
183
  buildingType?: StringFilter;
111
- driveway?: StringFilter;
112
- exteriorWalls?: StringFilter;
113
- floorCover?: StringFilter;
184
+ driveway?: StringFilter<Driveway>;
185
+ exteriorWalls?: StringFilter<ExteriorWalls>;
186
+ floorCover?: StringFilter<FloorCover>;
114
187
  garageParkingSpaceCount?: NumericRangeFilter;
115
- garage?: StringFilter;
116
- heatSource?: StringFilter;
117
- heatingFuelType?: StringFilter;
118
- interiorWalls?: StringFilter;
188
+ garage?: StringFilter<Garage>;
189
+ heatSource?: StringFilter<HeatSource>;
190
+ heatingFuelType?: StringFilter<HeatingFuelType>;
191
+ interiorWalls?: StringFilter<InteriorWalls>;
119
192
  buildingCount?: NumericRangeFilter;
120
193
  bathroomCount?: NumericRangeFilter;
121
194
  calculatedBathroomCount?: NumericRangeFilter;
122
195
  bedroomCount?: NumericRangeFilter;
123
- patio?: StringFilter;
196
+ patio?: StringFilter<Patio>;
124
197
  storyCount?: NumericRangeFilter;
125
- features?: StringFilter;
198
+ features?: StringFilter<Features>;
126
199
  residentialUnitCount?: NumericRangeFilter;
127
- pool?: StringFilter;
128
- porch?: StringFilter;
129
- roofCover?: StringFilter;
130
- roofType?: StringFilter;
131
- sewer?: StringFilter;
132
- style?: StringFilter;
200
+ pool?: StringFilter<Pool>;
201
+ porch?: StringFilter<Porch>;
202
+ roofCover?: StringFilter<RoofCover>;
203
+ roofType?: StringFilter<RoofType>;
204
+ sewer?: StringFilter<Sewer>;
205
+ style?: StringFilter<Style>;
133
206
  roomCount?: NumericRangeFilter;
134
207
  unitCount?: NumericRangeFilter;
135
- constructionType?: StringFilter;
136
- waterService?: StringFilter;
208
+ constructionType?: StringFilter<ConstructionType>;
209
+ waterService?: StringFilter<WaterService>;
137
210
  yearBuilt?: NumericRangeFilter;
138
211
  }
139
212
  /**
@@ -155,21 +228,21 @@ export interface DemographicsSearchCriteria {
155
228
  income?: NumericRangeFilter;
156
229
  netWorth?: NumericRangeFilter;
157
230
  discretionaryIncome?: NumericRangeFilter;
158
- homeownerRenter?: StringFilter;
159
- businessOwner?: StringFilter;
160
- gender?: StringFilter;
231
+ homeownerRenter?: StringFilter<HomeownerRenter>;
232
+ businessOwner?: StringFilter<BusinessOwner>;
233
+ gender?: StringFilter<Gender>;
161
234
  hasChildren?: {
162
235
  equals: boolean;
163
236
  };
164
- investments?: StringFilter;
165
- demographics?: StringFilter;
166
- religiousAffiliation?: StringFilter;
237
+ investments?: StringFilter<Investments>;
238
+ demographics?: StringFilter<DemographicsValue>;
239
+ religiousAffiliation?: StringFilter<ReligiousAffiliation>;
167
240
  }
168
241
  /**
169
242
  * Foreclosure search criteria
170
243
  */
171
244
  export interface ForeclosureSearchCriteria {
172
- status?: StringFilter;
245
+ status?: StringFilter<ForeclosureStatus>;
173
246
  recordingDate?: DateRangeFilter;
174
247
  auctionDate?: DateRangeFilter;
175
248
  releaseDate?: DateRangeFilter;
@@ -180,8 +253,8 @@ export interface ForeclosureSearchCriteria {
180
253
  * General property search criteria
181
254
  */
182
255
  export interface GeneralSearchCriteria {
183
- propertyTypeCategory?: StringFilter;
184
- propertyTypeDetail?: StringFilter;
256
+ propertyTypeCategory?: StringFilter<PropertyTypeCategory>;
257
+ propertyTypeDetail?: StringFilter<PropertyTypeDetail>;
185
258
  }
186
259
  /**
187
260
  * IDs search criteria
@@ -205,8 +278,8 @@ export interface IntelSearchCriteria {
205
278
  * Involuntary lien search criteria
206
279
  */
207
280
  export interface InvoluntaryLienSearchCriteria {
208
- lienType?: StringFilter;
209
- lienTypeCode?: StringFilter;
281
+ lienType?: StringFilter<LienType>;
282
+ lienTypeCode?: StringFilter<LienTypeCode>;
210
283
  documentType?: StringFilter;
211
284
  documentTypeCode?: StringFilter;
212
285
  recordingDate?: DateRangeFilter;
@@ -239,14 +312,14 @@ export interface LotSearchCriteria {
239
312
  lotDepthFeet?: NumericRangeFilter;
240
313
  lotFrontageFeet?: NumericRangeFilter;
241
314
  lotSizeSquareFeet?: NumericRangeFilter;
242
- zoningCode?: StringFilter;
315
+ zoningCode?: StringFilter<ZoningCode>;
243
316
  }
244
317
  /**
245
318
  * Open lien search criteria
246
319
  */
247
320
  export interface OpenLienSearchCriteria {
248
- allLoanTypes?: StringFilter;
249
- juniorLoanTypes?: StringFilter;
321
+ allLoanTypes?: StringFilter<LoanType>;
322
+ juniorLoanTypes?: StringFilter<LoanType>;
250
323
  totalOpenLienCount?: NumericRangeFilter;
251
324
  totalOpenLienBalance?: NumericRangeFilter;
252
325
  firstLoanLtv?: NumericRangeFilter;
@@ -254,10 +327,10 @@ export interface OpenLienSearchCriteria {
254
327
  secondLoanInterestRate?: NumericRangeFilter;
255
328
  thirdLoanInterestRate?: NumericRangeFilter;
256
329
  fourthLoanInterestRate?: NumericRangeFilter;
257
- firstLoanType?: StringFilter;
258
- secondLoanType?: StringFilter;
259
- thirdLoanType?: StringFilter;
260
- fourthLoanType?: StringFilter;
330
+ firstLoanType?: StringFilter<LoanType>;
331
+ secondLoanType?: StringFilter<LoanType>;
332
+ thirdLoanType?: StringFilter<LoanType>;
333
+ fourthLoanType?: StringFilter<LoanType>;
261
334
  firstLoanRecordingDate?: DateRangeFilter;
262
335
  lastLoanRecordingDate?: DateRangeFilter;
263
336
  }
@@ -274,7 +347,7 @@ export interface OwnerSearchCriteria {
274
347
  mailingCity?: StringFilter;
275
348
  mailingState?: StringFilter;
276
349
  mailingZip?: StringFilter;
277
- ownerStatusType?: StringFilter;
350
+ ownerStatusType?: StringFilter<OwnerStatusType>;
278
351
  lengthOfResidenceMonths?: NumericRangeFilter;
279
352
  lengthOfResidenceYears?: NumericRangeFilter;
280
353
  ownershipStartDate?: DateRangeFilter;
@@ -307,7 +380,7 @@ export interface PropertyOwnerProfileSearchCriteria {
307
380
  export interface SaleSearchCriteria {
308
381
  lastSalePrice?: NumericRangeFilter;
309
382
  lastSaleDate?: DateRangeFilter;
310
- lastSaleDocumentType?: StringFilter;
383
+ lastSaleDocumentType?: StringFilter<LastSaleDocumentType>;
311
384
  lastSalePricePerSquareFoot?: NumericRangeFilter;
312
385
  flipLength?: NumericRangeFilter;
313
386
  flipLengthCategory?: NumericRangeFilter;
@@ -1654,6 +1727,22 @@ export interface PropertySearchRequest {
1654
1727
  searchCriteria: SearchCriteria;
1655
1728
  options?: PropertyLookupOptions;
1656
1729
  }
1730
+ /**
1731
+ * Property count request
1732
+ *
1733
+ * Used specifically for getting property counts without fetching property data.
1734
+ * This type does NOT include options to prevent accidental property data fetching
1735
+ * (which incurs charges). For count-only requests, use this type instead of
1736
+ * PropertySearchRequest to ensure no property data is retrieved.
1737
+ *
1738
+ * Note: All filtering needed for an accurate count should be specified in
1739
+ * searchCriteria. PropertyLookupOptions contains some duplicate filter fields
1740
+ * (useBedrooms, useBathrooms, useYearBuilt, etc.) that mirror SearchCriteria fields,
1741
+ * but these are redundant and should not be needed for accurate counts.
1742
+ */
1743
+ export interface PropertyCountRequest {
1744
+ searchCriteria: SearchCriteria;
1745
+ }
1657
1746
  /**
1658
1747
  * Property lookup request
1659
1748
  */
@@ -17,6 +17,53 @@
17
17
  * Property field data type
18
18
  */
19
19
  export type PropertyFieldType = "string" | "number" | "boolean" | "date" | "array[string]" | "array[number]" | "object";
20
+ /**
21
+ * Constants for possible field values - shared across multiple fields
22
+ * This reduces redundancy and LLM context size
23
+ */
24
+ export declare const POSSIBLE_VALUES_CONSTANTS: {
25
+ readonly AirConditioningSource: readonly ["Central", "Chilled Water", "Evaporative Cooler", "Geo-Thermal", "None", "Office only", "Other", "Packaged Unit", "Partial", "Refrigeration", "Ventilation", "Wall", "Window Unit", "Yes"];
26
+ readonly BasementType: readonly ["Basement (not specified)", "Daylight", "First FLoor", "Daylight/Walkout", "Full Basement", "Improved Basement (Finished)", "Partial", "Partial Basement", "Unfinished Basement"];
27
+ readonly BuildingClass: readonly ["Buildings having fireproofed reinforced concrete frames carrying all wall, floor and roof loads which are all non-combustible.", "Buildings having fireproofed structural steel frames carrying all wall, floor and roof loads. Wall, floor and roof structures are built of non-combustible materials.", "Buildings having wood or wood and steel frames.", "Exterior walls non-combustible material. Interior partitions and roof structure combustible materials. Floor concrete or wood frame.", "Specialized buildings that do not fit in any of the above categories."];
28
+ readonly BuildingCondition: readonly ["Average", "Excellent", "Fair", "Good", "Poor", "Unsound", "Very Good"];
29
+ readonly BuildingQuality: readonly ["A", "A+", "A-", "B", "B+", "B-", "C", "C+", "C-", "D", "D+", "D-", "E", "E+", "E-"];
30
+ readonly ConstructionType: readonly ["Adobe", "Brick", "Concrete", "Concrete Block", "Dome", "Frame", "Heavy", "Light", "Log", "Manufactured", "Masonry", "Metal", "Mixed", "Other", "Steel", "Stone", "Tilt-Up", "Wood"];
31
+ readonly Driveway: readonly ["Asphalt", "Bomanite", "Chat", "Concrete", "DBrick", "Driveway", "Gravel", "Paver", "Tile"];
32
+ readonly ExteriorWalls: readonly ["Adobe", "Aluminum Siding", "Asbestos Shingle", "Block", "Brick", "Brick Veneer", "Ceramic Tile", "Clay Tile", "Combination", "Composition", "Composition/Composite", "Concrete", "Concrete Block", "Concrete Tile", "EIFS/Synthetic Stucco", "Fiber Cement Siding", "Glass", "Log", "Marble", "Masonry", "Metal", "Other", "Rock", "Shingle (Not Wood)", "Siding (Alum/Vinyl)", "Stucco", "Tile", "Tilt-up (pre-cast concrete)", "Vinyl Siding", "Wood", "Wood Shingle", "Wood Siding"];
33
+ readonly FloorCover: readonly ["Asbestos", "Brick", "Carpet", "Ceramic", "Combination", "Concrete", "Cork", "Covered", "Dirt/Earth/Soil", "Epoxy", "Faux Wood Tile", "Finished Wood", "Floating Floor/Laminate", "Granite", "Hardwood", "Linoleum", "Marble", "Other", "Parquet", "Plywood", "Slate", "Softwood", "Stone", "Terrazzo", "Tile", "Vinyl"];
34
+ readonly Garage: readonly ["Attached Garage", "Built-in", "Carport", "Covered", "Detached Garage", "Finished", "Finished Attached", "Finished Detached", "Garage", "Heated", "Mixed", "None", "Offsite", "Open", "Parking Lot", "Parking Structure", "Paved/Surfaced", "Pole", "Ramp", "Tuckunder", "Underground/Basement", "Unfinished Attached", "Unfinished Detached", "Unimproved"];
35
+ readonly HeatSource: readonly ["Baseboard", "Central", "Coal", "Convection", "Electric", "Floor/Wall", "Forced Air Unit", "Gas", "Geo-Thermal", "Gravity", "Heat Pump", "Hot Water", "None", "Oil", "Other", "Partial", "Propane", "Radiant", "Solar", "Space/Suspended", "Steam", "Vent", "Wood Burning", "Yes", "Zone"];
36
+ readonly HeatingFuelType: readonly ["Butane", "Coal", "Electric", "Gas", "Geo-Thermal", "None", "Oil", "Propane", "Solar", "Wood"];
37
+ readonly InteriorWalls: readonly ["Block", "Brick", "Cement Board", "Composition", "Concrete", "Decorative/Custom", "Finished/Painted", "Glass", "Gypsum Board", "Log", "Masonry", "Metal", "Minimum/Plywood", "Other", "Paneling", "Plaster", "Stone", "Unfinished", "Vinyl", "Wood"];
38
+ readonly Patio: readonly ["Patio", "Patio - Screened"];
39
+ readonly Features: readonly ["ARBOR/PERGOLA", "Above-Ground Pool", "Air Conditioning", "Alarm System", "Atrium", "Attached Garage", "Audio Sound System", "Automatic Sprinkler System (irrigation)", "BOAT LIFT/DAVITS", "Basketball/Sport Court", "Boat Dock/Ramp", "Built-in Garage", "Carport", "Cellar", "Central Air Conditioning", "Central Vacuum System", "Chilled Water Air Conditioning", "Club House", "Community Pool or Spa", "Covered Garage", "Covered Porch", "Detached Garage", "Enclosed Pool", "Evaporative Cooler", "Exercise Room/Home Gym", "Fire Sprinkler", "Fireplace", "Game/Recreation Room", "Garage", "Geo-Thermal Air Conditioning", "Geo-Thermal Heat", "Golf Course/Green", "HANDICAP RAMP/ACCESSIBLE", "Heated Pool", "Indoor Pool", "Intercom System", "Koi Pond", "Lanai", "MOBILE HOME HOOKUP", "Media Room/Home Theater", "OVERHEAD DOOR", "Outdoor Kitchen/Fireplace", "Panic Room", "Parking Structure", "Partial Air Conditioning", "Patio", "Pole Garage", "Pool", "Porch", "Portico", "RV parking", "Refrigeration Air Conditioning", "SAUNA/STEAM ROOM", "STORM/SECURITY SHUTTERS", "Safe Room/Panic Room", "Screened Porch", "Solar Heat", "Solar Heated Pool", "Spa", "Spa or Hot Tub", "Storm or Tornado Shelter/Cellar", "Study Library", "Sun Room", "Tennis Court", "Tuckunder Garage", "Underground/Basement Garage", "Vinyl In-Ground Pool", "Wall Air Conditioning", "Water Feature", "Wet Bar", "Wine Cellar"];
40
+ readonly Pool: readonly ["Above-Ground Pool", "Community Pool or Spa", "Enclosed", "Heated Pool", "In-Ground Pool", "Indoor Pool", "Pool & Spa", "Pool - Yes", "Solar Heated", "Spa or Hot Tub (only)", "Vinyl In-Ground Pool"];
41
+ readonly Porch: readonly ["Porch", "Porch - Open", "Porch covered", "Porch screened", "Portico (Drive Under)"];
42
+ readonly RoofCover: readonly ["Aluminum", "Asbestos", "Asphalt", "Bermuda", "Built-Up", "Ceramic Tile", "Clay Tile", "Composition Shingle", "Concrete", "Concrete Tile", "Copper", "Fiberglass", "Gravel/Rock", "Gypsum", "Masonite/ Cement Shake", "Metal", "Other", "Roll Composition", "Shingle (Not Wood)", "Slate", "Solar", "Steel", "Tar & Gravel", "Tile", "Tin", "Urethane", "Wood", "Wood Shake/ Shingles"];
43
+ readonly RoofType: readonly ["Bowstring Truss", "Dome", "Flat", "Gable", "Gable or Hip", "Gambrel", "Hip", "Irr/Cathedral", "Mansard", "Prestress Concrete", "Reinforced Concrete", "Rigid Frame Bar Joist", "Sawtooth", "Shed", "Steel Frame/Truss", "Wood Truss"];
44
+ readonly Sewer: readonly ["Municipal", "None", "Septic", "Storm", "Yes"];
45
+ readonly Style: readonly ["A-Frame", "Bi-Level", "Bungalow", "Cape Cod", "Cluster", "Colonial", "Condominium", "Contemporary", "Conventional", "Cottage", "Custom", "Dome", "Duplex", "English", "European", "French Provincial", "Georgian", "High-rise", "Historical", "Log Cabin/Rustic", "Mansion", "Mediterranean", "Mobile Home", "Mobile/Manufactured", "Modern", "MultiFamily", "Other", "Patio Home", "Prefab/Modular", "Quadplex", "Raised Ranch", "Ranch/Rambler", "Row Home", "Shotgun", "Spanish", "Split Foyer", "Split Level", "Tiny House", "TownHouse", "Traditional", "Tri-Level", "Triplex", "Tudor", "Unfinished-Under Construction", "Victorian", "unknown"];
46
+ readonly WaterService: readonly ["Cistern", "Municipal", "None", "Spring", "Well", "Yes"];
47
+ readonly BusinessOwner: readonly ["Accountant", "Builder", "Contractor", "Dealer/Retailer/Storekeeper", "Distributor/Wholesaler", "Funeral Director", "Maker/Manufacturer", "Owner", "Partner", "Self-Employed"];
48
+ readonly DemographicsValue: readonly ["Business Owner", "Female", "Has Children", "Home Owner", "Male", "Married", "Millionaire", "New Home Owner", "Pet Owner", "Recently Moved", "Religious", "Renter", "Single", "Single Parent", "Smoker"];
49
+ readonly Gender: readonly ["Female", "Male"];
50
+ readonly HomeownerRenter: readonly ["Home Owner", "Renter"];
51
+ readonly Investments: readonly ["Foreign", "Investment Properties", "Personal", "Real Estate", "Stocks and Bonds"];
52
+ readonly ReligiousAffiliation: readonly ["All", "Buddhist", "Catholic", "Eastern Orthodox", "Ethiopian Orthodox", "Greek Orthodox", "Hindu", "Islamic", "Jewish", "Lutheran", "Mormon", "Other", "Protestant", "Shinto", "Sikh"];
53
+ readonly ForeclosureStatus: readonly ["Cancel Due to length of Time and Auction Date", "Notice of Default and Lis Pendens", "Notice of Sale", "Notice of Trustee Sale and Final Judgement", "REO Release", "Rescission Recording", "Rescission Release", "Transfer Release"];
54
+ readonly PropertyTypeCategory: readonly ["Agricultural", "Commercial", "Exempt", "Industrial", "Miscellaneous", "Office", "Recreational", "Residential", "Vacant Land"];
55
+ readonly PropertyTypeDetail: readonly ["Agricultural/Rural", "Airport", "Apartment House (5+ Units)", "Apartments", "Auto Repair or Garage", "Bar or Tavern", "Barber or Hair Salon", "Boarding House or Rooming House", "Boat Slips", "Bulk Storage Tanks", "Bungalow", "Cabin", "Campground or RV Park", "Car Wash", "Cemetery", "Centrally Assessed", "Charitable or Fraternal Organization", "Church", "City", "Club", "Cluster Home", "College", "Commercial", "Commercial Building", "Commercial Condominium (Not Offices)", "Commercial Office", "Commercial/Office/Residential (Mixed Use)", "Commerical/Industrial (Mixed Use)", "Common Area", "Community Center", "Community Shopping Center", "Condominium Building", "Condominium Offices", "Condominium Unit", "Construction or Contracting Services", "Convenience Store", "Cooperative Unit", "Country Club", "County Owned", "Court Apartment (5+ Units)", "Crop Land", "Cultural or Historical", "Dairy Farm", "Day Care or Preschool Facility", "Dental Building", "Department Store", "Distribution Warehouse", "Dormitory", "Drugstore or Pharmacy", "Duplex", "Easement", "Emergency", "Equipment or Supplies", "Exempt", "Factory", "Farm", "Fast Food Restaurant or Drive-Through", "Federal Property", "Fields or Row Crops", "Financial Building or Bank", "Florist", "Forest", "Freeway or State Highway", "Full or Partial", "Funeral Home or Mortuary", "Garden Apartment", "Garden Home", "Gas Station", "General", "Golf Course", "Government Administrative Office", "Governmental", "Governmental or Public Use", "Grocery or Supermarket", "Gym or Health Spa", "Harbor & Marine Transportation", "Heavy Industrial", "Heavy Manufacturing", "High-Rise Apartment", "Horticulture or Growing Houses", "Hotel", "Hotel Resort", "Hotel/Motel", "Industrial", "Industrial Loft Building", "Industrial Park", "Institutional", "Institutional (General)", "Inventory", "Irrigation or Flood Control", "Laboratory or Research Facility", "Landominium", "Leasehold Rights", "Library or Art Gallery", "Light Industrial", "Light Manufacturing", "Livestock Parcel", "Lodge or Professional Association", "Lumber or Building Materials Yard", "Mail Order Showroom or Commercial Warehouse", "Marina or Yacht Club", "Marsh or Swamp", "Medical Building or Clinic", "Medical Clinic", "Military", "Mini-Warehouse or Self-Storage", "Mining Facility", "Miscellaneous Residential Improvement", "Miscellaneous Structures", "Mobile Home Park or Trailer Park", "Mobile/Manufactured Home", "Module or Prefabricated Homes", "Motel", "Multi-Family", "Multi-Family Dwelling", "Municipal", "Museum", "Native American Lands", "Natural Resources", "Neighborhood Shopping Center", "Nightclub or Cocktail Lounge", "Nursery or Greenhouse", "Office Building (General)", "Orchard", "Other Exempt Property", "Parcel with Improvements", "Park", "Parking Garage or Structure", "Parking Lot", "Parochial or Private School", "Pasture or Meadow", "Patio Home", "Personal Property", "Petroleum & Gas Wells", "Pipeline or Right-of-Way", "Planned Unit Development", "Playground or Picnic Area", "Plaza or Mini-Mall", "Possessory Interest", "Post Office", "Private Hospital", "Private Preserve or Open Space", "Private Utility", "Processing Plant", "Professional Building", "Public College or University", "Public Hospital", "Public School", "Public Utility", "Quadruplex", "Quarry", "R&D", "Radio or TV Statio", "Railroad", "Ranch", "Range Land", "Recreation Center", "Recreational", "Recreational/Entertainment", "Redevelopment Agency or Zone", "Regional Shopping Center or Mall", "Regulating Districts & Assessments", "Religious", "Resevoir or Water Supply", "Residential", "Residential Common Area", "Residential Condominium Development", "Residential Income (Multi-Family)", "Residential Parking Garage", "Residential Storage Space", "Restaurant", "Retail Stores", "Retail/Residential (Mixed Use)", "Right-of-Way", "Road", "Road Right-of-Way", "Row House", "Royalty Interest", "Rural Improved (Non-Residential)", "Rural/Agricultural", "Rurual/Agricultural Residence", "Seasonal", "Service Shop", "Service Station", "Service Station with Food Mart", "Single Family", "Skyscraper or High-Rise (Commercial Offices)", "Social Service or Low Income Housing", "Special Purpose", "State Board of Equalization - Special Assessments", "State Owned", "Storage Yard", "Store (Multi-Story)", "Store/Office", "Street or Bridge", "Strip Mall or Enterprise Zone", "Structures on Leased Land", "Sub-Surface Rights", "Surface Rights", "Telephone or Telegraph Facility", "Theater", "Timberland or Forest", "Timeshare", "Town or Village Owned", "Townhouse", "Transportation & Communications", "Triplex", "Truck Crops", "Truck Terminal", "Under Construction", "University or Vocational School", "Unspecified Improvement", "Unusable Land", "Utilities", "Vacation Residence", "Vehicle Rental and Sales", "Veterinary Clinic or Animal Hospital", "Vineyard", "Warehouse (Industrial)", "Waste Disposal or Sewage Plant", "Waste Land", "Welfare", "Wholesale Outlet or Discount Store", "Working Interest", "Worship", "Zero Lot Line"];
56
+ readonly ZoningCode: readonly ["01 - NOT Z", "01-SINGLE", "0100:SINGL", "02 - SINGL", "1", "10", "2F", "A", "A-1", "A1", "A2", "AG", "AR", "B", "C", "C1", "C2", "COMMERCIAL", "GR", "LAR1", "LDR", "M-H", "MDR", "MPUD", "P-D", "PAD", "PD", "PUD", "R", "R-1", "R-10", "R-15", "R-1A", "R-1C", "R-2", "R-20", "R-3", "R-4", "R-40", "R-5", "R-6", "R-7", "R-8", "R1", "R1-8", "R10", "R12", "R15", "R16", "R1A", "R1B", "R1C", "R2", "R20", "R2A", "R3", "R3-2", "R3A", "R4", "R4-RESIDEN", "R40", "R5", "R5-RESIDEN", "R6", "R60", "R7", "R75", "R8", "RA", "RB", "RC", "RD", "RD-5", "RES", "RESIDENTIA", "RI", "RL", "RLD-60", "RM", "RM1", "RPD", "RR", "RS", "RS-1", "RS-1-7", "RS2", "RS3", "RS6", "RSA5", "RSF", "RSF3.5", "RT", "SF 5000", "SF-5", "SFR", "SINGLE-FAM", "SR", "U/05/00", "Z298", "ZO01"];
57
+ readonly LienType: readonly ["Assessment Lien", "Economic Lien", "Federal Tax Lien", "Mechanic's Lien", "Other", "State Tax Lien", "Support Lien"];
58
+ readonly LienTypeCode: readonly ["A", "B", "C", "D", "E", "F", "G"];
59
+ readonly LoanType: readonly ["2nd Mortgage made to cover Down Payment", "ARM (Adjustable Rate Mortgage as of August, 2009)", "Amount keyed is an Aggregate amount", "Assumption", "Balloon", "Building or Construction Loan", "Cash", "Closed-end Mortgage", "Commercial", "Construction Loan", "Conventional", "Credit Line (Revolving)", "FHA", "Fannie Mae/Freddie Mac", "Farmers Home Administration", "Future Advance Clause / Open End Mortgage", "Future-Advance Mortgage", "Land Contract", "Land Contract (Argmt. Of Sale)", "Line of Credit", "Loan Amount $1-9 billion", "Loan Amount $10-99 billion", "Misc Residential Improvement", "Modification - Effective as of December 2008", "Negative Amortization", "New Conventional", "Non Purchase Money Mortgage", "Purchase Money Mortgage", "Real Conventional", "Reverse Mortgage", "Reverse Mortgage (Home Equity Conversion Mortgage)", "SBA Participation Trust Deed", "Seller Caryback", "Seller take-back", "Stand Alone First", "Stand Alone Refi (Refinance of Original Loan)", "Stand Alone Second", "Standalone Refinance", "State Veterans", "USDA", "Undefined/Multiple Amounts", "Unknown & Other", "Unknown (DEFAULT)", "VA"];
60
+ readonly OwnerStatusType: readonly ["Company Owned", "Individual"];
61
+ readonly AddressValidity: readonly ["Valid", "Invalid", "Partially Valid"];
62
+ readonly StateAbbreviation: readonly ["AA", "AB", "AE", "AK", "AL", "AP", "AR", "AS", "AU", "AZ", "BC", "BR", "CA", "CH", "CN", "CO", "CT", "CZ", "DC", "DE", "DF", "FL", "FR", "GA", "GB", "GE", "GU", "HI", "HO", "IA", "ID", "IL", "IN", "IS", "IT", "JA", "JP", "KR", "KS", "KU", "KY", "LA", "MA", "MB", "MD", "ME", "MH", "MI", "MN", "MO", "MP", "MS", "MT", "MX", "NB", "NC", "ND", "NE", "NH", "NJ", "NL", "NM", "NS", "NV", "NY", "OH", "OK", "ON", "OR", "PA", "PE", "PH", "PR", "QC", "RI", "SC", "SD", "SG", "SI", "SK", "SO", "SW", "TA", "TH", "TN", "TW", "TX", "UK", "UN", "UT", "VA", "VI", "VT", "WA", "WI", "WV", "WY", "XX", "YO", "YT"];
63
+ readonly FlipLengthCategory: readonly ["12", "24", "3", "6"];
64
+ readonly LastSaleDocumentType: readonly ["Administrator's Deed", "Affidavit", "Affidavit - Notice of Sale", "Affidavit Death of Trustee/Successor Trustee (Los Angeles)", "Affidavit of Death of Joint Tenant", "Affidavit of Death of Life Tenant", "Affidavit of Trust or Trust Agreement (Los Angeles)", "Agreement of Sale", "Assessor Sales History", "Assignment Deed (or Condo Deed if Land Use = CND)", "Assignment of Agreement of Sale (Hawaii)", "Assignment of Commercial Lease (Hawaii)", "Assignment of Final Judgement of Foreclosure", "Assignment of Lease (Leasehold Sale) (Hawaii)", "Assignment of Sub Agreement of Sale (Hawaii)", "Assignment of Sub Commercial Lease (Hawaii)", "Assignment of Sub Lease (Hawaii)", "Bargain and Sale Deed", "Beneficiary Deed", "Beneficiary Deed (Buyer ID = BE)", "Cancellation of Agreement of Sale (Hawaii)", "Cash Sale Deed", "Certificate of Transfer", "Commercial Lease", "Commercial Lease (Hawaii)", "Commissioner's Deed - North Carolina in probate-related transfers. In Hawaii foreclosure-related transfers.", "Commissioners Assignment of Lease (Hawaii)", "Condominium Deed", "Conservator's Deed", "Contract of Sale", "Corporation Deed", "Correction Deed", "Correction Document", "Declaration", "Deed", "Deed in Lieu of Foreclosure", "Deed of Distribution", "Deed of Guardian", "Distress Sale", "Divorce/Dissolution of Marriage Transfer", "Exchange", "Executor's Deed", "Fiduciary Deed", "Foreclosure", "Gift Deed", "Grant Deed", "Ground Lease", "Individual Deed", "Intra-Familty Transfer", "Intra-Family Transfer", "Intrafamily Transfer", "Intrafamily Transfer & Dissolution", "Joint Tenancy Deed", "Land Contract", "Land Court (Massachusetts)", "Lease", "Lease (Hawaii)", "Leasehold Conv. With Agreement of Sale (Fee Purchase) (Hawaii)", "Leasehold Conv. with an Agreement of Sale (Hawaii)", "Legal Action/Court Order", "Limited Warranty Deed", "Mineral Rights Deed", "Mortgage", "Other", "Owelty Deed/Owelty Agreement", "Partial Release of Lis Pendens", "Partnership Deed", "Personal Representatives Deed", "Power of Attorney to Foreclosure Mortgage", "PreForeclosure Sold", "Public Action - Common in Florida (Clerks Tax Deed or Tax Deeds or property sold for taxes.", "Quit Claim Deed", "Quit Claim Deed (arm's length)", "REO Sale (REO Out)", "Re-Recorded Partial Release of Lis Pendens", "Re-Recorded Power of Attorney to Foreclosure", "Re-recorded Document", "Receiver's Deed", "Redemption Deed", "Referee's Deed - transfer pursuant to a foreclosure sale (NY)", "Release/Satisfaction of Agreement of Sale (Leasehold) (Hawaii)", "Satisfaction of Land Contract (WI) or Release/Satisfaction of Agreement of Sale (Fee Property) (HI)", "Sheriff's Deed", "Special Master Deed", "Special Warranty Deed", "Sub Agreement of Sale (Hawaii)", "Sub Commercial Lease (Hawaii)", "Sub Lease", "Sub Lease (Hawaii)", "Survivorship Deed", "Survivorship Deed/Survivorship Property Agreement", "Transaction History Record", "Transfer on Death Deed", "Trustee's Deed", "Trustee's Deed (Certificate of Title)", "Vendor's Lien", "Warranty Deed"];
65
+ readonly QuickList: readonly ["absentee-owner", "active-auction", "active-listing", "bankruptcy", "canceled-listing", "cash-buyer", "corporate-owned", "divorce", "expired-listing", "fix-and-flip", "free-and-clear", "has-hoa-fees", "high-equity", "in-state-absentee-owner", "inherited", "involuntary-lien", "liens", "listed-below-market-price", "low-equity", "mailing-address-vacant", "notice-of-default", "notice-of-default-or-lis-pendens", "notice-of-sale", "notice-of-trustee-sale", "on-market", "out-of-state-absentee-owner", "out-of-state-owner", "owner-occupied", "pending-listing", "preforeclosure", "recently-sold", "same-property-and-mailing-address", "senior-owner", "tax-default", "tired-landlord", "unknown-equity", "vacant"];
66
+ };
20
67
  /**
21
68
  * Property field metadata entry
22
69
  */
@@ -53,11 +100,21 @@ export interface PropertyFieldMetadata {
53
100
  * Whether this field is an array element (indicated by [n] in the path)
54
101
  */
55
102
  isArrayElement: boolean;
103
+ /**
104
+ * Reference to a shared constant of possible values
105
+ */
106
+ possibleValuesRef?: keyof typeof POSSIBLE_VALUES_CONSTANTS;
56
107
  }
57
108
  /**
58
109
  * Registry of all property field metadata, indexed by field path
59
110
  */
60
111
  export declare const PROPERTY_FIELD_METADATA: Record<string, PropertyFieldMetadata>;
112
+ /**
113
+ * Get the resolved possible values for a field
114
+ * @param metadata The field metadata
115
+ * @returns The array of possible values, or undefined if none
116
+ */
117
+ export declare function getPossibleValues(metadata: PropertyFieldMetadata): string[] | undefined;
61
118
  /**
62
119
  * Get metadata for a specific field path
63
120
  * @param fieldPath The field path (e.g., "address.city")