README

BMLT Admin API Documentation

Installation & Usage

Requirements

PHP 8.1 and later.

Composer

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

{
  "repositories": [
    {
      "type": "vcs",
      "url": "https://github.com/bmlt-enabled/bmlt-server-php-client.git"
    }
  ],
  "require": {
    "bmlt-enabled/bmlt-server-php-client": "*@dev"
  }
}

Then run composer install

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


$apiInstance = new OpenAPI\Client\Api\RootServerApi(
    // 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
);

try {
    $apiInstance->authLogout();
} catch (Exception $e) {
    echo 'Exception when calling RootServerApi->authLogout: ', $e->getMessage(), PHP_EOL;
}

API Endpoints

All URIs are relative to http://localhost:8000/main_server

Models

• AuthenticationError
• AuthorizationError
• ConflictError
• ErrorTest
• Format
• FormatBase
• FormatCreate
• FormatPartialUpdate
• FormatTranslation
• FormatUpdate
• Meeting
• MeetingBase
• MeetingChangeResource
• MeetingCreate
• MeetingPartialUpdate
• MeetingUpdate
• NotFoundError
• RootServer
• RootServerBase
• RootServerBaseStatistics
• RootServerBaseStatisticsMeetings
• RootServerBaseStatisticsServiceBodies
• ServerError
• ServiceBody
• ServiceBodyBase
• ServiceBodyCreate
• ServiceBodyPartialUpdate
• ServiceBodyUpdate
• SettingsBase
• SettingsObject
• SettingsUpdate
• Token
• TokenCredentials
• User
• UserBase
• UserCreate
• UserPartialUpdate
• UserUpdate
• ValidationError

Authorization

Authentication schemes defined for the API:

bmltToken

• Type: OAuth
• Flow: password
• Authorization URL: ``
• Scopes: N/A

Tests

To run the tests, use:

composer install
vendor/bin/phpunit

Author

About this package

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

• API version: 1.0.0
  • Package version: 1.1.1
  • Generator version: 7.20.0-SNAPSHOT
• Build package: org.openapitools.codegen.languages.PhpClientCodegen