@vepler/sdk 1.9.11 → 1.10.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 (405) hide show
  1. package/README.md +30 -1
  2. package/dist/commonjs/funcs/safetyGetV1SafetyCrime.d.ts +17 -0
  3. package/dist/commonjs/funcs/safetyGetV1SafetyCrime.d.ts.map +1 -0
  4. package/dist/commonjs/funcs/safetyGetV1SafetyCrime.js +120 -0
  5. package/dist/commonjs/funcs/safetyGetV1SafetyCrime.js.map +1 -0
  6. package/dist/commonjs/funcs/safetyGetV1SafetyCrimeStats.d.ts +17 -0
  7. package/dist/commonjs/funcs/safetyGetV1SafetyCrimeStats.d.ts.map +1 -0
  8. package/dist/commonjs/funcs/safetyGetV1SafetyCrimeStats.js +120 -0
  9. package/dist/commonjs/funcs/safetyGetV1SafetyCrimeStats.js.map +1 -0
  10. package/dist/commonjs/funcs/schoolMetricsGetMetrics.d.ts +17 -0
  11. package/dist/commonjs/funcs/schoolMetricsGetMetrics.d.ts.map +1 -0
  12. package/dist/commonjs/funcs/schoolMetricsGetMetrics.js +130 -0
  13. package/dist/commonjs/funcs/schoolMetricsGetMetrics.js.map +1 -0
  14. package/dist/commonjs/funcs/schoolMetricsListProfiles.d.ts +17 -0
  15. package/dist/commonjs/funcs/schoolMetricsListProfiles.d.ts.map +1 -0
  16. package/dist/commonjs/funcs/schoolMetricsListProfiles.js +104 -0
  17. package/dist/commonjs/funcs/schoolMetricsListProfiles.js.map +1 -0
  18. package/dist/commonjs/funcs/schoolsGet.d.ts +17 -0
  19. package/dist/commonjs/funcs/schoolsGet.d.ts.map +1 -0
  20. package/dist/commonjs/funcs/schoolsGet.js +124 -0
  21. package/dist/commonjs/funcs/schoolsGet.js.map +1 -0
  22. package/dist/commonjs/funcs/schoolsGetBySlug.d.ts +17 -0
  23. package/dist/commonjs/funcs/schoolsGetBySlug.d.ts.map +1 -0
  24. package/dist/commonjs/funcs/schoolsGetBySlug.js +124 -0
  25. package/dist/commonjs/funcs/schoolsGetBySlug.js.map +1 -0
  26. package/dist/commonjs/funcs/schoolsGetByUrn.d.ts +17 -0
  27. package/dist/commonjs/funcs/schoolsGetByUrn.d.ts.map +1 -0
  28. package/dist/commonjs/funcs/schoolsGetByUrn.js +124 -0
  29. package/dist/commonjs/funcs/schoolsGetByUrn.js.map +1 -0
  30. package/dist/commonjs/funcs/schoolsList.d.ts +17 -0
  31. package/dist/commonjs/funcs/schoolsList.d.ts.map +1 -0
  32. package/dist/commonjs/funcs/schoolsList.js +126 -0
  33. package/dist/commonjs/funcs/schoolsList.js.map +1 -0
  34. package/dist/commonjs/funcs/schoolsSearchNearby.d.ts +17 -0
  35. package/dist/commonjs/funcs/schoolsSearchNearby.d.ts.map +1 -0
  36. package/dist/commonjs/funcs/schoolsSearchNearby.js +125 -0
  37. package/dist/commonjs/funcs/schoolsSearchNearby.js.map +1 -0
  38. package/dist/commonjs/funcs/schoolsSearchWithin.d.ts +17 -0
  39. package/dist/commonjs/funcs/schoolsSearchWithin.d.ts.map +1 -0
  40. package/dist/commonjs/funcs/schoolsSearchWithin.js +125 -0
  41. package/dist/commonjs/funcs/schoolsSearchWithin.js.map +1 -0
  42. package/dist/commonjs/lib/config.d.ts +4 -4
  43. package/dist/commonjs/lib/config.d.ts.map +1 -1
  44. package/dist/commonjs/lib/config.js +4 -4
  45. package/dist/commonjs/lib/config.js.map +1 -1
  46. package/dist/commonjs/sdk/models/operations/getmetricprofiles.d.ts +89 -0
  47. package/dist/commonjs/sdk/models/operations/getmetricprofiles.d.ts.map +1 -0
  48. package/dist/commonjs/sdk/models/operations/getmetricprofiles.js +121 -0
  49. package/dist/commonjs/sdk/models/operations/getmetricprofiles.js.map +1 -0
  50. package/dist/commonjs/sdk/models/operations/getschoolbyid.d.ts +245 -0
  51. package/dist/commonjs/sdk/models/operations/getschoolbyid.d.ts.map +1 -0
  52. package/dist/commonjs/sdk/models/operations/getschoolbyid.js +267 -0
  53. package/dist/commonjs/sdk/models/operations/getschoolbyid.js.map +1 -0
  54. package/dist/commonjs/sdk/models/operations/getschoolbyslug.d.ts +245 -0
  55. package/dist/commonjs/sdk/models/operations/getschoolbyslug.d.ts.map +1 -0
  56. package/dist/commonjs/sdk/models/operations/getschoolbyslug.js +267 -0
  57. package/dist/commonjs/sdk/models/operations/getschoolbyslug.js.map +1 -0
  58. package/dist/commonjs/sdk/models/operations/getschoolbyurn.d.ts +245 -0
  59. package/dist/commonjs/sdk/models/operations/getschoolbyurn.d.ts.map +1 -0
  60. package/dist/commonjs/sdk/models/operations/getschoolbyurn.js +267 -0
  61. package/dist/commonjs/sdk/models/operations/getschoolbyurn.js.map +1 -0
  62. package/dist/commonjs/sdk/models/operations/getschoolmetrics.d.ts +901 -0
  63. package/dist/commonjs/sdk/models/operations/getschoolmetrics.d.ts.map +1 -0
  64. package/dist/commonjs/sdk/models/operations/getschoolmetrics.js +843 -0
  65. package/dist/commonjs/sdk/models/operations/getschoolmetrics.js.map +1 -0
  66. package/dist/commonjs/sdk/models/operations/getv1safetycrime.d.ts +309 -0
  67. package/dist/commonjs/sdk/models/operations/getv1safetycrime.d.ts.map +1 -0
  68. package/dist/commonjs/sdk/models/operations/getv1safetycrime.js +352 -0
  69. package/dist/commonjs/sdk/models/operations/getv1safetycrime.js.map +1 -0
  70. package/dist/commonjs/sdk/models/operations/getv1safetycrimestats.d.ts +330 -0
  71. package/dist/commonjs/sdk/models/operations/getv1safetycrimestats.d.ts.map +1 -0
  72. package/dist/commonjs/sdk/models/operations/getv1safetycrimestats.js +366 -0
  73. package/dist/commonjs/sdk/models/operations/getv1safetycrimestats.js.map +1 -0
  74. package/dist/commonjs/sdk/models/operations/index.d.ts +10 -0
  75. package/dist/commonjs/sdk/models/operations/index.d.ts.map +1 -1
  76. package/dist/commonjs/sdk/models/operations/index.js +10 -0
  77. package/dist/commonjs/sdk/models/operations/index.js.map +1 -1
  78. package/dist/commonjs/sdk/models/operations/listschools.d.ts +248 -0
  79. package/dist/commonjs/sdk/models/operations/listschools.d.ts.map +1 -0
  80. package/dist/commonjs/sdk/models/operations/listschools.js +262 -0
  81. package/dist/commonjs/sdk/models/operations/listschools.js.map +1 -0
  82. package/dist/commonjs/sdk/models/operations/searchschoolsnearby.d.ts +274 -0
  83. package/dist/commonjs/sdk/models/operations/searchschoolsnearby.d.ts.map +1 -0
  84. package/dist/commonjs/sdk/models/operations/searchschoolsnearby.js +282 -0
  85. package/dist/commonjs/sdk/models/operations/searchschoolsnearby.js.map +1 -0
  86. package/dist/commonjs/sdk/models/operations/searchschoolswithin.d.ts +243 -0
  87. package/dist/commonjs/sdk/models/operations/searchschoolswithin.d.ts.map +1 -0
  88. package/dist/commonjs/sdk/models/operations/searchschoolswithin.js +260 -0
  89. package/dist/commonjs/sdk/models/operations/searchschoolswithin.js.map +1 -0
  90. package/dist/commonjs/sdk/models/shared/index.d.ts +11 -5
  91. package/dist/commonjs/sdk/models/shared/index.d.ts.map +1 -1
  92. package/dist/commonjs/sdk/models/shared/index.js +11 -5
  93. package/dist/commonjs/sdk/models/shared/index.js.map +1 -1
  94. package/dist/commonjs/sdk/models/shared/propertyaddress.d.ts +1 -1
  95. package/dist/commonjs/sdk/models/shared/propertyareafilter.d.ts +31 -0
  96. package/dist/commonjs/sdk/models/shared/propertyareafilter.d.ts.map +1 -0
  97. package/dist/commonjs/sdk/models/shared/propertyareafilter.js +85 -0
  98. package/dist/commonjs/sdk/models/shared/propertyareafilter.js.map +1 -0
  99. package/dist/commonjs/sdk/models/shared/propertylocationidareafilter.d.ts +32 -0
  100. package/dist/commonjs/sdk/models/shared/propertylocationidareafilter.d.ts.map +1 -0
  101. package/dist/commonjs/sdk/models/shared/propertylocationidareafilter.js +69 -0
  102. package/dist/commonjs/sdk/models/shared/propertylocationidareafilter.js.map +1 -0
  103. package/dist/commonjs/sdk/models/shared/propertymultipolygonareafilter.d.ts +57 -0
  104. package/dist/commonjs/sdk/models/shared/propertymultipolygonareafilter.d.ts.map +1 -0
  105. package/dist/commonjs/sdk/models/shared/{pointareafilter.js → propertymultipolygonareafilter.js} +20 -22
  106. package/dist/commonjs/sdk/models/shared/propertymultipolygonareafilter.js.map +1 -0
  107. package/dist/commonjs/sdk/models/shared/propertyoutcodeareafilter.d.ts +57 -0
  108. package/dist/commonjs/sdk/models/shared/propertyoutcodeareafilter.d.ts.map +1 -0
  109. package/dist/commonjs/sdk/models/shared/propertyoutcodeareafilter.js +89 -0
  110. package/dist/commonjs/sdk/models/shared/propertyoutcodeareafilter.js.map +1 -0
  111. package/dist/commonjs/sdk/models/shared/propertypointareafilter.d.ts +62 -0
  112. package/dist/commonjs/sdk/models/shared/propertypointareafilter.d.ts.map +1 -0
  113. package/dist/commonjs/sdk/models/shared/propertypointareafilter.js +91 -0
  114. package/dist/commonjs/sdk/models/shared/propertypointareafilter.js.map +1 -0
  115. package/dist/commonjs/sdk/models/shared/propertypolygonareafilter.d.ts +57 -0
  116. package/dist/commonjs/sdk/models/shared/propertypolygonareafilter.d.ts.map +1 -0
  117. package/dist/commonjs/sdk/models/shared/propertypolygonareafilter.js +89 -0
  118. package/dist/commonjs/sdk/models/shared/propertypolygonareafilter.js.map +1 -0
  119. package/dist/commonjs/sdk/models/shared/propertypostcodeareafilter.d.ts +62 -0
  120. package/dist/commonjs/sdk/models/shared/propertypostcodeareafilter.d.ts.map +1 -0
  121. package/dist/commonjs/sdk/models/shared/propertypostcodeareafilter.js +91 -0
  122. package/dist/commonjs/sdk/models/shared/propertypostcodeareafilter.js.map +1 -0
  123. package/dist/commonjs/sdk/models/shared/propertyquerycondition.d.ts +146 -0
  124. package/dist/commonjs/sdk/models/shared/propertyquerycondition.d.ts.map +1 -0
  125. package/dist/commonjs/sdk/models/shared/propertyquerycondition.js +173 -0
  126. package/dist/commonjs/sdk/models/shared/propertyquerycondition.js.map +1 -0
  127. package/dist/commonjs/sdk/models/shared/propertyquerygroup.d.ts +33 -0
  128. package/dist/commonjs/sdk/models/shared/propertyquerygroup.d.ts.map +1 -0
  129. package/dist/commonjs/sdk/models/shared/propertyquerygroup.js +70 -0
  130. package/dist/commonjs/sdk/models/shared/propertyquerygroup.js.map +1 -0
  131. package/dist/commonjs/sdk/models/shared/propertyqueryoperator.d.ts +70 -0
  132. package/dist/commonjs/sdk/models/shared/propertyqueryoperator.d.ts.map +1 -0
  133. package/dist/commonjs/sdk/models/shared/propertyqueryoperator.js +95 -0
  134. package/dist/commonjs/sdk/models/shared/propertyqueryoperator.js.map +1 -0
  135. package/dist/commonjs/sdk/models/shared/propertyqueryrequest.d.ts +27 -80
  136. package/dist/commonjs/sdk/models/shared/propertyqueryrequest.d.ts.map +1 -1
  137. package/dist/commonjs/sdk/models/shared/propertyqueryrequest.js +28 -54
  138. package/dist/commonjs/sdk/models/shared/propertyqueryrequest.js.map +1 -1
  139. package/dist/commonjs/sdk/models/shared/school.d.ts +441 -0
  140. package/dist/commonjs/sdk/models/shared/school.d.ts.map +1 -0
  141. package/dist/commonjs/sdk/models/shared/school.js +301 -0
  142. package/dist/commonjs/sdk/models/shared/school.js.map +1 -0
  143. package/dist/commonjs/sdk/models/shared/streetquerybycoordinates.d.ts +2 -2
  144. package/dist/commonjs/sdk/safety.d.ts +19 -0
  145. package/dist/commonjs/sdk/safety.d.ts.map +1 -0
  146. package/dist/commonjs/sdk/safety.js +32 -0
  147. package/dist/commonjs/sdk/safety.js.map +1 -0
  148. package/dist/commonjs/sdk/schoolmetrics.d.ts +19 -0
  149. package/dist/commonjs/sdk/schoolmetrics.d.ts.map +1 -0
  150. package/dist/commonjs/sdk/schoolmetrics.js +32 -0
  151. package/dist/commonjs/sdk/schoolmetrics.js.map +1 -0
  152. package/dist/commonjs/sdk/schools.d.ts +47 -0
  153. package/dist/commonjs/sdk/schools.d.ts.map +1 -0
  154. package/dist/commonjs/sdk/schools.js +72 -0
  155. package/dist/commonjs/sdk/schools.js.map +1 -0
  156. package/dist/commonjs/sdk/sdk.d.ts +9 -0
  157. package/dist/commonjs/sdk/sdk.d.ts.map +1 -1
  158. package/dist/commonjs/sdk/sdk.js +12 -0
  159. package/dist/commonjs/sdk/sdk.js.map +1 -1
  160. package/dist/esm/funcs/safetyGetV1SafetyCrime.d.ts +17 -0
  161. package/dist/esm/funcs/safetyGetV1SafetyCrime.d.ts.map +1 -0
  162. package/dist/esm/funcs/safetyGetV1SafetyCrime.js +84 -0
  163. package/dist/esm/funcs/safetyGetV1SafetyCrime.js.map +1 -0
  164. package/dist/esm/funcs/safetyGetV1SafetyCrimeStats.d.ts +17 -0
  165. package/dist/esm/funcs/safetyGetV1SafetyCrimeStats.d.ts.map +1 -0
  166. package/dist/esm/funcs/safetyGetV1SafetyCrimeStats.js +84 -0
  167. package/dist/esm/funcs/safetyGetV1SafetyCrimeStats.js.map +1 -0
  168. package/dist/esm/funcs/schoolMetricsGetMetrics.d.ts +17 -0
  169. package/dist/esm/funcs/schoolMetricsGetMetrics.d.ts.map +1 -0
  170. package/dist/esm/funcs/schoolMetricsGetMetrics.js +94 -0
  171. package/dist/esm/funcs/schoolMetricsGetMetrics.js.map +1 -0
  172. package/dist/esm/funcs/schoolMetricsListProfiles.d.ts +17 -0
  173. package/dist/esm/funcs/schoolMetricsListProfiles.d.ts.map +1 -0
  174. package/dist/esm/funcs/schoolMetricsListProfiles.js +68 -0
  175. package/dist/esm/funcs/schoolMetricsListProfiles.js.map +1 -0
  176. package/dist/esm/funcs/schoolsGet.d.ts +17 -0
  177. package/dist/esm/funcs/schoolsGet.d.ts.map +1 -0
  178. package/dist/esm/funcs/schoolsGet.js +88 -0
  179. package/dist/esm/funcs/schoolsGet.js.map +1 -0
  180. package/dist/esm/funcs/schoolsGetBySlug.d.ts +17 -0
  181. package/dist/esm/funcs/schoolsGetBySlug.d.ts.map +1 -0
  182. package/dist/esm/funcs/schoolsGetBySlug.js +88 -0
  183. package/dist/esm/funcs/schoolsGetBySlug.js.map +1 -0
  184. package/dist/esm/funcs/schoolsGetByUrn.d.ts +17 -0
  185. package/dist/esm/funcs/schoolsGetByUrn.d.ts.map +1 -0
  186. package/dist/esm/funcs/schoolsGetByUrn.js +88 -0
  187. package/dist/esm/funcs/schoolsGetByUrn.js.map +1 -0
  188. package/dist/esm/funcs/schoolsList.d.ts +17 -0
  189. package/dist/esm/funcs/schoolsList.d.ts.map +1 -0
  190. package/dist/esm/funcs/schoolsList.js +90 -0
  191. package/dist/esm/funcs/schoolsList.js.map +1 -0
  192. package/dist/esm/funcs/schoolsSearchNearby.d.ts +17 -0
  193. package/dist/esm/funcs/schoolsSearchNearby.d.ts.map +1 -0
  194. package/dist/esm/funcs/schoolsSearchNearby.js +89 -0
  195. package/dist/esm/funcs/schoolsSearchNearby.js.map +1 -0
  196. package/dist/esm/funcs/schoolsSearchWithin.d.ts +17 -0
  197. package/dist/esm/funcs/schoolsSearchWithin.d.ts.map +1 -0
  198. package/dist/esm/funcs/schoolsSearchWithin.js +89 -0
  199. package/dist/esm/funcs/schoolsSearchWithin.js.map +1 -0
  200. package/dist/esm/lib/config.d.ts +4 -4
  201. package/dist/esm/lib/config.d.ts.map +1 -1
  202. package/dist/esm/lib/config.js +4 -4
  203. package/dist/esm/lib/config.js.map +1 -1
  204. package/dist/esm/sdk/models/operations/getmetricprofiles.d.ts +89 -0
  205. package/dist/esm/sdk/models/operations/getmetricprofiles.d.ts.map +1 -0
  206. package/dist/esm/sdk/models/operations/getmetricprofiles.js +81 -0
  207. package/dist/esm/sdk/models/operations/getmetricprofiles.js.map +1 -0
  208. package/dist/esm/sdk/models/operations/getschoolbyid.d.ts +245 -0
  209. package/dist/esm/sdk/models/operations/getschoolbyid.d.ts.map +1 -0
  210. package/dist/esm/sdk/models/operations/getschoolbyid.js +219 -0
  211. package/dist/esm/sdk/models/operations/getschoolbyid.js.map +1 -0
  212. package/dist/esm/sdk/models/operations/getschoolbyslug.d.ts +245 -0
  213. package/dist/esm/sdk/models/operations/getschoolbyslug.d.ts.map +1 -0
  214. package/dist/esm/sdk/models/operations/getschoolbyslug.js +219 -0
  215. package/dist/esm/sdk/models/operations/getschoolbyslug.js.map +1 -0
  216. package/dist/esm/sdk/models/operations/getschoolbyurn.d.ts +245 -0
  217. package/dist/esm/sdk/models/operations/getschoolbyurn.d.ts.map +1 -0
  218. package/dist/esm/sdk/models/operations/getschoolbyurn.js +219 -0
  219. package/dist/esm/sdk/models/operations/getschoolbyurn.js.map +1 -0
  220. package/dist/esm/sdk/models/operations/getschoolmetrics.d.ts +901 -0
  221. package/dist/esm/sdk/models/operations/getschoolmetrics.d.ts.map +1 -0
  222. package/dist/esm/sdk/models/operations/getschoolmetrics.js +770 -0
  223. package/dist/esm/sdk/models/operations/getschoolmetrics.js.map +1 -0
  224. package/dist/esm/sdk/models/operations/getv1safetycrime.d.ts +309 -0
  225. package/dist/esm/sdk/models/operations/getv1safetycrime.d.ts.map +1 -0
  226. package/dist/esm/sdk/models/operations/getv1safetycrime.js +296 -0
  227. package/dist/esm/sdk/models/operations/getv1safetycrime.js.map +1 -0
  228. package/dist/esm/sdk/models/operations/getv1safetycrimestats.d.ts +330 -0
  229. package/dist/esm/sdk/models/operations/getv1safetycrimestats.d.ts.map +1 -0
  230. package/dist/esm/sdk/models/operations/getv1safetycrimestats.js +310 -0
  231. package/dist/esm/sdk/models/operations/getv1safetycrimestats.js.map +1 -0
  232. package/dist/esm/sdk/models/operations/index.d.ts +10 -0
  233. package/dist/esm/sdk/models/operations/index.d.ts.map +1 -1
  234. package/dist/esm/sdk/models/operations/index.js +10 -0
  235. package/dist/esm/sdk/models/operations/index.js.map +1 -1
  236. package/dist/esm/sdk/models/operations/listschools.d.ts +248 -0
  237. package/dist/esm/sdk/models/operations/listschools.d.ts.map +1 -0
  238. package/dist/esm/sdk/models/operations/listschools.js +216 -0
  239. package/dist/esm/sdk/models/operations/listschools.js.map +1 -0
  240. package/dist/esm/sdk/models/operations/searchschoolsnearby.d.ts +274 -0
  241. package/dist/esm/sdk/models/operations/searchschoolsnearby.d.ts.map +1 -0
  242. package/dist/esm/sdk/models/operations/searchschoolsnearby.js +236 -0
  243. package/dist/esm/sdk/models/operations/searchschoolsnearby.js.map +1 -0
  244. package/dist/esm/sdk/models/operations/searchschoolswithin.d.ts +243 -0
  245. package/dist/esm/sdk/models/operations/searchschoolswithin.d.ts.map +1 -0
  246. package/dist/esm/sdk/models/operations/searchschoolswithin.js +214 -0
  247. package/dist/esm/sdk/models/operations/searchschoolswithin.js.map +1 -0
  248. package/dist/esm/sdk/models/shared/index.d.ts +11 -5
  249. package/dist/esm/sdk/models/shared/index.d.ts.map +1 -1
  250. package/dist/esm/sdk/models/shared/index.js +11 -5
  251. package/dist/esm/sdk/models/shared/index.js.map +1 -1
  252. package/dist/esm/sdk/models/shared/propertyaddress.d.ts +1 -1
  253. package/dist/esm/sdk/models/shared/propertyareafilter.d.ts +31 -0
  254. package/dist/esm/sdk/models/shared/propertyareafilter.d.ts.map +1 -0
  255. package/dist/esm/sdk/models/shared/propertyareafilter.js +47 -0
  256. package/dist/esm/sdk/models/shared/propertyareafilter.js.map +1 -0
  257. package/dist/esm/sdk/models/shared/propertylocationidareafilter.d.ts +32 -0
  258. package/dist/esm/sdk/models/shared/propertylocationidareafilter.d.ts.map +1 -0
  259. package/dist/esm/sdk/models/shared/propertylocationidareafilter.js +31 -0
  260. package/dist/esm/sdk/models/shared/propertylocationidareafilter.js.map +1 -0
  261. package/dist/esm/sdk/models/shared/propertymultipolygonareafilter.d.ts +57 -0
  262. package/dist/esm/sdk/models/shared/propertymultipolygonareafilter.d.ts.map +1 -0
  263. package/dist/esm/sdk/models/shared/propertymultipolygonareafilter.js +51 -0
  264. package/dist/esm/sdk/models/shared/propertymultipolygonareafilter.js.map +1 -0
  265. package/dist/esm/sdk/models/shared/propertyoutcodeareafilter.d.ts +57 -0
  266. package/dist/esm/sdk/models/shared/propertyoutcodeareafilter.d.ts.map +1 -0
  267. package/dist/esm/sdk/models/shared/propertyoutcodeareafilter.js +51 -0
  268. package/dist/esm/sdk/models/shared/propertyoutcodeareafilter.js.map +1 -0
  269. package/dist/esm/sdk/models/shared/propertypointareafilter.d.ts +62 -0
  270. package/dist/esm/sdk/models/shared/propertypointareafilter.d.ts.map +1 -0
  271. package/dist/esm/sdk/models/shared/propertypointareafilter.js +53 -0
  272. package/dist/esm/sdk/models/shared/propertypointareafilter.js.map +1 -0
  273. package/dist/esm/sdk/models/shared/propertypolygonareafilter.d.ts +57 -0
  274. package/dist/esm/sdk/models/shared/propertypolygonareafilter.d.ts.map +1 -0
  275. package/dist/esm/sdk/models/shared/propertypolygonareafilter.js +51 -0
  276. package/dist/esm/sdk/models/shared/propertypolygonareafilter.js.map +1 -0
  277. package/dist/esm/sdk/models/shared/propertypostcodeareafilter.d.ts +62 -0
  278. package/dist/esm/sdk/models/shared/propertypostcodeareafilter.d.ts.map +1 -0
  279. package/dist/esm/sdk/models/shared/propertypostcodeareafilter.js +53 -0
  280. package/dist/esm/sdk/models/shared/propertypostcodeareafilter.js.map +1 -0
  281. package/dist/esm/sdk/models/shared/propertyquerycondition.d.ts +146 -0
  282. package/dist/esm/sdk/models/shared/propertyquerycondition.d.ts.map +1 -0
  283. package/dist/esm/sdk/models/shared/propertyquerycondition.js +131 -0
  284. package/dist/esm/sdk/models/shared/propertyquerycondition.js.map +1 -0
  285. package/dist/esm/sdk/models/shared/propertyquerygroup.d.ts +33 -0
  286. package/dist/esm/sdk/models/shared/propertyquerygroup.d.ts.map +1 -0
  287. package/dist/esm/sdk/models/shared/propertyquerygroup.js +32 -0
  288. package/dist/esm/sdk/models/shared/propertyquerygroup.js.map +1 -0
  289. package/dist/esm/sdk/models/shared/propertyqueryoperator.d.ts +70 -0
  290. package/dist/esm/sdk/models/shared/propertyqueryoperator.d.ts.map +1 -0
  291. package/dist/esm/sdk/models/shared/propertyqueryoperator.js +57 -0
  292. package/dist/esm/sdk/models/shared/propertyqueryoperator.js.map +1 -0
  293. package/dist/esm/sdk/models/shared/propertyqueryrequest.d.ts +27 -80
  294. package/dist/esm/sdk/models/shared/propertyqueryrequest.d.ts.map +1 -1
  295. package/dist/esm/sdk/models/shared/propertyqueryrequest.js +25 -53
  296. package/dist/esm/sdk/models/shared/propertyqueryrequest.js.map +1 -1
  297. package/dist/esm/sdk/models/shared/school.d.ts +441 -0
  298. package/dist/esm/sdk/models/shared/school.d.ts.map +1 -0
  299. package/dist/esm/sdk/models/shared/school.js +259 -0
  300. package/dist/esm/sdk/models/shared/school.js.map +1 -0
  301. package/dist/esm/sdk/models/shared/streetquerybycoordinates.d.ts +2 -2
  302. package/dist/esm/sdk/safety.d.ts +19 -0
  303. package/dist/esm/sdk/safety.d.ts.map +1 -0
  304. package/dist/esm/sdk/safety.js +28 -0
  305. package/dist/esm/sdk/safety.js.map +1 -0
  306. package/dist/esm/sdk/schoolmetrics.d.ts +19 -0
  307. package/dist/esm/sdk/schoolmetrics.d.ts.map +1 -0
  308. package/dist/esm/sdk/schoolmetrics.js +28 -0
  309. package/dist/esm/sdk/schoolmetrics.js.map +1 -0
  310. package/dist/esm/sdk/schools.d.ts +47 -0
  311. package/dist/esm/sdk/schools.d.ts.map +1 -0
  312. package/dist/esm/sdk/schools.js +68 -0
  313. package/dist/esm/sdk/schools.js.map +1 -0
  314. package/dist/esm/sdk/sdk.d.ts +9 -0
  315. package/dist/esm/sdk/sdk.d.ts.map +1 -1
  316. package/dist/esm/sdk/sdk.js +12 -0
  317. package/dist/esm/sdk/sdk.js.map +1 -1
  318. package/openapi.json +908 -1
  319. package/package.json +1 -1
  320. package/src/funcs/safetyGetV1SafetyCrime.ts +167 -0
  321. package/src/funcs/safetyGetV1SafetyCrimeStats.ts +168 -0
  322. package/src/funcs/schoolMetricsGetMetrics.ts +177 -0
  323. package/src/funcs/schoolMetricsListProfiles.ts +140 -0
  324. package/src/funcs/schoolsGet.ts +172 -0
  325. package/src/funcs/schoolsGetBySlug.ts +172 -0
  326. package/src/funcs/schoolsGetByUrn.ts +172 -0
  327. package/src/funcs/schoolsList.ts +173 -0
  328. package/src/funcs/schoolsSearchNearby.ts +172 -0
  329. package/src/funcs/schoolsSearchWithin.ts +172 -0
  330. package/src/lib/config.ts +4 -4
  331. package/src/sdk/models/operations/getmetricprofiles.ts +169 -0
  332. package/src/sdk/models/operations/getschoolbyid.ts +473 -0
  333. package/src/sdk/models/operations/getschoolbyslug.ts +479 -0
  334. package/src/sdk/models/operations/getschoolbyurn.ts +474 -0
  335. package/src/sdk/models/operations/getschoolmetrics.ts +1563 -0
  336. package/src/sdk/models/operations/getv1safetycrime.ts +671 -0
  337. package/src/sdk/models/operations/getv1safetycrimestats.ts +733 -0
  338. package/src/sdk/models/operations/index.ts +10 -0
  339. package/src/sdk/models/operations/listschools.ts +470 -0
  340. package/src/sdk/models/operations/searchschoolsnearby.ts +507 -0
  341. package/src/sdk/models/operations/searchschoolswithin.ts +475 -0
  342. package/src/sdk/models/shared/index.ts +11 -5
  343. package/src/sdk/models/shared/propertyaddress.ts +1 -1
  344. package/src/sdk/models/shared/propertyareafilter.ts +120 -0
  345. package/src/sdk/models/shared/propertylocationidareafilter.ts +71 -0
  346. package/src/sdk/models/shared/propertymultipolygonareafilter.ts +101 -0
  347. package/src/sdk/models/shared/propertyoutcodeareafilter.ts +102 -0
  348. package/src/sdk/models/shared/propertypointareafilter.ts +109 -0
  349. package/src/sdk/models/shared/propertypolygonareafilter.ts +102 -0
  350. package/src/sdk/models/shared/propertypostcodeareafilter.ts +109 -0
  351. package/src/sdk/models/shared/propertyquerycondition.ts +238 -0
  352. package/src/sdk/models/shared/propertyquerygroup.ts +75 -0
  353. package/src/sdk/models/shared/propertyqueryoperator.ts +114 -0
  354. package/src/sdk/models/shared/propertyqueryrequest.ts +62 -94
  355. package/src/sdk/models/shared/school.ts +588 -0
  356. package/src/sdk/models/shared/streetquerybycoordinates.ts +2 -2
  357. package/src/sdk/safety.ts +45 -0
  358. package/src/sdk/schoolmetrics.ts +43 -0
  359. package/src/sdk/schools.ts +117 -0
  360. package/src/sdk/sdk.ts +18 -0
  361. package/test-local.ts +4 -4
  362. package/dist/commonjs/sdk/models/shared/areafilter.d.ts +0 -40
  363. package/dist/commonjs/sdk/models/shared/areafilter.d.ts.map +0 -1
  364. package/dist/commonjs/sdk/models/shared/areafilter.js +0 -84
  365. package/dist/commonjs/sdk/models/shared/areafilter.js.map +0 -1
  366. package/dist/commonjs/sdk/models/shared/pointareafilter.d.ts +0 -62
  367. package/dist/commonjs/sdk/models/shared/pointareafilter.d.ts.map +0 -1
  368. package/dist/commonjs/sdk/models/shared/pointareafilter.js.map +0 -1
  369. package/dist/commonjs/sdk/models/shared/polygonareafilter.d.ts +0 -57
  370. package/dist/commonjs/sdk/models/shared/polygonareafilter.d.ts.map +0 -1
  371. package/dist/commonjs/sdk/models/shared/polygonareafilter.js +0 -89
  372. package/dist/commonjs/sdk/models/shared/polygonareafilter.js.map +0 -1
  373. package/dist/commonjs/sdk/models/shared/postcodeareafilter.d.ts +0 -62
  374. package/dist/commonjs/sdk/models/shared/postcodeareafilter.d.ts.map +0 -1
  375. package/dist/commonjs/sdk/models/shared/postcodeareafilter.js +0 -91
  376. package/dist/commonjs/sdk/models/shared/postcodeareafilter.js.map +0 -1
  377. package/dist/commonjs/sdk/models/shared/propertyfilters.d.ts +0 -447
  378. package/dist/commonjs/sdk/models/shared/propertyfilters.d.ts.map +0 -1
  379. package/dist/commonjs/sdk/models/shared/propertyfilters.js +0 -299
  380. package/dist/commonjs/sdk/models/shared/propertyfilters.js.map +0 -1
  381. package/dist/esm/sdk/models/shared/areafilter.d.ts +0 -40
  382. package/dist/esm/sdk/models/shared/areafilter.d.ts.map +0 -1
  383. package/dist/esm/sdk/models/shared/areafilter.js +0 -46
  384. package/dist/esm/sdk/models/shared/areafilter.js.map +0 -1
  385. package/dist/esm/sdk/models/shared/pointareafilter.d.ts +0 -62
  386. package/dist/esm/sdk/models/shared/pointareafilter.d.ts.map +0 -1
  387. package/dist/esm/sdk/models/shared/pointareafilter.js +0 -53
  388. package/dist/esm/sdk/models/shared/pointareafilter.js.map +0 -1
  389. package/dist/esm/sdk/models/shared/polygonareafilter.d.ts +0 -57
  390. package/dist/esm/sdk/models/shared/polygonareafilter.d.ts.map +0 -1
  391. package/dist/esm/sdk/models/shared/polygonareafilter.js +0 -51
  392. package/dist/esm/sdk/models/shared/polygonareafilter.js.map +0 -1
  393. package/dist/esm/sdk/models/shared/postcodeareafilter.d.ts +0 -62
  394. package/dist/esm/sdk/models/shared/postcodeareafilter.d.ts.map +0 -1
  395. package/dist/esm/sdk/models/shared/postcodeareafilter.js +0 -53
  396. package/dist/esm/sdk/models/shared/postcodeareafilter.js.map +0 -1
  397. package/dist/esm/sdk/models/shared/propertyfilters.d.ts +0 -447
  398. package/dist/esm/sdk/models/shared/propertyfilters.d.ts.map +0 -1
  399. package/dist/esm/sdk/models/shared/propertyfilters.js +0 -259
  400. package/dist/esm/sdk/models/shared/propertyfilters.js.map +0 -1
  401. package/src/sdk/models/shared/areafilter.ts +0 -106
  402. package/src/sdk/models/shared/pointareafilter.ts +0 -104
  403. package/src/sdk/models/shared/polygonareafilter.ts +0 -100
  404. package/src/sdk/models/shared/postcodeareafilter.ts +0 -107
  405. package/src/sdk/models/shared/propertyfilters.ts +0 -475
@@ -0,0 +1,238 @@
1
+ /*
2
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
3
+ */
4
+
5
+ import * as z from "zod";
6
+ import { safeParse } from "../../../lib/schemas.js";
7
+ import { ClosedEnum } from "../../types/enums.js";
8
+ import { Result as SafeParseResult } from "../../types/fp.js";
9
+ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
10
+
11
+ /**
12
+ * Comparison operator
13
+ */
14
+ export const Comparator = {
15
+ Eq: "eq",
16
+ Ne: "ne",
17
+ Gt: "gt",
18
+ Gte: "gte",
19
+ Lt: "lt",
20
+ Lte: "lte",
21
+ In: "in",
22
+ Nin: "nin",
23
+ Contains: "contains",
24
+ Startswith: "startswith",
25
+ Endswith: "endswith",
26
+ } as const;
27
+ /**
28
+ * Comparison operator
29
+ */
30
+ export type Comparator = ClosedEnum<typeof Comparator>;
31
+
32
+ export type Four = string | number | boolean;
33
+
34
+ /**
35
+ * Value to compare against
36
+ */
37
+ export type Value =
38
+ | string
39
+ | number
40
+ | boolean
41
+ | Array<string | number | boolean>;
42
+
43
+ export type PropertyQueryCondition = {
44
+ /**
45
+ * Comparison operator
46
+ */
47
+ comparator: Comparator;
48
+ /**
49
+ * Field to filter on
50
+ */
51
+ field: string;
52
+ /**
53
+ * Value to compare against
54
+ */
55
+ value: string | number | boolean | Array<string | number | boolean>;
56
+ };
57
+
58
+ /** @internal */
59
+ export const Comparator$inboundSchema: z.ZodNativeEnum<typeof Comparator> = z
60
+ .nativeEnum(Comparator);
61
+
62
+ /** @internal */
63
+ export const Comparator$outboundSchema: z.ZodNativeEnum<typeof Comparator> =
64
+ Comparator$inboundSchema;
65
+
66
+ /**
67
+ * @internal
68
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
69
+ */
70
+ export namespace Comparator$ {
71
+ /** @deprecated use `Comparator$inboundSchema` instead. */
72
+ export const inboundSchema = Comparator$inboundSchema;
73
+ /** @deprecated use `Comparator$outboundSchema` instead. */
74
+ export const outboundSchema = Comparator$outboundSchema;
75
+ }
76
+
77
+ /** @internal */
78
+ export const Four$inboundSchema: z.ZodType<Four, z.ZodTypeDef, unknown> = z
79
+ .union([z.string(), z.number(), z.boolean()]);
80
+
81
+ /** @internal */
82
+ export type Four$Outbound = string | number | boolean;
83
+
84
+ /** @internal */
85
+ export const Four$outboundSchema: z.ZodType<Four$Outbound, z.ZodTypeDef, Four> =
86
+ z.union([z.string(), z.number(), z.boolean()]);
87
+
88
+ /**
89
+ * @internal
90
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
91
+ */
92
+ export namespace Four$ {
93
+ /** @deprecated use `Four$inboundSchema` instead. */
94
+ export const inboundSchema = Four$inboundSchema;
95
+ /** @deprecated use `Four$outboundSchema` instead. */
96
+ export const outboundSchema = Four$outboundSchema;
97
+ /** @deprecated use `Four$Outbound` instead. */
98
+ export type Outbound = Four$Outbound;
99
+ }
100
+
101
+ export function fourToJSON(four: Four): string {
102
+ return JSON.stringify(Four$outboundSchema.parse(four));
103
+ }
104
+
105
+ export function fourFromJSON(
106
+ jsonString: string,
107
+ ): SafeParseResult<Four, SDKValidationError> {
108
+ return safeParse(
109
+ jsonString,
110
+ (x) => Four$inboundSchema.parse(JSON.parse(x)),
111
+ `Failed to parse 'Four' from JSON`,
112
+ );
113
+ }
114
+
115
+ /** @internal */
116
+ export const Value$inboundSchema: z.ZodType<Value, z.ZodTypeDef, unknown> = z
117
+ .union([
118
+ z.string(),
119
+ z.number(),
120
+ z.boolean(),
121
+ z.array(z.union([z.string(), z.number(), z.boolean()])),
122
+ ]);
123
+
124
+ /** @internal */
125
+ export type Value$Outbound =
126
+ | string
127
+ | number
128
+ | boolean
129
+ | Array<string | number | boolean>;
130
+
131
+ /** @internal */
132
+ export const Value$outboundSchema: z.ZodType<
133
+ Value$Outbound,
134
+ z.ZodTypeDef,
135
+ Value
136
+ > = z.union([
137
+ z.string(),
138
+ z.number(),
139
+ z.boolean(),
140
+ z.array(z.union([z.string(), z.number(), z.boolean()])),
141
+ ]);
142
+
143
+ /**
144
+ * @internal
145
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
146
+ */
147
+ export namespace Value$ {
148
+ /** @deprecated use `Value$inboundSchema` instead. */
149
+ export const inboundSchema = Value$inboundSchema;
150
+ /** @deprecated use `Value$outboundSchema` instead. */
151
+ export const outboundSchema = Value$outboundSchema;
152
+ /** @deprecated use `Value$Outbound` instead. */
153
+ export type Outbound = Value$Outbound;
154
+ }
155
+
156
+ export function valueToJSON(value: Value): string {
157
+ return JSON.stringify(Value$outboundSchema.parse(value));
158
+ }
159
+
160
+ export function valueFromJSON(
161
+ jsonString: string,
162
+ ): SafeParseResult<Value, SDKValidationError> {
163
+ return safeParse(
164
+ jsonString,
165
+ (x) => Value$inboundSchema.parse(JSON.parse(x)),
166
+ `Failed to parse 'Value' from JSON`,
167
+ );
168
+ }
169
+
170
+ /** @internal */
171
+ export const PropertyQueryCondition$inboundSchema: z.ZodType<
172
+ PropertyQueryCondition,
173
+ z.ZodTypeDef,
174
+ unknown
175
+ > = z.object({
176
+ comparator: Comparator$inboundSchema,
177
+ field: z.string(),
178
+ value: z.union([
179
+ z.string(),
180
+ z.number(),
181
+ z.boolean(),
182
+ z.array(z.union([z.string(), z.number(), z.boolean()])),
183
+ ]),
184
+ });
185
+
186
+ /** @internal */
187
+ export type PropertyQueryCondition$Outbound = {
188
+ comparator: string;
189
+ field: string;
190
+ value: string | number | boolean | Array<string | number | boolean>;
191
+ };
192
+
193
+ /** @internal */
194
+ export const PropertyQueryCondition$outboundSchema: z.ZodType<
195
+ PropertyQueryCondition$Outbound,
196
+ z.ZodTypeDef,
197
+ PropertyQueryCondition
198
+ > = z.object({
199
+ comparator: Comparator$outboundSchema,
200
+ field: z.string(),
201
+ value: z.union([
202
+ z.string(),
203
+ z.number(),
204
+ z.boolean(),
205
+ z.array(z.union([z.string(), z.number(), z.boolean()])),
206
+ ]),
207
+ });
208
+
209
+ /**
210
+ * @internal
211
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
212
+ */
213
+ export namespace PropertyQueryCondition$ {
214
+ /** @deprecated use `PropertyQueryCondition$inboundSchema` instead. */
215
+ export const inboundSchema = PropertyQueryCondition$inboundSchema;
216
+ /** @deprecated use `PropertyQueryCondition$outboundSchema` instead. */
217
+ export const outboundSchema = PropertyQueryCondition$outboundSchema;
218
+ /** @deprecated use `PropertyQueryCondition$Outbound` instead. */
219
+ export type Outbound = PropertyQueryCondition$Outbound;
220
+ }
221
+
222
+ export function propertyQueryConditionToJSON(
223
+ propertyQueryCondition: PropertyQueryCondition,
224
+ ): string {
225
+ return JSON.stringify(
226
+ PropertyQueryCondition$outboundSchema.parse(propertyQueryCondition),
227
+ );
228
+ }
229
+
230
+ export function propertyQueryConditionFromJSON(
231
+ jsonString: string,
232
+ ): SafeParseResult<PropertyQueryCondition, SDKValidationError> {
233
+ return safeParse(
234
+ jsonString,
235
+ (x) => PropertyQueryCondition$inboundSchema.parse(JSON.parse(x)),
236
+ `Failed to parse 'PropertyQueryCondition' from JSON`,
237
+ );
238
+ }
@@ -0,0 +1,75 @@
1
+ /*
2
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
3
+ */
4
+
5
+ import * as z from "zod";
6
+ import { safeParse } from "../../../lib/schemas.js";
7
+ import { Result as SafeParseResult } from "../../types/fp.js";
8
+ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
9
+ import {
10
+ PropertyQueryCondition,
11
+ PropertyQueryCondition$inboundSchema,
12
+ PropertyQueryCondition$Outbound,
13
+ PropertyQueryCondition$outboundSchema,
14
+ } from "./propertyquerycondition.js";
15
+
16
+ export type PropertyQueryGroup = {
17
+ /**
18
+ * Array of conditions
19
+ */
20
+ conditions: Array<PropertyQueryCondition>;
21
+ };
22
+
23
+ /** @internal */
24
+ export const PropertyQueryGroup$inboundSchema: z.ZodType<
25
+ PropertyQueryGroup,
26
+ z.ZodTypeDef,
27
+ unknown
28
+ > = z.object({
29
+ conditions: z.array(PropertyQueryCondition$inboundSchema),
30
+ });
31
+
32
+ /** @internal */
33
+ export type PropertyQueryGroup$Outbound = {
34
+ conditions: Array<PropertyQueryCondition$Outbound>;
35
+ };
36
+
37
+ /** @internal */
38
+ export const PropertyQueryGroup$outboundSchema: z.ZodType<
39
+ PropertyQueryGroup$Outbound,
40
+ z.ZodTypeDef,
41
+ PropertyQueryGroup
42
+ > = z.object({
43
+ conditions: z.array(PropertyQueryCondition$outboundSchema),
44
+ });
45
+
46
+ /**
47
+ * @internal
48
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
49
+ */
50
+ export namespace PropertyQueryGroup$ {
51
+ /** @deprecated use `PropertyQueryGroup$inboundSchema` instead. */
52
+ export const inboundSchema = PropertyQueryGroup$inboundSchema;
53
+ /** @deprecated use `PropertyQueryGroup$outboundSchema` instead. */
54
+ export const outboundSchema = PropertyQueryGroup$outboundSchema;
55
+ /** @deprecated use `PropertyQueryGroup$Outbound` instead. */
56
+ export type Outbound = PropertyQueryGroup$Outbound;
57
+ }
58
+
59
+ export function propertyQueryGroupToJSON(
60
+ propertyQueryGroup: PropertyQueryGroup,
61
+ ): string {
62
+ return JSON.stringify(
63
+ PropertyQueryGroup$outboundSchema.parse(propertyQueryGroup),
64
+ );
65
+ }
66
+
67
+ export function propertyQueryGroupFromJSON(
68
+ jsonString: string,
69
+ ): SafeParseResult<PropertyQueryGroup, SDKValidationError> {
70
+ return safeParse(
71
+ jsonString,
72
+ (x) => PropertyQueryGroup$inboundSchema.parse(JSON.parse(x)),
73
+ `Failed to parse 'PropertyQueryGroup' from JSON`,
74
+ );
75
+ }
@@ -0,0 +1,114 @@
1
+ /*
2
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
3
+ */
4
+
5
+ import * as z from "zod";
6
+ import { safeParse } from "../../../lib/schemas.js";
7
+ import { ClosedEnum } from "../../types/enums.js";
8
+ import { Result as SafeParseResult } from "../../types/fp.js";
9
+ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
10
+ import {
11
+ PropertyQueryGroup,
12
+ PropertyQueryGroup$inboundSchema,
13
+ PropertyQueryGroup$Outbound,
14
+ PropertyQueryGroup$outboundSchema,
15
+ } from "./propertyquerygroup.js";
16
+
17
+ /**
18
+ * Logical operator
19
+ */
20
+ export const Operator = {
21
+ And: "AND",
22
+ Or: "OR",
23
+ } as const;
24
+ /**
25
+ * Logical operator
26
+ */
27
+ export type Operator = ClosedEnum<typeof Operator>;
28
+
29
+ export type PropertyQueryOperator = {
30
+ /**
31
+ * Array of condition groups
32
+ */
33
+ groups: Array<PropertyQueryGroup>;
34
+ /**
35
+ * Logical operator
36
+ */
37
+ operator: Operator;
38
+ };
39
+
40
+ /** @internal */
41
+ export const Operator$inboundSchema: z.ZodNativeEnum<typeof Operator> = z
42
+ .nativeEnum(Operator);
43
+
44
+ /** @internal */
45
+ export const Operator$outboundSchema: z.ZodNativeEnum<typeof Operator> =
46
+ Operator$inboundSchema;
47
+
48
+ /**
49
+ * @internal
50
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
51
+ */
52
+ export namespace Operator$ {
53
+ /** @deprecated use `Operator$inboundSchema` instead. */
54
+ export const inboundSchema = Operator$inboundSchema;
55
+ /** @deprecated use `Operator$outboundSchema` instead. */
56
+ export const outboundSchema = Operator$outboundSchema;
57
+ }
58
+
59
+ /** @internal */
60
+ export const PropertyQueryOperator$inboundSchema: z.ZodType<
61
+ PropertyQueryOperator,
62
+ z.ZodTypeDef,
63
+ unknown
64
+ > = z.object({
65
+ groups: z.array(PropertyQueryGroup$inboundSchema),
66
+ operator: Operator$inboundSchema,
67
+ });
68
+
69
+ /** @internal */
70
+ export type PropertyQueryOperator$Outbound = {
71
+ groups: Array<PropertyQueryGroup$Outbound>;
72
+ operator: string;
73
+ };
74
+
75
+ /** @internal */
76
+ export const PropertyQueryOperator$outboundSchema: z.ZodType<
77
+ PropertyQueryOperator$Outbound,
78
+ z.ZodTypeDef,
79
+ PropertyQueryOperator
80
+ > = z.object({
81
+ groups: z.array(PropertyQueryGroup$outboundSchema),
82
+ operator: Operator$outboundSchema,
83
+ });
84
+
85
+ /**
86
+ * @internal
87
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
88
+ */
89
+ export namespace PropertyQueryOperator$ {
90
+ /** @deprecated use `PropertyQueryOperator$inboundSchema` instead. */
91
+ export const inboundSchema = PropertyQueryOperator$inboundSchema;
92
+ /** @deprecated use `PropertyQueryOperator$outboundSchema` instead. */
93
+ export const outboundSchema = PropertyQueryOperator$outboundSchema;
94
+ /** @deprecated use `PropertyQueryOperator$Outbound` instead. */
95
+ export type Outbound = PropertyQueryOperator$Outbound;
96
+ }
97
+
98
+ export function propertyQueryOperatorToJSON(
99
+ propertyQueryOperator: PropertyQueryOperator,
100
+ ): string {
101
+ return JSON.stringify(
102
+ PropertyQueryOperator$outboundSchema.parse(propertyQueryOperator),
103
+ );
104
+ }
105
+
106
+ export function propertyQueryOperatorFromJSON(
107
+ jsonString: string,
108
+ ): SafeParseResult<PropertyQueryOperator, SDKValidationError> {
109
+ return safeParse(
110
+ jsonString,
111
+ (x) => PropertyQueryOperator$inboundSchema.parse(JSON.parse(x)),
112
+ `Failed to parse 'PropertyQueryOperator' from JSON`,
113
+ );
114
+ }
@@ -4,62 +4,35 @@
4
4
 
5
5
  import * as z from "zod";
6
6
  import { safeParse } from "../../../lib/schemas.js";
7
- import { ClosedEnum } from "../../types/enums.js";
8
7
  import { Result as SafeParseResult } from "../../types/fp.js";
9
8
  import { SDKValidationError } from "../errors/sdkvalidationerror.js";
10
9
  import {
11
- AreaFilter,
12
- AreaFilter$inboundSchema,
13
- AreaFilter$Outbound,
14
- AreaFilter$outboundSchema,
15
- } from "./areafilter.js";
10
+ PropertyAreaFilter,
11
+ PropertyAreaFilter$inboundSchema,
12
+ PropertyAreaFilter$Outbound,
13
+ PropertyAreaFilter$outboundSchema,
14
+ } from "./propertyareafilter.js";
16
15
  import {
17
- PropertyFilters,
18
- PropertyFilters$inboundSchema,
19
- PropertyFilters$Outbound,
20
- PropertyFilters$outboundSchema,
21
- } from "./propertyfilters.js";
16
+ PropertyQueryOperator,
17
+ PropertyQueryOperator$inboundSchema,
18
+ PropertyQueryOperator$Outbound,
19
+ PropertyQueryOperator$outboundSchema,
20
+ } from "./propertyqueryoperator.js";
22
21
 
23
22
  /**
24
- * Field to sort results by
23
+ * Comma-separated string or array of attributes to include
25
24
  */
26
- export const PropertyQueryRequestSortBy = {
27
- Price: "price",
28
- Date: "date",
29
- Beds: "beds",
30
- FloorArea: "floorArea",
31
- YearBuilt: "yearBuilt",
32
- } as const;
33
- /**
34
- * Field to sort results by
35
- */
36
- export type PropertyQueryRequestSortBy = ClosedEnum<
37
- typeof PropertyQueryRequestSortBy
38
- >;
39
-
40
- /**
41
- * Sort order
42
- */
43
- export const PropertyQueryRequestSortOrder = {
44
- Asc: "asc",
45
- Desc: "desc",
46
- } as const;
47
- /**
48
- * Sort order
49
- */
50
- export type PropertyQueryRequestSortOrder = ClosedEnum<
51
- typeof PropertyQueryRequestSortOrder
52
- >;
25
+ export type Attributes = string | Array<string>;
53
26
 
54
27
  export type PropertyQueryRequest = {
55
28
  /**
56
29
  * Geographic search areas (multiple areas will be combined with OR logic)
57
30
  */
58
- area: Array<AreaFilter>;
31
+ area: Array<PropertyAreaFilter>;
59
32
  /**
60
- * Specific fields to include in response
33
+ * Comma-separated string or array of attributes to include
61
34
  */
62
- attributes?: Array<string> | undefined;
35
+ attributes?: string | Array<string> | undefined;
63
36
  /**
64
37
  * Number of results to return per page
65
38
  */
@@ -69,59 +42,57 @@ export type PropertyQueryRequest = {
69
42
  */
70
43
  offset?: number | undefined;
71
44
  /**
72
- * Property attribute filters
45
+ * Array of query operators for filtering
73
46
  */
74
- query?: PropertyFilters | undefined;
47
+ query: Array<PropertyQueryOperator>;
75
48
  /**
76
- * Field to sort results by
49
+ * Enable tracking for billing purposes
77
50
  */
78
- sortBy?: PropertyQueryRequestSortBy | undefined;
79
- /**
80
- * Sort order
81
- */
82
- sortOrder?: PropertyQueryRequestSortOrder | undefined;
51
+ track?: boolean | undefined;
83
52
  };
84
53
 
85
54
  /** @internal */
86
- export const PropertyQueryRequestSortBy$inboundSchema: z.ZodNativeEnum<
87
- typeof PropertyQueryRequestSortBy
88
- > = z.nativeEnum(PropertyQueryRequestSortBy);
55
+ export const Attributes$inboundSchema: z.ZodType<
56
+ Attributes,
57
+ z.ZodTypeDef,
58
+ unknown
59
+ > = z.union([z.string(), z.array(z.string())]);
60
+
61
+ /** @internal */
62
+ export type Attributes$Outbound = string | Array<string>;
89
63
 
90
64
  /** @internal */
91
- export const PropertyQueryRequestSortBy$outboundSchema: z.ZodNativeEnum<
92
- typeof PropertyQueryRequestSortBy
93
- > = PropertyQueryRequestSortBy$inboundSchema;
65
+ export const Attributes$outboundSchema: z.ZodType<
66
+ Attributes$Outbound,
67
+ z.ZodTypeDef,
68
+ Attributes
69
+ > = z.union([z.string(), z.array(z.string())]);
94
70
 
95
71
  /**
96
72
  * @internal
97
73
  * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
98
74
  */
99
- export namespace PropertyQueryRequestSortBy$ {
100
- /** @deprecated use `PropertyQueryRequestSortBy$inboundSchema` instead. */
101
- export const inboundSchema = PropertyQueryRequestSortBy$inboundSchema;
102
- /** @deprecated use `PropertyQueryRequestSortBy$outboundSchema` instead. */
103
- export const outboundSchema = PropertyQueryRequestSortBy$outboundSchema;
75
+ export namespace Attributes$ {
76
+ /** @deprecated use `Attributes$inboundSchema` instead. */
77
+ export const inboundSchema = Attributes$inboundSchema;
78
+ /** @deprecated use `Attributes$outboundSchema` instead. */
79
+ export const outboundSchema = Attributes$outboundSchema;
80
+ /** @deprecated use `Attributes$Outbound` instead. */
81
+ export type Outbound = Attributes$Outbound;
104
82
  }
105
83
 
106
- /** @internal */
107
- export const PropertyQueryRequestSortOrder$inboundSchema: z.ZodNativeEnum<
108
- typeof PropertyQueryRequestSortOrder
109
- > = z.nativeEnum(PropertyQueryRequestSortOrder);
110
-
111
- /** @internal */
112
- export const PropertyQueryRequestSortOrder$outboundSchema: z.ZodNativeEnum<
113
- typeof PropertyQueryRequestSortOrder
114
- > = PropertyQueryRequestSortOrder$inboundSchema;
84
+ export function attributesToJSON(attributes: Attributes): string {
85
+ return JSON.stringify(Attributes$outboundSchema.parse(attributes));
86
+ }
115
87
 
116
- /**
117
- * @internal
118
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
119
- */
120
- export namespace PropertyQueryRequestSortOrder$ {
121
- /** @deprecated use `PropertyQueryRequestSortOrder$inboundSchema` instead. */
122
- export const inboundSchema = PropertyQueryRequestSortOrder$inboundSchema;
123
- /** @deprecated use `PropertyQueryRequestSortOrder$outboundSchema` instead. */
124
- export const outboundSchema = PropertyQueryRequestSortOrder$outboundSchema;
88
+ export function attributesFromJSON(
89
+ jsonString: string,
90
+ ): SafeParseResult<Attributes, SDKValidationError> {
91
+ return safeParse(
92
+ jsonString,
93
+ (x) => Attributes$inboundSchema.parse(JSON.parse(x)),
94
+ `Failed to parse 'Attributes' from JSON`,
95
+ );
125
96
  }
126
97
 
127
98
  /** @internal */
@@ -130,24 +101,22 @@ export const PropertyQueryRequest$inboundSchema: z.ZodType<
130
101
  z.ZodTypeDef,
131
102
  unknown
132
103
  > = z.object({
133
- area: z.array(AreaFilter$inboundSchema),
134
- attributes: z.array(z.string()).optional(),
104
+ area: z.array(PropertyAreaFilter$inboundSchema),
105
+ attributes: z.union([z.string(), z.array(z.string())]).optional(),
135
106
  limit: z.number().default(25),
136
107
  offset: z.number().default(0),
137
- query: PropertyFilters$inboundSchema.optional(),
138
- sortBy: PropertyQueryRequestSortBy$inboundSchema.optional(),
139
- sortOrder: PropertyQueryRequestSortOrder$inboundSchema.default("asc"),
108
+ query: z.array(PropertyQueryOperator$inboundSchema),
109
+ track: z.boolean().default(false),
140
110
  });
141
111
 
142
112
  /** @internal */
143
113
  export type PropertyQueryRequest$Outbound = {
144
- area: Array<AreaFilter$Outbound>;
145
- attributes?: Array<string> | undefined;
114
+ area: Array<PropertyAreaFilter$Outbound>;
115
+ attributes?: string | Array<string> | undefined;
146
116
  limit: number;
147
117
  offset: number;
148
- query?: PropertyFilters$Outbound | undefined;
149
- sortBy?: string | undefined;
150
- sortOrder: string;
118
+ query: Array<PropertyQueryOperator$Outbound>;
119
+ track: boolean;
151
120
  };
152
121
 
153
122
  /** @internal */
@@ -156,13 +125,12 @@ export const PropertyQueryRequest$outboundSchema: z.ZodType<
156
125
  z.ZodTypeDef,
157
126
  PropertyQueryRequest
158
127
  > = z.object({
159
- area: z.array(AreaFilter$outboundSchema),
160
- attributes: z.array(z.string()).optional(),
128
+ area: z.array(PropertyAreaFilter$outboundSchema),
129
+ attributes: z.union([z.string(), z.array(z.string())]).optional(),
161
130
  limit: z.number().default(25),
162
131
  offset: z.number().default(0),
163
- query: PropertyFilters$outboundSchema.optional(),
164
- sortBy: PropertyQueryRequestSortBy$outboundSchema.optional(),
165
- sortOrder: PropertyQueryRequestSortOrder$outboundSchema.default("asc"),
132
+ query: z.array(PropertyQueryOperator$outboundSchema),
133
+ track: z.boolean().default(false),
166
134
  });
167
135
 
168
136
  /**