openapi_client

OpenapiClient - the Ruby gem for the API V1

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

This SDK is automatically generated by the OpenAPI Generator project:

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

Installation

Build a gem

To build the Ruby code into a gem:

gem build openapi_client.gemspec

Then either install the gem locally:

gem install ./openapi_client-1.0.0.gem

(for development, run gem install --dev ./openapi_client-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 'openapi_client', '~> 1.0.0'

Install from Git

If the Ruby gem is hosted at a git repository: https:///YOUR_GIT_USERNAME/YOUR_GIT_REPO, then add the following in the Gemfile:

gem 'openapi_client', :git => 'https:///YOUR_GIT_USERNAME/YOUR_GIT_REPO.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 'openapi_client'

api_instance = OpenapiClient::AppsApi.new
access_token = 'access_token_example' # String | 
opts = {
  app: OpenapiClient::App.new # App | 
}

begin
  #create app
  api_instance.create_app(access_token, opts)
rescue OpenapiClient::ApiError => e
  puts "Exception when calling AppsApi->create_app: #{e}"
end

Documentation for API Endpoints

All URIs are relative to http://127.0.0.1:3085

Class	Method	HTTP request	Description
OpenapiClient::AppsApi	create_app	POST /api/v1/apps	create app
OpenapiClient::AppsApi	delete_app	DELETE /api/v1/apps/id	delete app
OpenapiClient::AppsApi	get_app	GET /api/v1/apps/id	show app
OpenapiClient::AppsApi	get_apps	GET /api/v1/apps	list apps
OpenapiClient::AppsApi	patch_app	PATCH /api/v1/apps/id	update app
OpenapiClient::AppsApi	update_app	PUT /api/v1/apps/id	update app
OpenapiClient::AuthApi	auth_validate_token_get	GET /auth/validate_token	validates a token
OpenapiClient::UsersApi	add_role_to_user	POST /api/v1/users/user_id/roles	add role to user
OpenapiClient::UsersApi	delete_role_from_user	DELETE /api/v1/users/user_id/roles/role_id	delete role
OpenapiClient::UsersApi	delete_user	DELETE /api/v1/users/id	delete user
OpenapiClient::UsersApi	get_user	GET /api/v1/users/id	show user
OpenapiClient::UsersApi	get_user_roles	GET /api/v1/users/user_id/roles	list roles of a user
OpenapiClient::UsersApi	get_users	GET /api/v1/users	list users
OpenapiClient::UsersApi	patch_user	PATCH /api/v1/users/id	update user
OpenapiClient::UsersApi	update_user	PUT /api/v1/users/id	update user

Documentation for Models

• OpenapiClient::App
• OpenapiClient::AuthValidateTokenGet200Response
• OpenapiClient::Role
• OpenapiClient::User
• OpenapiClient::UserAppAdd
• OpenapiClient::UserRoleAdd

Documentation for Authorization

Endpoints do not require authorization.