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,282 @@
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
+ module BagKadasterClient
14
+ class Configuration
15
+ # Defines url scheme
16
+ attr_accessor :scheme
17
+
18
+ # Defines url host
19
+ attr_accessor :host
20
+
21
+ # Defines url base path
22
+ attr_accessor :base_path
23
+
24
+ # Define server configuration index
25
+ attr_accessor :server_index
26
+
27
+ # Define server operation configuration index
28
+ attr_accessor :server_operation_index
29
+
30
+ # Default server variables
31
+ attr_accessor :server_variables
32
+
33
+ # Default server operation variables
34
+ attr_accessor :server_operation_variables
35
+
36
+ # Defines API keys used with API Key authentications.
37
+ #
38
+ # @return [Hash] key: parameter name, value: parameter value (API key)
39
+ #
40
+ # @example parameter name is "api_key", API key is "xxx" (e.g. "api_key=xxx" in query string)
41
+ # config.api_key['api_key'] = 'xxx'
42
+ attr_accessor :api_key
43
+
44
+ # Defines API key prefixes used with API Key authentications.
45
+ #
46
+ # @return [Hash] key: parameter name, value: API key prefix
47
+ #
48
+ # @example parameter name is "Authorization", API key prefix is "Token" (e.g. "Authorization: Token xxx" in headers)
49
+ # config.api_key_prefix['api_key'] = 'Token'
50
+ attr_accessor :api_key_prefix
51
+
52
+ # Defines the username used with HTTP basic authentication.
53
+ #
54
+ # @return [String]
55
+ attr_accessor :username
56
+
57
+ # Defines the password used with HTTP basic authentication.
58
+ #
59
+ # @return [String]
60
+ attr_accessor :password
61
+
62
+ # Defines the access token (Bearer) used with OAuth2.
63
+ attr_accessor :access_token
64
+
65
+ # Set this to enable/disable debugging. When enabled (set to true), HTTP request/response
66
+ # details will be logged with `logger.debug` (see the `logger` attribute).
67
+ # Default to false.
68
+ #
69
+ # @return [true, false]
70
+ attr_accessor :debugging
71
+
72
+ # Defines the logger used for debugging.
73
+ # Default to `Rails.logger` (when in Rails) or logging to STDOUT.
74
+ #
75
+ # @return [#debug]
76
+ attr_accessor :logger
77
+
78
+ # Defines the temporary folder to store downloaded files
79
+ # (for API endpoints that have file response).
80
+ # Default to use `Tempfile`.
81
+ #
82
+ # @return [String]
83
+ attr_accessor :temp_folder_path
84
+
85
+ # The time limit for HTTP request in seconds.
86
+ # Default to 0 (never times out).
87
+ attr_accessor :timeout
88
+
89
+ # Set this to false to skip client side validation in the operation.
90
+ # Default to true.
91
+ # @return [true, false]
92
+ attr_accessor :client_side_validation
93
+
94
+ ### TLS/SSL setting
95
+ # Set this to false to skip verifying SSL certificate when calling API from https server.
96
+ # Default to true.
97
+ #
98
+ # @note Do NOT set it to false in production code, otherwise you would face multiple types of cryptographic attacks.
99
+ #
100
+ # @return [true, false]
101
+ attr_accessor :verify_ssl
102
+
103
+ ### TLS/SSL setting
104
+ # Set this to false to skip verifying SSL host name
105
+ # Default to true.
106
+ #
107
+ # @note Do NOT set it to false in production code, otherwise you would face multiple types of cryptographic attacks.
108
+ #
109
+ # @return [true, false]
110
+ attr_accessor :verify_ssl_host
111
+
112
+ ### TLS/SSL setting
113
+ # Set this to customize the certificate file to verify the peer.
114
+ #
115
+ # @return [String] the path to the certificate file
116
+ #
117
+ # @see The `cainfo` option of Typhoeus, `--cert` option of libcurl. Related source code:
118
+ # https://github.com/typhoeus/typhoeus/blob/master/lib/typhoeus/easy_factory.rb#L145
119
+ attr_accessor :ssl_ca_cert
120
+
121
+ ### TLS/SSL setting
122
+ # Client certificate file (for client certificate)
123
+ attr_accessor :cert_file
124
+
125
+ ### TLS/SSL setting
126
+ # Client private key file (for client certificate)
127
+ attr_accessor :key_file
128
+
129
+ # Set this to customize parameters encoding of array parameter with multi collectionFormat.
130
+ # Default to nil.
131
+ #
132
+ # @see The params_encoding option of Ethon. Related source code:
133
+ # https://github.com/typhoeus/ethon/blob/master/lib/ethon/easy/queryable.rb#L96
134
+ attr_accessor :params_encoding
135
+
136
+ attr_accessor :inject_format
137
+
138
+ attr_accessor :force_ending_format
139
+
140
+ def initialize
141
+ @scheme = 'https'
142
+ @host = 'api.bag.acceptatie.kadaster.nl'
143
+ @base_path = '/lvbag/individuelebevragingen/v2'
144
+ @server_index = 0
145
+ @server_operation_index = {}
146
+ @server_variables = {}
147
+ @server_operation_variables = {}
148
+ @api_key = {}
149
+ @api_key_prefix = {}
150
+ @client_side_validation = true
151
+ @verify_ssl = true
152
+ @verify_ssl_host = true
153
+ @params_encoding = nil
154
+ @cert_file = nil
155
+ @key_file = nil
156
+ @timeout = 0
157
+ @debugging = false
158
+ @inject_format = false
159
+ @force_ending_format = false
160
+ @logger = defined?(Rails) ? Rails.logger : Logger.new(STDOUT)
161
+
162
+ yield(self) if block_given?
163
+ end
164
+
165
+ # The default Configuration object.
166
+ def self.default
167
+ @@default ||= Configuration.new
168
+ end
169
+
170
+ def configure
171
+ yield(self) if block_given?
172
+ end
173
+
174
+ def scheme=(scheme)
175
+ # remove :// from scheme
176
+ @scheme = scheme.sub(/:\/\//, '')
177
+ end
178
+
179
+ def host=(host)
180
+ # remove http(s):// and anything after a slash
181
+ @host = host.sub(/https?:\/\//, '').split('/').first
182
+ end
183
+
184
+ def base_path=(base_path)
185
+ # Add leading and trailing slashes to base_path
186
+ @base_path = "/#{base_path}".gsub(/\/+/, '/')
187
+ @base_path = '' if @base_path == '/'
188
+ end
189
+
190
+ # Returns base URL for specified operation based on server settings
191
+ def base_url(operation = nil)
192
+ index = server_operation_index.fetch(operation, server_index)
193
+ return "#{scheme}://#{[host, base_path].join('/').gsub(/\/+/, '/')}".sub(/\/+\z/, '') if index == nil
194
+
195
+ server_url(index, server_operation_variables.fetch(operation, server_variables), operation_server_settings[operation])
196
+ end
197
+
198
+ # Gets API key (with prefix if set).
199
+ # @param [String] param_name the parameter name of API key auth
200
+ def api_key_with_prefix(param_name, param_alias = nil)
201
+ key = @api_key[param_name]
202
+ key = @api_key.fetch(param_alias, key) unless param_alias.nil?
203
+ if @api_key_prefix[param_name]
204
+ "#{@api_key_prefix[param_name]} #{key}"
205
+ else
206
+ key
207
+ end
208
+ end
209
+
210
+ # Gets Basic Auth token string
211
+ def basic_auth_token
212
+ 'Basic ' + ["#{username}:#{password}"].pack('m').delete("\r\n")
213
+ end
214
+
215
+ # Returns Auth Settings hash for api client.
216
+ def auth_settings
217
+ {
218
+ 'apiKeyBAG' =>
219
+ {
220
+ type: 'api_key',
221
+ in: 'header',
222
+ key: 'X-Api-Key',
223
+ value: api_key_with_prefix('apiKeyBAG')
224
+ },
225
+ }
226
+ end
227
+
228
+ # Returns an array of Server setting
229
+ def server_settings
230
+ [
231
+ {
232
+ url: "https://api.bag.acceptatie.kadaster.nl/lvbag/individuelebevragingen/v2",
233
+ description: "LVBAG - ACCEPTATIE",
234
+ },
235
+ {
236
+ url: "https://api.bag.kadaster.nl/lvbag/individuelebevragingen/v2",
237
+ description: "LVBAG - PRODUCTIE",
238
+ }
239
+ ]
240
+ end
241
+
242
+ def operation_server_settings
243
+ {
244
+ }
245
+ end
246
+
247
+ # Returns URL based on server settings
248
+ #
249
+ # @param index array index of the server settings
250
+ # @param variables hash of variable and the corresponding value
251
+ def server_url(index, variables = {}, servers = nil)
252
+ servers = server_settings if servers == nil
253
+
254
+ # check array index out of bound
255
+ if (index < 0 || index >= servers.size)
256
+ fail ArgumentError, "Invalid index #{index} when selecting the server. Must be less than #{servers.size}"
257
+ end
258
+
259
+ server = servers[index]
260
+ url = server[:url]
261
+
262
+ return url unless server.key? :variables
263
+
264
+ # go through variable and assign a value
265
+ server[:variables].each do |name, variable|
266
+ if variables.key?(name)
267
+ if (!server[:variables][name].key?(:enum_values) || server[:variables][name][:enum_values].include?(variables[name]))
268
+ url.gsub! "{" + name.to_s + "}", variables[name]
269
+ else
270
+ fail ArgumentError, "The variable `#{name}` in the server URL has invalid value #{variables[name]}. Must be #{server[:variables][name][:enum_values]}."
271
+ end
272
+ else
273
+ # use default value
274
+ url.gsub! "{" + name.to_s + "}", server[:variables][name][:default_value]
275
+ end
276
+ end
277
+
278
+ url
279
+ end
280
+
281
+ end
282
+ end