Class: Coinbase::Client::FundApi
- Inherits:
-
Object
- Object
- Coinbase::Client::FundApi
- Defined in:
- lib/coinbase/client/api/fund_api.rb
Instance Attribute Summary collapse
-
#api_client ⇒ Object
Returns the value of attribute api_client.
Instance Method Summary collapse
-
#create_fund_operation(wallet_id, address_id, create_fund_operation_request, opts = {}) ⇒ FundOperation
Create a new fund operation.
-
#create_fund_operation_with_http_info(wallet_id, address_id, create_fund_operation_request, opts = {}) ⇒ Array<(FundOperation, Integer, Hash)>
Create a new fund operation.
-
#create_fund_quote(wallet_id, address_id, create_fund_quote_request, opts = {}) ⇒ FundQuote
Create a Fund Operation quote.
-
#create_fund_quote_with_http_info(wallet_id, address_id, create_fund_quote_request, opts = {}) ⇒ Array<(FundQuote, Integer, Hash)>
Create a Fund Operation quote.
-
#get_fund_operation(wallet_id, address_id, fund_operation_id, opts = {}) ⇒ FundOperation
Get fund operation.
-
#get_fund_operation_with_http_info(wallet_id, address_id, fund_operation_id, opts = {}) ⇒ Array<(FundOperation, Integer, Hash)>
Get fund operation.
-
#initialize(api_client = ApiClient.default) ⇒ FundApi
constructor
A new instance of FundApi.
-
#list_fund_operations(wallet_id, address_id, opts = {}) ⇒ FundOperationList
List fund operations for an address.
-
#list_fund_operations_with_http_info(wallet_id, address_id, opts = {}) ⇒ Array<(FundOperationList, Integer, Hash)>
List fund operations for an address.
Constructor Details
Instance Attribute Details
#api_client ⇒ Object
Returns the value of attribute api_client.
17 18 19 |
# File 'lib/coinbase/client/api/fund_api.rb', line 17 def api_client @api_client end |
Instance Method Details
#create_fund_operation(wallet_id, address_id, create_fund_operation_request, opts = {}) ⇒ FundOperation
Create a new fund operation. Create a new fund operation with an address.
29 30 31 32 |
# File 'lib/coinbase/client/api/fund_api.rb', line 29 def create_fund_operation(wallet_id, address_id, create_fund_operation_request, opts = {}) data, _status_code, _headers = create_fund_operation_with_http_info(wallet_id, address_id, create_fund_operation_request, opts) data end |
#create_fund_operation_with_http_info(wallet_id, address_id, create_fund_operation_request, opts = {}) ⇒ Array<(FundOperation, Integer, Hash)>
Create a new fund operation. Create a new fund operation with an address.
41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 |
# File 'lib/coinbase/client/api/fund_api.rb', line 41 def create_fund_operation_with_http_info(wallet_id, address_id, create_fund_operation_request, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: FundApi.create_fund_operation ...' end # verify the required parameter 'wallet_id' is set if @api_client.config.client_side_validation && wallet_id.nil? fail ArgumentError, "Missing the required parameter 'wallet_id' when calling FundApi.create_fund_operation" end # verify the required parameter 'address_id' is set if @api_client.config.client_side_validation && address_id.nil? fail ArgumentError, "Missing the required parameter 'address_id' when calling FundApi.create_fund_operation" end # verify the required parameter 'create_fund_operation_request' is set if @api_client.config.client_side_validation && create_fund_operation_request.nil? fail ArgumentError, "Missing the required parameter 'create_fund_operation_request' when calling FundApi.create_fund_operation" end # resource path local_var_path = '/v1/wallets/{wallet_id}/addresses/{address_id}/fund_operations'.sub('{' + 'wallet_id' + '}', CGI.escape(wallet_id.to_s)).sub('{' + 'address_id' + '}', CGI.escape(address_id.to_s)) # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept'] # HTTP header 'Content-Type' content_type = @api_client.select_header_content_type(['application/json']) if !content_type.nil? header_params['Content-Type'] = content_type end # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] || @api_client.object_to_http_body(create_fund_operation_request) # return_type return_type = opts[:debug_return_type] || 'FundOperation' # auth_names auth_names = opts[:debug_auth_names] || ['apiKey'] = opts.merge( :operation => :"FundApi.create_fund_operation", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:POST, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: FundApi#create_fund_operation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#create_fund_quote(wallet_id, address_id, create_fund_quote_request, opts = {}) ⇒ FundQuote
Create a Fund Operation quote. Create a new fund operation with an address.
109 110 111 112 |
# File 'lib/coinbase/client/api/fund_api.rb', line 109 def create_fund_quote(wallet_id, address_id, create_fund_quote_request, opts = {}) data, _status_code, _headers = create_fund_quote_with_http_info(wallet_id, address_id, create_fund_quote_request, opts) data end |
#create_fund_quote_with_http_info(wallet_id, address_id, create_fund_quote_request, opts = {}) ⇒ Array<(FundQuote, Integer, Hash)>
Create a Fund Operation quote. Create a new fund operation with an address.
121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 |
# File 'lib/coinbase/client/api/fund_api.rb', line 121 def create_fund_quote_with_http_info(wallet_id, address_id, create_fund_quote_request, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: FundApi.create_fund_quote ...' end # verify the required parameter 'wallet_id' is set if @api_client.config.client_side_validation && wallet_id.nil? fail ArgumentError, "Missing the required parameter 'wallet_id' when calling FundApi.create_fund_quote" end # verify the required parameter 'address_id' is set if @api_client.config.client_side_validation && address_id.nil? fail ArgumentError, "Missing the required parameter 'address_id' when calling FundApi.create_fund_quote" end # verify the required parameter 'create_fund_quote_request' is set if @api_client.config.client_side_validation && create_fund_quote_request.nil? fail ArgumentError, "Missing the required parameter 'create_fund_quote_request' when calling FundApi.create_fund_quote" end # resource path local_var_path = '/v1/wallets/{wallet_id}/addresses/{address_id}/fund_operations/quote'.sub('{' + 'wallet_id' + '}', CGI.escape(wallet_id.to_s)).sub('{' + 'address_id' + '}', CGI.escape(address_id.to_s)) # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept'] # HTTP header 'Content-Type' content_type = @api_client.select_header_content_type(['application/json']) if !content_type.nil? header_params['Content-Type'] = content_type end # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] || @api_client.object_to_http_body(create_fund_quote_request) # return_type return_type = opts[:debug_return_type] || 'FundQuote' # auth_names auth_names = opts[:debug_auth_names] || ['apiKey'] = opts.merge( :operation => :"FundApi.create_fund_quote", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:POST, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: FundApi#create_fund_quote\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#get_fund_operation(wallet_id, address_id, fund_operation_id, opts = {}) ⇒ FundOperation
Get fund operation. Get fund operation.
189 190 191 192 |
# File 'lib/coinbase/client/api/fund_api.rb', line 189 def get_fund_operation(wallet_id, address_id, fund_operation_id, opts = {}) data, _status_code, _headers = get_fund_operation_with_http_info(wallet_id, address_id, fund_operation_id, opts) data end |
#get_fund_operation_with_http_info(wallet_id, address_id, fund_operation_id, opts = {}) ⇒ Array<(FundOperation, Integer, Hash)>
Get fund operation. Get fund operation.
201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 |
# File 'lib/coinbase/client/api/fund_api.rb', line 201 def get_fund_operation_with_http_info(wallet_id, address_id, fund_operation_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: FundApi.get_fund_operation ...' end # verify the required parameter 'wallet_id' is set if @api_client.config.client_side_validation && wallet_id.nil? fail ArgumentError, "Missing the required parameter 'wallet_id' when calling FundApi.get_fund_operation" end # verify the required parameter 'address_id' is set if @api_client.config.client_side_validation && address_id.nil? fail ArgumentError, "Missing the required parameter 'address_id' when calling FundApi.get_fund_operation" end # verify the required parameter 'fund_operation_id' is set if @api_client.config.client_side_validation && fund_operation_id.nil? fail ArgumentError, "Missing the required parameter 'fund_operation_id' when calling FundApi.get_fund_operation" end # resource path local_var_path = '/v1/wallets/{wallet_id}/addresses/{address_id}/fund_operations/{fund_operation_id}'.sub('{' + 'wallet_id' + '}', CGI.escape(wallet_id.to_s)).sub('{' + 'address_id' + '}', CGI.escape(address_id.to_s)).sub('{' + 'fund_operation_id' + '}', CGI.escape(fund_operation_id.to_s)) # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept'] # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'FundOperation' # auth_names auth_names = opts[:debug_auth_names] || ['apiKey', 'session'] = opts.merge( :operation => :"FundApi.get_fund_operation", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: FundApi#get_fund_operation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#list_fund_operations(wallet_id, address_id, opts = {}) ⇒ FundOperationList
List fund operations for an address. List fund operations for an address.
265 266 267 268 |
# File 'lib/coinbase/client/api/fund_api.rb', line 265 def list_fund_operations(wallet_id, address_id, opts = {}) data, _status_code, _headers = list_fund_operations_with_http_info(wallet_id, address_id, opts) data end |
#list_fund_operations_with_http_info(wallet_id, address_id, opts = {}) ⇒ Array<(FundOperationList, Integer, Hash)>
List fund operations for an address. List fund operations for an address.
278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 |
# File 'lib/coinbase/client/api/fund_api.rb', line 278 def list_fund_operations_with_http_info(wallet_id, address_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: FundApi.list_fund_operations ...' end # verify the required parameter 'wallet_id' is set if @api_client.config.client_side_validation && wallet_id.nil? fail ArgumentError, "Missing the required parameter 'wallet_id' when calling FundApi.list_fund_operations" end # verify the required parameter 'address_id' is set if @api_client.config.client_side_validation && address_id.nil? fail ArgumentError, "Missing the required parameter 'address_id' when calling FundApi.list_fund_operations" end if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'].to_s.length > 5000 fail ArgumentError, 'invalid value for "opts[:"page"]" when calling FundApi.list_fund_operations, the character length must be smaller than or equal to 5000.' end # resource path local_var_path = '/v1/wallets/{wallet_id}/addresses/{address_id}/fund_operations'.sub('{' + 'wallet_id' + '}', CGI.escape(wallet_id.to_s)).sub('{' + 'address_id' + '}', CGI.escape(address_id.to_s)) # query parameters query_params = opts[:query_params] || {} query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil? query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil? # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept'] # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'FundOperationList' # auth_names auth_names = opts[:debug_auth_names] || ['apiKey', 'session'] = opts.merge( :operation => :"FundApi.list_fund_operations", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: FundApi#list_fund_operations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |