Metadata-Version: 2.4
Name: calcasa.api
Version: 1.7.0
Summary: Calcasa Public API
Home-page: https://github.com/calcasa/api-python
Author: Calcasa B.V.
Author-email: "Calcasa B.V." <info@calcasa.nl>
License: Apache License 2.0
Project-URL: Repository, https://github.com/GIT_USER_ID/GIT_REPO_ID
Keywords: OpenAPI,OpenAPI-Generator,Calcasa Public API
Requires-Python: >=3.6
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: urllib3<3.0.0,>=2.1.0
Requires-Dist: python-dateutil>=2.8.2
Requires-Dist: pydantic>=2.11
Requires-Dist: typing-extensions>=4.7.1
Dynamic: author
Dynamic: home-page
Dynamic: license-file
Dynamic: requires-python

# calcasa.api
The Calcasa API is used to connect to Calcasa provided services.
For more information, please visit [Documentation](https://docs.calcasa.nl) or [GitHub](https://github.com/calcasa/api).

This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:

- API version: 1.7.0
- Package version: 1.7.0
- Generator version: 7.23.0
- Build package: org.openapitools.codegen.languages.PythonClientCodegen
For more information, please visit [https://www.calcasa.nl/contact](https://www.calcasa.nl/contact)

## Requirements.

Python 3.10+

## Installation & Usage
### pip install

If the python package is hosted on a repository, you can install directly using:

```sh
pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git
```
(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git`)

Then import the package:
```python
import calcasa.api
```

### Setuptools

Install via [Setuptools](http://pypi.python.org/pypi/setuptools).

```sh
python setup.py install --user
```
(or `sudo python setup.py install` to install the package for all users)

Then import the package:
```python
import calcasa.api
```

### Tests

Execute `pytest` to run the tests.

## Getting Started

Please follow the [installation procedure](#installation--usage) and then run the following:

```python

import calcasa.api
from calcasa.api.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.calcasa.nl/api/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = calcasa.api.Configuration(
    host = "https://api.calcasa.nl/api/v1"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

configuration.access_token = os.environ["ACCESS_TOKEN"]


# Enter a context with an instance of the API client
with calcasa.api.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = calcasa.api.AdressenApi(api_client)
    bag_nummeraanduiding_id = 56 # int | Een BAG Nummeraanduiding ID om een adres te specificeren.

    try:
        # Haal adresinformatie op.
        api_response = api_instance.get_adres(bag_nummeraanduiding_id)
        print("The response of AdressenApi->get_adres:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling AdressenApi->get_adres: %s\n" % e)

```

## Documentation for API Endpoints

All URIs are relative to *https://api.calcasa.nl/api/v1*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*AdressenApi* | [**get_adres**](docs/AdressenApi.md#get_adres) | **GET** /adressen/{bagNummeraanduidingId} | Haal adresinformatie op.
*AdressenApi* | [**search_adres**](docs/AdressenApi.md#search_adres) | **POST** /adressen/zoeken | Zoek adresinformatie.
*BestemmingsplannenApi* | [**get_bestemming_by_id**](docs/BestemmingsplannenApi.md#get_bestemming_by_id) | **GET** /bestemmingsplannen/{bagNummeraanduidingId} | Haal bestemmingsplannen op.
*BodemApi* | [**get_bodem_by_id**](docs/BodemApi.md#get_bodem_by_id) | **GET** /bodem/{bagNummeraanduidingId} | Haal bodemkwaliteitsgegevens op.
*BuurtApi* | [**get_buurt**](docs/BuurtApi.md#get_buurt) | **GET** /buurt/{buurtCode} | Haal buurtgegevens op.
*CallbacksApi* | [**add_or_update_callback_subscription**](docs/CallbacksApi.md#add_or_update_callback_subscription) | **POST** /callbacks/inschrijvingen | Maak of werk een callbackinschrijving bij.
*CallbacksApi* | [**delete_notification_subscription**](docs/CallbacksApi.md#delete_notification_subscription) | **DELETE** /callbacks/inschrijvingen/{bagNummeraanduidingId} | Verwijder een callbackinschrijving.
*CallbacksApi* | [**get_notification_subscription**](docs/CallbacksApi.md#get_notification_subscription) | **GET** /callbacks/inschrijvingen/{bagNummeraanduidingId} | Haal een callbackinschrijving op.
*CallbacksApi* | [**get_notification_subscriptions**](docs/CallbacksApi.md#get_notification_subscriptions) | **GET** /callbacks/inschrijvingen | Haal callbackinschrijvingen op.
*ConfiguratieApi* | [**get_callback_authentication**](docs/ConfiguratieApi.md#get_callback_authentication) | **GET** /configuratie/callbacks/authentication | Haal callbackauthenticatie op.
*ConfiguratieApi* | [**get_callbacks**](docs/ConfiguratieApi.md#get_callbacks) | **GET** /configuratie/callbacks | Haal callback-URL&#39;s op.
*ConfiguratieApi* | [**get_mtls_certificate**](docs/ConfiguratieApi.md#get_mtls_certificate) | **GET** /configuratie/callbacks/mtls-certificate | Haal het mTLS-certificaat op.
*ConfiguratieApi* | [**get_signature_keys**](docs/ConfiguratieApi.md#get_signature_keys) | **GET** /configuratie/callbacks/signature-keys | Haal JWKS-sleutels op.
*ConfiguratieApi* | [**post_callback_authentication**](docs/ConfiguratieApi.md#post_callback_authentication) | **POST** /configuratie/callbacks/authentication | Werk callbackauthenticatie bij.
*ConfiguratieApi* | [**update_callbacks**](docs/ConfiguratieApi.md#update_callbacks) | **POST** /configuratie/callbacks | Configureer een callback-URL.
*FacturenApi* | [**get_factuur**](docs/FacturenApi.md#get_factuur) | **GET** /facturen/{id} | Haal een factuur op.
*FileSetsApi* | [**confirm_inbound_file_set_by_id**](docs/FileSetsApi.md#confirm_inbound_file_set_by_id) | **POST** /file-sets/inbound/{inboundFileSetId} | Confirm an inbound file set.
*FileSetsApi* | [**create_inbound_file_set**](docs/FileSetsApi.md#create_inbound_file_set) | **POST** /file-sets/inbound | Create an inbound file set.
*FileSetsApi* | [**delete_outbound_file_set_by_id**](docs/FileSetsApi.md#delete_outbound_file_set_by_id) | **DELETE** /file-sets/outbound/{outboundFileSetId} | Delete an outbound file set.
*FileSetsApi* | [**get_file_set_limits**](docs/FileSetsApi.md#get_file_set_limits) | **GET** /file-sets/limits | Get file set limits.
*FileSetsApi* | [**get_inbound_file_set_by_id**](docs/FileSetsApi.md#get_inbound_file_set_by_id) | **GET** /file-sets/inbound/{inboundFileSetId} | Get an inbound file set.
*FileSetsApi* | [**get_inbound_file_sets**](docs/FileSetsApi.md#get_inbound_file_sets) | **GET** /file-sets/inbound | List inbound file sets.
*FileSetsApi* | [**get_outbound_file_by_index**](docs/FileSetsApi.md#get_outbound_file_by_index) | **GET** /file-sets/outbound/{outboundFileSetId}/{fileIndex} | Download outbound file content.
*FileSetsApi* | [**get_outbound_file_set_by_id**](docs/FileSetsApi.md#get_outbound_file_set_by_id) | **GET** /file-sets/outbound/{outboundFileSetId} | Get an outbound file set.
*FileSetsApi* | [**get_outbound_file_sets**](docs/FileSetsApi.md#get_outbound_file_sets) | **GET** /file-sets/outbound | List outbound file sets.
*FileSetsApi* | [**put_file_chunk**](docs/FileSetsApi.md#put_file_chunk) | **PUT** /file-sets/inbound/{inboundFileSetId}/{fileIndex}/{chunkIndex} | Upload an inbound file chunk.
*FotosApi* | [**get_foto**](docs/FotosApi.md#get_foto) | **GET** /fotos/{id} | Haal een foto op.
*FunderingenApi* | [**get_fundering_by_id**](docs/FunderingenApi.md#get_fundering_by_id) | **GET** /funderingen/{bagNummeraanduidingId} | Haal funderingsgegevens op.
*GeldverstrekkersApi* | [**get_geldverstrekkers**](docs/GeldverstrekkersApi.md#get_geldverstrekkers) | **GET** /geldverstrekkers/{productType} | Haal geldverstrekkers op.
*PlanningApi* | [**assign_opnemer**](docs/PlanningApi.md#assign_opnemer) | **POST** /planning/opnames/{opnameId} | Assign an opnemer.
*PlanningApi* | [**delete_planning_for_opname**](docs/PlanningApi.md#delete_planning_for_opname) | **DELETE** /planning/opnames/{opnameId} | Delete an opname planning.
*PlanningApi* | [**get_opnames**](docs/PlanningApi.md#get_opnames) | **GET** /planning/opnames | List opnames.
*PlanningApi* | [**get_opnemers**](docs/PlanningApi.md#get_opnemers) | **GET** /planning/opnemers | List opnemers.
*RapportenApi* | [**get_rapport**](docs/RapportenApi.md#get_rapport) | **GET** /rapporten/{id} | Haal een rapport op.
*WaarderingenApi* | [**check_producten**](docs/WaarderingenApi.md#check_producten) | **POST** /waarderingen/check | Controleer mogelijke producten.
*WaarderingenApi* | [**create_waardering**](docs/WaarderingenApi.md#create_waardering) | **POST** /waarderingen | Maak een waardering.
*WaarderingenApi* | [**get_waardering**](docs/WaarderingenApi.md#get_waardering) | **GET** /waarderingen/{id} | Haal een waardering op.
*WaarderingenApi* | [**get_waardering_by_report_hash**](docs/WaarderingenApi.md#get_waardering_by_report_hash) | **GET** /waarderingen/by-hash/{hash} | Zoek op rapport-hash.
*WaarderingenApi* | [**get_waardering_ontwikkeling**](docs/WaarderingenApi.md#get_waardering_ontwikkeling) | **GET** /waarderingen/{id}/ontwikkeling | Haal waarderingsontwikkeling op.
*WaarderingenApi* | [**patch_waarderingen**](docs/WaarderingenApi.md#patch_waarderingen) | **PATCH** /waarderingen/{id} | Werk een waardering bij.
*WaarderingenApi* | [**search_waarderingen**](docs/WaarderingenApi.md#search_waarderingen) | **POST** /waarderingen/zoeken | Zoek waarderingen.


## Documentation For Models

 - [Aanvraagdoel](docs/Aanvraagdoel.md)
 - [Adres](docs/Adres.md)
 - [AdresInfo](docs/AdresInfo.md)
 - [Bestemmingsdata](docs/Bestemmingsdata.md)
 - [BodemStatusType](docs/BodemStatusType.md)
 - [Bodemdata](docs/Bodemdata.md)
 - [BusinessRulesCode](docs/BusinessRulesCode.md)
 - [BusinessRulesProblemDetails](docs/BusinessRulesProblemDetails.md)
 - [Callback](docs/Callback.md)
 - [CallbackAuthentication](docs/CallbackAuthentication.md)
 - [CallbackInschrijving](docs/CallbackInschrijving.md)
 - [CbsIndeling](docs/CbsIndeling.md)
 - [CompressionType](docs/CompressionType.md)
 - [ContentTooLargeProblemDetails](docs/ContentTooLargeProblemDetails.md)
 - [CreateInboundFileSetRequest](docs/CreateInboundFileSetRequest.md)
 - [DeelWaarderingWebhookPayload](docs/DeelWaarderingWebhookPayload.md)
 - [Energielabel](docs/Energielabel.md)
 - [EnergielabelData](docs/EnergielabelData.md)
 - [ExpiredValuationProblemDetails](docs/ExpiredValuationProblemDetails.md)
 - [Factuur](docs/Factuur.md)
 - [FileContentError](docs/FileContentError.md)
 - [FileInfo](docs/FileInfo.md)
 - [FileNotice](docs/FileNotice.md)
 - [FileSet](docs/FileSet.md)
 - [FileSetLimits](docs/FileSetLimits.md)
 - [Foto](docs/Foto.md)
 - [FrontendDeeplinks](docs/FrontendDeeplinks.md)
 - [FunderingDataBron](docs/FunderingDataBron.md)
 - [FunderingHerstelType](docs/FunderingHerstelType.md)
 - [FunderingRisico](docs/FunderingRisico.md)
 - [FunderingRisicoLabel](docs/FunderingRisicoLabel.md)
 - [FunderingSoortBron](docs/FunderingSoortBron.md)
 - [FunderingTechnischHerstelType](docs/FunderingTechnischHerstelType.md)
 - [FunderingType](docs/FunderingType.md)
 - [FunderingTypering](docs/FunderingTypering.md)
 - [Funderingdata](docs/Funderingdata.md)
 - [Funderingsrisico](docs/Funderingsrisico.md)
 - [Gebiedsdata](docs/Gebiedsdata.md)
 - [Geldverstrekker](docs/Geldverstrekker.md)
 - [InboundFileInfo](docs/InboundFileInfo.md)
 - [InboundFileSet](docs/InboundFileSet.md)
 - [InboundFileSetAlreadyExistsProblemDetails](docs/InboundFileSetAlreadyExistsProblemDetails.md)
 - [InboundFileSetInvalidStateProblemDetails](docs/InboundFileSetInvalidStateProblemDetails.md)
 - [InboundFileSetState](docs/InboundFileSetState.md)
 - [InboundFileSetWebhookPayload](docs/InboundFileSetWebhookPayload.md)
 - [InvalidArgumentProblemDetails](docs/InvalidArgumentProblemDetails.md)
 - [KlantwaardeType](docs/KlantwaardeType.md)
 - [Kwartaal](docs/Kwartaal.md)
 - [LengthRequiredProblemDetails](docs/LengthRequiredProblemDetails.md)
 - [MTLSType](docs/MTLSType.md)
 - [Modeldata](docs/Modeldata.md)
 - [NotFoundProblemDetails](docs/NotFoundProblemDetails.md)
 - [Notitie](docs/Notitie.md)
 - [Notities](docs/Notities.md)
 - [Objectdata](docs/Objectdata.md)
 - [Omgevingsdata](docs/Omgevingsdata.md)
 - [OnderhoudStaat](docs/OnderhoudStaat.md)
 - [Operation](docs/Operation.md)
 - [OperationType](docs/OperationType.md)
 - [Opname](docs/Opname.md)
 - [Opnamedata](docs/Opnamedata.md)
 - [Opnemer](docs/Opnemer.md)
 - [OutboundFileSet](docs/OutboundFileSet.md)
 - [OutboundFileSetInvalidStateProblemDetails](docs/OutboundFileSetInvalidStateProblemDetails.md)
 - [OutboundFileSetState](docs/OutboundFileSetState.md)
 - [OutboundFileSetWebhookPayload](docs/OutboundFileSetWebhookPayload.md)
 - [PermissionsDeniedProblemDetails](docs/PermissionsDeniedProblemDetails.md)
 - [PlanningInfo](docs/PlanningInfo.md)
 - [Point](docs/Point.md)
 - [ProblemDetails](docs/ProblemDetails.md)
 - [ProductCheck](docs/ProductCheck.md)
 - [ProductCheckItem](docs/ProductCheckItem.md)
 - [ProductCheckParameters](docs/ProductCheckParameters.md)
 - [ProductType](docs/ProductType.md)
 - [Rapport](docs/Rapport.md)
 - [Referentieobject](docs/Referentieobject.md)
 - [ResourceExhaustedProblemDetails](docs/ResourceExhaustedProblemDetails.md)
 - [Taxatiedata](docs/Taxatiedata.md)
 - [Taxatiestatus](docs/Taxatiestatus.md)
 - [UnauthorizedProblemDetails](docs/UnauthorizedProblemDetails.md)
 - [ValidationProblemDetails](docs/ValidationProblemDetails.md)
 - [VerkoopBijzonderheden](docs/VerkoopBijzonderheden.md)
 - [VersionNames](docs/VersionNames.md)
 - [VorigeVerkoop](docs/VorigeVerkoop.md)
 - [Waardering](docs/Waardering.md)
 - [WaarderingInputParameters](docs/WaarderingInputParameters.md)
 - [WaarderingOntwikkeling](docs/WaarderingOntwikkeling.md)
 - [WaarderingOntwikkelingKwartaal](docs/WaarderingOntwikkelingKwartaal.md)
 - [WaarderingStatus](docs/WaarderingStatus.md)
 - [WaarderingWebhookPayload](docs/WaarderingWebhookPayload.md)
 - [WaarderingZoekParameters](docs/WaarderingZoekParameters.md)
 - [WebhookPayload](docs/WebhookPayload.md)
 - [WoningType](docs/WoningType.md)


<a id="documentation-for-authorization"></a>
## Documentation For Authorization


Authentication schemes defined for the API:
<a id="oauth"></a>
### oauth

- **Type**: OAuth
- **Flow**: application
- **Authorization URL**: 
- **Scopes**: 
 - **api:adressen:read**: 
 - **api:bestemmingsplannen:read**: 
 - **api:bodem:read**: 
 - **api:buurt:read**: 
 - **api:callback:read**: 
 - **api:callback:write**: 
 - **api:configuratie:read**: 
 - **api:configuratie:write**: 
 - **api:facturen:read**: 
 - **api:file-set:inbound:read**: 
 - **api:file-set:inbound:write**: 
 - **api:file-set:outbound:read**: 
 - **api:file-set:outbound:write**: 
 - **api:fotos:read**: 
 - **api:funderingen:read**: 
 - **api:geldverstrekkers:read**: 
 - **api:rapporten:read**: 
 - **api:waarderingen:read**: 
 - **api:waarderingen:patch**: 
 - **api:waarderingen:ontwikkeling**: 
 - **api:waarderingen:create**: 
 - **api:planning:read**: 
 - **api:planning:write**: 


## Author

info@calcasa.nl


