README

iparapheur v5.x main core application.

The main link between every sub-services, integrating business code logic.

For more information, please visit https://libriciel.fr.

Installation & Usage

Requirements

PHP 7.2 and later.

Composer

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

{
  "repositories": [
    {
      "type": "vcs",
      "url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git"
    }
  ],
  "require": {
    "GIT_USER_ID/GIT_REPO_ID": "*@dev"
  }
}

Then run composer install

Your project is free to choose the http client of your choice Please require packages that will provide http client functionality: https://packagist.org/providers/psr/http-client-implementation https://packagist.org/providers/php-http/async-client-implementation https://packagist.org/providers/psr/http-factory-implementation

As an example:

composer require guzzlehttp/guzzle php-http/guzzle7-adapter http-interop/http-factory-guzzle

Manual Installation

Download the files and include autoload.php:

<?php
require_once('/path/to/OpenAPIClient-php/vendor/autoload.php');

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: spring_oauth
$config = Libriciel\IparapheurV5\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Libriciel\IparapheurV5\Client\Api\AdminTrashBinApi(
    // If you want use custom http client, pass your client which implements `Psr\Http\Client\ClientInterface`.
    // This is optional, `Psr18ClientDiscovery` will be used to find http client. For instance `GuzzleHttp\Client` implements that interface
    new GuzzleHttp\Client(),
    $config
);
$tenant_id = 'tenant_id_example'; // string | Tenant id
$folder_id = 'folder_id_example'; // string | Folder id

try {
    $apiInstance->deleteTrashBinFolder($tenant_id, $folder_id);
} catch (Exception $e) {
    echo 'Exception when calling AdminTrashBinApi->deleteTrashBinFolder: ', $e->getMessage(), PHP_EOL;
}

API Endpoints

All URIs are relative to http://localhost:8080

Models

• Action
• DeskRepresentation
• DeskSortBy
• ErrorResponse
• FolderRepresentation
• FolderSortBy
• MailParams
• PageFolderRepresentation
• PageableObject
• SealTaskParams
• SimpleTaskParams
• SortObject
• StandardApiPageImplDeskRepresentation
• StandardApiPageImplFolderRepresentation
• StandardApiPageImplSubtypeRepresentation
• StandardApiPageImplTenantRepresentation
• StandardApiPageImplTypeRepresentation
• StandardApiPageable
• StandardApiSort
• State
• SubtypeRepresentation
• SubtypeSortBy
• TenantRepresentation
• TenantSortBy
• TypeRepresentation
• TypeSortBy

Authorization

spring_oauth

• Type: OAuth
• Flow: accessCode
• Authorization URL: ./auth/realms/api/protocol/openid-connect/auth
• Scopes: N/A

Tests

To run the tests, use:

composer install
vendor/bin/phpunit

Author

iparapheur@libriciel.coop

About this package

This PHP package is automatically generated by the OpenAPI Generator project:

• API version: DEVELOP
  • Generator version: 7.14.0
• Build package: org.openapitools.codegen.languages.PhpClientCodegen