|
| 1 | +# MessenteApi::AccountBalanceApi |
| 2 | + |
| 3 | +All URIs are relative to *https://api.messente.com/v1* |
| 4 | + |
| 5 | +| Method | HTTP request | Description | |
| 6 | +| ------ | ------------ | ----------- | |
| 7 | +| [**get_account_balance**](AccountBalanceApi.md#get_account_balance) | **GET** /get_balance | Get account balance | |
| 8 | +| [**get_account_balance_using_post**](AccountBalanceApi.md#get_account_balance_using_post) | **POST** /get_balance | Get account balance | |
| 9 | + |
| 10 | + |
| 11 | +## get_account_balance |
| 12 | + |
| 13 | +> String get_account_balance(username, password) |
| 14 | +
|
| 15 | +Get account balance |
| 16 | + |
| 17 | +### Examples |
| 18 | + |
| 19 | +```ruby |
| 20 | +require 'time' |
| 21 | +require 'messente_api' |
| 22 | +# setup authorization |
| 23 | +MessenteApi.configure do |config| |
| 24 | + # Configure API key authorization: apiPassword |
| 25 | + config.api_key['password'] = 'YOUR API KEY' |
| 26 | + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) |
| 27 | + # config.api_key_prefix['password'] = 'Bearer' |
| 28 | + |
| 29 | + # Configure API key authorization: apiUsername |
| 30 | + config.api_key['username'] = 'YOUR API KEY' |
| 31 | + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) |
| 32 | + # config.api_key_prefix['username'] = 'Bearer' |
| 33 | +end |
| 34 | + |
| 35 | +api_instance = MessenteApi::AccountBalanceApi.new |
| 36 | +username = 'username_example' # String | The API username |
| 37 | +password = 'password_example' # String | The API password |
| 38 | + |
| 39 | +begin |
| 40 | + # Get account balance |
| 41 | + result = api_instance.get_account_balance(username, password) |
| 42 | + p result |
| 43 | +rescue MessenteApi::ApiError => e |
| 44 | + puts "Error when calling AccountBalanceApi->get_account_balance: #{e}" |
| 45 | +end |
| 46 | +``` |
| 47 | + |
| 48 | +#### Using the get_account_balance_with_http_info variant |
| 49 | + |
| 50 | +This returns an Array which contains the response data, status code and headers. |
| 51 | + |
| 52 | +> <Array(String, Integer, Hash)> get_account_balance_with_http_info(username, password) |
| 53 | +
|
| 54 | +```ruby |
| 55 | +begin |
| 56 | + # Get account balance |
| 57 | + data, status_code, headers = api_instance.get_account_balance_with_http_info(username, password) |
| 58 | + p status_code # => 2xx |
| 59 | + p headers # => { ... } |
| 60 | + p data # => String |
| 61 | +rescue MessenteApi::ApiError => e |
| 62 | + puts "Error when calling AccountBalanceApi->get_account_balance_with_http_info: #{e}" |
| 63 | +end |
| 64 | +``` |
| 65 | + |
| 66 | +### Parameters |
| 67 | + |
| 68 | +| Name | Type | Description | Notes | |
| 69 | +| ---- | ---- | ----------- | ----- | |
| 70 | +| **username** | **String** | The API username | | |
| 71 | +| **password** | **String** | The API password | | |
| 72 | + |
| 73 | +### Return type |
| 74 | + |
| 75 | +**String** |
| 76 | + |
| 77 | +### Authorization |
| 78 | + |
| 79 | +[apiPassword](../README.md#apiPassword), [apiUsername](../README.md#apiUsername) |
| 80 | + |
| 81 | +### HTTP request headers |
| 82 | + |
| 83 | +- **Content-Type**: Not defined |
| 84 | +- **Accept**: text/plain |
| 85 | + |
| 86 | + |
| 87 | +## get_account_balance_using_post |
| 88 | + |
| 89 | +> String get_account_balance_using_post(username, password) |
| 90 | +
|
| 91 | +Get account balance |
| 92 | + |
| 93 | +### Examples |
| 94 | + |
| 95 | +```ruby |
| 96 | +require 'time' |
| 97 | +require 'messente_api' |
| 98 | +# setup authorization |
| 99 | +MessenteApi.configure do |config| |
| 100 | + # Configure API key authorization: apiPassword |
| 101 | + config.api_key['password'] = 'YOUR API KEY' |
| 102 | + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) |
| 103 | + # config.api_key_prefix['password'] = 'Bearer' |
| 104 | + |
| 105 | + # Configure API key authorization: apiUsername |
| 106 | + config.api_key['username'] = 'YOUR API KEY' |
| 107 | + # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil) |
| 108 | + # config.api_key_prefix['username'] = 'Bearer' |
| 109 | +end |
| 110 | + |
| 111 | +api_instance = MessenteApi::AccountBalanceApi.new |
| 112 | +username = 'username_example' # String | The API username |
| 113 | +password = 'password_example' # String | The API password |
| 114 | + |
| 115 | +begin |
| 116 | + # Get account balance |
| 117 | + result = api_instance.get_account_balance_using_post(username, password) |
| 118 | + p result |
| 119 | +rescue MessenteApi::ApiError => e |
| 120 | + puts "Error when calling AccountBalanceApi->get_account_balance_using_post: #{e}" |
| 121 | +end |
| 122 | +``` |
| 123 | + |
| 124 | +#### Using the get_account_balance_using_post_with_http_info variant |
| 125 | + |
| 126 | +This returns an Array which contains the response data, status code and headers. |
| 127 | + |
| 128 | +> <Array(String, Integer, Hash)> get_account_balance_using_post_with_http_info(username, password) |
| 129 | +
|
| 130 | +```ruby |
| 131 | +begin |
| 132 | + # Get account balance |
| 133 | + data, status_code, headers = api_instance.get_account_balance_using_post_with_http_info(username, password) |
| 134 | + p status_code # => 2xx |
| 135 | + p headers # => { ... } |
| 136 | + p data # => String |
| 137 | +rescue MessenteApi::ApiError => e |
| 138 | + puts "Error when calling AccountBalanceApi->get_account_balance_using_post_with_http_info: #{e}" |
| 139 | +end |
| 140 | +``` |
| 141 | + |
| 142 | +### Parameters |
| 143 | + |
| 144 | +| Name | Type | Description | Notes | |
| 145 | +| ---- | ---- | ----------- | ----- | |
| 146 | +| **username** | **String** | The API username | | |
| 147 | +| **password** | **String** | The API password | | |
| 148 | + |
| 149 | +### Return type |
| 150 | + |
| 151 | +**String** |
| 152 | + |
| 153 | +### Authorization |
| 154 | + |
| 155 | +[apiPassword](../README.md#apiPassword), [apiUsername](../README.md#apiUsername) |
| 156 | + |
| 157 | +### HTTP request headers |
| 158 | + |
| 159 | +- **Content-Type**: Not defined |
| 160 | +- **Accept**: text/plain |
| 161 | + |
0 commit comments