buildium-ruby 2.0.1

data/lib/buildium-ruby/models/gl_account_post_message.rb

@@ -0,0 +1,349 @@
+=begin
+#Open API, powered by Buildium
+
+#GetAllGLAccounts) response message now includes the property `IsBankAccount`. This is a boolean property that indicates whether the general ledger account is also a bank account.  * A `Country` property has been added to all Address messages. This property contains an enumeration indicating the country of the address.   
+
+The version of the OpenAPI document: v1
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 6.0.1
+
+=end
+
+require 'date'
+require 'time'
+
+module Buildium
+  class GLAccountPostMessage
+    # Describes the subtype of the general ledger account.
+    attr_accessor :sub_type
+
+    # Indicates if an account is a Cash Asset. Can only have a value if SubType is `CurrentAsset`
+    attr_accessor :is_cash_asset
+
+    # Name of the general ledger account. The name cannot exceed 50 characters and must be unique across all general ledger accounts.
+    attr_accessor :name
+
+    # General ledger account number. The account number cannot exceed 12 characters and must be unique across all general ledger accounts.
+    attr_accessor :account_number
+
+    # Description of the general ledger account. The description cannot exceed 250 characters.
+    attr_accessor :description
+
+    # Indicates whether the account is a contra account. Must be null if `IsCashAsset` field is set to true.
+    attr_accessor :is_contra_account
+
+    # Describes the cash flow classification for the general ledger account. Must be null if `IsCashAsset` field is set to true.
+    attr_accessor :cash_flow_classification
+
+    # Unique identifier of the parent general ledger account. Indicates if this is a sub general ledger account.
+    attr_accessor :parent_gl_account_id
+
+    class EnumAttributeValidator
+      attr_reader :datatype
+      attr_reader :allowable_values
+
+      def initialize(datatype, allowable_values)
+        @allowable_values = allowable_values.map do |value|
+          case datatype.to_s
+          when /Integer/i
+            value.to_i
+          when /Float/i
+            value.to_f
+          else
+            value
+          end
+        end
+      end
+
+      def valid?(value)
+        !value || allowable_values.include?(value)
+      end
+    end
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'sub_type' => :'SubType',
+        :'is_cash_asset' => :'IsCashAsset',
+        :'name' => :'Name',
+        :'account_number' => :'AccountNumber',
+        :'description' => :'Description',
+        :'is_contra_account' => :'IsContraAccount',
+        :'cash_flow_classification' => :'CashFlowClassification',
+        :'parent_gl_account_id' => :'ParentGLAccountId'
+      }
+    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
+      {
+        :'sub_type' => :'String',
+        :'is_cash_asset' => :'Boolean',
+        :'name' => :'String',
+        :'account_number' => :'String',
+        :'description' => :'String',
+        :'is_contra_account' => :'Boolean',
+        :'cash_flow_classification' => :'String',
+        :'parent_gl_account_id' => :'Integer'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    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 `Buildium::GLAccountPostMessage` 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 `Buildium::GLAccountPostMessage`. 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?(:'sub_type')
+        self.sub_type = attributes[:'sub_type']
+      end
+
+      if attributes.key?(:'is_cash_asset')
+        self.is_cash_asset = attributes[:'is_cash_asset']
+      end
+
+      if attributes.key?(:'name')
+        self.name = attributes[:'name']
+      end
+
+      if attributes.key?(:'account_number')
+        self.account_number = attributes[:'account_number']
+      end
+
+      if attributes.key?(:'description')
+        self.description = attributes[:'description']
+      end
+
+      if attributes.key?(:'is_contra_account')
+        self.is_contra_account = attributes[:'is_contra_account']
+      end
+
+      if attributes.key?(:'cash_flow_classification')
+        self.cash_flow_classification = attributes[:'cash_flow_classification']
+      end
+
+      if attributes.key?(:'parent_gl_account_id')
+        self.parent_gl_account_id = attributes[:'parent_gl_account_id']
+      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
+      if @sub_type.nil?
+        invalid_properties.push('invalid value for "sub_type", sub_type cannot be nil.')
+      end
+
+      if @name.nil?
+        invalid_properties.push('invalid value for "name", name cannot be nil.')
+      end
+
+      if @account_number.nil?
+        invalid_properties.push('invalid value for "account_number", account_number cannot be nil.')
+      end
+
+      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?
+      return false if @sub_type.nil?
+      sub_type_validator = EnumAttributeValidator.new('String', ["CurrentAsset", "FixedAsset", "CurrentLiability", "LongTermLiability", "Equity", "Income", "NonOperatingIncome", "OperatingExpenses", "NonOperatingExpenses"])
+      return false unless sub_type_validator.valid?(@sub_type)
+      return false if @name.nil?
+      return false if @account_number.nil?
+      cash_flow_classification_validator = EnumAttributeValidator.new('String', ["OperatingActivities", "InvestingActivities", "FinancingActivities"])
+      return false unless cash_flow_classification_validator.valid?(@cash_flow_classification)
+      true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] sub_type Object to be assigned
+    def sub_type=(sub_type)
+      validator = EnumAttributeValidator.new('String', ["CurrentAsset", "FixedAsset", "CurrentLiability", "LongTermLiability", "Equity", "Income", "NonOperatingIncome", "OperatingExpenses", "NonOperatingExpenses"])
+      unless validator.valid?(sub_type)
+        fail ArgumentError, "invalid value #{ sub_type.inspect } for \"sub_type\", must be one of #{validator.allowable_values}."
+      end
+      @sub_type = sub_type
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] cash_flow_classification Object to be assigned
+    def cash_flow_classification=(cash_flow_classification)
+      validator = EnumAttributeValidator.new('String', ["OperatingActivities", "InvestingActivities", "FinancingActivities"])
+      unless validator.valid?(cash_flow_classification)
+        fail ArgumentError, "invalid value #{ cash_flow_classification.inspect } for \"cash_flow_classification\", must be one of #{validator.allowable_values}."
+      end
+      @cash_flow_classification = cash_flow_classification
+    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 &&
+          sub_type == o.sub_type &&
+          is_cash_asset == o.is_cash_asset &&
+          name == o.name &&
+          account_number == o.account_number &&
+          description == o.description &&
+          is_contra_account == o.is_contra_account &&
+          cash_flow_classification == o.cash_flow_classification &&
+          parent_gl_account_id == o.parent_gl_account_id
+    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
+      [sub_type, is_cash_asset, name, account_number, description, is_contra_account, cash_flow_classification, parent_gl_account_id].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 unless attributes.is_a?(Hash)
+      attributes = attributes.transform_keys(&:to_sym)
+      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.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
+        # models (e.g. Pet) or oneOf
+        klass = Buildium.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

data/lib/buildium-ruby/models/gl_account_put_message.rb

@@ -0,0 +1,344 @@
+=begin
+#Open API, powered by Buildium
+
+#GetAllGLAccounts) response message now includes the property `IsBankAccount`. This is a boolean property that indicates whether the general ledger account is also a bank account.  * A `Country` property has been added to all Address messages. This property contains an enumeration indicating the country of the address.   
+
+The version of the OpenAPI document: v1
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 6.0.1
+
+=end
+
+require 'date'
+require 'time'
+
+module Buildium
+  class GLAccountPutMessage
+    # Name of the general ledger account. The name cannot exceed 50 characters and must be unique across all general ledger accounts.
+    attr_accessor :name
+
+    # Describes the subtype of the general ledger account.
+    attr_accessor :sub_type
+
+    # Unique identifier of the parent general ledger account. Indicates if this is a sub general ledger account.
+    attr_accessor :parent_gl_account_id
+
+    # Indicates if an account is a Cash Asset. Can only have a value if SubType is `CurrentAsset`
+    attr_accessor :is_cash_asset
+
+    # General ledger account number. The account number cannot exceed 12 characters and must be unique across all general ledger accounts.
+    attr_accessor :account_number
+
+    # Description of the general ledger account. The description cannot exceed 250 characters.
+    attr_accessor :description
+
+    # Indicates whether the account is a contra account. Must be null if `IsCashAsset` field is set to true.
+    attr_accessor :is_contra_account
+
+    # Describes the cash flow classification for the general ledger account. Must be null if `IsCashAsset` field is set to true.
+    attr_accessor :cash_flow_classification
+
+    class EnumAttributeValidator
+      attr_reader :datatype
+      attr_reader :allowable_values
+
+      def initialize(datatype, allowable_values)
+        @allowable_values = allowable_values.map do |value|
+          case datatype.to_s
+          when /Integer/i
+            value.to_i
+          when /Float/i
+            value.to_f
+          else
+            value
+          end
+        end
+      end
+
+      def valid?(value)
+        !value || allowable_values.include?(value)
+      end
+    end
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'name' => :'Name',
+        :'sub_type' => :'SubType',
+        :'parent_gl_account_id' => :'ParentGLAccountId',
+        :'is_cash_asset' => :'IsCashAsset',
+        :'account_number' => :'AccountNumber',
+        :'description' => :'Description',
+        :'is_contra_account' => :'IsContraAccount',
+        :'cash_flow_classification' => :'CashFlowClassification'
+      }
+    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
+      {
+        :'name' => :'String',
+        :'sub_type' => :'String',
+        :'parent_gl_account_id' => :'Integer',
+        :'is_cash_asset' => :'Boolean',
+        :'account_number' => :'String',
+        :'description' => :'String',
+        :'is_contra_account' => :'Boolean',
+        :'cash_flow_classification' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    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 `Buildium::GLAccountPutMessage` 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 `Buildium::GLAccountPutMessage`. 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?(:'name')
+        self.name = attributes[:'name']
+      end
+
+      if attributes.key?(:'sub_type')
+        self.sub_type = attributes[:'sub_type']
+      end
+
+      if attributes.key?(:'parent_gl_account_id')
+        self.parent_gl_account_id = attributes[:'parent_gl_account_id']
+      end
+
+      if attributes.key?(:'is_cash_asset')
+        self.is_cash_asset = attributes[:'is_cash_asset']
+      end
+
+      if attributes.key?(:'account_number')
+        self.account_number = attributes[:'account_number']
+      end
+
+      if attributes.key?(:'description')
+        self.description = attributes[:'description']
+      end
+
+      if attributes.key?(:'is_contra_account')
+        self.is_contra_account = attributes[:'is_contra_account']
+      end
+
+      if attributes.key?(:'cash_flow_classification')
+        self.cash_flow_classification = attributes[:'cash_flow_classification']
+      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
+      if @name.nil?
+        invalid_properties.push('invalid value for "name", name cannot be nil.')
+      end
+
+      if @sub_type.nil?
+        invalid_properties.push('invalid value for "sub_type", sub_type cannot be nil.')
+      end
+
+      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?
+      return false if @name.nil?
+      return false if @sub_type.nil?
+      sub_type_validator = EnumAttributeValidator.new('String', ["CurrentAsset", "FixedAsset", "CurrentLiability", "LongTermLiability", "Equity", "Income", "NonOperatingIncome", "OperatingExpenses", "NonOperatingExpenses"])
+      return false unless sub_type_validator.valid?(@sub_type)
+      cash_flow_classification_validator = EnumAttributeValidator.new('String', ["OperatingActivities", "InvestingActivities", "FinancingActivities"])
+      return false unless cash_flow_classification_validator.valid?(@cash_flow_classification)
+      true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] sub_type Object to be assigned
+    def sub_type=(sub_type)
+      validator = EnumAttributeValidator.new('String', ["CurrentAsset", "FixedAsset", "CurrentLiability", "LongTermLiability", "Equity", "Income", "NonOperatingIncome", "OperatingExpenses", "NonOperatingExpenses"])
+      unless validator.valid?(sub_type)
+        fail ArgumentError, "invalid value #{ sub_type.inspect } for \"sub_type\", must be one of #{validator.allowable_values}."
+      end
+      @sub_type = sub_type
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] cash_flow_classification Object to be assigned
+    def cash_flow_classification=(cash_flow_classification)
+      validator = EnumAttributeValidator.new('String', ["OperatingActivities", "InvestingActivities", "FinancingActivities"])
+      unless validator.valid?(cash_flow_classification)
+        fail ArgumentError, "invalid value #{ cash_flow_classification.inspect } for \"cash_flow_classification\", must be one of #{validator.allowable_values}."
+      end
+      @cash_flow_classification = cash_flow_classification
+    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 &&
+          name == o.name &&
+          sub_type == o.sub_type &&
+          parent_gl_account_id == o.parent_gl_account_id &&
+          is_cash_asset == o.is_cash_asset &&
+          account_number == o.account_number &&
+          description == o.description &&
+          is_contra_account == o.is_contra_account &&
+          cash_flow_classification == o.cash_flow_classification
+    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
+      [name, sub_type, parent_gl_account_id, is_cash_asset, account_number, description, is_contra_account, cash_flow_classification].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 unless attributes.is_a?(Hash)
+      attributes = attributes.transform_keys(&:to_sym)
+      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.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
+        # models (e.g. Pet) or oneOf
+        klass = Buildium.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