@vepler/sdk 2.20.2 → 2.24.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.
Files changed (65) hide show
  1. package/dist/commonjs/lib/config.d.ts +3 -3
  2. package/dist/commonjs/lib/config.js +3 -3
  3. package/dist/commonjs/lib/sdks.js +2 -2
  4. package/dist/commonjs/lib/sdks.js.map +1 -1
  5. package/dist/commonjs/sdk/models/operations/getareasbyfieldandids.d.ts +4 -3
  6. package/dist/commonjs/sdk/models/operations/getareasbyfieldandids.d.ts.map +1 -1
  7. package/dist/commonjs/sdk/models/operations/getareasbyfieldandids.js +2 -1
  8. package/dist/commonjs/sdk/models/operations/getareasbyfieldandids.js.map +1 -1
  9. package/dist/commonjs/sdk/models/operations/getareaswithinradius.d.ts +7 -5
  10. package/dist/commonjs/sdk/models/operations/getareaswithinradius.d.ts.map +1 -1
  11. package/dist/commonjs/sdk/models/operations/getareaswithinradius.js +4 -2
  12. package/dist/commonjs/sdk/models/operations/getareaswithinradius.js.map +1 -1
  13. package/dist/commonjs/sdk/models/operations/getborderingareas.d.ts +8 -6
  14. package/dist/commonjs/sdk/models/operations/getborderingareas.d.ts.map +1 -1
  15. package/dist/commonjs/sdk/models/operations/getborderingareas.js +4 -2
  16. package/dist/commonjs/sdk/models/operations/getborderingareas.js.map +1 -1
  17. package/dist/commonjs/sdk/models/operations/getchildareas.d.ts +8 -6
  18. package/dist/commonjs/sdk/models/operations/getchildareas.d.ts.map +1 -1
  19. package/dist/commonjs/sdk/models/operations/getchildareas.js +4 -2
  20. package/dist/commonjs/sdk/models/operations/getchildareas.js.map +1 -1
  21. package/dist/commonjs/sdk/models/operations/getmetricvalues.d.ts +12 -9
  22. package/dist/commonjs/sdk/models/operations/getmetricvalues.d.ts.map +1 -1
  23. package/dist/commonjs/sdk/models/operations/getmetricvalues.js +6 -3
  24. package/dist/commonjs/sdk/models/operations/getmetricvalues.js.map +1 -1
  25. package/dist/commonjs/sdk/models/shared/propertydataapi.d.ts +21 -0
  26. package/dist/commonjs/sdk/models/shared/propertydataapi.d.ts.map +1 -1
  27. package/dist/commonjs/sdk/models/shared/propertydataapi.js +21 -1
  28. package/dist/commonjs/sdk/models/shared/propertydataapi.js.map +1 -1
  29. package/dist/esm/lib/config.d.ts +3 -3
  30. package/dist/esm/lib/config.js +3 -3
  31. package/dist/esm/lib/sdks.js +2 -2
  32. package/dist/esm/lib/sdks.js.map +1 -1
  33. package/dist/esm/sdk/models/operations/getareasbyfieldandids.d.ts +4 -3
  34. package/dist/esm/sdk/models/operations/getareasbyfieldandids.d.ts.map +1 -1
  35. package/dist/esm/sdk/models/operations/getareasbyfieldandids.js +2 -1
  36. package/dist/esm/sdk/models/operations/getareasbyfieldandids.js.map +1 -1
  37. package/dist/esm/sdk/models/operations/getareaswithinradius.d.ts +7 -5
  38. package/dist/esm/sdk/models/operations/getareaswithinradius.d.ts.map +1 -1
  39. package/dist/esm/sdk/models/operations/getareaswithinradius.js +4 -2
  40. package/dist/esm/sdk/models/operations/getareaswithinradius.js.map +1 -1
  41. package/dist/esm/sdk/models/operations/getborderingareas.d.ts +8 -6
  42. package/dist/esm/sdk/models/operations/getborderingareas.d.ts.map +1 -1
  43. package/dist/esm/sdk/models/operations/getborderingareas.js +4 -2
  44. package/dist/esm/sdk/models/operations/getborderingareas.js.map +1 -1
  45. package/dist/esm/sdk/models/operations/getchildareas.d.ts +8 -6
  46. package/dist/esm/sdk/models/operations/getchildareas.d.ts.map +1 -1
  47. package/dist/esm/sdk/models/operations/getchildareas.js +4 -2
  48. package/dist/esm/sdk/models/operations/getchildareas.js.map +1 -1
  49. package/dist/esm/sdk/models/operations/getmetricvalues.d.ts +12 -9
  50. package/dist/esm/sdk/models/operations/getmetricvalues.d.ts.map +1 -1
  51. package/dist/esm/sdk/models/operations/getmetricvalues.js +6 -3
  52. package/dist/esm/sdk/models/operations/getmetricvalues.js.map +1 -1
  53. package/dist/esm/sdk/models/shared/propertydataapi.d.ts +21 -0
  54. package/dist/esm/sdk/models/shared/propertydataapi.d.ts.map +1 -1
  55. package/dist/esm/sdk/models/shared/propertydataapi.js +20 -0
  56. package/dist/esm/sdk/models/shared/propertydataapi.js.map +1 -1
  57. package/package.json +1 -1
  58. package/src/lib/config.ts +3 -3
  59. package/src/lib/sdks.ts +2 -2
  60. package/src/sdk/models/operations/getareasbyfieldandids.ts +4 -3
  61. package/src/sdk/models/operations/getareaswithinradius.ts +7 -5
  62. package/src/sdk/models/operations/getborderingareas.ts +8 -6
  63. package/src/sdk/models/operations/getchildareas.ts +8 -6
  64. package/src/sdk/models/operations/getmetricvalues.ts +12 -9
  65. package/src/sdk/models/shared/propertydataapi.ts +33 -0
@@ -102,10 +102,11 @@ export type GetChildAreasRelationships = {
102
102
  };
103
103
 
104
104
  /**
105
- * Layer type - supports ONS geographies (OA21, LSOA21, LAD), HMLR INSPIRE parcels, EA/NRW/SEPA flood data, environmental designations (Natura 2000, AONB/NSA), heritage assets, and noise mapping data
105
+ * Layer type - supports postcodes, outcodes (e.g., SW1A), ONS geographies (OA21, LSOA21, LAD), HMLR INSPIRE parcels, EA/NRW/SEPA flood data, environmental designations (Natura 2000, AONB/NSA), heritage assets, and noise mapping data
106
106
  */
107
107
  export const GetChildAreasType = {
108
108
  Postcode: "postcode",
109
+ Outcode: "outcode",
109
110
  UkOutputArea: "uk_output_area",
110
111
  Lsoa21: "lsoa21",
111
112
  Ward: "ward",
@@ -158,7 +159,7 @@ export const GetChildAreasType = {
158
159
  NoiseIndustryLden: "noise_industry_lden",
159
160
  } as const;
160
161
  /**
161
- * Layer type - supports ONS geographies (OA21, LSOA21, LAD), HMLR INSPIRE parcels, EA/NRW/SEPA flood data, environmental designations (Natura 2000, AONB/NSA), heritage assets, and noise mapping data
162
+ * Layer type - supports postcodes, outcodes (e.g., SW1A), ONS geographies (OA21, LSOA21, LAD), HMLR INSPIRE parcels, EA/NRW/SEPA flood data, environmental designations (Natura 2000, AONB/NSA), heritage assets, and noise mapping data
162
163
  */
163
164
  export type GetChildAreasType = ClosedEnum<typeof GetChildAreasType>;
164
165
 
@@ -211,7 +212,7 @@ export type Children = {
211
212
  */
212
213
  status?: string | undefined;
213
214
  /**
214
- * Layer type - supports ONS geographies (OA21, LSOA21, LAD), HMLR INSPIRE parcels, EA/NRW/SEPA flood data, environmental designations (Natura 2000, AONB/NSA), heritage assets, and noise mapping data
215
+ * Layer type - supports postcodes, outcodes (e.g., SW1A), ONS geographies (OA21, LSOA21, LAD), HMLR INSPIRE parcels, EA/NRW/SEPA flood data, environmental designations (Natura 2000, AONB/NSA), heritage assets, and noise mapping data
215
216
  */
216
217
  type: GetChildAreasType;
217
218
  };
@@ -251,10 +252,11 @@ export type GetChildAreasAreasRelationships = {
251
252
  };
252
253
 
253
254
  /**
254
- * Layer type - supports ONS geographies (OA21, LSOA21, LAD), HMLR INSPIRE parcels, EA/NRW/SEPA flood data, environmental designations (Natura 2000, AONB/NSA), heritage assets, and noise mapping data
255
+ * Layer type - supports postcodes, outcodes (e.g., SW1A), ONS geographies (OA21, LSOA21, LAD), HMLR INSPIRE parcels, EA/NRW/SEPA flood data, environmental designations (Natura 2000, AONB/NSA), heritage assets, and noise mapping data
255
256
  */
256
257
  export const GetChildAreasAreasType = {
257
258
  Postcode: "postcode",
259
+ Outcode: "outcode",
258
260
  UkOutputArea: "uk_output_area",
259
261
  Lsoa21: "lsoa21",
260
262
  Ward: "ward",
@@ -307,7 +309,7 @@ export const GetChildAreasAreasType = {
307
309
  NoiseIndustryLden: "noise_industry_lden",
308
310
  } as const;
309
311
  /**
310
- * Layer type - supports ONS geographies (OA21, LSOA21, LAD), HMLR INSPIRE parcels, EA/NRW/SEPA flood data, environmental designations (Natura 2000, AONB/NSA), heritage assets, and noise mapping data
312
+ * Layer type - supports postcodes, outcodes (e.g., SW1A), ONS geographies (OA21, LSOA21, LAD), HMLR INSPIRE parcels, EA/NRW/SEPA flood data, environmental designations (Natura 2000, AONB/NSA), heritage assets, and noise mapping data
311
313
  */
312
314
  export type GetChildAreasAreasType = ClosedEnum<typeof GetChildAreasAreasType>;
313
315
 
@@ -360,7 +362,7 @@ export type Parent = {
360
362
  */
361
363
  status?: string | undefined;
362
364
  /**
363
- * Layer type - supports ONS geographies (OA21, LSOA21, LAD), HMLR INSPIRE parcels, EA/NRW/SEPA flood data, environmental designations (Natura 2000, AONB/NSA), heritage assets, and noise mapping data
365
+ * Layer type - supports postcodes, outcodes (e.g., SW1A), ONS geographies (OA21, LSOA21, LAD), HMLR INSPIRE parcels, EA/NRW/SEPA flood data, environmental designations (Natura 2000, AONB/NSA), heritage assets, and noise mapping data
364
366
  */
365
367
  type: GetChildAreasAreasType;
366
368
  };
@@ -9,10 +9,11 @@ import { Result as SafeParseResult } from "../../types/fp.js";
9
9
  import { SDKValidationError } from "../errors/sdkvalidationerror.js";
10
10
 
11
11
  /**
12
- * Layer type - supports ONS geographies (OA21, LSOA21, LAD), HMLR INSPIRE parcels, EA/NRW/SEPA flood data, environmental designations (Natura 2000, AONB/NSA), heritage assets, and noise mapping data
12
+ * Layer type - supports postcodes, outcodes (e.g., SW1A), ONS geographies (OA21, LSOA21, LAD), HMLR INSPIRE parcels, EA/NRW/SEPA flood data, environmental designations (Natura 2000, AONB/NSA), heritage assets, and noise mapping data
13
13
  */
14
14
  export const GeographicType = {
15
15
  Postcode: "postcode",
16
+ Outcode: "outcode",
16
17
  UkOutputArea: "uk_output_area",
17
18
  Lsoa21: "lsoa21",
18
19
  Ward: "ward",
@@ -65,7 +66,7 @@ export const GeographicType = {
65
66
  NoiseIndustryLden: "noise_industry_lden",
66
67
  } as const;
67
68
  /**
68
- * Layer type - supports ONS geographies (OA21, LSOA21, LAD), HMLR INSPIRE parcels, EA/NRW/SEPA flood data, environmental designations (Natura 2000, AONB/NSA), heritage assets, and noise mapping data
69
+ * Layer type - supports postcodes, outcodes (e.g., SW1A), ONS geographies (OA21, LSOA21, LAD), HMLR INSPIRE parcels, EA/NRW/SEPA flood data, environmental designations (Natura 2000, AONB/NSA), heritage assets, and noise mapping data
69
70
  */
70
71
  export type GeographicType = ClosedEnum<typeof GeographicType>;
71
72
 
@@ -74,7 +75,7 @@ export type GetMetricValuesRequest = {
74
75
  endPeriod?: string | undefined;
75
76
  geographicCode?: string | undefined;
76
77
  /**
77
- * Layer type identifier. Includes ONS statistical geographies, HM Land Registry INSPIRE polygons, Environment Agency flood zones, Natural England/NatureScot environmental designations, Historic England heritage assets, and DEFRA END Directive noise mapping.
78
+ * Layer type identifier. Includes postcodes, outcodes, ONS statistical geographies, HM Land Registry INSPIRE polygons, Environment Agency flood zones, Natural England/NatureScot environmental designations, Historic England heritage assets, and DEFRA END Directive noise mapping.
78
79
  */
79
80
  geographicType?: GeographicType | undefined;
80
81
  includeGeographyDetails?: string | undefined;
@@ -139,10 +140,11 @@ export type Pagination = {
139
140
  };
140
141
 
141
142
  /**
142
- * Layer type - supports ONS geographies (OA21, LSOA21, LAD), HMLR INSPIRE parcels, EA/NRW/SEPA flood data, environmental designations (Natura 2000, AONB/NSA), heritage assets, and noise mapping data
143
+ * Layer type - supports postcodes, outcodes (e.g., SW1A), ONS geographies (OA21, LSOA21, LAD), HMLR INSPIRE parcels, EA/NRW/SEPA flood data, environmental designations (Natura 2000, AONB/NSA), heritage assets, and noise mapping data
143
144
  */
144
145
  export const GetMetricValuesGeographicType = {
145
146
  Postcode: "postcode",
147
+ Outcode: "outcode",
146
148
  UkOutputArea: "uk_output_area",
147
149
  Lsoa21: "lsoa21",
148
150
  Ward: "ward",
@@ -195,17 +197,18 @@ export const GetMetricValuesGeographicType = {
195
197
  NoiseIndustryLden: "noise_industry_lden",
196
198
  } as const;
197
199
  /**
198
- * Layer type - supports ONS geographies (OA21, LSOA21, LAD), HMLR INSPIRE parcels, EA/NRW/SEPA flood data, environmental designations (Natura 2000, AONB/NSA), heritage assets, and noise mapping data
200
+ * Layer type - supports postcodes, outcodes (e.g., SW1A), ONS geographies (OA21, LSOA21, LAD), HMLR INSPIRE parcels, EA/NRW/SEPA flood data, environmental designations (Natura 2000, AONB/NSA), heritage assets, and noise mapping data
199
201
  */
200
202
  export type GetMetricValuesGeographicType = ClosedEnum<
201
203
  typeof GetMetricValuesGeographicType
202
204
  >;
203
205
 
204
206
  /**
205
- * Layer type - supports ONS geographies (OA21, LSOA21, LAD), HMLR INSPIRE parcels, EA/NRW/SEPA flood data, environmental designations (Natura 2000, AONB/NSA), heritage assets, and noise mapping data
207
+ * Layer type - supports postcodes, outcodes (e.g., SW1A), ONS geographies (OA21, LSOA21, LAD), HMLR INSPIRE parcels, EA/NRW/SEPA flood data, environmental designations (Natura 2000, AONB/NSA), heritage assets, and noise mapping data
206
208
  */
207
209
  export const GetMetricValuesType = {
208
210
  Postcode: "postcode",
211
+ Outcode: "outcode",
209
212
  UkOutputArea: "uk_output_area",
210
213
  Lsoa21: "lsoa21",
211
214
  Ward: "ward",
@@ -258,7 +261,7 @@ export const GetMetricValuesType = {
258
261
  NoiseIndustryLden: "noise_industry_lden",
259
262
  } as const;
260
263
  /**
261
- * Layer type - supports ONS geographies (OA21, LSOA21, LAD), HMLR INSPIRE parcels, EA/NRW/SEPA flood data, environmental designations (Natura 2000, AONB/NSA), heritage assets, and noise mapping data
264
+ * Layer type - supports postcodes, outcodes (e.g., SW1A), ONS geographies (OA21, LSOA21, LAD), HMLR INSPIRE parcels, EA/NRW/SEPA flood data, environmental designations (Natura 2000, AONB/NSA), heritage assets, and noise mapping data
262
265
  */
263
266
  export type GetMetricValuesType = ClosedEnum<typeof GetMetricValuesType>;
264
267
 
@@ -266,7 +269,7 @@ export type Geography = {
266
269
  code: string;
267
270
  name: string;
268
271
  /**
269
- * Layer type - supports ONS geographies (OA21, LSOA21, LAD), HMLR INSPIRE parcels, EA/NRW/SEPA flood data, environmental designations (Natura 2000, AONB/NSA), heritage assets, and noise mapping data
272
+ * Layer type - supports postcodes, outcodes (e.g., SW1A), ONS geographies (OA21, LSOA21, LAD), HMLR INSPIRE parcels, EA/NRW/SEPA flood data, environmental designations (Natura 2000, AONB/NSA), heritage assets, and noise mapping data
270
273
  */
271
274
  type: GetMetricValuesType;
272
275
  };
@@ -311,7 +314,7 @@ export type GetMetricValuesResult = {
311
314
  createdAt: string;
312
315
  geographicCode: string;
313
316
  /**
314
- * Layer type - supports ONS geographies (OA21, LSOA21, LAD), HMLR INSPIRE parcels, EA/NRW/SEPA flood data, environmental designations (Natura 2000, AONB/NSA), heritage assets, and noise mapping data
317
+ * Layer type - supports postcodes, outcodes (e.g., SW1A), ONS geographies (OA21, LSOA21, LAD), HMLR INSPIRE parcels, EA/NRW/SEPA flood data, environmental designations (Natura 2000, AONB/NSA), heritage assets, and noise mapping data
315
318
  */
316
319
  geographicType: GetMetricValuesGeographicType;
317
320
  geography?: Geography | undefined;
@@ -38,11 +38,27 @@ export type Charges = {
38
38
  serviceCharge?: ChargeHistory | null | undefined;
39
39
  };
40
40
 
41
+ export const CoordinateConfidence = {
42
+ High: "high",
43
+ Medium: "medium",
44
+ Low: "low",
45
+ } as const;
46
+ export type CoordinateConfidence = ClosedEnum<typeof CoordinateConfidence>;
47
+
41
48
  export type FloodRisk = {
42
49
  riskLevel?: string | undefined;
43
50
  suitability?: string | null | undefined;
44
51
  };
45
52
 
53
+ export const OccupancyStatus = {
54
+ Planned: "planned",
55
+ UnderConstruction: "under_construction",
56
+ Occupied: "occupied",
57
+ Vacant: "vacant",
58
+ Demolished: "demolished",
59
+ } as const;
60
+ export type OccupancyStatus = ClosedEnum<typeof OccupancyStatus>;
61
+
46
62
  export const PropertyCategory = {
47
63
  Residential: "residential",
48
64
  Commercial: "commercial",
@@ -77,6 +93,7 @@ export type PropertyDataApi = {
77
93
  build?: BuildData | undefined;
78
94
  charges?: Charges | undefined;
79
95
  classificationCode?: string | null | undefined;
96
+ coordinateConfidence?: CoordinateConfidence | null | undefined;
80
97
  councilTax?: CouncilTaxData | undefined;
81
98
  epc?: EPCData | undefined;
82
99
  floodRisk?: FloodRisk | undefined;
@@ -87,6 +104,7 @@ export type PropertyDataApi = {
87
104
  */
88
105
  locationId?: string | undefined;
89
106
  marketStatus?: MarketStatus | undefined;
107
+ occupancyStatus?: OccupancyStatus | null | undefined;
90
108
  overlays?: Array<string> | undefined;
91
109
  parentLocationId?: string | null | undefined;
92
110
  priceChangeRent?: Array<PriceChange> | undefined;
@@ -105,6 +123,7 @@ export type PropertyDataApi = {
105
123
  tags?: PropertyTags | undefined;
106
124
  tenancy?: TenancyData | undefined;
107
125
  tenure?: TenureData | undefined;
126
+ unitCount?: number | null | undefined;
108
127
  };
109
128
 
110
129
  /** @internal */
@@ -124,6 +143,11 @@ export function chargesFromJSON(
124
143
  );
125
144
  }
126
145
 
146
+ /** @internal */
147
+ export const CoordinateConfidence$inboundSchema: z.ZodNativeEnum<
148
+ typeof CoordinateConfidence
149
+ > = z.nativeEnum(CoordinateConfidence);
150
+
127
151
  /** @internal */
128
152
  export const FloodRisk$inboundSchema: z.ZodType<
129
153
  FloodRisk,
@@ -144,6 +168,11 @@ export function floodRiskFromJSON(
144
168
  );
145
169
  }
146
170
 
171
+ /** @internal */
172
+ export const OccupancyStatus$inboundSchema: z.ZodNativeEnum<
173
+ typeof OccupancyStatus
174
+ > = z.nativeEnum(OccupancyStatus);
175
+
147
176
  /** @internal */
148
177
  export const PropertyCategory$inboundSchema: z.ZodNativeEnum<
149
178
  typeof PropertyCategory
@@ -239,6 +268,8 @@ export const PropertyDataApi$inboundSchema: z.ZodType<
239
268
  build: BuildData$inboundSchema.optional(),
240
269
  charges: z.lazy(() => Charges$inboundSchema).optional(),
241
270
  classificationCode: z.nullable(z.string()).optional(),
271
+ coordinateConfidence: z.nullable(CoordinateConfidence$inboundSchema)
272
+ .optional(),
242
273
  councilTax: CouncilTaxData$inboundSchema.optional(),
243
274
  epc: EPCData$inboundSchema.optional(),
244
275
  floodRisk: z.lazy(() => FloodRisk$inboundSchema).optional(),
@@ -246,6 +277,7 @@ export const PropertyDataApi$inboundSchema: z.ZodType<
246
277
  listings: z.array(Listing$inboundSchema).optional(),
247
278
  locationId: z.string().optional(),
248
279
  marketStatus: MarketStatus$inboundSchema.optional(),
280
+ occupancyStatus: z.nullable(OccupancyStatus$inboundSchema).optional(),
249
281
  overlays: z.array(z.string()).optional(),
250
282
  parentLocationId: z.nullable(z.string()).optional(),
251
283
  priceChangeRent: z.array(PriceChange$inboundSchema).optional(),
@@ -264,6 +296,7 @@ export const PropertyDataApi$inboundSchema: z.ZodType<
264
296
  tags: PropertyTags$inboundSchema.optional(),
265
297
  tenancy: TenancyData$inboundSchema.optional(),
266
298
  tenure: TenureData$inboundSchema.optional(),
299
+ unitCount: z.nullable(z.number().int()).optional(),
267
300
  });
268
301
 
269
302
  export function propertyDataApiFromJSON(