https://github.com/bmlt-enabled/bmlt-server-ruby-client
Ruby Client for BMLT Admin API
https://github.com/bmlt-enabled/bmlt-server-ruby-client
Last synced: 4 days ago
JSON representation
Ruby Client for BMLT Admin API
- Host: GitHub
- URL: https://github.com/bmlt-enabled/bmlt-server-ruby-client
- Owner: bmlt-enabled
- Created: 2022-10-24T15:54:59.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2026-02-09T02:20:13.000Z (5 months ago)
- Last Synced: 2026-02-09T08:19:47.276Z (5 months ago)
- Language: Ruby
- Homepage: https://rubygems.org/gems/BmltClient
- Size: 167 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# BmltClient
BmltClient - the Ruby gem for the BMLT
BMLT Admin API Documentation
This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
- API version: 1.0.0
- Package version: 1.0.1
- Generator version: 7.20.0-SNAPSHOT
- Build package: org.openapitools.codegen.languages.RubyClientCodegen
## Installation
### Build a gem
To build the Ruby code into a gem:
```shell
gem build BmltClient.gemspec
```
Then either install the gem locally:
```shell
gem install ./BmltClient-1.0.1.gem
```
(for development, run `gem install --dev ./BmltClient-1.0.1.gem` to install the development dependencies)
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
Finally add this to the Gemfile:
gem 'BmltClient', '~> 1.0.1'
### Install from Git
If the Ruby gem is hosted at a git repository: https://github.com/bmlt-enabled/bmlt-server-ruby-client, then add the following in the Gemfile:
gem 'BmltClient', :git => 'https://github.com/bmlt-enabled/bmlt-server-ruby-client.git'
### Include the Ruby code directly
Include the Ruby code directly using `-I` as follows:
```shell
ruby -Ilib script.rb
```
## Getting Started
Please follow the [installation](#installation) procedure and then run the following code:
```ruby
# Load the gem
require 'BmltClient'
# Setup authorization
BmltClient.configure do |config|
# Configure OAuth2 access token for authorization: bmltToken
config.access_token = 'YOUR ACCESS TOKEN'
# Configure a proc to get access tokens in lieu of the static access_token configuration
config.access_token_getter = -> { 'YOUR TOKEN GETTER PROC' }
end
api_instance = BmltClient::RootServerApi.new
begin
#Revokes a token
api_instance.auth_logout
rescue BmltClient::ApiError => e
puts "Exception when calling RootServerApi->auth_logout: #{e}"
end
```
## Documentation for API Endpoints
All URIs are relative to *http://localhost:8000/main_server*
Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*BmltClient::RootServerApi* | [**auth_logout**](docs/RootServerApi.md#auth_logout) | **POST** /api/v1/auth/logout | Revokes a token
*BmltClient::RootServerApi* | [**auth_refresh**](docs/RootServerApi.md#auth_refresh) | **POST** /api/v1/auth/refresh | Revokes and issues a new token
*BmltClient::RootServerApi* | [**auth_token**](docs/RootServerApi.md#auth_token) | **POST** /api/v1/auth/token | Creates a token
*BmltClient::RootServerApi* | [**create_error_test**](docs/RootServerApi.md#create_error_test) | **POST** /api/v1/errortest | Tests some errors
*BmltClient::RootServerApi* | [**create_format**](docs/RootServerApi.md#create_format) | **POST** /api/v1/formats | Creates a format
*BmltClient::RootServerApi* | [**create_meeting**](docs/RootServerApi.md#create_meeting) | **POST** /api/v1/meetings | Creates a meeting
*BmltClient::RootServerApi* | [**create_service_body**](docs/RootServerApi.md#create_service_body) | **POST** /api/v1/servicebodies | Creates a service body
*BmltClient::RootServerApi* | [**create_user**](docs/RootServerApi.md#create_user) | **POST** /api/v1/users | Creates a user
*BmltClient::RootServerApi* | [**delete_format**](docs/RootServerApi.md#delete_format) | **DELETE** /api/v1/formats/{formatId} | Deletes a format
*BmltClient::RootServerApi* | [**delete_meeting**](docs/RootServerApi.md#delete_meeting) | **DELETE** /api/v1/meetings/{meetingId} | Deletes a meeting
*BmltClient::RootServerApi* | [**delete_service_body**](docs/RootServerApi.md#delete_service_body) | **DELETE** /api/v1/servicebodies/{serviceBodyId} | Deletes a service body
*BmltClient::RootServerApi* | [**delete_user**](docs/RootServerApi.md#delete_user) | **DELETE** /api/v1/users/{userId} | Deletes a user
*BmltClient::RootServerApi* | [**get_format**](docs/RootServerApi.md#get_format) | **GET** /api/v1/formats/{formatId} | Retrieves a format
*BmltClient::RootServerApi* | [**get_formats**](docs/RootServerApi.md#get_formats) | **GET** /api/v1/formats | Retrieves formats
*BmltClient::RootServerApi* | [**get_laravel_log**](docs/RootServerApi.md#get_laravel_log) | **GET** /api/v1/logs/laravel | Retrieves laravel log
*BmltClient::RootServerApi* | [**get_meeting**](docs/RootServerApi.md#get_meeting) | **GET** /api/v1/meetings/{meetingId} | Retrieves a meeting
*BmltClient::RootServerApi* | [**get_meeting_changes**](docs/RootServerApi.md#get_meeting_changes) | **GET** /api/v1/meetings/{meetingId}/changes | Retrieve changes for a meeting
*BmltClient::RootServerApi* | [**get_meetings**](docs/RootServerApi.md#get_meetings) | **GET** /api/v1/meetings | Retrieves meetings
*BmltClient::RootServerApi* | [**get_root_server**](docs/RootServerApi.md#get_root_server) | **GET** /api/v1/rootservers/{rootServerId} | Retrieves a root server
*BmltClient::RootServerApi* | [**get_root_servers**](docs/RootServerApi.md#get_root_servers) | **GET** /api/v1/rootservers | Retrieves root servers
*BmltClient::RootServerApi* | [**get_service_bodies**](docs/RootServerApi.md#get_service_bodies) | **GET** /api/v1/servicebodies | Retrieves service bodies
*BmltClient::RootServerApi* | [**get_service_body**](docs/RootServerApi.md#get_service_body) | **GET** /api/v1/servicebodies/{serviceBodyId} | Retrieves a service body
*BmltClient::RootServerApi* | [**get_settings**](docs/RootServerApi.md#get_settings) | **GET** /api/v1/settings | Retrieves all settings
*BmltClient::RootServerApi* | [**get_user**](docs/RootServerApi.md#get_user) | **GET** /api/v1/users/{userId} | Retrieves a single user
*BmltClient::RootServerApi* | [**get_users**](docs/RootServerApi.md#get_users) | **GET** /api/v1/users | Retrieves users
*BmltClient::RootServerApi* | [**partial_update_user**](docs/RootServerApi.md#partial_update_user) | **PATCH** /api/v1/users/{userId} | Patches a user
*BmltClient::RootServerApi* | [**patch_format**](docs/RootServerApi.md#patch_format) | **PATCH** /api/v1/formats/{formatId} | Patches a format
*BmltClient::RootServerApi* | [**patch_meeting**](docs/RootServerApi.md#patch_meeting) | **PATCH** /api/v1/meetings/{meetingId} | Patches a meeting
*BmltClient::RootServerApi* | [**patch_service_body**](docs/RootServerApi.md#patch_service_body) | **PATCH** /api/v1/servicebodies/{serviceBodyId} | Patches a service body
*BmltClient::RootServerApi* | [**update_format**](docs/RootServerApi.md#update_format) | **PUT** /api/v1/formats/{formatId} | Updates a format
*BmltClient::RootServerApi* | [**update_meeting**](docs/RootServerApi.md#update_meeting) | **PUT** /api/v1/meetings/{meetingId} | Updates a meeting
*BmltClient::RootServerApi* | [**update_service_body**](docs/RootServerApi.md#update_service_body) | **PUT** /api/v1/servicebodies/{serviceBodyId} | Updates a Service Body
*BmltClient::RootServerApi* | [**update_settings**](docs/RootServerApi.md#update_settings) | **PATCH** /api/v1/settings | Update settings
*BmltClient::RootServerApi* | [**update_user**](docs/RootServerApi.md#update_user) | **PUT** /api/v1/users/{userId} | Update single user
## Documentation for Models
- [BmltClient::AuthenticationError](docs/AuthenticationError.md)
- [BmltClient::AuthorizationError](docs/AuthorizationError.md)
- [BmltClient::ConflictError](docs/ConflictError.md)
- [BmltClient::ErrorTest](docs/ErrorTest.md)
- [BmltClient::Format](docs/Format.md)
- [BmltClient::FormatBase](docs/FormatBase.md)
- [BmltClient::FormatCreate](docs/FormatCreate.md)
- [BmltClient::FormatPartialUpdate](docs/FormatPartialUpdate.md)
- [BmltClient::FormatTranslation](docs/FormatTranslation.md)
- [BmltClient::FormatUpdate](docs/FormatUpdate.md)
- [BmltClient::Meeting](docs/Meeting.md)
- [BmltClient::MeetingBase](docs/MeetingBase.md)
- [BmltClient::MeetingChangeResource](docs/MeetingChangeResource.md)
- [BmltClient::MeetingCreate](docs/MeetingCreate.md)
- [BmltClient::MeetingPartialUpdate](docs/MeetingPartialUpdate.md)
- [BmltClient::MeetingUpdate](docs/MeetingUpdate.md)
- [BmltClient::NotFoundError](docs/NotFoundError.md)
- [BmltClient::RootServer](docs/RootServer.md)
- [BmltClient::RootServerBase](docs/RootServerBase.md)
- [BmltClient::RootServerBaseStatistics](docs/RootServerBaseStatistics.md)
- [BmltClient::RootServerBaseStatisticsMeetings](docs/RootServerBaseStatisticsMeetings.md)
- [BmltClient::RootServerBaseStatisticsServiceBodies](docs/RootServerBaseStatisticsServiceBodies.md)
- [BmltClient::ServerError](docs/ServerError.md)
- [BmltClient::ServiceBody](docs/ServiceBody.md)
- [BmltClient::ServiceBodyBase](docs/ServiceBodyBase.md)
- [BmltClient::ServiceBodyCreate](docs/ServiceBodyCreate.md)
- [BmltClient::ServiceBodyPartialUpdate](docs/ServiceBodyPartialUpdate.md)
- [BmltClient::ServiceBodyUpdate](docs/ServiceBodyUpdate.md)
- [BmltClient::SettingsBase](docs/SettingsBase.md)
- [BmltClient::SettingsObject](docs/SettingsObject.md)
- [BmltClient::SettingsUpdate](docs/SettingsUpdate.md)
- [BmltClient::Token](docs/Token.md)
- [BmltClient::TokenCredentials](docs/TokenCredentials.md)
- [BmltClient::User](docs/User.md)
- [BmltClient::UserBase](docs/UserBase.md)
- [BmltClient::UserCreate](docs/UserCreate.md)
- [BmltClient::UserPartialUpdate](docs/UserPartialUpdate.md)
- [BmltClient::UserUpdate](docs/UserUpdate.md)
- [BmltClient::ValidationError](docs/ValidationError.md)
## Documentation for Authorization
Authentication schemes defined for the API:
### bmltToken
- **Type**: OAuth
- **Flow**: password
- **Authorization URL**:
- **Scopes**: N/A