Class: Raas::AccountsController

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

Overview

AccountsController

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/accounts_controller.rb', line 10

def instance
  @instance
end

Instance Method Details

#create_account(customer_identifier, body) ⇒ Object

Creates an account under a given customer Identifier

Parameters:

Returns:

  • AccountModel response from the API call



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
129
130
131
132
133
134
135
136
 
# File 'lib/raas/controllers/accounts_controller.rb', line 80

def (customer_identifier,
                   body)
  begin
    @logger.info("create_account called.")
    # Validate required parameters.
    @logger.info("Validating required parameters for create_account.")
    validate_parameters(
      'customer_identifier' => customer_identifier,
      'body' => body
    )
    # Prepare query url.
    @logger.info("Preparing query URL for create_account.")
    _query_builder = Configuration.get_base_uri
    _query_builder << '/customers/{customerIdentifier}/accounts'
    _query_builder = APIHelper.append_url_with_template_parameters(
      _query_builder,
      'customerIdentifier' => customer_identifier
    )
    _query_url = APIHelper.clean_url _query_builder
  
    # Prepare headers.
    @logger.info("Preparing headers for create_account.")
    _headers = {
      'accept' => 'application/json',
      'content-type' => 'application/json; charset=utf-8'
    }
  
    # Prepare and execute HttpRequest.
    @logger.info('Preparing and executing HttpRequest for create_account.')
    _request = @http_client.post(
      _query_url,
      headers: _headers,
      parameters: body.to_json
    )
    BasicAuth.apply(_request)
    _context = execute_request(_request, name: 'create_account')
  
    # Validate response against endpoint and global error codes.
    @logger.info("Validating response for create_account.")
    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_account.")
    decoded = APIHelper.json_deserialize(_context.response.raw_body)
    AccountModel.from_hash(decoded)

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

#get_account(account_identifier) ⇒ Object

Retrieves a single account Identifier

Parameters:

  • account_identifier (String) —

    Required parameter: Account

Returns:

  • AccountModel response from the API call



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
231
232
233
234
235
236
237
238
239
240
241
 
# File 'lib/raas/controllers/accounts_controller.rb', line 189

def ()
  begin
    @logger.info("get_account called.")
    # Validate required parameters.
    @logger.info("Validating required parameters for get_account.")
    validate_parameters(
      'account_identifier' => 
    )
    # Prepare query url.
    @logger.info("Preparing query URL for get_account.")
    _query_builder = Configuration.get_base_uri
    _query_builder << '/accounts/{accountIdentifier}'
    _query_builder = APIHelper.append_url_with_template_parameters(
      _query_builder,
      'accountIdentifier' => 
    )
    _query_url = APIHelper.clean_url _query_builder
  
    # Prepare headers.
    @logger.info("Preparing headers for get_account.")
    _headers = {
      'accept' => 'application/json'
    }
  
    # Prepare and execute HttpRequest.
    @logger.info('Preparing and executing HttpRequest for get_account.')
    _request = @http_client.get(
      _query_url,
      headers: _headers
    )
    BasicAuth.apply(_request)
    _context = execute_request(_request, name: 'get_account')
  
    # Validate response against endpoint and global error codes.
    @logger.info("Validating response for get_account.")
    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_account.")
    decoded = APIHelper.json_deserialize(_context.response.raw_body)
    AccountModel.from_hash(decoded)

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

#get_accounts_by_customer(customer_identifier) ⇒ Object

Retrieves a list of accounts for a given customer Identifier

Parameters:

  • customer_identifier (String) —

    Required parameter: Customer

Returns:

  • List of AccountSummaryModel 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
72
73
 
# File 'lib/raas/controllers/accounts_controller.rb', line 21

def get_accounts_by_customer(customer_identifier)
  begin
    @logger.info("get_accounts_by_customer called.")
    # Validate required parameters.
    @logger.info("Validating required parameters for get_accounts_by_customer.")
    validate_parameters(
      'customer_identifier' => customer_identifier
    )
    # Prepare query url.
    @logger.info("Preparing query URL for get_accounts_by_customer.")
    _query_builder = Configuration.get_base_uri
    _query_builder << '/customers/{customerIdentifier}/accounts'
    _query_builder = APIHelper.append_url_with_template_parameters(
      _query_builder,
      'customerIdentifier' => customer_identifier
    )
    _query_url = APIHelper.clean_url _query_builder
  
    # Prepare headers.
    @logger.info("Preparing headers for get_accounts_by_customer.")
    _headers = {
      'accept' => 'application/json'
    }
  
    # Prepare and execute HttpRequest.
    @logger.info('Preparing and executing HttpRequest for get_accounts_by_customer.')
    _request = @http_client.get(
      _query_url,
      headers: _headers
    )
    BasicAuth.apply(_request)
    _context = execute_request(_request, name: 'get_accounts_by_customer')
  
    # Validate response against endpoint and global error codes.
    @logger.info("Validating response for get_accounts_by_customer.")
    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_accounts_by_customer.")
    decoded = APIHelper.json_deserialize(_context.response.raw_body)
    decoded.map { |element| AccountSummaryModel.from_hash(element) }

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

#get_all_accounts ⇒ Object

Retrieves all accounts under the platform

Returns:

  • List of AccountModel response from the API call



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/accounts_controller.rb', line 140

def get_all_accounts
  begin
    @logger.info("get_all_accounts called.")
    # Prepare query url.
    @logger.info("Preparing query URL for get_all_accounts.")
    _query_builder = Configuration.get_base_uri
    _query_builder << '/accounts'
    _query_url = APIHelper.clean_url _query_builder
  
    # Prepare headers.
    @logger.info("Preparing headers for get_all_accounts.")
    _headers = {
      'accept' => 'application/json'
    }
  
    # Prepare and execute HttpRequest.
    @logger.info('Preparing and executing HttpRequest for get_all_accounts.')
    _request = @http_client.get(
      _query_url,
      headers: _headers
    )
    BasicAuth.apply(_request)
    _context = execute_request(_request, name: 'get_all_accounts')
  
    # Validate response against endpoint and global error codes.
    @logger.info("Validating response for get_all_accounts.")
    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_all_accounts.")
    decoded = APIHelper.json_deserialize(_context.response.raw_body)
    decoded.map { |element| AccountModel.from_hash(element) }

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

#instance ⇒ Object 



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

def instance
  self.class.instance
end