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,329 @@
1
+ # BagKadasterClient::OpenbareRuimteApi
2
+
3
+ All URIs are relative to *https://api.bag.acceptatie.kadaster.nl/lvbag/individuelebevragingen/v2*
4
+
5
+ | Method | HTTP request | Description |
6
+ | ------ | ------------ | ----------- |
7
+ | [**openbareruimte_identificatie**](OpenbareRuimteApi.md#openbareruimte_identificatie) | **GET** /openbareruimten/{openbareRuimteIdentificatie} | bevragen van een openbare ruimte met de identificatie van een openbare ruimte. |
8
+ | [**openbareruimte_identificatie_voorkomen**](OpenbareRuimteApi.md#openbareruimte_identificatie_voorkomen) | **GET** /openbareruimten/{openbareRuimteIdentificatie}/{versie}/{timestampRegistratieLv} | bevragen van een voorkomen van een openbare ruimte met de identificatie van een openbare ruimte en de identificatie van een voorkomen, bestaande uit een versie en een timestamp van het tijdstip van registratie in de LV BAG. |
9
+ | [**openbareruimte_lvc_identificatie**](OpenbareRuimteApi.md#openbareruimte_lvc_identificatie) | **GET** /openbareruimten/{openbareRuimteIdentificatie}/lvc | bevragen levenscyclus van een openbare ruimte met de identificatie van een openbare ruimte. |
10
+ | [**zoek_openbare_ruimten**](OpenbareRuimteApi.md#zoek_openbare_ruimten) | **GET** /openbareruimten | bevragen openbare ruimte(n) op basis van de verschillende combinaties van parameters. |
11
+
12
+
13
+ ## openbareruimte_identificatie
14
+
15
+ > <OpenbareRuimteIOHal> openbareruimte_identificatie(openbare_ruimte_identificatie, opts)
16
+
17
+ bevragen van een openbare ruimte met de identificatie van een openbare ruimte.
18
+
19
+ Bevragen/raadplegen van een openbare ruimte met de identificatie van een openbare ruimte. Als geldigOp en/of beschikbaarOp niet wordt opgegeven, worden de actuele gegevens geleverd. Als expand=ligtInWoonplaats of true dan wordt de woonplaats als geneste resource geleverd.
20
+
21
+ ### Examples
22
+
23
+ ```ruby
24
+ require 'time'
25
+ require 'bag_kadaster_client'
26
+ # setup authorization
27
+ BagKadasterClient.configure do |config|
28
+ # Configure API key authorization: apiKeyBAG
29
+ config.api_key['apiKeyBAG'] = 'YOUR API KEY'
30
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
31
+ # config.api_key_prefix['apiKeyBAG'] = 'Bearer'
32
+ end
33
+
34
+ api_instance = BagKadasterClient::OpenbareRuimteApi.new
35
+ openbare_ruimte_identificatie = '0226300000136124' # String | Identificatie van een object uit de BAG. Deze is 4 lang bij een woonplaats en 16 lang bij de andere objecten.
36
+ opts = {
37
+ geldig_op: Date.parse('2019-06-01'), # Date | Filtert op objecten die geldig zijn op de opgegeven datum 'YYYY-MM-DD' Deze parameters komen uit de API strategie, het hoofdstuk tijdreizen.
38
+ beschikbaar_op: Time.parse('2013-10-20T19:20:30+01:00'), # Time | Filtert op objecten die beschikbaar zijn op de opgegeven datum en tijd `YYYY-MM-DDThh:mm:ss.sss' Hierin kunnen de seconden ':ss' en milliseconden '.sss' of alleen de milliseconden conform ISO 8601 specificatie worden weggelaten, in dat geval krijgen deze automatisch de waarde ':00' respectievelijk '.000'. Indien er voor de milliseconden '.sss' meer dan 3 cijfers worden opgegeven, bv. '.12345', dan wordt dit afgekapt tot '.123'. Deze parameters komen uit de API strategie, het hoofdstuk tijdreizen.
39
+ expand: 'expand_example' # String | 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.
40
+ }
41
+
42
+ begin
43
+ # bevragen van een openbare ruimte met de identificatie van een openbare ruimte.
44
+ result = api_instance.openbareruimte_identificatie(openbare_ruimte_identificatie, opts)
45
+ p result
46
+ rescue BagKadasterClient::ApiError => e
47
+ puts "Error when calling OpenbareRuimteApi->openbareruimte_identificatie: #{e}"
48
+ end
49
+ ```
50
+
51
+ #### Using the openbareruimte_identificatie_with_http_info variant
52
+
53
+ This returns an Array which contains the response data, status code and headers.
54
+
55
+ > <Array(<OpenbareRuimteIOHal>, Integer, Hash)> openbareruimte_identificatie_with_http_info(openbare_ruimte_identificatie, opts)
56
+
57
+ ```ruby
58
+ begin
59
+ # bevragen van een openbare ruimte met de identificatie van een openbare ruimte.
60
+ data, status_code, headers = api_instance.openbareruimte_identificatie_with_http_info(openbare_ruimte_identificatie, opts)
61
+ p status_code # => 2xx
62
+ p headers # => { ... }
63
+ p data # => <OpenbareRuimteIOHal>
64
+ rescue BagKadasterClient::ApiError => e
65
+ puts "Error when calling OpenbareRuimteApi->openbareruimte_identificatie_with_http_info: #{e}"
66
+ end
67
+ ```
68
+
69
+ ### Parameters
70
+
71
+ | Name | Type | Description | Notes |
72
+ | ---- | ---- | ----------- | ----- |
73
+ | **openbare_ruimte_identificatie** | **String** | Identificatie van een object uit de BAG. Deze is 4 lang bij een woonplaats en 16 lang bij de andere objecten. | |
74
+ | **geldig_op** | **Date** | 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. | [optional] |
75
+ | **beschikbaar_op** | **Time** | Filtert op objecten die beschikbaar zijn 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. | [optional] |
76
+ | **expand** | **String** | 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. | [optional] |
77
+
78
+ ### Return type
79
+
80
+ [**OpenbareRuimteIOHal**](OpenbareRuimteIOHal.md)
81
+
82
+ ### Authorization
83
+
84
+ [apiKeyBAG](../README.md#apiKeyBAG)
85
+
86
+ ### HTTP request headers
87
+
88
+ - **Content-Type**: Not defined
89
+ - **Accept**: application/hal+json, application/problem+json
90
+
91
+
92
+ ## openbareruimte_identificatie_voorkomen
93
+
94
+ > <OpenbareRuimteIOHal> openbareruimte_identificatie_voorkomen(openbare_ruimte_identificatie, versie, timestamp_registratie_lv)
95
+
96
+ bevragen van een voorkomen van een openbare ruimte met de identificatie van een openbare ruimte en de identificatie van een voorkomen, bestaande uit een versie en een timestamp van het tijdstip van registratie in de LV BAG.
97
+
98
+ Bevragen/raadplegen van een voorkomen van een openbare ruimte met de identificatie van een openbare ruimte en de identificatie van een voorkomen, bestaande uit een versie en een timestamp van het tijdstip van registratie in de LV BAG.
99
+
100
+ ### Examples
101
+
102
+ ```ruby
103
+ require 'time'
104
+ require 'bag_kadaster_client'
105
+ # setup authorization
106
+ BagKadasterClient.configure do |config|
107
+ # Configure API key authorization: apiKeyBAG
108
+ config.api_key['apiKeyBAG'] = 'YOUR API KEY'
109
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
110
+ # config.api_key_prefix['apiKeyBAG'] = 'Bearer'
111
+ end
112
+
113
+ api_instance = BagKadasterClient::OpenbareRuimteApi.new
114
+ openbare_ruimte_identificatie = '0226300000136124' # String | Identificatie van een object uit de BAG. Deze is 4 lang bij een woonplaats en 16 lang bij de andere objecten.
115
+ versie = 1 # Integer | De versie van een voorkomen van een object
116
+ timestamp_registratie_lv = '1530403860000' # String | Een timestamp van het tijdstip waarop een voorkomen is geregistreerd in de LV BAG
117
+
118
+ begin
119
+ # bevragen van een voorkomen van een openbare ruimte met de identificatie van een openbare ruimte en de identificatie van een voorkomen, bestaande uit een versie en een timestamp van het tijdstip van registratie in de LV BAG.
120
+ result = api_instance.openbareruimte_identificatie_voorkomen(openbare_ruimte_identificatie, versie, timestamp_registratie_lv)
121
+ p result
122
+ rescue BagKadasterClient::ApiError => e
123
+ puts "Error when calling OpenbareRuimteApi->openbareruimte_identificatie_voorkomen: #{e}"
124
+ end
125
+ ```
126
+
127
+ #### Using the openbareruimte_identificatie_voorkomen_with_http_info variant
128
+
129
+ This returns an Array which contains the response data, status code and headers.
130
+
131
+ > <Array(<OpenbareRuimteIOHal>, Integer, Hash)> openbareruimte_identificatie_voorkomen_with_http_info(openbare_ruimte_identificatie, versie, timestamp_registratie_lv)
132
+
133
+ ```ruby
134
+ begin
135
+ # bevragen van een voorkomen van een openbare ruimte met de identificatie van een openbare ruimte en de identificatie van een voorkomen, bestaande uit een versie en een timestamp van het tijdstip van registratie in de LV BAG.
136
+ data, status_code, headers = api_instance.openbareruimte_identificatie_voorkomen_with_http_info(openbare_ruimte_identificatie, versie, timestamp_registratie_lv)
137
+ p status_code # => 2xx
138
+ p headers # => { ... }
139
+ p data # => <OpenbareRuimteIOHal>
140
+ rescue BagKadasterClient::ApiError => e
141
+ puts "Error when calling OpenbareRuimteApi->openbareruimte_identificatie_voorkomen_with_http_info: #{e}"
142
+ end
143
+ ```
144
+
145
+ ### Parameters
146
+
147
+ | Name | Type | Description | Notes |
148
+ | ---- | ---- | ----------- | ----- |
149
+ | **openbare_ruimte_identificatie** | **String** | Identificatie van een object uit de BAG. Deze is 4 lang bij een woonplaats en 16 lang bij de andere objecten. | |
150
+ | **versie** | **Integer** | De versie van een voorkomen van een object | |
151
+ | **timestamp_registratie_lv** | **String** | Een timestamp van het tijdstip waarop een voorkomen is geregistreerd in de LV BAG | |
152
+
153
+ ### Return type
154
+
155
+ [**OpenbareRuimteIOHal**](OpenbareRuimteIOHal.md)
156
+
157
+ ### Authorization
158
+
159
+ [apiKeyBAG](../README.md#apiKeyBAG)
160
+
161
+ ### HTTP request headers
162
+
163
+ - **Content-Type**: Not defined
164
+ - **Accept**: application/hal+json, application/problem+json
165
+
166
+
167
+ ## openbareruimte_lvc_identificatie
168
+
169
+ > <OpenbareRuimteIOLvcHalCollection> openbareruimte_lvc_identificatie(openbare_ruimte_identificatie, opts)
170
+
171
+ bevragen levenscyclus van een openbare ruimte met de identificatie van een openbare ruimte.
172
+
173
+ Bevragen/raadplegen van de levenscyclus van één openbare ruimte, via de identificatie van een openbare ruimte.
174
+
175
+ ### Examples
176
+
177
+ ```ruby
178
+ require 'time'
179
+ require 'bag_kadaster_client'
180
+ # setup authorization
181
+ BagKadasterClient.configure do |config|
182
+ # Configure API key authorization: apiKeyBAG
183
+ config.api_key['apiKeyBAG'] = 'YOUR API KEY'
184
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
185
+ # config.api_key_prefix['apiKeyBAG'] = 'Bearer'
186
+ end
187
+
188
+ api_instance = BagKadasterClient::OpenbareRuimteApi.new
189
+ openbare_ruimte_identificatie = '0226300000136124' # String | Identificatie van een object uit de BAG. Deze is 4 lang bij een woonplaats en 16 lang bij de andere objecten.
190
+ opts = {
191
+ gehele_lvc: true # Boolean | 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). Voor een toelichting zie de [Praktijkhandleiding BAG](https://imbag.github.io/praktijkhandleiding/artikelen/wat-is-het-verschil-tussen-actieve-voorkomens-actuele-voorkomens-en-huidige-voorkomens).
192
+ }
193
+
194
+ begin
195
+ # bevragen levenscyclus van een openbare ruimte met de identificatie van een openbare ruimte.
196
+ result = api_instance.openbareruimte_lvc_identificatie(openbare_ruimte_identificatie, opts)
197
+ p result
198
+ rescue BagKadasterClient::ApiError => e
199
+ puts "Error when calling OpenbareRuimteApi->openbareruimte_lvc_identificatie: #{e}"
200
+ end
201
+ ```
202
+
203
+ #### Using the openbareruimte_lvc_identificatie_with_http_info variant
204
+
205
+ This returns an Array which contains the response data, status code and headers.
206
+
207
+ > <Array(<OpenbareRuimteIOLvcHalCollection>, Integer, Hash)> openbareruimte_lvc_identificatie_with_http_info(openbare_ruimte_identificatie, opts)
208
+
209
+ ```ruby
210
+ begin
211
+ # bevragen levenscyclus van een openbare ruimte met de identificatie van een openbare ruimte.
212
+ data, status_code, headers = api_instance.openbareruimte_lvc_identificatie_with_http_info(openbare_ruimte_identificatie, opts)
213
+ p status_code # => 2xx
214
+ p headers # => { ... }
215
+ p data # => <OpenbareRuimteIOLvcHalCollection>
216
+ rescue BagKadasterClient::ApiError => e
217
+ puts "Error when calling OpenbareRuimteApi->openbareruimte_lvc_identificatie_with_http_info: #{e}"
218
+ end
219
+ ```
220
+
221
+ ### Parameters
222
+
223
+ | Name | Type | Description | Notes |
224
+ | ---- | ---- | ----------- | ----- |
225
+ | **openbare_ruimte_identificatie** | **String** | Identificatie van een object uit de BAG. Deze is 4 lang bij een woonplaats en 16 lang bij de andere objecten. | |
226
+ | **gehele_lvc** | **Boolean** | 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). Voor een toelichting zie de [Praktijkhandleiding BAG](https://imbag.github.io/praktijkhandleiding/artikelen/wat-is-het-verschil-tussen-actieve-voorkomens-actuele-voorkomens-en-huidige-voorkomens). | [optional][default to false] |
227
+
228
+ ### Return type
229
+
230
+ [**OpenbareRuimteIOLvcHalCollection**](OpenbareRuimteIOLvcHalCollection.md)
231
+
232
+ ### Authorization
233
+
234
+ [apiKeyBAG](../README.md#apiKeyBAG)
235
+
236
+ ### HTTP request headers
237
+
238
+ - **Content-Type**: Not defined
239
+ - **Accept**: application/hal+json, application/problem+json
240
+
241
+
242
+ ## zoek_openbare_ruimten
243
+
244
+ > <OpenbareRuimteIOHalCollection> zoek_openbare_ruimten(opts)
245
+
246
+ bevragen openbare ruimte(n) op basis van de verschillende combinaties van parameters.
247
+
248
+ De volgende (combinaties van) parameters worden ondersteund:<br/> <ol> <li> Bevragen/raadplegen van een openbare ruimte met een woonplaats naam en een openbare ruimte naam. Als expand=ligtInWoonplaats of true dan wordt de woonplaats als geneste resource geleverd. </li> <li> Bevragen/raadplegen van een openbare ruimte met een woonplaats identificatie en een openbare ruimte naam. Als expand=ligtInWoonplaats of true dan wordt de woonplaats als geneste resource geleverd. </li> <li> Bevragen/zoeken van alle aan een woonplaats gerelateerde openbare ruimten met de woonplaats identificatie. Parameter huidig kan worden toegepast. Expand wordt niet ondersteund. </li> </ol> Bij alle bovenstaande combinaties wordt paginering ondersteund en kunnen de parameters geldigOp en beschikbaarOp worden gebruikt. Voor paginering, zie: [functionele specificatie paginering](https://github.com/lvbag/BAG-API/blob/master/Features/paginering.feature). Als geldigOp en beschikbaarOp niet wordt opgegeven, worden de actuele gegevens geleverd.
249
+
250
+ ### Examples
251
+
252
+ ```ruby
253
+ require 'time'
254
+ require 'bag_kadaster_client'
255
+ # setup authorization
256
+ BagKadasterClient.configure do |config|
257
+ # Configure API key authorization: apiKeyBAG
258
+ config.api_key['apiKeyBAG'] = 'YOUR API KEY'
259
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
260
+ # config.api_key_prefix['apiKeyBAG'] = 'Bearer'
261
+ end
262
+
263
+ api_instance = BagKadasterClient::OpenbareRuimteApi.new
264
+ opts = {
265
+ woonplaats_naam: 'Duiven', # String | Naam van een woonplaats object uit de BAG.
266
+ openbare_ruimte_naam: 'Laan van de landinrichtingscommissie Duiven-Westervoort', # String | Naam van een openbare ruimte object uit de BAG.
267
+ woonplaats_identificatie: '2096', # String | Identificatie van een object uit de BAG. Deze is 4 lang bij een woonplaats en 16 lang bij de andere objecten.
268
+ huidig: false, # Boolean | Indicatie dat alleen actuele object voorkomens zonder eindstatus gewenst zijn.
269
+ geldig_op: Date.parse('2019-06-01'), # Date | Filtert op objecten die geldig zijn op de opgegeven datum 'YYYY-MM-DD' Deze parameters komen uit de API strategie, het hoofdstuk tijdreizen.
270
+ beschikbaar_op: Time.parse('2013-10-20T19:20:30+01:00'), # Time | Filtert op objecten die beschikbaar zijn op de opgegeven datum en tijd `YYYY-MM-DDThh:mm:ss.sss' Hierin kunnen de seconden ':ss' en milliseconden '.sss' of alleen de milliseconden conform ISO 8601 specificatie worden weggelaten, in dat geval krijgen deze automatisch de waarde ':00' respectievelijk '.000'. Indien er voor de milliseconden '.sss' meer dan 3 cijfers worden opgegeven, bv. '.12345', dan wordt dit afgekapt tot '.123'. Deze parameters komen uit de API strategie, het hoofdstuk tijdreizen.
271
+ page: 56, # Integer | Pagina nummer
272
+ page_size: 56, # Integer | Aantal resultaten per pagina
273
+ expand: 'expand_example' # String | 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.
274
+ }
275
+
276
+ begin
277
+ # bevragen openbare ruimte(n) op basis van de verschillende combinaties van parameters.
278
+ result = api_instance.zoek_openbare_ruimten(opts)
279
+ p result
280
+ rescue BagKadasterClient::ApiError => e
281
+ puts "Error when calling OpenbareRuimteApi->zoek_openbare_ruimten: #{e}"
282
+ end
283
+ ```
284
+
285
+ #### Using the zoek_openbare_ruimten_with_http_info variant
286
+
287
+ This returns an Array which contains the response data, status code and headers.
288
+
289
+ > <Array(<OpenbareRuimteIOHalCollection>, Integer, Hash)> zoek_openbare_ruimten_with_http_info(opts)
290
+
291
+ ```ruby
292
+ begin
293
+ # bevragen openbare ruimte(n) op basis van de verschillende combinaties van parameters.
294
+ data, status_code, headers = api_instance.zoek_openbare_ruimten_with_http_info(opts)
295
+ p status_code # => 2xx
296
+ p headers # => { ... }
297
+ p data # => <OpenbareRuimteIOHalCollection>
298
+ rescue BagKadasterClient::ApiError => e
299
+ puts "Error when calling OpenbareRuimteApi->zoek_openbare_ruimten_with_http_info: #{e}"
300
+ end
301
+ ```
302
+
303
+ ### Parameters
304
+
305
+ | Name | Type | Description | Notes |
306
+ | ---- | ---- | ----------- | ----- |
307
+ | **woonplaats_naam** | **String** | Naam van een woonplaats object uit de BAG. | [optional] |
308
+ | **openbare_ruimte_naam** | **String** | Naam van een openbare ruimte object uit de BAG. | [optional] |
309
+ | **woonplaats_identificatie** | **String** | Identificatie van een object uit de BAG. Deze is 4 lang bij een woonplaats en 16 lang bij de andere objecten. | [optional] |
310
+ | **huidig** | **Boolean** | Indicatie dat alleen actuele object voorkomens zonder eindstatus gewenst zijn. | [optional][default to false] |
311
+ | **geldig_op** | **Date** | 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. | [optional] |
312
+ | **beschikbaar_op** | **Time** | Filtert op objecten die beschikbaar zijn 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. | [optional] |
313
+ | **page** | **Integer** | Pagina nummer | [optional][default to 1] |
314
+ | **page_size** | **Integer** | Aantal resultaten per pagina | [optional][default to 20] |
315
+ | **expand** | **String** | 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. | [optional] |
316
+
317
+ ### Return type
318
+
319
+ [**OpenbareRuimteIOHalCollection**](OpenbareRuimteIOHalCollection.md)
320
+
321
+ ### Authorization
322
+
323
+ [apiKeyBAG](../README.md#apiKeyBAG)
324
+
325
+ ### HTTP request headers
326
+
327
+ - **Content-Type**: Not defined
328
+ - **Accept**: application/hal+json, application/problem+json
329
+
@@ -0,0 +1,18 @@
1
+ # BagKadasterClient::OpenbareRuimteEmbedded
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **ligt_in_woonplaats** | [**WoonplaatsIOHal**](WoonplaatsIOHal.md) | | [optional] |
8
+
9
+ ## Example
10
+
11
+ ```ruby
12
+ require 'bag_kadaster_client'
13
+
14
+ instance = BagKadasterClient::OpenbareRuimteEmbedded.new(
15
+ ligt_in_woonplaats: null
16
+ )
17
+ ```
18
+
@@ -0,0 +1,24 @@
1
+ # BagKadasterClient::OpenbareRuimteIOHal
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **openbare_ruimte** | [**OpenbareRuimte**](OpenbareRuimte.md) | | |
8
+ | **inonderzoek** | [**Array&lt;KenmerkOpenbareRuimteInOnderzoek&gt;**](KenmerkOpenbareRuimteInOnderzoek.md) | | [optional] |
9
+ | **_embedded** | [**OpenbareRuimteEmbedded**](OpenbareRuimteEmbedded.md) | | [optional] |
10
+ | **_links** | [**OpenbareRuimteLinks**](OpenbareRuimteLinks.md) | | [optional] |
11
+
12
+ ## Example
13
+
14
+ ```ruby
15
+ require 'bag_kadaster_client'
16
+
17
+ instance = BagKadasterClient::OpenbareRuimteIOHal.new(
18
+ openbare_ruimte: null,
19
+ inonderzoek: null,
20
+ _embedded: null,
21
+ _links: null
22
+ )
23
+ ```
24
+
@@ -0,0 +1,20 @@
1
+ # BagKadasterClient::OpenbareRuimteIOHalCollection
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **_embedded** | [**OpenbareRuimteIOHalCollectionEmbedded**](OpenbareRuimteIOHalCollectionEmbedded.md) | | [optional] |
8
+ | **_links** | [**HalPaginationLinks**](HalPaginationLinks.md) | | [optional] |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'bag_kadaster_client'
14
+
15
+ instance = BagKadasterClient::OpenbareRuimteIOHalCollection.new(
16
+ _embedded: null,
17
+ _links: null
18
+ )
19
+ ```
20
+
@@ -0,0 +1,18 @@
1
+ # BagKadasterClient::OpenbareRuimteIOHalCollectionEmbedded
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **openbareruimten** | [**Array&lt;OpenbareRuimteIOHal&gt;**](OpenbareRuimteIOHal.md) | | [optional] |
8
+
9
+ ## Example
10
+
11
+ ```ruby
12
+ require 'bag_kadaster_client'
13
+
14
+ instance = BagKadasterClient::OpenbareRuimteIOHalCollectionEmbedded.new(
15
+ openbareruimten: null
16
+ )
17
+ ```
18
+
@@ -0,0 +1,20 @@
1
+ # BagKadasterClient::OpenbareRuimteIOLvcHalCollection
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **_embedded** | [**OpenbareRuimteIOLvcHalCollectionEmbedded**](OpenbareRuimteIOLvcHalCollectionEmbedded.md) | | [optional] |
8
+ | **_links** | [**HalCollectionLinks**](HalCollectionLinks.md) | | [optional] |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'bag_kadaster_client'
14
+
15
+ instance = BagKadasterClient::OpenbareRuimteIOLvcHalCollection.new(
16
+ _embedded: null,
17
+ _links: null
18
+ )
19
+ ```
20
+
@@ -0,0 +1,18 @@
1
+ # BagKadasterClient::OpenbareRuimteIOLvcHalCollectionEmbedded
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **voorkomens** | [**Array&lt;OpenbareRuimteIOHal&gt;**](OpenbareRuimteIOHal.md) | | [optional] |
8
+
9
+ ## Example
10
+
11
+ ```ruby
12
+ require 'bag_kadaster_client'
13
+
14
+ instance = BagKadasterClient::OpenbareRuimteIOLvcHalCollectionEmbedded.new(
15
+ voorkomens: null
16
+ )
17
+ ```
18
+
@@ -0,0 +1,20 @@
1
+ # BagKadasterClient::OpenbareRuimteLinks
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **_self** | [**HalLink**](HalLink.md) | | |
8
+ | **ligt_in_woonplaats** | [**HalLink**](HalLink.md) | | [optional] |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'bag_kadaster_client'
14
+
15
+ instance = BagKadasterClient::OpenbareRuimteLinks.new(
16
+ _self: null,
17
+ ligt_in_woonplaats: null
18
+ )
19
+ ```
20
+
data/docs/Pand.md ADDED
@@ -0,0 +1,34 @@
1
+ # BagKadasterClient::Pand
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **identificatie** | **String** | Deze wordt gebruikt in de operation. | |
8
+ | **domein** | **String** | NL.IMBAG.Pand | |
9
+ | **geometrie** | [**Surface**](Surface.md) | | |
10
+ | **oorspronkelijk_bouwjaar** | **String** | De aanduiding van het jaar waarin een pand oorspronkelijk als bouwkundig gereed is of zal worden opgeleverd. Bij het initieel opvoeren van een PAND wordt door de gemeente een reële inschatting gemaakt van het waarschijnlijke bouwjaar van het PAND. Bij het bouwkundig gereed opleveren van het PAND wordt deze waarde in voorkomende gevallen aangepast. Indien in latere jaren wijzigingen aan een pand worden aangebracht, leidt dit niet tot wijziging van het bouwjaar. | |
11
+ | **status** | [**StatusPand**](StatusPand.md) | | |
12
+ | **geconstateerd** | [**Indicatie**](Indicatie.md) | | |
13
+ | **documentdatum** | **Date** | De datum waarop het brondocument is vastgesteld, op basis waarvan een opname, mutatie of een verwijdering van gegevens ten aanzien van een object heeft plaatsgevonden. | |
14
+ | **documentnummer** | **String** | De unieke aanduiding van het brondocument op basis waarvan een opname, mutatie of een verwijdering van gegevens ten aanzien van een woonplaats heeft plaatsgevonden, binnen een gemeente. Alle karakters uit de MES-1 karakterset zijn toegestaan. | |
15
+ | **voorkomen** | [**Voorkomen**](Voorkomen.md) | | |
16
+
17
+ ## Example
18
+
19
+ ```ruby
20
+ require 'bag_kadaster_client'
21
+
22
+ instance = BagKadasterClient::Pand.new(
23
+ identificatie: 0226100000008856,
24
+ domein: NL.IMBAG.Pand,
25
+ geometrie: null,
26
+ oorspronkelijk_bouwjaar: 1991,
27
+ status: null,
28
+ geconstateerd: null,
29
+ documentdatum: Tue May 12 00:00:00 UTC 2009,
30
+ documentnummer: 09.BW.0273,
31
+ voorkomen: null
32
+ )
33
+ ```
34
+