BmltClient

BmltClient - the Ruby gem for the BMLT

BMLT Admin API Documentation

This SDK is automatically generated by the OpenAPI Generator project:

• API version: 1.0.0
• Package version: 1.0.0
• Build package: org.openapitools.codegen.languages.RubyClientCodegen

Installation

Build a gem

To build the Ruby code into a gem:

gem build BmltClient.gemspec

Then either install the gem locally:

gem install ./BmltClient-1.0.0.gem

(for development, run gem install --dev ./BmltClient-1.0.0.gem to install the development dependencies)

or publish the gem to a gem hosting service, e.g. RubyGems.

Finally add this to the Gemfile:

gem 'BmltClient', '~> 1.0.0'

Install from Git

If the Ruby gem is hosted at a git repository: https://github.com/bmlt-enabled/bmlt-root-server-ruby-client, then add the following in the Gemfile:

gem 'BmltClient', :git => 'https://github.com/bmlt-enabled/bmlt-root-server-ruby-client.git'

Include the Ruby code directly

Include the Ruby code directly using -I as follows:

ruby -Ilib script.rb

Getting Started

Please follow the installation procedure and then run the following code:

# Load the gem
require 'BmltClient'

# Setup authorization
BmltClient.configure do |config|
  # Configure OAuth2 access token for authorization: bmltToken
  config.access_token = 'YOUR ACCESS TOKEN'
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	POST /api/v1/auth/logout	Revokes a token
BmltClient::RootServerApi	auth_refresh	POST /api/v1/auth/refresh	Revokes and issues a new token
BmltClient::RootServerApi	auth_token	POST /api/v1/auth/token	Creates a token
BmltClient::RootServerApi	create_error_test	POST /api/v1/errortest	Tests some errors
BmltClient::RootServerApi	create_format	POST /api/v1/formats	Creates a format
BmltClient::RootServerApi	create_meeting	POST /api/v1/meetings	Creates a meeting
BmltClient::RootServerApi	create_service_body	POST /api/v1/servicebodies	Creates a service body
BmltClient::RootServerApi	create_user	POST /api/v1/users	Creates a user
BmltClient::RootServerApi	delete_format	DELETE /api/v1/formats/formatId	Deletes a format
BmltClient::RootServerApi	delete_meeting	DELETE /api/v1/meetings/meetingId	Deletes a meeting
BmltClient::RootServerApi	delete_service_body	DELETE /api/v1/servicebodies/serviceBodyId	Deletes a service body
BmltClient::RootServerApi	delete_user	DELETE /api/v1/users/userId	Deletes a user
BmltClient::RootServerApi	get_format	GET /api/v1/formats/formatId	Retrieves a format
BmltClient::RootServerApi	get_formats	GET /api/v1/formats	Retrieves formats
BmltClient::RootServerApi	get_meeting	GET /api/v1/meetings/meetingId	Retrieves a meeting
BmltClient::RootServerApi	get_meetings	GET /api/v1/meetings	Retrieves meetings
BmltClient::RootServerApi	get_service_bodies	GET /api/v1/servicebodies	Retrieves service bodies
BmltClient::RootServerApi	get_service_body	GET /api/v1/servicebodies/serviceBodyId	Retrieves a service body
BmltClient::RootServerApi	get_user	GET /api/v1/users/userId	Retrieves a single user
BmltClient::RootServerApi	get_users	GET /api/v1/users	Retrieves users
BmltClient::RootServerApi	partial_update_user	PATCH /api/v1/users/userId	Patches a user
BmltClient::RootServerApi	patch_format	PATCH /api/v1/formats/formatId	Patches a format
BmltClient::RootServerApi	patch_meeting	PATCH /api/v1/meetings/meetingId	Patches a meeting
BmltClient::RootServerApi	patch_service_body	PATCH /api/v1/servicebodies/serviceBodyId	Patches a service body
BmltClient::RootServerApi	update_format	PUT /api/v1/formats/formatId	Updates a format
BmltClient::RootServerApi	update_meeting	PUT /api/v1/meetings/meetingId	Updates a meeting
BmltClient::RootServerApi	update_service_body	PUT /api/v1/servicebodies/serviceBodyId	Updates a Service Body
BmltClient::RootServerApi	update_user	PUT /api/v1/users/userId	Update single user

Documentation for Models

• BmltClient::AuthenticationError
• BmltClient::AuthorizationError
• BmltClient::ErrorTest
• BmltClient::Format
• BmltClient::FormatAllOf
• BmltClient::FormatBase
• BmltClient::FormatCreate
• BmltClient::FormatPartialUpdate
• BmltClient::FormatTranslation
• BmltClient::FormatUpdate
• BmltClient::Meeting
• BmltClient::MeetingBase
• BmltClient::MeetingCreate
• BmltClient::MeetingPartialUpdate
• BmltClient::MeetingUpdate
• BmltClient::NotFoundError
• BmltClient::ServerError
• BmltClient::ServiceBody
• BmltClient::ServiceBodyBase
• BmltClient::ServiceBodyCreate
• BmltClient::ServiceBodyPartialUpdate
• BmltClient::ServiceBodyUpdate
• BmltClient::Token
• BmltClient::TokenCredentials
• BmltClient::User
• BmltClient::UserBase
• BmltClient::UserCreate
• BmltClient::UserCreateAllOf
• BmltClient::UserPartialUpdate
• BmltClient::UserUpdate
• BmltClient::ValidationError

Documentation for Authorization

bmltToken

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