finspot-sdk

FinspotSDK - the Ruby gem for the Finspot API

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: 1.0.0
• Package version: 0.0.2
• Generator version: 7.8.0-SNAPSHOT
• Build package: org.openapitools.codegen.languages.RubyClientCodegen

Installation

Build a gem

To build the Ruby code into a gem:

gem build finspot-sdk.gemspec

Then either install the gem locally:

gem install ./finspot-sdk-0.0.2.gem

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

Install from Git

If the Ruby gem is hosted at a git repository: https://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile:

gem 'finspot-sdk', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.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 'finspot-sdk'

api_instance = FinspotSDK::DefaultApi.new

begin
  #Enquire health
  api_instance.up_get
rescue FinspotSDK::ApiError => e
  puts "Exception when calling DefaultApi->up_get: #{e}"
end

Documentation for API Endpoints

All URIs are relative to http://localhost

Class	Method	HTTP request	Description
FinspotSDK::DefaultApi	up_get	GET /up	Enquire health

Documentation for Models

Documentation for Authorization

Endpoints do not require authorization.