bag_kadaster_client 1.0.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 (474) hide show
  1. checksums.yaml +7 -0
  2. data/Gemfile +9 -0
  3. data/README.md +313 -0
  4. data/Rakefile +10 -0
  5. data/bag_kadaster_client.gemspec +38 -0
  6. data/docs/APIInfo.md +28 -0
  7. data/docs/Adres.md +42 -0
  8. data/docs/AdresApi.md +259 -0
  9. data/docs/AdresIO.md +46 -0
  10. data/docs/AdresIOAllOf.md +20 -0
  11. data/docs/AdresIOEmbedded.md +22 -0
  12. data/docs/AdresIOHal.md +50 -0
  13. data/docs/AdresIOHalAllOf.md +20 -0
  14. data/docs/AdresIOHalCollection.md +20 -0
  15. data/docs/AdresIOHalCollectionEmbedded.md +18 -0
  16. data/docs/AdresIOLinks.md +28 -0
  17. data/docs/AdresInOnderzoek.md +42 -0
  18. data/docs/AdresUitgebreid.md +58 -0
  19. data/docs/AdresUitgebreidAllOf.md +32 -0
  20. data/docs/AdresUitgebreidApi.md +173 -0
  21. data/docs/AdresUitgebreidGeconstateerd.md +30 -0
  22. data/docs/AdresUitgebreidGeconstateerdAllOf.md +24 -0
  23. data/docs/AdresUitgebreidHal.md +60 -0
  24. data/docs/AdresUitgebreidHalAllOf.md +18 -0
  25. data/docs/AdresUitgebreidHalCollection.md +20 -0
  26. data/docs/AdresUitgebreidHalCollectionEmbedded.md +18 -0
  27. data/docs/AdresUitgebreidInOnderzoek.md +60 -0
  28. data/docs/AdresUitgebreidInOnderzoekAllOf.md +34 -0
  29. data/docs/AdresUitgebreidLinks.md +28 -0
  30. data/docs/AdresseerbaarObject.md +22 -0
  31. data/docs/AdresseerbaarObjectApi.md +251 -0
  32. data/docs/AdresseerbaarObjectIOHal.md +24 -0
  33. data/docs/AdresseerbaarObjectLvcIOHalCollection.md +20 -0
  34. data/docs/AdresseerbaarObjectLvcIOHalCollectionEmbedded.md +18 -0
  35. data/docs/AdresseerbareObjectenIOHalCollection.md +20 -0
  36. data/docs/AdresseerbareObjectenIOHalCollectionEmbedded.md +18 -0
  37. data/docs/AlgemeneInformatieApi.md +74 -0
  38. data/docs/Bronhouder.md +26 -0
  39. data/docs/BronhouderApi.md +241 -0
  40. data/docs/BronhouderHal.md +20 -0
  41. data/docs/BronhouderHalCollection.md +20 -0
  42. data/docs/BronhouderHalCollectionEmbedded.md +18 -0
  43. data/docs/BronhouderLinks.md +18 -0
  44. data/docs/Error.md +30 -0
  45. data/docs/Gebruiksdoel.md +15 -0
  46. data/docs/Geconstateerd.md +22 -0
  47. data/docs/HalCollectionLinks.md +18 -0
  48. data/docs/HalLink.md +22 -0
  49. data/docs/HalPaginationLinks.md +26 -0
  50. data/docs/HalPaginationLinksAllOf.md +24 -0
  51. data/docs/HalPaginationLinksAllOfFirst.md +22 -0
  52. data/docs/HalPaginationLinksAllOfLast.md +22 -0
  53. data/docs/HalPaginationLinksAllOfNext.md +22 -0
  54. data/docs/HalPaginationLinksAllOfPrevious.md +22 -0
  55. data/docs/HistorieInOnderzoek.md +28 -0
  56. data/docs/InOnderzoekLigplaats.md +15 -0
  57. data/docs/InOnderzoekNummeraanduiding.md +15 -0
  58. data/docs/InOnderzoekOpenbareRuimte.md +15 -0
  59. data/docs/InOnderzoekPand.md +15 -0
  60. data/docs/InOnderzoekStandplaats.md +15 -0
  61. data/docs/InOnderzoekVerblijfsobject.md +15 -0
  62. data/docs/InOnderzoekWoonplaats.md +15 -0
  63. data/docs/Indicatie.md +15 -0
  64. data/docs/InvalidParams.md +24 -0
  65. data/docs/KenmerkLigplaatsInOnderzoek.md +28 -0
  66. data/docs/KenmerkNummeraanduidingInOnderzoek.md +28 -0
  67. data/docs/KenmerkOpenbareRuimteInOnderzoek.md +28 -0
  68. data/docs/KenmerkPandInOnderzoek.md +28 -0
  69. data/docs/KenmerkStandplaatsInOnderzoek.md +28 -0
  70. data/docs/KenmerkVerblijfsobjectInOnderzoek.md +28 -0
  71. data/docs/KenmerkWoonplaatsInOnderzoek.md +28 -0
  72. data/docs/Ligplaats.md +32 -0
  73. data/docs/LigplaatsAllOf.md +32 -0
  74. data/docs/LigplaatsApi.md +333 -0
  75. data/docs/LigplaatsEmbedded.md +20 -0
  76. data/docs/LigplaatsIOHal.md +24 -0
  77. data/docs/LigplaatsIOHalCollection.md +20 -0
  78. data/docs/LigplaatsIOHalCollectionEmbedded.md +18 -0
  79. data/docs/LigplaatsIOLvcHalCollection.md +20 -0
  80. data/docs/LigplaatsIOLvcHalCollectionEmbedded.md +18 -0
  81. data/docs/LigplaatsLinks.md +22 -0
  82. data/docs/MultiPolygon.md +20 -0
  83. data/docs/MultiSurface.md +20 -0
  84. data/docs/Nummeraanduiding.md +44 -0
  85. data/docs/NummeraanduidingApi.md +341 -0
  86. data/docs/NummeraanduidingEmbedded.md +20 -0
  87. data/docs/NummeraanduidingIOHal.md +24 -0
  88. data/docs/NummeraanduidingIOHalCollection.md +20 -0
  89. data/docs/NummeraanduidingIOHalCollectionEmbedded.md +18 -0
  90. data/docs/NummeraanduidingIOLvcHalCollection.md +20 -0
  91. data/docs/NummeraanduidingIOLvcHalCollectionEmbedded.md +18 -0
  92. data/docs/NummeraanduidingLinks.md +22 -0
  93. data/docs/OpenbareRuimte.md +38 -0
  94. data/docs/OpenbareRuimteApi.md +329 -0
  95. data/docs/OpenbareRuimteEmbedded.md +18 -0
  96. data/docs/OpenbareRuimteIOHal.md +24 -0
  97. data/docs/OpenbareRuimteIOHalCollection.md +20 -0
  98. data/docs/OpenbareRuimteIOHalCollectionEmbedded.md +18 -0
  99. data/docs/OpenbareRuimteIOLvcHalCollection.md +20 -0
  100. data/docs/OpenbareRuimteIOLvcHalCollectionEmbedded.md +18 -0
  101. data/docs/OpenbareRuimteLinks.md +20 -0
  102. data/docs/Pand.md +34 -0
  103. data/docs/PandApi.md +329 -0
  104. data/docs/PandIOHal.md +22 -0
  105. data/docs/PandIOHalCollection.md +20 -0
  106. data/docs/PandIOHalCollectionEmbedded.md +18 -0
  107. data/docs/PandIOLvcHalCollection.md +20 -0
  108. data/docs/PandIOLvcHalCollectionEmbedded.md +18 -0
  109. data/docs/PandLinks.md +18 -0
  110. data/docs/Point.md +20 -0
  111. data/docs/Polygon.md +20 -0
  112. data/docs/Provincie.md +20 -0
  113. data/docs/PuntOfVlak.md +20 -0
  114. data/docs/Standplaats.md +32 -0
  115. data/docs/StandplaatsAllOf.md +32 -0
  116. data/docs/StandplaatsApi.md +333 -0
  117. data/docs/StandplaatsEmbedded.md +20 -0
  118. data/docs/StandplaatsIOHal.md +24 -0
  119. data/docs/StandplaatsIOHalCollection.md +20 -0
  120. data/docs/StandplaatsIOHalCollectionEmbedded.md +18 -0
  121. data/docs/StandplaatsIOLvcHalCollection.md +20 -0
  122. data/docs/StandplaatsIOLvcHalCollectionEmbedded.md +18 -0
  123. data/docs/StandplaatsLinks.md +22 -0
  124. data/docs/StatusNaamgeving.md +15 -0
  125. data/docs/StatusPand.md +15 -0
  126. data/docs/StatusPlaats.md +15 -0
  127. data/docs/StatusVerblijfsobject.md +15 -0
  128. data/docs/StatusWoonplaats.md +15 -0
  129. data/docs/Surface.md +20 -0
  130. data/docs/TypeAdresseerbaarObject.md +15 -0
  131. data/docs/TypeOpenbareRuimte.md +15 -0
  132. data/docs/Verblijfsobject.md +38 -0
  133. data/docs/VerblijfsobjectAllOf.md +38 -0
  134. data/docs/VerblijfsobjectApi.md +333 -0
  135. data/docs/VerblijfsobjectEmbedded.md +22 -0
  136. data/docs/VerblijfsobjectIOHal.md +24 -0
  137. data/docs/VerblijfsobjectIOHalCollection.md +20 -0
  138. data/docs/VerblijfsobjectIOHalCollectionEmbedded.md +18 -0
  139. data/docs/VerblijfsobjectIOLvcHalCollection.md +20 -0
  140. data/docs/VerblijfsobjectIOLvcHalCollectionEmbedded.md +18 -0
  141. data/docs/VerblijfsobjectLinks.md +24 -0
  142. data/docs/VlakOfMultivlak.md +20 -0
  143. data/docs/Voorkomen.md +36 -0
  144. data/docs/Woonplaats.md +32 -0
  145. data/docs/WoonplaatsApi.md +419 -0
  146. data/docs/WoonplaatsEmbedded.md +20 -0
  147. data/docs/WoonplaatsIOHal.md +24 -0
  148. data/docs/WoonplaatsIOHalCollection.md +20 -0
  149. data/docs/WoonplaatsIOHalCollectionEmbedded.md +18 -0
  150. data/docs/WoonplaatsIOLvcHalCollection.md +20 -0
  151. data/docs/WoonplaatsIOLvcHalCollectionEmbedded.md +18 -0
  152. data/docs/WoonplaatsLinks.md +20 -0
  153. data/docs/ZoekResultaat.md +20 -0
  154. data/docs/ZoekResultaatHal.md +22 -0
  155. data/docs/ZoekResultaatHalAllOf.md +18 -0
  156. data/docs/ZoekResultaatHalCollection.md +20 -0
  157. data/docs/ZoekResultaatHalCollectionEmbedded.md +18 -0
  158. data/docs/ZoekResultaatLinks.md +18 -0
  159. data/git_push.sh +57 -0
  160. data/lib/bag_kadaster_client/api/adres_api.rb +358 -0
  161. data/lib/bag_kadaster_client/api/adres_uitgebreid_api.rb +239 -0
  162. data/lib/bag_kadaster_client/api/adresseerbaar_object_api.rb +268 -0
  163. data/lib/bag_kadaster_client/api/algemene_informatie_api.rb +77 -0
  164. data/lib/bag_kadaster_client/api/bronhouder_api.rb +260 -0
  165. data/lib/bag_kadaster_client/api/ligplaats_api.rb +370 -0
  166. data/lib/bag_kadaster_client/api/nummeraanduiding_api.rb +428 -0
  167. data/lib/bag_kadaster_client/api/openbare_ruimte_api.rb +382 -0
  168. data/lib/bag_kadaster_client/api/pand_api.rb +364 -0
  169. data/lib/bag_kadaster_client/api/standplaats_api.rb +370 -0
  170. data/lib/bag_kadaster_client/api/verblijfsobject_api.rb +379 -0
  171. data/lib/bag_kadaster_client/api/woonplaats_api.rb +469 -0
  172. data/lib/bag_kadaster_client/api_client.rb +390 -0
  173. data/lib/bag_kadaster_client/api_error.rb +57 -0
  174. data/lib/bag_kadaster_client/configuration.rb +282 -0
  175. data/lib/bag_kadaster_client/models/adres.rb +716 -0
  176. data/lib/bag_kadaster_client/models/adres_in_onderzoek.rb +330 -0
  177. data/lib/bag_kadaster_client/models/adres_io.rb +741 -0
  178. data/lib/bag_kadaster_client/models/adres_io_all_of.rb +227 -0
  179. data/lib/bag_kadaster_client/models/adres_io_embedded.rb +236 -0
  180. data/lib/bag_kadaster_client/models/adres_io_hal.rb +759 -0
  181. data/lib/bag_kadaster_client/models/adres_io_hal_all_of.rb +227 -0
  182. data/lib/bag_kadaster_client/models/adres_io_hal_collection.rb +227 -0
  183. data/lib/bag_kadaster_client/models/adres_io_hal_collection_embedded.rb +220 -0
  184. data/lib/bag_kadaster_client/models/adres_io_links.rb +266 -0
  185. data/lib/bag_kadaster_client/models/adres_uitgebreid.rb +821 -0
  186. data/lib/bag_kadaster_client/models/adres_uitgebreid_all_of.rb +306 -0
  187. data/lib/bag_kadaster_client/models/adres_uitgebreid_geconstateerd.rb +280 -0
  188. data/lib/bag_kadaster_client/models/adres_uitgebreid_geconstateerd_all_of.rb +245 -0
  189. data/lib/bag_kadaster_client/models/adres_uitgebreid_hal.rb +829 -0
  190. data/lib/bag_kadaster_client/models/adres_uitgebreid_hal_all_of.rb +218 -0
  191. data/lib/bag_kadaster_client/models/adres_uitgebreid_hal_collection.rb +227 -0
  192. data/lib/bag_kadaster_client/models/adres_uitgebreid_hal_collection_embedded.rb +220 -0
  193. data/lib/bag_kadaster_client/models/adres_uitgebreid_in_onderzoek.rb +420 -0
  194. data/lib/bag_kadaster_client/models/adres_uitgebreid_in_onderzoek_all_of.rb +292 -0
  195. data/lib/bag_kadaster_client/models/adres_uitgebreid_links.rb +273 -0
  196. data/lib/bag_kadaster_client/models/adresseerbaar_object.rb +309 -0
  197. data/lib/bag_kadaster_client/models/adresseerbaar_object_io_hal.rb +246 -0
  198. data/lib/bag_kadaster_client/models/adresseerbaar_object_lvc_io_hal_collection.rb +227 -0
  199. data/lib/bag_kadaster_client/models/adresseerbaar_object_lvc_io_hal_collection_embedded.rb +235 -0
  200. data/lib/bag_kadaster_client/models/adresseerbare_objecten_io_hal_collection.rb +227 -0
  201. data/lib/bag_kadaster_client/models/adresseerbare_objecten_io_hal_collection_embedded.rb +220 -0
  202. data/lib/bag_kadaster_client/models/api_info.rb +269 -0
  203. data/lib/bag_kadaster_client/models/bronhouder.rb +329 -0
  204. data/lib/bag_kadaster_client/models/bronhouder_hal.rb +233 -0
  205. data/lib/bag_kadaster_client/models/bronhouder_hal_collection.rb +227 -0
  206. data/lib/bag_kadaster_client/models/bronhouder_hal_collection_embedded.rb +220 -0
  207. data/lib/bag_kadaster_client/models/bronhouder_links.rb +223 -0
  208. data/lib/bag_kadaster_client/models/error.rb +320 -0
  209. data/lib/bag_kadaster_client/models/gebruiksdoel.rb +46 -0
  210. data/lib/bag_kadaster_client/models/geconstateerd.rb +237 -0
  211. data/lib/bag_kadaster_client/models/hal_collection_links.rb +218 -0
  212. data/lib/bag_kadaster_client/models/hal_link.rb +243 -0
  213. data/lib/bag_kadaster_client/models/hal_pagination_links.rb +262 -0
  214. data/lib/bag_kadaster_client/models/hal_pagination_links_all_of.rb +245 -0
  215. data/lib/bag_kadaster_client/models/hal_pagination_links_all_of_first.rb +237 -0
  216. data/lib/bag_kadaster_client/models/hal_pagination_links_all_of_last.rb +237 -0
  217. data/lib/bag_kadaster_client/models/hal_pagination_links_all_of_next.rb +237 -0
  218. data/lib/bag_kadaster_client/models/hal_pagination_links_all_of_previous.rb +237 -0
  219. data/lib/bag_kadaster_client/models/historie_in_onderzoek.rb +284 -0
  220. data/lib/bag_kadaster_client/models/in_onderzoek_ligplaats.rb +39 -0
  221. data/lib/bag_kadaster_client/models/in_onderzoek_nummeraanduiding.rb +43 -0
  222. data/lib/bag_kadaster_client/models/in_onderzoek_openbare_ruimte.rb +39 -0
  223. data/lib/bag_kadaster_client/models/in_onderzoek_pand.rb +38 -0
  224. data/lib/bag_kadaster_client/models/in_onderzoek_standplaats.rb +39 -0
  225. data/lib/bag_kadaster_client/models/in_onderzoek_verblijfsobject.rb +42 -0
  226. data/lib/bag_kadaster_client/models/in_onderzoek_woonplaats.rb +38 -0
  227. data/lib/bag_kadaster_client/models/indicatie.rb +37 -0
  228. data/lib/bag_kadaster_client/models/invalid_params.rb +265 -0
  229. data/lib/bag_kadaster_client/models/kenmerk_ligplaats_in_onderzoek.rb +374 -0
  230. data/lib/bag_kadaster_client/models/kenmerk_nummeraanduiding_in_onderzoek.rb +361 -0
  231. data/lib/bag_kadaster_client/models/kenmerk_openbare_ruimte_in_onderzoek.rb +374 -0
  232. data/lib/bag_kadaster_client/models/kenmerk_pand_in_onderzoek.rb +374 -0
  233. data/lib/bag_kadaster_client/models/kenmerk_standplaats_in_onderzoek.rb +374 -0
  234. data/lib/bag_kadaster_client/models/kenmerk_verblijfsobject_in_onderzoek.rb +374 -0
  235. data/lib/bag_kadaster_client/models/kenmerk_woonplaats_in_onderzoek.rb +375 -0
  236. data/lib/bag_kadaster_client/models/ligplaats.rb +435 -0
  237. data/lib/bag_kadaster_client/models/ligplaats_all_of.rb +422 -0
  238. data/lib/bag_kadaster_client/models/ligplaats_embedded.rb +244 -0
  239. data/lib/bag_kadaster_client/models/ligplaats_io_hal.rb +268 -0
  240. data/lib/bag_kadaster_client/models/ligplaats_io_hal_collection.rb +227 -0
  241. data/lib/bag_kadaster_client/models/ligplaats_io_hal_collection_embedded.rb +220 -0
  242. data/lib/bag_kadaster_client/models/ligplaats_io_lvc_hal_collection.rb +227 -0
  243. data/lib/bag_kadaster_client/models/ligplaats_io_lvc_hal_collection_embedded.rb +235 -0
  244. data/lib/bag_kadaster_client/models/ligplaats_links.rb +264 -0
  245. data/lib/bag_kadaster_client/models/multi_polygon.rb +274 -0
  246. data/lib/bag_kadaster_client/models/multi_surface.rb +280 -0
  247. data/lib/bag_kadaster_client/models/nummeraanduiding.rb +646 -0
  248. data/lib/bag_kadaster_client/models/nummeraanduiding_embedded.rb +227 -0
  249. data/lib/bag_kadaster_client/models/nummeraanduiding_io_hal.rb +268 -0
  250. data/lib/bag_kadaster_client/models/nummeraanduiding_io_hal_collection.rb +227 -0
  251. data/lib/bag_kadaster_client/models/nummeraanduiding_io_hal_collection_embedded.rb +220 -0
  252. data/lib/bag_kadaster_client/models/nummeraanduiding_io_lvc_hal_collection.rb +227 -0
  253. data/lib/bag_kadaster_client/models/nummeraanduiding_io_lvc_hal_collection_embedded.rb +235 -0
  254. data/lib/bag_kadaster_client/models/nummeraanduiding_links.rb +241 -0
  255. data/lib/bag_kadaster_client/models/openbare_ruimte.rb +585 -0
  256. data/lib/bag_kadaster_client/models/openbare_ruimte_embedded.rb +218 -0
  257. data/lib/bag_kadaster_client/models/openbare_ruimte_io_hal.rb +268 -0
  258. data/lib/bag_kadaster_client/models/openbare_ruimte_io_hal_collection.rb +227 -0
  259. data/lib/bag_kadaster_client/models/openbare_ruimte_io_hal_collection_embedded.rb +235 -0
  260. data/lib/bag_kadaster_client/models/openbare_ruimte_io_lvc_hal_collection.rb +227 -0
  261. data/lib/bag_kadaster_client/models/openbare_ruimte_io_lvc_hal_collection_embedded.rb +235 -0
  262. data/lib/bag_kadaster_client/models/openbare_ruimte_links.rb +232 -0
  263. data/lib/bag_kadaster_client/models/pand.rb +468 -0
  264. data/lib/bag_kadaster_client/models/pand_io_hal.rb +259 -0
  265. data/lib/bag_kadaster_client/models/pand_io_hal_collection.rb +227 -0
  266. data/lib/bag_kadaster_client/models/pand_io_hal_collection_embedded.rb +235 -0
  267. data/lib/bag_kadaster_client/models/pand_io_lvc_hal_collection.rb +227 -0
  268. data/lib/bag_kadaster_client/models/pand_io_lvc_hal_collection_embedded.rb +235 -0
  269. data/lib/bag_kadaster_client/models/pand_links.rb +223 -0
  270. data/lib/bag_kadaster_client/models/point.rb +293 -0
  271. data/lib/bag_kadaster_client/models/polygon.rb +274 -0
  272. data/lib/bag_kadaster_client/models/provincie.rb +294 -0
  273. data/lib/bag_kadaster_client/models/punt_of_vlak.rb +228 -0
  274. data/lib/bag_kadaster_client/models/standplaats.rb +435 -0
  275. data/lib/bag_kadaster_client/models/standplaats_all_of.rb +422 -0
  276. data/lib/bag_kadaster_client/models/standplaats_embedded.rb +244 -0
  277. data/lib/bag_kadaster_client/models/standplaats_io_hal.rb +268 -0
  278. data/lib/bag_kadaster_client/models/standplaats_io_hal_collection.rb +227 -0
  279. data/lib/bag_kadaster_client/models/standplaats_io_hal_collection_embedded.rb +220 -0
  280. data/lib/bag_kadaster_client/models/standplaats_io_lvc_hal_collection.rb +227 -0
  281. data/lib/bag_kadaster_client/models/standplaats_io_lvc_hal_collection_embedded.rb +235 -0
  282. data/lib/bag_kadaster_client/models/standplaats_links.rb +264 -0
  283. data/lib/bag_kadaster_client/models/status_naamgeving.rb +37 -0
  284. data/lib/bag_kadaster_client/models/status_pand.rb +45 -0
  285. data/lib/bag_kadaster_client/models/status_plaats.rb +37 -0
  286. data/lib/bag_kadaster_client/models/status_verblijfsobject.rb +43 -0
  287. data/lib/bag_kadaster_client/models/status_woonplaats.rb +37 -0
  288. data/lib/bag_kadaster_client/models/surface.rb +280 -0
  289. data/lib/bag_kadaster_client/models/type_adresseerbaar_object.rb +38 -0
  290. data/lib/bag_kadaster_client/models/type_openbare_ruimte.rb +42 -0
  291. data/lib/bag_kadaster_client/models/verblijfsobject.rb +529 -0
  292. data/lib/bag_kadaster_client/models/verblijfsobject_all_of.rb +516 -0
  293. data/lib/bag_kadaster_client/models/verblijfsobject_embedded.rb +270 -0
  294. data/lib/bag_kadaster_client/models/verblijfsobject_io_hal.rb +268 -0
  295. data/lib/bag_kadaster_client/models/verblijfsobject_io_hal_collection.rb +227 -0
  296. data/lib/bag_kadaster_client/models/verblijfsobject_io_hal_collection_embedded.rb +220 -0
  297. data/lib/bag_kadaster_client/models/verblijfsobject_io_lvc_hal_collection.rb +227 -0
  298. data/lib/bag_kadaster_client/models/verblijfsobject_io_lvc_hal_collection_embedded.rb +235 -0
  299. data/lib/bag_kadaster_client/models/verblijfsobject_links.rb +300 -0
  300. data/lib/bag_kadaster_client/models/vlak_of_multivlak.rb +228 -0
  301. data/lib/bag_kadaster_client/models/voorkomen.rb +329 -0
  302. data/lib/bag_kadaster_client/models/woonplaats.rb +463 -0
  303. data/lib/bag_kadaster_client/models/woonplaats_embedded.rb +244 -0
  304. data/lib/bag_kadaster_client/models/woonplaats_io_hal.rb +268 -0
  305. data/lib/bag_kadaster_client/models/woonplaats_io_hal_collection.rb +227 -0
  306. data/lib/bag_kadaster_client/models/woonplaats_io_hal_collection_embedded.rb +220 -0
  307. data/lib/bag_kadaster_client/models/woonplaats_io_lvc_hal_collection.rb +227 -0
  308. data/lib/bag_kadaster_client/models/woonplaats_io_lvc_hal_collection_embedded.rb +235 -0
  309. data/lib/bag_kadaster_client/models/woonplaats_links.rb +250 -0
  310. data/lib/bag_kadaster_client/models/zoek_resultaat.rb +235 -0
  311. data/lib/bag_kadaster_client/models/zoek_resultaat_hal.rb +251 -0
  312. data/lib/bag_kadaster_client/models/zoek_resultaat_hal_all_of.rb +218 -0
  313. data/lib/bag_kadaster_client/models/zoek_resultaat_hal_collection.rb +228 -0
  314. data/lib/bag_kadaster_client/models/zoek_resultaat_hal_collection_embedded.rb +220 -0
  315. data/lib/bag_kadaster_client/models/zoek_resultaat_links.rb +218 -0
  316. data/lib/bag_kadaster_client/version.rb +15 -0
  317. data/lib/bag_kadaster_client.rb +192 -0
  318. data/spec/api/adres_api_spec.rb +86 -0
  319. data/spec/api/adres_uitgebreid_api_spec.rb +68 -0
  320. data/spec/api/adresseerbaar_object_api_spec.rb +82 -0
  321. data/spec/api/algemene_informatie_api_spec.rb +45 -0
  322. data/spec/api/bronhouder_api_spec.rb +78 -0
  323. data/spec/api/ligplaats_api_spec.rb +98 -0
  324. data/spec/api/nummeraanduiding_api_spec.rb +103 -0
  325. data/spec/api/openbare_ruimte_api_spec.rb +97 -0
  326. data/spec/api/pand_api_spec.rb +96 -0
  327. data/spec/api/standplaats_api_spec.rb +98 -0
  328. data/spec/api/verblijfsobject_api_spec.rb +98 -0
  329. data/spec/api/woonplaats_api_spec.rb +116 -0
  330. data/spec/api_client_spec.rb +226 -0
  331. data/spec/configuration_spec.rb +42 -0
  332. data/spec/models/adres_in_onderzoek_spec.rb +106 -0
  333. data/spec/models/adres_io_all_of_spec.rb +40 -0
  334. data/spec/models/adres_io_embedded_spec.rb +46 -0
  335. data/spec/models/adres_io_hal_all_of_spec.rb +40 -0
  336. data/spec/models/adres_io_hal_collection_embedded_spec.rb +34 -0
  337. data/spec/models/adres_io_hal_collection_spec.rb +40 -0
  338. data/spec/models/adres_io_hal_spec.rb +130 -0
  339. data/spec/models/adres_io_links_spec.rb +64 -0
  340. data/spec/models/adres_io_spec.rb +118 -0
  341. data/spec/models/adres_spec.rb +106 -0
  342. data/spec/models/adres_uitgebreid_all_of_spec.rb +76 -0
  343. data/spec/models/adres_uitgebreid_geconstateerd_all_of_spec.rb +52 -0
  344. data/spec/models/adres_uitgebreid_geconstateerd_spec.rb +70 -0
  345. data/spec/models/adres_uitgebreid_hal_all_of_spec.rb +34 -0
  346. data/spec/models/adres_uitgebreid_hal_collection_embedded_spec.rb +34 -0
  347. data/spec/models/adres_uitgebreid_hal_collection_spec.rb +40 -0
  348. data/spec/models/adres_uitgebreid_hal_spec.rb +160 -0
  349. data/spec/models/adres_uitgebreid_in_onderzoek_all_of_spec.rb +82 -0
  350. data/spec/models/adres_uitgebreid_in_onderzoek_spec.rb +160 -0
  351. data/spec/models/adres_uitgebreid_links_spec.rb +64 -0
  352. data/spec/models/adres_uitgebreid_spec.rb +154 -0
  353. data/spec/models/adresseerbaar_object_io_hal_spec.rb +52 -0
  354. data/spec/models/adresseerbaar_object_lvc_io_hal_collection_embedded_spec.rb +34 -0
  355. data/spec/models/adresseerbaar_object_lvc_io_hal_collection_spec.rb +40 -0
  356. data/spec/models/adresseerbaar_object_spec.rb +46 -0
  357. data/spec/models/adresseerbare_objecten_io_hal_collection_embedded_spec.rb +34 -0
  358. data/spec/models/adresseerbare_objecten_io_hal_collection_spec.rb +40 -0
  359. data/spec/models/api_info_spec.rb +64 -0
  360. data/spec/models/bronhouder_hal_collection_embedded_spec.rb +34 -0
  361. data/spec/models/bronhouder_hal_collection_spec.rb +40 -0
  362. data/spec/models/bronhouder_hal_spec.rb +40 -0
  363. data/spec/models/bronhouder_links_spec.rb +34 -0
  364. data/spec/models/bronhouder_spec.rb +58 -0
  365. data/spec/models/error_spec.rb +70 -0
  366. data/spec/models/gebruiksdoel_spec.rb +28 -0
  367. data/spec/models/geconstateerd_spec.rb +46 -0
  368. data/spec/models/hal_collection_links_spec.rb +34 -0
  369. data/spec/models/hal_link_spec.rb +46 -0
  370. data/spec/models/hal_pagination_links_all_of_first_spec.rb +46 -0
  371. data/spec/models/hal_pagination_links_all_of_last_spec.rb +46 -0
  372. data/spec/models/hal_pagination_links_all_of_next_spec.rb +46 -0
  373. data/spec/models/hal_pagination_links_all_of_previous_spec.rb +46 -0
  374. data/spec/models/hal_pagination_links_all_of_spec.rb +52 -0
  375. data/spec/models/hal_pagination_links_spec.rb +58 -0
  376. data/spec/models/historie_in_onderzoek_spec.rb +64 -0
  377. data/spec/models/in_onderzoek_ligplaats_spec.rb +28 -0
  378. data/spec/models/in_onderzoek_nummeraanduiding_spec.rb +28 -0
  379. data/spec/models/in_onderzoek_openbare_ruimte_spec.rb +28 -0
  380. data/spec/models/in_onderzoek_pand_spec.rb +28 -0
  381. data/spec/models/in_onderzoek_standplaats_spec.rb +28 -0
  382. data/spec/models/in_onderzoek_verblijfsobject_spec.rb +28 -0
  383. data/spec/models/in_onderzoek_woonplaats_spec.rb +28 -0
  384. data/spec/models/indicatie_spec.rb +28 -0
  385. data/spec/models/invalid_params_spec.rb +52 -0
  386. data/spec/models/kenmerk_ligplaats_in_onderzoek_spec.rb +64 -0
  387. data/spec/models/kenmerk_nummeraanduiding_in_onderzoek_spec.rb +64 -0
  388. data/spec/models/kenmerk_openbare_ruimte_in_onderzoek_spec.rb +64 -0
  389. data/spec/models/kenmerk_pand_in_onderzoek_spec.rb +64 -0
  390. data/spec/models/kenmerk_standplaats_in_onderzoek_spec.rb +64 -0
  391. data/spec/models/kenmerk_verblijfsobject_in_onderzoek_spec.rb +64 -0
  392. data/spec/models/kenmerk_woonplaats_in_onderzoek_spec.rb +64 -0
  393. data/spec/models/ligplaats_all_of_spec.rb +76 -0
  394. data/spec/models/ligplaats_embedded_spec.rb +40 -0
  395. data/spec/models/ligplaats_io_hal_collection_embedded_spec.rb +34 -0
  396. data/spec/models/ligplaats_io_hal_collection_spec.rb +40 -0
  397. data/spec/models/ligplaats_io_hal_spec.rb +52 -0
  398. data/spec/models/ligplaats_io_lvc_hal_collection_embedded_spec.rb +34 -0
  399. data/spec/models/ligplaats_io_lvc_hal_collection_spec.rb +40 -0
  400. data/spec/models/ligplaats_links_spec.rb +46 -0
  401. data/spec/models/ligplaats_spec.rb +76 -0
  402. data/spec/models/multi_polygon_spec.rb +44 -0
  403. data/spec/models/multi_surface_spec.rb +44 -0
  404. data/spec/models/nummeraanduiding_embedded_spec.rb +40 -0
  405. data/spec/models/nummeraanduiding_io_hal_collection_embedded_spec.rb +34 -0
  406. data/spec/models/nummeraanduiding_io_hal_collection_spec.rb +40 -0
  407. data/spec/models/nummeraanduiding_io_hal_spec.rb +52 -0
  408. data/spec/models/nummeraanduiding_io_lvc_hal_collection_embedded_spec.rb +34 -0
  409. data/spec/models/nummeraanduiding_io_lvc_hal_collection_spec.rb +40 -0
  410. data/spec/models/nummeraanduiding_links_spec.rb +46 -0
  411. data/spec/models/nummeraanduiding_spec.rb +112 -0
  412. data/spec/models/openbare_ruimte_embedded_spec.rb +34 -0
  413. data/spec/models/openbare_ruimte_io_hal_collection_embedded_spec.rb +34 -0
  414. data/spec/models/openbare_ruimte_io_hal_collection_spec.rb +40 -0
  415. data/spec/models/openbare_ruimte_io_hal_spec.rb +52 -0
  416. data/spec/models/openbare_ruimte_io_lvc_hal_collection_embedded_spec.rb +34 -0
  417. data/spec/models/openbare_ruimte_io_lvc_hal_collection_spec.rb +40 -0
  418. data/spec/models/openbare_ruimte_links_spec.rb +40 -0
  419. data/spec/models/openbare_ruimte_spec.rb +94 -0
  420. data/spec/models/pand_io_hal_collection_embedded_spec.rb +34 -0
  421. data/spec/models/pand_io_hal_collection_spec.rb +40 -0
  422. data/spec/models/pand_io_hal_spec.rb +46 -0
  423. data/spec/models/pand_io_lvc_hal_collection_embedded_spec.rb +34 -0
  424. data/spec/models/pand_io_lvc_hal_collection_spec.rb +40 -0
  425. data/spec/models/pand_links_spec.rb +34 -0
  426. data/spec/models/pand_spec.rb +82 -0
  427. data/spec/models/point_spec.rb +44 -0
  428. data/spec/models/polygon_spec.rb +44 -0
  429. data/spec/models/provincie_spec.rb +40 -0
  430. data/spec/models/punt_of_vlak_spec.rb +40 -0
  431. data/spec/models/standplaats_all_of_spec.rb +76 -0
  432. data/spec/models/standplaats_embedded_spec.rb +40 -0
  433. data/spec/models/standplaats_io_hal_collection_embedded_spec.rb +34 -0
  434. data/spec/models/standplaats_io_hal_collection_spec.rb +40 -0
  435. data/spec/models/standplaats_io_hal_spec.rb +52 -0
  436. data/spec/models/standplaats_io_lvc_hal_collection_embedded_spec.rb +34 -0
  437. data/spec/models/standplaats_io_lvc_hal_collection_spec.rb +40 -0
  438. data/spec/models/standplaats_links_spec.rb +46 -0
  439. data/spec/models/standplaats_spec.rb +76 -0
  440. data/spec/models/status_naamgeving_spec.rb +28 -0
  441. data/spec/models/status_pand_spec.rb +28 -0
  442. data/spec/models/status_plaats_spec.rb +28 -0
  443. data/spec/models/status_verblijfsobject_spec.rb +28 -0
  444. data/spec/models/status_woonplaats_spec.rb +28 -0
  445. data/spec/models/surface_spec.rb +44 -0
  446. data/spec/models/type_adresseerbaar_object_spec.rb +28 -0
  447. data/spec/models/type_openbare_ruimte_spec.rb +28 -0
  448. data/spec/models/verblijfsobject_all_of_spec.rb +94 -0
  449. data/spec/models/verblijfsobject_embedded_spec.rb +46 -0
  450. data/spec/models/verblijfsobject_io_hal_collection_embedded_spec.rb +34 -0
  451. data/spec/models/verblijfsobject_io_hal_collection_spec.rb +40 -0
  452. data/spec/models/verblijfsobject_io_hal_spec.rb +52 -0
  453. data/spec/models/verblijfsobject_io_lvc_hal_collection_embedded_spec.rb +34 -0
  454. data/spec/models/verblijfsobject_io_lvc_hal_collection_spec.rb +40 -0
  455. data/spec/models/verblijfsobject_links_spec.rb +52 -0
  456. data/spec/models/verblijfsobject_spec.rb +94 -0
  457. data/spec/models/vlak_of_multivlak_spec.rb +40 -0
  458. data/spec/models/voorkomen_spec.rb +88 -0
  459. data/spec/models/woonplaats_embedded_spec.rb +40 -0
  460. data/spec/models/woonplaats_io_hal_collection_embedded_spec.rb +34 -0
  461. data/spec/models/woonplaats_io_hal_collection_spec.rb +40 -0
  462. data/spec/models/woonplaats_io_hal_spec.rb +52 -0
  463. data/spec/models/woonplaats_io_lvc_hal_collection_embedded_spec.rb +34 -0
  464. data/spec/models/woonplaats_io_lvc_hal_collection_spec.rb +40 -0
  465. data/spec/models/woonplaats_links_spec.rb +40 -0
  466. data/spec/models/woonplaats_spec.rb +76 -0
  467. data/spec/models/zoek_resultaat_hal_all_of_spec.rb +34 -0
  468. data/spec/models/zoek_resultaat_hal_collection_embedded_spec.rb +34 -0
  469. data/spec/models/zoek_resultaat_hal_collection_spec.rb +40 -0
  470. data/spec/models/zoek_resultaat_hal_spec.rb +46 -0
  471. data/spec/models/zoek_resultaat_links_spec.rb +34 -0
  472. data/spec/models/zoek_resultaat_spec.rb +40 -0
  473. data/spec/spec_helper.rb +111 -0
  474. metadata +732 -0
@@ -0,0 +1,239 @@
1
+ =begin
2
+ #IMBAG API - van de LVBAG
3
+
4
+ #Dit is de [BAG API](https://zakelijk.kadaster.nl/-/bag-api) Individuele Bevragingen van de Landelijke Voorziening Basisregistratie Adressen en Gebouwen (LVBAG). <br/> Meer informatie over de Basisregistratie Adressen en Gebouwen is te vinden op de website van het [Ministerie van Binnenlandse Zaken en Koninkrijksrelaties](https://www.geobasisregistraties.nl/basisregistraties/adressen-en-gebouwen) en [Kadaster](https://zakelijk.kadaster.nl/bag). <br/> <br/> De BAG API levert informatie conform de [BAG Catalogus 2018](https://www.geobasisregistraties.nl/documenten/publicatie/2018/03/12/catalogus-2018) en het informatiemodel IMBAG 2.0. De API specificatie volgt de [Nederlandse API-Strategie](https://docs.geostandaarden.nl/api/API-Strategie) specificatie versie van 20200204 en is opgesteld in [OpenAPI Specificatie](https://www.forumstandaardisatie.nl/standaard/openapi-specification) (OAS) v3. <br/> Het standaard mediatype HAL (`application/hal+json`) wordt gebruikt. Dit is een mediatype voor het weergeven van resources en hun relaties via hyperlinks. <br/> <br/> Deze API is vooral gericht op individuele bevragingen (op basis van de identificerende gegevens van een object). Om gebruik te kunnen maken van de BAG API is een API key nodig, deze kan verkregen worden door het [aanvraagformulier](https://formulieren.kadaster.nl/aanvraag_bag_api_individuele_bevragingen_productie) in te vullen. <br/> <br/> Voor vragen, neem contact op met de LVBAG beheerder o.v.v. BAG API 2.0. We zijn aan het kijken naar een geschikt medium hiervoor, mede ook om de API iteratief te kunnen opstellen of doorontwikkelen samen met de community. Als de API iets (nog) niet kan, wat u wel graag wilt, neem dan contact op.
5
+
6
+ The version of the OpenAPI document: 2.1.6
7
+
8
+ Generated by: https://openapi-generator.tech
9
+ OpenAPI Generator version: 5.4.0-SNAPSHOT
10
+
11
+ =end
12
+
13
+ require 'cgi'
14
+
15
+ module BagKadasterClient
16
+ class AdresUitgebreidApi
17
+ attr_accessor :api_client
18
+
19
+ def initialize(api_client = ApiClient.default)
20
+ @api_client = api_client
21
+ end
22
+ # Bevragen van de uitgebreide informatie van één huidig adres met de identificatie van een nummeraanduiding.
23
+ # Bevragen van de uitgebreide informatie van één huidig adres met de identificatie van een nummeraanduiding.
24
+ # @param nummeraanduiding_identificatie [String] Identificatie van een nummeraanduiding uit de BAG.
25
+ # @param [Hash] opts the optional parameters
26
+ # @option opts [String] :accept_crs Gewenste CRS van de coördinaten in de response.
27
+ # @return [AdresUitgebreidHal]
28
+ def bevraag_adres_uitgebreid_met_num_id(nummeraanduiding_identificatie, opts = {})
29
+ data, _status_code, _headers = bevraag_adres_uitgebreid_met_num_id_with_http_info(nummeraanduiding_identificatie, opts)
30
+ data
31
+ end
32
+
33
+ # Bevragen van de uitgebreide informatie van één huidig adres met de identificatie van een nummeraanduiding.
34
+ # Bevragen van de uitgebreide informatie van één huidig adres met de identificatie van een nummeraanduiding.
35
+ # @param nummeraanduiding_identificatie [String] Identificatie van een nummeraanduiding uit de BAG.
36
+ # @param [Hash] opts the optional parameters
37
+ # @option opts [String] :accept_crs Gewenste CRS van de coördinaten in de response.
38
+ # @return [Array<(AdresUitgebreidHal, Integer, Hash)>] AdresUitgebreidHal data, response status code and response headers
39
+ def bevraag_adres_uitgebreid_met_num_id_with_http_info(nummeraanduiding_identificatie, opts = {})
40
+ if @api_client.config.debugging
41
+ @api_client.config.logger.debug 'Calling API: AdresUitgebreidApi.bevraag_adres_uitgebreid_met_num_id ...'
42
+ end
43
+ # verify the required parameter 'nummeraanduiding_identificatie' is set
44
+ if @api_client.config.client_side_validation && nummeraanduiding_identificatie.nil?
45
+ fail ArgumentError, "Missing the required parameter 'nummeraanduiding_identificatie' when calling AdresUitgebreidApi.bevraag_adres_uitgebreid_met_num_id"
46
+ end
47
+ pattern = Regexp.new(/^[0-9]{4}20[0-9]{10}$/)
48
+ if @api_client.config.client_side_validation && nummeraanduiding_identificatie !~ pattern
49
+ fail ArgumentError, "invalid value for 'nummeraanduiding_identificatie' when calling AdresUitgebreidApi.bevraag_adres_uitgebreid_met_num_id, must conform to the pattern #{pattern}."
50
+ end
51
+
52
+ allowable_values = ["epsg:28992"]
53
+ if @api_client.config.client_side_validation && opts[:'accept_crs'] && !allowable_values.include?(opts[:'accept_crs'])
54
+ fail ArgumentError, "invalid value for \"accept_crs\", must be one of #{allowable_values}"
55
+ end
56
+ # resource path
57
+ local_var_path = '/adressenuitgebreid/{nummeraanduidingIdentificatie}'.sub('{' + 'nummeraanduidingIdentificatie' + '}', CGI.escape(nummeraanduiding_identificatie.to_s))
58
+
59
+ # query parameters
60
+ query_params = opts[:query_params] || {}
61
+
62
+ # header parameters
63
+ header_params = opts[:header_params] || {}
64
+ # HTTP header 'Accept' (if needed)
65
+ header_params['Accept'] = @api_client.select_header_accept(['application/hal+json', 'application/problem+json'])
66
+ header_params[:'Accept-Crs'] = opts[:'accept_crs'] if !opts[:'accept_crs'].nil?
67
+
68
+ # form parameters
69
+ form_params = opts[:form_params] || {}
70
+
71
+ # http body (model)
72
+ post_body = opts[:debug_body]
73
+
74
+ # return_type
75
+ return_type = opts[:debug_return_type] || 'AdresUitgebreidHal'
76
+
77
+ # auth_names
78
+ auth_names = opts[:debug_auth_names] || ['apiKeyBAG']
79
+
80
+ new_options = opts.merge(
81
+ :operation => :"AdresUitgebreidApi.bevraag_adres_uitgebreid_met_num_id",
82
+ :header_params => header_params,
83
+ :query_params => query_params,
84
+ :form_params => form_params,
85
+ :body => post_body,
86
+ :auth_names => auth_names,
87
+ :return_type => return_type
88
+ )
89
+
90
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
91
+ if @api_client.config.debugging
92
+ @api_client.config.logger.debug "API called: AdresUitgebreidApi#bevraag_adres_uitgebreid_met_num_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
93
+ end
94
+ return data, status_code, headers
95
+ end
96
+
97
+ # Bevragen van de uitgebreide informatie van één of meer huidige adressen op basis van verschillende combinaties van parameters.
98
+ # De volgende (combinaties van) parameters worden ondersteund: <ol> <li>Bevragen van de uitgebreide informatie van één of meer huidige adressen met een postcode, huisnummer en optioneel huisnummertoevoeging en huisletter. Het opgeven van een combinatie van parameters levert niet altijd een exacte match met één adres, bv. in geval van meerdere objecten met huisnummertoevoegingen en/of huisletters. Met de exacteMatch parameter kan worden aangegeven dat alleen object(en) die exact overeenkomen met de opgegeven parameters, geretourneerd moeten worden. </li> <li>Bevragen van de uitgebreide informatie van één of meer huidige adressen met de identificatie van een adresseerbaar object.</li> <li>Bevragen van de uitgebreide informatie van één of meer huidige adressen met woonplaats naam, openbare ruimte naam, huisnummer en optioneel huisnummertoevoeging en huisletter. Het opgeven van een combinatie van parameters levert niet altijd een exacte match met één adres, bv. in geval van meerdere objecten met huisnummertoevoegingen en/of huisletters. Met de exacteMatch parameter kan worden aangegeven dat alleen object(en) die exact overeenkomen met de opgegeven parameters, geretourneerd moeten worden. </li> </ol>
99
+ # @param [Hash] opts the optional parameters
100
+ # @option opts [String] :postcode Postcode behorende bij een nummeraanduiding.
101
+ # @option opts [Integer] :huisnummer Huisnummer behorende bij een nummeraanduiding.
102
+ # @option opts [String] :huisnummertoevoeging Huisnummertoevoeging behorende bij een nummeraanduiding.
103
+ # @option opts [String] :huisletter Huisletter behorende bij een nummeraanduiding.
104
+ # @option opts [Boolean] :exacte_match \&quot;Een indicatie of de resultaten van een zoekoperatie exact overeen moeten komen met de zoekcriteria, zie [functionele specificatie exacte match](https://github.com/lvbag/BAG-API/blob/master/Features/exacte_match.feature).\&quot; (default to false)
105
+ # @option opts [String] :adresseerbaar_object_identificatie Identificatie van een adresseerbaar object uit de BAG.
106
+ # @option opts [String] :woonplaats_naam Naam van een woonplaats.
107
+ # @option opts [String] :openbare_ruimte_naam Naam van een openbare ruimte.
108
+ # @option opts [String] :accept_crs Gewenste CRS van de coördinaten in de response.
109
+ # @return [AdresUitgebreidHalCollection]
110
+ def zoek_adres_uitgebreid(opts = {})
111
+ data, _status_code, _headers = zoek_adres_uitgebreid_with_http_info(opts)
112
+ data
113
+ end
114
+
115
+ # Bevragen van de uitgebreide informatie van één of meer huidige adressen op basis van verschillende combinaties van parameters.
116
+ # De volgende (combinaties van) parameters worden ondersteund: &lt;ol&gt; &lt;li&gt;Bevragen van de uitgebreide informatie van één of meer huidige adressen met een postcode, huisnummer en optioneel huisnummertoevoeging en huisletter. Het opgeven van een combinatie van parameters levert niet altijd een exacte match met één adres, bv. in geval van meerdere objecten met huisnummertoevoegingen en/of huisletters. Met de exacteMatch parameter kan worden aangegeven dat alleen object(en) die exact overeenkomen met de opgegeven parameters, geretourneerd moeten worden. &lt;/li&gt; &lt;li&gt;Bevragen van de uitgebreide informatie van één of meer huidige adressen met de identificatie van een adresseerbaar object.&lt;/li&gt; &lt;li&gt;Bevragen van de uitgebreide informatie van één of meer huidige adressen met woonplaats naam, openbare ruimte naam, huisnummer en optioneel huisnummertoevoeging en huisletter. Het opgeven van een combinatie van parameters levert niet altijd een exacte match met één adres, bv. in geval van meerdere objecten met huisnummertoevoegingen en/of huisletters. Met de exacteMatch parameter kan worden aangegeven dat alleen object(en) die exact overeenkomen met de opgegeven parameters, geretourneerd moeten worden. &lt;/li&gt; &lt;/ol&gt;
117
+ # @param [Hash] opts the optional parameters
118
+ # @option opts [String] :postcode Postcode behorende bij een nummeraanduiding.
119
+ # @option opts [Integer] :huisnummer Huisnummer behorende bij een nummeraanduiding.
120
+ # @option opts [String] :huisnummertoevoeging Huisnummertoevoeging behorende bij een nummeraanduiding.
121
+ # @option opts [String] :huisletter Huisletter behorende bij een nummeraanduiding.
122
+ # @option opts [Boolean] :exacte_match \&quot;Een indicatie of de resultaten van een zoekoperatie exact overeen moeten komen met de zoekcriteria, zie [functionele specificatie exacte match](https://github.com/lvbag/BAG-API/blob/master/Features/exacte_match.feature).\&quot;
123
+ # @option opts [String] :adresseerbaar_object_identificatie Identificatie van een adresseerbaar object uit de BAG.
124
+ # @option opts [String] :woonplaats_naam Naam van een woonplaats.
125
+ # @option opts [String] :openbare_ruimte_naam Naam van een openbare ruimte.
126
+ # @option opts [String] :accept_crs Gewenste CRS van de coördinaten in de response.
127
+ # @return [Array<(AdresUitgebreidHalCollection, Integer, Hash)>] AdresUitgebreidHalCollection data, response status code and response headers
128
+ def zoek_adres_uitgebreid_with_http_info(opts = {})
129
+ if @api_client.config.debugging
130
+ @api_client.config.logger.debug 'Calling API: AdresUitgebreidApi.zoek_adres_uitgebreid ...'
131
+ end
132
+ pattern = Regexp.new(/^[1-9]{1}[0-9]{3}[ ]{0,1}[a-zA-Z]{2}$/)
133
+ if @api_client.config.client_side_validation && !opts[:'postcode'].nil? && opts[:'postcode'] !~ pattern
134
+ fail ArgumentError, "invalid value for 'opts[:\"postcode\"]' when calling AdresUitgebreidApi.zoek_adres_uitgebreid, must conform to the pattern #{pattern}."
135
+ end
136
+
137
+ if @api_client.config.client_side_validation && !opts[:'huisnummer'].nil? && opts[:'huisnummer'] > 99999
138
+ fail ArgumentError, 'invalid value for "opts[:"huisnummer"]" when calling AdresUitgebreidApi.zoek_adres_uitgebreid, must be smaller than or equal to 99999.'
139
+ end
140
+
141
+ if @api_client.config.client_side_validation && !opts[:'huisnummer'].nil? && opts[:'huisnummer'] < 1
142
+ fail ArgumentError, 'invalid value for "opts[:"huisnummer"]" when calling AdresUitgebreidApi.zoek_adres_uitgebreid, must be greater than or equal to 1.'
143
+ end
144
+
145
+ pattern = Regexp.new(/^[0-9a-zA-Z]{1,4}$/)
146
+ if @api_client.config.client_side_validation && !opts[:'huisnummertoevoeging'].nil? && opts[:'huisnummertoevoeging'] !~ pattern
147
+ fail ArgumentError, "invalid value for 'opts[:\"huisnummertoevoeging\"]' when calling AdresUitgebreidApi.zoek_adres_uitgebreid, must conform to the pattern #{pattern}."
148
+ end
149
+
150
+ pattern = Regexp.new(/^[a-zA-Z]{1}$/)
151
+ if @api_client.config.client_side_validation && !opts[:'huisletter'].nil? && opts[:'huisletter'] !~ pattern
152
+ fail ArgumentError, "invalid value for 'opts[:\"huisletter\"]' when calling AdresUitgebreidApi.zoek_adres_uitgebreid, must conform to the pattern #{pattern}."
153
+ end
154
+
155
+ pattern = Regexp.new(/^[0-9]{4}(01|02|03)[0-9]{10}$/)
156
+ if @api_client.config.client_side_validation && !opts[:'adresseerbaar_object_identificatie'].nil? && opts[:'adresseerbaar_object_identificatie'] !~ pattern
157
+ fail ArgumentError, "invalid value for 'opts[:\"adresseerbaar_object_identificatie\"]' when calling AdresUitgebreidApi.zoek_adres_uitgebreid, must conform to the pattern #{pattern}."
158
+ end
159
+
160
+ if @api_client.config.client_side_validation && !opts[:'woonplaats_naam'].nil? && opts[:'woonplaats_naam'].to_s.length > 80
161
+ fail ArgumentError, 'invalid value for "opts[:"woonplaats_naam"]" when calling AdresUitgebreidApi.zoek_adres_uitgebreid, the character length must be smaller than or equal to 80.'
162
+ end
163
+
164
+ if @api_client.config.client_side_validation && !opts[:'woonplaats_naam'].nil? && opts[:'woonplaats_naam'].to_s.length < 1
165
+ fail ArgumentError, 'invalid value for "opts[:"woonplaats_naam"]" when calling AdresUitgebreidApi.zoek_adres_uitgebreid, the character length must be great than or equal to 1.'
166
+ end
167
+
168
+ pattern = Regexp.new(/^[\u0020-\u007E;\u00A0-\u00FF;\u0100-\u0113;\u0116-\u012B;\u012E-\u014D;\u0150-\u017E;\u02C7;\u02D8-\u02DB;\u02DD;\u2015;\u2018-\u2019;\u201C-\u201D;\u20AC;\u2122;\u2126;\u215B-\u215E;\u2190-\u2193;\u266A;]*/)
169
+ if @api_client.config.client_side_validation && !opts[:'woonplaats_naam'].nil? && opts[:'woonplaats_naam'] !~ pattern
170
+ fail ArgumentError, "invalid value for 'opts[:\"woonplaats_naam\"]' when calling AdresUitgebreidApi.zoek_adres_uitgebreid, must conform to the pattern #{pattern}."
171
+ end
172
+
173
+ if @api_client.config.client_side_validation && !opts[:'openbare_ruimte_naam'].nil? && opts[:'openbare_ruimte_naam'].to_s.length > 80
174
+ fail ArgumentError, 'invalid value for "opts[:"openbare_ruimte_naam"]" when calling AdresUitgebreidApi.zoek_adres_uitgebreid, the character length must be smaller than or equal to 80.'
175
+ end
176
+
177
+ if @api_client.config.client_side_validation && !opts[:'openbare_ruimte_naam'].nil? && opts[:'openbare_ruimte_naam'].to_s.length < 1
178
+ fail ArgumentError, 'invalid value for "opts[:"openbare_ruimte_naam"]" when calling AdresUitgebreidApi.zoek_adres_uitgebreid, the character length must be great than or equal to 1.'
179
+ end
180
+
181
+ pattern = Regexp.new(/^[\u0020-\u007E;\u00A0-\u00FF;\u0100-\u0113;\u0116-\u012B;\u012E-\u014D;\u0150-\u017E;\u02C7;\u02D8-\u02DB;\u02DD;\u2015;\u2018-\u2019;\u201C-\u201D;\u20AC;\u2122;\u2126;\u215B-\u215E;\u2190-\u2193;\u266A;]*/)
182
+ if @api_client.config.client_side_validation && !opts[:'openbare_ruimte_naam'].nil? && opts[:'openbare_ruimte_naam'] !~ pattern
183
+ fail ArgumentError, "invalid value for 'opts[:\"openbare_ruimte_naam\"]' when calling AdresUitgebreidApi.zoek_adres_uitgebreid, must conform to the pattern #{pattern}."
184
+ end
185
+
186
+ allowable_values = ["epsg:28992"]
187
+ if @api_client.config.client_side_validation && opts[:'accept_crs'] && !allowable_values.include?(opts[:'accept_crs'])
188
+ fail ArgumentError, "invalid value for \"accept_crs\", must be one of #{allowable_values}"
189
+ end
190
+ # resource path
191
+ local_var_path = '/adressenuitgebreid'
192
+
193
+ # query parameters
194
+ query_params = opts[:query_params] || {}
195
+ query_params[:'postcode'] = opts[:'postcode'] if !opts[:'postcode'].nil?
196
+ query_params[:'huisnummer'] = opts[:'huisnummer'] if !opts[:'huisnummer'].nil?
197
+ query_params[:'huisnummertoevoeging'] = opts[:'huisnummertoevoeging'] if !opts[:'huisnummertoevoeging'].nil?
198
+ query_params[:'huisletter'] = opts[:'huisletter'] if !opts[:'huisletter'].nil?
199
+ query_params[:'exacteMatch'] = opts[:'exacte_match'] if !opts[:'exacte_match'].nil?
200
+ query_params[:'adresseerbaarObjectIdentificatie'] = opts[:'adresseerbaar_object_identificatie'] if !opts[:'adresseerbaar_object_identificatie'].nil?
201
+ query_params[:'woonplaatsNaam'] = opts[:'woonplaats_naam'] if !opts[:'woonplaats_naam'].nil?
202
+ query_params[:'openbareRuimteNaam'] = opts[:'openbare_ruimte_naam'] if !opts[:'openbare_ruimte_naam'].nil?
203
+
204
+ # header parameters
205
+ header_params = opts[:header_params] || {}
206
+ # HTTP header 'Accept' (if needed)
207
+ header_params['Accept'] = @api_client.select_header_accept(['application/hal+json', 'application/problem+json'])
208
+ header_params[:'Accept-Crs'] = opts[:'accept_crs'] if !opts[:'accept_crs'].nil?
209
+
210
+ # form parameters
211
+ form_params = opts[:form_params] || {}
212
+
213
+ # http body (model)
214
+ post_body = opts[:debug_body]
215
+
216
+ # return_type
217
+ return_type = opts[:debug_return_type] || 'AdresUitgebreidHalCollection'
218
+
219
+ # auth_names
220
+ auth_names = opts[:debug_auth_names] || ['apiKeyBAG']
221
+
222
+ new_options = opts.merge(
223
+ :operation => :"AdresUitgebreidApi.zoek_adres_uitgebreid",
224
+ :header_params => header_params,
225
+ :query_params => query_params,
226
+ :form_params => form_params,
227
+ :body => post_body,
228
+ :auth_names => auth_names,
229
+ :return_type => return_type
230
+ )
231
+
232
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
233
+ if @api_client.config.debugging
234
+ @api_client.config.logger.debug "API called: AdresUitgebreidApi#zoek_adres_uitgebreid\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
235
+ end
236
+ return data, status_code, headers
237
+ end
238
+ end
239
+ end
@@ -0,0 +1,268 @@
1
+ =begin
2
+ #IMBAG API - van de LVBAG
3
+
4
+ #Dit is de [BAG API](https://zakelijk.kadaster.nl/-/bag-api) Individuele Bevragingen van de Landelijke Voorziening Basisregistratie Adressen en Gebouwen (LVBAG). <br/> Meer informatie over de Basisregistratie Adressen en Gebouwen is te vinden op de website van het [Ministerie van Binnenlandse Zaken en Koninkrijksrelaties](https://www.geobasisregistraties.nl/basisregistraties/adressen-en-gebouwen) en [Kadaster](https://zakelijk.kadaster.nl/bag). <br/> <br/> De BAG API levert informatie conform de [BAG Catalogus 2018](https://www.geobasisregistraties.nl/documenten/publicatie/2018/03/12/catalogus-2018) en het informatiemodel IMBAG 2.0. De API specificatie volgt de [Nederlandse API-Strategie](https://docs.geostandaarden.nl/api/API-Strategie) specificatie versie van 20200204 en is opgesteld in [OpenAPI Specificatie](https://www.forumstandaardisatie.nl/standaard/openapi-specification) (OAS) v3. <br/> Het standaard mediatype HAL (`application/hal+json`) wordt gebruikt. Dit is een mediatype voor het weergeven van resources en hun relaties via hyperlinks. <br/> <br/> Deze API is vooral gericht op individuele bevragingen (op basis van de identificerende gegevens van een object). Om gebruik te kunnen maken van de BAG API is een API key nodig, deze kan verkregen worden door het [aanvraagformulier](https://formulieren.kadaster.nl/aanvraag_bag_api_individuele_bevragingen_productie) in te vullen. <br/> <br/> Voor vragen, neem contact op met de LVBAG beheerder o.v.v. BAG API 2.0. We zijn aan het kijken naar een geschikt medium hiervoor, mede ook om de API iteratief te kunnen opstellen of doorontwikkelen samen met de community. Als de API iets (nog) niet kan, wat u wel graag wilt, neem dan contact op.
5
+
6
+ The version of the OpenAPI document: 2.1.6
7
+
8
+ Generated by: https://openapi-generator.tech
9
+ OpenAPI Generator version: 5.4.0-SNAPSHOT
10
+
11
+ =end
12
+
13
+ require 'cgi'
14
+
15
+ module BagKadasterClient
16
+ class AdresseerbaarObjectApi
17
+ attr_accessor :api_client
18
+
19
+ def initialize(api_client = ApiClient.default)
20
+ @api_client = api_client
21
+ end
22
+ # Bevragen van één adresseerbaar object met een adresseerbaar object identificatie.
23
+ # Bevragen van één adresseerbaar object (ligplaats, standplaats of verblijfsobject) met de identificatie van een adresseerbaar object. Als geldigOp en/of beschikbaarOp niet wordt opgegeven, worden de actuele gegevens geleverd. Als expand=heeftAlsHoofdAdres, heeftAlsNevenAdres, maaktDeelUitVan (of een combinatie daarvan) of als expand=true, dan worden de gevraagde of alle gerelateerde resources als geneste resource geleverd.
24
+ # @param adresseerbaar_object_identificatie [String] Identificatie van een object uit de BAG. Deze is 4 lang bij een woonplaats en 16 lang bij de andere objecten.
25
+ # @param [Hash] opts the optional parameters
26
+ # @option opts [Date] :geldig_op Filtert op objecten die geldig zijn op de opgegeven datum &#39;YYYY-MM-DD&#39; Deze parameters komen uit de API strategie, het hoofdstuk tijdreizen.
27
+ # @option opts [Time] :beschikbaar_op Filtert op objecten die beschikbaar zijn gekomen op de opgegeven datum en tijd &#x60;YYYY-MM-DDThh:mm:ss.sss&#39;. Hierin kunnen de seconden &#39;:ss&#39; en milliseconden &#39;.sss&#39; of alleen de milliseconden conform ISO 8601 specificatie worden weggelaten, in dat geval krijgen deze automatisch de waarde &#39;:00&#39; respectievelijk &#39;.000&#39;. Indien er voor de milliseconden &#39;.sss&#39; meer dan 3 cijfers worden opgegeven, bv. &#39;.12345&#39;, dan wordt dit afgekapt tot &#39;.123&#39;. Deze parameters komen uit de API strategie, het hoofdstuk tijdreizen.
28
+ # @option opts [String] :expand Hier kan aangegeven worden welke gerelateerde resources meegeladen moeten worden. Resources en velden van resources die gewenst zijn kunnen in de expand parameter kommagescheiden worden opgegeven. Specifieke velden van resource kunnen worden opgegeven door het opgeven van de resource-naam gevolgd door de veldnaam, met daartussen een punt.
29
+ # @option opts [String] :accept_crs Gewenste CRS van de coördinaten in de response.
30
+ # @return [AdresseerbaarObjectIOHal]
31
+ def bevragen_adresseerbaar_object(adresseerbaar_object_identificatie, opts = {})
32
+ data, _status_code, _headers = bevragen_adresseerbaar_object_with_http_info(adresseerbaar_object_identificatie, opts)
33
+ data
34
+ end
35
+
36
+ # Bevragen van één adresseerbaar object met een adresseerbaar object identificatie.
37
+ # Bevragen van één adresseerbaar object (ligplaats, standplaats of verblijfsobject) met de identificatie van een adresseerbaar object. Als geldigOp en/of beschikbaarOp niet wordt opgegeven, worden de actuele gegevens geleverd. Als expand&#x3D;heeftAlsHoofdAdres, heeftAlsNevenAdres, maaktDeelUitVan (of een combinatie daarvan) of als expand&#x3D;true, dan worden de gevraagde of alle gerelateerde resources als geneste resource geleverd.
38
+ # @param adresseerbaar_object_identificatie [String] Identificatie van een object uit de BAG. Deze is 4 lang bij een woonplaats en 16 lang bij de andere objecten.
39
+ # @param [Hash] opts the optional parameters
40
+ # @option opts [Date] :geldig_op Filtert op objecten die geldig zijn op de opgegeven datum &#39;YYYY-MM-DD&#39; Deze parameters komen uit de API strategie, het hoofdstuk tijdreizen.
41
+ # @option opts [Time] :beschikbaar_op Filtert op objecten die beschikbaar zijn gekomen op de opgegeven datum en tijd &#x60;YYYY-MM-DDThh:mm:ss.sss&#39;. Hierin kunnen de seconden &#39;:ss&#39; en milliseconden &#39;.sss&#39; of alleen de milliseconden conform ISO 8601 specificatie worden weggelaten, in dat geval krijgen deze automatisch de waarde &#39;:00&#39; respectievelijk &#39;.000&#39;. Indien er voor de milliseconden &#39;.sss&#39; meer dan 3 cijfers worden opgegeven, bv. &#39;.12345&#39;, dan wordt dit afgekapt tot &#39;.123&#39;. Deze parameters komen uit de API strategie, het hoofdstuk tijdreizen.
42
+ # @option opts [String] :expand Hier kan aangegeven worden welke gerelateerde resources meegeladen moeten worden. Resources en velden van resources die gewenst zijn kunnen in de expand parameter kommagescheiden worden opgegeven. Specifieke velden van resource kunnen worden opgegeven door het opgeven van de resource-naam gevolgd door de veldnaam, met daartussen een punt.
43
+ # @option opts [String] :accept_crs Gewenste CRS van de coördinaten in de response.
44
+ # @return [Array<(AdresseerbaarObjectIOHal, Integer, Hash)>] AdresseerbaarObjectIOHal data, response status code and response headers
45
+ def bevragen_adresseerbaar_object_with_http_info(adresseerbaar_object_identificatie, opts = {})
46
+ if @api_client.config.debugging
47
+ @api_client.config.logger.debug 'Calling API: AdresseerbaarObjectApi.bevragen_adresseerbaar_object ...'
48
+ end
49
+ # verify the required parameter 'adresseerbaar_object_identificatie' is set
50
+ if @api_client.config.client_side_validation && adresseerbaar_object_identificatie.nil?
51
+ fail ArgumentError, "Missing the required parameter 'adresseerbaar_object_identificatie' when calling AdresseerbaarObjectApi.bevragen_adresseerbaar_object"
52
+ end
53
+ pattern = Regexp.new(/^[0-9]{4}(01|02|03)[0-9]{10}$/)
54
+ if @api_client.config.client_side_validation && adresseerbaar_object_identificatie !~ pattern
55
+ fail ArgumentError, "invalid value for 'adresseerbaar_object_identificatie' when calling AdresseerbaarObjectApi.bevragen_adresseerbaar_object, must conform to the pattern #{pattern}."
56
+ end
57
+
58
+ allowable_values = ["epsg:28992"]
59
+ if @api_client.config.client_side_validation && opts[:'accept_crs'] && !allowable_values.include?(opts[:'accept_crs'])
60
+ fail ArgumentError, "invalid value for \"accept_crs\", must be one of #{allowable_values}"
61
+ end
62
+ # resource path
63
+ local_var_path = '/adresseerbareobjecten/{adresseerbaarObjectIdentificatie}'.sub('{' + 'adresseerbaarObjectIdentificatie' + '}', CGI.escape(adresseerbaar_object_identificatie.to_s))
64
+
65
+ # query parameters
66
+ query_params = opts[:query_params] || {}
67
+ query_params[:'geldigOp'] = opts[:'geldig_op'] if !opts[:'geldig_op'].nil?
68
+ query_params[:'beschikbaarOp'] = opts[:'beschikbaar_op'] if !opts[:'beschikbaar_op'].nil?
69
+ query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil?
70
+
71
+ # header parameters
72
+ header_params = opts[:header_params] || {}
73
+ # HTTP header 'Accept' (if needed)
74
+ header_params['Accept'] = @api_client.select_header_accept(['application/hal+json', 'application/problem+json'])
75
+ header_params[:'Accept-Crs'] = opts[:'accept_crs'] if !opts[:'accept_crs'].nil?
76
+
77
+ # form parameters
78
+ form_params = opts[:form_params] || {}
79
+
80
+ # http body (model)
81
+ post_body = opts[:debug_body]
82
+
83
+ # return_type
84
+ return_type = opts[:debug_return_type] || 'AdresseerbaarObjectIOHal'
85
+
86
+ # auth_names
87
+ auth_names = opts[:debug_auth_names] || ['apiKeyBAG']
88
+
89
+ new_options = opts.merge(
90
+ :operation => :"AdresseerbaarObjectApi.bevragen_adresseerbaar_object",
91
+ :header_params => header_params,
92
+ :query_params => query_params,
93
+ :form_params => form_params,
94
+ :body => post_body,
95
+ :auth_names => auth_names,
96
+ :return_type => return_type
97
+ )
98
+
99
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
100
+ if @api_client.config.debugging
101
+ @api_client.config.logger.debug "API called: AdresseerbaarObjectApi#bevragen_adresseerbaar_object\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
102
+ end
103
+ return data, status_code, headers
104
+ end
105
+
106
+ # Bevragen van de levenscyclus van een adresseerbaar object met een adresseerbaar object identificatie.
107
+ # Bevragen van de levenscyclus van een adresseerbaar object (ligplaats, standplaats of verblijfsobject) met de identificatie van een adresseerbaar object. Met de geheleLvc parameter kan worden aangegeven of de gehele levenscyclus (inclusief voorkomens die uit de geldige levenscyclus zijn verwijderd) of alleen de actieve levenscyclus (alleen de voorkomens die onderdeel zijn van de geldige levenscyclus) gewenst zijn.
108
+ # @param adresseerbaar_object_identificatie [String] Identificatie van een object uit de BAG. Deze is 4 lang bij een woonplaats en 16 lang bij de andere objecten.
109
+ # @param [Hash] opts the optional parameters
110
+ # @option opts [Boolean] :gehele_lvc Filtert naast geldige voorkomens ook de voorkomens die uit de geldige levenscyclus van het object zijn verwijderd. Als deze parameter wordt weggelaten worden alleen geldige voorkomens geretourneerd (default is false). (default to false)
111
+ # @option opts [String] :accept_crs Gewenste CRS van de coördinaten in de response.
112
+ # @return [AdresseerbaarObjectLvcIOHalCollection]
113
+ def bevragen_adresseerbaar_object_lvc(adresseerbaar_object_identificatie, opts = {})
114
+ data, _status_code, _headers = bevragen_adresseerbaar_object_lvc_with_http_info(adresseerbaar_object_identificatie, opts)
115
+ data
116
+ end
117
+
118
+ # Bevragen van de levenscyclus van een adresseerbaar object met een adresseerbaar object identificatie.
119
+ # Bevragen van de levenscyclus van een adresseerbaar object (ligplaats, standplaats of verblijfsobject) met de identificatie van een adresseerbaar object. Met de geheleLvc parameter kan worden aangegeven of de gehele levenscyclus (inclusief voorkomens die uit de geldige levenscyclus zijn verwijderd) of alleen de actieve levenscyclus (alleen de voorkomens die onderdeel zijn van de geldige levenscyclus) gewenst zijn.
120
+ # @param adresseerbaar_object_identificatie [String] Identificatie van een object uit de BAG. Deze is 4 lang bij een woonplaats en 16 lang bij de andere objecten.
121
+ # @param [Hash] opts the optional parameters
122
+ # @option opts [Boolean] :gehele_lvc Filtert naast geldige voorkomens ook de voorkomens die uit de geldige levenscyclus van het object zijn verwijderd. Als deze parameter wordt weggelaten worden alleen geldige voorkomens geretourneerd (default is false).
123
+ # @option opts [String] :accept_crs Gewenste CRS van de coördinaten in de response.
124
+ # @return [Array<(AdresseerbaarObjectLvcIOHalCollection, Integer, Hash)>] AdresseerbaarObjectLvcIOHalCollection data, response status code and response headers
125
+ def bevragen_adresseerbaar_object_lvc_with_http_info(adresseerbaar_object_identificatie, opts = {})
126
+ if @api_client.config.debugging
127
+ @api_client.config.logger.debug 'Calling API: AdresseerbaarObjectApi.bevragen_adresseerbaar_object_lvc ...'
128
+ end
129
+ # verify the required parameter 'adresseerbaar_object_identificatie' is set
130
+ if @api_client.config.client_side_validation && adresseerbaar_object_identificatie.nil?
131
+ fail ArgumentError, "Missing the required parameter 'adresseerbaar_object_identificatie' when calling AdresseerbaarObjectApi.bevragen_adresseerbaar_object_lvc"
132
+ end
133
+ pattern = Regexp.new(/^[0-9]{4}(01|02|03)[0-9]{10}$/)
134
+ if @api_client.config.client_side_validation && adresseerbaar_object_identificatie !~ pattern
135
+ fail ArgumentError, "invalid value for 'adresseerbaar_object_identificatie' when calling AdresseerbaarObjectApi.bevragen_adresseerbaar_object_lvc, must conform to the pattern #{pattern}."
136
+ end
137
+
138
+ allowable_values = ["epsg:28992"]
139
+ if @api_client.config.client_side_validation && opts[:'accept_crs'] && !allowable_values.include?(opts[:'accept_crs'])
140
+ fail ArgumentError, "invalid value for \"accept_crs\", must be one of #{allowable_values}"
141
+ end
142
+ # resource path
143
+ local_var_path = '/adresseerbareobjecten/{adresseerbaarObjectIdentificatie}/lvc'.sub('{' + 'adresseerbaarObjectIdentificatie' + '}', CGI.escape(adresseerbaar_object_identificatie.to_s))
144
+
145
+ # query parameters
146
+ query_params = opts[:query_params] || {}
147
+ query_params[:'geheleLvc'] = opts[:'gehele_lvc'] if !opts[:'gehele_lvc'].nil?
148
+
149
+ # header parameters
150
+ header_params = opts[:header_params] || {}
151
+ # HTTP header 'Accept' (if needed)
152
+ header_params['Accept'] = @api_client.select_header_accept(['application/hal+json', 'application/problem+json'])
153
+ header_params[:'Accept-Crs'] = opts[:'accept_crs'] if !opts[:'accept_crs'].nil?
154
+
155
+ # form parameters
156
+ form_params = opts[:form_params] || {}
157
+
158
+ # http body (model)
159
+ post_body = opts[:debug_body]
160
+
161
+ # return_type
162
+ return_type = opts[:debug_return_type] || 'AdresseerbaarObjectLvcIOHalCollection'
163
+
164
+ # auth_names
165
+ auth_names = opts[:debug_auth_names] || ['apiKeyBAG']
166
+
167
+ new_options = opts.merge(
168
+ :operation => :"AdresseerbaarObjectApi.bevragen_adresseerbaar_object_lvc",
169
+ :header_params => header_params,
170
+ :query_params => query_params,
171
+ :form_params => form_params,
172
+ :body => post_body,
173
+ :auth_names => auth_names,
174
+ :return_type => return_type
175
+ )
176
+
177
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
178
+ if @api_client.config.debugging
179
+ @api_client.config.logger.debug "API called: AdresseerbaarObjectApi#bevragen_adresseerbaar_object_lvc\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
180
+ end
181
+ return data, status_code, headers
182
+ end
183
+
184
+ # Bevragen van één of meer adresseerbare objecten op basis van een nummeraanduiding identificatie.
185
+ # Bevragen/zoeken van alle aan een nummeraanduiding identificatie gerelateerde adresseerbare objecten (ligplaats, standplaats of verblijfsobject). Parameter huidig kan worden toegepast. Als geldigOp en/of beschikbaarOp niet wordt opgegeven, worden de actuele gegevens geleverd. Als expand=heeftAlsHoofdAdres, heeftAlsNevenAdres, maaktDeelUitVan (of een combinatie daarvan) of als expand=true, dan worden de gevraagde of alle gerelateerde resources als geneste resource geleverd.
186
+ # @param [Hash] opts the optional parameters
187
+ # @option opts [String] :nummeraanduiding_identificatie Identificatie van een object uit de BAG. Deze is 4 lang bij een woonplaats en 16 lang bij de andere objecten.
188
+ # @option opts [Boolean] :huidig Indicatie dat alleen actuele object voorkomens zonder eindstatus gewenst zijn. (default to false)
189
+ # @option opts [Date] :geldig_op Filtert op objecten die geldig zijn op de opgegeven datum &#39;YYYY-MM-DD&#39; Deze parameters komen uit de API strategie, het hoofdstuk tijdreizen.
190
+ # @option opts [Time] :beschikbaar_op Filtert op objecten die beschikbaar zijn gekomen op de opgegeven datum en tijd &#x60;YYYY-MM-DDThh:mm:ss.sss&#39;. Hierin kunnen de seconden &#39;:ss&#39; en milliseconden &#39;.sss&#39; of alleen de milliseconden conform ISO 8601 specificatie worden weggelaten, in dat geval krijgen deze automatisch de waarde &#39;:00&#39; respectievelijk &#39;.000&#39;. Indien er voor de milliseconden &#39;.sss&#39; meer dan 3 cijfers worden opgegeven, bv. &#39;.12345&#39;, dan wordt dit afgekapt tot &#39;.123&#39;. Deze parameters komen uit de API strategie, het hoofdstuk tijdreizen.
191
+ # @option opts [String] :expand Hier kan aangegeven worden welke gerelateerde resources meegeladen moeten worden. Resources en velden van resources die gewenst zijn kunnen in de expand parameter kommagescheiden worden opgegeven. Specifieke velden van resource kunnen worden opgegeven door het opgeven van de resource-naam gevolgd door de veldnaam, met daartussen een punt.
192
+ # @option opts [String] :accept_crs Gewenste CRS van de coördinaten in de response.
193
+ # @return [AdresseerbareObjectenIOHalCollection]
194
+ def zoek_adresseerbaar_object(opts = {})
195
+ data, _status_code, _headers = zoek_adresseerbaar_object_with_http_info(opts)
196
+ data
197
+ end
198
+
199
+ # Bevragen van één of meer adresseerbare objecten op basis van een nummeraanduiding identificatie.
200
+ # Bevragen/zoeken van alle aan een nummeraanduiding identificatie gerelateerde adresseerbare objecten (ligplaats, standplaats of verblijfsobject). Parameter huidig kan worden toegepast. Als geldigOp en/of beschikbaarOp niet wordt opgegeven, worden de actuele gegevens geleverd. Als expand&#x3D;heeftAlsHoofdAdres, heeftAlsNevenAdres, maaktDeelUitVan (of een combinatie daarvan) of als expand&#x3D;true, dan worden de gevraagde of alle gerelateerde resources als geneste resource geleverd.
201
+ # @param [Hash] opts the optional parameters
202
+ # @option opts [String] :nummeraanduiding_identificatie Identificatie van een object uit de BAG. Deze is 4 lang bij een woonplaats en 16 lang bij de andere objecten.
203
+ # @option opts [Boolean] :huidig Indicatie dat alleen actuele object voorkomens zonder eindstatus gewenst zijn.
204
+ # @option opts [Date] :geldig_op Filtert op objecten die geldig zijn op de opgegeven datum &#39;YYYY-MM-DD&#39; Deze parameters komen uit de API strategie, het hoofdstuk tijdreizen.
205
+ # @option opts [Time] :beschikbaar_op Filtert op objecten die beschikbaar zijn gekomen op de opgegeven datum en tijd &#x60;YYYY-MM-DDThh:mm:ss.sss&#39;. Hierin kunnen de seconden &#39;:ss&#39; en milliseconden &#39;.sss&#39; of alleen de milliseconden conform ISO 8601 specificatie worden weggelaten, in dat geval krijgen deze automatisch de waarde &#39;:00&#39; respectievelijk &#39;.000&#39;. Indien er voor de milliseconden &#39;.sss&#39; meer dan 3 cijfers worden opgegeven, bv. &#39;.12345&#39;, dan wordt dit afgekapt tot &#39;.123&#39;. Deze parameters komen uit de API strategie, het hoofdstuk tijdreizen.
206
+ # @option opts [String] :expand Hier kan aangegeven worden welke gerelateerde resources meegeladen moeten worden. Resources en velden van resources die gewenst zijn kunnen in de expand parameter kommagescheiden worden opgegeven. Specifieke velden van resource kunnen worden opgegeven door het opgeven van de resource-naam gevolgd door de veldnaam, met daartussen een punt.
207
+ # @option opts [String] :accept_crs Gewenste CRS van de coördinaten in de response.
208
+ # @return [Array<(AdresseerbareObjectenIOHalCollection, Integer, Hash)>] AdresseerbareObjectenIOHalCollection data, response status code and response headers
209
+ def zoek_adresseerbaar_object_with_http_info(opts = {})
210
+ if @api_client.config.debugging
211
+ @api_client.config.logger.debug 'Calling API: AdresseerbaarObjectApi.zoek_adresseerbaar_object ...'
212
+ end
213
+ pattern = Regexp.new(/^[0-9]{4}20[0-9]{10}$/)
214
+ if @api_client.config.client_side_validation && !opts[:'nummeraanduiding_identificatie'].nil? && opts[:'nummeraanduiding_identificatie'] !~ pattern
215
+ fail ArgumentError, "invalid value for 'opts[:\"nummeraanduiding_identificatie\"]' when calling AdresseerbaarObjectApi.zoek_adresseerbaar_object, must conform to the pattern #{pattern}."
216
+ end
217
+
218
+ allowable_values = ["epsg:28992"]
219
+ if @api_client.config.client_side_validation && opts[:'accept_crs'] && !allowable_values.include?(opts[:'accept_crs'])
220
+ fail ArgumentError, "invalid value for \"accept_crs\", must be one of #{allowable_values}"
221
+ end
222
+ # resource path
223
+ local_var_path = '/adresseerbareobjecten'
224
+
225
+ # query parameters
226
+ query_params = opts[:query_params] || {}
227
+ query_params[:'nummeraanduidingIdentificatie'] = opts[:'nummeraanduiding_identificatie'] if !opts[:'nummeraanduiding_identificatie'].nil?
228
+ query_params[:'huidig'] = opts[:'huidig'] if !opts[:'huidig'].nil?
229
+ query_params[:'geldigOp'] = opts[:'geldig_op'] if !opts[:'geldig_op'].nil?
230
+ query_params[:'beschikbaarOp'] = opts[:'beschikbaar_op'] if !opts[:'beschikbaar_op'].nil?
231
+ query_params[:'expand'] = opts[:'expand'] if !opts[:'expand'].nil?
232
+
233
+ # header parameters
234
+ header_params = opts[:header_params] || {}
235
+ # HTTP header 'Accept' (if needed)
236
+ header_params['Accept'] = @api_client.select_header_accept(['application/hal+json', 'application/problem+json'])
237
+ header_params[:'Accept-Crs'] = opts[:'accept_crs'] if !opts[:'accept_crs'].nil?
238
+
239
+ # form parameters
240
+ form_params = opts[:form_params] || {}
241
+
242
+ # http body (model)
243
+ post_body = opts[:debug_body]
244
+
245
+ # return_type
246
+ return_type = opts[:debug_return_type] || 'AdresseerbareObjectenIOHalCollection'
247
+
248
+ # auth_names
249
+ auth_names = opts[:debug_auth_names] || ['apiKeyBAG']
250
+
251
+ new_options = opts.merge(
252
+ :operation => :"AdresseerbaarObjectApi.zoek_adresseerbaar_object",
253
+ :header_params => header_params,
254
+ :query_params => query_params,
255
+ :form_params => form_params,
256
+ :body => post_body,
257
+ :auth_names => auth_names,
258
+ :return_type => return_type
259
+ )
260
+
261
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
262
+ if @api_client.config.debugging
263
+ @api_client.config.logger.debug "API called: AdresseerbaarObjectApi#zoek_adresseerbaar_object\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
264
+ end
265
+ return data, status_code, headers
266
+ end
267
+ end
268
+ end
@@ -0,0 +1,77 @@
1
+ =begin
2
+ #IMBAG API - van de LVBAG
3
+
4
+ #Dit is de [BAG API](https://zakelijk.kadaster.nl/-/bag-api) Individuele Bevragingen van de Landelijke Voorziening Basisregistratie Adressen en Gebouwen (LVBAG). <br/> Meer informatie over de Basisregistratie Adressen en Gebouwen is te vinden op de website van het [Ministerie van Binnenlandse Zaken en Koninkrijksrelaties](https://www.geobasisregistraties.nl/basisregistraties/adressen-en-gebouwen) en [Kadaster](https://zakelijk.kadaster.nl/bag). <br/> <br/> De BAG API levert informatie conform de [BAG Catalogus 2018](https://www.geobasisregistraties.nl/documenten/publicatie/2018/03/12/catalogus-2018) en het informatiemodel IMBAG 2.0. De API specificatie volgt de [Nederlandse API-Strategie](https://docs.geostandaarden.nl/api/API-Strategie) specificatie versie van 20200204 en is opgesteld in [OpenAPI Specificatie](https://www.forumstandaardisatie.nl/standaard/openapi-specification) (OAS) v3. <br/> Het standaard mediatype HAL (`application/hal+json`) wordt gebruikt. Dit is een mediatype voor het weergeven van resources en hun relaties via hyperlinks. <br/> <br/> Deze API is vooral gericht op individuele bevragingen (op basis van de identificerende gegevens van een object). Om gebruik te kunnen maken van de BAG API is een API key nodig, deze kan verkregen worden door het [aanvraagformulier](https://formulieren.kadaster.nl/aanvraag_bag_api_individuele_bevragingen_productie) in te vullen. <br/> <br/> Voor vragen, neem contact op met de LVBAG beheerder o.v.v. BAG API 2.0. We zijn aan het kijken naar een geschikt medium hiervoor, mede ook om de API iteratief te kunnen opstellen of doorontwikkelen samen met de community. Als de API iets (nog) niet kan, wat u wel graag wilt, neem dan contact op.
5
+
6
+ The version of the OpenAPI document: 2.1.6
7
+
8
+ Generated by: https://openapi-generator.tech
9
+ OpenAPI Generator version: 5.4.0-SNAPSHOT
10
+
11
+ =end
12
+
13
+ require 'cgi'
14
+
15
+ module BagKadasterClient
16
+ class AlgemeneInformatieApi
17
+ attr_accessor :api_client
18
+
19
+ def initialize(api_client = ApiClient.default)
20
+ @api_client = api_client
21
+ end
22
+ # Algemene info van de API
23
+ # @param [Hash] opts the optional parameters
24
+ # @return [APIInfo]
25
+ def get_info(opts = {})
26
+ data, _status_code, _headers = get_info_with_http_info(opts)
27
+ data
28
+ end
29
+
30
+ # Algemene info van de API
31
+ # @param [Hash] opts the optional parameters
32
+ # @return [Array<(APIInfo, Integer, Hash)>] APIInfo data, response status code and response headers
33
+ def get_info_with_http_info(opts = {})
34
+ if @api_client.config.debugging
35
+ @api_client.config.logger.debug 'Calling API: AlgemeneInformatieApi.get_info ...'
36
+ end
37
+ # resource path
38
+ local_var_path = '/info'
39
+
40
+ # query parameters
41
+ query_params = opts[:query_params] || {}
42
+
43
+ # header parameters
44
+ header_params = opts[:header_params] || {}
45
+ # HTTP header 'Accept' (if needed)
46
+ header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/problem+json'])
47
+
48
+ # form parameters
49
+ form_params = opts[:form_params] || {}
50
+
51
+ # http body (model)
52
+ post_body = opts[:debug_body]
53
+
54
+ # return_type
55
+ return_type = opts[:debug_return_type] || 'APIInfo'
56
+
57
+ # auth_names
58
+ auth_names = opts[:debug_auth_names] || ['apiKeyBAG']
59
+
60
+ new_options = opts.merge(
61
+ :operation => :"AlgemeneInformatieApi.get_info",
62
+ :header_params => header_params,
63
+ :query_params => query_params,
64
+ :form_params => form_params,
65
+ :body => post_body,
66
+ :auth_names => auth_names,
67
+ :return_type => return_type
68
+ )
69
+
70
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
71
+ if @api_client.config.debugging
72
+ @api_client.config.logger.debug "API called: AlgemeneInformatieApi#get_info\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
73
+ end
74
+ return data, status_code, headers
75
+ end
76
+ end
77
+ end