# core.v2
EazyRent Core API ====================  Description -------------  The EazyRent API is a powerful tool, designed to automate and streamline the tenant application process for professionals in the real estate and insurance sectors.  Our API leverages advanced technologies like Optical Character Recognition (OCR) and Machine Learning to collect, analyze, and verify tenant application documents.  The API helps clients detect fraudulent submissions and assess the reliability of potential tenants, ensuring a secure and efficient tenant selection process.  Target Audience ----------------   * **Real Estate Agencies and Social Housing Providers:** Professionals who need a reliable solution to evaluate tenant applications quickly and accurately.   * **Rent Guarantee Insurers:** Companies seeking to verify the credibility of tenant applications and assess eligibility for rent payment guarantees.   Purpose --------  The purpose of the EazyRent API is to enable seamless interaction with our tenant application system. It allows clients to integrate our automated document collection, analysis, and verification capabilities directly into their own workflows. By using our API, businesses can streamline operations, reduce fraud risk, and make well-informed decisions in the tenant selection process.   How to use this API ---------------------  To start using the EazyRent API, please refer to our comprehensive online documentation, which includes detailed information on API endpoints, authentication, and integration examples. You can access the documentation [here](https://docs.eazyrent.fr). This resource will guide you through the steps needed to integrate our API into your existing systems and maximize its capabilities.  

The `core.v2` package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:

- API version: 2
- Package version: 1.0.0
- Generator version: 7.14.0-SNAPSHOT
- Build package: org.openapitools.codegen.languages.PythonClientCodegen

## Requirements.

Python 3.9+

## Installation & Usage

This python library package is generated without supporting files like setup.py or requirements files

To be able to use it, you will need these dependencies in your own package that uses this library:

* urllib3 >= 2.1.0, < 3.0.0
* python-dateutil >= 2.8.2
* pydantic >= 2
* typing-extensions >= 4.7.1

## Getting Started

In your own code, to use this library to connect and interact with core.v2,
you can run the following:

```python

import core.v2
from core.v2.rest import ApiException
from pprint import pprint

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

# 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 API key authorization: APIKeyHeader
configuration.api_key['APIKeyHeader'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['APIKeyHeader'] = 'Bearer'

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


# Enter a context with an instance of the API client
with core.v2.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = core.v2.AcceptedDocumentsApi(api_client)
    id = 'id_example' # str | 
    file = None # bytearray | 
    x_eaz_account_id = 'x_eaz_account_id_example' # str | The default is always the organization of the requesting user. If you like to get/set a result of another organization include the header. Make sure the user has permission to access the requested data. (optional)

    try:
        # Add document download
        api_response = api_instance.add_document_download(id, file, x_eaz_account_id=x_eaz_account_id)
        print("The response of AcceptedDocumentsApi->add_document_download:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling AcceptedDocumentsApi->add_document_download: %s\n" % e)

```

## Documentation for API Endpoints

All URIs are relative to */v2*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*AcceptedDocumentsApi* | [**add_document_download**](core/v2/docs/AcceptedDocumentsApi.md#add_document_download) | **POST** /accepted-documents/{id}/document-download/ | Add document download
*AcceptedDocumentsApi* | [**create_accepted_documents**](core/v2/docs/AcceptedDocumentsApi.md#create_accepted_documents) | **POST** /accepted-documents/ | Create accepted documents
*AcceptedDocumentsApi* | [**delete_accepted_document**](core/v2/docs/AcceptedDocumentsApi.md#delete_accepted_document) | **DELETE** /accepted-documents/{id}/ | Delete accepted document
*AcceptedDocumentsApi* | [**delete_document_download**](core/v2/docs/AcceptedDocumentsApi.md#delete_document_download) | **DELETE** /accepted-documents/{id}/document-download/ | Delete document download
*AcceptedDocumentsApi* | [**get_accepted_document**](core/v2/docs/AcceptedDocumentsApi.md#get_accepted_document) | **GET** /accepted-documents/{id}/ | Get accepted document
*AcceptedDocumentsApi* | [**list_accepted_documents**](core/v2/docs/AcceptedDocumentsApi.md#list_accepted_documents) | **GET** /accepted-documents/ | List accepted documents
*AcceptedDocumentsApi* | [**partial_update_accepted_documents**](core/v2/docs/AcceptedDocumentsApi.md#partial_update_accepted_documents) | **PATCH** /accepted-documents/{id}/ | Partial update accepted documents
*AcceptedDocumentsApi* | [**update_accepted_documents**](core/v2/docs/AcceptedDocumentsApi.md#update_accepted_documents) | **PUT** /accepted-documents/{id}/ | Update accepted documents
*ApplicantFormsApi* | [**get_applicant_form**](core/v2/docs/ApplicantFormsApi.md#get_applicant_form) | **GET** /forms/{id}/ | Get applicant form
*ApplicantFormsApi* | [**get_applicant_form_comment**](core/v2/docs/ApplicantFormsApi.md#get_applicant_form_comment) | **GET** /forms/{id}/comment/ | Get applicant form comment
*DocumentsApi* | [**create_document**](core/v2/docs/DocumentsApi.md#create_document) | **POST** /documents/ | Create document
*DocumentsApi* | [**deleted_document**](core/v2/docs/DocumentsApi.md#deleted_document) | **DELETE** /documents/{id} | Deleted document
*DocumentsApi* | [**get_document**](core/v2/docs/DocumentsApi.md#get_document) | **GET** /documents/{id}/download/ | Get document
*DocumentsApi* | [**get_document_pages**](core/v2/docs/DocumentsApi.md#get_document_pages) | **GET** /documents/{id}/pages | Get document pages
*DocumentsApi* | [**list_document**](core/v2/docs/DocumentsApi.md#list_document) | **GET** /documents/ | List document
*DocumentsApi* | [**update_document**](core/v2/docs/DocumentsApi.md#update_document) | **PATCH** /documents/{id} | Update document
*RentalFilesApi* | [**ask_analysis**](core/v2/docs/RentalFilesApi.md#ask_analysis) | **POST** /rental-files/{id}/ask-analysis/ | Ask analysis
*RentalFilesApi* | [**close_rental_file**](core/v2/docs/RentalFilesApi.md#close_rental_file) | **POST** /rental-files/{id}/close/ | Close rental file
*RentalFilesApi* | [**create_rental_file**](core/v2/docs/RentalFilesApi.md#create_rental_file) | **POST** /rental-files/ | Create rental file
*RentalFilesApi* | [**delete_rental_file**](core/v2/docs/RentalFilesApi.md#delete_rental_file) | **DELETE** /rental-files/{id}/ | Delete rental file
*RentalFilesApi* | [**download_documents**](core/v2/docs/RentalFilesApi.md#download_documents) | **GET** /rental-files/{id}/download/ | Download documents
*RentalFilesApi* | [**get_rental_file**](core/v2/docs/RentalFilesApi.md#get_rental_file) | **GET** /rental-files/{id}/ | Get rental file
*RentalFilesApi* | [**get_rental_file_by_metadata**](core/v2/docs/RentalFilesApi.md#get_rental_file_by_metadata) | **GET** /rental-files/resolve/ | Get rental file by metadata
*RentalFilesApi* | [**get_rental_file_history_events**](core/v2/docs/RentalFilesApi.md#get_rental_file_history_events) | **GET** /rental-files/{id}/history | Get rental file history events
*RentalFilesApi* | [**get_rental_file_status**](core/v2/docs/RentalFilesApi.md#get_rental_file_status) | **GET** /rental-files/{id}/status/ | Get rental file status
*RentalFilesApi* | [**get_rental_file_status_by_metadata**](core/v2/docs/RentalFilesApi.md#get_rental_file_status_by_metadata) | **GET** /rental-files/resolve/status/ | Get rental file status by metadata
*RentalFilesApi* | [**invite_applicant**](core/v2/docs/RentalFilesApi.md#invite_applicant) | **POST** /rental-files/invite/ | Invite applicant
*RentalFilesApi* | [**list_rental_files**](core/v2/docs/RentalFilesApi.md#list_rental_files) | **GET** /rental-files/ | List rental files
*RentalFilesApi* | [**partial_update_rental_file**](core/v2/docs/RentalFilesApi.md#partial_update_rental_file) | **PATCH** /rental-files/{id}/ | Partial update rental file
*RentalFilesApi* | [**reopen_all_forms**](core/v2/docs/RentalFilesApi.md#reopen_all_forms) | **POST** /rental-files/{id}/unlock-forms/ | Reopen all forms
*RentalFilesApi* | [**reopen_applicant_form**](core/v2/docs/RentalFilesApi.md#reopen_applicant_form) | **POST** /rental-files/{applicant_id}/unlock-form/ | Reopen applicant form
*RentalFilesApi* | [**update_rental_file**](core/v2/docs/RentalFilesApi.md#update_rental_file) | **PUT** /rental-files/{id}/ | Update rental file
*RentalFilesApi* | [**validate_pre_application**](core/v2/docs/RentalFilesApi.md#validate_pre_application) | **POST** /rental-files/{id}/validate-pre-application/ | Validate pre application
*RentalFilesCommentsApi* | [**add_comment**](core/v2/docs/RentalFilesCommentsApi.md#add_comment) | **POST** /rental-files/{id}/comments | Add comment
*RentalFilesCommentsApi* | [**delete_comment**](core/v2/docs/RentalFilesCommentsApi.md#delete_comment) | **DELETE** /rental-files/{id}/comments/{comment_id} | Delete comment
*RentalFilesCommentsApi* | [**get_comments**](core/v2/docs/RentalFilesCommentsApi.md#get_comments) | **GET** /rental-files/{id}/comments | Get comments
*RentalFilesCommentsApi* | [**update_comment**](core/v2/docs/RentalFilesCommentsApi.md#update_comment) | **PATCH** /rental-files/{id}/comments/{comment_id} | Update comment
*ShareLinksApi* | [**create_share_link**](core/v2/docs/ShareLinksApi.md#create_share_link) | **POST** /share-links/ | Create share link
*ShareLinksApi* | [**delete_share_link**](core/v2/docs/ShareLinksApi.md#delete_share_link) | **DELETE** /share-links/{secret}/ | Delete share link
*ShareLinksApi* | [**get_rental_file_by_secret**](core/v2/docs/ShareLinksApi.md#get_rental_file_by_secret) | **GET** /share-links/{secret}/rental-file/ | Get rental file by secret
*ShareLinksApi* | [**get_share_links**](core/v2/docs/ShareLinksApi.md#get_share_links) | **GET** /share-links/{rental_file_id}/ | Get share links
*TagsApi* | [**list_account_tags**](core/v2/docs/TagsApi.md#list_account_tags) | **GET** /tags/ | List account tags


## Documentation For Models

 - [AcceptedDocument](core/v2/docs/AcceptedDocument.md)
 - [Alert](core/v2/docs/Alert.md)
 - [Applicant](core/v2/docs/Applicant.md)
 - [BaseAlertType](core/v2/docs/BaseAlertType.md)
 - [CloseRentalFile](core/v2/docs/CloseRentalFile.md)
 - [CreateAcceptedDocument](core/v2/docs/CreateAcceptedDocument.md)
 - [CreateApplicant](core/v2/docs/CreateApplicant.md)
 - [CreateRentalFile](core/v2/docs/CreateRentalFile.md)
 - [DocumentSlice](core/v2/docs/DocumentSlice.md)
 - [DocumentType](core/v2/docs/DocumentType.md)
 - [DocumentView](core/v2/docs/DocumentView.md)
 - [File](core/v2/docs/File.md)
 - [FormComment](core/v2/docs/FormComment.md)
 - [HTTPValidationError](core/v2/docs/HTTPValidationError.md)
 - [HistoryEvent](core/v2/docs/HistoryEvent.md)
 - [Images](core/v2/docs/Images.md)
 - [InvitePayload](core/v2/docs/InvitePayload.md)
 - [ListAcceptedDocument](core/v2/docs/ListAcceptedDocument.md)
 - [ListApplicant](core/v2/docs/ListApplicant.md)
 - [ListDocument](core/v2/docs/ListDocument.md)
 - [ListProductsProjection](core/v2/docs/ListProductsProjection.md)
 - [ListRentalFile](core/v2/docs/ListRentalFile.md)
 - [ManagersEq](core/v2/docs/ManagersEq.md)
 - [MoralGuarantor](core/v2/docs/MoralGuarantor.md)
 - [Next](core/v2/docs/Next.md)
 - [PaginatedResponseDocumentView](core/v2/docs/PaginatedResponseDocumentView.md)
 - [PaginatedResponseListAcceptedDocument](core/v2/docs/PaginatedResponseListAcceptedDocument.md)
 - [PaginatedResponseListRentalFile](core/v2/docs/PaginatedResponseListRentalFile.md)
 - [PartialUpdateAcceptedDocument](core/v2/docs/PartialUpdateAcceptedDocument.md)
 - [PartialUpdateRentalFile](core/v2/docs/PartialUpdateRentalFile.md)
 - [Previous](core/v2/docs/Previous.md)
 - [ProductPhoto](core/v2/docs/ProductPhoto.md)
 - [ProductType](core/v2/docs/ProductType.md)
 - [RejectReason](core/v2/docs/RejectReason.md)
 - [RentalFile](core/v2/docs/RentalFile.md)
 - [RentalFileComment](core/v2/docs/RentalFileComment.md)
 - [RentalFileCommentIn](core/v2/docs/RentalFileCommentIn.md)
 - [RentalFileStatus](core/v2/docs/RentalFileStatus.md)
 - [ReopenForms](core/v2/docs/ReopenForms.md)
 - [Tag](core/v2/docs/Tag.md)
 - [TagIn](core/v2/docs/TagIn.md)
 - [Thumbnail](core/v2/docs/Thumbnail.md)
 - [ToDownload](core/v2/docs/ToDownload.md)
 - [UpdateAcceptedDocument](core/v2/docs/UpdateAcceptedDocument.md)
 - [UpdateApplicant](core/v2/docs/UpdateApplicant.md)
 - [UpdateRentalFile](core/v2/docs/UpdateRentalFile.md)
 - [ValidationError](core/v2/docs/ValidationError.md)
 - [ValidationErrorLocInner](core/v2/docs/ValidationErrorLocInner.md)


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


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

- **Type**: OAuth
- **Flow**: application
- **Authorization URL**: 
- **Scopes**: 
 - **profile**: Profile scope
 - **openid**: OpenId scope
 - **urn:zitadel:iam:org:projects:roles**: Get user roles
 - **urn:zitadel:iam:user:resourceowner**: Get user org
 - **urn:zitadel:iam:org:project:id:286048212773503426:aud**: Get grant to eazyrent project

<a id="APIKeyHeader"></a>
### APIKeyHeader

- **Type**: API key
- **API key parameter name**: Authorization
- **Location**: HTTP header


## Author




