toctoc-controller-router-sdk 0.0.46
TOCTOC API ROUTER
Keywords: OpenAPI, OpenAPI-Generator, TOCTOC API ROUTER

# toctoc-controller-router-sdk
No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

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

- API version: 1.0
- Package version: 0.0.46
- Generator version: 7.9.0
- Build package: org.openapitools.codegen.languages.PythonClientCodegen

## Requirements.

Python 3.7+

## 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 toctoc_controller_router_sdk
```

### 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 toctoc_controller_router_sdk
```

### Tests

Execute `pytest` to run the tests.

## Getting Started

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

```python

import toctoc_controller_router_sdk
from toctoc_controller_router_sdk.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = toctoc_controller_router_sdk.Configuration(
    host = "http://localhost"
)

# 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 Bearer authorization (JWT): bearer
configuration = toctoc_controller_router_sdk.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)


# Enter a context with an instance of the API client
with toctoc_controller_router_sdk.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = toctoc_controller_router_sdk.AppraisalApi(api_client)
    appraisal_input_dto = toctoc_controller_router_sdk.AppraisalInputDto() # AppraisalInputDto | 

    try:
        # Appraisal
        api_response = api_instance.appraisal(appraisal_input_dto)
        print("The response of AppraisalApi->appraisal:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling AppraisalApi->appraisal: %s\n" % e)

```

## Documentation for API Endpoints

All URIs are relative to *http://localhost*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*AppraisalApi* | [**appraisal**](docs/AppraisalApi.md#appraisal) | **POST** /1.0/realstate/appraisal | Appraisal
*EnvironmentApi* | [**get_communes**](docs/EnvironmentApi.md#get_communes) | **GET** /1.0/realstate/environment/communes | Get communes
*EnvironmentApi* | [**get_regions**](docs/EnvironmentApi.md#get_regions) | **GET** /1.0/realstate/environment/regions | Get regions
*HighlightApi* | [**highlight**](docs/HighlightApi.md#highlight) | **PUT** /1.0/properties/highlight/{propertyCode} | Highlight property
*HighlightApi* | [**remove**](docs/HighlightApi.md#remove) | **DELETE** /1.0/properties/highlight/{propertyCode} | Remove property highlight
*HighlightApi* | [**status**](docs/HighlightApi.md#status) | **GET** /1.0/properties/highlight/status | Status of subscription
*HighlightApi* | [**summary**](docs/HighlightApi.md#summary) | **GET** /1.0/properties/highlight/summary | Summary of highlighted properties
*PropertiesApi* | [**get_properties**](docs/PropertiesApi.md#get_properties) | **GET** /1.0/properties | Get properties


## Documentation For Models

 - [Appraisal200Response](docs/Appraisal200Response.md)
 - [AppraisalInputDto](docs/AppraisalInputDto.md)
 - [ContractLinkDto](docs/ContractLinkDto.md)
 - [FlowDto](docs/FlowDto.md)
 - [GetCommunes200Response](docs/GetCommunes200Response.md)
 - [GetProperties200Response](docs/GetProperties200Response.md)
 - [GetRegions200Response](docs/GetRegions200Response.md)
 - [Highlight200Response](docs/Highlight200Response.md)
 - [HighlightErrorResponseDto](docs/HighlightErrorResponseDto.md)
 - [Images](docs/Images.md)
 - [ProductUsageDto](docs/ProductUsageDto.md)
 - [PropertiesAddress](docs/PropertiesAddress.md)
 - [PropertiesAddressLocation](docs/PropertiesAddressLocation.md)
 - [PropertiesArea](docs/PropertiesArea.md)
 - [PropertiesClient](docs/PropertiesClient.md)
 - [PropertiesCommune](docs/PropertiesCommune.md)
 - [PropertiesDistribution](docs/PropertiesDistribution.md)
 - [PropertiesFinances](docs/PropertiesFinances.md)
 - [PropertiesMultimedia](docs/PropertiesMultimedia.md)
 - [PropertiesOperation](docs/PropertiesOperation.md)
 - [Remove200Response](docs/Remove200Response.md)
 - [ResponseAppraisalDto](docs/ResponseAppraisalDto.md)
 - [ResponseBadRequestDto](docs/ResponseBadRequestDto.md)
 - [ResponseCommuneDto](docs/ResponseCommuneDto.md)
 - [ResponseErrorDto](docs/ResponseErrorDto.md)
 - [ResponseHighlightDto](docs/ResponseHighlightDto.md)
 - [ResponseHighlightStatusDto](docs/ResponseHighlightStatusDto.md)
 - [ResponseHighlightSummaryDto](docs/ResponseHighlightSummaryDto.md)
 - [ResponsePaginateDto](docs/ResponsePaginateDto.md)
 - [ResponsePaginateDtoMessage](docs/ResponsePaginateDtoMessage.md)
 - [ResponsePropertyDto](docs/ResponsePropertyDto.md)
 - [ResponseRegionsDto](docs/ResponseRegionsDto.md)
 - [ResponseRemoveHighlightedDto](docs/ResponseRemoveHighlightedDto.md)
 - [ResponseSingleDto](docs/ResponseSingleDto.md)
 - [Status200Response](docs/Status200Response.md)
 - [Summary200Response](docs/Summary200Response.md)
 - [UserMessageDto](docs/UserMessageDto.md)


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


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

- **Type**: Bearer authentication (JWT)


## Author