cloudmersive-configuration-api-client

CloudmersiveConfigurationApiClient - the Ruby gem for the configapi

Config API lets you easily manage configuration at scale.

This SDK is automatically generated by the Swagger Codegen project:

• API version: v1
• Package version: 1.7.2
• Build package: io.swagger.codegen.languages.RubyClientCodegen

Installation

Build a gem

To build the Ruby code into a gem:

gem build cloudmersive-configuration-api-client.gemspec

Then either install the gem locally:

gem install ./cloudmersive-configuration-api-client-1.7.2.gem

(for development, run gem install --dev ./cloudmersive-configuration-api-client-1.7.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 'cloudmersive-configuration-api-client', '~> 1.7.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 'cloudmersive-configuration-api-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 'cloudmersive-configuration-api-client'

# Setup authorization
CloudmersiveConfigurationApiClient.configure do |config|
  # Configure API key authorization: Apikey
  config.api_key['Apikey'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['Apikey'] = 'Bearer'
end

api_instance = CloudmersiveConfigurationApiClient::OrchestratorApi.new

request = CloudmersiveConfigurationApiClient::HttpOrchestrationRequest.new # HttpOrchestrationRequest | 


begin
  #Orchestrate multiple HTTP API calls with a single API call in the order specified.  Call other Cloudmersive APIs or third party APIs.  For Cloudmersive APIs, the API Key will automatically propogate to the child calls without needing to be set explicitly.  Name each task and reference the output of a previous task in the inputs to a given task.
  result = api_instance.orchestrator_http_simple(request)
  p result
rescue CloudmersiveConfigurationApiClient::ApiError => e
  puts "Exception when calling OrchestratorApi->orchestrator_http_simple: #{e}"
end

Documentation for API Endpoints

All URIs are relative to https://api.cloudmersive.com

Class	Method	HTTP request	Description
CloudmersiveConfigurationApiClient::OrchestratorApi	orchestrator_http_simple	POST /config/orchestrator/http/simple	Orchestrate multiple HTTP API calls with a single API call in the order specified. Call other Cloudmersive APIs or third party APIs. For Cloudmersive APIs, the API Key will automatically propogate to the child calls without needing to be set explicitly. Name each task and reference the output of a previous task in the inputs to a given task.
CloudmersiveConfigurationApiClient::SettingsApi	settings_create_setting	POST /config/settings/create	Create a setting in the specified bucket
CloudmersiveConfigurationApiClient::SettingsApi	settings_list_settings	POST /config/settings/list	Enumerate the settings in a bucket
CloudmersiveConfigurationApiClient::SettingsApi	settings_update_setting	POST /config/settings/update	Update a setting

Documentation for Models

• CloudmersiveConfigurationApiClient::CreateSettingRequest
• CloudmersiveConfigurationApiClient::CreateSettingResponse
• CloudmersiveConfigurationApiClient::HttpFormDataParameter
• CloudmersiveConfigurationApiClient::HttpGetParameter
• CloudmersiveConfigurationApiClient::HttpOrchestrationHeader
• CloudmersiveConfigurationApiClient::HttpOrchestrationRequest
• CloudmersiveConfigurationApiClient::HttpOrchestrationResponse
• CloudmersiveConfigurationApiClient::HttpOrchestrationTask
• CloudmersiveConfigurationApiClient::HttpRawBinaryParameter
• CloudmersiveConfigurationApiClient::HttpRawTextParameter
• CloudmersiveConfigurationApiClient::HttpWwwFormUrlEncodedParameter
• CloudmersiveConfigurationApiClient::ListSettingsRequest
• CloudmersiveConfigurationApiClient::ListSettingsResponse
• CloudmersiveConfigurationApiClient::SettingValue
• CloudmersiveConfigurationApiClient::TaskOutputReference
• CloudmersiveConfigurationApiClient::UpdateSettingRequest
• CloudmersiveConfigurationApiClient::UpdateSettingResponse

Documentation for Authorization

Apikey

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