Class: OpenapiClient::DynamicPricingExchangeRateRequest

Inherits:
ExchangeRateRequest show all
Defined in:
lib/openapi_client/models/dynamic_pricing_exchange_rate_request.rb

Overview

Request to perform a dynamic pricing exchange rate inquiry.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from ExchangeRateRequest

openapi_discriminator_name

Constructor Details

#initialize(attributes = {}) ⇒ DynamicPricingExchangeRateRequest

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



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
 
# File 'lib/openapi_client/models/dynamic_pricing_exchange_rate_request.rb', line 60

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `OpenapiClient::DynamicPricingExchangeRateRequest` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!self.class.attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `OpenapiClient::DynamicPricingExchangeRateRequest`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  # call parent's initialize
  super(attributes)

  if attributes.key?(:'request_type')
    self.request_type = attributes[:'request_type']
  end

  if attributes.key?(:'base_amount')
    self.base_amount = attributes[:'base_amount']
  end

  if attributes.key?(:'store_id')
    self.store_id = attributes[:'store_id']
  end

  if attributes.key?(:'foreign_currency')
    self.foreign_currency = attributes[:'foreign_currency']
  end
end

Instance Attribute Details

#base_amount ⇒ Object

The original amount of the merchant currency for calculation.



22
23
24
 
# File 'lib/openapi_client/models/dynamic_pricing_exchange_rate_request.rb', line 22

def base_amount
  @base_amount
end

#foreign_currency ⇒ Object

The currency code to convert for dynamic pricing in either numeric or alphabetic ISO 4217 currency code format.



28
29
30
 
# File 'lib/openapi_client/models/dynamic_pricing_exchange_rate_request.rb', line 28

def foreign_currency
  @foreign_currency
end

#request_type ⇒ Object

Object name of the exchange rate request.



19
20
21
 
# File 'lib/openapi_client/models/dynamic_pricing_exchange_rate_request.rb', line 19

def request_type
  @request_type
end

#store_id ⇒ Object

An optional outlet ID for clients that support multiple stores in the same app.



25
26
27
 
# File 'lib/openapi_client/models/dynamic_pricing_exchange_rate_request.rb', line 25

def store_id
  @store_id
end

Class Method Details

.attribute_map ⇒ Object

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



31
32
33
34
35
36
37
38
 
# File 'lib/openapi_client/models/dynamic_pricing_exchange_rate_request.rb', line 31

def self.attribute_map
  {
    :'request_type' => :'requestType',
    :'base_amount' => :'baseAmount',
    :'store_id' => :'storeId',
    :'foreign_currency' => :'foreignCurrency'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



182
183
184
 
# File 'lib/openapi_client/models/dynamic_pricing_exchange_rate_request.rb', line 182

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



51
52
53
54
55
56
 
# File 'lib/openapi_client/models/dynamic_pricing_exchange_rate_request.rb', line 51

def self.openapi_all_of
  [
  :'DynamicPricingExchangeRateRequestAllOf',
  :'ExchangeRateRequest'
  ]
end

.openapi_types ⇒ Object

Attribute type mapping.



41
42
43
44
45
46
47
48
 
# File 'lib/openapi_client/models/dynamic_pricing_exchange_rate_request.rb', line 41

def self.openapi_types
  {
    :'request_type' => :'String',
    :'base_amount' => :'Float',
    :'store_id' => :'String',
    :'foreign_currency' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



158
159
160
161
162
163
164
165
 
# File 'lib/openapi_client/models/dynamic_pricing_exchange_rate_request.rb', line 158

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      request_type == o.request_type &&
      base_amount == o.base_amount &&
      store_id == o.store_id &&
      foreign_currency == o.foreign_currency && super(o)
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



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
242
243
244
245
246
 
# File 'lib/openapi_client/models/dynamic_pricing_exchange_rate_request.rb', line 211

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
    OpenapiClient.const_get(type).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

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



276
277
278
279
280
281
282
283
284
285
286
287
288
 
# File 'lib/openapi_client/models/dynamic_pricing_exchange_rate_request.rb', line 276

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

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
 
# File 'lib/openapi_client/models/dynamic_pricing_exchange_rate_request.rb', line 189

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  super(attributes)
  self.class.openapi_types.each_pair do |key, type|
    if type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{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

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


169
170
171
 
# File 'lib/openapi_client/models/dynamic_pricing_exchange_rate_request.rb', line 169

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



175
176
177
 
# File 'lib/openapi_client/models/dynamic_pricing_exchange_rate_request.rb', line 175

def hash
  [request_type, base_amount, store_id, foreign_currency].hash
end

#list_invalid_properties ⇒ Object

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

Returns:

  • Array for valid properties with the reasons



95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
 
# File 'lib/openapi_client/models/dynamic_pricing_exchange_rate_request.rb', line 95

def list_invalid_properties
  invalid_properties = super
  if !@store_id.nil? && @store_id.to_s.length > 20
    invalid_properties.push('invalid value for "store_id", the character length must be smaller than or equal to 20.')
  end

  if @foreign_currency.nil?
    invalid_properties.push('invalid value for "foreign_currency", foreign_currency cannot be nil.')
  end

  if @foreign_currency.to_s.length > 3
    invalid_properties.push('invalid value for "foreign_currency", the character length must be smaller than or equal to 3.')
  end

  pattern = Regexp.new(/([A-Z]{3})|([0-9]{3})/)
  if @foreign_currency !~ pattern
    invalid_properties.push("invalid value for \"foreign_currency\", must conform to the pattern #{pattern}.")
  end

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



256
257
258
 
# File 'lib/openapi_client/models/dynamic_pricing_exchange_rate_request.rb', line 256

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



262
263
264
265
266
267
268
269
270
 
# File 'lib/openapi_client/models/dynamic_pricing_exchange_rate_request.rb', line 262

def to_hash
  hash = super
  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

Returns:

  • (String) —

    String presentation of the object



250
251
252
 
# File 'lib/openapi_client/models/dynamic_pricing_exchange_rate_request.rb', line 250

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

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

Returns:

  • (Boolean) —

    true if the model is valid



119
120
121
122
123
124
125
 
# File 'lib/openapi_client/models/dynamic_pricing_exchange_rate_request.rb', line 119

def valid?
  return false if !@store_id.nil? && @store_id.to_s.length > 20
  return false if @foreign_currency.nil?
  return false if @foreign_currency.to_s.length > 3
  return false if @foreign_currency !~ Regexp.new(/([A-Z]{3})|([0-9]{3})/)
  true && super
end