@vepler/sdk 7.11.2 → 7.18.0

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 (199) hide show
  1. package/README.md +468 -443
  2. package/dist/commonjs/funcs/placesAttributes.d.ts +18 -0
  3. package/dist/commonjs/funcs/placesAttributes.d.ts.map +1 -0
  4. package/dist/commonjs/funcs/placesAttributes.js +109 -0
  5. package/dist/commonjs/funcs/placesAttributes.js.map +1 -0
  6. package/dist/commonjs/funcs/placesGet.d.ts +19 -0
  7. package/dist/commonjs/funcs/placesGet.d.ts.map +1 -0
  8. package/dist/commonjs/funcs/placesGet.js +125 -0
  9. package/dist/commonjs/funcs/placesGet.js.map +1 -0
  10. package/dist/commonjs/funcs/placesNearest.d.ts +19 -0
  11. package/dist/commonjs/funcs/placesNearest.d.ts.map +1 -0
  12. package/dist/commonjs/funcs/placesNearest.js +127 -0
  13. package/dist/commonjs/funcs/placesNearest.js.map +1 -0
  14. package/dist/commonjs/lib/config.d.ts +3 -3
  15. package/dist/commonjs/lib/config.js +3 -3
  16. package/dist/commonjs/sdk/models/errors/getnearestplaces.d.ts +396 -0
  17. package/dist/commonjs/sdk/models/errors/getnearestplaces.d.ts.map +1 -0
  18. package/dist/commonjs/sdk/models/errors/getnearestplaces.js +381 -0
  19. package/dist/commonjs/sdk/models/errors/getnearestplaces.js.map +1 -0
  20. package/dist/commonjs/sdk/models/errors/getplace.d.ts +461 -0
  21. package/dist/commonjs/sdk/models/errors/getplace.d.ts.map +1 -0
  22. package/dist/commonjs/sdk/models/errors/getplace.js +437 -0
  23. package/dist/commonjs/sdk/models/errors/getplace.js.map +1 -0
  24. package/dist/commonjs/sdk/models/errors/getplaceattributes.d.ts +201 -0
  25. package/dist/commonjs/sdk/models/errors/getplaceattributes.d.ts.map +1 -0
  26. package/dist/commonjs/sdk/models/errors/getplaceattributes.js +213 -0
  27. package/dist/commonjs/sdk/models/errors/getplaceattributes.js.map +1 -0
  28. package/dist/commonjs/sdk/models/errors/index.d.ts +3 -0
  29. package/dist/commonjs/sdk/models/errors/index.d.ts.map +1 -1
  30. package/dist/commonjs/sdk/models/errors/index.js +3 -0
  31. package/dist/commonjs/sdk/models/errors/index.js.map +1 -1
  32. package/dist/commonjs/sdk/models/operations/getnearestplaces.d.ts +35 -0
  33. package/dist/commonjs/sdk/models/operations/getnearestplaces.d.ts.map +1 -0
  34. package/dist/commonjs/sdk/models/operations/getnearestplaces.js +53 -0
  35. package/dist/commonjs/sdk/models/operations/getnearestplaces.js.map +1 -0
  36. package/dist/commonjs/sdk/models/operations/getplace.d.ts +15 -0
  37. package/dist/commonjs/sdk/models/operations/getplace.d.ts.map +1 -0
  38. package/dist/commonjs/sdk/models/operations/getplace.js +49 -0
  39. package/dist/commonjs/sdk/models/operations/getplace.js.map +1 -0
  40. package/dist/commonjs/sdk/models/operations/index.d.ts +2 -0
  41. package/dist/commonjs/sdk/models/operations/index.d.ts.map +1 -1
  42. package/dist/commonjs/sdk/models/operations/index.js +2 -0
  43. package/dist/commonjs/sdk/models/operations/index.js.map +1 -1
  44. package/dist/commonjs/sdk/models/shared/index.d.ts +7 -0
  45. package/dist/commonjs/sdk/models/shared/index.d.ts.map +1 -1
  46. package/dist/commonjs/sdk/models/shared/index.js +7 -0
  47. package/dist/commonjs/sdk/models/shared/index.js.map +1 -1
  48. package/dist/commonjs/sdk/models/shared/marketstatus.d.ts +1 -1
  49. package/dist/commonjs/sdk/models/shared/poiattribute.d.ts +37 -0
  50. package/dist/commonjs/sdk/models/shared/poiattribute.d.ts.map +1 -0
  51. package/dist/commonjs/sdk/models/shared/poiattribute.js +56 -0
  52. package/dist/commonjs/sdk/models/shared/poiattribute.js.map +1 -0
  53. package/dist/commonjs/sdk/models/shared/poiattributecatalogue.d.ts +17 -0
  54. package/dist/commonjs/sdk/models/shared/poiattributecatalogue.d.ts.map +1 -0
  55. package/dist/commonjs/sdk/models/shared/poiattributecatalogue.js +51 -0
  56. package/dist/commonjs/sdk/models/shared/poiattributecatalogue.js.map +1 -0
  57. package/dist/commonjs/sdk/models/shared/poifieldprovenance.d.ts +35 -0
  58. package/dist/commonjs/sdk/models/shared/poifieldprovenance.d.ts.map +1 -0
  59. package/dist/commonjs/sdk/models/shared/poifieldprovenance.js +62 -0
  60. package/dist/commonjs/sdk/models/shared/poifieldprovenance.js.map +1 -0
  61. package/dist/commonjs/sdk/models/shared/poinearestresponse.d.ts +217 -0
  62. package/dist/commonjs/sdk/models/shared/poinearestresponse.d.ts.map +1 -0
  63. package/dist/commonjs/sdk/models/shared/poinearestresponse.js +140 -0
  64. package/dist/commonjs/sdk/models/shared/poinearestresponse.js.map +1 -0
  65. package/dist/commonjs/sdk/models/shared/poiplace.d.ts +253 -0
  66. package/dist/commonjs/sdk/models/shared/poiplace.d.ts.map +1 -0
  67. package/dist/commonjs/sdk/models/shared/poiplace.js +151 -0
  68. package/dist/commonjs/sdk/models/shared/poiplace.js.map +1 -0
  69. package/dist/commonjs/sdk/models/shared/poiprovenance.d.ts +81 -0
  70. package/dist/commonjs/sdk/models/shared/poiprovenance.d.ts.map +1 -0
  71. package/dist/commonjs/sdk/models/shared/poiprovenance.js +67 -0
  72. package/dist/commonjs/sdk/models/shared/poiprovenance.js.map +1 -0
  73. package/dist/commonjs/sdk/models/shared/poiregistermatch.d.ts +48 -0
  74. package/dist/commonjs/sdk/models/shared/poiregistermatch.d.ts.map +1 -0
  75. package/dist/commonjs/sdk/models/shared/poiregistermatch.js +71 -0
  76. package/dist/commonjs/sdk/models/shared/poiregistermatch.js.map +1 -0
  77. package/dist/commonjs/sdk/models/shared/pscexemption.d.ts +4 -4
  78. package/dist/commonjs/sdk/models/shared/pscexemption.d.ts.map +1 -1
  79. package/dist/commonjs/sdk/models/shared/pscexemption.js +6 -7
  80. package/dist/commonjs/sdk/models/shared/pscexemption.js.map +1 -1
  81. package/dist/commonjs/sdk/places.d.ts +27 -0
  82. package/dist/commonjs/sdk/places.d.ts.map +1 -0
  83. package/dist/commonjs/sdk/places.js +42 -0
  84. package/dist/commonjs/sdk/places.js.map +1 -0
  85. package/dist/commonjs/sdk/sdk.d.ts +3 -0
  86. package/dist/commonjs/sdk/sdk.d.ts.map +1 -1
  87. package/dist/commonjs/sdk/sdk.js +4 -0
  88. package/dist/commonjs/sdk/sdk.js.map +1 -1
  89. package/dist/esm/funcs/placesAttributes.d.ts +18 -0
  90. package/dist/esm/funcs/placesAttributes.d.ts.map +1 -0
  91. package/dist/esm/funcs/placesAttributes.js +73 -0
  92. package/dist/esm/funcs/placesAttributes.js.map +1 -0
  93. package/dist/esm/funcs/placesGet.d.ts +19 -0
  94. package/dist/esm/funcs/placesGet.d.ts.map +1 -0
  95. package/dist/esm/funcs/placesGet.js +89 -0
  96. package/dist/esm/funcs/placesGet.js.map +1 -0
  97. package/dist/esm/funcs/placesNearest.d.ts +19 -0
  98. package/dist/esm/funcs/placesNearest.d.ts.map +1 -0
  99. package/dist/esm/funcs/placesNearest.js +91 -0
  100. package/dist/esm/funcs/placesNearest.js.map +1 -0
  101. package/dist/esm/lib/config.d.ts +3 -3
  102. package/dist/esm/lib/config.js +3 -3
  103. package/dist/esm/sdk/models/errors/getnearestplaces.d.ts +396 -0
  104. package/dist/esm/sdk/models/errors/getnearestplaces.d.ts.map +1 -0
  105. package/dist/esm/sdk/models/errors/getnearestplaces.js +333 -0
  106. package/dist/esm/sdk/models/errors/getnearestplaces.js.map +1 -0
  107. package/dist/esm/sdk/models/errors/getplace.d.ts +461 -0
  108. package/dist/esm/sdk/models/errors/getplace.d.ts.map +1 -0
  109. package/dist/esm/sdk/models/errors/getplace.js +387 -0
  110. package/dist/esm/sdk/models/errors/getplace.js.map +1 -0
  111. package/dist/esm/sdk/models/errors/getplaceattributes.d.ts +201 -0
  112. package/dist/esm/sdk/models/errors/getplaceattributes.d.ts.map +1 -0
  113. package/dist/esm/sdk/models/errors/getplaceattributes.js +171 -0
  114. package/dist/esm/sdk/models/errors/getplaceattributes.js.map +1 -0
  115. package/dist/esm/sdk/models/errors/index.d.ts +3 -0
  116. package/dist/esm/sdk/models/errors/index.d.ts.map +1 -1
  117. package/dist/esm/sdk/models/errors/index.js +3 -0
  118. package/dist/esm/sdk/models/errors/index.js.map +1 -1
  119. package/dist/esm/sdk/models/operations/getnearestplaces.d.ts +35 -0
  120. package/dist/esm/sdk/models/operations/getnearestplaces.d.ts.map +1 -0
  121. package/dist/esm/sdk/models/operations/getnearestplaces.js +16 -0
  122. package/dist/esm/sdk/models/operations/getnearestplaces.js.map +1 -0
  123. package/dist/esm/sdk/models/operations/getplace.d.ts +15 -0
  124. package/dist/esm/sdk/models/operations/getplace.d.ts.map +1 -0
  125. package/dist/esm/sdk/models/operations/getplace.js +12 -0
  126. package/dist/esm/sdk/models/operations/getplace.js.map +1 -0
  127. package/dist/esm/sdk/models/operations/index.d.ts +2 -0
  128. package/dist/esm/sdk/models/operations/index.d.ts.map +1 -1
  129. package/dist/esm/sdk/models/operations/index.js +2 -0
  130. package/dist/esm/sdk/models/operations/index.js.map +1 -1
  131. package/dist/esm/sdk/models/shared/index.d.ts +7 -0
  132. package/dist/esm/sdk/models/shared/index.d.ts.map +1 -1
  133. package/dist/esm/sdk/models/shared/index.js +7 -0
  134. package/dist/esm/sdk/models/shared/index.js.map +1 -1
  135. package/dist/esm/sdk/models/shared/marketstatus.d.ts +1 -1
  136. package/dist/esm/sdk/models/shared/poiattribute.d.ts +37 -0
  137. package/dist/esm/sdk/models/shared/poiattribute.d.ts.map +1 -0
  138. package/dist/esm/sdk/models/shared/poiattribute.js +19 -0
  139. package/dist/esm/sdk/models/shared/poiattribute.js.map +1 -0
  140. package/dist/esm/sdk/models/shared/poiattributecatalogue.d.ts +17 -0
  141. package/dist/esm/sdk/models/shared/poiattributecatalogue.d.ts.map +1 -0
  142. package/dist/esm/sdk/models/shared/poiattributecatalogue.js +14 -0
  143. package/dist/esm/sdk/models/shared/poiattributecatalogue.js.map +1 -0
  144. package/dist/esm/sdk/models/shared/poifieldprovenance.d.ts +35 -0
  145. package/dist/esm/sdk/models/shared/poifieldprovenance.d.ts.map +1 -0
  146. package/dist/esm/sdk/models/shared/poifieldprovenance.js +25 -0
  147. package/dist/esm/sdk/models/shared/poifieldprovenance.js.map +1 -0
  148. package/dist/esm/sdk/models/shared/poinearestresponse.d.ts +217 -0
  149. package/dist/esm/sdk/models/shared/poinearestresponse.d.ts.map +1 -0
  150. package/dist/esm/sdk/models/shared/poinearestresponse.js +98 -0
  151. package/dist/esm/sdk/models/shared/poinearestresponse.js.map +1 -0
  152. package/dist/esm/sdk/models/shared/poiplace.d.ts +253 -0
  153. package/dist/esm/sdk/models/shared/poiplace.d.ts.map +1 -0
  154. package/dist/esm/sdk/models/shared/poiplace.js +110 -0
  155. package/dist/esm/sdk/models/shared/poiplace.js.map +1 -0
  156. package/dist/esm/sdk/models/shared/poiprovenance.d.ts +81 -0
  157. package/dist/esm/sdk/models/shared/poiprovenance.d.ts.map +1 -0
  158. package/dist/esm/sdk/models/shared/poiprovenance.js +30 -0
  159. package/dist/esm/sdk/models/shared/poiprovenance.js.map +1 -0
  160. package/dist/esm/sdk/models/shared/poiregistermatch.d.ts +48 -0
  161. package/dist/esm/sdk/models/shared/poiregistermatch.d.ts.map +1 -0
  162. package/dist/esm/sdk/models/shared/poiregistermatch.js +34 -0
  163. package/dist/esm/sdk/models/shared/poiregistermatch.js.map +1 -0
  164. package/dist/esm/sdk/models/shared/pscexemption.d.ts +4 -4
  165. package/dist/esm/sdk/models/shared/pscexemption.d.ts.map +1 -1
  166. package/dist/esm/sdk/models/shared/pscexemption.js +4 -5
  167. package/dist/esm/sdk/models/shared/pscexemption.js.map +1 -1
  168. package/dist/esm/sdk/places.d.ts +27 -0
  169. package/dist/esm/sdk/places.d.ts.map +1 -0
  170. package/dist/esm/sdk/places.js +38 -0
  171. package/dist/esm/sdk/places.js.map +1 -0
  172. package/dist/esm/sdk/sdk.d.ts +3 -0
  173. package/dist/esm/sdk/sdk.d.ts.map +1 -1
  174. package/dist/esm/sdk/sdk.js +4 -0
  175. package/dist/esm/sdk/sdk.js.map +1 -1
  176. package/package.json +2 -2
  177. package/src/funcs/placesAttributes.ts +164 -0
  178. package/src/funcs/placesGet.ts +201 -0
  179. package/src/funcs/placesNearest.ts +212 -0
  180. package/src/lib/config.ts +3 -3
  181. package/src/sdk/models/errors/getnearestplaces.ts +783 -0
  182. package/src/sdk/models/errors/getplace.ts +897 -0
  183. package/src/sdk/models/errors/getplaceattributes.ts +393 -0
  184. package/src/sdk/models/errors/index.ts +3 -0
  185. package/src/sdk/models/operations/getnearestplaces.ts +58 -0
  186. package/src/sdk/models/operations/getplace.ts +32 -0
  187. package/src/sdk/models/operations/index.ts +2 -0
  188. package/src/sdk/models/shared/index.ts +7 -0
  189. package/src/sdk/models/shared/marketstatus.ts +1 -1
  190. package/src/sdk/models/shared/poiattribute.ts +64 -0
  191. package/src/sdk/models/shared/poiattributecatalogue.ts +38 -0
  192. package/src/sdk/models/shared/poifieldprovenance.ts +62 -0
  193. package/src/sdk/models/shared/poinearestresponse.ts +372 -0
  194. package/src/sdk/models/shared/poiplace.ts +397 -0
  195. package/src/sdk/models/shared/poiprovenance.ts +121 -0
  196. package/src/sdk/models/shared/poiregistermatch.ts +84 -0
  197. package/src/sdk/models/shared/pscexemption.ts +15 -12
  198. package/src/sdk/places.ts +62 -0
  199. package/src/sdk/sdk.ts +6 -0
@@ -0,0 +1,62 @@
1
+ /*
2
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
3
+ */
4
+
5
+ import { placesAttributes } from "../funcs/placesAttributes.js";
6
+ import { placesGet } from "../funcs/placesGet.js";
7
+ import { placesNearest } from "../funcs/placesNearest.js";
8
+ import { ClientSDK, RequestOptions } from "../lib/sdks.js";
9
+ import * as operations from "./models/operations/index.js";
10
+ import * as shared from "./models/shared/index.js";
11
+ import { unwrapAsync } from "./types/fp.js";
12
+
13
+ export class Places extends ClientSDK {
14
+ /**
15
+ * List point of interest attributes
16
+ *
17
+ * @remarks
18
+ * Lists every attribute a point of interest can carry, with its type, whether it can be null, whether the nearest endpoint returns it, and the account permission it needs. Free.
19
+ */
20
+ async attributes(
21
+ options?: RequestOptions,
22
+ ): Promise<shared.PoiAttributeCatalogue> {
23
+ return unwrapAsync(placesAttributes(
24
+ this,
25
+ options,
26
+ ));
27
+ }
28
+
29
+ /**
30
+ * Get a point of interest
31
+ *
32
+ * @remarks
33
+ * Returns one point of interest with every published attribute: identity, location, address, matched property, contact details, brand where known, operating status, register match, food hygiene rating and, per field, where the value comes from. Charged per place.
34
+ */
35
+ async get(
36
+ request: operations.GetPlaceRequest,
37
+ options?: RequestOptions,
38
+ ): Promise<shared.PoiPlace> {
39
+ return unwrapAsync(placesGet(
40
+ this,
41
+ request,
42
+ options,
43
+ ));
44
+ }
45
+
46
+ /**
47
+ * Find the nearest points of interest
48
+ *
49
+ * @remarks
50
+ * Returns the points of interest nearest a point within a radius, nearest first, each with its straight-line distance in metres and its brand where known. Covers the businesses registered for food hygiene and the other places whose existence is corroborated. A registered food business can be any premises that handles food, a care home or a school as well as a restaurant, so filter on `categories` for a kind of place: `categoryPath` is given only where it is corroborated and is null otherwise. Places with no corroborated location are not returned. Charged per place returned.
51
+ */
52
+ async nearest(
53
+ request: operations.GetNearestPlacesRequest,
54
+ options?: RequestOptions,
55
+ ): Promise<shared.PoiNearestResponse> {
56
+ return unwrapAsync(placesNearest(
57
+ this,
58
+ request,
59
+ options,
60
+ ));
61
+ }
62
+ }
package/src/sdk/sdk.ts CHANGED
@@ -23,6 +23,7 @@ import { Listings } from "./listings.js";
23
23
  import { Metrics } from "./metrics.js";
24
24
  import { Models } from "./models.js";
25
25
  import { Noise } from "./noise.js";
26
+ import { Places } from "./places.js";
26
27
  import { Planning } from "./planning.js";
27
28
  import { Poi } from "./poi.js";
28
29
  import { Property } from "./property.js";
@@ -158,6 +159,11 @@ export class SDK extends ClientSDK {
158
159
  return (this._planning ??= new Planning(this._options));
159
160
  }
160
161
 
162
+ private _places?: Places;
163
+ get places(): Places {
164
+ return (this._places ??= new Places(this._options));
165
+ }
166
+
161
167
  private _property?: Property;
162
168
  get property(): Property {
163
169
  return (this._property ??= new Property(this._options));