README

BMLT Admin API Documentation

Installation & Usage

Requirements

PHP 7.4 and later. Should also work with PHP 8.0.

Composer

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

{
  "repositories": [
    {
      "type": "vcs",
      "url": "https://github.com/bmlt-enabled/bmlt-root-server-php-client.git"
    }
  ],
  "require": {
    "bmlt-enabled/bmlt-root-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

Class	Method	HTTP request	Description
RootServerApi	authLogout	POST /api/v1/auth/logout	Revokes a token
RootServerApi	authRefresh	POST /api/v1/auth/refresh	Revokes and issues a new token
RootServerApi	authToken	POST /api/v1/auth/token	Creates a token
RootServerApi	createErrorTest	POST /api/v1/errortest	Tests some errors
RootServerApi	createFormat	POST /api/v1/formats	Creates a format
RootServerApi	createMeeting	POST /api/v1/meetings	Creates a meeting
RootServerApi	createServiceBody	POST /api/v1/servicebodies	Creates a service body
RootServerApi	createUser	POST /api/v1/users	Creates a user
RootServerApi	deleteFormat	DELETE /api/v1/formats/{formatId}	Deletes a format
RootServerApi	deleteMeeting	DELETE /api/v1/meetings/{meetingId}	Deletes a meeting
RootServerApi	deleteServiceBody	DELETE /api/v1/servicebodies/{serviceBodyId}	Deletes a service body
RootServerApi	deleteUser	DELETE /api/v1/users/{userId}	Deletes a user
RootServerApi	getFormat	GET /api/v1/formats/{formatId}	Retrieves a format
RootServerApi	getFormats	GET /api/v1/formats	Retrieves formats
RootServerApi	getMeeting	GET /api/v1/meetings/{meetingId}	Retrieves a meeting
RootServerApi	getMeetings	GET /api/v1/meetings	Retrieves meetings
RootServerApi	getRootServer	GET /api/v1/rootservers/{rootServerId}	Retrieves a root server
RootServerApi	getRootServers	GET /api/v1/rootservers	Retrieves root servers
RootServerApi	getServiceBodies	GET /api/v1/servicebodies	Retrieves service bodies
RootServerApi	getServiceBody	GET /api/v1/servicebodies/{serviceBodyId}	Retrieves a service body
RootServerApi	getUser	GET /api/v1/users/{userId}	Retrieves a single user
RootServerApi	getUsers	GET /api/v1/users	Retrieves users
RootServerApi	partialUpdateUser	PATCH /api/v1/users/{userId}	Patches a user
RootServerApi	patchFormat	PATCH /api/v1/formats/{formatId}	Patches a format
RootServerApi	patchMeeting	PATCH /api/v1/meetings/{meetingId}	Patches a meeting
RootServerApi	patchServiceBody	PATCH /api/v1/servicebodies/{serviceBodyId}	Patches a service body
RootServerApi	updateFormat	PUT /api/v1/formats/{formatId}	Updates a format
RootServerApi	updateMeeting	PUT /api/v1/meetings/{meetingId}	Updates a meeting
RootServerApi	updateServiceBody	PUT /api/v1/servicebodies/{serviceBodyId}	Updates a Service Body
RootServerApi	updateUser	PUT /api/v1/users/{userId}	Update single user

Models

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.0.4
Build package: org.openapitools.codegen.languages.PhpClientCodegen

bmlt-enabled / bmlt-root-server-php-client

Maintainers

Details