bleumi_pay_sdk_ruby 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 37ecca8caab4b85776edd2cd0d400b69b0583dc6f1fc41fea705c2e7a7e0067b
-  data.tar.gz: '0856f4650070a17c7a8a963b7143dd1e16ad4b7fa615461ea3e295b56fe6afcd'
+  metadata.gz: eb14b4320f3d028617902cc9113626a5d0e973c71fdad64009b29a47cb6e20dc
+  data.tar.gz: f5b85bbaf36c6df463c51d32305a55f79257c2bc36a8d693bcac99ef08d195b6
 SHA512:
-  metadata.gz: fd313f860dfc4a0a9e85e4667e29fea96ff072798f4b16bbca70fa97aea6ca09fb29794ac1e8a9ffd1e98d1071a624eb2f7cda2eb16aff02fdf0464163370cc4
-  data.tar.gz: c807179469c410617366ca49ee68c8ab68b4ae7cc9f044368d037f399cf863aad2e27a67cf94077f0b73bfe68ec09e687026c60f616e12097d227abc06dd19ec
+  metadata.gz: d4ea80d9397c9c777ab8f10111345c12786576d56be488c9db150a42b916b6e20eb62d82ced47e4f9e398e7d57f962c1419504e08ee75712b2024f1305f5e528
+  data.tar.gz: 5b3424cdfefe5b8b7e3592ee3266bf5d0193f90d4541f456a174dc30f10066eb8d2cfaa5cc821e87f17a1416758f6ea2336720fae891650c7ce0590e155b1103

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 Bleumi
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -1,4 +1,8 @@
-# bleumi_pay_sdk_ruby
+<img src="https://pay.bleumi.com/wp-content/uploads/2019/04/logo_dark_bleumi_invoice_6797x1122.png" height="30">
+
+# Bleumi Pay SDK for Ruby
+
+[![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg?style=flat-square)](https://raw.githubusercontent.com/bleumi/bleumi-pay-sdk-ruby/master/LICENSE)
 
 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.
 
@@ -14,7 +18,7 @@ Ruby 1.9+
 
 #### Obtain An API Key
 
-Bleumi Pay SDK uses API keys to authenticate requests. You can obtain an API key through the [Bleumi Pay developer portal](https://pay.bleumi.com/app/).
+Bleumi Pay SDK uses API keys to authenticate requests. You can obtain an API key through the [Bleumi Pay Dashboard](https://pay.bleumi.com/app/).
 
 ### Install Package
 
@@ -23,7 +27,7 @@ Bleumi Pay SDK uses API keys to authenticate requests. You can obtain an API key
 
 To install,
 ```bash
-gem 'bleumi_pay_sdk_ruby', '~> 1.0.1'
+gem install bleumi_pay_sdk_ruby
 ```
 
 ### Install from Git
@@ -32,17 +36,10 @@ 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
-```
 
 ### Run Sample Code
 
-The following code creates a wallet to accept payment from the buyer specific for the ECR-20 Token.
+The following code generates a wallet to accept payment from the buyer specific for the ECR-20 Token.
 
 ```ruby
 # Load the gem
@@ -60,55 +57,54 @@ 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>')
+buyer_address = BleumiPay::EthAddress.new('<BUYER_ADDR>') # Replace <BUYER_ADDR> with the Buyer's Enthereum Network Address
+transfer_address = BleumiPay::EthAddress.new('<MERCHANT_ADDR>') # Replace <MERCHANT_ADDR> with the Merchant's Enthereum Network Address
 
 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)
+  #Generate an unique wallet address to accept payments for an ERC-20 token from a buyer
+  result = api_instance.generate_wallet(wallet_create_input, opts)
   p result
 rescue BleumiPay::ApiError => e
-  puts "Exception when calling Erc20PaymentsApi->create_wallet: #{e}"
+  puts "Exception when calling Erc20PaymentsApi->generate_wallet: #{e}"
 end
 
 ```
 
-More examples can be found under each method in [SDK Classes](README.md#sdk-classes) section.
+More examples can be found under each method in [SDK Classes](#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
-
+Erc20PaymentsApi | [**generate_wallet**](docs/Erc20PaymentsApi.md#generate_wallet) | **POST** /v1/payment/eth/wallet | Generates an unique wallet address to accept payments for an ERC-20 token.
+Erc20PaymentsApi | [**get_wallet**](docs/Erc20PaymentsApi.md#get_wallet) | **GET** /v1/payment/eth/wallet/{id} | Retrieve a wallet.
+Erc20PaymentsApi | [**list_wallets**](docs/Erc20PaymentsApi.md#list_wallets) | **GET** /v1/payment/eth/wallet | Retrieve all wallets.
+Erc20PaymentsApi | [**settle_wallet**](docs/Erc20PaymentsApi.md#settle_wallet) | **POST** /v1/payment/eth/wallet/{id}/settle | This method settles a specific amount of an ERC-20 token of a wallet to the transferAddress specified during [Generate Wallet](/docs/Erc20PaymentsApi.md#generatewallet)
+Erc20PaymentsApi | [**refund_wallet**](docs/Erc20PaymentsApi.md#refund_wallet) | **POST** /v1/payment/eth/wallet/{id}/refund | This method refunds the balance of an ERC-20 token of a wallet to the buyerAddress specified during [Generate Wallet](/docs/Erc20PaymentsApi.md#generatewallet).
+Erc20PaymentsApi | [**get_wallet_operation**](docs/Erc20PaymentsApi.md#get_wallet_operation) | **GET** /v1/payment/eth/wallet/{id}/operation/{txid} | Retrieve an operation of a wallet
+Erc20PaymentsApi | [**list_wallet_operations**](docs/Erc20PaymentsApi.md#list_wallet_operations) | **GET** /v1/payment/eth/wallet/{id}/operation | Retrieve all operations of a wallet.
 
 ## 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)
+ - [BadRequest](docs/BadRequest.md)
+ - [EthAddress](docs/EthAddress.md)
+ - [EthNetwork](docs/EthNetwork.md)
+ - [PaginatedWalletOperations](docs/PaginatedWalletOperations.md)
+ - [PaginatedWallets](docs/PaginatedWallets.md)
+ - [Wallet](docs/Wallet.md)
+ - [WalletBalance](docs/WalletBalance.md)
+ - [WalletCreateInput](docs/WalletCreateInput.md)
+ - [WalletCreateOutput](docs/WalletCreateOutput.md)
+ - [WalletInputs](docs/WalletInputs.md)
+ - [WalletOperation](docs/WalletOperation.md)
+ - [WalletOperationInputs](docs/WalletOperationInputs.md)
+ - [WalletOperationOutput](docs/WalletOperationOutput.md)
+ - [WalletRefundOperationInput](docs/WalletRefundOperationInput.md)
+ - [WalletSettleOperationInput](docs/WalletSettleOperationInput.md)
 
 ## Limitations
 
@@ -118,4 +114,4 @@ BleumiPay::Erc20PaymentsApi | [**settle_wallet**](docs/Erc20PaymentsApi.md#settl
 
 Copyright 2019 Bleumi, Inc.
 
-Code licensed under the [MIT License](docs/MITLicense.md).
+Code licensed under the [MIT License](LICENSE).

data/docs/BadRequest.md

@@ -6,12 +6,3 @@ 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

@@ -1,10 +1,10 @@
 # BleumiPay::Erc20PaymentsApi
 
-## create_wallet
+## generate_wallet
 
-> WalletCreateOutput create_wallet(wallet_create_input, opts)
+> WalletCreateOutput generate_wallet(wallet_create_input, opts)
 
-Create an unique wallet address to accept payments for an ERC-20 token from a buyer
+Generate an unique wallet address to accept payments for an ERC-20 token from a buyer.
 
 ### Example
 
@@ -23,19 +23,19 @@ 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>')
+buyer_address = BleumiPay::EthAddress.new('<BUYER_ADDR>') # Replace <BUYER_ADDR> with the Buyer Address
+transfer_address = BleumiPay::EthAddress.new('<MERCHANT_ADDR>') # Replace <MERCHANT_ADDR> with the Merchant's Enthereum Network Address
 
-wallet_create_input.id = '<ID>'
+wallet_create_input.id = '<ID>' # String | Unique ID identifying the wallet in your system
 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)
+  #Generate an unique wallet address to accept payments for an ERC-20 token from a buyer
+  result = api_instance.generate_wallet(wallet_create_input, opts)
   p result
 rescue BleumiPay::ApiError => e
-  puts "Exception when calling Erc20PaymentsApi->create_wallet: #{e}"
+  puts "Exception when calling Erc20PaymentsApi->generate_wallet: #{e}"
 end
 ```
 
@@ -44,8 +44,8 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **wallet_create_input** | [**WalletCreateInput**](WalletCreateInput.md)|  |
- **chain** | [**EthNetwork**](.md)| Ethereum network in which wallet is to be created. | [optional]
+ **wallet_create_input** | [**WalletCreateInput**](WalletCreateInput.md)| Specify the parameters for the wallet generation.  |
+ **chain** | [**EthNetwork**](EthNetwork.md)| Ethereum network in which the wallet is to be created. Please refer to the [Supported Ethereum Networks](https://pay.bleumi.com/docs/#supported-ethereum-networks) |
 
 ### Return type
 
@@ -55,7 +55,7 @@ Name | Type | Description  | Notes
 
 > Wallet get_wallet(id)
 
-Return a specific wallet
+This method retrieves a wallet.
 
 ### Example
 
@@ -69,7 +69,7 @@ BleumiPay.configure do |config|
 end
 
 api_instance = BleumiPay::Erc20PaymentsApi.new
-id = '<ID>' # String | Unique ID identifying the wallet in your system
+id = '<ID>' # String | The ID of the wallet to get the details
 
 begin
   #Return a specific wallet
@@ -96,7 +96,15 @@ Name | Type | Description  | Notes
 
 > PaginatedWallets list_wallets(opts)
 
-Returns a list of wallets
+This method retrieves a list of wallets.
+
+### Pagination
+
+The list of wallets is returned as an array in the 'results' field. The list is restricted to a maximum of 100 wallets per page.
+
+If there are more than 100 wallets generated for an ethereum network, 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 wallets.
 
 ### Example
 
@@ -131,10 +139,10 @@ end
 
 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]
+ **next_token** | **String**| The token to fetch the next page, supply blank value to get the first page of wallet operations | [optional]
+ **sort_by** | **String**| Sort wallets by | [optional] 'createdAt' - results will be sorted by created time in ascending order. 'updatedAt' - results will be sorted by last updated time in ascending order.
+ **start_at** | **String**| Get wallets from this timestamp | [optional] Get wallets from this timestamp (UNIX). Will be compared to created or updated time based on the value of sortBy parameter.
+ **end_at** | **String**| Get wallets till this timestamp | [optional] Get wallets till this timestamp (UNIX). Will be compared to created or updated time based on the value of sortBy parameter.
 
 ### Return type
 
@@ -145,7 +153,7 @@ Name | Type | Description  | Notes
 
 > WalletOperationOutput settle_wallet(id, wallet_settle_operation_input)
 
-Settle a wallet, amount received will be transferred even if less than payment amount
+This method settles a specific amount of an ERC-20 token of a wallet to the transferAddress specified during [Generate Wallet](#generate_wallet). And remaining balance (if any) will be refunded to the buyerAddress specified during [Generate Wallet](#generate_wallet).
 
 ### Example
 
@@ -178,8 +186,8 @@ end
 
 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. |
+ **id** | **String**| Unique identifier of the wallet (specified during [Generate Wallet](#generatewallet)) to settle
+ **wallet_settle_operation_input** | [**WalletSettleOperationInput**](WalletSettleOperationInput.md)| Specify the token and amount to settle. |
 
 ### Return type
 
@@ -189,7 +197,7 @@ Name | Type | Description  | Notes
 
 > WalletOperationOutput refund_wallet(id, wallet_refund_operation_input)
 
-Refund wallet
+This method refunds the balance of an ERC-20 token of a wallet to the buyerAddress specified during [Generate Wallet](#generate_wallet).
 
 ### Example
 
@@ -221,8 +229,8 @@ end
 
 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. |
+ **id** | **String**| Unique identifier of the wallet (specified during [Generate Wallet](#generate_wallet)) to refund |
+ **wallet_refund_operation_input** | [**WalletRefundOperationInput**](WalletRefundOperationInput.md)| Specify the token to refund. |
 
 ### Return type
 
@@ -233,7 +241,7 @@ Name | Type | Description  | Notes
 
 > WalletOperation get_wallet_operation(id, txid)
 
-Return a specific operation of the wallet
+This method retrieves an operation of a wallet.
 
 ### Example
 
@@ -264,8 +272,8 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **id** | **String**| Unique ID identifying the wallet in your system |
- **txid** | **String**| ID of a specific operation of the wallet |
+ **id** | **String**| Unique identifier of the wallet (specified during [Generate Wallet](#generate_wallet)) |
+ **txid** | **String**| Transaction ID of the operation (returned during [Refund Wallet](#refundwallet) / [Settle Wallet](#settlewallet)) to retrieve |
 
 ### Return type
 
@@ -273,11 +281,19 @@ Name | Type | Description  | Notes
 
 
 
-## get_wallet_operations
+## list_wallet_operations
 
-> PaginatedWalletOperations get_wallet_operations(id, opts)
+> PaginatedWalletOperations list_wallet_operations(id, opts)
 
-Return the list of operations performed by the mechant on a specific wallet
+This method retrieves all operations of a wallet.
+
+### Pagination
+
+The list of operations is returned as an array in the 'results' field. The list is restricted to a maximum of 100 operations per page.
+
+If there are more than 100 operations for a wallet, a cursor is passed 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 operations.
 
 ### Example
 
@@ -298,10 +314,10 @@ opts = {
 
 begin
   #Return the list of operations performed by the mechant on a specific wallet
-  result = api_instance.get_wallet_operations(id, opts)
+  result = api_instance.list_wallet_operations(id, opts)
   p result
 rescue BleumiPay::ApiError => e
-  puts "Exception when calling Erc20PaymentsApi->get_wallet_operations: #{e}"
+  puts "Exception when calling Erc20PaymentsApi->list_wallet_operations: #{e}"
 end
 ```
 
@@ -310,8 +326,8 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **id** | **String**| Unique ID identifying the wallet in your system |
- **next_token** | **String**| Cursor to start results from | [optional]
+ **id** | **String**| Unique identifier of the wallet (specified during [Generate Wallet](#generate_wallet)) |
+ **next_token** | **String**| The token to fetch the next page, supply blank value to get the first page of wallet operations | [optional]
 
 ### Return type
 

data/docs/EthAddress.md

@@ -4,14 +4,5 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**addr** | **String** | Valid Ethereum address string should pass validation pattern | 
-
-## Code Sample
-
-```ruby
-require 'BleumiPay'
-
-instance = BleumiPay::EthAddress.new(addr: null)
-```
-
+**addr** | **String** | Valid Ethereum address string should pass validation pattern: '^0x[a-fA-F0-9]{40}$'| Eg. 0x13e4ACeFE6a6700604929946E70E6443E4E73447
 

data/docs/EthNetwork.md

@@ -1,16 +1,9 @@
 # BleumiPay::EthNetwork
 
-## Properties
-
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-
-## Code Sample
-
-```ruby
-require 'BleumiPay'
-
-instance = BleumiPay::EthNetwork.new()
-```
-
+## Enum
 
+* `BleumiPay::EthNetwork::MAINNET` (value: `"mainnet"`)
+* `BleumiPay::EthNetwork::ROPSTEN` (value: `"ropsten"`)
+* `BleumiPay::EthNetwork::GOERLI` (value: `"goerli"`)
+* `BleumiPay::EthNetwork::KOVAN` (value: `"kovan"`)
+* `BleumiPay::EthNetwork::RINKEBY` (value: `"rinkeby"`)

data/docs/PaginatedWalletOperations.md

@@ -4,5 +4,5 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**results** | [**Array<WalletOperation>**](WalletOperation.md) | List of operations of the wallet in the current page | 
-**next_token** | **String** | Cursor to fetch next page of results, empty if no more results | [optional] 
+**results** | [**Array<WalletOperation>**](WalletOperation.md) | Array of Wallet Operations |
+**next_token** | **String** | Cursor to fetch next set of results. (if next set is available) |

data/docs/PaginatedWallets.md

@@ -4,5 +4,5 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**results** | [**Array<Wallet>**](Wallet.md) | List of wallets in the current page | 
-**next_token** | **String** | Cursor to fetch next page of results, empty if no more results | [optional] 
+**results** | [**Array<Wallet>**](Wallet.md) | Array of Wallets |
+**next_token** | **String** | Cursor to fetch next page of results, empty if no more results |

data/docs/Wallet.md

@@ -4,26 +4,10 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**id** | **String** | Unique ID identifying the wallet; specified when it was created by your system | 
-**chain** | **String** | Ethereum network in which wallet is to be created. Please refer to the [network list](https://pay.bleumi.com/docs/#supported-ethereum-networks) | 
+**id** | **String** | Unique ID identifying the wallet |
+**chain** | **String** | Ethereum network of the wallet. Please refer to the [Supported Ethereum Networks.](https://pay.bleumi.com/docs/#supported-ethereum-networks) |
 **addr** | **String** | Wallet address | 
-**balances** | [**Hash<String, WalletBalance>**](WalletBalance.md) | The current token balance | 
-**inputs** | [**WalletInputs**](WalletInputs.md) |  | 
-**created_at** | **Integer** | UNIX timestamp when the wallet was created | 
-**updated_at** | **Integer** | UNIX timestamp when the lastest operation was performed | 
-
-## Code Sample
-
-```ruby
-require 'BleumiPay'
-
-instance = BleumiPay::Wallet.new(id: null,
-                                 chain: null,
-                                 addr: null,
-                                 balances: null,
-                                 inputs: null,
-                                 created_at: null,
-                                 updated_at: null)
-```
-
-
+**balances** | [**Hash<String, WalletBalance>**](WalletBalance.md) | A dictionary which gives the balance, token-digits and token-balance for each ERC-20 token in the wallet. |
+**inputs** | [**WalletInputs**](WalletInputs.md) | Parameters required to interact with the  [Payment Processor](https://pay.bleumi.com/docs/#payment-processor-address) |
+**created_at** | **Integer** | The created UNIX timestamp of the wallet |
+**updated_at** | **Integer** | The last updated UNIX timestamp of the wallet |