Skip to content

Latest commit

 

History

History
290 lines (255 loc) · 23.3 KB

API_README.md

File metadata and controls

290 lines (255 loc) · 23.3 KB
Raw

avacloud-client-python

AVACloud API specification

This Python package is automatically generated by the Swagger Codegen project:

  • API version: 1.52.1
  • Package version: 1.52.1
  • Build package: io.swagger.codegen.languages.PythonClientCodegen

Requirements.

Python 2.7 and 3.4+

Installation & Usage

pip install

If the python package is hosted on Github, you can install directly from Github

pip install git+https://github.com//.git

(you may need to run pip with root permission: sudo pip install git+https://github.com//.git)

Then import the package:

import avacloud_client_python

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 avacloud_client_python

Getting Started

Please follow the installation procedure and then run the following:

from __future__ import print_function
import time
import avacloud_client_python
from avacloud_client_python.rest import ApiException
from pprint import pprint

# Configure OAuth2 access token for authorization: Dangl.Identity
configuration = avacloud_client_python.Configuration()
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# create an instance of the API class
api_instance = avacloud_client_python.AslvConversionApi(avacloud_client_python.ApiClient(configuration))
aslv_file = '/path/to/file.txt' # file | The input file (optional)
remove_plain_text_long_texts = true # bool | If set to true, plain text long texts will be removed from the output to reduce response sizes (optional)
remove_html_long_texts = true # bool | If set to true, html long texts will be removed from the output to reduce response sizes (optional)

try:
    # Converts Aslv files to Dangl.AVA projects
    api_response = api_instance.aslv_conversion_convert_to_ava(aslv_file=aslv_file, remove_plain_text_long_texts=remove_plain_text_long_texts, remove_html_long_texts=remove_html_long_texts)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling AslvConversionApi->aslv_conversion_convert_to_ava: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to https://avacloud-api.dangl-it.com

Class Method HTTP request Description
AslvConversionApi aslv_conversion_convert_to_ava POST /conversion/aslv/ava Converts Aslv files to Dangl.AVA projects
AslvConversionApi aslv_conversion_convert_to_excel POST /conversion/aslv/excel Converts Aslv files to Excel
AslvConversionApi aslv_conversion_convert_to_flat_ava POST /conversion/aslv/flat-ava Converts Aslv files to Dangl.AVA projects
AslvConversionApi aslv_conversion_convert_to_gaeb POST /conversion/aslv/gaeb Converts Aslv files to GAEB files
AslvConversionApi aslv_conversion_convert_to_oenorm POST /conversion/aslv/oenorm Converts Aslv files to Oenorm files
AvaConversionApi ava_conversion_convert_to_ava POST /conversion/ava/ava Converts Dangl.AVA projects to Dangl.AVA. This is useful when you want to generate the calculated properties.
AvaConversionApi ava_conversion_convert_to_datanorm POST /conversion/ava/datanorm Converts Dangl.AVA projects to Datanorm
AvaConversionApi ava_conversion_convert_to_excel POST /conversion/ava/excel Converts Dangl.AVA projects to Excel
AvaConversionApi ava_conversion_convert_to_flat_ava POST /conversion/ava/flat-ava Converts Dangl.AVA projects to Dangl.AVA. This is useful when you want to generate the calculated properties.
AvaConversionApi ava_conversion_convert_to_gaeb POST /conversion/ava/gaeb Converts Dangl.AVA projects to GAEB
AvaConversionApi ava_conversion_convert_to_ids_connect POST /conversion/ava/ids-connect Converts Dangl.AVA projects to IDS Connect files
AvaConversionApi ava_conversion_convert_to_oenorm POST /conversion/ava/oenorm Converts Dangl.AVA projects to Oenorm
AvaConversionApi ava_conversion_convert_to_reb POST /conversion/ava/reb Converts Dangl.AVA projects to REB
AvaConversionApi ava_conversion_convert_to_sia POST /conversion/ava/sia Converts Dangl.AVA projects to SIA 451
AvaConversionApi ava_conversion_convert_to_ugl POST /conversion/ava/ugl Converts Dangl.AVA projects to UGL
DanglIdentityApi dangl_identity_get_user_info GET /identity/user-info
DanglIdentityApi dangl_identity_login_and_return_token POST /identity/token-login
DanglIdentityApi dangl_identity_login_with_cookie POST /identity/login
DanglIdentityApi dangl_identity_refresh_token POST /identity/token-refresh
DanglIdentityApi dangl_identity_register POST /identity/register
DanglIdentityApi dangl_identity_request_password_reset POST /identity/password-forgotten
DanglIdentityApi dangl_identity_sign_out_with_sign_in_manager DELETE /identity/login
DatanormConversionApi datanorm_conversion_convert_to_ava POST /conversion/datanorm/ava Converts Datanorm files to Dangl.AVA projects
DatanormConversionApi datanorm_conversion_convert_to_flat_ava POST /conversion/datanorm/flat-ava Converts Datanorm files to Dangl.AVA projects
ExcelConversionApi excel_conversion_convert_to_ava POST /conversion/excel/ava Converts Excel files to Dangl.AVA projects.
ExcelConversionApi excel_conversion_convert_to_excel POST /conversion/excel/excel Converts Excel files to Excel files. Used, for example, when elements were added in excel to generate or modify a project. The Excel file can then be shared containing the full project with all formattings, formulas and styles applied.
ExcelConversionApi excel_conversion_convert_to_flat_ava POST /conversion/excel/flat-ava Converts Excel files to Dangl.AVA projects.
ExcelConversionApi excel_conversion_convert_to_gaeb POST /conversion/excel/gaeb Converts Excel files to GAEB files.
ExcelConversionApi excel_conversion_convert_to_oenorm POST /conversion/excel/oenorm Converts Excel files to Oenorm files.
FlatAvaConversionApi flat_ava_conversion_convert_to_ava POST /conversion/flat-ava/ava Converts flat Dangl.AVA projects to Dangl.AVA. This is useful when you want to generate the calculated properties.
FlatAvaConversionApi flat_ava_conversion_convert_to_datanorm POST /conversion/flat-ava/datanorm Converts flat Dangl.AVA projects to Datanorm
FlatAvaConversionApi flat_ava_conversion_convert_to_excel POST /conversion/flat-ava/excel Converts flat Dangl.AVA projects to Excel
FlatAvaConversionApi flat_ava_conversion_convert_to_flat_ava POST /conversion/flat-ava/flat-ava Converts flat Dangl.AVA projects to Dangl.AVA. This is useful when you want to generate the calculated properties.
FlatAvaConversionApi flat_ava_conversion_convert_to_gaeb POST /conversion/flat-ava/gaeb Converts flat Dangl.AVA projects to GAEB
FlatAvaConversionApi flat_ava_conversion_convert_to_ids_connect POST /conversion/flat-ava/ids-connect Converts flat Dangl.AVA projects to IDS Connect files
FlatAvaConversionApi flat_ava_conversion_convert_to_oenorm POST /conversion/flat-ava/oenorm Converts flat Dangl.AVA projects to Oenorm
FlatAvaConversionApi flat_ava_conversion_convert_to_reb POST /conversion/flat-ava/reb Converts flat Dangl.AVA projects to REB
FlatAvaConversionApi flat_ava_conversion_convert_to_sia POST /conversion/flat-ava/sia Converts flat Dangl.AVA projects to SIA 451
FlatAvaConversionApi flat_ava_conversion_convert_to_ugl POST /conversion/flat-ava/ugl Converts flat Dangl.AVA projects to UGL
GaebConversionApi gaeb_conversion_convert_to_ava POST /conversion/gaeb/ava Converts GAEB files to Dangl.AVA projects
GaebConversionApi gaeb_conversion_convert_to_excel POST /conversion/gaeb/excel Converts GAEB files to Excel
GaebConversionApi gaeb_conversion_convert_to_flat_ava POST /conversion/gaeb/flat-ava Converts GAEB files to Dangl.AVA projects
GaebConversionApi gaeb_conversion_convert_to_gaeb POST /conversion/gaeb/gaeb Converts GAEB files to GAEB files. Used for example when transforming or repairing GAEB files.
GaebConversionApi gaeb_conversion_convert_to_oenorm POST /conversion/gaeb/oenorm Converts GAEB files to Oenorm files
IdsConnectConversionApi ids_connect_conversion_convert_to_ava POST /conversion/ids-connect/ava Converts IDS Connect files to Dangl.AVA projects
IdsConnectConversionApi ids_connect_conversion_convert_to_flat_ava POST /conversion/ids-connect/flat-ava Converts IDS Connect files to Dangl.AVA projects
OenormConversionApi oenorm_conversion_convert_to_ava POST /conversion/oenorm/ava Converts ÖNorm files to Dangl.AVA projects
OenormConversionApi oenorm_conversion_convert_to_excel POST /conversion/oenorm/excel Converts ÖNorm files to Excel
OenormConversionApi oenorm_conversion_convert_to_flat_ava POST /conversion/oenorm/flat-ava Converts ÖNorm files to Dangl.AVA projects
OenormConversionApi oenorm_conversion_convert_to_gaeb POST /conversion/oenorm/gaeb Converts ÖNorm files to GAEB files.
OenormConversionApi oenorm_conversion_convert_to_oenorm POST /conversion/oenorm/oenorm Converts ÖNorm files to Oenorm files.
RebConversionApi reb_conversion_convert_to_ava POST /conversion/reb/ava Converts REB files to Dangl.AVA projects
RebConversionApi reb_conversion_convert_to_excel POST /conversion/reb/excel Converts REB files to Excel
RebConversionApi reb_conversion_convert_to_flat_ava POST /conversion/reb/flat-ava Converts REB files to Dangl.AVA projects
RebConversionApi reb_conversion_convert_to_gaeb POST /conversion/reb/gaeb Converts REB files to GAEB files
RebConversionApi reb_conversion_convert_to_oenorm POST /conversion/reb/oenorm Converts REB files to Oenorm
SiaConversionApi sia_conversion_convert_to_ava POST /conversion/sia/ava Converts SIA 451 files to Dangl.AVA projects
SiaConversionApi sia_conversion_convert_to_excel POST /conversion/sia/excel Converts SIA 451 files to Excel
SiaConversionApi sia_conversion_convert_to_flat_ava POST /conversion/sia/flat-ava Converts SIA 451 files to Dangl.AVA projects
SiaConversionApi sia_conversion_convert_to_gaeb POST /conversion/sia/gaeb Converts SIA 451 files to GAEB files
SiaConversionApi sia_conversion_convert_to_oenorm POST /conversion/sia/oenorm Converts SIA 451 files to Oenorm files
StatusApi status_get_status GET /status Reports the health status of the AVACloud API
UglConversionApi ugl_conversion_convert_to_ava POST /conversion/ugl/ava Converts Ugl files to Dangl.AVA projects
UglConversionApi ugl_conversion_convert_to_flat_ava POST /conversion/ugl/flat-ava Converts Ugl files to Dangl.AVA projects
ValidationApi validation_validate_file POST /validation/file This endpoint validates AVA files, typically GAEB or ÖNorm. The type of file needs to be provided as a query parameter, since there is no auto detection of the uploaded file type.
ValidationApi validation_validate_project POST /validation/project This endpoint provides a full validation of a provided ProjectDto. It will take the given exchange phase into account and do some general project validation. Optionally, a conversion to a desired target can also be done, in which case the target file will also be validated.
XRechnungConversionApi x_rechnung_conversion_convert_ava_to_x_rechnung POST /conversion/xrechnung/ava-wrapper/xrechnung This will convert an AVA wrapper object to an XRechnung file
XRechnungConversionApi x_rechnung_conversion_convert_invoice_to_x_rechnung POST /conversion/xrechnung/invoice/xrechnung This will convert an Invoice object to an XRechnung file
XRechnungConversionApi x_rechnung_conversion_convert_x_rechnung_to_ava POST /conversion/xrechnung/ava-wrapper This will read an XRechnung file and convert it to an AVA wrapper object
XRechnungConversionApi x_rechnung_conversion_convert_x_rechnung_to_invoice POST /conversion/xrechnung/invoice This will read an XRechnung file and convert it to an Invoice object

Documentation For Models

Documentation For Authorization

Dangl.Identity

Author