bleumi_pay_sdk_ruby 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5b4841a457f75522f71b7cc5de03091d8940e8b5849f301f17867654d8bdc206
+  data.tar.gz: d56a789b264d10df6c3a08c23106a1a40e408d00fa16cd3da1eba764987a31af
+SHA512:
+  metadata.gz: dfd06cf23a3171655d257a15acc8139e0ad8afcea81cc1076330b4423b388cc72e3753a09eae221a5b39f158ac71aa469685c1a87864eb569d0dbc312c65c0d2
+  data.tar.gz: 98e2ed390dd6f054dbb43be846bc4c4b8087226233aad1995b2aa7cc009a335e1497144e637984e431c6b7a514aad6262e73d0b71d1130476cae9921e95d4475

data/Gemfile

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

data/README.md

@@ -0,0 +1,105 @@
+# bleumi_pay_sdk_ruby
+
+The Bleumi Pay SDK is a one-stop shop to help you integrate ECR-20 payments into your business or application. The SDK bundles [Bleumi Pay API](https://pay.bleumi.com/docs/#introduction) into one SDK to ease implementation and support.
+
+bleumi-pay-sdk-ruby is a Ruby library that provides an interface between your Rubu=y application and [Bleumi Pay API](https://pay.bleumi.com/docs/#introduction). This tutorial covers the basics, including examples, needed to use the SDK.
+
+## Installation
+
+Finally add this to the Gemfile:
+
+    gem 'bleumi_pay_sdk_ruby', '~> 1.0.0'
+
+### Install from Git
+
+If the Ruby gem is hosted at a git repository: https://github.com/bleumi/bleumi_pay_sdk_ruby, then add the following in the Gemfile:
+
+    gem 'bleumi_pay_sdk_ruby', :git => 'https://github.com/bleumi/bleumi_pay_sdk_ruby.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 'bleumi_pay_sdk_ruby'
+
+# Setup authorization
+BleumiPay.configure do |config|
+  # Configure API key authorization: ApiKeyAuth
+  config.api_key['x-api-key'] = '<YOUR_API_KEY>'
+end
+
+api_instance = BleumiPay::Erc20PaymentsApi.new
+wallet_create_input = BleumiPay::WalletCreateInput.new # WalletCreateInput |
+opts = {
+  chain: BleumiPay::EthNetwork::ROPSTEN # EthNetwork | Ethereum network in which wallet is to be created.
+}
+
+buyer_address = BleumiPay::EthAddress.new('<BUYER_ADDR>')
+transfer_address = BleumiPay::EthAddress.new('<MERCHANT_ADDR>')
+
+wallet_create_input.id = '<ID>'
+wallet_create_input.buyer_address = buyer_address
+wallet_create_input.transfer_address = transfer_address
+
+begin
+  #Create an unique wallet address to accept payments for an ERC-20 token from a buyer
+  result = api_instance.create_wallet(wallet_create_input, opts)
+  p result
+rescue BleumiPay::ApiError => e
+  puts "Exception when calling Erc20PaymentsApi->create_wallet: #{e}"
+end
+
+```
+
+More examples can be found under each method in [SDK Classes](README.md#sdk-classes) section.
+
+## SDK Classes
+
+Class | Method | HTTP request | Description
+------------ | ------------- | ------------- | -------------
+BleumiPay::Erc20PaymentsApi | [**create_wallet**](docs/Erc20PaymentsApi.md#create_wallet) | **POST** /v1/payment/erc20/wallet | Create an unique wallet address to accept payments for an ERC-20 token from a buyer
+BleumiPay::Erc20PaymentsApi | [**get_wallet**](docs/Erc20PaymentsApi.md#get_wallet) | **GET** /v1/payment/erc20/wallet/{id} | Return a specific wallet
+BleumiPay::Erc20PaymentsApi | [**get_wallet_operation**](docs/Erc20PaymentsApi.md#get_wallet_operation) | **GET** /v1/payment/erc20/wallet/{id}/operation/{txid} | Return a specific operation of the wallet
+BleumiPay::Erc20PaymentsApi | [**get_wallet_operations**](docs/Erc20PaymentsApi.md#get_wallet_operations) | **GET** /v1/payment/erc20/wallet/{id}/operation | Return the list of operations performed by the mechant on a specific wallet
+BleumiPay::Erc20PaymentsApi | [**list_wallets**](docs/Erc20PaymentsApi.md#list_wallets) | **GET** /v1/payment/erc20/wallet | Returns a list of wallets
+BleumiPay::Erc20PaymentsApi | [**refund_wallet**](docs/Erc20PaymentsApi.md#refund_wallet) | **POST** /v1/payment/erc20/wallet/{id}/refund | Refund wallet
+BleumiPay::Erc20PaymentsApi | [**settle_wallet**](docs/Erc20PaymentsApi.md#settle_wallet) | **POST** /v1/payment/erc20/wallet/{id}/settle | Settle a wallet, amount received will be transferred even if less than payment amount
+
+
+## Documentation for Models
+
+ - [BleumiPay::BadRequest](docs/BadRequest.md)
+ - [BleumiPay::EthAddress](docs/EthAddress.md)
+ - [BleumiPay::EthNetwork](docs/EthNetwork.md)
+ - [BleumiPay::PaginatedWalletOperations](docs/PaginatedWalletOperations.md)
+ - [BleumiPay::PaginatedWallets](docs/PaginatedWallets.md)
+ - [BleumiPay::Wallet](docs/Wallet.md)
+ - [BleumiPay::WalletBalance](docs/WalletBalance.md)
+ - [BleumiPay::WalletCreateInput](docs/WalletCreateInput.md)
+ - [BleumiPay::WalletCreateOutput](docs/WalletCreateOutput.md)
+ - [BleumiPay::WalletInputs](docs/WalletInputs.md)
+ - [BleumiPay::WalletOperation](docs/WalletOperation.md)
+ - [BleumiPay::WalletOperationInputs](docs/WalletOperationInputs.md)
+ - [BleumiPay::WalletOperationOutput](docs/WalletOperationOutput.md)
+ - [BleumiPay::WalletRefundOperationInput](docs/WalletRefundOperationInput.md)
+ - [BleumiPay::WalletSettleOperationInput](docs/WalletSettleOperationInput.md)
+
+## Limitations
+
+ - [Bleumi Pay API Limits](https://pay.bleumi.com/docs/#api-limits)
+
+## License
+
+Copyright 2019 Bleumi, Inc.
+
+Code licensed under the [MIT License](docs/MITLicense.md).

data/Rakefile

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

data/bleumi_pay_sdk_ruby.gemspec

@@ -0,0 +1,39 @@
+# -*- encoding: utf-8 -*-
+
+=begin
+#Bleumi Pay API
+
+#A simple and powerful REST API to integrate ERC20 payments into your business or application
+
+The version of the OpenAPI document: 1.0.0
+Contact: info@bleumi.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.2.0
+
+=end
+
+$:.push File.expand_path("../lib", __FILE__)
+require "bleumi_pay_sdk_ruby/version"
+
+Gem::Specification.new do |s|
+  s.name        = "bleumi_pay_sdk_ruby"
+  s.version     = BleumiPay::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Bleumi"]
+  s.email       = ["info@bleumi.com"]
+  s.homepage    = "https://pay.bleumi.com/"
+  s.summary     = "Bleumi Pay API Ruby Gem"
+  s.description = "A simple and powerful REST API to integrate ERC20 payments into your business or application"
+  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.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/BadRequest.md

@@ -0,0 +1,17 @@
+# BleumiPay::BadRequest
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**error_code** | **String** | Code for error class. Complete list of error codes is available [here](https://pay.bleumi.com/docs/#errors) | 
+**error_message** | **String** | Error description | [optional] 
+
+## Code Sample
+
+```ruby
+require 'BleumiPay'
+
+instance = BleumiPay::BadRequest.new(error_code: null,
+                                 error_message: null)
+```

data/docs/Erc20PaymentsApi.md

@@ -0,0 +1,318 @@
+# BleumiPay::Erc20PaymentsApi
+
+## create_wallet
+
+> WalletCreateOutput create_wallet(wallet_create_input, opts)
+
+Create an unique wallet address to accept payments for an ERC-20 token from a buyer
+
+### Example
+
+```ruby
+# load the gem
+require 'bleumi_pay_sdk_ruby'
+# Setup authorization
+BleumiPay.configure do |config|
+  # Configure API key authorization: ApiKeyAuth
+  config.api_key['x-api-key'] = '<YOUR_API_KEY>'
+end
+
+api_instance = BleumiPay::Erc20PaymentsApi.new
+wallet_create_input = BleumiPay::WalletCreateInput.new # WalletCreateInput |
+opts = {
+  chain: BleumiPay::EthNetwork::ROPSTEN # EthNetwork | Ethereum network in which wallet is to be created.
+}
+
+buyer_address = BleumiPay::EthAddress.new('<BUYER_ADDR>')
+transfer_address = BleumiPay::EthAddress.new('<MERCHANT_ADDR>')
+
+wallet_create_input.id = '<ID>'
+wallet_create_input.buyer_address = buyer_address
+wallet_create_input.transfer_address = transfer_address
+
+begin
+  #Create an unique wallet address to accept payments for an ERC-20 token from a buyer
+  result = api_instance.create_wallet(wallet_create_input, opts)
+  p result
+rescue BleumiPay::ApiError => e
+  puts "Exception when calling Erc20PaymentsApi->create_wallet: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **wallet_create_input** | [**WalletCreateInput**](WalletCreateInput.md)|  |
+ **chain** | [**EthNetwork**](.md)| Ethereum network in which wallet is to be created. | [optional]
+
+### Return type
+
+[**WalletCreateOutput**](WalletCreateOutput.md)
+
+## get_wallet
+
+> Wallet get_wallet(id)
+
+Return a specific wallet
+
+### Example
+
+```ruby
+# load the gem
+require 'bleumi_pay_sdk_ruby'
+# setup authorization
+BleumiPay.configure do |config|
+  # Configure API key authorization: ApiKeyAuth
+  config.api_key['x-api-key'] = '<YOUR_API_KEY>'
+end
+
+api_instance = BleumiPay::Erc20PaymentsApi.new
+id = '<ID>' # String | Unique ID identifying the wallet in your system
+
+begin
+  #Return a specific wallet
+  result = api_instance.get_wallet(id)
+  p result
+rescue BleumiPay::ApiError => e
+  puts "Exception when calling Erc20PaymentsApi->get_wallet: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **String**| Unique ID identifying the wallet in your system |
+
+### Return type
+
+[**Wallet**](Wallet.md)
+
+
+## list_wallets
+
+> PaginatedWallets list_wallets(opts)
+
+Returns a list of wallets
+
+### Example
+
+```ruby
+# load the gem
+require 'bleumi_pay_sdk_ruby'
+# setup authorization
+BleumiPay.configure do |config|
+  # Configure API key authorization: ApiKeyAuth
+  config.api_key['x-api-key'] = '<YOUR_API_KEY>'
+end
+
+api_instance = BleumiPay::Erc20PaymentsApi.new
+opts = {
+  next_token: '', # String | Cursor to start results from
+  sort_by: '<SORT_BY>', # String | Sort wallets by (optional) | Eg. "createdAt"
+  start_at: '<START_TIMESTAMP>', # String | Get wallets from this timestamp (optional) | Eg. 1546300800 for 1-JAN-2019
+  end_at: '' # String | Get wallets till this timestamp (optional) 
+}
+
+begin
+  #Returns a list of wallets
+  result = api_instance.list_wallets(opts)
+  p result
+rescue BleumiPay::ApiError => e
+  puts "Exception when calling Erc20PaymentsApi->list_wallets: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **next_token** | **String**| Cursor to start results from | [optional]
+ **sort_by** | **String**| Sort wallets by | [optional]
+ **start_at** | **String**| Get wallets from this timestamp | [optional]
+ **end_at** | **String**| Get wallets till this timestamp | [optional]
+
+### Return type
+
+[**PaginatedWallets**](PaginatedWallets.md)
+
+
+## settle_wallet
+
+> WalletOperationOutput settle_wallet(id, wallet_settle_operation_input)
+
+Settle a wallet, amount received will be transferred even if less than payment amount
+
+### Example
+
+```ruby
+# load the gem
+require 'bleumi_pay_sdk_ruby'
+# setup authorization
+BleumiPay.configure do |config|
+  # Configure API key authorization: ApiKeyAuth
+  config.api_key['x-api-key'] = '<YOUR_API_KEY>'
+end
+
+api_instance = BleumiPay::Erc20PaymentsApi.new
+id = '<ID>' # String | Unique ID identifying this record in your system
+wallet_settle_operation_input = BleumiPay::WalletSettleOperationInput.new 
+wallet_settle_operation_input.amount = '<AMT>' # String | Replace <AMT> with settle amount
+wallet_settle_operation_input.token = BleumiPay::EthAddress.new('<TOKEN_ADDR>') # String | Replace <TOKEN_ADDR> with ECR-20 token address
+
+begin
+  #Settle a wallet, amount received will be transferred even if less than payment amount
+  result = api_instance.settle_wallet(id, wallet_settle_operation_input)
+  p result
+rescue BleumiPay::ApiError => e
+  puts "Exception when calling Erc20PaymentsApi->settle_wallet: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **String**| Unique ID identifying this record in your system |
+ **wallet_settle_operation_input** | [**WalletSettleOperationInput**](WalletSettleOperationInput.md)| Request body - used to specify the amount to settle. |
+
+### Return type
+
+[**WalletOperationOutput**](WalletOperationOutput.md)
+
+## refund_wallet
+
+> WalletOperationOutput refund_wallet(id, wallet_refund_operation_input)
+
+Refund wallet
+
+### Example
+
+```ruby
+# load the gem
+require 'bleumi_pay_sdk_ruby'
+# setup authorization
+BleumiPay.configure do |config|
+  # Configure API key authorization: ApiKeyAuth
+  config.api_key['x-api-key'] = '<YOUR_API_KEY>'
+end
+
+api_instance = BleumiPay::Erc20PaymentsApi.new
+id = '<ID>' # String | Unique ID identifying this record in your system
+wallet_refund_operation_input = BleumiPay::WalletRefundOperationInput.new 
+wallet_refund_operation_input.token = BleumiPay::EthAddress.new('<TOKEN_ADDR>') # String | Replace <TOKEN_ADDR> with ECR-20 token address
+
+begin
+  #Refund wallet
+  result = api_instance.refund_wallet(id, wallet_refund_operation_input)
+  p result
+rescue BleumiPay::ApiError => e
+  puts "Exception when calling Erc20PaymentsApi->refund_wallet: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **String**| Unique ID identifying this record in your system |
+ **wallet_refund_operation_input** | [**WalletRefundOperationInput**](WalletRefundOperationInput.md)| Request body - used to specify the token to refund. |
+
+### Return type
+
+[**WalletOperationOutput**](WalletOperationOutput.md)
+
+
+## get_wallet_operation
+
+> WalletOperation get_wallet_operation(id, txid)
+
+Return a specific operation of the wallet
+
+### Example
+
+```ruby
+# load the gem
+require 'bleumi_pay_sdk_ruby'
+# setup authorization
+BleumiPay.configure do |config|
+  # Configure API key authorization: ApiKeyAuth
+  config.api_key['x-api-key'] = '<YOUR_API_KEY>'
+end
+
+api_instance = BleumiPay::Erc20PaymentsApi.new
+id = '<ID>' # String | Unique ID identifying the wallet in your system
+txid = '<TXID>' # String | ID of a specific operation of the wallet
+
+begin
+  #Return a specific operation of the wallet
+  result = api_instance.get_wallet_operation(id, txid)
+  p result
+rescue BleumiPay::ApiError => e
+  puts "Exception when calling Erc20PaymentsApi->get_wallet_operation: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **String**| Unique ID identifying the wallet in your system |
+ **txid** | **String**| ID of a specific operation of the wallet |
+
+### Return type
+
+[**WalletOperation**](WalletOperation.md)
+
+
+
+## get_wallet_operations
+
+> PaginatedWalletOperations get_wallet_operations(id, opts)
+
+Return the list of operations performed by the mechant on a specific wallet
+
+### Example
+
+```ruby
+# load the gem
+require 'bleumi_pay_sdk_ruby'
+# setup authorization
+BleumiPay.configure do |config|
+  # Configure API key authorization: ApiKeyAuth
+  config.api_key['x-api-key'] = '<YOUR_API_KEY>'
+end
+
+api_instance = BleumiPay::Erc20PaymentsApi.new
+id = '<ID>' # String | Unique ID identifying the wallet in your system
+opts = {
+  next_token: '' # String | Cursor to start results from
+}
+
+begin
+  #Return the list of operations performed by the mechant on a specific wallet
+  result = api_instance.get_wallet_operations(id, opts)
+  p result
+rescue BleumiPay::ApiError => e
+  puts "Exception when calling Erc20PaymentsApi->get_wallet_operations: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **String**| Unique ID identifying the wallet in your system |
+ **next_token** | **String**| Cursor to start results from | [optional]
+
+### Return type
+
+[**PaginatedWalletOperations**](PaginatedWalletOperations.md)