bmlt-server-client

BMLT Admin API Documentation

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

• API version: 1.0.0
• Package version: 1.0.0
• Generator version: 7.14.0-SNAPSHOT
• Build package: org.openapitools.codegen.languages.PythonClientCodegen

Requirements.

Python 3.9+

Installation & Usage

pip install

If the python package is hosted on a repository, you can install directly using:

pip install git+https://github.com/bmlt-enabled/bmlt-server-python-client.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/bmlt-enabled/bmlt-server-python-client.git)

Then import the package:

import bmlt_client

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 bmlt_client

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import bmlt_client
from bmlt_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost:8000/main_server
# See configuration.py for a list of all supported configuration parameters.
configuration = bmlt_client.Configuration(
    host = "http://localhost:8000/main_server"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

configuration.access_token = os.environ["ACCESS_TOKEN"]


# Enter a context with an instance of the API client
with bmlt_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = bmlt_client.RootServerApi(api_client)

    try:
        # Revokes a token
        api_instance.auth_logout()
    except ApiException as e:
        print("Exception when calling RootServerApi->auth_logout: %s\n" % e)

Documentation for API Endpoints

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

Documentation For 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
• Token
• TokenCredentials
• User
• UserBase
• UserCreate
• UserPartialUpdate
• UserUpdate
• ValidationError

Documentation For Authorization

Authentication schemes defined for the API:

bmltToken

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

Author