bag_kadaster_client 1.0.0

data/docs/LigplaatsApi.md

@@ -0,0 +1,333 @@
+# BagKadasterClient::LigplaatsApi
+
+All URIs are relative to *https://api.bag.acceptatie.kadaster.nl/lvbag/individuelebevragingen/v2*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**ligplaats_geometrie**](LigplaatsApi.md#ligplaats_geometrie) | **POST** /ligplaatsen | bevragen van een ligplaats, op basis van een geometrische locatie. |
+| [**ligplaats_identificatie**](LigplaatsApi.md#ligplaats_identificatie) | **GET** /ligplaatsen/{identificatie} | bevragen 1 ligplaats met de identificatie van een ligplaats. |
+| [**ligplaats_identificatie_voorkomen**](LigplaatsApi.md#ligplaats_identificatie_voorkomen) | **GET** /ligplaatsen/{identificatie}/{versie}/{timestampRegistratieLv} | bevragen voorkomen van een ligplaats met de identificatie van een ligplaats en de identificatie van een voorkomen, bestaande uit een versie en een timestamp van het tijdstip van registratie in de LV BAG. |
+| [**ligplaats_lvc_identificatie**](LigplaatsApi.md#ligplaats_lvc_identificatie) | **GET** /ligplaatsen/{identificatie}/lvc | bevragen levenscyclus van een ligplaats met de identificatie van een ligplaats. |
+
+
+## ligplaats_geometrie
+
+> <LigplaatsIOHalCollection> ligplaats_geometrie(point, opts)
+
+bevragen van een ligplaats, op basis van een geometrische locatie.
+
+Bevragen/raadplegen van één of meer ligplaatsen met een geometrische locatie. Parameter huidig kan worden toegepast. Als geldigOp en/of beschikbaarOp niet wordt opgegeven, worden de actuele gegevens geleverd. Als expand=heeftAlsHoofdAdres, heeftAlsNevenAdres of true dan worden de gevraagde of alle 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::LigplaatsApi.new
+point = BagKadasterClient::Point.new({type: 'Point', coordinates: [3.56]}) # Point | Geometrisch punt waarop de ligplaatsen bepaald moeten worden.
+opts = {
+  geldig_op: Date.parse('2019-04-01'), # 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. 
+  huidig: false, # Boolean | Indicatie dat alleen actuele object voorkomens zonder eindstatus gewenst zijn.
+  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.
+  content_crs: 'epsg:28992', # String | CRS van de meegegeven geometrie.
+  accept_crs: 'epsg:28992' # String | Gewenste CRS van de coördinaten in de response.
+}
+
+begin
+  # bevragen van een ligplaats, op basis van een geometrische locatie.
+  result = api_instance.ligplaats_geometrie(point, opts)
+  p result
+rescue BagKadasterClient::ApiError => e
+  puts "Error when calling LigplaatsApi->ligplaats_geometrie: #{e}"
+end
+```
+
+#### Using the ligplaats_geometrie_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<LigplaatsIOHalCollection>, Integer, Hash)> ligplaats_geometrie_with_http_info(point, opts)
+
+```ruby
+begin
+  # bevragen van een ligplaats, op basis van een geometrische locatie.
+  data, status_code, headers = api_instance.ligplaats_geometrie_with_http_info(point, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <LigplaatsIOHalCollection>
+rescue BagKadasterClient::ApiError => e
+  puts "Error when calling LigplaatsApi->ligplaats_geometrie_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **point** | [**Point**](Point.md) | Geometrisch punt waarop de ligplaatsen bepaald moeten worden. |  |
+| **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] |
+| **huidig** | **Boolean** | Indicatie dat alleen actuele object voorkomens zonder eindstatus gewenst zijn. | [optional][default to false] |
+| **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] |
+| **content_crs** | **String** | CRS van de meegegeven geometrie. | [optional] |
+| **accept_crs** | **String** | Gewenste CRS van de coördinaten in de response. | [optional] |
+
+### Return type
+
+[**LigplaatsIOHalCollection**](LigplaatsIOHalCollection.md)
+
+### Authorization
+
+[apiKeyBAG](../README.md#apiKeyBAG)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/hal+json, application/problem+json
+
+
+## ligplaats_identificatie
+
+> <LigplaatsIOHal> ligplaats_identificatie(identificatie, opts)
+
+bevragen 1 ligplaats met de identificatie van een ligplaats.
+
+Bevragen/raadplegen van een voorkomen van een ligplaats met de identificatie van de ligplaats. Als geldigOp en/of beschikbaarOp niet wordt opgegeven, worden de actuele gegevens geleverd. Als expand=heeftAlsHoofdAdres, heeftAlsNevenAdres of true dan worden de gevraagde of alle 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::LigplaatsApi.new
+identificatie = '0797020000056894' # 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-04-01'), # 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 ligplaats met de identificatie van een ligplaats.
+  result = api_instance.ligplaats_identificatie(identificatie, opts)
+  p result
+rescue BagKadasterClient::ApiError => e
+  puts "Error when calling LigplaatsApi->ligplaats_identificatie: #{e}"
+end
+```
+
+#### Using the ligplaats_identificatie_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<LigplaatsIOHal>, Integer, Hash)> ligplaats_identificatie_with_http_info(identificatie, opts)
+
+```ruby
+begin
+  # bevragen 1 ligplaats met de identificatie van een ligplaats.
+  data, status_code, headers = api_instance.ligplaats_identificatie_with_http_info(identificatie, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <LigplaatsIOHal>
+rescue BagKadasterClient::ApiError => e
+  puts "Error when calling LigplaatsApi->ligplaats_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
+
+[**LigplaatsIOHal**](LigplaatsIOHal.md)
+
+### Authorization
+
+[apiKeyBAG](../README.md#apiKeyBAG)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/hal+json, application/problem+json
+
+
+## ligplaats_identificatie_voorkomen
+
+> <LigplaatsIOHal> ligplaats_identificatie_voorkomen(identificatie, versie, timestamp_registratie_lv, opts)
+
+bevragen voorkomen van een ligplaats met de identificatie van een ligplaats en de identificatie van een voorkomen, bestaande uit een versie en een timestamp van het tijdstip van registratie in de LV BAG.
+
+Bevragen/raadplegen van een voorkomen van een ligplaats met de identificatie van een ligplaats 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::LigplaatsApi.new
+identificatie = '0797020000056894' # 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 ligplaats met de identificatie van een ligplaats en de identificatie van een voorkomen, bestaande uit een versie en een timestamp van het tijdstip van registratie in de LV BAG.
+  result = api_instance.ligplaats_identificatie_voorkomen(identificatie, versie, timestamp_registratie_lv, opts)
+  p result
+rescue BagKadasterClient::ApiError => e
+  puts "Error when calling LigplaatsApi->ligplaats_identificatie_voorkomen: #{e}"
+end
+```
+
+#### Using the ligplaats_identificatie_voorkomen_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<LigplaatsIOHal>, Integer, Hash)> ligplaats_identificatie_voorkomen_with_http_info(identificatie, versie, timestamp_registratie_lv, opts)
+
+```ruby
+begin
+  # bevragen voorkomen van een ligplaats met de identificatie van een ligplaats en de identificatie van een voorkomen, bestaande uit een versie en een timestamp van het tijdstip van registratie in de LV BAG.
+  data, status_code, headers = api_instance.ligplaats_identificatie_voorkomen_with_http_info(identificatie, versie, timestamp_registratie_lv, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <LigplaatsIOHal>
+rescue BagKadasterClient::ApiError => e
+  puts "Error when calling LigplaatsApi->ligplaats_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
+
+[**LigplaatsIOHal**](LigplaatsIOHal.md)
+
+### Authorization
+
+[apiKeyBAG](../README.md#apiKeyBAG)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/hal+json, application/problem+json
+
+
+## ligplaats_lvc_identificatie
+
+> <LigplaatsIOLvcHalCollection> ligplaats_lvc_identificatie(identificatie, opts)
+
+bevragen levenscyclus van een ligplaats met de identificatie van een ligplaats.
+
+Bevragen/raadplegen van de levenscyclus van een ligplaats, via de identificatie van de ligplaats.
+
+### 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::LigplaatsApi.new
+identificatie = '0797020000056894' # 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 ligplaats met de identificatie van een ligplaats.
+  result = api_instance.ligplaats_lvc_identificatie(identificatie, opts)
+  p result
+rescue BagKadasterClient::ApiError => e
+  puts "Error when calling LigplaatsApi->ligplaats_lvc_identificatie: #{e}"
+end
+```
+
+#### Using the ligplaats_lvc_identificatie_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<LigplaatsIOLvcHalCollection>, Integer, Hash)> ligplaats_lvc_identificatie_with_http_info(identificatie, opts)
+
+```ruby
+begin
+  # bevragen levenscyclus van een ligplaats met de identificatie van een ligplaats.
+  data, status_code, headers = api_instance.ligplaats_lvc_identificatie_with_http_info(identificatie, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <LigplaatsIOLvcHalCollection>
+rescue BagKadasterClient::ApiError => e
+  puts "Error when calling LigplaatsApi->ligplaats_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
+
+[**LigplaatsIOLvcHalCollection**](LigplaatsIOLvcHalCollection.md)
+
+### Authorization
+
+[apiKeyBAG](../README.md#apiKeyBAG)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/hal+json, application/problem+json
+

data/docs/LigplaatsEmbedded.md

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

data/docs/LigplaatsIOHal.md

@@ -0,0 +1,24 @@
+# BagKadasterClient::LigplaatsIOHal
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **ligplaats** | [**Ligplaats**](Ligplaats.md) |  |  |
+| **inonderzoek** | [**Array<KenmerkLigplaatsInOnderzoek>**](KenmerkLigplaatsInOnderzoek.md) |  | [optional] |
+| **_embedded** | [**LigplaatsEmbedded**](LigplaatsEmbedded.md) |  | [optional] |
+| **_links** | [**LigplaatsLinks**](LigplaatsLinks.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'bag_kadaster_client'
+
+instance = BagKadasterClient::LigplaatsIOHal.new(
+  ligplaats: null,
+  inonderzoek: null,
+  _embedded: null,
+  _links: null
+)
+```
+

data/docs/LigplaatsIOHalCollection.md

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

data/docs/LigplaatsIOHalCollectionEmbedded.md

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

data/docs/LigplaatsIOLvcHalCollection.md

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

data/docs/LigplaatsIOLvcHalCollectionEmbedded.md

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

data/docs/LigplaatsLinks.md

@@ -0,0 +1,22 @@
+# BagKadasterClient::LigplaatsLinks
+
+## 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] |
+
+## Example
+
+```ruby
+require 'bag_kadaster_client'
+
+instance = BagKadasterClient::LigplaatsLinks.new(
+  _self: null,
+  heeft_als_hoofd_adres: null,
+  heeft_als_neven_adres: null
+)
+```
+

data/docs/MultiPolygon.md

@@ -0,0 +1,20 @@
+# BagKadasterClient::MultiPolygon
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **type** | **String** |  |  |
+| **coordinates** | **Array<Array<Array<Array<Float>>>>** |  |  |
+
+## Example
+
+```ruby
+require 'bag_kadaster_client'
+
+instance = BagKadasterClient::MultiPolygon.new(
+  type: null,
+  coordinates: null
+)
+```
+

data/docs/MultiSurface.md

@@ -0,0 +1,20 @@
+# BagKadasterClient::MultiSurface
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **type** | **String** |  |  |
+| **coordinates** | **Array<Array<Array<Array<Float>>>>** |  |  |
+
+## Example
+
+```ruby
+require 'bag_kadaster_client'
+
+instance = BagKadasterClient::MultiSurface.new(
+  type: null,
+  coordinates: null
+)
+```
+

data/docs/Nummeraanduiding.md

@@ -0,0 +1,44 @@
+# BagKadasterClient::Nummeraanduiding
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **identificatie** | **String** | Deze wordt gebruikt in de operation. |  |
+| **domein** | **String** | NL.IMBAG.Nummeraanduiding |  |
+| **huisnummer** | **Integer** | Een door of namens het gemeentebestuur ten aanzien van een adresseerbaar object toegekende nummering. |  |
+| **huisletter** | **String** | Een door of namens het gemeentebestuur ten aanzien van een adresseerbaar object toegekende toevoeging aan een huisnummer in de vorm van een alfanumeriek teken. | [optional] |
+| **huisnummertoevoeging** | **String** | Een door of namens het gemeentebestuur ten aanzien van een adresseerbaar object toegekende nadere toevoeging aan een huisnummer of een combinatie van huisnummer en huisletter. | [optional] |
+| **postcode** | **String** | De door PostNL vastgestelde code behorende bij een bepaalde combinatie van een straatnaam en een huisnummer. | [optional] |
+| **type_adresseerbaar_object** | [**TypeAdresseerbaarObject**](TypeAdresseerbaarObject.md) |  |  |
+| **status** | [**StatusNaamgeving**](StatusNaamgeving.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) |  |  |
+| **ligt_in** | **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}$. | [optional] |
+| **ligt_aan** | **String** | Deze wordt gebruikt in de operation. |  |
+
+## Example
+
+```ruby
+require 'bag_kadaster_client'
+
+instance = BagKadasterClient::Nummeraanduiding.new(
+  identificatie: 0226200000038923,
+  domein: NL.IMBAG.Nummeraanduiding,
+  huisnummer: 1,
+  huisletter: A,
+  huisnummertoevoeging: bis,
+  postcode: 6922KZ,
+  type_adresseerbaar_object: null,
+  status: null,
+  geconstateerd: null,
+  documentdatum: Mon Nov 25 00:00:00 UTC 2019,
+  documentnummer: Duiven 25112019,
+  voorkomen: null,
+  ligt_in: 2096,
+  ligt_aan: 0226300000136124
+)
+```
+