Class: IntegrationApi::FinancialStatement

Inherits:
Object
  • Object
show all
Defined in:
lib/integration_api/models/financial_statement.rb

Overview

FinancialStatement Object

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ FinancialStatement

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
 
# File 'lib/integration_api/models/financial_statement.rb', line 107

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?(:'accounting_method')
    self.accounting_method = attributes[:'accounting_method']
  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?(:'currency_code')
    self.currency_code = attributes[:'currency_code']
  end

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#accounting_method ⇒ Object

accounting_method



19
20
21
 
# File 'lib/integration_api/models/financial_statement.rb', line 19

def accounting_method
  @accounting_method
end

#client_id ⇒ Object

clientId



22
23
24
 
# File 'lib/integration_api/models/financial_statement.rb', line 22

def client_id
  @client_id
end

#create_date ⇒ Object

Returns the value of attribute create_date.



24
25
26
 
# File 'lib/integration_api/models/financial_statement.rb', line 24

def create_date
  @create_date
end

#currency_code ⇒ Object

currencyCode



27
28
29
 
# File 'lib/integration_api/models/financial_statement.rb', line 27

def currency_code
  @currency_code
end

#id ⇒ Object

Returns the value of attribute id.



29
30
31
 
# File 'lib/integration_api/models/financial_statement.rb', line 29

def id
  @id
end

#metadata ⇒ Object

Returns the value of attribute metadata.



31
32
33
 
# File 'lib/integration_api/models/financial_statement.rb', line 31

def metadata
  @metadata
end

#period_length ⇒ Object

periodLength



34
35
36
 
# File 'lib/integration_api/models/financial_statement.rb', line 34

def period_length
  @period_length
end

#period_month ⇒ Object

periodMonth



37
38
39
 
# File 'lib/integration_api/models/financial_statement.rb', line 37

def period_month
  @period_month
end

#period_quarter ⇒ Object

periodQuarter



40
41
42
 
# File 'lib/integration_api/models/financial_statement.rb', line 40

def period_quarter
  @period_quarter
end

#period_type ⇒ Object

periodType



43
44
45
 
# File 'lib/integration_api/models/financial_statement.rb', line 43

def period_type
  @period_type
end

#period_year ⇒ Object

periodYear



46
47
48
 
# File 'lib/integration_api/models/financial_statement.rb', line 46

def period_year
  @period_year
end

#secondary_id ⇒ Object

Returns the value of attribute secondary_id.



48
49
50
 
# File 'lib/integration_api/models/financial_statement.rb', line 48

def secondary_id
  @secondary_id
end

#statement_date ⇒ Object

statementDate



51
52
53
 
# File 'lib/integration_api/models/financial_statement.rb', line 51

def statement_date
  @statement_date
end

#statement_type ⇒ Object

statement_type



54
55
56
 
# File 'lib/integration_api/models/financial_statement.rb', line 54

def statement_type
  @statement_type
end

#stats ⇒ Object

stats



57
58
59
 
# File 'lib/integration_api/models/financial_statement.rb', line 57

def stats
  @stats
end

#update_date ⇒ Object

Returns the value of attribute update_date.



59
60
61
 
# File 'lib/integration_api/models/financial_statement.rb', line 59

def update_date
  @update_date
end

Class Method Details

.attribute_map ⇒ Object

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



62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/integration_api/models/financial_statement.rb', line 62

def self.attribute_map
  {
    :'accounting_method' => :'accounting_method',
    :'client_id' => :'client_id',
    :'create_date' => :'create_date',
    :'currency_code' => :'currency_code',
    :'id' => :'id',
    :'metadata' => :'metadata',
    :'period_length' => :'period_length',
    :'period_month' => :'period_month',
    :'period_quarter' => :'period_quarter',
    :'period_type' => :'period_type',
    :'period_year' => :'period_year',
    :'secondary_id' => :'secondary_id',
    :'statement_date' => :'statement_date',
    :'statement_type' => :'statement_type',
    :'stats' => :'stats',
    :'update_date' => :'update_date'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
 
# File 'lib/integration_api/models/financial_statement.rb', line 84

def self.swagger_types
  {
    :'accounting_method' => :'String',
    :'client_id' => :'String',
    :'create_date' => :'DateTime',
    :'currency_code' => :'String',
    :'id' => :'String',
    :'metadata' => :'Hash<String, String>',
    :'period_length' => :'String',
    :'period_month' => :'Integer',
    :'period_quarter' => :'Integer',
    :'period_type' => :'String',
    :'period_year' => :'Integer',
    :'secondary_id' => :'String',
    :'statement_date' => :'Date',
    :'statement_type' => :'String',
    :'stats' => :'Array<Stat>',
    :'update_date' => :'DateTime'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
 
# File 'lib/integration_api/models/financial_statement.rb', line 217

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      accounting_method == o.accounting_method &&
      client_id == o.client_id &&
      create_date == o.create_date &&
      currency_code == o.currency_code &&
      id == o.id &&
      metadata == o.metadata &&
      period_length == o.period_length &&
      period_month == o.period_month &&
      period_quarter == o.period_quarter &&
      period_type == o.period_type &&
      period_year == o.period_year &&
      secondary_id == o.secondary_id &&
      statement_date == o.statement_date &&
      statement_type == o.statement_type &&
      stats == o.stats &&
      update_date == o.update_date
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



273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
 
# File 'lib/integration_api/models/financial_statement.rb', line 273

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



338
339
340
341
342
343
344
345
346
347
348
349
350
 
# File 'lib/integration_api/models/financial_statement.rb', line 338

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



253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
 
# File 'lib/integration_api/models/financial_statement.rb', line 253

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


240
241
242
 
# File 'lib/integration_api/models/financial_statement.rb', line 240

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



246
247
248
 
# File 'lib/integration_api/models/financial_statement.rb', line 246

def hash
  [accounting_method, client_id, create_date, currency_code, id, metadata, period_length, period_month, period_quarter, period_type, period_year, secondary_id, statement_date, statement_type, stats, update_date].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



184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
 
# File 'lib/integration_api/models/financial_statement.rb', line 184

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

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

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

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



319
320
321
 
# File 'lib/integration_api/models/financial_statement.rb', line 319

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



325
326
327
328
329
330
331
332
 
# File 'lib/integration_api/models/financial_statement.rb', line 325

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_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



313
314
315
 
# File 'lib/integration_api/models/financial_statement.rb', line 313

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



207
208
209
210
211
212
213
 
# File 'lib/integration_api/models/financial_statement.rb', line 207

def valid?
  return false if @accounting_method.nil?
  return false if @currency_code.nil?
  return false if @statement_date.nil?
  return false if @statement_type.nil?
  true
end