bleumi_pay_sdk_ruby 1.0.2 → 1.0.7

data/docs/Payout.md

@@ -0,0 +1,18 @@
+# BleumiPay::Payout
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**transfer_address** | **String** | Address of receiver. This address must be able to receive payments from smart contracts. | 
+**amount** | **String** | Amount of token to transfer |
+**authorization** <br> (Optional)| **String** | (Only for Algorand) Base64 serialization of an encoded LogicSig signed by the source of the payout |
+
+## Example
+
+```json
+{
+    "transferAddress": "0xD15BDD17175825742A5904b21008dd3A019a060E",
+    "amount": "1"
+}
+```

data/docs/PayoutItem.md

@@ -0,0 +1,39 @@
+# BleumiPay::PayoutItem
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**txid** | **String** | Unique identifier for this payout | 
+**status** | **Boolean** | <b>null</b> - Operation in progress </br> <b>true</b> - Operation confirmed by network </br> <b>false</b> - Operation rejected by network </br> | 
+**hash** | **String** | Transaction hash of the operation submitted to the network. This field is blank when the operation is in progress. | 
+**created_at** | **Integer** | UNIX timestamp when the payout was created | 
+**updated_at** | **Integer** | UNIX timestamp when the lastest operation was performed | 
+**inputs** | [**PayoutItemInputs**](PayoutItemInputs.md) | Inputs provided for this payout creation | 
+
+
+## Example
+
+```json
+{
+    "txid": "12345-6789-10",
+    "status": false,
+    "hash": "<N/A>",
+    "createdAt": 1574501464,
+    "updatedAt": 1574501769,
+    "inputs": {
+    "salt": "0x6f3b4b923b133a82dddef57139b6bbd622e7343128983518557cd13201c5462b",
+    "token": "0x84df8548086ec9025e9c93297058bed706e90ddd",
+    "payouts": [
+        {
+        "transferAddress": "0xD15BDD17175825742A5904b21008dd3A019a060E",
+        "amount": "15"
+        },
+        {
+        "transferAddress": "0x7Dc30B85084aA1608e5C1Ce39c804Be177e40A07",
+        "amount": "21"
+        }
+    ]
+    }
+}
+```

data/docs/PayoutItemInputs.md

@@ -0,0 +1,28 @@
+# BleumiPay::PayoutItemInputs
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**salt** | **String** | Unique identifier generated for the txid of the payout (specified during Create a Payout). | 
+**token** | **String** | Token used for the payout | <b>ETH</b> - for Ethereum  <br/> <b>XDAI</b> - for xDai <br/> <b>XDAIT</b> - for xDai Testnet <br/> <b>ALGO</b> - for Algo <br/> <b>&lt;asset id&gt;</b> - for Algorand Standard Asset payouts <br/> <b> &lt;contract address of ERC-20 token&gt;</b> - for ERC-20 payouts; Please refer to [ERC-20 Tokens](https://pay.bleumi.com/docs/#erc-20) for contract address;  | 
+**payouts** | [**Array&lt;Payout&gt;**](Payout.md) | Array of payments to be made in this payout. This is an atomic transaction (i.e. either all payments are processed or all of them are rejected). | 
+
+## Example
+
+```json
+{
+    "salt": "0x6f3b4b923b133a82dddef57139b6bbd622e7343128983518557cd13201c5462b",
+    "token": "0x84df8548086ec9025e9c93297058bed706e90ddd",
+    "payouts": [
+        {
+        "transferAddress": "0xD15BDD17175825742A5904b21008dd3A019a060E",
+        "amount": "15"
+        },
+        {
+        "amount": "21",
+        "transferAddress": "0x7Dc30B85084aA1608e5C1Ce39c804Be177e40A07"
+        }
+    ]
+}
+```

data/docs/PayoutsApi.md

@@ -0,0 +1,137 @@
+# BleumiPay::PayoutsApi
+
+Payouts are available only for the Ethereum, xDAI and RSK networks today and require you to set up a Private Payment Processor and link it to your account. Please contact support@bleumi.com if you want to enable payouts for your account.
+
+## create_payout
+
+> CreatePayoutResponse create_payout(create_payout_request, opts)
+
+This method makes a payout from your Private Payment Processor.
+
+### 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::PayoutsApi.new
+
+opts = {
+  chain: BleumiPay::Chain::GOERLI # Chain | Network in which payment is to be created.
+}
+
+begin
+
+  create_payout_request = BleumiPay::CreatePayoutRequest.new # CreatePayoutRequest | Request body - used to specify payout creation parameters.
+  # This example shows 2 payouts being created
+  # Creating Payout-1
+  payout1 = BleumiPay::Payout.new
+  payout1.amount = '<PAYOUT_AMT_1>' # str | Replace <PAYOUT_AMT_1>  with the 1st payout's amount
+  payout1.transfer_address = '<PAYOUT_ADDR_1>' # str | Replace <PAYOUT_ADDR_1>  with the 1st payout's receiver's address
+  # Creating Payout-2
+  payout2 = BleumiPay::Payout.new
+  payout2.amount = '<PAYOUT_AMT_2>' # str | Replace <PAYOUT_AMT_2>  with the 2nd payout's amount
+  payout2.transfer_address = '<PAYOUT_ADDR_2>' # str | Replace <PAYOUT_ADDR_2>  with the 2nd payout's receiver's address
+  # Creating a payouts array with both the payouts created above 
+  payouts = [payout1, payout2]
+
+  create_payout_request.txid = '<TXID>' # str | Replace with unique payout ID 
+  create_payout_request.token = '<TOKEN>' # str | Replace <TOKEN>  by anyone of the following values: 'ETH' or 'XDAI' or 'XDAIT' or ECR-20 Contract Address or 'RBTC' or RSK ECR-20 Contract Address or 'Asset ID' of Algorand Standard Asset.
+  create_payout_request.payouts = payouts # setting the payouts array to the payout create request
+  
+  #Create a payout.
+  result = api_instance.create_payout(create_payout_request, opts)
+  p result
+rescue BleumiPay::ApiError => e
+  puts "Exception when calling create_payout: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **create_payout_request** | [**CreatePayoutRequest**](CreatePayoutRequest.md)| Specify payout creation parameters. |
+ **chain** | [**Chain**](Chain.md)| Network in which the payout is to be made. Please refer documentation for [Supported Networks](https://pay.bleumi.com/docs/#supported-networks) |
+
+
+### Return type
+
+[**CreatePayoutResponse**](CreatePayoutResponse.md)
+
+Field | Type | Description
+----- | ----- | -----
+salt | string | Unique id generated for the given txid
+
+### 400 Errors
+
+The following table is a list of possible error codes that can be returned, along with additional information about how to resolve them for a response with 400 status code.
+
+errorCode <br> <i>errorMessage</i> | Description
+---- | ----
+ValidationError <br> <i>&lt;details&gt;</i> | Details on input which does not conform to the above schema
+ValidationError <br> <i>invalid_token</i> | Provided token is not valid for the specified 'chain'
+ValidationError <br> <i>no_gas_accounts</i> | No active gas accounts present in your account. Please activate at least one gas account from the <a href="https://pay.bleumi.com/app/" target="_blank">Bleumi Pay Dashboard</a>.
+ValidationError <br> <i>txid_already_exists</i> | The 'txid' provided has been used previously
+ValidationError <br> <i>not_whitelisted&#124;&lt;addr&gt;</i> | The &lt;addr&gt; provided has not been whitelisted in your Private Payment Processor
+ValidationError <br> <i>payouts_requires_private_payment_processor</i> | Private Payment Processor is not set up and linked to your account
+
+
+## list_payouts
+
+> PaginatedPayoutItems list_payouts(opts)
+
+The list of payouts is returned as an array in the 'results' field. The list is restricted to a maximum of 10 payouts per page.
+
+If there are more than 10 payouts, a cursor is returned in the 'nextToken' field. Passing this as the 'nextToken' query parameter will fetch the next page. 
+
+When the value of 'nextToken' field is an empty string, there are no more payouts.
+
+### 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::PayoutsApi.new
+opts = {
+  next_token: '', # String | Cursor to start results from
+  sort_by: '<SORT_BY>', # String | Sort payouts by (optional) | Eg. "createdAt"
+  start_at: '<START_TIMESTAMP>', # String | Get payouts from this timestamp (optional) | Eg. 1577836800 for 1-JAN-2020
+  end_at: '' # String | Get payouts till this timestamp (optional) 
+}
+
+begin
+  #Returns a list of payouts
+  result = api_instance.list_payouts(opts)
+  p result
+rescue BleumiPay::ApiError => e
+  puts "Exception when calling list_payouts: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **next_token** | **String**| Cursor to start results from | [optional] 
+ **sort_by** | **String**| Sort payouts by | [optional] 'createdAt' - results will be sorted by created time in ascending order. <br>'updatedAt' - results will be sorted by last updated time in ascending order.
+ **start_at** | **String**| Get payouts from this timestamp (unix) | [optional] 
+ **end_at** | **String**| Get payouts till this timestamp (unix) | [optional] 
+
+### Return type
+
+[**PaginatedPayoutItems**](PaginatedPayoutItems.md)
+

data/docs/RskBalance.md

@@ -0,0 +1,28 @@
+# BleumiPay::RskBalance
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**rsk** <br>(Optional) | [**Hash&lt;String, WalletBalance&gt;**](WalletBalance.md) | A dictionary which gives the token balances in RSK MainNet  |
+**rsk_testnet** <br>(Optional) | [**Hash&lt;String, WalletBalance&gt;**](WalletBalance.md) | A dictionary which gives the token balances in RSK TestNet  |
+
+## Example - TestNet
+
+```json
+{
+    "balances": {
+        "rsk": {
+            "rsk_testnet": {
+                "0x1efeabf46ca3270a9a41d324350692664f1ea105": {
+                    "blockNum": "889362",
+                    "token_balance": "300",
+                    "balance": "3",
+                    "safety": "high",
+                    "token_decimals": 2
+                }
+            }
+        }
+    }
+}
+```

data/docs/ValidateCheckoutRequest.md

@@ -0,0 +1,21 @@
+# BleumiPay::ValidateCheckoutRequest
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**hmac_input** | **String** | Payment Details. Passed as GET parameter in successUrl. | 
+**hmac_key_id** | **String** | KeyId used to generate the HMAC. Passed as GET parameter in successUrl. | 
+**hmac_alg** | **String** | Algorithm used to generate the HMAC. Passed as GET parameter in successUrl. | 
+**hmac_value** | **String** | HMAC passed as GET parameter in successUrl. | 
+
+## Example
+
+```json
+{
+    "hmac_input": "goerli|0xbe98e68c0ffbead18f94882b0f5d15eb31930cee|0x84df8548086ec9025e9c93297058bed706e90ddd|10|12",
+    "hmac_keyId": "v1",
+    "hmac_alg": "HMAC-SHA256-HEX",
+    "hmac_value": "e842bb5f3f62319864293ecb7ccc01674a0af08e4e74a01ab16b2157c3fce5d6"
+}
+```

data/docs/ValidateCheckoutResponse.md

@@ -0,0 +1,15 @@
+# BleumiPay::ValidateCheckoutResponse
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**valid** | **Boolean** | <b>true</b> - The data has been generated by Bleumi Pay <br/> <b>false</b> - The data has not been generated by Bleumi Pay, the payment must be treated as unpaid | 
+
+## Example
+
+```json
+{
+  "valid": true
+}
+```

data/docs/WalletBalance.md

@@ -4,8 +4,22 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**balance** | **String** | ERC-20 token balance for the wallet |
-**token_balance** | **String** | ERC-20 token balance for the wallet (in Ethereum format) |
-**token_decimals** | **Integer** | ERC-20 token decimal places |
-**block_num** | **String** | Block in which the ERC-20 token balance was last updated. <br>'0' - No incoming/outgoing transactions recorded. |
+**balance** | **String** | Token balance for the wallet | 
+**token_balance** | **String** | Token balance for the wallet in Ethereum format | 
+**token_decimals** | **Integer** | Token decimal places | 
+**block_num** | **String** | Block in which the balance was last updated | 
+**safety** | **String** | Safety level indicator | 
+
+## Code Sample
+
+```ruby
+require 'BleumiPay'
+
+instance = BleumiPay::WalletBalance.new(balance: null,
+                                 token_balance: null,
+                                 token_decimals: null,
+                                 block_num: null,
+                                 safety: null)
+```
+
 

data/hc_create.rb

@@ -0,0 +1,40 @@
+# 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'] = 'gCix0pemxoUt76Ufef16jwvbV6cC7H60HdryEJj0'
+end
+
+api_instance = BleumiPay::HostedCheckoutsApi.new
+
+create_checkout_url_request = BleumiPay::CreateCheckoutUrlRequest.new # CreatePayoutRequest | Specify payout creation parameters.
+create_checkout_url_request.id = '17'
+create_checkout_url_request.currency = 'USD'
+create_checkout_url_request.amount = '10'
+create_checkout_url_request.success_url = 'https://demo.store/api/completeOrder'
+create_checkout_url_request.cancel_url = 'https://demo.store/api/cancelOrder'
+# create_checkout_url_request.token = '0x115615DbD0f835344725146Fa6343219315F15E5'
+# create_checkout_url_request.chain = BleumiPay::Chain::GOERLI
+
+# create_checkout_url_request.currency = 'ALGO'
+# create_checkout_url_request.token = 'ALGO'
+# create_checkout_url_request.chain = BleumiPay::Chain::ALG_TESTNET
+
+# RSK
+# USD p18 - 0xB3A4A821434bDFbE55872C240D3888c412c68B9B
+# USD p6 - 0xb9F624160Bb2755aa25366cc307ED27e39A4f296
+# USD p2 - 0x1efEaBf46Ca3270A9a41D324350692664f1eA105
+# EUR p2 - 0xd7a5c209194AC2E8e3E6Ca1dbF3C55484adb06e1
+# Chain: RSK_TESTNET
+create_checkout_url_request.token = '0xb9F624160Bb2755aa25366cc307ED27e39A4f296'
+create_checkout_url_request.chain = BleumiPay::Chain::RSK_TESTNET
+
+begin
+  #Create an unique wallet address to accept payments for an ERC-20 token from a buyer
+  result = api_instance.create_checkout_url(create_checkout_url_request)
+  p result
+rescue BleumiPay::ApiError => e
+  puts "Exception when calling HostedCheckoutsApi->create_checkout_url: #{e}"
+end

data/hc_list.rb

@@ -0,0 +1,17 @@
+# 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'] = 'gCix0pemxoUt76Ufef16jwvbV6cC7H60HdryEJj0'
+end
+
+api_instance = BleumiPay::HostedCheckoutsApi.new
+
+begin
+  #Retrieve all tokens configured for the Hosted Checkout in your account in the Bleumi Pay Dashboard
+  result = api_instance.list_tokens
+  p result
+rescue BleumiPay::ApiError => e
+  puts "Exception when calling HostedCheckoutsApi->list_tokens: #{e}"
+end

data/hc_validate.rb

@@ -0,0 +1,22 @@
+# 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'] = 'gCix0pemxoUt76Ufef16jwvbV6cC7H60HdryEJj0'
+end
+
+api_instance = BleumiPay::HostedCheckoutsApi.new
+
+begin
+  validate_checkout_request = BleumiPay::ValidateCheckoutRequest.new # WalletSettleOperationInput | Request body - used to specify the amount to settle.
+  validate_checkout_request.hmac_alg = 'HMAC-SHA256-HEX'
+  validate_checkout_request.hmac_input = 'goerli|0xbeaa3c30fc4a89e31caec6e2c8e89d3138f3bc18|0x115615dbd0f835344725146fa6343219315f15e5|10|0'
+  validate_checkout_request.hmac_key_id = 'v1'
+  validate_checkout_request.hmac_value = '205e429e51618e377046a0e8452d94b364e6938ea04362d466418548f3871f30'
+  #Settle a wallet, amount received will be transferred even if less than payment amount
+  result = api_instance.validate_checkout_payment(validate_checkout_request)
+  p result
+rescue BleumiPay::ApiError => e
+  puts "Exception when calling HostedCheckoutsApi->validate_checkout_payment: #{e}"
+end

data/lib/bleumi_pay_sdk_ruby.rb

@@ -1,12 +1,12 @@
 =begin
-#Bleumi Pay API
+#Bleumi Pay REST API
 
-#A simple and powerful REST API to integrate ERC20 payments into your business or application
+#A simple and powerful REST API to integrate ERC-20, Ethereum, xDai, Algorand payments and/or payouts 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
+OpenAPI Generator version: 4.2.2
 
 =end
 
@@ -17,24 +17,45 @@ require 'bleumi_pay_sdk_ruby/version'
 require 'bleumi_pay_sdk_ruby/configuration'
 
 # Models
+require 'bleumi_pay_sdk_ruby/models/algorand_balance'
+require 'bleumi_pay_sdk_ruby/models/algorand_wallet_address'
+require 'bleumi_pay_sdk_ruby/models/algorand_wallet_inputs'
 require 'bleumi_pay_sdk_ruby/models/bad_request'
-require 'bleumi_pay_sdk_ruby/models/eth_address'
-require 'bleumi_pay_sdk_ruby/models/eth_network'
-require 'bleumi_pay_sdk_ruby/models/paginated_wallet_operations'
-require 'bleumi_pay_sdk_ruby/models/paginated_wallets'
-require 'bleumi_pay_sdk_ruby/models/wallet'
+require 'bleumi_pay_sdk_ruby/models/chain'
+require 'bleumi_pay_sdk_ruby/models/checkout_token'
+require 'bleumi_pay_sdk_ruby/models/create_checkout_url_request'
+require 'bleumi_pay_sdk_ruby/models/create_checkout_url_response'
+require 'bleumi_pay_sdk_ruby/models/create_payment_request'
+require 'bleumi_pay_sdk_ruby/models/create_payment_response'
+require 'bleumi_pay_sdk_ruby/models/create_payout_request'
+require 'bleumi_pay_sdk_ruby/models/create_payout_response'
+require 'bleumi_pay_sdk_ruby/models/ethereum_balance'
+require 'bleumi_pay_sdk_ruby/models/ethereum_wallet_address'
+require 'bleumi_pay_sdk_ruby/models/ethereum_wallet_inputs'
+require 'bleumi_pay_sdk_ruby/models/paginated_payment_operations'
+require 'bleumi_pay_sdk_ruby/models/paginated_payments'
+require 'bleumi_pay_sdk_ruby/models/paginated_payout_items'
+require 'bleumi_pay_sdk_ruby/models/payment'
+require 'bleumi_pay_sdk_ruby/models/payment_addresses'
+require 'bleumi_pay_sdk_ruby/models/payment_balances'
+require 'bleumi_pay_sdk_ruby/models/payment_operation'
+require 'bleumi_pay_sdk_ruby/models/payment_operation_inputs'
+require 'bleumi_pay_sdk_ruby/models/payment_operation_response'
+require 'bleumi_pay_sdk_ruby/models/payment_refund_request'
+require 'bleumi_pay_sdk_ruby/models/payment_settle_request'
+require 'bleumi_pay_sdk_ruby/models/payout'
+require 'bleumi_pay_sdk_ruby/models/payout_item'
+require 'bleumi_pay_sdk_ruby/models/payout_item_inputs'
+require 'bleumi_pay_sdk_ruby/models/rsk_balance'
+require 'bleumi_pay_sdk_ruby/models/validate_checkout_request'
+require 'bleumi_pay_sdk_ruby/models/validate_checkout_response'
 require 'bleumi_pay_sdk_ruby/models/wallet_balance'
-require 'bleumi_pay_sdk_ruby/models/wallet_create_input'
-require 'bleumi_pay_sdk_ruby/models/wallet_create_output'
-require 'bleumi_pay_sdk_ruby/models/wallet_inputs'
-require 'bleumi_pay_sdk_ruby/models/wallet_operation'
-require 'bleumi_pay_sdk_ruby/models/wallet_operation_inputs'
-require 'bleumi_pay_sdk_ruby/models/wallet_operation_output'
-require 'bleumi_pay_sdk_ruby/models/wallet_refund_operation_input'
-require 'bleumi_pay_sdk_ruby/models/wallet_settle_operation_input'
 
 # APIs
-require 'bleumi_pay_sdk_ruby/api/erc20_payments_api'
+require 'bleumi_pay_sdk_ruby/api/hosted_checkouts_api'
+require 'bleumi_pay_sdk_ruby/api/payments_api'
+require 'bleumi_pay_sdk_ruby/api/payouts_api'
+require 'bleumi_pay_sdk_ruby/api/request_validator'
 
 module BleumiPay
   class << self