Class: OpenapiClient::CurrencyConversionApi

Inherits:
Object
  • Object
show all
Defined in:
lib/openapi_client/api/currency_conversion_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ CurrencyConversionApi 



19
20
21
 
# File 'lib/openapi_client/api/currency_conversion_api.rb', line 19

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/openapi_client/api/currency_conversion_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#get_exchange_rate(content_type, client_request_id, api_key, timestamp, exchange_rate_request, opts = {}) ⇒ ExchangeRateResponse

Generate dynamic currency conversion transactions. Sale, return and lookup exchange rate with dynamic currency conversion option.

Options Hash (opts):

  • :message_signature (String) —

    Used to ensure the request has not been tampered with during transmission. The Message-Signature is the Base64 encoded HMAC hash (SHA256 algorithm with the API Secret as the key.) For more information, refer to the supporting documentation on the Developer Portal.

  • :region (String) —

    Indicates the region where the client wants the transaction to be processed. This will override the default processing region identified for the client. Available options are argentina, brazil, germany, india and northamerica. Region specific store setup and APIGEE boarding is required in order to use an alternate region for processing.



33
34
35
36
 
# File 'lib/openapi_client/api/currency_conversion_api.rb', line 33

def get_exchange_rate(content_type, client_request_id, api_key, timestamp, exchange_rate_request, opts = {})
  data, _status_code, _headers = get_exchange_rate_with_http_info(content_type, client_request_id, api_key, timestamp, exchange_rate_request, opts)
  data
end

#get_exchange_rate_with_http_info(content_type, client_request_id, api_key, timestamp, exchange_rate_request, opts = {}) ⇒ Array<(ExchangeRateResponse, Integer, Hash)>

Generate dynamic currency conversion transactions. Sale, return and lookup exchange rate with dynamic currency conversion option.

Options Hash (opts):

  • :message_signature (String) —

    Used to ensure the request has not been tampered with during transmission. The Message-Signature is the Base64 encoded HMAC hash (SHA256 algorithm with the API Secret as the key.) For more information, refer to the supporting documentation on the Developer Portal.

  • :region (String) —

    Indicates the region where the client wants the transaction to be processed. This will override the default processing region identified for the client. Available options are argentina, brazil, germany, india and northamerica. Region specific store setup and APIGEE boarding is required in order to use an alternate region for processing.



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
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
 
# File 'lib/openapi_client/api/currency_conversion_api.rb', line 49

def get_exchange_rate_with_http_info(content_type, client_request_id, api_key, timestamp, exchange_rate_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CurrencyConversionApi.get_exchange_rate ...'
  end
  # verify the required parameter 'content_type' is set
  if @api_client.config.client_side_validation && content_type.nil?
    fail ArgumentError, "Missing the required parameter 'content_type' when calling CurrencyConversionApi.get_exchange_rate"
  end
  # verify enum value
  allowable_values = ["application/json"]
  if @api_client.config.client_side_validation && !allowable_values.include?(content_type)
    fail ArgumentError, "invalid value for \"content_type\", must be one of #{allowable_values}"
  end
  # verify the required parameter 'client_request_id' is set
  if @api_client.config.client_side_validation && client_request_id.nil?
    fail ArgumentError, "Missing the required parameter 'client_request_id' when calling CurrencyConversionApi.get_exchange_rate"
  end
  # verify the required parameter 'api_key' is set
  if @api_client.config.client_side_validation && api_key.nil?
    fail ArgumentError, "Missing the required parameter 'api_key' when calling CurrencyConversionApi.get_exchange_rate"
  end
  # verify the required parameter 'timestamp' is set
  if @api_client.config.client_side_validation && timestamp.nil?
    fail ArgumentError, "Missing the required parameter 'timestamp' when calling CurrencyConversionApi.get_exchange_rate"
  end
  # verify the required parameter 'exchange_rate_request' is set
  if @api_client.config.client_side_validation && exchange_rate_request.nil?
    fail ArgumentError, "Missing the required parameter 'exchange_rate_request' when calling CurrencyConversionApi.get_exchange_rate"
  end
  # resource path
  local_var_path = '/exchange-rates'

  # 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'])
  # HTTP header 'Content-Type'
  # header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
  # header_params[:'Content-Type'] = content_type
  header_params[:'Client-Request-Id'] = client_request_id
  header_params[:'Api-Key'] = api_key
  header_params[:'Timestamp'] = timestamp
  header_params[:'Message-Signature'] = opts[:'message_signature'] if !opts[:'message_signature'].nil?
  header_params[:'Region'] = opts[:'region'] if !opts[:'region'].nil?

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(exchange_rate_request) 

  # return_type
  return_type = opts[:return_type] || 'ExchangeRateResponse' 

  # auth_names
  auth_names = opts[:auth_names] || []

  new_options = opts.merge(
    :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, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CurrencyConversionApi#get_exchange_rate\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end