class ProtonApi::FinancialStatementAnalysisRequest
Attributes
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# 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
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# 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
Attribute type mapping.
# 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
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# 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
Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data
# 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
Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash
# 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
Custom attribute writer method checking allowed values (enum). @param [Object] accounting_method
Object to be assigned
# File lib/proton_api/models/financial_statement_analysis_request.rb, line 248 def accounting_method=(accounting_method) validator = EnumAttributeValidator.new('String', ['accrual', 'cash']) unless validator.valid?(accounting_method) fail ArgumentError, 'invalid value for "accounting_method", must be one of #{validator.allowable_values}.' end @accounting_method = accounting_method end
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# 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
@see the `==` method @param [Object] Object to be compared
# File lib/proton_api/models/financial_statement_analysis_request.rb, line 349 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# 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
Custom attribute writer method checking allowed values (enum). @param [Object] history_frequency_interval
Object to be assigned
# File lib/proton_api/models/financial_statement_analysis_request.rb, line 258 def history_frequency_interval=(history_frequency_interval) validator = EnumAttributeValidator.new('String', ['day', 'week', 'month', 'quarter', 'year']) unless validator.valid?(history_frequency_interval) fail ArgumentError, 'invalid value for "history_frequency_interval", must be one of #{validator.allowable_values}.' end @history_frequency_interval = history_frequency_interval end
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons
# 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
Custom attribute writer method checking allowed values (enum). @param [Object] period_length
Object to be assigned
# File lib/proton_api/models/financial_statement_analysis_request.rb, line 306 def period_length=(period_length) validator = EnumAttributeValidator.new('String', ['annual', 'quarterly', 'monthly', 'ytd', 'qtd', 'mtd']) unless validator.valid?(period_length) fail ArgumentError, 'invalid value for "period_length", must be one of #{validator.allowable_values}.' end @period_length = period_length end
Custom attribute writer method with validation @param [Object] period_month
Value to be assigned
# File lib/proton_api/models/financial_statement_analysis_request.rb, line 292 def period_month=(period_month) if !period_month.nil? && period_month > 12 fail ArgumentError, 'invalid value for "period_month", must be smaller than or equal to 12.' end if !period_month.nil? && period_month < 1 fail ArgumentError, 'invalid value for "period_month", must be greater than or equal to 1.' end @period_month = period_month end
Custom attribute writer method with validation @param [Object] period_quarter
Value to be assigned
# File lib/proton_api/models/financial_statement_analysis_request.rb, line 268 def period_quarter=(period_quarter) if !period_quarter.nil? && period_quarter > 4 fail ArgumentError, 'invalid value for "period_quarter", must be smaller than or equal to 4.' end if !period_quarter.nil? && period_quarter < 1 fail ArgumentError, 'invalid value for "period_quarter", must be greater than or equal to 1.' end @period_quarter = period_quarter end
Custom attribute writer method checking allowed values (enum). @param [Object] period_type
Object to be assigned
# File lib/proton_api/models/financial_statement_analysis_request.rb, line 316 def period_type=(period_type) validator = EnumAttributeValidator.new('String', ['calendar', 'fiscal']) unless validator.valid?(period_type) fail ArgumentError, 'invalid value for "period_type", must be one of #{validator.allowable_values}.' end @period_type = period_type end
Custom attribute writer method checking allowed values (enum). @param [Object] statement_type
Object to be assigned
# File lib/proton_api/models/financial_statement_analysis_request.rb, line 282 def statement_type=(statement_type) validator = EnumAttributeValidator.new('String', ['income_statement', 'balance_sheet', 'all']) unless validator.valid?(statement_type) fail ArgumentError, 'invalid value for "statement_type", must be one of #{validator.allowable_values}.' end @statement_type = statement_type end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# 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
Returns the string representation of the object @return [String] String presentation of the object
# File lib/proton_api/models/financial_statement_analysis_request.rb, line 421 def to_s to_hash.to_s end
Check to see if the all the properties in the model are valid @return true if the model is valid
# 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