Class: ProtonApi::FinancialStatementAnalysisRequest

Inherits:
Object
  • Object
show all
Defined in:
lib/proton_api/models/financial_statement_analysis_request.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ FinancialStatementAnalysisRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
 
# File 'lib/proton_api/models/financial_statement_analysis_request.rb', line 117

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

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

  if attributes.has_key?(:'show_history')
    self.show_history = attributes[:'show_history']
  else
    self.show_history = false
  end

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

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

  if attributes.has_key?(:'history_frequency_interval')
    self.history_frequency_interval = attributes[:'history_frequency_interval']
  else
    self.history_frequency_interval = 'month'
  end

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#accounting_method ⇒ Object

Returns the value of attribute accounting_method.



23
24
25
 
# File 'lib/proton_api/models/financial_statement_analysis_request.rb', line 23

def accounting_method
  @accounting_method
end

#business_id ⇒ Object

Returns the value of attribute business_id.



39
40
41
 
# File 'lib/proton_api/models/financial_statement_analysis_request.rb', line 39

def business_id
  @business_id
end

#client_id ⇒ Object

Returns the value of attribute client_id.



19
20
21
 
# File 'lib/proton_api/models/financial_statement_analysis_request.rb', line 19

def client_id
  @client_id
end

#currency_code ⇒ Object

Returns the value of attribute currency_code.



17
18
19
 
# File 'lib/proton_api/models/financial_statement_analysis_request.rb', line 17

def currency_code
  @currency_code
end

#currency_conversion ⇒ Object

Returns the value of attribute currency_conversion.



29
30
31
 
# File 'lib/proton_api/models/financial_statement_analysis_request.rb', line 29

def currency_conversion
  @currency_conversion
end

#end_date ⇒ Object

Returns the value of attribute end_date.



25
26
27
 
# File 'lib/proton_api/models/financial_statement_analysis_request.rb', line 25

def end_date
  @end_date
end

#history_frequency_interval ⇒ Object

Returns the value of attribute history_frequency_interval.



27
28
29
 
# File 'lib/proton_api/models/financial_statement_analysis_request.rb', line 27

def history_frequency_interval
  @history_frequency_interval
end

#period_length ⇒ Object

Returns the value of attribute period_length.



43
44
45
 
# File 'lib/proton_api/models/financial_statement_analysis_request.rb', line 43

def period_length
  @period_length
end

#period_month ⇒ Object

Returns the value of attribute period_month.



35
36
37
 
# File 'lib/proton_api/models/financial_statement_analysis_request.rb', line 35

def period_month
  @period_month
end

#period_quarter ⇒ Object

Returns the value of attribute period_quarter.



31
32
33
 
# File 'lib/proton_api/models/financial_statement_analysis_request.rb', line 31

def period_quarter
  @period_quarter
end

#period_type ⇒ Object

Returns the value of attribute period_type.



47
48
49
 
# File 'lib/proton_api/models/financial_statement_analysis_request.rb', line 47

def period_type
  @period_type
end

#period_year ⇒ Object

Returns the value of attribute period_year.



41
42
43
 
# File 'lib/proton_api/models/financial_statement_analysis_request.rb', line 41

def period_year
  @period_year
end

#show_history ⇒ Object

Returns the value of attribute show_history.



21
22
23
 
# File 'lib/proton_api/models/financial_statement_analysis_request.rb', line 21

def show_history
  @show_history
end

#start_date ⇒ Object

Returns the value of attribute start_date.



37
38
39
 
# File 'lib/proton_api/models/financial_statement_analysis_request.rb', line 37

def start_date
  @start_date
end

#stat_names ⇒ Object

Returns the value of attribute stat_names.



45
46
47
 
# File 'lib/proton_api/models/financial_statement_analysis_request.rb', line 45

def stat_names
  @stat_names
end

#statement_type ⇒ Object

Returns the value of attribute statement_type.



33
34
35
 
# File 'lib/proton_api/models/financial_statement_analysis_request.rb', line 33

def statement_type
  @statement_type
end

Class Method Details

.attribute_map ⇒ Object

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



72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
 
# File 'lib/proton_api/models/financial_statement_analysis_request.rb', line 72

def self.attribute_map
  {
    :'currency_code' => :'currency_code',
    :'client_id' => :'client_id',
    :'show_history' => :'show_history',
    :'accounting_method' => :'accounting_method',
    :'end_date' => :'end_date',
    :'history_frequency_interval' => :'history_frequency_interval',
    :'currency_conversion' => :'currency_conversion',
    :'period_quarter' => :'period_quarter',
    :'statement_type' => :'statement_type',
    :'period_month' => :'period_month',
    :'start_date' => :'start_date',
    :'business_id' => :'business_id',
    :'period_year' => :'period_year',
    :'period_length' => :'period_length',
    :'stat_names' => :'stat_names',
    :'period_type' => :'period_type'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
 
# File 'lib/proton_api/models/financial_statement_analysis_request.rb', line 94

def self.swagger_types
  {
    :'currency_code' => :'String',
    :'client_id' => :'String',
    :'show_history' => :'BOOLEAN',
    :'accounting_method' => :'String',
    :'end_date' => :'Date',
    :'history_frequency_interval' => :'String',
    :'currency_conversion' => :'String',
    :'period_quarter' => :'Integer',
    :'statement_type' => :'String',
    :'period_month' => :'Integer',
    :'start_date' => :'Date',
    :'business_id' => :'String',
    :'period_year' => :'Integer',
    :'period_length' => :'String',
    :'stat_names' => :'Array<String>',
    :'period_type' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
 
# File 'lib/proton_api/models/financial_statement_analysis_request.rb', line 326

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      currency_code == o.currency_code &&
      client_id == o.client_id &&
      show_history == o.show_history &&
      accounting_method == o.accounting_method &&
      end_date == o.end_date &&
      history_frequency_interval == o.history_frequency_interval &&
      currency_conversion == o.currency_conversion &&
      period_quarter == o.period_quarter &&
      statement_type == o.statement_type &&
      period_month == o.period_month &&
      start_date == o.start_date &&
      business_id == o.business_id &&
      period_year == o.period_year &&
      period_length == o.period_length &&
      stat_names == o.stat_names &&
      period_type == o.period_type
end

#_deserialize(type, value) ⇒ Object

Returns Deserialized data.

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
 
# File 'lib/proton_api/models/financial_statement_analysis_request.rb', line 382

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 = ProtonApi.const_get(type).new
    temp_model.build_from_hash(value)
  end
end

#_to_hash(value) ⇒ 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



446
447
448
449
450
451
452
453
454
455
456
457
458
 
# File 'lib/proton_api/models/financial_statement_analysis_request.rb', line 446

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



362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
 
# File 'lib/proton_api/models/financial_statement_analysis_request.rb', line 362

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  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


349
350
351
 
# File 'lib/proton_api/models/financial_statement_analysis_request.rb', line 349

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



355
356
357
 
# File 'lib/proton_api/models/financial_statement_analysis_request.rb', line 355

def hash
  [currency_code, client_id, show_history, accounting_method, end_date, history_frequency_interval, currency_conversion, period_quarter, statement_type, period_month, start_date, business_id, period_year, period_length, stat_names, period_type].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



200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
 
# File 'lib/proton_api/models/financial_statement_analysis_request.rb', line 200

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 !@period_quarter.nil? && @period_quarter > 4
    invalid_properties.push('invalid value for "period_quarter", must be smaller than or equal to 4.')
  end

  if !@period_quarter.nil? && @period_quarter < 1
    invalid_properties.push('invalid value for "period_quarter", must be greater than or equal to 1.')
  end

  if !@period_month.nil? && @period_month > 12
    invalid_properties.push('invalid value for "period_month", must be smaller than or equal to 12.')
  end

  if !@period_month.nil? && @period_month < 1
    invalid_properties.push('invalid value for "period_month", must be greater than or equal to 1.')
  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



427
428
429
 
# File 'lib/proton_api/models/financial_statement_analysis_request.rb', line 427

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



433
434
435
436
437
438
439
440
441
 
# File 'lib/proton_api/models/financial_statement_analysis_request.rb', line 433

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
  hash
end

#to_s ⇒ String

Returns String presentation of the object.

Returns:

  • (String) —

    String presentation of the object



421
422
423
 
# File 'lib/proton_api/models/financial_statement_analysis_request.rb', line 421

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



227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
 
# File 'lib/proton_api/models/financial_statement_analysis_request.rb', line 227

def valid?
  return false if @accounting_method.nil?
  accounting_method_validator = EnumAttributeValidator.new('String', ['accrual', 'cash'])
  return false unless accounting_method_validator.valid?(@accounting_method)
  history_frequency_interval_validator = EnumAttributeValidator.new('String', ['day', 'week', 'month', 'quarter', 'year'])
  return false unless history_frequency_interval_validator.valid?(@history_frequency_interval)
  return false if !@period_quarter.nil? && @period_quarter > 4
  return false if !@period_quarter.nil? && @period_quarter < 1
  statement_type_validator = EnumAttributeValidator.new('String', ['income_statement', 'balance_sheet', 'all'])
  return false unless statement_type_validator.valid?(@statement_type)
  return false if !@period_month.nil? && @period_month > 12
  return false if !@period_month.nil? && @period_month < 1
  period_length_validator = EnumAttributeValidator.new('String', ['annual', 'quarterly', 'monthly', 'ytd', 'qtd', 'mtd'])
  return false unless period_length_validator.valid?(@period_length)
  period_type_validator = EnumAttributeValidator.new('String', ['calendar', 'fiscal'])
  return false unless period_type_validator.valid?(@period_type)
  true
end