The official ruby library for ClickSend v3 API

This is the official ClickSend SDK. Documentation can be found here.

Requirements

• Sign Up for a free ClickSend account.
• Copy your API key from the API Credentials area.

Installation

Build a gem

To build the Ruby code into a gem:

gem build clicksend_client.gemspec

Then either install the gem locally:

gem install ./clicksend_client-1.0.0.gem

(for development, run gem install --dev ./clicksend_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 'clicksend_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 'clicksend_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 'clicksend_client'

# Setup authorization
ClickSendClient.configure do |config|
  # Configure HTTP basic authorization: BasicAuth
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'
end

api_instance = ClickSendClient::AccountApi.new

begin
  #Get account information
  result = api_instance.account_get
  p result
rescue ClickSendClient::ApiError => e
  puts "Exception when calling AccountApi->account_get: #{e}"
end

Documentation

Documentation for our SDK and REST API can be found here.

Documentation for Authorization

BasicAuth

• Type: HTTP basic authentication