toctoc-controller-router-sdk 0.0.33

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 project:

• API version: 1.0
• Package version: 0.0.33
• 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:

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:

import toctoc_controller_router_sdk

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import toctoc_controller_router_sdk

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

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	POST /1.0/realstate/appraisal	Appraisal
EnvironmentApi	get_communes	GET /1.0/realstate/environment/communes	Get communes
EnvironmentApi	get_regions	GET /1.0/realstate/environment/regions	Get regions
HighlightApi	highlight	PUT /1.0/properties/highlight/{propertyCode}	Highlight property
HighlightApi	remove	DELETE /1.0/properties/highlight/{propertyCode}	Remove property highlight
HighlightApi	status	GET /1.0/properties/highlight/status	Status of subscription
HighlightApi	summary	GET /1.0/properties/highlight/summary	Summary of highlighted properties
PropertiesApi	get_properties	GET /1.0/properties	Get properties
DefaultApi	create_or_update_session	PUT /1.0/auth/{token}
DefaultApi	deactivate_session	DELETE /1.0/auth/{token}
DefaultApi	get_session	GET /1.0/auth/{token}

Documentation For Models

• Appraisal200Response
• AppraisalInputDto
• FlowDto
• GetCommunes200Response
• GetProperties200Response
• GetRegions200Response
• Highlight200Response
• Images
• ProductUsageDto
• PropertiesAddress
• PropertiesAddressLocation
• PropertiesArea
• PropertiesClient
• PropertiesCommune
• PropertiesDistribution
• PropertiesFinances
• PropertiesMultimedia
• PropertiesOperation
• Remove200Response
• ResponseAppraisalDto
• ResponseBadRequestDto
• ResponseCommuneDto
• ResponseErrorDto
• ResponseHighlightDto
• ResponseHighlightStatusDto
• ResponseHighlightSummaryDto
• ResponsePaginateDto
• ResponsePaginateDtoMessage
• ResponsePropertyDto
• ResponseRegionsDto
• ResponseRemoveHighlightedDto
• ResponseSingleDto
• Status200Response
• Summary200Response

Documentation For Authorization

Authentication schemes defined for the API:

bearer

• Type: Bearer authentication (JWT)

Author