Class: Raas::FundController

Inherits:
BaseController show all
Defined in:
lib/raas/controllers/fund_controller.rb

Overview

FundController

Class Attribute Summary collapse

Attributes inherited from BaseController

#http_call_back, #http_client

Instance Method Summary collapse

Methods inherited from BaseController

#execute_request, #initialize, #validate_parameters, #validate_response

Constructor Details

This class inherits a constructor from Raas::BaseController

Class Attribute Details

.instance ⇒ Object

Returns the value of attribute instance.



10
11
12
 
# File 'lib/raas/controllers/fund_controller.rb', line 10

def instance
  @instance
end

Instance Method Details

#add_funds(body) ⇒ Object

Funds an account via credit card

Parameters:

Returns:

  • DepositResponseModel response from the API call



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
181
182
183
 
# File 'lib/raas/controllers/fund_controller.rb', line 133

def add_funds(body)
  begin
    @logger.info("add_funds called.")
    # Validate required parameters.
    @logger.info("Validating required parameters for add_funds.")
    validate_parameters(
      'body' => body
    )
    # Prepare query url.
    @logger.info("Preparing query URL for add_funds.")
    _query_builder = Configuration.get_base_uri
    _query_builder << '/creditCardDeposits'
    _query_url = APIHelper.clean_url _query_builder
  
    # Prepare headers.
    @logger.info("Preparing headers for add_funds.")
    _headers = {
      'accept' => 'application/json',
      'content-type' => 'application/json; charset=utf-8'
    }
  
    # Prepare and execute HttpRequest.
    @logger.info('Preparing and executing HttpRequest for add_funds.')
    _request = @http_client.post(
      _query_url,
      headers: _headers,
      parameters: body.to_json
    )
    BasicAuth.apply(_request)
    _context = execute_request(_request, name: 'add_funds')
  
    # Validate response against endpoint and global error codes.
    @logger.info("Validating response for add_funds.")
    unless _context.response.status_code.between?(200, 208)
      raise RaasGenericException.new(
        'API Error',
        _context
      )
    end
    validate_response(_context)
  
    # Return appropriate response type.
    @logger.info("Returning response for add_funds.")
    decoded = APIHelper.json_deserialize(_context.response.raw_body)
    DepositResponseModel.from_hash(decoded)

  rescue Exception => e
    @logger.error(e)
    raise e
  end
end

#create_register_credit_card(body) ⇒ Object

Registers a new credit card CreateCreditCardRequest object

Parameters:

Returns:

  • CreditCardModel response from the API call



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
335
336
337
338
339
340
341
342
343
 
# File 'lib/raas/controllers/fund_controller.rb', line 293

def create_register_credit_card(body)
  begin
    @logger.info("create_register_credit_card called.")
    # Validate required parameters.
    @logger.info("Validating required parameters for create_register_credit_card.")
    validate_parameters(
      'body' => body
    )
    # Prepare query url.
    @logger.info("Preparing query URL for create_register_credit_card.")
    _query_builder = Configuration.get_base_uri
    _query_builder << '/creditCards'
    _query_url = APIHelper.clean_url _query_builder
  
    # Prepare headers.
    @logger.info("Preparing headers for create_register_credit_card.")
    _headers = {
      'accept' => 'application/json',
      'content-type' => 'application/json; charset=utf-8'
    }
  
    # Prepare and execute HttpRequest.
    @logger.info('Preparing and executing HttpRequest for create_register_credit_card.')
    _request = @http_client.post(
      _query_url,
      headers: _headers,
      parameters: body.to_json
    )
    BasicAuth.apply(_request)
    _context = execute_request(_request, name: 'create_register_credit_card')
  
    # Validate response against endpoint and global error codes.
    @logger.info("Validating response for create_register_credit_card.")
    unless _context.response.status_code.between?(200, 208)
      raise RaasGenericException.new(
        'API Error',
        _context
      )
    end
    validate_response(_context)
  
    # Return appropriate response type.
    @logger.info("Returning response for create_register_credit_card.")
    decoded = APIHelper.json_deserialize(_context.response.raw_body)
    CreditCardModel.from_hash(decoded)

  rescue Exception => e
    @logger.error(e)
    raise e
  end
end

#create_unregister_credit_card(body) ⇒ Object

Unregister a credit card Example:

Parameters:

Returns:

  • UnregisterCreditCardResponseModel response from the API call



21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
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
 
# File 'lib/raas/controllers/fund_controller.rb', line 21

def create_unregister_credit_card(body)
  begin
    @logger.info("create_unregister_credit_card called.")
    # Validate required parameters.
    @logger.info("Validating required parameters for create_unregister_credit_card.")
    validate_parameters(
      'body' => body
    )
    # Prepare query url.
    @logger.info("Preparing query URL for create_unregister_credit_card.")
    _query_builder = Configuration.get_base_uri
    _query_builder << '/creditCardUnregisters'
    _query_url = APIHelper.clean_url _query_builder
  
    # Prepare headers.
    @logger.info("Preparing headers for create_unregister_credit_card.")
    _headers = {
      'accept' => 'application/json',
      'content-type' => 'application/json; charset=utf-8'
    }
  
    # Prepare and execute HttpRequest.
    @logger.info('Preparing and executing HttpRequest for create_unregister_credit_card.')
    _request = @http_client.post(
      _query_url,
      headers: _headers,
      parameters: body.to_json
    )
    BasicAuth.apply(_request)
    _context = execute_request(_request, name: 'create_unregister_credit_card')
  
    # Validate response against endpoint and global error codes.
    @logger.info("Validating response for create_unregister_credit_card.")
    unless _context.response.status_code.between?(200, 208)
      raise RaasGenericException.new(
        'API Error',
        _context
      )
    end
    validate_response(_context)
  
    # Return appropriate response type.
    @logger.info("Returning response for create_unregister_credit_card.")
    decoded = APIHelper.json_deserialize(_context.response.raw_body)
    UnregisterCreditCardResponseModel.from_hash(decoded)

  rescue Exception => e
    @logger.error(e)
    raise e
  end
end

#get_credit_card(token) ⇒ Object

Retrieves details for a single credit card

Parameters:

  • token (String) —

    Required parameter: Credit Card Token

Returns:

  • CreditCardModel response from the API call



235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
 
# File 'lib/raas/controllers/fund_controller.rb', line 235

def get_credit_card(token)
  begin
    @logger.info("get_credit_card called.")
    # Validate required parameters.
    @logger.info("Validating required parameters for get_credit_card.")
    validate_parameters(
      'token' => token
    )
    # Prepare query url.
    @logger.info("Preparing query URL for get_credit_card.")
    _query_builder = Configuration.get_base_uri
    _query_builder << '/creditCards/{token}'
    _query_builder = APIHelper.append_url_with_template_parameters(
      _query_builder,
      'token' => token
    )
    _query_url = APIHelper.clean_url _query_builder
  
    # Prepare headers.
    @logger.info("Preparing headers for get_credit_card.")
    _headers = {
      'accept' => 'application/json'
    }
  
    # Prepare and execute HttpRequest.
    @logger.info('Preparing and executing HttpRequest for get_credit_card.')
    _request = @http_client.get(
      _query_url,
      headers: _headers
    )
    BasicAuth.apply(_request)
    _context = execute_request(_request, name: 'get_credit_card')
  
    # Validate response against endpoint and global error codes.
    @logger.info("Validating response for get_credit_card.")
    unless _context.response.status_code.between?(200, 208)
      raise RaasGenericException.new(
        'API Error',
        _context
      )
    end
    validate_response(_context)
  
    # Return appropriate response type.
    @logger.info("Returning response for get_credit_card.")
    decoded = APIHelper.json_deserialize(_context.response.raw_body)
    CreditCardModel.from_hash(decoded)

  rescue Exception => e
    @logger.error(e)
    raise e
  end
end

#get_credit_cards ⇒ Object

Retrieves all credit cards registered on the platform

Returns:

  • List of CreditCardModel response from the API call



187
188
189
190
191
192
193
194
195
196
197
198
199
200
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
 
# File 'lib/raas/controllers/fund_controller.rb', line 187

def get_credit_cards
  begin
    @logger.info("get_credit_cards called.")
    # Prepare query url.
    @logger.info("Preparing query URL for get_credit_cards.")
    _query_builder = Configuration.get_base_uri
    _query_builder << '/creditCards'
    _query_url = APIHelper.clean_url _query_builder
  
    # Prepare headers.
    @logger.info("Preparing headers for get_credit_cards.")
    _headers = {
      'accept' => 'application/json'
    }
  
    # Prepare and execute HttpRequest.
    @logger.info('Preparing and executing HttpRequest for get_credit_cards.')
    _request = @http_client.get(
      _query_url,
      headers: _headers
    )
    BasicAuth.apply(_request)
    _context = execute_request(_request, name: 'get_credit_cards')
  
    # Validate response against endpoint and global error codes.
    @logger.info("Validating response for get_credit_cards.")
    unless _context.response.status_code.between?(200, 208)
      raise RaasGenericException.new(
        'API Error',
        _context
      )
    end
    validate_response(_context)
  
    # Return appropriate response type.
    @logger.info("Returning response for get_credit_cards.")
    decoded = APIHelper.json_deserialize(_context.response.raw_body)
    decoded.map { |element| CreditCardModel.from_hash(element) }

  rescue Exception => e
    @logger.error(e)
    raise e
  end
end

#get_deposit(deposit_id) ⇒ Object

Get details for a specific credit card deposit

Parameters:

  • deposit_id (String) —

    Required parameter: The reference deposit id

Returns:

  • GetDepositResponseModel response from the API call



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
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
 
# File 'lib/raas/controllers/fund_controller.rb', line 76

def get_deposit(deposit_id)
  begin
    @logger.info("get_deposit called.")
    # Validate required parameters.
    @logger.info("Validating required parameters for get_deposit.")
    validate_parameters(
      'deposit_id' => deposit_id
    )
    # Prepare query url.
    @logger.info("Preparing query URL for get_deposit.")
    _query_builder = Configuration.get_base_uri
    _query_builder << '/creditCardDeposits/{depositId}'
    _query_builder = APIHelper.append_url_with_template_parameters(
      _query_builder,
      'depositId' => deposit_id
    )
    _query_url = APIHelper.clean_url _query_builder
  
    # Prepare headers.
    @logger.info("Preparing headers for get_deposit.")
    _headers = {
      'accept' => 'application/json'
    }
  
    # Prepare and execute HttpRequest.
    @logger.info('Preparing and executing HttpRequest for get_deposit.')
    _request = @http_client.get(
      _query_url,
      headers: _headers
    )
    BasicAuth.apply(_request)
    _context = execute_request(_request, name: 'get_deposit')
  
    # Validate response against endpoint and global error codes.
    @logger.info("Validating response for get_deposit.")
    unless _context.response.status_code.between?(200, 208)
      raise RaasGenericException.new(
        'API Error',
        _context
      )
    end
    validate_response(_context)
  
    # Return appropriate response type.
    @logger.info("Returning response for get_deposit.")
    decoded = APIHelper.json_deserialize(_context.response.raw_body)
    GetDepositResponseModel.from_hash(decoded)

  rescue Exception => e
    @logger.error(e)
    raise e
  end
end

#instance ⇒ Object 



13
14
15
 
# File 'lib/raas/controllers/fund_controller.rb', line 13

def instance
  self.class.instance
end