clicksend_client 1.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 346858ef68ae591b2808e36a2f2e2e82ba6e20542e57c903ec86ec27036b6110
+  data.tar.gz: d69a4f507734356cff41be11825a82f67b9dca8ab9a4ae1e41c41533a5cd1387
+SHA512:
+  metadata.gz: 40e50129fe673825732e925dd034e4a733f7ace22b7ea79371a2362c42c1ee353883435d53328b9d849a6cabbb80c7ab3cffcabc5f4af075d33238908b8f7356
+  data.tar.gz: b33f4ade93f89d5145530321f3949a72f72958c01b1386d516fc82f06213a7a52903b87c4b415f2124c8cae0dd7ee9b1c07480c40a1c9abe7e86e179c1ed94d8

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development, :test do
+  gem 'rake', '~> 12.0.0'
+end

data/README.md

@@ -0,0 +1,78 @@
+# The official ruby library for ClickSend v3 API
+
+ This is an official SDK for [ClickSend](https://clicksend.com)  Below you will find a current list of the available methods for clicksend.  *NOTE: You will need to create a free account to use the API. You can register [here](https://dashboard.clicksend.com/#/signup/step1/)..* 
+
+## Installation
+
+### Build a gem
+
+To build the Ruby code into a gem:
+
+```shell
+gem build clicksend_client.gemspec
+```
+
+Then either install the gem locally:
+
+```shell
+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](https://rubygems.org/).
+
+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:
+
+```shell
+ruby -Ilib script.rb
+```
+
+## Getting Started
+
+Please follow the [installation](#installation) procedure and then run the following code:
+```ruby
+# 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 for API Endpoints and Models
+
+Documentation can be found here: [ClickSend API Docs](https://developers.clicksend.com/docs/)
+
+## Documentation for Authorization
+
+
+### BasicAuth
+
+- **Type**: HTTP basic authentication
+

data/Rakefile

@@ -0,0 +1,8 @@
+begin
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new(:spec)
+  task default: :spec
+rescue LoadError
+  # no rspec available
+end

data/clicksend_client.gemspec

@@ -0,0 +1,45 @@
+# -*- encoding: utf-8 -*-
+
+=begin
+#ClickSend v3 API
+
+# This is an official SDK for [ClickSend](https://clicksend.com) *NOTE: You will need to create a free account to use the API. You can register [here](https://dashboard.clicksend.com/#/signup/step1/)..* 
+
+OpenAPI spec version: 3.1
+Contact: support@clicksend.com
+Generated by: https://github.com/clicksend-api/clicksend-codegen.git
+ClickSend Codegen version: 2.4.1-SNAPSHOT
+
+=end
+
+$:.push File.expand_path("../lib", __FILE__)
+require "clicksend_client/version"
+
+Gem::Specification.new do |s|
+  s.name        = "clicksend_client"
+  s.version     = ClickSendClient::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["ClickSend-Codegen"]
+  s.email       = ["support@clicksend.com"]
+  s.homepage    = "https://github.com/clicksend-api/clicksend-codegen"
+  s.summary     = "ClickSend v3 API Ruby Gem"
+  s.description = " This is an official SDK for [ClickSend](https://clicksend.com)  *NOTE: You will need to create a free account to use the API. You can register [here](https://dashboard.clicksend.com/#/signup/step1/)..* "
+  s.license     = "Unlicense"
+  s.required_ruby_version = ">= 1.9"
+
+  s.add_runtime_dependency 'typhoeus', '~> 1.0', '>= 1.0.1'
+  s.add_runtime_dependency 'json', '~> 2.1', '>= 2.1.0'
+
+  s.add_development_dependency 'rspec', '~> 3.6', '>= 3.6.0'
+  s.add_development_dependency 'vcr', '~> 3.0', '>= 3.0.1'
+  s.add_development_dependency 'webmock', '~> 1.24', '>= 1.24.3'
+  s.add_development_dependency 'autotest', '~> 4.4', '>= 4.4.6'
+  s.add_development_dependency 'autotest-rails-pure', '~> 4.1', '>= 4.1.2'
+  s.add_development_dependency 'autotest-growl', '~> 0.2', '>= 0.2.16'
+  s.add_development_dependency 'autotest-fsevent', '~> 0.2', '>= 0.2.12'
+
+  s.files         = `find *`.split("\n").uniq.sort.select { |f| !f.empty? }
+  s.test_files    = `find spec/*`.split("\n")
+  s.executables   = []
+  s.require_paths = ["lib"]
+end

data/docs/Account.md

@@ -0,0 +1,15 @@
+# ClickSendClient::Account
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**username** | **String** | Your username | 
+**password** | **String** | Your password | 
+**user_phone** | **String** | Your phone number in E.164 format. | 
+**user_email** | **String** | Your email | 
+**user_first_name** | **String** | Your first name | 
+**user_last_name** | **String** | Your last name | 
+**account_name** | **String** | Your delivery to value. | 
+**country** | **String** | Your country | 
+
+

data/docs/AccountApi.md

@@ -0,0 +1,433 @@
+# ClickSendClient::AccountApi
+
+All URIs are relative to *https://rest.clicksend.com/v3*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**account_get**](AccountApi.md#account_get) | **GET** /account | Get account information
+[**account_post**](AccountApi.md#account_post) | **POST** /account | Create a new account
+[**account_useage_by_subaccount_get**](AccountApi.md#account_useage_by_subaccount_get) | **GET** /account/usage/{year}/{month}/subaccount | Get account useage by subaccount
+[**account_verify_send_put**](AccountApi.md#account_verify_send_put) | **PUT** /account-verify/send | Send account activation token
+[**account_verify_verify_by_activation_token_put**](AccountApi.md#account_verify_verify_by_activation_token_put) | **PUT** /account-verify/verify/{activation_token} | Verify new account
+[**forgot_password_put**](AccountApi.md#forgot_password_put) | **PUT** /forgot-password | Forgot password
+[**forgot_password_verify_put**](AccountApi.md#forgot_password_verify_put) | **PUT** /forgot-password/verify | Verify forgot password
+[**forgot_username_put**](AccountApi.md#forgot_username_put) | **PUT** /forgot-username | Forgot username
+
+
+# **account_get**
+> String account_get
+
+Get account information
+
+Get account details
+
+### Example
+```ruby
+# 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
+```
+
+### Parameters
+This endpoint does not need any parameter.
+
+### Return type
+
+**String**
+
+### Authorization
+
+[BasicAuth](../README.md#BasicAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **account_post**
+> String account_post(account)
+
+Create a new account
+
+Create An Account
+
+### Example
+```ruby
+# 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
+
+account = ClickSendClient::Account.new # Account | Account model
+
+
+begin
+  #Create a new account
+  result = api_instance.account_post(account)
+  p result
+rescue ClickSendClient::ApiError => e
+  puts "Exception when calling AccountApi->account_post: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **account** | [**Account**](Account.md)| Account model | 
+
+### Return type
+
+**String**
+
+### Authorization
+
+[BasicAuth](../README.md#BasicAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **account_useage_by_subaccount_get**
+> String account_useage_by_subaccount_get(year, month)
+
+Get account useage by subaccount
+
+Get account useage by subaccount
+
+### Example
+```ruby
+# 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
+
+year = 56 # Integer | Year to filter by (yyyy)
+
+month = 56 # Integer | Month to filter by (mm)
+
+
+begin
+  #Get account useage by subaccount
+  result = api_instance.account_useage_by_subaccount_get(year, month)
+  p result
+rescue ClickSendClient::ApiError => e
+  puts "Exception when calling AccountApi->account_useage_by_subaccount_get: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **year** | **Integer**| Year to filter by (yyyy) | 
+ **month** | **Integer**| Month to filter by (mm) | 
+
+### Return type
+
+**String**
+
+### Authorization
+
+[BasicAuth](../README.md#BasicAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **account_verify_send_put**
+> String account_verify_send_put(account_verify)
+
+Send account activation token
+
+Send account activation token
+
+### Example
+```ruby
+# 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
+
+account_verify = ClickSendClient::AccountVerify.new # AccountVerify | Account details
+
+
+begin
+  #Send account activation token
+  result = api_instance.account_verify_send_put(account_verify)
+  p result
+rescue ClickSendClient::ApiError => e
+  puts "Exception when calling AccountApi->account_verify_send_put: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **account_verify** | [**AccountVerify**](AccountVerify.md)| Account details | 
+
+### Return type
+
+**String**
+
+### Authorization
+
+[BasicAuth](../README.md#BasicAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **account_verify_verify_by_activation_token_put**
+> String account_verify_verify_by_activation_token_put(activation_token)
+
+Verify new account
+
+Verify new account
+
+### Example
+```ruby
+# 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
+
+activation_token = 56 # Integer | 
+
+
+begin
+  #Verify new account
+  result = api_instance.account_verify_verify_by_activation_token_put(activation_token)
+  p result
+rescue ClickSendClient::ApiError => e
+  puts "Exception when calling AccountApi->account_verify_verify_by_activation_token_put: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **activation_token** | **Integer**|  | 
+
+### Return type
+
+**String**
+
+### Authorization
+
+[BasicAuth](../README.md#BasicAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **forgot_password_put**
+> String forgot_password_put(opts)
+
+Forgot password
+
+Forgot password
+
+### Example
+```ruby
+# 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
+
+opts = { 
+  forgot_password: ClickSendClient::ForgotPassword.new # ForgotPassword | 
+}
+
+begin
+  #Forgot password
+  result = api_instance.forgot_password_put(opts)
+  p result
+rescue ClickSendClient::ApiError => e
+  puts "Exception when calling AccountApi->forgot_password_put: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **forgot_password** | [**ForgotPassword**](ForgotPassword.md)|  | [optional] 
+
+### Return type
+
+**String**
+
+### Authorization
+
+[BasicAuth](../README.md#BasicAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **forgot_password_verify_put**
+> String forgot_password_verify_put(verify_password)
+
+Verify forgot password
+
+Verify forgot password
+
+### Example
+```ruby
+# 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
+
+verify_password = ClickSendClient::AccountForgotPasswordVerify.new # AccountForgotPasswordVerify | verifyPassword data
+
+
+begin
+  #Verify forgot password
+  result = api_instance.forgot_password_verify_put(verify_password)
+  p result
+rescue ClickSendClient::ApiError => e
+  puts "Exception when calling AccountApi->forgot_password_verify_put: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **verify_password** | [**AccountForgotPasswordVerify**](AccountForgotPasswordVerify.md)| verifyPassword data | 
+
+### Return type
+
+**String**
+
+### Authorization
+
+[BasicAuth](../README.md#BasicAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **forgot_username_put**
+> String forgot_username_put(opts)
+
+Forgot username
+
+Forgot username
+
+### Example
+```ruby
+# load the gem
+require 'clicksend_client'
+
+api_instance = ClickSendClient::AccountApi.new
+
+opts = { 
+  forgot_username: ClickSendClient::ForgotUsername.new # ForgotUsername | 
+}
+
+begin
+  #Forgot username
+  result = api_instance.forgot_username_put(opts)
+  p result
+rescue ClickSendClient::ApiError => e
+  puts "Exception when calling AccountApi->forgot_username_put: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **forgot_username** | [**ForgotUsername**](ForgotUsername.md)|  | [optional] 
+
+### Return type
+
+**String**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+