Class: NucleusApi::Overflow

Inherits:
Object
  • Object
show all
Defined in:
lib/nucleus_api/models/overflow.rb

Overview

Overflow Object

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Overflow

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
109
110
111
112
113
114
115
116
# File 'lib/nucleus_api/models/overflow.rb', line 73

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  if attributes.has_key?(:'account_id')
    self. = attributes[:'account_id']
  end

  if attributes.has_key?(:'client_id')
    self.client_id = attributes[:'client_id']
  end

  if attributes.has_key?(:'create_date')
    self.create_date = attributes[:'create_date']
  end

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

  if attributes.has_key?(:'id')
    self.id = attributes[:'id']
  end

  if attributes.has_key?(:'overflow_setting_id')
    self.overflow_setting_id = attributes[:'overflow_setting_id']
  end

  if attributes.has_key?(:'total_overflow_amount')
    self.total_overflow_amount = attributes[:'total_overflow_amount']
  end

  if attributes.has_key?(:'update_balances')
    self.update_balances = attributes[:'update_balances']
  end

  if attributes.has_key?(:'update_date')
    self.update_date = attributes[:'update_date']
  end
end

Instance Attribute Details

#account_idObject

accountId



19
20
21
# File 'lib/nucleus_api/models/overflow.rb', line 19

def 
  @account_id
end

#client_idObject

clientId



22
23
24
# File 'lib/nucleus_api/models/overflow.rb', line 22

def client_id
  @client_id
end

#create_dateObject

Returns the value of attribute create_date.



24
25
26
# File 'lib/nucleus_api/models/overflow.rb', line 24

def create_date
  @create_date
end

#funding_requestsObject

Returns the value of attribute funding_requests.



26
27
28
# File 'lib/nucleus_api/models/overflow.rb', line 26

def funding_requests
  @funding_requests
end

#idObject

Returns the value of attribute id.



28
29
30
# File 'lib/nucleus_api/models/overflow.rb', line 28

def id
  @id
end

#overflow_setting_idObject

overflowSettingId



31
32
33
# File 'lib/nucleus_api/models/overflow.rb', line 31

def overflow_setting_id
  @overflow_setting_id
end

#total_overflow_amountObject

totalOverflowAmount



34
35
36
# File 'lib/nucleus_api/models/overflow.rb', line 34

def total_overflow_amount
  @total_overflow_amount
end

#update_balancesObject

updateBalances



37
38
39
# File 'lib/nucleus_api/models/overflow.rb', line 37

def update_balances
  @update_balances
end

#update_dateObject

Returns the value of attribute update_date.



39
40
41
# File 'lib/nucleus_api/models/overflow.rb', line 39

def update_date
  @update_date
end

Class Method Details

.attribute_mapObject

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



42
43
44
45
46
47
48
49
50
51
52
53
54
# File 'lib/nucleus_api/models/overflow.rb', line 42

def self.attribute_map
  {
    :'account_id' => :'account_id',
    :'client_id' => :'client_id',
    :'create_date' => :'create_date',
    :'funding_requests' => :'funding_requests',
    :'id' => :'id',
    :'overflow_setting_id' => :'overflow_setting_id',
    :'total_overflow_amount' => :'total_overflow_amount',
    :'update_balances' => :'update_balances',
    :'update_date' => :'update_date'
  }
end

.swagger_typesObject

Attribute type mapping.



57
58
59
60
61
62
63
64
65
66
67
68
69
# File 'lib/nucleus_api/models/overflow.rb', line 57

def self.swagger_types
  {
    :'account_id' => :'String',
    :'client_id' => :'String',
    :'create_date' => :'DateTime',
    :'funding_requests' => :'Array<FundingRequestMap>',
    :'id' => :'String',
    :'overflow_setting_id' => :'String',
    :'total_overflow_amount' => :'Float',
    :'update_balances' => :'BOOLEAN',
    :'update_date' => :'DateTime'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



153
154
155
156
157
158
159
160
161
162
163
164
165
# File 'lib/nucleus_api/models/overflow.rb', line 153

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
       == o. &&
      client_id == o.client_id &&
      create_date == o.create_date &&
      funding_requests == o.funding_requests &&
      id == o.id &&
      overflow_setting_id == o.overflow_setting_id &&
      total_overflow_amount == o.total_overflow_amount &&
      update_balances == o.update_balances &&
      update_date == o.update_date
end

#_deserialize(type, value) ⇒ Object

Returns Deserialized data.

Parameters:

  • string

    type Data type

  • string

    value Value to be deserialized

Returns:

  • (Object)

    Deserialized data



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
230
231
232
233
234
235
236
237
# File 'lib/nucleus_api/models/overflow.rb', line 201

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    (value)
  when :Date
    (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 = NucleusApi.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/nucleus_api/models/overflow.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

Builds the object from hash

Parameters:

  • attributes (Hash)

    Model attributes in the form of hash

Returns:

  • (Object)

    Returns the model itself



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

def build_from_hash(attributes)
  self.class.swagger_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/nucleus_api/models/overflow.rb', line 169

def eql?(o)
  self == o
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



175
176
177
# File 'lib/nucleus_api/models/overflow.rb', line 175

def hash
  [, client_id, create_date, funding_requests, id, overflow_setting_id, total_overflow_amount, update_balances, update_date].hash
end

#list_invalid_propertiesObject

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/nucleus_api/models/overflow.rb', line 120

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

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

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

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

  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



248
249
250
# File 'lib/nucleus_api/models/overflow.rb', line 248

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



254
255
256
257
258
259
260
261
# File 'lib/nucleus_api/models/overflow.rb', line 254

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    hash[param] = _to_hash(value)
  end
  hash
end

#to_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



242
243
244
# File 'lib/nucleus_api/models/overflow.rb', line 242

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
# File 'lib/nucleus_api/models/overflow.rb', line 143

def valid?
  return false if @account_id.nil?
  return false if @client_id.nil?
  return false if @overflow_setting_id.nil?
  return false if @total_overflow_amount.nil?
  true
end