subskribe_dev

SubskribeDevClient - the Ruby gem for the Subskribe API

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)

This SDK is automatically generated by the Swagger Codegen project:

• API version: 1.0.0
• Package version: 1.1.0
• Build package: io.swagger.codegen.languages.RubyClientCodegen

Installation

Build a gem

To build the Ruby code into a gem:

gem build subskribe_dev.gemspec

Then either install the gem locally:

gem install ./subskribe_dev-1.1.0.gem

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

# Setup authorization
SubskribeDevClient.configure do |config|
  # Configure API key authorization: ApiKeyAuth
  config.api_key['X-API-Key'] = '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['X-API-Key'] = 'Bearer'
end

api_instance = SubskribeDevClient::SettingsApi.new

id = 'id_example' # String | 


begin
  #Activate unit of measure
  api_instance.activate_unit_of_measure(id)
rescue SubskribeDevClient::ApiError => e
  puts "Exception when calling SettingsApi->activate_unit_of_measure: #{e}"
end

Documentation for API Endpoints

All URIs are relative to https://api.dev2.subskribe.net

Class	Method	HTTP request	Description
SubskribeDevClient::SettingsApi	activate_unit_of_measure	POST /unitsOfMeasure/id/activate	Activate unit of measure
SubskribeDevClient::SettingsApi	add_unit_of_measure	POST /unitsOfMeasure	Add unit of measure
SubskribeDevClient::SettingsApi	delete_unit_of_measure	DELETE /unitsOfMeasure/id	Delete unit of measure
SubskribeDevClient::SettingsApi	deprecate_unit_of_measure	POST /unitsOfMeasure/id/deprecate	Deprecate unit of measure
SubskribeDevClient::SettingsApi	get_units_of_measure	GET /unitsOfMeasure	Get units of measure
SubskribeDevClient::SettingsApi	update_unit_of_measure	PUT /unitsOfMeasure/id	Update unit of measure

Documentation for Models

• SubskribeDevClient::UnitOfMeasureJson
• SubskribeDevClient::UnitOfMeasurePaginationResponseJson

Documentation for Authorization

ApiKeyAuth

• Type: API key
• API key parameter name: X-API-Key
• Location: HTTP header