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

Class	Method	HTTP request	Description
RootServerApi	auth_logout	POST /api/v1/auth/logout	Revokes a token
RootServerApi	auth_refresh	POST /api/v1/auth/refresh	Revokes and issues a new token
RootServerApi	auth_token	POST /api/v1/auth/token	Creates a token
RootServerApi	create_error_test	POST /api/v1/errortest	Tests some errors
RootServerApi	create_format	POST /api/v1/formats	Creates a format
RootServerApi	create_meeting	POST /api/v1/meetings	Creates a meeting
RootServerApi	create_service_body	POST /api/v1/servicebodies	Creates a service body
RootServerApi	create_user	POST /api/v1/users	Creates a user
RootServerApi	delete_format	DELETE /api/v1/formats/{formatId}	Deletes a format
RootServerApi	delete_meeting	DELETE /api/v1/meetings/{meetingId}	Deletes a meeting
RootServerApi	delete_service_body	DELETE /api/v1/servicebodies/{serviceBodyId}	Deletes a service body
RootServerApi	delete_user	DELETE /api/v1/users/{userId}	Deletes a user
RootServerApi	get_format	GET /api/v1/formats/{formatId}	Retrieves a format
RootServerApi	get_formats	GET /api/v1/formats	Retrieves formats
RootServerApi	get_laravel_log	GET /api/v1/logs/laravel	Retrieves laravel log
RootServerApi	get_meeting	GET /api/v1/meetings/{meetingId}	Retrieves a meeting
RootServerApi	get_meeting_changes	GET /api/v1/meetings/{meetingId}/changes	Retrieve changes for a meeting
RootServerApi	get_meetings	GET /api/v1/meetings	Retrieves meetings
RootServerApi	get_root_server	GET /api/v1/rootservers/{rootServerId}	Retrieves a root server
RootServerApi	get_root_servers	GET /api/v1/rootservers	Retrieves root servers
RootServerApi	get_service_bodies	GET /api/v1/servicebodies	Retrieves service bodies
RootServerApi	get_service_body	GET /api/v1/servicebodies/{serviceBodyId}	Retrieves a service body
RootServerApi	get_user	GET /api/v1/users/{userId}	Retrieves a single user
RootServerApi	get_users	GET /api/v1/users	Retrieves users
RootServerApi	partial_update_user	PATCH /api/v1/users/{userId}	Patches a user
RootServerApi	patch_format	PATCH /api/v1/formats/{formatId}	Patches a format
RootServerApi	patch_meeting	PATCH /api/v1/meetings/{meetingId}	Patches a meeting
RootServerApi	patch_service_body	PATCH /api/v1/servicebodies/{serviceBodyId}	Patches a service body
RootServerApi	update_format	PUT /api/v1/formats/{formatId}	Updates a format
RootServerApi	update_meeting	PUT /api/v1/meetings/{meetingId}	Updates a meeting
RootServerApi	update_service_body	PUT /api/v1/servicebodies/{serviceBodyId}	Updates a Service Body
RootServerApi	update_user	PUT /api/v1/users/{userId}	Update single user

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