Class: TransferZero::Currency

Inherits:
Object
  • Object
show all
Defined in:
lib/transferzero-sdk/models/currency.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Currency

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
124
 
# File 'lib/transferzero-sdk/models/currency.rb', line 76

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `TransferZero::Currency` 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 `TransferZero::Currency`. 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?(:'code')
    self.code = attributes[:'code']
  end

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

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

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

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

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

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

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

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

Instance Attribute Details

#code ⇒ Object

The currency code in 3-character alpha ISO 4217 currency format



18
19
20
 
# File 'lib/transferzero-sdk/models/currency.rb', line 18

def code
  @code
end

#decimals ⇒ Object

Number of decimal points



27
28
29
 
# File 'lib/transferzero-sdk/models/currency.rb', line 27

def decimals
  @decimals
end

#max ⇒ Object

The maximum amount allowed in a transaction



39
40
41
 
# File 'lib/transferzero-sdk/models/currency.rb', line 39

def max
  @max
end

#min ⇒ Object

The minimum amount allowed in a transaction



36
37
38
 
# File 'lib/transferzero-sdk/models/currency.rb', line 36

def min
  @min
end

#name ⇒ Object

Name of currency



21
22
23
 
# File 'lib/transferzero-sdk/models/currency.rb', line 21

def name
  @name
end

#primary ⇒ Object

Is this a primary currency?



33
34
35
 
# File 'lib/transferzero-sdk/models/currency.rb', line 33

def primary
  @primary
end

#subunit_to_unit ⇒ Object

Subunits in Unit (eg. there are 100 cents in 1 US Dollar)



30
31
32
 
# File 'lib/transferzero-sdk/models/currency.rb', line 30

def subunit_to_unit
  @subunit_to_unit
end

#symbol ⇒ Object

Symbol of currency



24
25
26
 
# File 'lib/transferzero-sdk/models/currency.rb', line 24

def symbol
  @symbol
end

#usd_equivalent ⇒ Object

The equivalent of the currency to 1 USD



42
43
44
 
# File 'lib/transferzero-sdk/models/currency.rb', line 42

def usd_equivalent
  @usd_equivalent
end

Class Method Details

.attribute_map ⇒ Object

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



45
46
47
48
49
50
51
52
53
54
55
56
57
 
# File 'lib/transferzero-sdk/models/currency.rb', line 45

def self.attribute_map
  {
    :'code' => :'code',
    :'name' => :'name',
    :'symbol' => :'symbol',
    :'decimals' => :'decimals',
    :'subunit_to_unit' => :'subunit_to_unit',
    :'primary' => :'primary',
    :'min' => :'min',
    :'max' => :'max',
    :'usd_equivalent' => :'usd_equivalent'
  }
end

.openapi_types ⇒ Object

Attribute type mapping.



60
61
62
63
64
65
66
67
68
69
70
71
72
 
# File 'lib/transferzero-sdk/models/currency.rb', line 60

def self.openapi_types
  {
    :'code' => :'String',
    :'name' => :'String',
    :'symbol' => :'String',
    :'decimals' => :'Float',
    :'subunit_to_unit' => :'String',
    :'primary' => :'Boolean',
    :'min' => :'String',
    :'max' => :'String',
    :'usd_equivalent' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



141
142
143
144
145
146
147
148
149
150
151
152
153
 
# File 'lib/transferzero-sdk/models/currency.rb', line 141

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      code == o.code &&
      name == o.name &&
      symbol == o.symbol &&
      decimals == o.decimals &&
      subunit_to_unit == o.subunit_to_unit &&
      primary == o.primary &&
      min == o.min &&
      max == o.max &&
      usd_equivalent == o.usd_equivalent
end

#[](key) ⇒ Object 



255
256
257
 
# File 'lib/transferzero-sdk/models/currency.rb', line 255

def [](key)
  to_hash[key]
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



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
226
227
228
229
 
# File 'lib/transferzero-sdk/models/currency.rb', line 193

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

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



267
268
269
270
271
272
273
274
275
276
277
278
279
 
# File 'lib/transferzero-sdk/models/currency.rb', line 267

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

Returns the model itself

Returns:

  • (Object) —

    Returns the model itself



172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
 
# File 'lib/transferzero-sdk/models/currency.rb', line 172

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.openapi_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("#{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

#dig(*args) ⇒ Object 



259
260
261
 
# File 'lib/transferzero-sdk/models/currency.rb', line 259

def dig(*args)
  to_hash.dig(*args)
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


157
158
159
 
# File 'lib/transferzero-sdk/models/currency.rb', line 157

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



163
164
165
 
# File 'lib/transferzero-sdk/models/currency.rb', line 163

def hash
  [code, name, symbol, decimals, subunit_to_unit, primary, min, max, usd_equivalent].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



128
129
130
131
 
# File 'lib/transferzero-sdk/models/currency.rb', line 128

def list_invalid_properties
  invalid_properties = Array.new
  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



239
240
241
 
# File 'lib/transferzero-sdk/models/currency.rb', line 239

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



245
246
247
248
249
250
251
252
253
 
# File 'lib/transferzero-sdk/models/currency.rb', line 245

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
  ::ActiveSupport::HashWithIndifferentAccess.new(hash)
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



233
234
235
 
# File 'lib/transferzero-sdk/models/currency.rb', line 233

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



135
136
137
 
# File 'lib/transferzero-sdk/models/currency.rb', line 135

def valid?
  true
end