Class: PaymentsApi::QuotesController

Inherits:
BaseController show all
Defined in:
lib/payments_api/controllers/quotes_controller.rb

Overview

QuotesController

Instance Attribute Summary

Attributes inherited from BaseController

#config, #http_call_back

Instance Method Summary collapse

Methods inherited from BaseController

#execute_request, #validate_parameters, #validate_response

Constructor Details

#initialize(config, http_call_back: nil) ⇒ QuotesController

Returns a new instance of QuotesController.



9
10
11
 
# File 'lib/payments_api/controllers/quotes_controller.rb', line 9

def initialize(config, http_call_back: nil)
  super(config, http_call_back: http_call_back)
end

Instance Method Details

#cancel_quote(bank_id, quote_id) ⇒ void

This method returns an undefined value.

Attempts to cancel a Quote

Parameters:

  • bank_id (String) —

    Required parameter: Bank ID (Routing Number)

  • quote_id (Integer) —

    Required parameter: ID of quote to refresh



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
101
102
103
104
105
106
107
108
109
110
 
# File 'lib/payments_api/controllers/quotes_controller.rb', line 68

def cancel_quote(bank_id,
                 quote_id)
  # Prepare query url.
  _query_builder = config.get_base_uri
  _query_builder << '/quotes/{quoteId}'
  _query_builder = APIHelper.append_url_with_template_parameters(
    _query_builder,
    'quoteId' => { 'value' => quote_id, 'encode' => true }
  )
  _query_url = APIHelper.clean_url _query_builder

  # Prepare headers.
  _headers = {
    'bankId' => bank_id
  }

  # Prepare and execute HttpRequest.
  _request = config.http_client.delete(
    _query_url,
    headers: _headers
  )
  CustomHeaderAuth.apply(config, _request)
  _response = execute_request(_request)

  # Validate response against endpoint and global error codes.
  if _response.status_code == 400
    raise RequestErrorException.new(
      'Error in Request',
      _response
    )
  elsif _response.status_code == 403
    raise APIException.new(
      'Forbidden',
      _response
    )
  elsif _response.status_code == 500
    raise RequestErrorException.new(
      'System Error',
      _response
    )
  end
  validate_response(_response)
end

#create_quote(bank_id, body) ⇒ Quote

Create new Quote

Parameters:

  • bank_id (String) —

    Required parameter: Bank ID (Routing Number)

  • body (Quote) —

    Required parameter: Quote data

Returns:

  • (Quote) —

    response from the API call



17
18
19
20
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
 
# File 'lib/payments_api/controllers/quotes_controller.rb', line 17

def create_quote(bank_id,
                 body)
  # Prepare query url.
  _query_builder = config.get_base_uri
  _query_builder << '/quotes'
  _query_url = APIHelper.clean_url _query_builder

  # Prepare headers.
  _headers = {
    'accept' => 'application/json',
    'content-type' => 'application/json; charset=utf-8',
    'bankId' => bank_id
  }

  # Prepare and execute HttpRequest.
  _request = config.http_client.post(
    _query_url,
    headers: _headers,
    parameters: body.to_json
  )
  CustomHeaderAuth.apply(config, _request)
  _response = execute_request(_request)

  # Validate response against endpoint and global error codes.
  if _response.status_code == 400
    raise RequestErrorException.new(
      'Error in Request',
      _response
    )
  elsif _response.status_code == 403
    raise APIException.new(
      'Forbidden',
      _response
    )
  elsif _response.status_code == 500
    raise RequestErrorException.new(
      'System Error',
      _response
    )
  end
  validate_response(_response)

  # Return appropriate response type.
  decoded = APIHelper.json_deserialize(_response.raw_body)
  Quote.from_hash(decoded)
end

#lock_quote(bank_id, quote_id) ⇒ void

This method returns an undefined value.

Lock the rate for a given Quote

Parameters:

  • bank_id (String) —

    Required parameter: Bank ID (Routing Number)

  • quote_id (Integer) —

    Required parameter: ID of quote to lock



116
117
118
119
120
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
 
# File 'lib/payments_api/controllers/quotes_controller.rb', line 116

def lock_quote(bank_id,
               quote_id)
  # Prepare query url.
  _query_builder = config.get_base_uri
  _query_builder << '/quotes/{quoteId}/lock'
  _query_builder = APIHelper.append_url_with_template_parameters(
    _query_builder,
    'quoteId' => { 'value' => quote_id, 'encode' => true }
  )
  _query_url = APIHelper.clean_url _query_builder

  # Prepare headers.
  _headers = {
    'bankId' => bank_id
  }

  # Prepare and execute HttpRequest.
  _request = config.http_client.post(
    _query_url,
    headers: _headers
  )
  CustomHeaderAuth.apply(config, _request)
  _response = execute_request(_request)

  # Validate response against endpoint and global error codes.
  if _response.status_code == 400
    raise RequestErrorException.new(
      'Error in Request',
      _response
    )
  elsif _response.status_code == 403
    raise APIException.new(
      'Forbidden',
      _response
    )
  elsif _response.status_code == 500
    raise RequestErrorException.new(
      'System Error',
      _response
    )
  end
  validate_response(_response)
end

#refresh_quote(bank_id, quote_id) ⇒ Quote

Refresh the rates for an existing Quote

Parameters:

  • bank_id (String) —

    Required parameter: Bank ID (Routing Number)

  • quote_id (Integer) —

    Required parameter: ID of quote to refresh

Returns:

  • (Quote) —

    response from the API call



164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
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
 
# File 'lib/payments_api/controllers/quotes_controller.rb', line 164

def refresh_quote(bank_id,
                  quote_id)
  # Prepare query url.
  _query_builder = config.get_base_uri
  _query_builder << '/quotes/{quoteId}/refresh'
  _query_builder = APIHelper.append_url_with_template_parameters(
    _query_builder,
    'quoteId' => { 'value' => quote_id, 'encode' => true }
  )
  _query_url = APIHelper.clean_url _query_builder

  # Prepare headers.
  _headers = {
    'accept' => 'application/json',
    'bankId' => bank_id
  }

  # Prepare and execute HttpRequest.
  _request = config.http_client.post(
    _query_url,
    headers: _headers
  )
  CustomHeaderAuth.apply(config, _request)
  _response = execute_request(_request)

  # Validate response against endpoint and global error codes.
  if _response.status_code == 400
    raise RequestErrorException.new(
      'Error in Request',
      _response
    )
  elsif _response.status_code == 403
    raise APIException.new(
      'Forbidden',
      _response
    )
  elsif _response.status_code == 500
    raise RequestErrorException.new(
      'System Error',
      _response
    )
  end
  validate_response(_response)

  # Return appropriate response type.
  decoded = APIHelper.json_deserialize(_response.raw_body)
  Quote.from_hash(decoded)
end