xero-ruby 9.3.0 → 18.0.0

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

@@ -0,0 +1,257 @@
+=begin
+#Xero Payroll UK
+
+#This is the Xero Payroll API for orgs in the UK region.
+
+Contact: api@xero.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.3.1
+
+=end
+
+require 'time'
+require 'date'
+
+module XeroRuby::PayrollUk
+  require 'bigdecimal'
+
+  class NICategoryOneOf1
+
+    attr_accessor :ni_category
+    V ||= "V".freeze
+    
+    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
+      {
+        :'ni_category' => :'niCategory'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'ni_category' => :'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::PayrollUk::NICategoryOneOf1` 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::PayrollUk::NICategoryOneOf1`. 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?(:'ni_category')
+        self.ni_category = attributes[:'ni_category']
+      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?
+      ni_category_validator = EnumAttributeValidator.new('String', ["V"])
+      return false unless ni_category_validator.valid?(@ni_category)
+      true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] ni_category Object to be assigned
+    def ni_category=(ni_category)
+      validator = EnumAttributeValidator.new('String', ["V"])
+      unless validator.valid?(ni_category)
+        fail ArgumentError, "invalid value for \"ni_category\", must be one of #{validator.allowable_values}."
+      end
+      @ni_category = ni_category
+    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 &&
+          ni_category == o.ni_category
+    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
+      [ni_category].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::PayrollUk.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/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.3.0
+The version of the XeroOpenAPI document: 16.1.0
 =end
 
 module XeroRuby
-  VERSION = '9.3.0'
+  VERSION = '18.0.0'
 end

data/lib/xero-ruby.rb

@@ -18,8 +18,6 @@ require 'xero-ruby/version'
 require 'xero-ruby/configuration'
 
 # Models
-require 'xero-ruby/models/finance/account_usage'
-require 'xero-ruby/models/finance/account_usage_response'
 require 'xero-ruby/models/finance/balance_sheet_account_detail'
 require 'xero-ruby/models/finance/balance_sheet_account_group'
 require 'xero-ruby/models/finance/balance_sheet_account_type'
@@ -41,25 +39,19 @@ require 'xero-ruby/models/finance/contact_total_other'
 require 'xero-ruby/models/finance/credit_note_response'
 require 'xero-ruby/models/finance/current_statement_response'
 require 'xero-ruby/models/finance/data_source_response'
-require 'xero-ruby/models/finance/history_record_response'
 require 'xero-ruby/models/finance/income_by_contact_response'
 require 'xero-ruby/models/finance/invoice_response'
 require 'xero-ruby/models/finance/line_item_response'
-require 'xero-ruby/models/finance/lock_history_model'
-require 'xero-ruby/models/finance/lock_history_response'
 require 'xero-ruby/models/finance/manual_journal_total'
 require 'xero-ruby/models/finance/overpayment_response'
 require 'xero-ruby/models/finance/payment_response'
 require 'xero-ruby/models/finance/pnl_account'
 require 'xero-ruby/models/finance/pnl_account_class'
 require 'xero-ruby/models/finance/pnl_account_type'
-require 'xero-ruby/models/finance/practice_response'
 require 'xero-ruby/models/finance/prepayment_response'
 require 'xero-ruby/models/finance/problem'
 require 'xero-ruby/models/finance/problem_type'
 require 'xero-ruby/models/finance/profit_and_loss_response'
-require 'xero-ruby/models/finance/report_history_model'
-require 'xero-ruby/models/finance/report_history_response'
 require 'xero-ruby/models/finance/statement_balance_response'
 require 'xero-ruby/models/finance/statement_line_response'
 require 'xero-ruby/models/finance/statement_lines_response'
@@ -70,8 +62,6 @@ require 'xero-ruby/models/finance/trial_balance_account'
 require 'xero-ruby/models/finance/trial_balance_entry'
 require 'xero-ruby/models/finance/trial_balance_movement'
 require 'xero-ruby/models/finance/trial_balance_response'
-require 'xero-ruby/models/finance/user_activities_response'
-require 'xero-ruby/models/finance/user_response'
 require 'xero-ruby/models/app_store/create_usage_record'
 require 'xero-ruby/models/app_store/plan'
 require 'xero-ruby/models/app_store/price'
@@ -90,11 +80,14 @@ require 'xero-ruby/models/payroll_uk/benefit'
 require 'xero-ruby/models/payroll_uk/benefit_line'
 require 'xero-ruby/models/payroll_uk/benefit_object'
 require 'xero-ruby/models/payroll_uk/benefits'
+require 'xero-ruby/models/payroll_uk/contract_type'
+require 'xero-ruby/models/payroll_uk/contracts'
 require 'xero-ruby/models/payroll_uk/court_order_line'
 require 'xero-ruby/models/payroll_uk/deduction'
 require 'xero-ruby/models/payroll_uk/deduction_line'
 require 'xero-ruby/models/payroll_uk/deduction_object'
 require 'xero-ruby/models/payroll_uk/deductions'
+require 'xero-ruby/models/payroll_uk/developmental_role_details'
 require 'xero-ruby/models/payroll_uk/earnings_line'
 require 'xero-ruby/models/payroll_uk/earnings_order'
 require 'xero-ruby/models/payroll_uk/earnings_order_object'
@@ -131,6 +124,7 @@ require 'xero-ruby/models/payroll_uk/employee_tax_object'
 require 'xero-ruby/models/payroll_uk/employees'
 require 'xero-ruby/models/payroll_uk/employment'
 require 'xero-ruby/models/payroll_uk/employment_object'
+require 'xero-ruby/models/payroll_uk/employment_status'
 require 'xero-ruby/models/payroll_uk/invalid_field'
 require 'xero-ruby/models/payroll_uk/leave_accrual_line'
 require 'xero-ruby/models/payroll_uk/leave_earnings_line'
@@ -139,6 +133,10 @@ require 'xero-ruby/models/payroll_uk/leave_periods'
 require 'xero-ruby/models/payroll_uk/leave_type'
 require 'xero-ruby/models/payroll_uk/leave_type_object'
 require 'xero-ruby/models/payroll_uk/leave_types'
+require 'xero-ruby/models/payroll_uk/ni_category'
+require 'xero-ruby/models/payroll_uk/ni_category_letter'
+require 'xero-ruby/models/payroll_uk/ni_category_one_of'
+require 'xero-ruby/models/payroll_uk/ni_category_one_of1'
 require 'xero-ruby/models/payroll_uk/pagination'
 require 'xero-ruby/models/payroll_uk/pay_run'
 require 'xero-ruby/models/payroll_uk/pay_run_calendar'
@@ -277,6 +275,14 @@ require 'xero-ruby/models/payroll_nz/timesheets'
 require 'xero-ruby/models/payroll_nz/tracking_categories'
 require 'xero-ruby/models/payroll_nz/tracking_category'
 require 'xero-ruby/models/payroll_nz/working_week'
+require 'xero-ruby/models/payroll_au_v2/invalid_field'
+require 'xero-ruby/models/payroll_au_v2/pagination'
+require 'xero-ruby/models/payroll_au_v2/problem'
+require 'xero-ruby/models/payroll_au_v2/timesheet'
+require 'xero-ruby/models/payroll_au_v2/timesheet_line'
+require 'xero-ruby/models/payroll_au_v2/timesheet_line_object'
+require 'xero-ruby/models/payroll_au_v2/timesheet_object'
+require 'xero-ruby/models/payroll_au_v2/timesheets'
 require 'xero-ruby/models/payroll_au/api_exception'
 require 'xero-ruby/models/payroll_au/account'
 require 'xero-ruby/models/payroll_au/account_type'
@@ -315,6 +321,7 @@ require 'xero-ruby/models/payroll_au/leave_period_status'
 require 'xero-ruby/models/payroll_au/leave_type'
 require 'xero-ruby/models/payroll_au/leave_type_contribution_type'
 require 'xero-ruby/models/payroll_au/manual_tax_type'
+require 'xero-ruby/models/payroll_au/opening_balance_leave_line'
 require 'xero-ruby/models/payroll_au/opening_balances'
 require 'xero-ruby/models/payroll_au/paid_leave_earnings_line'
 require 'xero-ruby/models/payroll_au/pay_item'
@@ -422,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'
@@ -537,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'
@@ -546,6 +557,7 @@ require 'xero-ruby/api/finance_api'
 require 'xero-ruby/api/app_store_api'
 require 'xero-ruby/api/payroll_uk_api'
 require 'xero-ruby/api/payroll_nz_api'
+require 'xero-ruby/api/payroll_au_v2_api'
 require 'xero-ruby/api/payroll_au_api'
 require 'xero-ruby/api/files_api'
 require 'xero-ruby/api/project_api'

data/spec/finance/api/finance_api_spec.rb

@@ -31,59 +31,6 @@ describe 'FinanceApi' do
     end
   end
 
-  # unit tests for get_accounting_activity_account_usage
-  # Get account usage
-  # A summary of how each account is being transacted on exposing the level of detail and amounts attributable to manual adjustments.
-  # @param xero_tenant_id Xero identifier for Tenant
-  # @param [Hash] opts the optional parameters
-  # @option opts [String] :start_month date, yyyy-MM                 If no parameter is provided, the month 12 months prior to the end month will be used.                Account usage for up to 12 months from this date will be returned.
-  # @option opts [String] :end_month date, yyyy-MM                 If no parameter is provided, the current month will be used.                Account usage for up to 12 months prior to this date will be returned.
-  # @return [AccountUsageResponse]
-  describe 'get_accounting_activity_account_usage test' do
-    it 'should work' do
-      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
-    end
-  end
-
-  # unit tests for get_accounting_activity_lock_history
-  # Get lock history
-  # Provides a history of locking of accounting books. Locking may be an indicator of good accounting practices that could reduce the risk of changes to accounting records in prior periods.
-  # @param xero_tenant_id Xero identifier for Tenant
-  # @param [Hash] opts the optional parameters
-  # @option opts [String] :end_date date, yyyy-MM-dd                 If no parameter is provided, the current date will be used.                Any changes to hard or soft lock dates that were made within the period up to 12 months before this date will be returned.                Please be aware that there may be a delay of up to 3 days before a change is visible from this API.
-  # @return [LockHistoryResponse]
-  describe 'get_accounting_activity_lock_history test' do
-    it 'should work' do
-      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
-    end
-  end
-
-  # unit tests for get_accounting_activity_report_history
-  # Get report history
-  # For a specified organisation, provides a summary of all the reports published within a given period, which may be an indicator for good business management and oversight.
-  # @param xero_tenant_id Xero identifier for Tenant
-  # @param [Hash] opts the optional parameters
-  # @option opts [String] :end_date date, yyyy-MM-dd                 If no parameter is provided, the current date will be used.                Any reports that were published within the period up to 12 months before this date will be returned.                Please be aware that there may be a delay of up to 3 days before a published report is visible from this API.
-  # @return [ReportHistoryResponse]
-  describe 'get_accounting_activity_report_history test' do
-    it 'should work' do
-      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
-    end
-  end
-
-  # unit tests for get_accounting_activity_user_activities
-  # Get user activities
-  # For a specified organisation, provides a list of all the users registered, and a history of their accounting transactions. Also identifies the existence of an external accounting advisor and the level of interaction.
-  # @param xero_tenant_id Xero identifier for Tenant
-  # @param [Hash] opts the optional parameters
-  # @option opts [String] :data_month date, yyyy-MM                 The specified month must be complete (in the past); The current month cannot be specified since it is not complete.                If no parameter is provided, the month immediately previous to the current month will be used.                Any user activities occurring within the specified month will be returned.                Please be aware that there may be a delay of up to 3 days before a user activity is visible from this API.
-  # @return [UserActivitiesResponse]
-  describe 'get_accounting_activity_user_activities test' do
-    it 'should work' do
-      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
-    end
-  end
-
   # unit tests for get_cash_validation
   # Get cash validation
   # Summarizes the total cash position for each account for an org