@land-catalyst/batch-data-sdk 1.4.0 → 1.5.1
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.
- package/dist/core/types.d.ts +104 -2
- package/package.json +1 -1
package/dist/core/types.d.ts
CHANGED
|
@@ -1147,6 +1147,11 @@ export interface OpenLienMortgage {
|
|
|
1147
1147
|
assignedLenderName?: string;
|
|
1148
1148
|
ltv?: number;
|
|
1149
1149
|
estimatedPaymentAmount?: number;
|
|
1150
|
+
transactionType?: string;
|
|
1151
|
+
transactionTypeCode?: string;
|
|
1152
|
+
adjustableRateIndex?: string;
|
|
1153
|
+
firstChangeDateYearConversionRider?: number;
|
|
1154
|
+
firstChangeDateMonthConversionRider?: number;
|
|
1150
1155
|
}
|
|
1151
1156
|
/**
|
|
1152
1157
|
* Open lien information
|
|
@@ -1252,14 +1257,103 @@ export interface Owner {
|
|
|
1252
1257
|
dnc?: OwnerDNC;
|
|
1253
1258
|
}
|
|
1254
1259
|
/**
|
|
1255
|
-
* Property owner profile
|
|
1260
|
+
* Property owner profile - information about the owner's property portfolio
|
|
1256
1261
|
*/
|
|
1257
1262
|
export interface PropertyOwnerProfile {
|
|
1263
|
+
/** Average assessed value of properties owned by the property owner */
|
|
1264
|
+
averageAssessedValue?: number;
|
|
1265
|
+
/** Average purchase price of properties owned by the property owner */
|
|
1266
|
+
averagePurchasePrice?: number;
|
|
1267
|
+
/** Average year built of properties owned by the property owner */
|
|
1258
1268
|
averageYearBuilt?: number;
|
|
1269
|
+
/** Total number of properties owned by the property owner */
|
|
1259
1270
|
propertiesCount?: number;
|
|
1271
|
+
/** Total equity in all properties owned */
|
|
1272
|
+
propertiesTotalEquity?: number;
|
|
1273
|
+
/** Total estimated value of all properties owned */
|
|
1274
|
+
propertiesTotalEstimatedValue?: number;
|
|
1275
|
+
/** Total balance of all mortgages */
|
|
1260
1276
|
mortgagesTotalBalance?: number;
|
|
1277
|
+
/** Total number of open liens (mortgages) held by the property owner */
|
|
1261
1278
|
mortgagesCount?: number;
|
|
1279
|
+
/** Average mortgage balance across all properties */
|
|
1262
1280
|
mortgagesAverageBalance?: number;
|
|
1281
|
+
/** Total purchase price of all properties owned */
|
|
1282
|
+
totalPurchasePrice?: number;
|
|
1283
|
+
}
|
|
1284
|
+
/**
|
|
1285
|
+
* Permit tag values for allTags array
|
|
1286
|
+
*/
|
|
1287
|
+
export type PermitTag = "roofing" | "remodel" | "electrical" | "plumbing" | "hvac" | "solar" | "addition" | "kitchen" | "bathroom";
|
|
1288
|
+
/**
|
|
1289
|
+
* Permit tags - boolean flags for each permit type
|
|
1290
|
+
*/
|
|
1291
|
+
export interface PermitTags {
|
|
1292
|
+
/** Property has at least one permit that adds new square feet */
|
|
1293
|
+
addition?: boolean;
|
|
1294
|
+
/** Property has at least one permit involving a secondary unit, cottage, in-law suite, or ADU */
|
|
1295
|
+
adu?: boolean;
|
|
1296
|
+
/** Property has at least one permit that involved a bathroom */
|
|
1297
|
+
bathroom?: boolean;
|
|
1298
|
+
/** Property has at least one permit that involved a battery */
|
|
1299
|
+
battery?: boolean;
|
|
1300
|
+
/** Property has at least one permit that involved any demolition */
|
|
1301
|
+
demolition?: boolean;
|
|
1302
|
+
/** Property has at least one permit that involved an electrical meter */
|
|
1303
|
+
electricMeter?: boolean;
|
|
1304
|
+
/** Property has at least one permit that involved electrical work */
|
|
1305
|
+
electrical?: boolean;
|
|
1306
|
+
/** Property has at least one permit that involved an EV charger */
|
|
1307
|
+
evCharger?: boolean;
|
|
1308
|
+
/** Property has at least one permit that involved a fire sprinkler */
|
|
1309
|
+
fireSprinkler?: boolean;
|
|
1310
|
+
/** Property has at least one permit that involved gas */
|
|
1311
|
+
gas?: boolean;
|
|
1312
|
+
/** Property has at least one permit that involved a generator */
|
|
1313
|
+
generator?: boolean;
|
|
1314
|
+
/** Property has at least one permit that involved grading */
|
|
1315
|
+
grading?: boolean;
|
|
1316
|
+
/** Property has at least one permit involving a mini-split, heat pump, or related technology */
|
|
1317
|
+
heatPump?: boolean;
|
|
1318
|
+
/** Property has at least one permit that involved heating, ventilation, or air conditioning */
|
|
1319
|
+
hvac?: boolean;
|
|
1320
|
+
/** Property has inspections that have passed */
|
|
1321
|
+
inspectionPassed?: boolean;
|
|
1322
|
+
/** Property has at least one permit that involved a kitchen */
|
|
1323
|
+
kitchen?: boolean;
|
|
1324
|
+
/** Property has at least one permit that included any new construction */
|
|
1325
|
+
newConstruction?: boolean;
|
|
1326
|
+
/** Property has at least one permit that involved any type of plumbing */
|
|
1327
|
+
plumbing?: boolean;
|
|
1328
|
+
/** Property has at least one permit that involved a pool or hot tub */
|
|
1329
|
+
poolAndHotTub?: boolean;
|
|
1330
|
+
/** Property has at least one permit that involved a remodel */
|
|
1331
|
+
remodel?: boolean;
|
|
1332
|
+
/** Property has at least one permit that involved roofing */
|
|
1333
|
+
roofing?: boolean;
|
|
1334
|
+
/** Property has at least one permit that involved solar */
|
|
1335
|
+
solar?: boolean;
|
|
1336
|
+
/** Property has at least one permit that involved a water heater */
|
|
1337
|
+
waterHeater?: boolean;
|
|
1338
|
+
/** Property has at least one permit that involved windows or doors */
|
|
1339
|
+
windowDoor?: boolean;
|
|
1340
|
+
}
|
|
1341
|
+
/**
|
|
1342
|
+
* Permit information for a property
|
|
1343
|
+
*/
|
|
1344
|
+
export interface Permit {
|
|
1345
|
+
/** Total number of permits registered to the property */
|
|
1346
|
+
permitCount?: number;
|
|
1347
|
+
/** Date of the most recent permit */
|
|
1348
|
+
latestDate?: string;
|
|
1349
|
+
/** Date of the oldest permit */
|
|
1350
|
+
earliestDate?: string;
|
|
1351
|
+
/** Total job value for all permits */
|
|
1352
|
+
totalJobValue?: number;
|
|
1353
|
+
/** Array of all permit types that have been taken out on the property */
|
|
1354
|
+
allTags?: PermitTag[];
|
|
1355
|
+
/** Permit tags - boolean flags for each permit type */
|
|
1356
|
+
tags?: PermitTags;
|
|
1263
1357
|
}
|
|
1264
1358
|
/**
|
|
1265
1359
|
* Quick lists flags
|
|
@@ -1406,7 +1500,7 @@ export interface Property {
|
|
|
1406
1500
|
mortgageHistory?: MortgageHistoryEntry[];
|
|
1407
1501
|
openLien?: OpenLien;
|
|
1408
1502
|
owner?: Owner;
|
|
1409
|
-
permit?:
|
|
1503
|
+
permit?: Permit;
|
|
1410
1504
|
propertyOwnerProfile?: PropertyOwnerProfile;
|
|
1411
1505
|
quickLists?: QuickLists;
|
|
1412
1506
|
sale?: Sale;
|
|
@@ -1435,6 +1529,14 @@ export interface ResultsMetadata {
|
|
|
1435
1529
|
resultCount?: number;
|
|
1436
1530
|
/** Number of results found. This is the total number of properties that matched the search criteria. */
|
|
1437
1531
|
resultsFound?: number;
|
|
1532
|
+
/** Number of skip trace requests that resulted in errors */
|
|
1533
|
+
skipTraceErrorCount?: number;
|
|
1534
|
+
/** Number of skip trace requests that found matches */
|
|
1535
|
+
skipTraceMatchCount?: number;
|
|
1536
|
+
/** Number of skip trace requests that found no matches */
|
|
1537
|
+
skipTraceNoMatchCount?: number;
|
|
1538
|
+
/** Total number of skip trace requests made */
|
|
1539
|
+
skipTraceRequestCount?: number;
|
|
1438
1540
|
}
|
|
1439
1541
|
/**
|
|
1440
1542
|
* Response metadata
|
package/package.json
CHANGED