xero-ruby 3.12.0 → 3.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: eca22a65d6cd11bc3848d37259562279cb05874c8eb659acea215a5e72f3fb88
-  data.tar.gz: 13e577c274b99dd0ef74b33e648e821f8b5d9bdfe6c7550ffe4585ba282de3fa
+  metadata.gz: 64166b3675aaf064c236cd859fc18a4b51a6cadd80be862894bab7b556dfd7cf
+  data.tar.gz: cdebb07a417fb45d1e2b1afb372ef538f8833761cd5b5be5b5af4cecb743e2a9
 SHA512:
-  metadata.gz: 19a28bc6110af2ea9a80a5099b932bcd08109832d05e4938636c63c5bb6d45e5d63a7e8d4ec54a335b4283d43a887c87a5d9cf4acc63807c5558abee14a5bf87
-  data.tar.gz: 92d5d4b03239e8ca5739057d353ee7fb5f9b46d1f81d5a28ffb0824ebd34909c604ffb71fdb6387739ecd5af1b44fc54304a87a3d171c864cab1f3f0fcf1451a
+  metadata.gz: 1b58cddfacc52ba933664a360e62af2d3ed061c9f561d0dbd83ed4e49084009be76a0ec4532c3aa87d8b00dfac8cbf931849d66a0f47c1d2da637b31ecf07886
+  data.tar.gz: a408135c0687635c65bde9a5af6cbd4d587452e34541c85f8c6c20239a34613d4352ba6b7b68021d6fb56d3c4d81c205e7a67839a2388e4fccb2aaa106ba5740

data/lib/xero-ruby/api/accounting_api.rb

@@ -6886,6 +6886,81 @@ module XeroRuby
       return data, status_code, headers
     end
 
+    # Retrieves a specific batch payment using a unique batch payment Id
+    # @param xero_tenant_id [String] Xero identifier for Tenant
+    # @param batch_payment_id [String] Unique identifier for BatchPayment
+    # @param [Hash] opts the optional parameters
+    # @return [BatchPayments]
+    def get_batch_payment(xero_tenant_id, batch_payment_id, opts = {})
+      data, _status_code, _headers = get_batch_payment_with_http_info(xero_tenant_id, batch_payment_id, opts)
+      data
+    end
+
+    # Retrieves a specific batch payment using a unique batch payment Id
+    # @param xero_tenant_id [String] Xero identifier for Tenant
+    # @param batch_payment_id [String] Unique identifier for BatchPayment
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(BatchPayments, Integer, Hash)>] BatchPayments data, response status code and response headers
+    def get_batch_payment_with_http_info(xero_tenant_id, batch_payment_id, options = {})
+      opts = options.dup
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AccountingApi.get_batch_payment ...'
+      end
+      # verify the required parameter 'xero_tenant_id' is set
+      if @api_client.config.client_side_validation && xero_tenant_id.nil?
+        fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling AccountingApi.get_batch_payment"
+      end
+      # verify the required parameter 'batch_payment_id' is set
+      if @api_client.config.client_side_validation && batch_payment_id.nil?
+        fail ArgumentError, "Missing the required parameter 'batch_payment_id' when calling AccountingApi.get_batch_payment"
+      end
+      # resource path
+      local_var_path = '/BatchPayments/{BatchPaymentID}'.sub('{' + 'BatchPaymentID' + '}', batch_payment_id.to_s)
+
+      # camelize keys of incoming `where` opts
+      opts[:'where'] = @api_client.parameterize_where(opts[:'where']) if !opts[:'where'].nil?
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      
+      # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
+      query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
+      query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      header_params[:'xero-tenant-id'] = xero_tenant_id
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:body] 
+
+      # return_type
+      return_type = opts[:return_type] || 'BatchPayments' 
+
+      # auth_names
+      auth_names = opts[:auth_names] || ['OAuth2']
+
+      new_options = opts.merge(
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, "AccountingApi", new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: AccountingApi#get_batch_payment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Retrieves history from a specific batch payment
     # @param xero_tenant_id [String] Xero identifier for Tenant
     # @param batch_payment_id [String] Unique identifier for BatchPayment

data/lib/xero-ruby/api/project_api.rb

@@ -99,10 +99,10 @@ module XeroRuby
     # @param project_id [String] You can create a task on a specified projectId
     # @param task_create_or_update [TaskCreateOrUpdate] The task object you are creating
     # @param [Hash] opts the optional parameters
-    # @return [nil]
+    # @return [Task]
     def create_task(xero_tenant_id, project_id, task_create_or_update, opts = {})
-      create_task_with_http_info(xero_tenant_id, project_id, task_create_or_update, opts)
-      nil
+      data, _status_code, _headers = create_task_with_http_info(xero_tenant_id, project_id, task_create_or_update, opts)
+      data
     end
 
     # Allows you to create a task
@@ -111,7 +111,7 @@ module XeroRuby
     # @param project_id [String] You can create a task on a specified projectId
     # @param task_create_or_update [TaskCreateOrUpdate] The task object you are creating
     # @param [Hash] opts the optional parameters
-    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
+    # @return [Array<(Task, Integer, Hash)>] Task data, response status code and response headers
     def create_task_with_http_info(xero_tenant_id, project_id, task_create_or_update, options = {})
       opts = options.dup
       if @api_client.config.debugging
@@ -157,7 +157,7 @@ module XeroRuby
       post_body = opts[:body] || @api_client.object_to_http_body(task_create_or_update) 
 
       # return_type
-      return_type = opts[:return_type] 
+      return_type = opts[:return_type] || 'Task' 
 
       # auth_names
       auth_names = opts[:auth_names] || ['OAuth2']

data/lib/xero-ruby/api_client.rb

@@ -196,7 +196,12 @@ module XeroRuby
 
     def decode_jwt(tkn, verify=true)
       if verify == true
-        jwks_data = JSON.parse(Faraday.get('https://identity.xero.com/.well-known/openid-configuration/jwks').body)
+
+        response = Faraday.get('https://identity.xero.com/.well-known/openid-configuration/jwks') do |req|
+          req.headers['User-Agent'] = @user_agent
+        end
+
+        jwks_data = JSON.parse(response.body)
         jwk_set = JSON::JWK::Set.new(jwks_data)
         JSON::JWT.decode(tkn, jwk_set)
       else
@@ -230,6 +235,7 @@ module XeroRuby
       response = Faraday.post("#{@config.token_url}#{path}") do |req|
         req.headers['Authorization'] = "Basic " + Base64.strict_encode64("#{@client_id}:#{@client_secret}")
         req.headers['Content-Type'] = 'application/x-www-form-urlencoded'
+        req.headers['User-Agent'] = @user_agent
         req.body = URI.encode_www_form(data)
       end
       return_error(response) unless response.success?

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

@@ -51,7 +51,7 @@ module XeroRuby::Accounting
 
     attr_accessor :currency_code
     
-    # The tax type from TaxRates
+    # The tax type from taxRates
     attr_accessor :tax_type
     
     # Boolean – describes whether account can have payments applied to it

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

@@ -43,7 +43,7 @@ module XeroRuby::Accounting
     # Total tax on a journal line
     attr_accessor :tax_amount
     
-    # The tax type from TaxRates
+    # The tax type from taxRates
     attr_accessor :tax_type
     
     # see TaxRates

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

@@ -116,6 +116,13 @@ module XeroRuby::Accounting
     TXRCREINPUT ||= "TXRCREINPUT".freeze
     TXRCESSINPUT ||= "TXRCESSINPUT".freeze
     TXRCTSINPUT ||= "TXRCTSINPUT".freeze
+    CAPEXINPUT ||= "CAPEXINPUT".freeze
+    UNDEFINED ||= "UNDEFINED".freeze
+    CAPEXOUTPUT ||= "CAPEXOUTPUT".freeze
+    ZEROEXPOUTPUT ||= "ZEROEXPOUTPUT".freeze
+    GOODSIMPORT ||= "GOODSIMPORT".freeze
+    NONEINPUT ||= "NONEINPUT".freeze
+    NOTREPORTED ||= "NOTREPORTED".freeze
     
     # Boolean to describe if tax rate can be used for asset accounts i.e.  true,false
     attr_accessor :can_apply_to_assets
@@ -274,7 +281,7 @@ module XeroRuby::Accounting
     def valid?
       status_validator = EnumAttributeValidator.new('String', ["ACTIVE", "DELETED", "ARCHIVED", "PENDING"])
       return false unless status_validator.valid?(@status)
-      report_tax_type_validator = EnumAttributeValidator.new('String', ["AVALARA", "BASEXCLUDED", "CAPITALSALESOUTPUT", "CAPITALEXPENSESINPUT", "ECOUTPUT", "ECOUTPUTSERVICES", "ECINPUT", "ECACQUISITIONS", "EXEMPTEXPENSES", "EXEMPTINPUT", "EXEMPTOUTPUT", "GSTONIMPORTS", "INPUT", "INPUTTAXED", "MOSSSALES", "NONE", "NONEOUTPUT", "OUTPUT", "PURCHASESINPUT", "SALESOUTPUT", "EXEMPTCAPITAL", "EXEMPTEXPORT", "CAPITALEXINPUT", "GSTONCAPIMPORTS", "GSTONCAPITALIMPORTS", "REVERSECHARGES", "PAYMENTS", "INVOICE", "CASH", "ACCRUAL", "FLATRATECASH", "FLATRATEACCRUAL", "ACCRUALS", "TXCA", "SRCAS", "DSOUTPUT", "BLINPUT2", "EPINPUT", "IMINPUT2", "MEINPUT", "IGDSINPUT2", "ESN33OUTPUT", "OPINPUT", "OSOUTPUT", "TXN33INPUT", "TXESSINPUT", "TXREINPUT", "TXPETINPUT", "NRINPUT", "ES33OUTPUT", "ZERORATEDINPUT", "ZERORATEDOUTPUT", "DRCHARGESUPPLY", "DRCHARGE", "CAPINPUT", "CAPIMPORTS", "IMINPUT", "INPUT2", "CIUINPUT", "SRINPUT", "OUTPUT2", "SROUTPUT", "CAPOUTPUT", "SROUTPUT2", "CIUOUTPUT", "ZROUTPUT", "ZREXPORT", "ACC28PLUS", "ACCUPTO28", "OTHEROUTPUT", "SHOUTPUT", "ZRINPUT", "BADDEBT", "OTHERINPUT", "BADDEBTRELIEF", "IGDSINPUT3", "SROVR", "TOURISTREFUND", "TXRCN33INPUT", "TXRCREINPUT", "TXRCESSINPUT", "TXRCTSINPUT"])
+      report_tax_type_validator = EnumAttributeValidator.new('String', ["AVALARA", "BASEXCLUDED", "CAPITALSALESOUTPUT", "CAPITALEXPENSESINPUT", "ECOUTPUT", "ECOUTPUTSERVICES", "ECINPUT", "ECACQUISITIONS", "EXEMPTEXPENSES", "EXEMPTINPUT", "EXEMPTOUTPUT", "GSTONIMPORTS", "INPUT", "INPUTTAXED", "MOSSSALES", "NONE", "NONEOUTPUT", "OUTPUT", "PURCHASESINPUT", "SALESOUTPUT", "EXEMPTCAPITAL", "EXEMPTEXPORT", "CAPITALEXINPUT", "GSTONCAPIMPORTS", "GSTONCAPITALIMPORTS", "REVERSECHARGES", "PAYMENTS", "INVOICE", "CASH", "ACCRUAL", "FLATRATECASH", "FLATRATEACCRUAL", "ACCRUALS", "TXCA", "SRCAS", "DSOUTPUT", "BLINPUT2", "EPINPUT", "IMINPUT2", "MEINPUT", "IGDSINPUT2", "ESN33OUTPUT", "OPINPUT", "OSOUTPUT", "TXN33INPUT", "TXESSINPUT", "TXREINPUT", "TXPETINPUT", "NRINPUT", "ES33OUTPUT", "ZERORATEDINPUT", "ZERORATEDOUTPUT", "DRCHARGESUPPLY", "DRCHARGE", "CAPINPUT", "CAPIMPORTS", "IMINPUT", "INPUT2", "CIUINPUT", "SRINPUT", "OUTPUT2", "SROUTPUT", "CAPOUTPUT", "SROUTPUT2", "CIUOUTPUT", "ZROUTPUT", "ZREXPORT", "ACC28PLUS", "ACCUPTO28", "OTHEROUTPUT", "SHOUTPUT", "ZRINPUT", "BADDEBT", "OTHERINPUT", "BADDEBTRELIEF", "IGDSINPUT3", "SROVR", "TOURISTREFUND", "TXRCN33INPUT", "TXRCREINPUT", "TXRCESSINPUT", "TXRCTSINPUT", "CAPEXINPUT", "UNDEFINED", "CAPEXOUTPUT", "ZEROEXPOUTPUT", "GOODSIMPORT", "NONEINPUT", "NOTREPORTED"])
       return false unless report_tax_type_validator.valid?(@report_tax_type)
       true
     end
@@ -292,7 +299,7 @@ module XeroRuby::Accounting
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] report_tax_type Object to be assigned
     def report_tax_type=(report_tax_type)
-      validator = EnumAttributeValidator.new('String', ["AVALARA", "BASEXCLUDED", "CAPITALSALESOUTPUT", "CAPITALEXPENSESINPUT", "ECOUTPUT", "ECOUTPUTSERVICES", "ECINPUT", "ECACQUISITIONS", "EXEMPTEXPENSES", "EXEMPTINPUT", "EXEMPTOUTPUT", "GSTONIMPORTS", "INPUT", "INPUTTAXED", "MOSSSALES", "NONE", "NONEOUTPUT", "OUTPUT", "PURCHASESINPUT", "SALESOUTPUT", "EXEMPTCAPITAL", "EXEMPTEXPORT", "CAPITALEXINPUT", "GSTONCAPIMPORTS", "GSTONCAPITALIMPORTS", "REVERSECHARGES", "PAYMENTS", "INVOICE", "CASH", "ACCRUAL", "FLATRATECASH", "FLATRATEACCRUAL", "ACCRUALS", "TXCA", "SRCAS", "DSOUTPUT", "BLINPUT2", "EPINPUT", "IMINPUT2", "MEINPUT", "IGDSINPUT2", "ESN33OUTPUT", "OPINPUT", "OSOUTPUT", "TXN33INPUT", "TXESSINPUT", "TXREINPUT", "TXPETINPUT", "NRINPUT", "ES33OUTPUT", "ZERORATEDINPUT", "ZERORATEDOUTPUT", "DRCHARGESUPPLY", "DRCHARGE", "CAPINPUT", "CAPIMPORTS", "IMINPUT", "INPUT2", "CIUINPUT", "SRINPUT", "OUTPUT2", "SROUTPUT", "CAPOUTPUT", "SROUTPUT2", "CIUOUTPUT", "ZROUTPUT", "ZREXPORT", "ACC28PLUS", "ACCUPTO28", "OTHEROUTPUT", "SHOUTPUT", "ZRINPUT", "BADDEBT", "OTHERINPUT", "BADDEBTRELIEF", "IGDSINPUT3", "SROVR", "TOURISTREFUND", "TXRCN33INPUT", "TXRCREINPUT", "TXRCESSINPUT", "TXRCTSINPUT"])
+      validator = EnumAttributeValidator.new('String', ["AVALARA", "BASEXCLUDED", "CAPITALSALESOUTPUT", "CAPITALEXPENSESINPUT", "ECOUTPUT", "ECOUTPUTSERVICES", "ECINPUT", "ECACQUISITIONS", "EXEMPTEXPENSES", "EXEMPTINPUT", "EXEMPTOUTPUT", "GSTONIMPORTS", "INPUT", "INPUTTAXED", "MOSSSALES", "NONE", "NONEOUTPUT", "OUTPUT", "PURCHASESINPUT", "SALESOUTPUT", "EXEMPTCAPITAL", "EXEMPTEXPORT", "CAPITALEXINPUT", "GSTONCAPIMPORTS", "GSTONCAPITALIMPORTS", "REVERSECHARGES", "PAYMENTS", "INVOICE", "CASH", "ACCRUAL", "FLATRATECASH", "FLATRATEACCRUAL", "ACCRUALS", "TXCA", "SRCAS", "DSOUTPUT", "BLINPUT2", "EPINPUT", "IMINPUT2", "MEINPUT", "IGDSINPUT2", "ESN33OUTPUT", "OPINPUT", "OSOUTPUT", "TXN33INPUT", "TXESSINPUT", "TXREINPUT", "TXPETINPUT", "NRINPUT", "ES33OUTPUT", "ZERORATEDINPUT", "ZERORATEDOUTPUT", "DRCHARGESUPPLY", "DRCHARGE", "CAPINPUT", "CAPIMPORTS", "IMINPUT", "INPUT2", "CIUINPUT", "SRINPUT", "OUTPUT2", "SROUTPUT", "CAPOUTPUT", "SROUTPUT2", "CIUOUTPUT", "ZROUTPUT", "ZREXPORT", "ACC28PLUS", "ACCUPTO28", "OTHEROUTPUT", "SHOUTPUT", "ZRINPUT", "BADDEBT", "OTHERINPUT", "BADDEBTRELIEF", "IGDSINPUT3", "SROVR", "TOURISTREFUND", "TXRCN33INPUT", "TXRCREINPUT", "TXRCESSINPUT", "TXRCTSINPUT", "CAPEXINPUT", "UNDEFINED", "CAPEXOUTPUT", "ZEROEXPOUTPUT", "GOODSIMPORT", "NONEINPUT", "NOTREPORTED"])
       unless validator.valid?(report_tax_type)
         fail ArgumentError, "invalid value for \"report_tax_type\", must be one of #{validator.allowable_values}."
       end

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

@@ -16,7 +16,7 @@ module XeroRuby::PayrollAu
   class LeaveCategoryCode
     ANNUALLEAVE ||= "ANNUALLEAVE".freeze
     LONGSERVICELEAVE ||= "LONGSERVICELEAVE".freeze
-    PERSONALCARERSLEAVE ||= "PERSONALCARERSLEAVE".freeze
+    PERSONALSICKCARERSLEAVE ||= "PERSONALSICKCARERSLEAVE".freeze
     ROSTEREDDAYOFF ||= "ROSTEREDDAYOFF".freeze
     TIMEOFFINLIEU ||= "TIMEOFFINLIEU".freeze
     COMPASSIONATEANDBEREAVEMENTLEAVE ||= "COMPASSIONATEANDBEREAVEMENTLEAVE".freeze

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: 2.27.0
+The version of the XeroOpenAPI document: 2.29.3
 =end
 
 module XeroRuby
-  VERSION = '3.12.0'
+  VERSION = '3.13.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: xero-ruby
 version: !ruby/object:Gem::Version
-  version: 3.12.0
+  version: 3.13.0
 platform: ruby
 authors:
 - Xero API Team
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-08-30 00:00:00.000000000 Z
+date: 2022-09-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -1095,7 +1095,7 @@ homepage: https://developer.xero.com
 licenses:
 - Unlicense
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -1111,7 +1111,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.1.6
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Xero Accounting API Ruby Gem
 test_files: