multiflexi-api-client

MultiFlexi API provides comprehensive access to job execution, application management, event-driven processing, 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 project:

• API version: 1.4.0
• Package version: 1.2.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:

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 multiflexi_client

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 multiflexi_client

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

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	GET /app/{appId}.{suffix}	Get App by ID
AppApi	list_apps	GET /apps.{suffix}	Show All Apps
AppApi	set_app_by_id	POST /app/	Create or Update Application
CompanyApi	get_company_by_id	GET /company/{companyId}.{suffix}	Get Company by ID
CompanyApi	list_companies	GET /companies.{suffix}	Show All Companies
CompanyApi	set_company_by_id	POST /company/	Create or Update Company
CredentialApi	get_all_user_credentials	GET /credentials.{suffix}	Get All User Credentials
CredentialApi	get_credential	GET /credential/{credentialId}.{suffix}	Get User Credentials
CredentialApi	update_credentials	POST /credential/{credentialId}.{suffix}	Update Credentials
CredentialTypeApi	get_all_credential_types	GET /credential_types.{suffix}	Get All Credential Types
CredentialTypeApi	get_credential_type	GET /credential_type/{credentialTypeID}.{suffix}	Get Credential Type by ID
CredentialTypeApi	update_credential_type	POST /credential_type/{credentialTypeID}.{suffix}	Update Credential Type
DefaultApi	get_api_index	GET /index.{suffix}	Endpoints listing
DefaultApi	get_jobs_status	GET /jobs/status.{suffix}	Get Jobs Status
DefaultApi	login_suffix_get	GET /login.{suffix}	Return User's token
DefaultApi	login_suffix_post	POST /login.{suffix}	Return User's token
DefaultApi	logout_post	POST /logout	Odhlášení uživatele (invalidate token/session)
DefaultApi	ping_suffix_get	GET /ping.{suffix}	job heartbeat operation
DefaultApi	root_get	GET /	Redirect to index
DefaultApi	status_suffix_get	GET /status.{suffix}	Get API status
EventruleApi	delete_event_rule_by_id	DELETE /eventrule/{eventRuleId}.{suffix}	Delete EventRule by ID
EventruleApi	get_event_rule_by_id	GET /eventrule/{eventRuleId}.{suffix}	Get EventRule by ID
EventruleApi	list_event_rules	GET /eventrules.{suffix}	Show All EventRules
EventruleApi	set_event_rule_by_id	POST /eventrule/	Create or Update EventRule
EventsourceApi	delete_event_source_by_id	DELETE /eventsource/{eventSourceId}.{suffix}	Delete EventSource by ID
EventsourceApi	get_event_source_by_id	GET /eventsource/{eventSourceId}.{suffix}	Get EventSource by ID
EventsourceApi	list_event_sources	GET /eventsources.{suffix}	Show All EventSources
EventsourceApi	set_event_source_by_id	POST /eventsource/	Create or Update EventSource
EventsourceApi	test_event_source_connection	POST /eventsource/{eventSourceId}/test.{suffix}	Test EventSource connection
GdprApi	download_data_export	GET /data-export-download	Download personal data export file
GdprApi	request_data_export	GET /data-export	Request personal data export (GDPR Article 15)
GdprApi	request_data_export_post	POST /data-export	Request personal data export (GDPR Article 15)
JobApi	getjob_by_id	GET /job/{jobId}.{suffix}	Get job by ID
JobApi	listjobs	GET /jobs.{suffix}	Show All jobs
JobApi	setjob_by_id	POST /job/	Schedule a job from a RunTemplate
RuntemplateApi	get_run_template_by_id	GET /runtemplate/{runTemplateId}.{suffix}	Get RunTemplate by ID
RuntemplateApi	list_run_templates	GET /runtemplates.{suffix}	Show All RunTemplates
RuntemplateApi	set_run_template_by_id	POST /runtemplate	Create or Update RunTemplate
RuntemplateApi	update_run_template_by_id	POST /runtemplate/{runTemplateId}.{suffix}	Update RunTemplate by ID
TaskApi	get_task_by_id	GET /task/{taskId}.{suffix}	Get Task by ID
TaskApi	list_tasks	GET /tasks.{suffix}	List Tasks
TopicApi	get_all_topics	GET /topics.{suffix}	Get All Topics
TopicApi	get_topic	GET /topic/{topicId}.{suffix}	Get Topic by ID
TopicApi	update_topic	POST /topic/{topicId}.{suffix}	Update Topic
UserApi	get_user_by_id	GET /user/{userId}.{suffix}	Get User by ID
UserApi	list_users	GET /users.{suffix}	Show All Users
UserApi	set_user_by_id	POST /user/	Create or Update User
UserCompanyApi	assign_user_to_company	POST /company/{companyId}/user/	Assign a user to a company
UserCompanyApi	list_company_users	GET /company/{companyId}/users.{suffix}	List users assigned to a company
UserCompanyApi	unassign_user_from_company	DELETE /company/{companyId}/user/{userId}	Remove a user from a company
UserRoleApi	get_user_roles	GET /user/{userId}/roles.{suffix}	Get RBAC roles for a user
UserRoleApi	set_user_roles	POST /user/{userId}/roles/	Set RBAC roles for a user

Documentation For Models

• App
• AppEnvironmentValue
• AssignUserToCompanyRequest
• Company
• CompanyUser
• ConfField
• Configuration
• Credential
• CredentialType
• Customer
• DataExportData
• DataExportDataActivityLogsInner
• DataExportDataAuditTrails
• DataExportDataAuditTrailsDataExportRequestsInner
• DataExportDataCompanyAssociationsInner
• DataExportDataConsentRecords
• DataExportDataConsentRecordsConsentAuditTrailInner
• DataExportDataConsentRecordsConsentRecordsInner
• DataExportDataCredentialsInner
• DataExportDataExportMetadata
• DataExportDataJobHistoryInner
• DataExportDataSessionHistory
• DataExportDataSessionHistoryCurrentSessionInfo
• DataExportDataUserProfile
• DataExportResponse
• DataExportStatusResponse
• DataExportStatusResponseExportsInner
• ErrorResponse
• EventRule
• EventSource
• ExitCodeDetail
• GetCredentialType200Response
• GetTopic200Response
• Job
• JobsStatus
• ListCompanyUsers200ResponseInner
• LogoutPostRequest
• RbacRole
• RequestDataExport200Response
• RequestDataExportPostRequest
• RunTemplate
• SetUserRoles200Response
• SetUserRolesRequest
• SetjobByIdRequest
• Status
• Tag
• Task
• TestEventSourceConnection200Response
• Topic
• UnassignUserFromCompany200Response
• UpdateCredentials201Response
• UpdateRunTemplateById400Response
• UpdateRunTemplateById404Response
• UpdateRunTemplateById500Response
• UpdateRunTemplateByIdRequest
• User

Documentation For Authorization

Authentication schemes defined for the API:

basicAuth

• Type: HTTP basic authentication

Author