merge_accounting_client 1.0.0

data/lib/merge_accounting_client/models/income_statement.rb

@@ -0,0 +1,352 @@
+=begin
+#Merge Accounting API
+
+#The unified API for building rich integrations with multiple Accounting & Finance platforms.
+
+The version of the OpenAPI document: 1.0
+Contact: hello@merge.dev
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 5.1.1
+
+=end
+
+require 'date'
+require 'time'
+
+module MergeAccountingClient
+  # # The IncomeStatement Object ### Description The `IncomeStatement` object is used to represent a company's income statements.  ### Usage Example Fetch from the `GET IncomeStatement` endpoint and view a company's income statement for a given period.
+  class IncomeStatement
+    attr_accessor :id
+
+    # The third-party API ID of the matching object.
+    attr_accessor :remote_id
+
+    attr_accessor :remote_data
+
+    # The income statement's name.
+    attr_accessor :name
+
+    # The income statement's start period.
+    attr_accessor :start_period
+
+    # The income statement's end period.
+    attr_accessor :end_period
+
+    attr_accessor :income
+
+    attr_accessor :cost_of_sales
+
+    # The income statement's gross profit.
+    attr_accessor :gross_profit
+
+    attr_accessor :operating_expenses
+
+    # The income statement's net operating profit.
+    attr_accessor :net_operating_income
+
+    attr_accessor :non_operating_expenses
+
+    # The income statement's net income.
+    attr_accessor :net_income
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'id' => :'id',
+        :'remote_id' => :'remote_id',
+        :'remote_data' => :'remote_data',
+        :'name' => :'name',
+        :'start_period' => :'start_period',
+        :'end_period' => :'end_period',
+        :'income' => :'income',
+        :'cost_of_sales' => :'cost_of_sales',
+        :'gross_profit' => :'gross_profit',
+        :'operating_expenses' => :'operating_expenses',
+        :'net_operating_income' => :'net_operating_income',
+        :'non_operating_expenses' => :'non_operating_expenses',
+        :'net_income' => :'net_income'
+      }
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'id' => :'String',
+        :'remote_id' => :'String',
+        :'remote_data' => :'Array<RemoteData>',
+        :'name' => :'String',
+        :'start_period' => :'Time',
+        :'end_period' => :'Time',
+        :'income' => :'Array<ReportItem>',
+        :'cost_of_sales' => :'Array<ReportItem>',
+        :'gross_profit' => :'Float',
+        :'operating_expenses' => :'Array<ReportItem>',
+        :'net_operating_income' => :'Float',
+        :'non_operating_expenses' => :'Array<ReportItem>',
+        :'net_income' => :'Float'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'remote_id',
+        :'remote_data',
+        :'name',
+        :'start_period',
+        :'end_period',
+        :'gross_profit',
+        :'net_operating_income',
+        :'net_income'
+      ])
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `MergeAccountingClient::IncomeStatement` 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 `MergeAccountingClient::IncomeStatement`. 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?(:'id')
+        self.id = attributes[:'id']
+      end
+
+      if attributes.key?(:'remote_id')
+        self.remote_id = attributes[:'remote_id']
+      end
+
+      if attributes.key?(:'remote_data')
+        if (value = attributes[:'remote_data']).is_a?(Array)
+          self.remote_data = value
+        end
+      end
+
+      if attributes.key?(:'name')
+        self.name = attributes[:'name']
+      end
+
+      if attributes.key?(:'start_period')
+        self.start_period = attributes[:'start_period']
+      end
+
+      if attributes.key?(:'end_period')
+        self.end_period = attributes[:'end_period']
+      end
+
+      if attributes.key?(:'income')
+        if (value = attributes[:'income']).is_a?(Array)
+          self.income = value
+        end
+      end
+
+      if attributes.key?(:'cost_of_sales')
+        if (value = attributes[:'cost_of_sales']).is_a?(Array)
+          self.cost_of_sales = value
+        end
+      end
+
+      if attributes.key?(:'gross_profit')
+        self.gross_profit = attributes[:'gross_profit']
+      end
+
+      if attributes.key?(:'operating_expenses')
+        if (value = attributes[:'operating_expenses']).is_a?(Array)
+          self.operating_expenses = value
+        end
+      end
+
+      if attributes.key?(:'net_operating_income')
+        self.net_operating_income = attributes[:'net_operating_income']
+      end
+
+      if attributes.key?(:'non_operating_expenses')
+        if (value = attributes[:'non_operating_expenses']).is_a?(Array)
+          self.non_operating_expenses = value
+        end
+      end
+
+      if attributes.key?(:'net_income')
+        self.net_income = attributes[:'net_income']
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      true
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          id == o.id &&
+          remote_id == o.remote_id &&
+          remote_data == o.remote_data &&
+          name == o.name &&
+          start_period == o.start_period &&
+          end_period == o.end_period &&
+          income == o.income &&
+          cost_of_sales == o.cost_of_sales &&
+          gross_profit == o.gross_profit &&
+          operating_expenses == o.operating_expenses &&
+          net_operating_income == o.net_operating_income &&
+          non_operating_expenses == o.non_operating_expenses &&
+          net_income == o.net_income
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [id, remote_id, remote_data, name, start_period, end_period, income, cost_of_sales, gross_profit, operating_expenses, net_operating_income, non_operating_expenses, net_income].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      new.build_from_hash(attributes)
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      self.class.openapi_types.each_pair do |key, type|
+        if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
+          self.send("#{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[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
+      end
+
+      self
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def _deserialize(type, value)
+      case type.to_sym
+      when :Time
+        Time.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value
+      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 = MergeAccountingClient.const_get(type)
+        klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    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
+
+    # 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
+    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
+
+  end
+
+end