Class: ConnectWise::CurrencyReference

Inherits:
Object
  • Object
show all
Defined in:
lib/connect_wise/models/currency_reference.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CurrencyReference

Initializes the object

Parameters:

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

    Model attributes in the form of hash

Raises:

  • (ArgumentError) 


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
 
# File 'lib/connect_wise/models/currency_reference.rb', line 70

def initialize(attributes = {})
  raise ArgumentError, 'The input argument (attributes) must be a hash in `ConnectWise::CurrencyReference` initialize method' unless attributes.is_a?(Hash)

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

    h[k.to_sym] = v
  end

  self.id = attributes[:id] if attributes.key?(:id)

  self.symbol = attributes[:symbol] if attributes.key?(:symbol)

  self.currency_code = attributes[:currency_code] if attributes.key?(:currency_code)

  self.decimal_separator = attributes[:decimal_separator] if attributes.key?(:decimal_separator)

  self.number_of_decimals = attributes[:number_of_decimals] if attributes.key?(:number_of_decimals)

  self.thousands_separator = attributes[:thousands_separator] if attributes.key?(:thousands_separator)

  self.negative_parentheses_flag = attributes[:negative_parentheses_flag] if attributes.key?(:negative_parentheses_flag)

  self.display_symbol_flag = attributes[:display_symbol_flag] if attributes.key?(:display_symbol_flag)

  self.currency_identifier = attributes[:currency_identifier] if attributes.key?(:currency_identifier)

  self.display_id_flag = attributes[:display_id_flag] if attributes.key?(:display_id_flag)

  self.right_align = attributes[:right_align] if attributes.key?(:right_align)

  self.name = attributes[:name] if attributes.key?(:name)

  return unless attributes.key?(:_info)
  return unless (value = attributes[:_info]).is_a?(Hash)

  self._info = value
end

Instance Attribute Details

#_info ⇒ Object

Returns the value of attribute _info.



16
17
18
 
# File 'lib/connect_wise/models/currency_reference.rb', line 16

def _info
  @_info
end

#currency_code ⇒ Object

Returns the value of attribute currency_code.



16
17
18
 
# File 'lib/connect_wise/models/currency_reference.rb', line 16

def currency_code
  @currency_code
end

#currency_identifier ⇒ Object

Returns the value of attribute currency_identifier.



16
17
18
 
# File 'lib/connect_wise/models/currency_reference.rb', line 16

def currency_identifier
  @currency_identifier
end

#decimal_separator ⇒ Object

Returns the value of attribute decimal_separator.



16
17
18
 
# File 'lib/connect_wise/models/currency_reference.rb', line 16

def decimal_separator
  @decimal_separator
end

#display_id_flag ⇒ Object

Returns the value of attribute display_id_flag.



16
17
18
 
# File 'lib/connect_wise/models/currency_reference.rb', line 16

def display_id_flag
  @display_id_flag
end

#display_symbol_flag ⇒ Object

Returns the value of attribute display_symbol_flag.



16
17
18
 
# File 'lib/connect_wise/models/currency_reference.rb', line 16

def display_symbol_flag
  @display_symbol_flag
end

#id ⇒ Object

Returns the value of attribute id.



16
17
18
 
# File 'lib/connect_wise/models/currency_reference.rb', line 16

def id
  @id
end

#name ⇒ Object

Returns the value of attribute name.



16
17
18
 
# File 'lib/connect_wise/models/currency_reference.rb', line 16

def name
  @name
end

#negative_parentheses_flag ⇒ Object

Returns the value of attribute negative_parentheses_flag.



16
17
18
 
# File 'lib/connect_wise/models/currency_reference.rb', line 16

def negative_parentheses_flag
  @negative_parentheses_flag
end

#number_of_decimals ⇒ Object

Returns the value of attribute number_of_decimals.



16
17
18
 
# File 'lib/connect_wise/models/currency_reference.rb', line 16

def number_of_decimals
  @number_of_decimals
end

#right_align ⇒ Object

Returns the value of attribute right_align.



16
17
18
 
# File 'lib/connect_wise/models/currency_reference.rb', line 16

def right_align
  @right_align
end

#symbol ⇒ Object

Returns the value of attribute symbol.



16
17
18
 
# File 'lib/connect_wise/models/currency_reference.rb', line 16

def symbol
  @symbol
end

#thousands_separator ⇒ Object

Returns the value of attribute thousands_separator.



16
17
18
 
# File 'lib/connect_wise/models/currency_reference.rb', line 16

def thousands_separator
  @thousands_separator
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



38
39
40
 
# File 'lib/connect_wise/models/currency_reference.rb', line 38

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
 
# File 'lib/connect_wise/models/currency_reference.rb', line 19

def self.attribute_map
  {
    id: :id,
    symbol: :symbol,
    currency_code: :currencyCode,
    decimal_separator: :decimalSeparator,
    number_of_decimals: :numberOfDecimals,
    thousands_separator: :thousandsSeparator,
    negative_parentheses_flag: :negativeParenthesesFlag,
    display_symbol_flag: :displaySymbolFlag,
    currency_identifier: :currencyIdentifier,
    display_id_flag: :displayIdFlag,
    right_align: :rightAlign,
    name: :name,
    _info: :_info
  }
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



158
159
160
 
# File 'lib/connect_wise/models/currency_reference.rb', line 158

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



62
63
64
65
66
 
# File 'lib/connect_wise/models/currency_reference.rb', line 62

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

.openapi_types ⇒ Object

Attribute type mapping.



43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
 
# File 'lib/connect_wise/models/currency_reference.rb', line 43

def self.openapi_types
  {
    id: :Integer,
    symbol: :String,
    currency_code: :String,
    decimal_separator: :String,
    number_of_decimals: :Integer,
    thousands_separator: :String,
    negative_parentheses_flag: :Boolean,
    display_symbol_flag: :Boolean,
    currency_identifier: :String,
    display_id_flag: :Boolean,
    right_align: :Boolean,
    name: :String,
    _info: :'Hash<String, String>'
  }
end

Instance Method Details

#==(other) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
 
# File 'lib/connect_wise/models/currency_reference.rb', line 124

def ==(other)
  return true if equal?(other)

  self.class == other.class &&
    id == other.id &&
    symbol == other.symbol &&
    currency_code == other.currency_code &&
    decimal_separator == other.decimal_separator &&
    number_of_decimals == other.number_of_decimals &&
    thousands_separator == other.thousands_separator &&
    negative_parentheses_flag == other.negative_parentheses_flag &&
    display_symbol_flag == other.display_symbol_flag &&
    currency_identifier == other.currency_identifier &&
    display_id_flag == other.display_id_flag &&
    right_align == other.right_align &&
    name == other.name &&
    _info == other._info
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



188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
 
# File 'lib/connect_wise/models/currency_reference.rb', line 188

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 = ConnectWise.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



259
260
261
262
263
264
265
266
267
268
269
270
271
 
# File 'lib/connect_wise/models/currency_reference.rb', line 259

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



165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
 
# File 'lib/connect_wise/models/currency_reference.rb', line 165

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)
      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
      send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize(::Regexp.last_match(1), v) }) if attributes[self.class.attribute_map[key]].is_a?(Array)
    elsif !attributes[self.class.attribute_map[key]].nil?
      send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end
  end

  self
end

#eql?(other) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


145
146
147
 
# File 'lib/connect_wise/models/currency_reference.rb', line 145

def eql?(other)
  self == other
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



151
152
153
 
# File 'lib/connect_wise/models/currency_reference.rb', line 151

def hash
  [id, symbol, currency_code, decimal_separator, number_of_decimals, thousands_separator, negative_parentheses_flag, display_symbol_flag, currency_identifier, display_id_flag, right_align, name, _info].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



112
113
114
 
# File 'lib/connect_wise/models/currency_reference.rb', line 112

def list_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



235
236
237
 
# File 'lib/connect_wise/models/currency_reference.rb', line 235

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



241
242
243
244
245
246
247
248
249
250
251
252
253
 
# File 'lib/connect_wise/models/currency_reference.rb', line 241

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = 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



229
230
231
 
# File 'lib/connect_wise/models/currency_reference.rb', line 229

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



118
119
120
 
# File 'lib/connect_wise/models/currency_reference.rb', line 118

def valid?
  true
end