dangl/avacloud

0.1.17 2019-10-30 10:10 UTC

This package is auto-updated.

Last update: 2020-07-30 01:32:52 UTC


README

Please see the offical site for more information and further documentation: https://www.dangl-it.com/products/avacloud-gaeb-saas/
To get started, you can use the PHP demo application: https://github.com/Dangl-IT/avacloud-demo-php

AVACloud API specification

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

  • API version: 1.12.0
  • Package version: 1.12.0
  • Build package: io.swagger.codegen.languages.PhpClientCodegen

Requirements

PHP 5.5 and later

Installation & Usage

Composer

To install the bindings via Composer, add the following to composer.json:

{
  "repositories": [
    {
      "type": "git",
      "url": "https://github.com/Dangl-IT/avacloud-client-php.git"
    }
  ],
  "require": {
    "dangl/avacloud": "*@dev"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

    require_once('/path/to/Dangl\AVACloud/vendor/autoload.php');

Tests

To run the unit tests:

composer install
./vendor/bin/phpunit

Getting Started

Please follow the installation procedure and then run the following:

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure OAuth2 access token for authorization: Dangl.Identity
$config = Dangl\AVACloud\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$apiInstance = new Dangl\AVACloud\Api\AslvConversionApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$aslv_file = "/path/to/file.txt"; // \SplFileObject | The input file
$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
$remove_html_long_texts = true; // bool | If set to true, html long texts will be removed from the output to reduce response sizes

try {
    $result = $apiInstance->aslvConversionConvertToAva($aslv_file, $remove_plain_text_long_texts, $remove_html_long_texts);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AslvConversionApi->aslvConversionConvertToAva: ', $e->getMessage(), PHP_EOL;
}

?>

Documentation for API Endpoints

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

Class Method HTTP request Description
AslvConversionApi aslvConversionConvertToAva POST /conversion/aslv/ava Converts Aslv files to Dangl.AVA projects
AslvConversionApi aslvConversionConvertToExcel POST /conversion/aslv/excel Converts Aslv files to Excel
AslvConversionApi aslvConversionConvertToGaeb POST /conversion/aslv/gaeb Converts Aslv files to GAEB files
AslvConversionApi aslvConversionConvertToOenorm POST /conversion/aslv/oenorm Converts Aslv files to Oenorm files
AvaConversionApi avaConversionConvertToAva POST /conversion/ava/ava Converts Dangl.AVA projects to Dangl.AVA. This is useful when you want to generate the calculated properties.
AvaConversionApi avaConversionConvertToExcel POST /conversion/ava/excel Converts Dangl.AVA projects to Excel
AvaConversionApi avaConversionConvertToGaeb POST /conversion/ava/gaeb Converts Dangl.AVA projects to GAEB
AvaConversionApi avaConversionConvertToOenorm POST /conversion/ava/oenorm Converts Dangl.AVA projects to Oenorm
AvaConversionApi avaConversionConvertToReb POST /conversion/ava/reb Converts Dangl.AVA projects to REB
AvaConversionApi avaConversionConvertToSia POST /conversion/ava/sia Converts Dangl.AVA projects to SIA 451
DanglIdentityApi danglIdentityLoginAndReturnToken POST /identity/token-login
DanglIdentityApi danglIdentityLoginWithCookie POST /identity/login
DanglIdentityApi danglIdentityRefreshToken POST /identity/token-refresh
DanglIdentityApi danglIdentityRegister POST /identity/register
DanglIdentityApi danglIdentityRequestPasswordReset POST /identity/password-forgotten
DanglIdentityApi danglIdentitySignOutWithSignInManager DELETE /identity/login
ExcelConversionApi excelConversionConvertToAva POST /conversion/excel/ava Converts Excel files to Dangl.AVA projects.
ExcelConversionApi excelConversionConvertToExcel 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 excelConversionConvertToGaeb POST /conversion/excel/gaeb Converts Excel files to GAEB files.
ExcelConversionApi excelConversionConvertToOenorm POST /conversion/excel/oenorm Converts Excel files to Oenorm files.
GaebConversionApi gaebConversionConvertToAva POST /conversion/gaeb/ava Converts GAEB files to Dangl.AVA projects
GaebConversionApi gaebConversionConvertToExcel POST /conversion/gaeb/excel Converts GAEB files to Excel
GaebConversionApi gaebConversionConvertToGaeb POST /conversion/gaeb/gaeb Converts GAEB files to GAEB files. Used for example when transforming or repairing GAEB files.
GaebConversionApi gaebConversionConvertToOenorm POST /conversion/gaeb/oenorm Converts GAEB files to Oenorm files
OenormConversionApi oenormConversionConvertToAva POST /conversion/oenorm/ava Converts ÖNorm files to Dangl.AVA projects
OenormConversionApi oenormConversionConvertToExcel POST /conversion/oenorm/excel Converts ÖNorm files to Excel
OenormConversionApi oenormConversionConvertToGaeb POST /conversion/oenorm/gaeb Converts ÖNorm files to GAEB files.
OenormConversionApi oenormConversionConvertToOenorm POST /conversion/oenorm/oenorm Converts ÖNorm files to Oenorm files.
RebConversionApi rebConversionConvertToAva POST /conversion/reb/ava Converts REB files to Dangl.AVA projects
RebConversionApi rebConversionConvertToExcel POST /conversion/reb/excel Converts REB files to Excel
RebConversionApi rebConversionConvertToGaeb POST /conversion/reb/gaeb Converts REB files to GAEB files
RebConversionApi rebConversionConvertToOenorm POST /conversion/reb/oenorm Converts REB files to Oenorm
SiaConversionApi siaConversionConvertToAva POST /conversion/sia/ava Converts SIA 451 files to Dangl.AVA projects
SiaConversionApi siaConversionConvertToExcel POST /conversion/sia/excel Converts SIA 451 files to Excel
SiaConversionApi siaConversionConvertToGaeb POST /conversion/sia/gaeb Converts SIA 451 files to GAEB files
SiaConversionApi siaConversionConvertToOenorm POST /conversion/sia/oenorm Converts SIA 451 files to Oenorm files
StatusApi statusGetStatus GET /status Reports the health status of the AVACloud API

Documentation For Models

Documentation For Authorization

Dangl.Identity

Author