Metadata-Version: 2.1
Name: calcasa-api
Version: 1.0.0
Summary: Calcasa Public API v1
Home-page: https://github.com/calcasa/api-python
Author: Calcasa B.V.
Author-email: info@calcasa.nl
License: Apache-2.0
Description: # calcasa-api
        The Calcasa API is used to connect to Calcasa provided services. This is the first production version of the service
        
        ## Changelog
        
        ### 2021-12-13 (v1.0.0)
        - Initial release of v0 based on v0.0.6
        
        ## Client packages
        [Nuget](https://www.nuget.org/packages/Calcasa.Api) - [Packagist](https://packagist.org/packages/calcasa/api) - [PyPI](https://pypi.org/project/calcasa.api)
        ## Client implementation notes
        Clients should at all times be tolerant to the following:
        
        - Extra fields in responses
        - Empty or hidden fields in responses
        - Extra values in enumerations
        - Unexpected error responses in the form of [Problem Details](https://rfc-editor.org/rfc/rfc7807)
        
        ## OpenAPI Specification
        This API is documented in **OpenAPI format version 3** you can use tools like the [OpenAPI Generator](https://github.com/OpenAPITools/openapi-generator) to generate API clients.
        
        ## Cross-Origin Resource Sharing
        This API features Cross-Origin Resource Sharing (CORS) implemented in compliance with [W3C spec](https://www.w3.org/TR/cors/).
        And that allows cross-domain communication from the browser.
        All responses have a wildcard same-origin which makes them completely public and accessible to everyone, including any code on any site.
        
        ## Authentication
        Authentication is done via [OAuth2](https://oauth.net/2/) and the [client credentials](https://oauth.net/2/grant-types/client-credentials/) grant type.
        
        
        This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
        
        - API version: 1.0.0
        - Package version: 1.0.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.6
        
        ## 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
        ```
        
        ## Getting Started
        
        Please follow the [installation procedure](#installation--usage) and then run the following:
        
        ```python
        
        import time
        import calcasa-api
        from pprint import pprint
        from calcasa-api.api import adressen_api
        from calcasa-api.model.adres import Adres
        from calcasa-api.model.adres_info import AdresInfo
        from calcasa-api.model.not_found_problem_details import NotFoundProblemDetails
        from calcasa-api.model.permissions_denied_problem_details import PermissionsDeniedProblemDetails
        from calcasa-api.model.problem_details import ProblemDetails
        # Defining the host is optional and defaults to https://api.calcasa.nl
        # See configuration.py for a list of all supported configuration parameters.
        configuration = calcasa-api.Configuration(
            host = "https://api.calcasa.nl"
        )
        
        # 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.
        
        # Configure OAuth2 access token for authorization: oauth
        configuration = calcasa-api.Configuration(
            host = "https://api.calcasa.nl"
        )
        configuration.access_token = 'YOUR_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 = adressen_api.AdressenApi(api_client)
            bag_nummeraanduiding_id = 1 # int | Een BAG Nummeraanduiding ID om een adres te specificeren.
        
            try:
                # Adres info op basis van BAG Nummeraanduiding Id.
                api_response = api_instance.get_adres(bag_nummeraanduiding_id)
                pprint(api_response)
            except calcasa-api.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*
        
        Class | Method | HTTP request | Description
        ------------ | ------------- | ------------- | -------------
        *AdressenApi* | [**get_adres**](docs/AdressenApi.md#get_adres) | **GET** /api/v1/adressen/{bagNummeraanduidingId} | Adres info op basis van BAG Nummeraanduiding Id.
        *AdressenApi* | [**search_adres**](docs/AdressenApi.md#search_adres) | **POST** /api/v1/adressen/zoeken | Zoek adres info op basis van het gegeven adres.
        *BestemmingsplannenApi* | [**get_bestemming_by_id**](docs/BestemmingsplannenApi.md#get_bestemming_by_id) | **GET** /api/v1/bestemmingsplannen/{bagNummeraanduidingId} | Gegevens over de bestemmingsplannen op de locatie van een adres (BAG Nummeraanduiding ID).
        *BodemApi* | [**get_bodem_by_id**](docs/BodemApi.md#get_bodem_by_id) | **GET** /api/v1/bodem/{id} | Gegevens over de bodemkwaliteit op de locatie van een adres (BAG Nummeraanduiding ID).
        *BuurtApi* | [**get_buurt**](docs/BuurtApi.md#get_buurt) | **GET** /api/v1/buurt/{buurtId} | Gegevens over een buurt en de wijk, gemeente en land waarin deze buurt gesitueerd is.
        *ConfiguratieApi* | [**get_callbacks**](docs/ConfiguratieApi.md#get_callbacks) | **GET** /api/v1/configuratie/callbacks | Haal de geconfigureerde callback URL&#39;s op voor de huidige client.
        *ConfiguratieApi* | [**update_callbacks**](docs/ConfiguratieApi.md#update_callbacks) | **POST** /api/v1/configuratie/callbacks | Configureer callback URL voor een specifieke API versie voor de huidige client.
        *FacturenApi* | [**get_factuur**](docs/FacturenApi.md#get_factuur) | **GET** /api/v1/facturen/{id} | Factuur op basis van een waardering Id.
        *FotosApi* | [**get_foto**](docs/FotosApi.md#get_foto) | **GET** /api/v1/fotos/{id} | Foto op basis van een foto Id.
        *FunderingenApi* | [**get_fundering_by_id**](docs/FunderingenApi.md#get_fundering_by_id) | **GET** /api/v1/funderingen/{bagNummeraanduidingId} | Gegevens over de fundering op de locatie van een adres (BAG Nummeraanduiding ID).
        *RapportenApi* | [**get_rapport**](docs/RapportenApi.md#get_rapport) | **GET** /api/v1/rapporten/{id} | Rapport op basis van waardering Id.
        *WaarderingenApi* | [**create_waardering**](docs/WaarderingenApi.md#create_waardering) | **POST** /api/v1/waarderingen | Creërt een waardering.
        *WaarderingenApi* | [**get_waardering**](docs/WaarderingenApi.md#get_waardering) | **GET** /api/v1/waarderingen/{id} | Waardering op basis van Id.
        *WaarderingenApi* | [**get_waardering_ontwikkeling**](docs/WaarderingenApi.md#get_waardering_ontwikkeling) | **GET** /api/v1/waarderingen/{id}/ontwikkeling | Waardering ontwikkeling op basis van waardering Id.
        *WaarderingenApi* | [**patch_waarderingen**](docs/WaarderingenApi.md#patch_waarderingen) | **PATCH** /api/v1/waarderingen/{id} | Patcht een waardering.
        *WaarderingenApi* | [**search_waarderingen**](docs/WaarderingenApi.md#search_waarderingen) | **POST** /api/v1/waarderingen/zoeken | Zoek waardering op basis van input parameters.
        
        
        ## 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)
         - [CbsIndeling](docs/CbsIndeling.md)
         - [Energielabel](docs/Energielabel.md)
         - [Factuur](docs/Factuur.md)
         - [Foto](docs/Foto.md)
         - [FunderingDataBron](docs/FunderingDataBron.md)
         - [FunderingHerstelType](docs/FunderingHerstelType.md)
         - [FunderingRisico](docs/FunderingRisico.md)
         - [FunderingRisicoLabel](docs/FunderingRisicoLabel.md)
         - [FunderingSoortBron](docs/FunderingSoortBron.md)
         - [FunderingType](docs/FunderingType.md)
         - [FunderingTypering](docs/FunderingTypering.md)
         - [Funderingdata](docs/Funderingdata.md)
         - [Gebiedsdata](docs/Gebiedsdata.md)
         - [InvalidArgumentProblemDetails](docs/InvalidArgumentProblemDetails.md)
         - [JsonPatchDocument](docs/JsonPatchDocument.md)
         - [KlantwaardeType](docs/KlantwaardeType.md)
         - [Kwartaal](docs/Kwartaal.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)
         - [Operation](docs/Operation.md)
         - [OperationType](docs/OperationType.md)
         - [PermissionsDeniedProblemDetails](docs/PermissionsDeniedProblemDetails.md)
         - [ProblemDetails](docs/ProblemDetails.md)
         - [ProductType](docs/ProductType.md)
         - [Rapport](docs/Rapport.md)
         - [Referentieobject](docs/Referentieobject.md)
         - [Taxatiedata](docs/Taxatiedata.md)
         - [Taxatiestatus](docs/Taxatiestatus.md)
         - [ValidationProblemDetails](docs/ValidationProblemDetails.md)
         - [VerkoopBijzonderheden](docs/VerkoopBijzonderheden.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)
         - [WaarderingZoekParameters](docs/WaarderingZoekParameters.md)
         - [WoningType](docs/WoningType.md)
        
        
        ## Documentation For Authorization
        
        
        ## oauth
        
        - **Type**: OAuth
        - **Flow**: application
        - **Authorization URL**: 
        - **Scopes**: 
         - **all**: Full permissions for all areas.
         - **api:all**: Full permissions for all areas of the public API.
         - **api:bestemmingsplannen:all**: Full permissions for the bestemmingsplannen area of the public API.
         - **api:bodem:all**: Full permissions for the bodem area of the public API.
         - **api:buurt:all**: Full permissions for the buurt area of the public API.
         - **api:configuratie:all**: Full permissions for the configuratie area of the public API.
         - **api:facturen:all**: Full permissions for the facturen area of the public API.
         - **api:fotos:all**: Full permissions for the fotos area of the public API.
         - **api:funderingen:all**: Full permissions for the funderingen area of the public API.
         - **api:rapporten:all**: Full permissions for the rapporten area of the public API.
         - **api:waarderingen:all**: Full permissions for the waarderingen area of the public API.
         - **api:adressen:read**: Read permissions for the adressen area of the public API.
         - **api:bestemmingsplannen:read**: Read permissions for the bestemmingsplannen area of the public API.
         - **api:bodem:read**: Read permissions for the bodem area of the public API.
         - **api:buurt:read**: Read permissions for the buurt area of the public API.
         - **api:configuratie:read**: Read permissions for the configuratie area of the public API.
         - **api:configuratie:write**: Write permissions for the configuratie area of the public API.
         - **api:facturen:read**: Read permissions for the facturen area of the public API.
         - **api:fotos:read**: Read permissions for the fotos area of the public API.
         - **api:funderingen:read**: Read permissions for the funderingen area of the public API.
         - **api:rapporten:read**: Read permissions for the rapporten area of the public API.
         - **api:waarderingen:create**: Create permissions for the waarderingen area of the public API.
         - **api:waarderingen:patch**: Patch permissions for the waarderingen area of the public API.
         - **api:waarderingen:read**: Read permissions for the waarderingen area of the public API.
         - **api:waarderingen:ontwikkeling**: Read permissions for the ontwikkelingen endpoint in the waarderingen area of the public API.
        
        
        ## Author
        
        info@calcasa.nl
        
        
        ## Notes for Large OpenAPI documents
        If the OpenAPI document is large, imports in calcasa-api.apis and calcasa-api.models may fail with a
        RecursionError indicating the maximum recursion limit has been exceeded. In that case, there are a couple of solutions:
        
        Solution 1:
        Use specific imports for apis and models like:
        - `from calcasa-api.api.default_api import DefaultApi`
        - `from calcasa-api.model.pet import Pet`
        
        Solution 2:
        Before importing the package, adjust the maximum recursion limit as shown below:
        ```
        import sys
        sys.setrecursionlimit(1500)
        import calcasa-api
        from calcasa-api.apis import *
        from calcasa-api.models import *
        ```
        
        
Keywords: OpenAPI,OpenAPI-Generator,Calcasa Public API v1
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: License :: OSI Approved :: Apache Software License
Requires-Python: >=3.6
Description-Content-Type: text/markdown; charset=UTF-8; variant=GFM
