xero-ruby 16.0.0 → 18.2.0

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

@@ -0,0 +1,277 @@
+=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 TrackingReference
+    # The Xero identifier for a tracking category
+    attr_accessor :tracking_category_id
+    
+    # The Xero identifier for a tracking category option
+    attr_accessor :tracking_option_id
+    
+    # The name of the tracking category
+    attr_accessor :name
+    
+    # See Tracking Options
+    attr_accessor :option
+    
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'tracking_category_id' => :'TrackingCategoryID',
+        :'tracking_option_id' => :'TrackingOptionID',
+        :'name' => :'Name',
+        :'option' => :'Option'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'tracking_category_id' => :'String',
+        :'tracking_option_id' => :'String',
+        :'name' => :'String',
+        :'option' => :'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::TrackingReference` 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::TrackingReference`. 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?(:'tracking_category_id')
+        self.tracking_category_id = attributes[:'tracking_category_id']
+      end
+
+      if attributes.key?(:'tracking_option_id')
+        self.tracking_option_id = attributes[:'tracking_option_id']
+      end
+
+      if attributes.key?(:'name')
+        self.name = attributes[:'name']
+      end
+
+      if attributes.key?(:'option')
+        self.option = attributes[:'option']
+      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 @tracking_category_id.nil?
+        invalid_properties.push('invalid value for "tracking_category_id", tracking_category_id cannot be nil.')
+      end
+
+      if @tracking_option_id.nil?
+        invalid_properties.push('invalid value for "tracking_option_id", tracking_option_id cannot be nil.')
+      end
+
+      if !@name.nil? && @name.to_s.length > 100
+        invalid_properties.push('invalid value for "name", the character length must be smaller than or equal to 100.')
+      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 @tracking_category_id.nil?
+      return false if @tracking_option_id.nil?
+      return false if !@name.nil? && @name.to_s.length > 100
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] name Value to be assigned
+    def name=(name)
+      if !name.nil? && name.to_s.length > 100
+        fail ArgumentError, 'invalid value for "name", the character length must be smaller than or equal to 100.'
+      end
+
+      @name = name
+    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 &&
+          tracking_category_id == o.tracking_category_id &&
+          tracking_option_id == o.tracking_option_id &&
+          name == o.name &&
+          option == o.option
+    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
+      [tracking_category_id, tracking_option_id, name, option].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_au/earnings_rate.rb

@@ -34,7 +34,7 @@ module XeroRuby::PayrollAu
     # Boolean to determine if the earnings rate is reportable or exempt from W1
     attr_accessor :is_reportable_as_w1
     
-    # Optional Boolean to determine if the earnings rate is considered as qualifying earnings for superannuation guarantee calculations. When not specified value is calculated based on earnings type and superannuation settings
+    # Boolean to determine if the earnings rate is considered as qualifying earnings for superannuation guarantee calculations
     attr_accessor :is_qualifying_earnings
     
     # Boolean to determine if the allowance earnings rate contributes towards annual leave rate. Only applicable if EarningsType is ALLOWANCE and RateType is RATEPERUNIT
@@ -245,6 +245,10 @@ module XeroRuby::PayrollAu
         invalid_properties.push('invalid value for "type_of_units", the character length must be smaller than or equal to 50.')
       end
 
+      if @is_qualifying_earnings.nil?
+        invalid_properties.push('invalid value for "is_qualifying_earnings", is_qualifying_earnings cannot be nil.')
+      end
+
       invalid_properties
     end
 
@@ -253,6 +257,7 @@ module XeroRuby::PayrollAu
     def valid?
       return false if !@name.nil? && @name.to_s.length > 100
       return false if !@type_of_units.nil? && @type_of_units.to_s.length > 50
+      return false if @is_qualifying_earnings.nil?
       true
     end
 

data/lib/xero-ruby/models/payroll_au/leave_line.rb

@@ -31,7 +31,7 @@ module XeroRuby::PayrollAu
     # amount of leave line
     attr_accessor :include_superannuation_guarantee_contribution
     
-    # Optional Boolean to determine if the earnings rate is considered as qualifying earnings for superannuation guarantee calculations. When not specified value is calculated based on superannuation settings
+    # Boolean to determine if the leave line is considered as qualifying earnings for superannuation guarantee calculations
     attr_accessor :is_qualifying_earnings
     
     # Number of units for leave line.
@@ -129,12 +129,17 @@ module XeroRuby::PayrollAu
     # @return Array for valid properties with the reasons
     def list_invalid_properties
       invalid_properties = Array.new
+      if @is_qualifying_earnings.nil?
+        invalid_properties.push('invalid value for "is_qualifying_earnings", is_qualifying_earnings 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 @is_qualifying_earnings.nil?
       true
     end
 

data/lib/xero-ruby/models/payroll_au/leave_type.rb

@@ -49,7 +49,7 @@ module XeroRuby::PayrollAu
     # Set this to indicate that the leave type is exempt from superannuation guarantee contribution
     attr_accessor :sgc_exempt
     
-    # Optional Boolean to determine if the earnings rate is considered as qualifying earnings for superannuation guarantee calculations. When not specified value is calculated based on earnings type and superannuation settings
+    # Boolean to determine if the leave type is considered as qualifying earnings for superannuation guarantee calculations
     attr_accessor :is_qualifying_earnings
     
     # Attribute mapping from ruby-style variable name to JSON key.
@@ -160,6 +160,10 @@ module XeroRuby::PayrollAu
         invalid_properties.push('invalid value for "name", the character length must be smaller than or equal to 100.')
       end
 
+      if @is_qualifying_earnings.nil?
+        invalid_properties.push('invalid value for "is_qualifying_earnings", is_qualifying_earnings cannot be nil.')
+      end
+
       invalid_properties
     end
 
@@ -167,6 +171,7 @@ module XeroRuby::PayrollAu
     # @return true if the model is valid
     def valid?
       return false if !@name.nil? && @name.to_s.length > 100
+      return false if @is_qualifying_earnings.nil?
       true
     end
 

data/lib/xero-ruby/models/payroll_au/tax_declaration.rb

@@ -79,7 +79,7 @@ module XeroRuby::PayrollAu
     # Last modified timestamp
     attr_accessor :updated_date_utc
     
-    # Optional Boolean to determine if leave loading is considered as qualifying earnings for superannuation guarantee calculations
+    # Boolean to determine if leave loading is considered as qualifying earnings for superannuation guarantee calculations. Required when IncludeLeaveLoadingInSGC is specified in the payload
     attr_accessor :include_leave_loading_in_qualifying_earnings
     
     # Attribute mapping from ruby-style variable name to JSON key.

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

@@ -17,6 +17,7 @@ module XeroRuby::PayrollUk
     EMPLOYEE ||= "Employee".freeze
     WORKER ||= "Worker".freeze
     UNSPECIFIED ||= "Unspecified".freeze
+    OFF_PAYROLL_WORKER ||= "OffPayrollWorker".freeze
 
     # Builds the enum from string
     # @param [String] The enum value in the form of the string

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: 14.0.0
+The version of the XeroOpenAPI document: 19.0.0
 =end
 
 module XeroRuby
-  VERSION = '16.0.0'
+  VERSION = '18.2.0'
 end

data/lib/xero-ruby.rb

@@ -429,7 +429,10 @@ require 'xero-ruby/models/accounting/balances'
 require 'xero-ruby/models/accounting/bank_transaction'
 require 'xero-ruby/models/accounting/bank_transactions'
 require 'xero-ruby/models/accounting/bank_transfer'
+require 'xero-ruby/models/accounting/bank_transfer_delete'
+require 'xero-ruby/models/accounting/bank_transfer_delete_by_url_param'
 require 'xero-ruby/models/accounting/bank_transfers'
+require 'xero-ruby/models/accounting/bank_transfers_delete'
 require 'xero-ruby/models/accounting/batch_payment'
 require 'xero-ruby/models/accounting/batch_payment_delete'
 require 'xero-ruby/models/accounting/batch_payment_delete_by_url_param'
@@ -544,6 +547,7 @@ require 'xero-ruby/models/accounting/tracking_categories'
 require 'xero-ruby/models/accounting/tracking_category'
 require 'xero-ruby/models/accounting/tracking_option'
 require 'xero-ruby/models/accounting/tracking_options'
+require 'xero-ruby/models/accounting/tracking_reference'
 require 'xero-ruby/models/accounting/user'
 require 'xero-ruby/models/accounting/users'
 require 'xero-ruby/models/accounting/validation_error'