bag_kadaster_client 1.0.0

data/docs/VerblijfsobjectAllOf.md

@@ -0,0 +1,38 @@
+# BagKadasterClient::VerblijfsobjectAllOf
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **identificatie** | **String** | Deze wordt gebruikt in de operation. |  |
+| **domein** | **String** | NL.IMBAG.Verblijfsobject |  |
+| **geometrie** | [**PuntOfVlak**](PuntOfVlak.md) |  |  |
+| **gebruiksdoelen** | [**Array<Gebruiksdoel>**](Gebruiksdoel.md) |  |  |
+| **oppervlakte** | **Integer** |  |  |
+| **status** | [**StatusVerblijfsobject**](StatusVerblijfsobject.md) |  |  |
+| **geconstateerd** | [**Indicatie**](Indicatie.md) |  |  |
+| **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. |  |
+| **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. |  |
+| **voorkomen** | [**Voorkomen**](Voorkomen.md) |  |  |
+| **maakt_deel_uit_van** | **Array<String>** |  |  |
+
+## Example
+
+```ruby
+require 'bag_kadaster_client'
+
+instance = BagKadasterClient::VerblijfsobjectAllOf.new(
+  identificatie: 0226010000038820,
+  domein: NL.IMBAG.Verblijfsobject,
+  geometrie: null,
+  gebruiksdoelen: null,
+  oppervlakte: 205,
+  status: null,
+  geconstateerd: null,
+  documentdatum: Fri Nov 22 00:00:00 UTC 2019,
+  documentnummer: 19SZ2048,
+  voorkomen: null,
+  maakt_deel_uit_van: null
+)
+```
+

data/docs/VerblijfsobjectApi.md

@@ -0,0 +1,333 @@
+# BagKadasterClient::VerblijfsobjectApi
+
+All URIs are relative to *https://api.bag.acceptatie.kadaster.nl/lvbag/individuelebevragingen/v2*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**verblijfsobject_identificatie**](VerblijfsobjectApi.md#verblijfsobject_identificatie) | **GET** /verblijfsobjecten/{identificatie} | bevragen 1 verblijfsobject met de identificatie van een verblijfsobject. |
+| [**verblijfsobject_identificatie_voorkomen**](VerblijfsobjectApi.md#verblijfsobject_identificatie_voorkomen) | **GET** /verblijfsobjecten/{identificatie}/{versie}/{timestampRegistratieLv} | bevragen voorkomen van een verblijfsobject, op basis van de identificatie van een verblijfsobject en de identificatie van een voorkomen |
+| [**verblijfsobject_lvc_identificatie**](VerblijfsobjectApi.md#verblijfsobject_lvc_identificatie) | **GET** /verblijfsobjecten/{identificatie}/lvc | bevragen levenscyclus van een verblijfsobject met de identificatie van een verblijfsobject. |
+| [**zoek_verblijfsobjecten**](VerblijfsobjectApi.md#zoek_verblijfsobjecten) | **GET** /verblijfsobjecten | bevragen van alle aan een pand gerelateerde verblijfsobjecten (met paginering). |
+
+
+## verblijfsobject_identificatie
+
+> <VerblijfsobjectIOHal> verblijfsobject_identificatie(identificatie, opts)
+
+bevragen 1 verblijfsobject met de identificatie van een verblijfsobject.
+
+Bevragen/raadplegen van één voorkomen van een Verblijfsobject met de identificatie van een verblijfsobject. Als geldigOp en/of beschikbaarOp niet wordt opgegeven, worden de actuele gegevens geleverd. Als expand=heeftAlsHoofdAdres, heeftAlsNevenAdres, maaktDeelUitVan of true, dan worden de gevraagde of alle gerelateerde objecten als geneste resource geleverd.
+
+### Examples
+
+```ruby
+require 'time'
+require 'bag_kadaster_client'
+# setup authorization
+BagKadasterClient.configure do |config|
+  # Configure API key authorization: apiKeyBAG
+  config.api_key['apiKeyBAG'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['apiKeyBAG'] = 'Bearer'
+end
+
+api_instance = BagKadasterClient::VerblijfsobjectApi.new
+identificatie = '0226010000038820' # String | Identificatie van een object uit de BAG. Deze is 4 lang bij een woonplaats en 16 lang bij de andere objecten.
+opts = {
+  geldig_op: Date.parse('2019-11-23'), # Date | Filtert op objecten die geldig zijn op de opgegeven datum `JJJJ-MM-DD` Deze parameters komen uit de API strategie, het hoofdstuk tijdreizen. 
+  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. 
+  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.
+  accept_crs: 'epsg:28992' # String | Gewenste CRS van de coördinaten in de response.
+}
+
+begin
+  # bevragen 1 verblijfsobject met de identificatie van een verblijfsobject.
+  result = api_instance.verblijfsobject_identificatie(identificatie, opts)
+  p result
+rescue BagKadasterClient::ApiError => e
+  puts "Error when calling VerblijfsobjectApi->verblijfsobject_identificatie: #{e}"
+end
+```
+
+#### Using the verblijfsobject_identificatie_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<VerblijfsobjectIOHal>, Integer, Hash)> verblijfsobject_identificatie_with_http_info(identificatie, opts)
+
+```ruby
+begin
+  # bevragen 1 verblijfsobject met de identificatie van een verblijfsobject.
+  data, status_code, headers = api_instance.verblijfsobject_identificatie_with_http_info(identificatie, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <VerblijfsobjectIOHal>
+rescue BagKadasterClient::ApiError => e
+  puts "Error when calling VerblijfsobjectApi->verblijfsobject_identificatie_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **identificatie** | **String** | Identificatie van een object uit de BAG. Deze is 4 lang bij een woonplaats en 16 lang bij de andere objecten. |  |
+| **geldig_op** | **Date** | Filtert op objecten die geldig zijn op de opgegeven datum &#x60;JJJJ-MM-DD&#x60; Deze parameters komen uit de API strategie, het hoofdstuk tijdreizen.  | [optional] |
+| **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] |
+| **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] |
+| **accept_crs** | **String** | Gewenste CRS van de coördinaten in de response. | [optional] |
+
+### Return type
+
+[**VerblijfsobjectIOHal**](VerblijfsobjectIOHal.md)
+
+### Authorization
+
+[apiKeyBAG](../README.md#apiKeyBAG)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/hal+json, application/problem+json
+
+
+## verblijfsobject_identificatie_voorkomen
+
+> <VerblijfsobjectIOHal> verblijfsobject_identificatie_voorkomen(identificatie, versie, timestamp_registratie_lv, opts)
+
+bevragen voorkomen van een verblijfsobject, op basis van de identificatie van een verblijfsobject en de identificatie van een voorkomen
+
+Bevragen/raadplegen van een voorkomen van een verblijfsobject, met de identificatie van een verblijfsobject en de identificatie van een voorkomen, bestaande uit een versie en een timestamp van het tijdstip van registratie in de LV BAG.
+
+### Examples
+
+```ruby
+require 'time'
+require 'bag_kadaster_client'
+# setup authorization
+BagKadasterClient.configure do |config|
+  # Configure API key authorization: apiKeyBAG
+  config.api_key['apiKeyBAG'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['apiKeyBAG'] = 'Bearer'
+end
+
+api_instance = BagKadasterClient::VerblijfsobjectApi.new
+identificatie = '0226010000038820' # String | Identificatie van een object uit de BAG. Deze is 4 lang bij een woonplaats en 16 lang bij de andere objecten.
+versie = 1 # Integer | De versie van een voorkomen van een object
+timestamp_registratie_lv = '1530403860000' # String | Een timestamp van het tijdstip waarop een voorkomen is geregistreerd in de LV BAG
+opts = {
+  accept_crs: 'epsg:28992' # String | Gewenste CRS van de coördinaten in de response.
+}
+
+begin
+  # bevragen voorkomen van een verblijfsobject, op basis van de identificatie van een verblijfsobject en de identificatie van een voorkomen
+  result = api_instance.verblijfsobject_identificatie_voorkomen(identificatie, versie, timestamp_registratie_lv, opts)
+  p result
+rescue BagKadasterClient::ApiError => e
+  puts "Error when calling VerblijfsobjectApi->verblijfsobject_identificatie_voorkomen: #{e}"
+end
+```
+
+#### Using the verblijfsobject_identificatie_voorkomen_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<VerblijfsobjectIOHal>, Integer, Hash)> verblijfsobject_identificatie_voorkomen_with_http_info(identificatie, versie, timestamp_registratie_lv, opts)
+
+```ruby
+begin
+  # bevragen voorkomen van een verblijfsobject, op basis van de identificatie van een verblijfsobject en de identificatie van een voorkomen
+  data, status_code, headers = api_instance.verblijfsobject_identificatie_voorkomen_with_http_info(identificatie, versie, timestamp_registratie_lv, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <VerblijfsobjectIOHal>
+rescue BagKadasterClient::ApiError => e
+  puts "Error when calling VerblijfsobjectApi->verblijfsobject_identificatie_voorkomen_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **identificatie** | **String** | Identificatie van een object uit de BAG. Deze is 4 lang bij een woonplaats en 16 lang bij de andere objecten. |  |
+| **versie** | **Integer** | De versie van een voorkomen van een object |  |
+| **timestamp_registratie_lv** | **String** | Een timestamp van het tijdstip waarop een voorkomen is geregistreerd in de LV BAG |  |
+| **accept_crs** | **String** | Gewenste CRS van de coördinaten in de response. | [optional] |
+
+### Return type
+
+[**VerblijfsobjectIOHal**](VerblijfsobjectIOHal.md)
+
+### Authorization
+
+[apiKeyBAG](../README.md#apiKeyBAG)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/hal+json, application/problem+json
+
+
+## verblijfsobject_lvc_identificatie
+
+> <VerblijfsobjectIOLvcHalCollection> verblijfsobject_lvc_identificatie(identificatie, opts)
+
+bevragen levenscyclus van een verblijfsobject met de identificatie van een verblijfsobject.
+
+Bevragen/raadplegen van de levenscyclus van een Verblijfsobject met de identificatie van de verblijfsobject.
+
+### Examples
+
+```ruby
+require 'time'
+require 'bag_kadaster_client'
+# setup authorization
+BagKadasterClient.configure do |config|
+  # Configure API key authorization: apiKeyBAG
+  config.api_key['apiKeyBAG'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['apiKeyBAG'] = 'Bearer'
+end
+
+api_instance = BagKadasterClient::VerblijfsobjectApi.new
+identificatie = '0226010000038820' # String | Identificatie van een object uit de BAG. Deze is 4 lang bij een woonplaats en 16 lang bij de andere objecten.
+opts = {
+  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).
+  accept_crs: 'epsg:28992' # String | Gewenste CRS van de coördinaten in de response.
+}
+
+begin
+  # bevragen levenscyclus van een verblijfsobject met de identificatie van een verblijfsobject.
+  result = api_instance.verblijfsobject_lvc_identificatie(identificatie, opts)
+  p result
+rescue BagKadasterClient::ApiError => e
+  puts "Error when calling VerblijfsobjectApi->verblijfsobject_lvc_identificatie: #{e}"
+end
+```
+
+#### Using the verblijfsobject_lvc_identificatie_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<VerblijfsobjectIOLvcHalCollection>, Integer, Hash)> verblijfsobject_lvc_identificatie_with_http_info(identificatie, opts)
+
+```ruby
+begin
+  # bevragen levenscyclus van een verblijfsobject met de identificatie van een verblijfsobject.
+  data, status_code, headers = api_instance.verblijfsobject_lvc_identificatie_with_http_info(identificatie, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <VerblijfsobjectIOLvcHalCollection>
+rescue BagKadasterClient::ApiError => e
+  puts "Error when calling VerblijfsobjectApi->verblijfsobject_lvc_identificatie_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **identificatie** | **String** | Identificatie van een object uit de BAG. Deze is 4 lang bij een woonplaats en 16 lang bij de andere objecten. |  |
+| **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] |
+| **accept_crs** | **String** | Gewenste CRS van de coördinaten in de response. | [optional] |
+
+### Return type
+
+[**VerblijfsobjectIOLvcHalCollection**](VerblijfsobjectIOLvcHalCollection.md)
+
+### Authorization
+
+[apiKeyBAG](../README.md#apiKeyBAG)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/hal+json, application/problem+json
+
+
+## zoek_verblijfsobjecten
+
+> <VerblijfsobjectIOHalCollection> zoek_verblijfsobjecten(pand_identificatie, opts)
+
+bevragen van alle aan een pand gerelateerde verblijfsobjecten (met paginering).
+
+Bevragen/zoeken van alle aan een pand gerelateerde verblijfsobjecten, met een pand identificatie en met paginering. Parameter huidig kan worden toegepast. Als geldigOp en/of beschikbaarOp niet wordt opgegeven, worden de actuele gegevens geleverd. Voor paginering, zie: [functionele specificatie paginering](https://github.com/lvbag/BAG-API/blob/master/Features/paginering.feature).
+
+### Examples
+
+```ruby
+require 'time'
+require 'bag_kadaster_client'
+# setup authorization
+BagKadasterClient.configure do |config|
+  # Configure API key authorization: apiKeyBAG
+  config.api_key['apiKeyBAG'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['apiKeyBAG'] = 'Bearer'
+end
+
+api_instance = BagKadasterClient::VerblijfsobjectApi.new
+pand_identificatie = '0226100000008856' # String | Identificatie van een object uit de BAG. Deze is 4 lang bij een woonplaats en 16 lang bij de andere objecten.
+opts = {
+  huidig: false, # Boolean | Indicatie dat alleen actuele object voorkomens zonder eindstatus gewenst zijn.
+  geldig_op: Date.parse('2019-11-23'), # Date | Filtert op objecten die geldig zijn op de opgegeven datum `JJJJ-MM-DD` Deze parameters komen uit de API strategie, het hoofdstuk tijdreizen. 
+  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. 
+  page: 56, # Integer | Pagina nummer
+  page_size: 56, # Integer | Aantal resultaten per pagina
+  accept_crs: 'epsg:28992' # String | Gewenste CRS van de coördinaten in de response.
+}
+
+begin
+  # bevragen van alle aan een pand gerelateerde verblijfsobjecten (met paginering).
+  result = api_instance.zoek_verblijfsobjecten(pand_identificatie, opts)
+  p result
+rescue BagKadasterClient::ApiError => e
+  puts "Error when calling VerblijfsobjectApi->zoek_verblijfsobjecten: #{e}"
+end
+```
+
+#### Using the zoek_verblijfsobjecten_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<VerblijfsobjectIOHalCollection>, Integer, Hash)> zoek_verblijfsobjecten_with_http_info(pand_identificatie, opts)
+
+```ruby
+begin
+  # bevragen van alle aan een pand gerelateerde verblijfsobjecten (met paginering).
+  data, status_code, headers = api_instance.zoek_verblijfsobjecten_with_http_info(pand_identificatie, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <VerblijfsobjectIOHalCollection>
+rescue BagKadasterClient::ApiError => e
+  puts "Error when calling VerblijfsobjectApi->zoek_verblijfsobjecten_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **pand_identificatie** | **String** | Identificatie van een object uit de BAG. Deze is 4 lang bij een woonplaats en 16 lang bij de andere objecten. |  |
+| **huidig** | **Boolean** | Indicatie dat alleen actuele object voorkomens zonder eindstatus gewenst zijn. | [optional][default to false] |
+| **geldig_op** | **Date** | Filtert op objecten die geldig zijn op de opgegeven datum &#x60;JJJJ-MM-DD&#x60; Deze parameters komen uit de API strategie, het hoofdstuk tijdreizen.  | [optional] |
+| **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] |
+| **page** | **Integer** | Pagina nummer | [optional][default to 1] |
+| **page_size** | **Integer** | Aantal resultaten per pagina | [optional][default to 20] |
+| **accept_crs** | **String** | Gewenste CRS van de coördinaten in de response. | [optional] |
+
+### Return type
+
+[**VerblijfsobjectIOHalCollection**](VerblijfsobjectIOHalCollection.md)
+
+### Authorization
+
+[apiKeyBAG](../README.md#apiKeyBAG)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/hal+json, application/problem+json
+

data/docs/VerblijfsobjectEmbedded.md

@@ -0,0 +1,22 @@
+# BagKadasterClient::VerblijfsobjectEmbedded
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **heeft_als_hoofd_adres** | [**NummeraanduidingIOHal**](NummeraanduidingIOHal.md) |  | [optional] |
+| **heeft_als_neven_adres** | [**Array<NummeraanduidingIOHal>**](NummeraanduidingIOHal.md) |  | [optional] |
+| **maakt_deel_uit_van** | [**Array<PandIOHal>**](PandIOHal.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'bag_kadaster_client'
+
+instance = BagKadasterClient::VerblijfsobjectEmbedded.new(
+  heeft_als_hoofd_adres: null,
+  heeft_als_neven_adres: null,
+  maakt_deel_uit_van: null
+)
+```
+

data/docs/VerblijfsobjectIOHal.md

@@ -0,0 +1,24 @@
+# BagKadasterClient::VerblijfsobjectIOHal
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **verblijfsobject** | [**Verblijfsobject**](Verblijfsobject.md) |  |  |
+| **inonderzoek** | [**Array<KenmerkVerblijfsobjectInOnderzoek>**](KenmerkVerblijfsobjectInOnderzoek.md) |  | [optional] |
+| **_embedded** | [**VerblijfsobjectEmbedded**](VerblijfsobjectEmbedded.md) |  | [optional] |
+| **_links** | [**VerblijfsobjectLinks**](VerblijfsobjectLinks.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'bag_kadaster_client'
+
+instance = BagKadasterClient::VerblijfsobjectIOHal.new(
+  verblijfsobject: null,
+  inonderzoek: null,
+  _embedded: null,
+  _links: null
+)
+```
+

data/docs/VerblijfsobjectIOHalCollection.md

@@ -0,0 +1,20 @@
+# BagKadasterClient::VerblijfsobjectIOHalCollection
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **_embedded** | [**VerblijfsobjectIOHalCollectionEmbedded**](VerblijfsobjectIOHalCollectionEmbedded.md) |  | [optional] |
+| **_links** | [**HalPaginationLinks**](HalPaginationLinks.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'bag_kadaster_client'
+
+instance = BagKadasterClient::VerblijfsobjectIOHalCollection.new(
+  _embedded: null,
+  _links: null
+)
+```
+

data/docs/VerblijfsobjectIOHalCollectionEmbedded.md

@@ -0,0 +1,18 @@
+# BagKadasterClient::VerblijfsobjectIOHalCollectionEmbedded
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **verblijfsobjecten** | [**Array<VerblijfsobjectIOHal>**](VerblijfsobjectIOHal.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'bag_kadaster_client'
+
+instance = BagKadasterClient::VerblijfsobjectIOHalCollectionEmbedded.new(
+  verblijfsobjecten: null
+)
+```
+

data/docs/VerblijfsobjectIOLvcHalCollection.md

@@ -0,0 +1,20 @@
+# BagKadasterClient::VerblijfsobjectIOLvcHalCollection
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **_embedded** | [**VerblijfsobjectIOLvcHalCollectionEmbedded**](VerblijfsobjectIOLvcHalCollectionEmbedded.md) |  | [optional] |
+| **_links** | [**HalCollectionLinks**](HalCollectionLinks.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'bag_kadaster_client'
+
+instance = BagKadasterClient::VerblijfsobjectIOLvcHalCollection.new(
+  _embedded: null,
+  _links: null
+)
+```
+

data/docs/VerblijfsobjectIOLvcHalCollectionEmbedded.md

@@ -0,0 +1,18 @@
+# BagKadasterClient::VerblijfsobjectIOLvcHalCollectionEmbedded
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **voorkomens** | [**Array<VerblijfsobjectIOHal>**](VerblijfsobjectIOHal.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'bag_kadaster_client'
+
+instance = BagKadasterClient::VerblijfsobjectIOLvcHalCollectionEmbedded.new(
+  voorkomens: null
+)
+```
+

data/docs/VerblijfsobjectLinks.md

@@ -0,0 +1,24 @@
+# BagKadasterClient::VerblijfsobjectLinks
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **_self** | [**HalLink**](HalLink.md) |  |  |
+| **heeft_als_hoofd_adres** | [**HalLink**](HalLink.md) |  |  |
+| **heeft_als_neven_adres** | [**Array<HalLink>**](HalLink.md) | De nummeraanduidingen die dit adresseerbare object als nevenadressen heeft. Van deze gerelateerd nummeraanduiding: hiervan het voorkomen van nummeraanduiding die gevonden wordt op basis van dezelfde tijdreisparameters als waarmee het adresseerbare object voorkomen gevonden is. | [optional] |
+| **maakt_deel_uit_van** | [**Array<HalLink>**](HalLink.md) | De panden (1 of meer) waarvan dit verblijfsobject deel uit maakt. Van deze panden: hiervan het voorkomen van pand die gevonden worden op basis van dezelfde tijdreisparameters als waarmee het verblijfsobject voorkomen gevonden is. |  |
+
+## Example
+
+```ruby
+require 'bag_kadaster_client'
+
+instance = BagKadasterClient::VerblijfsobjectLinks.new(
+  _self: null,
+  heeft_als_hoofd_adres: null,
+  heeft_als_neven_adres: null,
+  maakt_deel_uit_van: null
+)
+```
+

data/docs/VlakOfMultivlak.md

@@ -0,0 +1,20 @@
+# BagKadasterClient::VlakOfMultivlak
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **vlak** | [**Surface**](Surface.md) |  | [optional] |
+| **multivlak** | [**MultiSurface**](MultiSurface.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'bag_kadaster_client'
+
+instance = BagKadasterClient::VlakOfMultivlak.new(
+  vlak: null,
+  multivlak: null
+)
+```
+

data/docs/Voorkomen.md

@@ -0,0 +1,36 @@
+# BagKadasterClient::Voorkomen
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **tijdstip_registratie** | **Time** | Het tijdstip waarop een versie van een BAG-object is geregistreerd in de registratie van een bronhouder en daarmee authentiek wordt gemaakt. |  |
+| **versie** | **Integer** | De identificatie van een voorkomen van een object. |  |
+| **eind_registratie** | **Time** | Het tijdstip waarop een versie van een BAG-object is beëindigd in de registratie van een bronhouder. | [optional] |
+| **begin_geldigheid** | **Date** | De datum waarop een versie van een BAG-object geldig is in de werkelijkheid conform de ingangsdatum in het brondocument. Dit tijdstip wordt vastgelegd in de beginGeldigheid. Als er geen expliciete ingangsdatum van geldigheid is opgenomen, wordt de datum van het brondocument overgenomen. |  |
+| **eind_geldigheid** | **Date** | De datum waarop de periode van geldigheid van een versie van een BAG-object eindigt. Bijvoorbeeld als gevolg van de vaststelling van een nieuw brondocument. Wanneer er geen tijdstip is ingevuld, dan is de versie nog geldig. | [optional] |
+| **tijdstip_inactief** | **Time** | Het tijdstip waarop een op dat moment toekomstig voorkomen door een bronhouder uit de geldige levenscylcus in de LV BAG is verwijderd. | [optional] |
+| **tijdstip_registratie_lv** | **Time** | Dit is het tijdstip waarop een versie van een BAG-object is opgenomen in de registratie van de landelijke voorziening. De gegevens komen daarmee beschikbaar voor afnemers. |  |
+| **tijdstip_niet_bag** | **Time** | Het tijdstip waarop een voorkomen door een synchronisatie bericht van een bronhouder is verwijderd uit de geldige levenscylcus in de registratie van de landelijke voorziening. | [optional] |
+| **tijdstip_eind_registratie_lv** | **Time** | Dit is het tijdstip waarop een versie van een BAG-object is beëindigd in de registratie van de landelijke voorziening. | [optional] |
+| **tijdstip_inactief_lv** | **Time** | Dit is het tijdstip waarop een toekomstig voorkomen van een BAG-object uit de geldige levenscylcus is verwijderd in de registratie van de landelijke voorziening. | [optional] |
+
+## Example
+
+```ruby
+require 'bag_kadaster_client'
+
+instance = BagKadasterClient::Voorkomen.new(
+  tijdstip_registratie: null,
+  versie: 3,
+  eind_registratie: null,
+  begin_geldigheid: Sat Jun 01 00:00:00 UTC 2019,
+  eind_geldigheid: Sat Jun 01 00:00:00 UTC 2019,
+  tijdstip_inactief: null,
+  tijdstip_registratie_lv: null,
+  tijdstip_niet_bag: null,
+  tijdstip_eind_registratie_lv: null,
+  tijdstip_inactief_lv: null
+)
+```
+

data/docs/Woonplaats.md

@@ -0,0 +1,32 @@
+# BagKadasterClient::Woonplaats
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **identificatie** | **String** | De identificatie wordt gebruikt in de operation, bv. /woonplaatsen/3560. Waarde: 0001-9999, formaat: ^[0-9]{3}[1-9]\\|[0-9]{2}[1-9][0-9]\\|[0-9][1-9][0-9]{2}\\|[1-9][0-9]{3}$. |  |
+| **domein** | **String** | NL.IMBAG.Woonplaats |  |
+| **naam** | **String** | De benaming van een door het gemeentebestuur aangewezen woonplaats. |  |
+| **status** | [**StatusWoonplaats**](StatusWoonplaats.md) |  |  |
+| **geconstateerd** | [**Indicatie**](Indicatie.md) |  |  |
+| **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. |  |
+| **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. |  |
+| **voorkomen** | [**Voorkomen**](Voorkomen.md) |  |  |
+
+## Example
+
+```ruby
+require 'bag_kadaster_client'
+
+instance = BagKadasterClient::Woonplaats.new(
+  identificatie: 2096,
+  domein: NL.IMBAG.Woonplaats,
+  naam: Duiven,
+  status: null,
+  geconstateerd: null,
+  documentdatum: Mon Feb 09 00:00:00 UTC 2009,
+  documentnummer: 09.0898,
+  voorkomen: null
+)
+```
+