@vepler/sdk 2.12.0 → 2.18.12

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 (103) hide show
  1. package/README.md +19 -14
  2. package/dist/commonjs/funcs/epcGetByLocationId.d.ts +17 -0
  3. package/dist/commonjs/funcs/epcGetByLocationId.d.ts.map +1 -0
  4. package/dist/commonjs/funcs/epcGetByLocationId.js +124 -0
  5. package/dist/commonjs/funcs/epcGetByLocationId.js.map +1 -0
  6. package/dist/commonjs/lib/config.d.ts +4 -4
  7. package/dist/commonjs/lib/config.js +4 -4
  8. package/dist/commonjs/lib/config.js.map +1 -1
  9. package/dist/commonjs/sdk/epc.d.ts +12 -0
  10. package/dist/commonjs/sdk/epc.d.ts.map +1 -0
  11. package/dist/commonjs/sdk/epc.js +22 -0
  12. package/dist/commonjs/sdk/epc.js.map +1 -0
  13. package/dist/commonjs/sdk/models/operations/getepcbylocationid.d.ts +562 -0
  14. package/dist/commonjs/sdk/models/operations/getepcbylocationid.d.ts.map +1 -0
  15. package/dist/commonjs/sdk/models/operations/getepcbylocationid.js +276 -0
  16. package/dist/commonjs/sdk/models/operations/getepcbylocationid.js.map +1 -0
  17. package/dist/commonjs/sdk/models/operations/getlistingbyid.d.ts +2 -2
  18. package/dist/commonjs/sdk/models/operations/getlistingbyid.d.ts.map +1 -1
  19. package/dist/commonjs/sdk/models/operations/getlistingsbylocation.d.ts +2 -2
  20. package/dist/commonjs/sdk/models/operations/getlistingsbylocation.d.ts.map +1 -1
  21. package/dist/commonjs/sdk/models/operations/getnearestpoi.d.ts +4 -4
  22. package/dist/commonjs/sdk/models/operations/getnearestpoi.d.ts.map +1 -1
  23. package/dist/commonjs/sdk/models/operations/getnearestpoi.js +6 -6
  24. package/dist/commonjs/sdk/models/operations/getnearestpoi.js.map +1 -1
  25. package/dist/commonjs/sdk/models/operations/index.d.ts +1 -0
  26. package/dist/commonjs/sdk/models/operations/index.d.ts.map +1 -1
  27. package/dist/commonjs/sdk/models/operations/index.js +1 -0
  28. package/dist/commonjs/sdk/models/operations/index.js.map +1 -1
  29. package/dist/commonjs/sdk/models/operations/querylistings.d.ts +2 -2
  30. package/dist/commonjs/sdk/models/operations/querylistings.d.ts.map +1 -1
  31. package/dist/commonjs/sdk/models/operations/querylistingsbysource.d.ts +2 -2
  32. package/dist/commonjs/sdk/models/operations/querylistingsbysource.d.ts.map +1 -1
  33. package/dist/commonjs/sdk/models/operations/resolveaddress.d.ts +39 -4
  34. package/dist/commonjs/sdk/models/operations/resolveaddress.d.ts.map +1 -1
  35. package/dist/commonjs/sdk/models/operations/resolveaddress.js +23 -2
  36. package/dist/commonjs/sdk/models/operations/resolveaddress.js.map +1 -1
  37. package/dist/commonjs/sdk/models/shared/propertyaddress.d.ts +1 -1
  38. package/dist/commonjs/sdk/models/shared/propertyaddress.d.ts.map +1 -1
  39. package/dist/commonjs/sdk/models/shared/streetdescriptor.d.ts +1 -1
  40. package/dist/commonjs/sdk/models/shared/streetdescriptor.d.ts.map +1 -1
  41. package/dist/commonjs/sdk/sdk.d.ts +3 -0
  42. package/dist/commonjs/sdk/sdk.d.ts.map +1 -1
  43. package/dist/commonjs/sdk/sdk.js +4 -0
  44. package/dist/commonjs/sdk/sdk.js.map +1 -1
  45. package/dist/esm/funcs/epcGetByLocationId.d.ts +17 -0
  46. package/dist/esm/funcs/epcGetByLocationId.d.ts.map +1 -0
  47. package/dist/esm/funcs/epcGetByLocationId.js +88 -0
  48. package/dist/esm/funcs/epcGetByLocationId.js.map +1 -0
  49. package/dist/esm/lib/config.d.ts +4 -4
  50. package/dist/esm/lib/config.js +4 -4
  51. package/dist/esm/lib/config.js.map +1 -1
  52. package/dist/esm/sdk/epc.d.ts +12 -0
  53. package/dist/esm/sdk/epc.d.ts.map +1 -0
  54. package/dist/esm/sdk/epc.js +18 -0
  55. package/dist/esm/sdk/epc.js.map +1 -0
  56. package/dist/esm/sdk/models/operations/getepcbylocationid.d.ts +562 -0
  57. package/dist/esm/sdk/models/operations/getepcbylocationid.d.ts.map +1 -0
  58. package/dist/esm/sdk/models/operations/getepcbylocationid.js +229 -0
  59. package/dist/esm/sdk/models/operations/getepcbylocationid.js.map +1 -0
  60. package/dist/esm/sdk/models/operations/getlistingbyid.d.ts +2 -2
  61. package/dist/esm/sdk/models/operations/getlistingbyid.d.ts.map +1 -1
  62. package/dist/esm/sdk/models/operations/getlistingsbylocation.d.ts +2 -2
  63. package/dist/esm/sdk/models/operations/getlistingsbylocation.d.ts.map +1 -1
  64. package/dist/esm/sdk/models/operations/getnearestpoi.d.ts +4 -4
  65. package/dist/esm/sdk/models/operations/getnearestpoi.d.ts.map +1 -1
  66. package/dist/esm/sdk/models/operations/getnearestpoi.js +4 -4
  67. package/dist/esm/sdk/models/operations/getnearestpoi.js.map +1 -1
  68. package/dist/esm/sdk/models/operations/index.d.ts +1 -0
  69. package/dist/esm/sdk/models/operations/index.d.ts.map +1 -1
  70. package/dist/esm/sdk/models/operations/index.js +1 -0
  71. package/dist/esm/sdk/models/operations/index.js.map +1 -1
  72. package/dist/esm/sdk/models/operations/querylistings.d.ts +2 -2
  73. package/dist/esm/sdk/models/operations/querylistings.d.ts.map +1 -1
  74. package/dist/esm/sdk/models/operations/querylistingsbysource.d.ts +2 -2
  75. package/dist/esm/sdk/models/operations/querylistingsbysource.d.ts.map +1 -1
  76. package/dist/esm/sdk/models/operations/resolveaddress.d.ts +39 -4
  77. package/dist/esm/sdk/models/operations/resolveaddress.d.ts.map +1 -1
  78. package/dist/esm/sdk/models/operations/resolveaddress.js +22 -1
  79. package/dist/esm/sdk/models/operations/resolveaddress.js.map +1 -1
  80. package/dist/esm/sdk/models/shared/propertyaddress.d.ts +1 -1
  81. package/dist/esm/sdk/models/shared/propertyaddress.d.ts.map +1 -1
  82. package/dist/esm/sdk/models/shared/streetdescriptor.d.ts +1 -1
  83. package/dist/esm/sdk/models/shared/streetdescriptor.d.ts.map +1 -1
  84. package/dist/esm/sdk/sdk.d.ts +3 -0
  85. package/dist/esm/sdk/sdk.d.ts.map +1 -1
  86. package/dist/esm/sdk/sdk.js +4 -0
  87. package/dist/esm/sdk/sdk.js.map +1 -1
  88. package/jsr.json +1 -1
  89. package/package.json +1 -1
  90. package/src/funcs/epcGetByLocationId.ts +172 -0
  91. package/src/lib/config.ts +4 -4
  92. package/src/sdk/epc.ts +27 -0
  93. package/src/sdk/models/operations/getepcbylocationid.ts +895 -0
  94. package/src/sdk/models/operations/getlistingbyid.ts +2 -2
  95. package/src/sdk/models/operations/getlistingsbylocation.ts +2 -2
  96. package/src/sdk/models/operations/getnearestpoi.ts +9 -9
  97. package/src/sdk/models/operations/index.ts +1 -0
  98. package/src/sdk/models/operations/querylistings.ts +2 -2
  99. package/src/sdk/models/operations/querylistingsbysource.ts +2 -2
  100. package/src/sdk/models/operations/resolveaddress.ts +50 -5
  101. package/src/sdk/models/shared/propertyaddress.ts +1 -1
  102. package/src/sdk/models/shared/streetdescriptor.ts +1 -1
  103. package/src/sdk/sdk.ts +6 -0
@@ -119,7 +119,7 @@ export type Address = {
119
119
  /**
120
120
  * Country code
121
121
  */
122
- country?: string | undefined;
122
+ country: string;
123
123
  /**
124
124
  * District
125
125
  */
@@ -568,7 +568,7 @@ export type Data = {
568
568
  /**
569
569
  * Currency code
570
570
  */
571
- currency?: string | undefined;
571
+ currency: string;
572
572
  /**
573
573
  * Formatted display address
574
574
  */
@@ -91,7 +91,7 @@ export type GetListingsByLocationAddress = {
91
91
  /**
92
92
  * Country code
93
93
  */
94
- country?: string | undefined;
94
+ country: string;
95
95
  /**
96
96
  * District
97
97
  */
@@ -548,7 +548,7 @@ export type GetListingsByLocationResult = {
548
548
  /**
549
549
  * Currency code
550
550
  */
551
- currency?: string | undefined;
551
+ currency: string;
552
552
  /**
553
553
  * Formatted display address
554
554
  */
@@ -88,7 +88,7 @@ export type GetNearestPOIType = ClosedEnum<typeof GetNearestPOIType>;
88
88
  /**
89
89
  * GeoJSON Point geometry representing the POI location
90
90
  */
91
- export type Location = {
91
+ export type GetNearestPOILocation = {
92
92
  /**
93
93
  * GeoJSON coordinates [longitude, latitude] in WGS84 (EPSG:4326)
94
94
  */
@@ -122,7 +122,7 @@ export type GetNearestPOIResult = {
122
122
  /**
123
123
  * GeoJSON Point geometry representing the POI location
124
124
  */
125
- location: Location;
125
+ location: GetNearestPOILocation;
126
126
  /**
127
127
  * Name of the point of interest
128
128
  */
@@ -292,8 +292,8 @@ export const GetNearestPOIType$inboundSchema: z.ZodNativeEnum<
292
292
  > = z.nativeEnum(GetNearestPOIType);
293
293
 
294
294
  /** @internal */
295
- export const Location$inboundSchema: z.ZodType<
296
- Location,
295
+ export const GetNearestPOILocation$inboundSchema: z.ZodType<
296
+ GetNearestPOILocation,
297
297
  z.ZodTypeDef,
298
298
  unknown
299
299
  > = z.object({
@@ -301,13 +301,13 @@ export const Location$inboundSchema: z.ZodType<
301
301
  type: GetNearestPOIType$inboundSchema,
302
302
  });
303
303
 
304
- export function locationFromJSON(
304
+ export function getNearestPOILocationFromJSON(
305
305
  jsonString: string,
306
- ): SafeParseResult<Location, SDKValidationError> {
306
+ ): SafeParseResult<GetNearestPOILocation, SDKValidationError> {
307
307
  return safeParse(
308
308
  jsonString,
309
- (x) => Location$inboundSchema.parse(JSON.parse(x)),
310
- `Failed to parse 'Location' from JSON`,
309
+ (x) => GetNearestPOILocation$inboundSchema.parse(JSON.parse(x)),
310
+ `Failed to parse 'GetNearestPOILocation' from JSON`,
311
311
  );
312
312
  }
313
313
 
@@ -321,7 +321,7 @@ export const GetNearestPOIResult$inboundSchema: z.ZodType<
321
321
  categoryId: z.string(),
322
322
  distance: z.number().optional(),
323
323
  id: z.number(),
324
- location: z.lazy(() => Location$inboundSchema),
324
+ location: z.lazy(() => GetNearestPOILocation$inboundSchema),
325
325
  name: z.string(),
326
326
  routingDistance: z.number().optional(),
327
327
  routingDuration: z.number().optional(),
@@ -11,6 +11,7 @@ export * from "./getareaswithinradius.js";
11
11
  export * from "./getborderingareas.js";
12
12
  export * from "./getchildareas.js";
13
13
  export * from "./getconnectivityscores.js";
14
+ export * from "./getepcbylocationid.js";
14
15
  export * from "./getlistingbyid.js";
15
16
  export * from "./getlistingbysource.js";
16
17
  export * from "./getlistingsbylocation.js";
@@ -184,7 +184,7 @@ export type QueryListingsAddress = {
184
184
  /**
185
185
  * Country code
186
186
  */
187
- country?: string | undefined;
187
+ country: string;
188
188
  /**
189
189
  * District
190
190
  */
@@ -632,7 +632,7 @@ export type QueryListingsResult = {
632
632
  /**
633
633
  * Currency code
634
634
  */
635
- currency?: string | undefined;
635
+ currency: string;
636
636
  /**
637
637
  * Formatted display address
638
638
  */
@@ -126,7 +126,7 @@ export type QueryListingsBySourceAddress = {
126
126
  /**
127
127
  * Country code
128
128
  */
129
- country?: string | undefined;
129
+ country: string;
130
130
  /**
131
131
  * District
132
132
  */
@@ -587,7 +587,7 @@ export type QueryListingsBySourceResult = {
587
587
  /**
588
588
  * Currency code
589
589
  */
590
- currency?: string | undefined;
590
+ currency: string;
591
591
  /**
592
592
  * Formatted display address
593
593
  */
@@ -97,6 +97,19 @@ export type ResolveAddressAddressResponseBody = {
97
97
  success: boolean;
98
98
  };
99
99
 
100
+ /**
101
+ * Confidence zone: H (High, >66%), M (Medium, 50-66%), L (Low, <50%)
102
+ */
103
+ export const ConfidenceZone = {
104
+ H: "H",
105
+ M: "M",
106
+ L: "L",
107
+ } as const;
108
+ /**
109
+ * Confidence zone: H (High, >66%), M (Medium, 50-66%), L (Low, <50%)
110
+ */
111
+ export type ConfidenceZone = ClosedEnum<typeof ConfidenceZone>;
112
+
100
113
  /**
101
114
  * Source of the match
102
115
  */
@@ -200,10 +213,6 @@ export type ResolveAddressMetadata = {
200
213
  * Total execution time in milliseconds
201
214
  */
202
215
  executionTimeMs: number;
203
- /**
204
- * Whether fast-path matching was used
205
- */
206
- fastPath?: boolean | undefined;
207
216
  /**
208
217
  * Detected address pattern type
209
218
  */
@@ -214,6 +223,18 @@ export type ResolveAddressMetadata = {
214
223
  processingSteps?: Array<ProcessingSteps> | undefined;
215
224
  };
216
225
 
226
+ /**
227
+ * Recommendation: A (Accept - safe to auto-accept) or I (Intervention - requires human review)
228
+ */
229
+ export const RecommendationCode = {
230
+ A: "A",
231
+ I: "I",
232
+ } as const;
233
+ /**
234
+ * Recommendation: A (Accept - safe to auto-accept) or I (Intervention - requires human review)
235
+ */
236
+ export type RecommendationCode = ClosedEnum<typeof RecommendationCode>;
237
+
217
238
  /**
218
239
  * Matching results (only present on success)
219
240
  */
@@ -222,6 +243,10 @@ export type Result = {
222
243
  * Overall confidence score of the results
223
244
  */
224
245
  confidence: number;
246
+ /**
247
+ * Confidence zone: H (High, >66%), M (Medium, 50-66%), L (Low, <50%)
248
+ */
249
+ confidenceZone?: ConfidenceZone | undefined;
225
250
  /**
226
251
  * Array of matched addresses
227
252
  */
@@ -230,6 +255,14 @@ export type Result = {
230
255
  * Metadata about the matching process
231
256
  */
232
257
  metadata: ResolveAddressMetadata;
258
+ /**
259
+ * Recommendation: A (Accept - safe to auto-accept) or I (Intervention - requires human review)
260
+ */
261
+ recommendationCode?: RecommendationCode | undefined;
262
+ /**
263
+ * Gap between top-2 match confidences (0-100). Higher values indicate clearer match distinction.
264
+ */
265
+ unambiguityScore?: number | undefined;
233
266
  };
234
267
 
235
268
  /**
@@ -388,6 +421,11 @@ export function resolveAddressAddressResponseBodyFromJSON(
388
421
  );
389
422
  }
390
423
 
424
+ /** @internal */
425
+ export const ConfidenceZone$inboundSchema: z.ZodNativeEnum<
426
+ typeof ConfidenceZone
427
+ > = z.nativeEnum(ConfidenceZone);
428
+
391
429
  /** @internal */
392
430
  export const Source$inboundSchema: z.ZodNativeEnum<typeof Source> = z
393
431
  .nativeEnum(Source);
@@ -452,7 +490,6 @@ export const ResolveAddressMetadata$inboundSchema: z.ZodType<
452
490
  > = z.object({
453
491
  addressCount: z.number(),
454
492
  executionTimeMs: z.number(),
455
- fastPath: z.boolean().optional(),
456
493
  pattern: Pattern$inboundSchema,
457
494
  processingSteps: z.array(z.lazy(() => ProcessingSteps$inboundSchema))
458
495
  .optional(),
@@ -468,12 +505,20 @@ export function resolveAddressMetadataFromJSON(
468
505
  );
469
506
  }
470
507
 
508
+ /** @internal */
509
+ export const RecommendationCode$inboundSchema: z.ZodNativeEnum<
510
+ typeof RecommendationCode
511
+ > = z.nativeEnum(RecommendationCode);
512
+
471
513
  /** @internal */
472
514
  export const Result$inboundSchema: z.ZodType<Result, z.ZodTypeDef, unknown> = z
473
515
  .object({
474
516
  confidence: z.number(),
517
+ confidenceZone: ConfidenceZone$inboundSchema.optional(),
475
518
  matches: z.array(z.lazy(() => Matches$inboundSchema)),
476
519
  metadata: z.lazy(() => ResolveAddressMetadata$inboundSchema),
520
+ recommendationCode: RecommendationCode$inboundSchema.optional(),
521
+ unambiguityScore: z.number().optional(),
477
522
  });
478
523
 
479
524
  export function resultFromJSON(
@@ -8,7 +8,7 @@ import { Result as SafeParseResult } from "../../types/fp.js";
8
8
  import { SDKValidationError } from "../errors/sdkvalidationerror.js";
9
9
 
10
10
  export type PropertyAddress = {
11
- country?: string | undefined;
11
+ country: string;
12
12
  /**
13
13
  * Formatted display address
14
14
  */
@@ -15,7 +15,7 @@ export type StreetDescriptor = {
15
15
  /**
16
16
  * Language code
17
17
  */
18
- language?: string | undefined;
18
+ language: string;
19
19
  /**
20
20
  * Local area name
21
21
  */
package/src/sdk/sdk.ts CHANGED
@@ -7,6 +7,7 @@ import { Address } from "./address.js";
7
7
  import { Areas } from "./areas.js";
8
8
  import { Avm } from "./avm.js";
9
9
  import { Connectivity } from "./connectivity.js";
10
+ import { Epc } from "./epc.js";
10
11
  import { Listings } from "./listings.js";
11
12
  import { Metrics } from "./metrics.js";
12
13
  import { Planning } from "./planning.js";
@@ -54,6 +55,11 @@ export class SDK extends ClientSDK {
54
55
  return (this._avm ??= new Avm(this._options));
55
56
  }
56
57
 
58
+ private _epc?: Epc;
59
+ get epc(): Epc {
60
+ return (this._epc ??= new Epc(this._options));
61
+ }
62
+
57
63
  private _listings?: Listings;
58
64
  get listings(): Listings {
59
65
  return (this._listings ??= new Listings(this._options));