diff --git a/README.md b/README.md
index 062d523..26c7a00 100644
--- a/README.md
+++ b/README.md
@@ -7,7 +7,7 @@
This SDK provides convenient access to the Price Engine REST API from TypeScript or JavaScript.
-**[Unstable v1](https://dd360.mx/)**
+**[Stable v2](https://dd360.mx/)**
[](https://github.com/dd3tech/pe-sdk)
[](https://www.npmjs.com/package/pe-sdk)
diff --git a/src/apis/appraisal.ts b/src/apis/appraisal.ts
index d42416c..47e6305 100644
--- a/src/apis/appraisal.ts
+++ b/src/apis/appraisal.ts
@@ -11,7 +11,8 @@ import type {
AppraisalRequestInputVariable,
AppraisalRequestOutput,
AppraisalOutputCoverage,
- CommonRequestInput
+ CommonRequestInput,
+ Comparable
} from '../types'
/*
* This is the API Client to interact with our Price Engine API.
@@ -21,6 +22,15 @@ export class Appraisal extends BaseFetcher {
super(props)
}
+ public async getComparables(
+ body: AppraisalRequestInput
+ ): Promise {
+ return this.request(`/${API_RESOURCES_PATH.APPRAISALS}/comparables`, {
+ method: 'POST',
+ body: JSON.stringify(body)
+ })
+ }
+
public async getAppraisalCoverage(
request: CommonRequestInput
): Promise {
diff --git a/src/types/appraisal.ts b/src/types/appraisal.ts
index b34f31b..d61b32a 100644
--- a/src/types/appraisal.ts
+++ b/src/types/appraisal.ts
@@ -1,7 +1,11 @@
/** Appraisals types */
-export type Comparable = {
+export interface Comparable {
id?: string
urlAd?: string
+ propertyId?: string
+ propertyCode?: string
+ latitude?: number
+ longitude?: number
surfaceTotal?: number
terrainSurface?: number
builtYear?: number
@@ -11,6 +15,11 @@ export type Comparable = {
isNewPropertyProb?: number
pricePerSquareMeter?: number
dissimilarityToTarget?: number
+ title?: string
+ street?: string
+ neighborhood?: string
+ state?: string
+ municipality?: string
}
export interface AppraisalRequestOutput {
@@ -71,6 +80,11 @@ export type AppraisalRequestInput = {
m2PrivateTerrace?: number
hasView?: number
developmentAmenities?: DevelopmentAmenities
+ isNewPropertyProb?: number
+ isHouse?: number
+ isSale?: number
+ floorNumber?: number
+ bedrooms?: number
}
export type AppraisalRequestInputVariable = Omit<
diff --git a/src/utils.ts b/src/utils.ts
index 77d3c3d..d362052 100644
--- a/src/utils.ts
+++ b/src/utils.ts
@@ -10,7 +10,7 @@ export const APPRAISAL_PROPERTY_TYPES = {
export const API_RESOURCES_PATH = {
APPRAISALS: 'appraisals',
- METRICS: 'metrics'
+ METRICS: 'metrics',
} as const
export const METRIC_RESOURCES_PATH = {