xero-ruby 9.2.0 → 9.3.0.pre.alpha

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

@@ -0,0 +1,351 @@
+=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 TaxBreakdownComponent
+    # The unique ID number of this component
+    attr_accessor :tax_component_id
+    
+    # The type of the jurisdiction
+    attr_accessor :type
+    USCOUNTRY ||= "SYSGST/USCOUNTRY".freeze
+    USSTATE ||= "SYSGST/USSTATE".freeze
+    USCOUNTY ||= "SYSGST/USCOUNTY".freeze
+    USCITY ||= "SYSGST/USCITY".freeze
+    USSPECIAL ||= "SYSGST/USSPECIAL".freeze
+    
+    # The name of the jurisdiction
+    attr_accessor :name
+    
+    # The percentage of the tax
+    attr_accessor :tax_percentage
+    
+    # The amount of the tax
+    attr_accessor :tax_amount
+    
+    # The amount that is taxable
+    attr_accessor :taxable_amount
+    
+    # The amount that is not taxable
+    attr_accessor :non_taxable_amount
+    
+    # The amount that is exempt
+    attr_accessor :exempt_amount
+    
+    # The state assigned number of the jurisdiction
+    attr_accessor :state_assigned_no
+    
+    # Name identifying the region within the country
+    attr_accessor :jurisdiction_region
+    
+    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
+      {
+        :'tax_component_id' => :'TaxComponentId',
+        :'type' => :'Type',
+        :'name' => :'Name',
+        :'tax_percentage' => :'TaxPercentage',
+        :'tax_amount' => :'TaxAmount',
+        :'taxable_amount' => :'TaxableAmount',
+        :'non_taxable_amount' => :'NonTaxableAmount',
+        :'exempt_amount' => :'ExemptAmount',
+        :'state_assigned_no' => :'StateAssignedNo',
+        :'jurisdiction_region' => :'JurisdictionRegion'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'tax_component_id' => :'String',
+        :'type' => :'String',
+        :'name' => :'String',
+        :'tax_percentage' => :'Float',
+        :'tax_amount' => :'Float',
+        :'taxable_amount' => :'Float',
+        :'non_taxable_amount' => :'Float',
+        :'exempt_amount' => :'Float',
+        :'state_assigned_no' => :'String',
+        :'jurisdiction_region' => :'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::TaxBreakdownComponent` 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::TaxBreakdownComponent`. 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?(:'tax_component_id')
+        self.tax_component_id = attributes[:'tax_component_id']
+      end
+
+      if attributes.key?(:'type')
+        self.type = attributes[:'type']
+      end
+
+      if attributes.key?(:'name')
+        self.name = attributes[:'name']
+      end
+
+      if attributes.key?(:'tax_percentage')
+        self.tax_percentage = attributes[:'tax_percentage']
+      end
+
+      if attributes.key?(:'tax_amount')
+        self.tax_amount = attributes[:'tax_amount']
+      end
+
+      if attributes.key?(:'taxable_amount')
+        self.taxable_amount = attributes[:'taxable_amount']
+      end
+
+      if attributes.key?(:'non_taxable_amount')
+        self.non_taxable_amount = attributes[:'non_taxable_amount']
+      end
+
+      if attributes.key?(:'exempt_amount')
+        self.exempt_amount = attributes[:'exempt_amount']
+      end
+
+      if attributes.key?(:'state_assigned_no')
+        self.state_assigned_no = attributes[:'state_assigned_no']
+      end
+
+      if attributes.key?(:'jurisdiction_region')
+        self.jurisdiction_region = attributes[:'jurisdiction_region']
+      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?
+      type_validator = EnumAttributeValidator.new('String', ["SYSGST/USCOUNTRY", "SYSGST/USSTATE", "SYSGST/USCOUNTY", "SYSGST/USCITY", "SYSGST/USSPECIAL"])
+      return false unless type_validator.valid?(@type)
+      true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] type Object to be assigned
+    def type=(type)
+      validator = EnumAttributeValidator.new('String', ["SYSGST/USCOUNTRY", "SYSGST/USSTATE", "SYSGST/USCOUNTY", "SYSGST/USCITY", "SYSGST/USSPECIAL"])
+      unless validator.valid?(type)
+        fail ArgumentError, "invalid value for \"type\", must be one of #{validator.allowable_values}."
+      end
+      @type = type
+    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 &&
+          tax_component_id == o.tax_component_id &&
+          type == o.type &&
+          name == o.name &&
+          tax_percentage == o.tax_percentage &&
+          tax_amount == o.tax_amount &&
+          taxable_amount == o.taxable_amount &&
+          non_taxable_amount == o.non_taxable_amount &&
+          exempt_amount == o.exempt_amount &&
+          state_assigned_no == o.state_assigned_no &&
+          jurisdiction_region == o.jurisdiction_region
+    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
+      [tax_component_id, type, name, tax_percentage, tax_amount, taxable_amount, non_taxable_amount, exempt_amount, state_assigned_no, jurisdiction_region].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

data/lib/xero-ruby/models/payroll_uk/employee_leave_type.rb

@@ -38,6 +38,9 @@ module XeroRuby::PayrollUk
     # The number of hours added to the leave balance for every hour worked by the employee. This is normally 0, unless the scheduleOfAccrual chosen is \"OnHourWorked\"
     attr_accessor :rate_accrued_hourly
     
+    # The date when an employee becomes entitled to their accrual. Only applicable when scheduleOfAccrual is \"OnAnniversaryDate\"
+    attr_accessor :schedule_of_accrual_date
+    
     class EnumAttributeValidator
       attr_reader :datatype
       attr_reader :allowable_values
@@ -68,7 +71,8 @@ module XeroRuby::PayrollUk
         :'hours_accrued_annually' => :'hoursAccruedAnnually',
         :'maximum_to_accrue' => :'maximumToAccrue',
         :'opening_balance' => :'openingBalance',
-        :'rate_accrued_hourly' => :'rateAccruedHourly'
+        :'rate_accrued_hourly' => :'rateAccruedHourly',
+        :'schedule_of_accrual_date' => :'scheduleOfAccrualDate'
       }
     end
 
@@ -80,7 +84,8 @@ module XeroRuby::PayrollUk
         :'hours_accrued_annually' => :'Float',
         :'maximum_to_accrue' => :'Float',
         :'opening_balance' => :'Float',
-        :'rate_accrued_hourly' => :'Float'
+        :'rate_accrued_hourly' => :'Float',
+        :'schedule_of_accrual_date' => :'Date'
       }
     end
 
@@ -122,6 +127,10 @@ module XeroRuby::PayrollUk
       if attributes.key?(:'rate_accrued_hourly')
         self.rate_accrued_hourly = attributes[:'rate_accrued_hourly']
       end
+
+      if attributes.key?(:'schedule_of_accrual_date')
+        self.schedule_of_accrual_date = attributes[:'schedule_of_accrual_date']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -169,7 +178,8 @@ module XeroRuby::PayrollUk
           hours_accrued_annually == o.hours_accrued_annually &&
           maximum_to_accrue == o.maximum_to_accrue &&
           opening_balance == o.opening_balance &&
-          rate_accrued_hourly == o.rate_accrued_hourly
+          rate_accrued_hourly == o.rate_accrued_hourly &&
+          schedule_of_accrual_date == o.schedule_of_accrual_date
     end
 
     # @see the `==` method
@@ -181,7 +191,7 @@ module XeroRuby::PayrollUk
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [leave_type_id, schedule_of_accrual, hours_accrued_annually, maximum_to_accrue, opening_balance, rate_accrued_hourly].hash
+      [leave_type_id, schedule_of_accrual, hours_accrued_annually, maximum_to_accrue, opening_balance, rate_accrued_hourly, schedule_of_accrual_date].hash
     end
 
     # Builds the object from hash

data/lib/xero-ruby/version.rb

@@ -7,9 +7,9 @@ Contact: api@xero.com
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 4.3.1
 
-The version of the XeroOpenAPI document: 6.2.0
+The version of the XeroOpenAPI document: 6.3.0
 =end
 
 module XeroRuby
-  VERSION = '9.2.0'
+  VERSION = '9.3.0-alpha'
 end

data/lib/xero-ruby/where.rb

@@ -17,51 +17,51 @@ module XeroRuby
 
     private
 
-    def parameterize_option(key, value)
-      quoted_key = quote_key(key)
+      def parameterize_option(key, value)
+        quoted_key = quote_key(key)
 
-      case value
-      when Array
-        operator, query = value
+        case value
+        when Array
+          operator, query = value
 
-        if STRING_FUNCTIONS.include?(camelize_key(operator))
-          "#{quoted_key}.#{camelize_key(operator)}(#{quote_value(query)})"
+          if STRING_FUNCTIONS.include?(camelize_key(operator))
+            "#{quoted_key}.#{camelize_key(operator)}(#{quote_value(query)})"
+          else
+            "#{quoted_key} #{operator} #{quote_value(query)}"
+          end
+        when Range
+          "#{quoted_key} >= #{quote_value(value.first)} AND #{quoted_key} <= #{quote_value(value.last)}"
+        when /^\./
+          "#{quoted_key}#{value}"
         else
-        "#{quoted_key} #{operator} #{quote_value(query)}"
+          "#{quoted_key} #{value}"
         end
-      when Range
-        "#{quoted_key} >= #{quote_value(value.first)} AND #{quoted_key} <= #{quote_value(value.last)}"
-      when /^\./
-        "#{quoted_key}#{value}"
-      else
-        "#{quoted_key} #{value}"
       end
-    end
 
-    def quote_key(key)
-      case key
-      when :contact_id
-        'Contact.ContactID'
-      when :contact_number
-        'Contact.ContactNumber'
-      when :invoice_id
-        'Invoice.InvoiceId'
-      else
-        camelize_key(key)
+      def quote_key(key)
+        case key
+        when :contact_id
+          'Contact.ContactID'
+        when :contact_number
+          'Contact.ContactNumber'
+        when :invoice_id
+          'Invoice.InvoiceId'
+        else
+          camelize_key(key)
+        end
       end
-    end
 
-    def quote_value(value)
-      case value
-      when DateTime, Date, Time
-        "DateTime(#{value.strftime("%Y,%m,%d")})"
-      when Numeric, false, true
-        value.to_s
-      when UUID_REGEXP
-        %{guid("#{value}")}
-      else
-        %{"#{value.to_s.gsub('"', '""')}"}
+      def quote_value(value)
+        case value
+        when DateTime, Date, Time
+          "DateTime(#{value.strftime("%Y,%m,%d")})"
+        when Numeric, false, true
+          value.to_s
+        when UUID_REGEXP
+          %{guid("#{value}")}
+        else
+          %{"#{value.to_s.gsub('"', '""')}"}
+        end
       end
-    end
   end
 end

data/lib/xero-ruby.rb

@@ -466,6 +466,7 @@ require 'xero-ruby/models/accounting/import_summary_accounts'
 require 'xero-ruby/models/accounting/import_summary_object'
 require 'xero-ruby/models/accounting/import_summary_organisation'
 require 'xero-ruby/models/accounting/invoice'
+require 'xero-ruby/models/accounting/invoice_address'
 require 'xero-ruby/models/accounting/invoice_reminder'
 require 'xero-ruby/models/accounting/invoice_reminders'
 require 'xero-ruby/models/accounting/invoices'
@@ -525,6 +526,7 @@ require 'xero-ruby/models/accounting/row_type'
 require 'xero-ruby/models/accounting/sales_tracking_category'
 require 'xero-ruby/models/accounting/schedule'
 require 'xero-ruby/models/accounting/setup'
+require 'xero-ruby/models/accounting/tax_breakdown_component'
 require 'xero-ruby/models/accounting/tax_component'
 require 'xero-ruby/models/accounting/tax_rate'
 require 'xero-ruby/models/accounting/tax_rates'