xero-ruby 3.8.0 → 3.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 64ea98826b9c024df40c0e3db6390722313e610c19b74a32f9200aa032fa8de9
-  data.tar.gz: 2b8d8f8fe9bd8909d3ea64f814763787752313ef3b224218f4e373af5bf13a7d
+  metadata.gz: 9da0e17f450205612e5090cdb258485529efa412eadc1ead5c564050d68b51d9
+  data.tar.gz: f06c54f4fd72e7dd1281a6960beb82969899d9015f2e14cf737018596199cb73
 SHA512:
-  metadata.gz: acf352b5dc0ab2bc6fe5de48b1ad0fdac7e90ecf1828f9a1184d93b4663f4a5c67b32085430471c4264fbbea98e2015ef30414da5324b5b522df84dde10ed5bc
-  data.tar.gz: b41a5a3cfd6cd0086991173efc0430c8b5d53e9776f0636400b1d53411f006e722b8f0c2bf903b3a4f0f487a3583fbdfe0d9d79cbeb18f387d18cefac64ddc69
+  metadata.gz: 602762907bb324d2a7f308418f3789602e077d32621b5329e3d4a83154524b0981b1876f99a655cb978b40514cfcc63fd63509e5117af567c097c4affd38655e
+  data.tar.gz: fbaddb461ba6b3db40c906e6195012b591e076ee2dc7248d4501621e4fa5dbb3c9cefa134317a4f76d3218d909ce7a302bdcaa9449fd970cc7d43d98356c08a8

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

@@ -9952,6 +9952,81 @@ module XeroRuby
       return data, status_code, headers
     end
 
+    # Retrieves a specific journal using a unique journal number.
+    # @param xero_tenant_id [String] Xero identifier for Tenant
+    # @param journal_number [Integer] Number of a Journal
+    # @param [Hash] opts the optional parameters
+    # @return [Journals]
+    def get_journal_by_number(xero_tenant_id, journal_number, opts = {})
+      data, _status_code, _headers = get_journal_by_number_with_http_info(xero_tenant_id, journal_number, opts)
+      data
+    end
+
+    # Retrieves a specific journal using a unique journal number.
+    # @param xero_tenant_id [String] Xero identifier for Tenant
+    # @param journal_number [Integer] Number of a Journal
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Journals, Integer, Hash)>] Journals data, response status code and response headers
+    def get_journal_by_number_with_http_info(xero_tenant_id, journal_number, options = {})
+      opts = options.dup
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AccountingApi.get_journal_by_number ...'
+      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_journal_by_number"
+      end
+      # verify the required parameter 'journal_number' is set
+      if @api_client.config.client_side_validation && journal_number.nil?
+        fail ArgumentError, "Missing the required parameter 'journal_number' when calling AccountingApi.get_journal_by_number"
+      end
+      # resource path
+      local_var_path = '/Journals/{JournalNumber}'.sub('{' + 'JournalNumber' + '}', journal_number.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] || 'Journals' 
+
+      # 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_journal_by_number\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Retrieves journals
     # @param xero_tenant_id [String] Xero identifier for Tenant
     # @param [Hash] opts the optional parameters

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

@@ -166,6 +166,7 @@ module XeroRuby::Accounting
     LEDGER ||= "LEDGER".freeze
     GST_CASHBOOK ||= "GST_CASHBOOK".freeze
     NON_GST_CASHBOOK ||= "NON_GST_CASHBOOK".freeze
+    ULTIMATE ||= "ULTIMATE".freeze
     
     # BUSINESS or PARTNER. Partner edition organisations are sold exclusively through accounting partners and have restricted functionality (e.g. no access to invoicing)
     attr_accessor :edition
@@ -461,7 +462,7 @@ module XeroRuby::Accounting
       return false unless sales_tax_period_validator.valid?(@sales_tax_period)
       organisation_entity_type_validator = EnumAttributeValidator.new('String', ["ACCOUNTING_PRACTICE", "COMPANY", "CHARITY", "CLUB_OR_SOCIETY", "INDIVIDUAL", "LOOK_THROUGH_COMPANY", "NOT_FOR_PROFIT", "PARTNERSHIP", "S_CORPORATION", "SELF_MANAGED_SUPERANNUATION_FUND", "SOLE_TRADER", "SUPERANNUATION_FUND", "TRUST"])
       return false unless organisation_entity_type_validator.valid?(@organisation_entity_type)
-      _class_validator = EnumAttributeValidator.new('String', ["DEMO", "TRIAL", "STARTER", "STANDARD", "PREMIUM", "PREMIUM_20", "PREMIUM_50", "PREMIUM_100", "LEDGER", "GST_CASHBOOK", "NON_GST_CASHBOOK"])
+      _class_validator = EnumAttributeValidator.new('String', ["DEMO", "TRIAL", "STARTER", "STANDARD", "PREMIUM", "PREMIUM_20", "PREMIUM_50", "PREMIUM_100", "LEDGER", "GST_CASHBOOK", "NON_GST_CASHBOOK", "ULTIMATE"])
       return false unless _class_validator.valid?(@_class)
       edition_validator = EnumAttributeValidator.new('String', ["BUSINESS", "PARTNER"])
       return false unless edition_validator.valid?(@edition)
@@ -521,7 +522,7 @@ module XeroRuby::Accounting
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] _class Object to be assigned
     def _class=(_class)
-      validator = EnumAttributeValidator.new('String', ["DEMO", "TRIAL", "STARTER", "STANDARD", "PREMIUM", "PREMIUM_20", "PREMIUM_50", "PREMIUM_100", "LEDGER", "GST_CASHBOOK", "NON_GST_CASHBOOK"])
+      validator = EnumAttributeValidator.new('String', ["DEMO", "TRIAL", "STARTER", "STANDARD", "PREMIUM", "PREMIUM_20", "PREMIUM_50", "PREMIUM_100", "LEDGER", "GST_CASHBOOK", "NON_GST_CASHBOOK", "ULTIMATE"])
       unless validator.valid?(_class)
         fail ArgumentError, "invalid value for \"_class\", must be one of #{validator.allowable_values}."
       end

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

@@ -108,6 +108,13 @@ module XeroRuby::Accounting
     ZRINPUT ||= "ZRINPUT".freeze
     BADDEBT ||= "BADDEBT".freeze
     OTHERINPUT ||= "OTHERINPUT".freeze
+    BADDEBTRELIEF ||= "BADDEBTRELIEF".freeze
+    IGDSINPUT3 ||= "IGDSINPUT3".freeze
+    SROVR ||= "SROVR".freeze
+    TOURISTREFUND ||= "TOURISTREFUND".freeze
+    TXRCN33_INPUT ||= "TXRCN33INPUT".freeze
+    TXRCREINPUT ||= "TXRCREINPUT".freeze
+    TXRCESSINPUT ||= "TXRCESSINPUT".freeze
     
     # Boolean to describe if tax rate can be used for asset accounts i.e.  true,false
     attr_accessor :can_apply_to_assets
@@ -266,7 +273,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"])
+      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"])
       return false unless report_tax_type_validator.valid?(@report_tax_type)
       true
     end
@@ -284,7 +291,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"])
+      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"])
       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/accounting/tax_type.rb

@@ -73,6 +73,13 @@ module XeroRuby::Accounting
     DRCHARGE20 ||= "DRCHARGE20".freeze
     DRCHARGESUPPLY5 ||= "DRCHARGESUPPLY5".freeze
     DRCHARGE5 ||= "DRCHARGE5".freeze
+    BADDEBTRELIEF ||= "BADDEBTRELIEF".freeze
+    IGDSINPUT3 ||= "IGDSINPUT3".freeze
+    SROVR ||= "SROVR".freeze
+    TOURISTREFUND ||= "TOURISTREFUND".freeze
+    TXRCN33_INPUT ||= "TXRCN33INPUT".freeze
+    TXRCREINPUT ||= "TXRCREINPUT".freeze
+    TXRCESSINPUT ||= "TXRCESSINPUT".freeze
 
     # Builds the enum from string
     # @param [String] The enum value in the form of the string

data/lib/xero-ruby/models/finance/statement_response.rb

@@ -28,9 +28,15 @@ module XeroRuby::Finance
     # Utc date time of when the statement was imported in Xero
     attr_accessor :imported_date_time_utc
     
-    # Import source of statement (STMTIMPORTSRC/MANUAL, STMTIMPORTSRC/CSV, STMTIMPORTSRC/QIF, STMTIMPORTSRC/OFX, XeroApi)
+    # Indicates the source of the statement data. Either imported from 1) direct bank feed OR 2) manual customer entry or upload. Manual import sources are STMTIMPORTSRC/MANUAL, STMTIMPORTSRC/CSV, STMTIMPORTSRC/OFX, Ofx or STMTIMPORTSRC/QIF. All other import sources are direct and, depending on the direct solution, may contain the name of the financial institution.
     attr_accessor :import_source
     
+    # Opening balance sourced from imported bank statements (if supplied). Note, for manually uploaded statements, this balance is also manual and usually not supplied.
+    attr_accessor :start_balance
+    
+    # Closing balance sourced from imported bank statements (if supplied). Note, for manually uploaded statements, this balance is also manual and usually not supplied.
+    attr_accessor :end_balance
+    
     # List of statement lines
     attr_accessor :statement_lines
     
@@ -42,6 +48,8 @@ module XeroRuby::Finance
         :'end_date' => :'endDate',
         :'imported_date_time_utc' => :'importedDateTimeUtc',
         :'import_source' => :'importSource',
+        :'start_balance' => :'startBalance',
+        :'end_balance' => :'endBalance',
         :'statement_lines' => :'statementLines'
       }
     end
@@ -54,6 +62,8 @@ module XeroRuby::Finance
         :'end_date' => :'Date',
         :'imported_date_time_utc' => :'DateTime',
         :'import_source' => :'String',
+        :'start_balance' => :'BigDecimal',
+        :'end_balance' => :'BigDecimal',
         :'statement_lines' => :'Array<StatementLineResponse>'
       }
     end
@@ -93,6 +103,14 @@ module XeroRuby::Finance
         self.import_source = attributes[:'import_source']
       end
 
+      if attributes.key?(:'start_balance')
+        self.start_balance = attributes[:'start_balance']
+      end
+
+      if attributes.key?(:'end_balance')
+        self.end_balance = attributes[:'end_balance']
+      end
+
       if attributes.key?(:'statement_lines')
         if (value = attributes[:'statement_lines']).is_a?(Array)
           self.statement_lines = value
@@ -123,6 +141,8 @@ module XeroRuby::Finance
           end_date == o.end_date &&
           imported_date_time_utc == o.imported_date_time_utc &&
           import_source == o.import_source &&
+          start_balance == o.start_balance &&
+          end_balance == o.end_balance &&
           statement_lines == o.statement_lines
     end
 
@@ -135,7 +155,7 @@ module XeroRuby::Finance
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [statement_id, start_date, end_date, imported_date_time_utc, import_source, statement_lines].hash
+      [statement_id, start_date, end_date, imported_date_time_utc, import_source, start_balance, end_balance, statement_lines].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: 2.21.0
+The version of the XeroOpenAPI document: 2.22.4
 =end
 
 module XeroRuby
-  VERSION = '3.8.0'
+  VERSION = '3.9.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: xero-ruby
 version: !ruby/object:Gem::Version
-  version: 3.8.0
+  version: 3.9.0
 platform: ruby
 authors:
 - Xero API Team
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-04-14 00:00:00.000000000 Z
+date: 2022-05-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday