triglav_client

TriglavClient - the Ruby gem for the Triglav API

Triglav API Reference

This SDK is automatically generated by the Swagger Codegen project:

• API version: 1.0.0
• Package version: 1.0.0
• Build date: 2017-04-19T18:47:18.255+09:00
• Build package: class io.swagger.codegen.languages.RubyClientCodegen

Installation

Build a gem

To build the Ruby code into a gem:

gem build triglav_client.gemspec

Then either install the gem locally:

gem install ./triglav_client-1.0.0.gem

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

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 'triglav_client', :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 'triglav_client'

api_instance = TriglavClient::AuthApi.new

credential = TriglavClient::Credential.new # Credential | 


begin
  result = api_instance.create_token(credential)
  p result
rescue TriglavClient::ApiError => e
  puts "Exception when calling AuthApi->create_token: #{e}"
end

Documentation for API Endpoints

All URIs are relative to http://localhost/api/v1

Class	Method	HTTP request	Description
TriglavClient::AuthApi	create_token	POST /auth/token
TriglavClient::AuthApi	delete_token	DELETE /auth/token
TriglavClient::AuthApi	me	GET /auth/me
TriglavClient::JobMessagesApi	fetch_job_messages	GET /job_messages
TriglavClient::JobMessagesApi	get_last_job_message_id	GET /job_messages/last_id
TriglavClient::JobsApi	create_or_update_job	PATCH /jobs
TriglavClient::JobsApi	delete_job	DELETE /jobs/id_or_uri
TriglavClient::JobsApi	get_job	GET /jobs/id_or_uri
TriglavClient::JobsApi	list_jobs	GET /jobs
TriglavClient::MessagesApi	fetch_messages	GET /messages
TriglavClient::MessagesApi	get_last_message_id	GET /messages/last_id
TriglavClient::MessagesApi	send_messages	POST /messages
TriglavClient::ResourcesApi	create_resource	POST /resources
TriglavClient::ResourcesApi	delete_resource	DELETE /resources/id_or_uri
TriglavClient::ResourcesApi	get_resource	GET /resources/id_or_uri
TriglavClient::ResourcesApi	list_aggregated_resources	GET /aggregated_resources
TriglavClient::ResourcesApi	list_resources	GET /resources
TriglavClient::ResourcesApi	update_resource	PATCH /resources/id_or_uri
TriglavClient::UsersApi	create_user	POST /users
TriglavClient::UsersApi	delete_user	DELETE /users/id
TriglavClient::UsersApi	get_user	GET /users/id
TriglavClient::UsersApi	list_users	GET /users
TriglavClient::UsersApi	update_user	PATCH /users/id

Documentation for Models

• TriglavClient::AggregatedResourceEachResponse
• TriglavClient::BulkinsertResponse
• TriglavClient::Credential
• TriglavClient::ErrorModel
• TriglavClient::JobEachResponse
• TriglavClient::JobMessageEachResponse
• TriglavClient::JobRequest
• TriglavClient::JobResponse
• TriglavClient::LastJobMessageIdResponse
• TriglavClient::LastMessageIdResponse
• TriglavClient::MessageEachResponse
• TriglavClient::MessageFetchRequest
• TriglavClient::MessageRequest
• TriglavClient::MessageResponse
• TriglavClient::ResourceEachResponse
• TriglavClient::ResourceRequest
• TriglavClient::ResourceResponse
• TriglavClient::TokenResponse
• TriglavClient::UserEachResponse
• TriglavClient::UserRequest
• TriglavClient::UserResponse

Documentation for Authorization

api_key

• Type: API key
• API key parameter name: Authorization
• Location: HTTP header