Class: Hubspot::Crm::Extensions::Accounting::ExchangeRateResponse

Inherits:
Object
  • Object
show all
Defined in:
lib/hubspot/codegen/crm/extensions/accounting/models/exchange_rate_response.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ExchangeRateResponse

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
 
# File 'lib/hubspot/codegen/crm/extensions/accounting/models/exchange_rate_response.rb', line 88

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Hubspot::Crm::Extensions::Accounting::ExchangeRateResponse` 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 `Hubspot::Crm::Extensions::Accounting::ExchangeRateResponse`. 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
  }

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

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

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

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

Instance Attribute Details

#exchange_rate ⇒ Object

The exchange rate between the 2 currencies



25
26
27
 
# File 'lib/hubspot/codegen/crm/extensions/accounting/models/exchange_rate_response.rb', line 25

def exchange_rate
  @exchange_rate
end

#result ⇒ Object

Designates if the response is a success (‘OK’) or failure (‘ERR’).



22
23
24
 
# File 'lib/hubspot/codegen/crm/extensions/accounting/models/exchange_rate_response.rb', line 22

def result
  @result
end

#source_currency_code ⇒ Object

The ISO 4217 currency code that represents the source currency of the exchange rate.



28
29
30
 
# File 'lib/hubspot/codegen/crm/extensions/accounting/models/exchange_rate_response.rb', line 28

def source_currency_code
  @source_currency_code
end

#target_currency_code ⇒ Object

The ISO 4217 currency code that represents the target currency of the exchange rate.



31
32
33
 
# File 'lib/hubspot/codegen/crm/extensions/accounting/models/exchange_rate_response.rb', line 31

def target_currency_code
  @target_currency_code
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



66
67
68
 
# File 'lib/hubspot/codegen/crm/extensions/accounting/models/exchange_rate_response.rb', line 66

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



56
57
58
59
60
61
62
63
 
# File 'lib/hubspot/codegen/crm/extensions/accounting/models/exchange_rate_response.rb', line 56

def self.attribute_map
  {
    :'result' => :'@result',
    :'exchange_rate' => :'exchangeRate',
    :'source_currency_code' => :'sourceCurrencyCode',
    :'target_currency_code' => :'targetCurrencyCode'
  }
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
 
# File 'lib/hubspot/codegen/crm/extensions/accounting/models/exchange_rate_response.rb', line 189

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



81
82
83
84
 
# File 'lib/hubspot/codegen/crm/extensions/accounting/models/exchange_rate_response.rb', line 81

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



71
72
73
74
75
76
77
78
 
# File 'lib/hubspot/codegen/crm/extensions/accounting/models/exchange_rate_response.rb', line 71

def self.openapi_types
  {
    :'result' => :'String',
    :'exchange_rate' => :'Float',
    :'source_currency_code' => :'String',
    :'target_currency_code' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



165
166
167
168
169
170
171
172
 
# File 'lib/hubspot/codegen/crm/extensions/accounting/models/exchange_rate_response.rb', line 165

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      result == o.result &&
      exchange_rate == o.exchange_rate &&
      source_currency_code == o.source_currency_code &&
      target_currency_code == o.target_currency_code
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



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
247
248
249
250
251
252
253
254
255
256
257
 
# File 'lib/hubspot/codegen/crm/extensions/accounting/models/exchange_rate_response.rb', line 220

def _deserialize(type, value)
  case type.to_sym
  when :Time
    Time.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
    # models (e.g. Pet) or oneOf
    klass = Hubspot::Crm::Extensions::Accounting.const_get(type)
    klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.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



291
292
293
294
295
296
297
298
299
300
301
302
303
 
# File 'lib/hubspot/codegen/crm/extensions/accounting/models/exchange_rate_response.rb', line 291

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



196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
 
# File 'lib/hubspot/codegen/crm/extensions/accounting/models/exchange_rate_response.rb', line 196

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  self.class.openapi_types.each_pair do |key, type|
    if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      self.send("#{key}=", nil)
    elsif 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
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


176
177
178
 
# File 'lib/hubspot/codegen/crm/extensions/accounting/models/exchange_rate_response.rb', line 176

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



182
183
184
 
# File 'lib/hubspot/codegen/crm/extensions/accounting/models/exchange_rate_response.rb', line 182

def hash
  [result, exchange_rate, source_currency_code, target_currency_code].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



120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
 
# File 'lib/hubspot/codegen/crm/extensions/accounting/models/exchange_rate_response.rb', line 120

def list_invalid_properties
  invalid_properties = Array.new
  if @result.nil?
    invalid_properties.push('invalid value for "result", result cannot be nil.')
  end

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

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

  if @target_currency_code.nil?
    invalid_properties.push('invalid value for "target_currency_code", target_currency_code cannot be nil.')
  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



267
268
269
 
# File 'lib/hubspot/codegen/crm/extensions/accounting/models/exchange_rate_response.rb', line 267

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



273
274
275
276
277
278
279
280
281
282
283
284
285
 
# File 'lib/hubspot/codegen/crm/extensions/accounting/models/exchange_rate_response.rb', line 273

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    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



261
262
263
 
# File 'lib/hubspot/codegen/crm/extensions/accounting/models/exchange_rate_response.rb', line 261

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



143
144
145
146
147
148
149
150
151
 
# File 'lib/hubspot/codegen/crm/extensions/accounting/models/exchange_rate_response.rb', line 143

def valid?
  return false if @result.nil?
  result_validator = EnumAttributeValidator.new('String', ["OK", "ERR"])
  return false unless result_validator.valid?(@result)
  return false if @exchange_rate.nil?
  return false if @source_currency_code.nil?
  return false if @target_currency_code.nil?
  true
end