xero-ruby 2.4.1 → 3.2.1

data/lib/xero-ruby/models/accounting/actions.rb

@@ -1,9 +1,8 @@
 =begin
-#Accounting API
+#Xero Accounting API
 
 #No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
 
-The version of the OpenAPI document: 2.6.0
 Contact: api@xero.com
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 4.3.1
@@ -173,38 +172,53 @@ module XeroRuby::Accounting
 
     # Returns the object in the form of hash
     # @return [Hash] Returns the object in the form of hash
-    def to_hash
+    def to_hash(downcase: false)
       hash = {}
       self.class.attribute_map.each_pair do |attr, param|
         value = self.send(attr)
         next if value.nil?
-        hash[param] = _to_hash(value)
+        key = downcase ? attr : param
+        hash[key] = _to_hash(value, downcase: downcase)
       end
       hash
     end
 
+    # Returns the object in the form of hash with snake_case
+    def to_attributes
+      to_hash(downcase: true)
+    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)
+    def _to_hash(value, downcase: false)
       if value.is_a?(Array)
-        value.compact.map { |v| _to_hash(v) }
+        value.map do |v|
+          v.to_hash(downcase: downcase)
+        end
       elsif value.is_a?(Hash)
         {}.tap do |hash|
-          value.each { |k, v| hash[k] = _to_hash(v) }
+          value.map { |k, v| hash[k] = _to_hash(v, downcase: downcase) }
         end
       elsif value.respond_to? :to_hash
-        value.to_hash
+        value.to_hash(downcase: downcase)
       else
         value
       end
     end
 
-    # customized data_parser
     def parse_date(datestring)
-      seconds_since_epoch = datestring.scan(/[0-9]+/)[0].to_i / 1000.0
-      return Time.at(seconds_since_epoch).strftime('%Y-%m-%dT%l:%M:%S%z').to_s
+      if datestring.include?('Date')
+        date_pattern = /\/Date\((-?\d+)(\+\d+)?\)\//
+        original, date, timezone = *date_pattern.match(datestring)
+        date = (date.to_i / 1000)
+        Time.at(date).utc.strftime('%Y-%m-%dT%H:%M:%S%z').to_s
+      elsif /(\d\d\d\d)-(\d\d)/.match(datestring) # handles dates w/out Days: YYYY-MM*-DD
+        Time.parse(datestring + '-01').strftime('%Y-%m-%dT%H:%M:%S').to_s
+      else # handle date 'types' for small subset of payroll API's
+        Time.parse(datestring).strftime('%Y-%m-%dT%H:%M:%S').to_s
+      end
     end
   end
 end

data/lib/xero-ruby/models/accounting/address.rb

@@ -1,9 +1,8 @@
 =begin
-#Accounting API
+#Xero Accounting API
 
 #No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
 
-The version of the OpenAPI document: 2.6.0
 Contact: api@xero.com
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 4.3.1
@@ -21,7 +20,6 @@ module XeroRuby::Accounting
     attr_accessor :address_type
     POBOX = "POBOX".freeze
     STREET = "STREET".freeze
-    DELIVERY = "DELIVERY".freeze
     
     # max length = 500
     attr_accessor :address_line1
@@ -206,7 +204,7 @@ module XeroRuby::Accounting
     # Check to see if the all the properties in the model are valid
     # @return true if the model is valid
     def valid?
-      address_type_validator = EnumAttributeValidator.new('String', ["POBOX", "STREET", "DELIVERY"])
+      address_type_validator = EnumAttributeValidator.new('String', ["POBOX", "STREET"])
       return false unless address_type_validator.valid?(@address_type)
       return false if !@address_line1.nil? && @address_line1.to_s.length > 500
       return false if !@address_line2.nil? && @address_line2.to_s.length > 500
@@ -223,7 +221,7 @@ module XeroRuby::Accounting
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] address_type Object to be assigned
     def address_type=(address_type)
-      validator = EnumAttributeValidator.new('String', ["POBOX", "STREET", "DELIVERY"])
+      validator = EnumAttributeValidator.new('String', ["POBOX", "STREET"])
       unless validator.valid?(address_type)
         fail ArgumentError, "invalid value for \"address_type\", must be one of #{validator.allowable_values}."
       end
@@ -433,38 +431,53 @@ module XeroRuby::Accounting
 
     # Returns the object in the form of hash
     # @return [Hash] Returns the object in the form of hash
-    def to_hash
+    def to_hash(downcase: false)
       hash = {}
       self.class.attribute_map.each_pair do |attr, param|
         value = self.send(attr)
         next if value.nil?
-        hash[param] = _to_hash(value)
+        key = downcase ? attr : param
+        hash[key] = _to_hash(value, downcase: downcase)
       end
       hash
     end
 
+    # Returns the object in the form of hash with snake_case
+    def to_attributes
+      to_hash(downcase: true)
+    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)
+    def _to_hash(value, downcase: false)
       if value.is_a?(Array)
-        value.compact.map { |v| _to_hash(v) }
+        value.map do |v|
+          v.to_hash(downcase: downcase)
+        end
       elsif value.is_a?(Hash)
         {}.tap do |hash|
-          value.each { |k, v| hash[k] = _to_hash(v) }
+          value.map { |k, v| hash[k] = _to_hash(v, downcase: downcase) }
         end
       elsif value.respond_to? :to_hash
-        value.to_hash
+        value.to_hash(downcase: downcase)
       else
         value
       end
     end
 
-    # customized data_parser
     def parse_date(datestring)
-      seconds_since_epoch = datestring.scan(/[0-9]+/)[0].to_i / 1000.0
-      return Time.at(seconds_since_epoch).strftime('%Y-%m-%dT%l:%M:%S%z').to_s
+      if datestring.include?('Date')
+        date_pattern = /\/Date\((-?\d+)(\+\d+)?\)\//
+        original, date, timezone = *date_pattern.match(datestring)
+        date = (date.to_i / 1000)
+        Time.at(date).utc.strftime('%Y-%m-%dT%H:%M:%S%z').to_s
+      elsif /(\d\d\d\d)-(\d\d)/.match(datestring) # handles dates w/out Days: YYYY-MM*-DD
+        Time.parse(datestring + '-01').strftime('%Y-%m-%dT%H:%M:%S').to_s
+      else # handle date 'types' for small subset of payroll API's
+        Time.parse(datestring).strftime('%Y-%m-%dT%H:%M:%S').to_s
+      end
     end
   end
 end

data/lib/xero-ruby/models/accounting/address_for_organisation.rb

@@ -0,0 +1,484 @@
+=begin
+#Xero Accounting API
+
+#No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+Contact: api@xero.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.3.1
+
+=end
+
+require 'time'
+require 'date'
+
+module XeroRuby::Accounting
+  require 'bigdecimal'
+
+  class AddressForOrganisation
+    # define the type of address
+    attr_accessor :address_type
+    POBOX = "POBOX".freeze
+    STREET = "STREET".freeze
+    DELIVERY = "DELIVERY".freeze
+    
+    # max length = 500
+    attr_accessor :address_line1
+    
+    # max length = 500
+    attr_accessor :address_line2
+    
+    # max length = 500
+    attr_accessor :address_line3
+    
+    # max length = 500
+    attr_accessor :address_line4
+    
+    # max length = 255
+    attr_accessor :city
+    
+    # max length = 255
+    attr_accessor :region
+    
+    # max length = 50
+    attr_accessor :postal_code
+    
+    # max length = 50, [A-Z], [a-z] only
+    attr_accessor :country
+    
+    # max length = 255
+    attr_accessor :attention_to
+    
+    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
+      {
+        :'address_type' => :'AddressType',
+        :'address_line1' => :'AddressLine1',
+        :'address_line2' => :'AddressLine2',
+        :'address_line3' => :'AddressLine3',
+        :'address_line4' => :'AddressLine4',
+        :'city' => :'City',
+        :'region' => :'Region',
+        :'postal_code' => :'PostalCode',
+        :'country' => :'Country',
+        :'attention_to' => :'AttentionTo'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'address_type' => :'String',
+        :'address_line1' => :'String',
+        :'address_line2' => :'String',
+        :'address_line3' => :'String',
+        :'address_line4' => :'String',
+        :'city' => :'String',
+        :'region' => :'String',
+        :'postal_code' => :'String',
+        :'country' => :'String',
+        :'attention_to' => :'String'
+      }
+    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 `XeroRuby::Accounting::AddressForOrganisation` 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 `XeroRuby::Accounting::AddressForOrganisation`. 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?(:'address_type')
+        self.address_type = attributes[:'address_type']
+      end
+
+      if attributes.key?(:'address_line1')
+        self.address_line1 = attributes[:'address_line1']
+      end
+
+      if attributes.key?(:'address_line2')
+        self.address_line2 = attributes[:'address_line2']
+      end
+
+      if attributes.key?(:'address_line3')
+        self.address_line3 = attributes[:'address_line3']
+      end
+
+      if attributes.key?(:'address_line4')
+        self.address_line4 = attributes[:'address_line4']
+      end
+
+      if attributes.key?(:'city')
+        self.city = attributes[:'city']
+      end
+
+      if attributes.key?(:'region')
+        self.region = attributes[:'region']
+      end
+
+      if attributes.key?(:'postal_code')
+        self.postal_code = attributes[:'postal_code']
+      end
+
+      if attributes.key?(:'country')
+        self.country = attributes[:'country']
+      end
+
+      if attributes.key?(:'attention_to')
+        self.attention_to = attributes[:'attention_to']
+      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 !@address_line1.nil? && @address_line1.to_s.length > 500
+        invalid_properties.push('invalid value for "address_line1", the character length must be smaller than or equal to 500.')
+      end
+
+      if !@address_line2.nil? && @address_line2.to_s.length > 500
+        invalid_properties.push('invalid value for "address_line2", the character length must be smaller than or equal to 500.')
+      end
+
+      if !@address_line3.nil? && @address_line3.to_s.length > 500
+        invalid_properties.push('invalid value for "address_line3", the character length must be smaller than or equal to 500.')
+      end
+
+      if !@address_line4.nil? && @address_line4.to_s.length > 500
+        invalid_properties.push('invalid value for "address_line4", the character length must be smaller than or equal to 500.')
+      end
+
+      if !@city.nil? && @city.to_s.length > 255
+        invalid_properties.push('invalid value for "city", the character length must be smaller than or equal to 255.')
+      end
+
+      if !@region.nil? && @region.to_s.length > 255
+        invalid_properties.push('invalid value for "region", the character length must be smaller than or equal to 255.')
+      end
+
+      if !@postal_code.nil? && @postal_code.to_s.length > 50
+        invalid_properties.push('invalid value for "postal_code", the character length must be smaller than or equal to 50.')
+      end
+
+      if !@country.nil? && @country.to_s.length > 50
+        invalid_properties.push('invalid value for "country", the character length must be smaller than or equal to 50.')
+      end
+
+      if !@attention_to.nil? && @attention_to.to_s.length > 255
+        invalid_properties.push('invalid value for "attention_to", the character length must be smaller than or equal to 255.')
+      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?
+      address_type_validator = EnumAttributeValidator.new('String', ["POBOX", "STREET", "DELIVERY"])
+      return false unless address_type_validator.valid?(@address_type)
+      return false if !@address_line1.nil? && @address_line1.to_s.length > 500
+      return false if !@address_line2.nil? && @address_line2.to_s.length > 500
+      return false if !@address_line3.nil? && @address_line3.to_s.length > 500
+      return false if !@address_line4.nil? && @address_line4.to_s.length > 500
+      return false if !@city.nil? && @city.to_s.length > 255
+      return false if !@region.nil? && @region.to_s.length > 255
+      return false if !@postal_code.nil? && @postal_code.to_s.length > 50
+      return false if !@country.nil? && @country.to_s.length > 50
+      return false if !@attention_to.nil? && @attention_to.to_s.length > 255
+      true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] address_type Object to be assigned
+    def address_type=(address_type)
+      validator = EnumAttributeValidator.new('String', ["POBOX", "STREET", "DELIVERY"])
+      unless validator.valid?(address_type)
+        fail ArgumentError, "invalid value for \"address_type\", must be one of #{validator.allowable_values}."
+      end
+      @address_type = address_type
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] address_line1 Value to be assigned
+    def address_line1=(address_line1)
+      if !address_line1.nil? && address_line1.to_s.length > 500
+        fail ArgumentError, 'invalid value for "address_line1", the character length must be smaller than or equal to 500.'
+      end
+
+      @address_line1 = address_line1
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] address_line2 Value to be assigned
+    def address_line2=(address_line2)
+      if !address_line2.nil? && address_line2.to_s.length > 500
+        fail ArgumentError, 'invalid value for "address_line2", the character length must be smaller than or equal to 500.'
+      end
+
+      @address_line2 = address_line2
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] address_line3 Value to be assigned
+    def address_line3=(address_line3)
+      if !address_line3.nil? && address_line3.to_s.length > 500
+        fail ArgumentError, 'invalid value for "address_line3", the character length must be smaller than or equal to 500.'
+      end
+
+      @address_line3 = address_line3
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] address_line4 Value to be assigned
+    def address_line4=(address_line4)
+      if !address_line4.nil? && address_line4.to_s.length > 500
+        fail ArgumentError, 'invalid value for "address_line4", the character length must be smaller than or equal to 500.'
+      end
+
+      @address_line4 = address_line4
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] city Value to be assigned
+    def city=(city)
+      if !city.nil? && city.to_s.length > 255
+        fail ArgumentError, 'invalid value for "city", the character length must be smaller than or equal to 255.'
+      end
+
+      @city = city
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] region Value to be assigned
+    def region=(region)
+      if !region.nil? && region.to_s.length > 255
+        fail ArgumentError, 'invalid value for "region", the character length must be smaller than or equal to 255.'
+      end
+
+      @region = region
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] postal_code Value to be assigned
+    def postal_code=(postal_code)
+      if !postal_code.nil? && postal_code.to_s.length > 50
+        fail ArgumentError, 'invalid value for "postal_code", the character length must be smaller than or equal to 50.'
+      end
+
+      @postal_code = postal_code
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] country Value to be assigned
+    def country=(country)
+      if !country.nil? && country.to_s.length > 50
+        fail ArgumentError, 'invalid value for "country", the character length must be smaller than or equal to 50.'
+      end
+
+      @country = country
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] attention_to Value to be assigned
+    def attention_to=(attention_to)
+      if !attention_to.nil? && attention_to.to_s.length > 255
+        fail ArgumentError, 'invalid value for "attention_to", the character length must be smaller than or equal to 255.'
+      end
+
+      @attention_to = attention_to
+    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 &&
+          address_type == o.address_type &&
+          address_line1 == o.address_line1 &&
+          address_line2 == o.address_line2 &&
+          address_line3 == o.address_line3 &&
+          address_line4 == o.address_line4 &&
+          city == o.city &&
+          region == o.region &&
+          postal_code == o.postal_code &&
+          country == o.country &&
+          attention_to == o.attention_to
+    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
+      [address_type, address_line1, address_line2, address_line3, address_line4, city, region, postal_code, country, attention_to].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 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
+
+    # 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 :DateTime
+        DateTime.parse(parse_date(value))
+      when :Date
+        Date.parse(parse_date(value))
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :BigDecimal
+        BigDecimal(value.to_s)
+      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
+        XeroRuby::Accounting.const_get(type).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(downcase: false)
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        next if value.nil?
+        key = downcase ? attr : param
+        hash[key] = _to_hash(value, downcase: downcase)
+      end
+      hash
+    end
+
+    # Returns the object in the form of hash with snake_case
+    def to_attributes
+      to_hash(downcase: true)
+    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, downcase: false)
+      if value.is_a?(Array)
+        value.map do |v|
+          v.to_hash(downcase: downcase)
+        end
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.map { |k, v| hash[k] = _to_hash(v, downcase: downcase) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash(downcase: downcase)
+      else
+        value
+      end
+    end
+
+    def parse_date(datestring)
+      if datestring.include?('Date')
+        date_pattern = /\/Date\((-?\d+)(\+\d+)?\)\//
+        original, date, timezone = *date_pattern.match(datestring)
+        date = (date.to_i / 1000)
+        Time.at(date).utc.strftime('%Y-%m-%dT%H:%M:%S%z').to_s
+      elsif /(\d\d\d\d)-(\d\d)/.match(datestring) # handles dates w/out Days: YYYY-MM*-DD
+        Time.parse(datestring + '-01').strftime('%Y-%m-%dT%H:%M:%S').to_s
+      else # handle date 'types' for small subset of payroll API's
+        Time.parse(datestring).strftime('%Y-%m-%dT%H:%M:%S').to_s
+      end
+    end
+  end
+end