Class: CyberSource::InlineResponse2018OrderInformationCurrencyConversionOffer

Inherits:
Object
  • Object
show all
Defined in:
lib/cybersource_rest_client/models/inline_response_201_8_order_information_currency_conversion_offer.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ InlineResponse2018OrderInformationCurrencyConversionOffer

Initializes the object



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
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
 
# File 'lib/cybersource_rest_client/models/inline_response_201_8_order_information_currency_conversion_offer.rb', line 102

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  if attributes.has_key?(:'originalAmount')
    self.original_amount = attributes[:'originalAmount']
  end

  if attributes.has_key?(:'originalCurrency')
    self.original_currency = attributes[:'originalCurrency']
  end

  if attributes.has_key?(:'amount')
    self.amount = attributes[:'amount']
  end

  if attributes.has_key?(:'currency')
    self.currency = attributes[:'currency']
  end

  if attributes.has_key?(:'exchangeRate')
    self.exchange_rate = attributes[:'exchangeRate']
  end

  if attributes.has_key?(:'exchangeRateInverted')
    self.exchange_rate_inverted = attributes[:'exchangeRateInverted']
  end

  if attributes.has_key?(:'marginRate')
    self.margin_rate = attributes[:'marginRate']
  end

  if attributes.has_key?(:'rateSource')
    self.rate_source = attributes[:'rateSource']
  end

  if attributes.has_key?(:'exchangeRateTimeUtc')
    self.exchange_rate_time_utc = attributes[:'exchangeRateTimeUtc']
  end

  if attributes.has_key?(:'exchangeRateExpirationTimeUtc')
    self.exchange_rate_expiration_time_utc = attributes[:'exchangeRateExpirationTimeUtc']
  end

  if attributes.has_key?(:'rateId')
    self.rate_id = attributes[:'rateId']
  end
end

Instance Attribute Details

#amount ⇒ Object

The offer amount, calculated using the originalAmount and the exchangeRate. For DCC this is the amount in the card issuer’s currency.



23
24
25
 
# File 'lib/cybersource_rest_client/models/inline_response_201_8_order_information_currency_conversion_offer.rb', line 23

def amount
  @amount
end

#currency ⇒ Object

Currency of the offer. For DCC this is the card’s issuers currency. Use three-character alphabetic [ISO 4271 Currency Codes.](developer.cybersource.com/docs/cybs/en-us/currency-codes/reference/all/na/currency-codes/currency-codes.html)



26
27
28
 
# File 'lib/cybersource_rest_client/models/inline_response_201_8_order_information_currency_conversion_offer.rb', line 26

def currency
  @currency
end

#exchange_rate ⇒ Object

The exchange rate of the offer from 1 major unit of the sale currency including margin. This will be printed on the receipt. For example, if a USD consumer is purchasing in EUR, this field should return the amount of 1 EUR in USD including mark-up. The receipt will contain the following: ‘EUR 1.00 = USD 1.09998900010999` - where 1.09998900010999 is the value returned in this field.



29
30
31
 
# File 'lib/cybersource_rest_client/models/inline_response_201_8_order_information_currency_conversion_offer.rb', line 29

def exchange_rate
  @exchange_rate
end

#exchange_rate_expiration_time_utc ⇒ Object

The expiration time of the exchange rate in UTC. Format: ‘YYYY-MM-DDThh:mm:ssZ`



44
45
46
 
# File 'lib/cybersource_rest_client/models/inline_response_201_8_order_information_currency_conversion_offer.rb', line 44

def exchange_rate_expiration_time_utc
  @exchange_rate_expiration_time_utc
end

#exchange_rate_inverted ⇒ Object

An inverted exchange rate is the base currency amount divided by the converted currency amount. Ex. If a USD customer is purchasing in EUR, this field should return the value of USD divided by EUR.



32
33
34
 
# File 'lib/cybersource_rest_client/models/inline_response_201_8_order_information_currency_conversion_offer.rb', line 32

def exchange_rate_inverted
  @exchange_rate_inverted
end

#exchange_rate_time_utc ⇒ Object

The date and time of exchange rate in UTC. Format: ‘YYYY-MM-DDThh:mm:ssZ` Example `2023-05-17T23:47:57Z` equals May 17, 2023, at 23:47:57 (11:47:57 PM). The `T` separates the date and the time. The `Z` indicates UTC.



41
42
43
 
# File 'lib/cybersource_rest_client/models/inline_response_201_8_order_information_currency_conversion_offer.rb', line 41

def exchange_rate_time_utc
  @exchange_rate_time_utc
end

#margin_rate ⇒ Object

The margin between the offer exchange rate and wholesale rates, i.e. the mark up. Expressed as a percentage of 100, e.g. 3.75



35
36
37
 
# File 'lib/cybersource_rest_client/models/inline_response_201_8_order_information_currency_conversion_offer.rb', line 35

def margin_rate
  @margin_rate
end

#original_amount ⇒ Object

The amount of the sale in the merchant’s currency. For DCC this should be the same value as the request. For MCP will be 1 major unit of the merchant’s base currency.



17
18
19
 
# File 'lib/cybersource_rest_client/models/inline_response_201_8_order_information_currency_conversion_offer.rb', line 17

def original_amount
  @original_amount
end

#original_currency ⇒ Object

Currency of the transaction in the merchant’s currency. For DCC this should be the same value as the request. For MCP will be the merchant’s base currency as configured on the currency conversion provider’s system. Use three-character alphabetic [ISO 4271 Currency Codes.](developer.cybersource.com/docs/cybs/en-us/currency-codes/reference/all/na/currency-codes/currency-codes.html)



20
21
22
 
# File 'lib/cybersource_rest_client/models/inline_response_201_8_order_information_currency_conversion_offer.rb', line 20

def original_currency
  @original_currency
end

#rate_id ⇒ Object

A unique MCP rate identifier.



47
48
49
 
# File 'lib/cybersource_rest_client/models/inline_response_201_8_order_information_currency_conversion_offer.rb', line 47

def rate_id
  @rate_id
end

#rate_source ⇒ Object

The source of the rate (excluding mark up). Optional field.



38
39
40
 
# File 'lib/cybersource_rest_client/models/inline_response_201_8_order_information_currency_conversion_offer.rb', line 38

def rate_source
  @rate_source
end

Class Method Details

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
 
# File 'lib/cybersource_rest_client/models/inline_response_201_8_order_information_currency_conversion_offer.rb', line 50

def self.attribute_map
  {
    :'original_amount' => :'originalAmount',
    :'original_currency' => :'originalCurrency',
    :'amount' => :'amount',
    :'currency' => :'currency',
    :'exchange_rate' => :'exchangeRate',
    :'exchange_rate_inverted' => :'exchangeRateInverted',
    :'margin_rate' => :'marginRate',
    :'rate_source' => :'rateSource',
    :'exchange_rate_time_utc' => :'exchangeRateTimeUtc',
    :'exchange_rate_expiration_time_utc' => :'exchangeRateExpirationTimeUtc',
    :'rate_id' => :'rateId'
  }
end

.json_map ⇒ Object

Attribute mapping from JSON key to ruby-style variable name.



67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/cybersource_rest_client/models/inline_response_201_8_order_information_currency_conversion_offer.rb', line 67

def self.json_map
  {
    :'original_amount' => :'original_amount',
    :'original_currency' => :'original_currency',
    :'amount' => :'amount',
    :'currency' => :'currency',
    :'exchange_rate' => :'exchange_rate',
    :'exchange_rate_inverted' => :'exchange_rate_inverted',
    :'margin_rate' => :'margin_rate',
    :'rate_source' => :'rate_source',
    :'exchange_rate_time_utc' => :'exchange_rate_time_utc',
    :'exchange_rate_expiration_time_utc' => :'exchange_rate_expiration_time_utc',
    :'rate_id' => :'rate_id'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
 
# File 'lib/cybersource_rest_client/models/inline_response_201_8_order_information_currency_conversion_offer.rb', line 84

def self.swagger_types
  {
    :'original_amount' => :'String',
    :'original_currency' => :'String',
    :'amount' => :'String',
    :'currency' => :'String',
    :'exchange_rate' => :'String',
    :'exchange_rate_inverted' => :'BOOLEAN',
    :'margin_rate' => :'String',
    :'rate_source' => :'String',
    :'exchange_rate_time_utc' => :'String',
    :'exchange_rate_expiration_time_utc' => :'String',
    :'rate_id' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.



228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
 
# File 'lib/cybersource_rest_client/models/inline_response_201_8_order_information_currency_conversion_offer.rb', line 228

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      original_amount == o.original_amount &&
      original_currency == o.original_currency &&
      amount == o.amount &&
      currency == o.currency &&
      exchange_rate == o.exchange_rate &&
      exchange_rate_inverted == o.exchange_rate_inverted &&
      margin_rate == o.margin_rate &&
      rate_source == o.rate_source &&
      exchange_rate_time_utc == o.exchange_rate_time_utc &&
      exchange_rate_expiration_time_utc == o.exchange_rate_expiration_time_utc &&
      rate_id == o.rate_id
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type



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
 
# File 'lib/cybersource_rest_client/models/inline_response_201_8_order_information_currency_conversion_offer.rb', line 280

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :BOOLEAN
    if value.to_s =~ /\A(true|t|yes|y|1)\z/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else # model
    temp_model = CyberSource.const_get(type).new
    temp_model.build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value



346
347
348
349
350
351
352
353
354
355
356
357
358
 
# File 'lib/cybersource_rest_client/models/inline_response_201_8_order_information_currency_conversion_offer.rb', line 346

def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end

#build_from_hash(attributes) ⇒ Object

Builds the object from hash



259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
 
# File 'lib/cybersource_rest_client/models/inline_response_201_8_order_information_currency_conversion_offer.rb', line 259

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    if type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{self.class.json_map[key]}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{self.class.json_map[key]}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(o) ⇒ Boolean

See Also:

  • `==` method


246
247
248
 
# File 'lib/cybersource_rest_client/models/inline_response_201_8_order_information_currency_conversion_offer.rb', line 246

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.



252
253
254
 
# File 'lib/cybersource_rest_client/models/inline_response_201_8_order_information_currency_conversion_offer.rb', line 252

def hash
  [original_amount, original_currency, amount, currency, exchange_rate, exchange_rate_inverted, margin_rate, rate_source, exchange_rate_time_utc, exchange_rate_expiration_time_utc, rate_id].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?



155
156
157
158
 
# File 'lib/cybersource_rest_client/models/inline_response_201_8_order_information_currency_conversion_offer.rb', line 155

def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)



326
327
328
 
# File 'lib/cybersource_rest_client/models/inline_response_201_8_order_information_currency_conversion_offer.rb', line 326

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash



332
333
334
335
336
337
338
339
340
 
# File 'lib/cybersource_rest_client/models/inline_response_201_8_order_information_currency_conversion_offer.rb', line 332

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object



320
321
322
 
# File 'lib/cybersource_rest_client/models/inline_response_201_8_order_information_currency_conversion_offer.rb', line 320

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid



162
163
164
 
# File 'lib/cybersource_rest_client/models/inline_response_201_8_order_information_currency_conversion_offer.rb', line 162

def valid?
  true
end