Class: DigitalFemsa::BalanceResponse

Inherits:
Object
  • Object
show all
Defined in:
lib/digital_femsa/models/balance_response.rb

Overview

balance model

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ BalanceResponse

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
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
152
153
154
155
156
157
158
159
160
161
162
163
164
# File 'lib/digital_femsa/models/balance_response.rb', line 94

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

  if attributes.key?(:'cashout_retention_amount')
    if (value = attributes[:'cashout_retention_amount']).is_a?(Array)
      self.cashout_retention_amount = value
    end
  end

  if attributes.key?(:'conekta_retention')
    if (value = attributes[:'conekta_retention']).is_a?(Array)
      self.conekta_retention = value
    end
  end

  if attributes.key?(:'gateway')
    if (value = attributes[:'gateway']).is_a?(Array)
      self.gateway = value
    end
  end

  if attributes.key?(:'pending')
    if (value = attributes[:'pending']).is_a?(Array)
      self.pending = value
    end
  end

  if attributes.key?(:'retained')
    if (value = attributes[:'retained']).is_a?(Array)
      self.retained = value
    end
  end

  if attributes.key?(:'retention_amount')
    if (value = attributes[:'retention_amount']).is_a?(Array)
      self.retention_amount = value
    end
  end

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

  if attributes.key?(:'target_retention_amount')
    if (value = attributes[:'target_retention_amount']).is_a?(Array)
      self.target_retention_amount = value
    end
  end

  if attributes.key?(:'temporarily_retained')
    if (value = attributes[:'temporarily_retained']).is_a?(Array)
      self.temporarily_retained = value
    end
  end
end

Instance Attribute Details

#availableObject

The balance’s available



20
21
22
# File 'lib/digital_femsa/models/balance_response.rb', line 20

def available
  @available
end

#cashout_retention_amountObject

The balance’s cashout retention amount



23
24
25
# File 'lib/digital_femsa/models/balance_response.rb', line 23

def cashout_retention_amount
  @cashout_retention_amount
end

#conekta_retentionObject

The balance’s Femsa retention



26
27
28
# File 'lib/digital_femsa/models/balance_response.rb', line 26

def conekta_retention
  @conekta_retention
end

#gatewayObject

The balance’s gateway



29
30
31
# File 'lib/digital_femsa/models/balance_response.rb', line 29

def gateway
  @gateway
end

#pendingObject

The balance’s pending



32
33
34
# File 'lib/digital_femsa/models/balance_response.rb', line 32

def pending
  @pending
end

#retainedObject

The balance’s retained



35
36
37
# File 'lib/digital_femsa/models/balance_response.rb', line 35

def retained
  @retained
end

#retention_amountObject

The balance’s retention amount



38
39
40
# File 'lib/digital_femsa/models/balance_response.rb', line 38

def retention_amount
  @retention_amount
end

#target_collateral_amountObject

The balance’s target collateral amount



41
42
43
# File 'lib/digital_femsa/models/balance_response.rb', line 41

def target_collateral_amount
  @target_collateral_amount
end

#target_retention_amountObject

The balance’s target retention amount



44
45
46
# File 'lib/digital_femsa/models/balance_response.rb', line 44

def target_retention_amount
  @target_retention_amount
end

#temporarily_retainedObject

The balance’s temporarily retained



47
48
49
# File 'lib/digital_femsa/models/balance_response.rb', line 47

def temporarily_retained
  @temporarily_retained
end

Class Method Details

._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



237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
# File 'lib/digital_femsa/models/balance_response.rb', line 237

def self._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 = DigitalFemsa.const_get(type)
    klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

.acceptable_attributesObject

Returns all the JSON keys this model knows about



66
67
68
# File 'lib/digital_femsa/models/balance_response.rb', line 66

def self.acceptable_attributes
  attribute_map.values
end

.attribute_mapObject

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



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

def self.attribute_map
  {
    :'available' => :'available',
    :'cashout_retention_amount' => :'cashout_retention_amount',
    :'conekta_retention' => :'conekta_retention',
    :'gateway' => :'gateway',
    :'pending' => :'pending',
    :'retained' => :'retained',
    :'retention_amount' => :'retention_amount',
    :'target_collateral_amount' => :'target_collateral_amount',
    :'target_retention_amount' => :'target_retention_amount',
    :'temporarily_retained' => :'temporarily_retained'
  }
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



213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
# File 'lib/digital_femsa/models/balance_response.rb', line 213

def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  transformed_hash = {}
  openapi_types.each_pair do |key, type|
    if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
      transformed_hash["#{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[attribute_map[key]].is_a?(Array)
        transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
      end
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
    end
  end
  new(transformed_hash)
end

.openapi_nullableObject

List of attributes with nullable: true



87
88
89
90
# File 'lib/digital_femsa/models/balance_response.rb', line 87

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

.openapi_typesObject

Attribute type mapping.



71
72
73
74
75
76
77
78
79
80
81
82
83
84
# File 'lib/digital_femsa/models/balance_response.rb', line 71

def self.openapi_types
  {
    :'available' => :'Array<BalanceCommonField>',
    :'cashout_retention_amount' => :'Array<BalanceCommonField>',
    :'conekta_retention' => :'Array<BalanceCommonField>',
    :'gateway' => :'Array<BalanceCommonField>',
    :'pending' => :'Array<BalanceCommonField>',
    :'retained' => :'Array<BalanceCommonField>',
    :'retention_amount' => :'Array<BalanceCommonField>',
    :'target_collateral_amount' => :'Object',
    :'target_retention_amount' => :'Array<BalanceCommonField>',
    :'temporarily_retained' => :'Array<BalanceCommonField>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



183
184
185
186
187
188
189
190
191
192
193
194
195
196
# File 'lib/digital_femsa/models/balance_response.rb', line 183

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      available == o.available &&
      cashout_retention_amount == o.cashout_retention_amount &&
      conekta_retention == o.conekta_retention &&
      gateway == o.gateway &&
      pending == o.pending &&
      retained == o.retained &&
      retention_amount == o.retention_amount &&
      target_collateral_amount == o.target_collateral_amount &&
      target_retention_amount == o.target_retention_amount &&
      temporarily_retained == o.temporarily_retained
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



308
309
310
311
312
313
314
315
316
317
318
319
320
# File 'lib/digital_femsa/models/balance_response.rb', line 308

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

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object)

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


200
201
202
# File 'lib/digital_femsa/models/balance_response.rb', line 200

def eql?(o)
  self == o
end

#hashInteger

Calculates hash code according to all attributes.

Returns:

  • (Integer)

    Hash code



206
207
208
# File 'lib/digital_femsa/models/balance_response.rb', line 206

def hash
  [available, cashout_retention_amount, conekta_retention, gateway, pending, retained, retention_amount, target_collateral_amount, target_retention_amount, temporarily_retained].hash
end

#list_invalid_propertiesObject

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

Returns:

  • Array for valid properties with the reasons



168
169
170
171
172
# File 'lib/digital_femsa/models/balance_response.rb', line 168

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  invalid_properties
end

#to_bodyHash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash)

    Returns the object in the form of hash



284
285
286
# File 'lib/digital_femsa/models/balance_response.rb', line 284

def to_body
  to_hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



290
291
292
293
294
295
296
297
298
299
300
301
302
# File 'lib/digital_femsa/models/balance_response.rb', line 290

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



278
279
280
# File 'lib/digital_femsa/models/balance_response.rb', line 278

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



176
177
178
179
# File 'lib/digital_femsa/models/balance_response.rb', line 176

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  true
end