multiflexi-client 1.1.0
MultiFlexi API
License: MIT
Requires Python: >=3.9
Keywords: OpenAPI, OpenAPI-Generator, MultiFlexi API

# multiflexi-api-client
MultiFlexi API provides comprehensive access to job execution, application management, and user data operations. The API includes GDPR compliance endpoints for data export (Article 15 - Right of Access) and uses OAuth2 Application Flow for security.

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

- API version: 1.2.0
- Package version: 1.1.0
- Generator version: 7.14.0
- Build package: org.openapitools.codegen.languages.PythonClientCodegen

## Requirements.

Python 3.9+

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

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

### Tests

Execute `pytest` to run the tests.

## Getting Started

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

```python

import multiflexi_client
from multiflexi_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://virtserver.swaggerhub.com/VitexSoftware/MultiFlexi/1.0.0
# See configuration.py for a list of all supported configuration parameters.
configuration = multiflexi_client.Configuration(
    host = "https://virtserver.swaggerhub.com/VitexSoftware/MultiFlexi/1.0.0"
)

# 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 HTTP basic authorization: basicAuth
configuration = multiflexi_client.Configuration(
    username = os.environ["USERNAME"],
    password = os.environ["PASSWORD"]
)


# Enter a context with an instance of the API client
with multiflexi_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = multiflexi_client.AppApi(api_client)
    app_id = 56 # int | ID of app to return
    suffix = html # str | force format suffix (default to html)
    limit = 20 # int | maximum number of results to return (optional) (default to 20)

    try:
        # Get App by ID
        api_response = api_instance.get_app_by_id(app_id, suffix, limit=limit)
        print("The response of AppApi->get_app_by_id:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling AppApi->get_app_by_id: %s\n" % e)

```

## Documentation for API Endpoints

All URIs are relative to *https://virtserver.swaggerhub.com/VitexSoftware/MultiFlexi/1.0.0*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*AppApi* | [**get_app_by_id**](docs/AppApi.md#get_app_by_id) | **GET** /app/{appId}.{suffix} | Get App by ID
*AppApi* | [**list_apps**](docs/AppApi.md#list_apps) | **GET** /apps.{suffix} | Show All Apps
*AppApi* | [**set_app_by_id**](docs/AppApi.md#set_app_by_id) | **POST** /app/ | Create or Update Application
*CompanyApi* | [**get_company_by_id**](docs/CompanyApi.md#get_company_by_id) | **GET** /company/{companyId}.{suffix} | Get Company by ID
*CompanyApi* | [**list_companies**](docs/CompanyApi.md#list_companies) | **GET** /companies.{suffix} | Show All Companies
*CompanyApi* | [**set_company_by_id**](docs/CompanyApi.md#set_company_by_id) | **POST** /company/ | Create or Update Company
*DefaultApi* | [**get_all_credential_types**](docs/DefaultApi.md#get_all_credential_types) | **GET** /credential_types.{suffix} | Get All Credential Types
*DefaultApi* | [**get_all_topics**](docs/DefaultApi.md#get_all_topics) | **GET** /topics.{suffix} | Get All Topics
*DefaultApi* | [**get_all_user_credentials**](docs/DefaultApi.md#get_all_user_credentials) | **GET** /credentials.{suffix} | Get All User Credentials
*DefaultApi* | [**get_api_index**](docs/DefaultApi.md#get_api_index) | **GET** /index.{suffix} | Endpoints listing
*DefaultApi* | [**get_credential**](docs/DefaultApi.md#get_credential) | **GET** /credential/{credentialId}.{suffix} | Get User Credentials
*DefaultApi* | [**get_credential_type**](docs/DefaultApi.md#get_credential_type) | **GET** /credential_type/{credentialTypeID}.{suffix} | Get Credential Type by ID
*DefaultApi* | [**get_jobs_status**](docs/DefaultApi.md#get_jobs_status) | **GET** /jobs/status.{suffix} | Get Jobs Status
*DefaultApi* | [**get_topic**](docs/DefaultApi.md#get_topic) | **GET** /topic/{topicId}.{suffix} | Get Topic by ID
*DefaultApi* | [**login_suffix_get**](docs/DefaultApi.md#login_suffix_get) | **GET** /login.{suffix} | Return User&#39;s token
*DefaultApi* | [**login_suffix_post**](docs/DefaultApi.md#login_suffix_post) | **POST** /login.{suffix} | Return User&#39;s token
*DefaultApi* | [**logout_post**](docs/DefaultApi.md#logout_post) | **POST** /logout | Odhlášení uživatele (invalidate token/session)
*DefaultApi* | [**ping_suffix_get**](docs/DefaultApi.md#ping_suffix_get) | **GET** /ping.{suffix} | job heartbeat operation
*DefaultApi* | [**root_get**](docs/DefaultApi.md#root_get) | **GET** / | Redirect to index
*DefaultApi* | [**status_suffix_get**](docs/DefaultApi.md#status_suffix_get) | **GET** /status.{suffix} | Get API status
*DefaultApi* | [**update_credential_type**](docs/DefaultApi.md#update_credential_type) | **POST** /credential_type/{credentialTypeID}.{suffix} | Update Credential Type
*DefaultApi* | [**update_credentials**](docs/DefaultApi.md#update_credentials) | **POST** /credential/{credentialId}.{suffix} | Update Credentials
*DefaultApi* | [**update_topic**](docs/DefaultApi.md#update_topic) | **POST** /topic/{topicId}.{suffix} | Update Topic
*GdprApi* | [**download_data_export**](docs/GdprApi.md#download_data_export) | **GET** /data-export-download | Download personal data export file
*GdprApi* | [**request_data_export**](docs/GdprApi.md#request_data_export) | **GET** /data-export | Request personal data export (GDPR Article 15)
*GdprApi* | [**request_data_export_post**](docs/GdprApi.md#request_data_export_post) | **POST** /data-export | Request personal data export (GDPR Article 15)
*JobApi* | [**getjob_by_id**](docs/JobApi.md#getjob_by_id) | **GET** /job/{jobId}.{suffix} | Get job by ID
*JobApi* | [**listjobs**](docs/JobApi.md#listjobs) | **GET** /jobs.{suffix} | Show All jobs
*JobApi* | [**setjob_by_id**](docs/JobApi.md#setjob_by_id) | **POST** /job/ | Create or Update job record
*RuntemplateApi* | [**get_run_template_by_id**](docs/RuntemplateApi.md#get_run_template_by_id) | **GET** /runtemplate/{runTemplateId}.{suffix} | Get RunTemplate by ID
*RuntemplateApi* | [**list_run_templates**](docs/RuntemplateApi.md#list_run_templates) | **GET** /runtemplates.{suffix} | Show All RunTemplates
*RuntemplateApi* | [**set_run_template_by_id**](docs/RuntemplateApi.md#set_run_template_by_id) | **POST** /runtemplate | Create or Update RunTemplate
*RuntemplateApi* | [**update_run_template_by_id**](docs/RuntemplateApi.md#update_run_template_by_id) | **POST** /runtemplate/{runTemplateId}.{suffix} | Update RunTemplate by ID
*UserApi* | [**get_user_by_id**](docs/UserApi.md#get_user_by_id) | **GET** /user/{userId}.{suffix} | Get User by ID
*UserApi* | [**list_users**](docs/UserApi.md#list_users) | **GET** /users.{suffix} | Show All Users
*UserApi* | [**set_user_by_id**](docs/UserApi.md#set_user_by_id) | **POST** /user/ | Create or Update User


## Documentation For Models

 - [App](docs/App.md)
 - [AppEnvironmentValue](docs/AppEnvironmentValue.md)
 - [AppExitCodesInner](docs/AppExitCodesInner.md)
 - [Company](docs/Company.md)
 - [ConfField](docs/ConfField.md)
 - [Configuration](docs/Configuration.md)
 - [Credential](docs/Credential.md)
 - [CredentialType](docs/CredentialType.md)
 - [Customer](docs/Customer.md)
 - [DataExportData](docs/DataExportData.md)
 - [DataExportDataActivityLogsInner](docs/DataExportDataActivityLogsInner.md)
 - [DataExportDataAuditTrails](docs/DataExportDataAuditTrails.md)
 - [DataExportDataAuditTrailsDataExportRequestsInner](docs/DataExportDataAuditTrailsDataExportRequestsInner.md)
 - [DataExportDataCompanyAssociationsInner](docs/DataExportDataCompanyAssociationsInner.md)
 - [DataExportDataConsentRecords](docs/DataExportDataConsentRecords.md)
 - [DataExportDataConsentRecordsConsentAuditTrailInner](docs/DataExportDataConsentRecordsConsentAuditTrailInner.md)
 - [DataExportDataConsentRecordsConsentRecordsInner](docs/DataExportDataConsentRecordsConsentRecordsInner.md)
 - [DataExportDataCredentialsInner](docs/DataExportDataCredentialsInner.md)
 - [DataExportDataExportMetadata](docs/DataExportDataExportMetadata.md)
 - [DataExportDataJobHistoryInner](docs/DataExportDataJobHistoryInner.md)
 - [DataExportDataSessionHistory](docs/DataExportDataSessionHistory.md)
 - [DataExportDataSessionHistoryCurrentSessionInfo](docs/DataExportDataSessionHistoryCurrentSessionInfo.md)
 - [DataExportDataUserProfile](docs/DataExportDataUserProfile.md)
 - [DataExportResponse](docs/DataExportResponse.md)
 - [DataExportStatusResponse](docs/DataExportStatusResponse.md)
 - [DataExportStatusResponseExportsInner](docs/DataExportStatusResponseExportsInner.md)
 - [ErrorResponse](docs/ErrorResponse.md)
 - [GetCredentialType200Response](docs/GetCredentialType200Response.md)
 - [GetTopic200Response](docs/GetTopic200Response.md)
 - [Job](docs/Job.md)
 - [JobsStatus](docs/JobsStatus.md)
 - [LogoutPostRequest](docs/LogoutPostRequest.md)
 - [RequestDataExport200Response](docs/RequestDataExport200Response.md)
 - [RequestDataExportPostRequest](docs/RequestDataExportPostRequest.md)
 - [RunTemplate](docs/RunTemplate.md)
 - [Status](docs/Status.md)
 - [Tag](docs/Tag.md)
 - [Topic](docs/Topic.md)
 - [UpdateCredentials201Response](docs/UpdateCredentials201Response.md)
 - [UpdateRunTemplateById400Response](docs/UpdateRunTemplateById400Response.md)
 - [UpdateRunTemplateById404Response](docs/UpdateRunTemplateById404Response.md)
 - [UpdateRunTemplateById500Response](docs/UpdateRunTemplateById500Response.md)
 - [UpdateRunTemplateByIdRequest](docs/UpdateRunTemplateByIdRequest.md)
 - [User](docs/User.md)


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


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

- **Type**: HTTP basic authentication


## Author