xero-ruby 2.2.4 → 2.5.0

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

@@ -3,15 +3,13 @@
 
 #This is the Xero Projects API
 
-The version of the OpenAPI document: 2.3.2
+The version of the OpenAPI document: 2.8.0
 Contact: api@xero.com
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 4.3.1
 
 =end
 
-require 'cgi'
-
 module XeroRuby
   class ProjectApi
     attr_accessor :api_client
@@ -88,7 +86,7 @@ module XeroRuby
         :return_type => return_type
       )
 
-      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path, "ProjectApi", new_options)
       if @api_client.config.debugging
         @api_client.config.logger.debug "API called: ProjectApi#create_project\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
@@ -172,7 +170,7 @@ module XeroRuby
         :return_type => return_type
       )
 
-      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path, "ProjectApi", new_options)
       if @api_client.config.debugging
         @api_client.config.logger.debug "API called: ProjectApi#create_time_entry\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
@@ -252,7 +250,7 @@ module XeroRuby
         :return_type => return_type
       )
 
-      data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
+      data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, "ProjectApi", new_options)
       if @api_client.config.debugging
         @api_client.config.logger.debug "API called: ProjectApi#delete_time_entry\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
@@ -328,7 +326,7 @@ module XeroRuby
         :return_type => return_type
       )
 
-      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, "ProjectApi", new_options)
       if @api_client.config.debugging
         @api_client.config.logger.debug "API called: ProjectApi#get_project\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
@@ -412,7 +410,7 @@ module XeroRuby
         :return_type => return_type
       )
 
-      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, "ProjectApi", new_options)
       if @api_client.config.debugging
         @api_client.config.logger.debug "API called: ProjectApi#get_project_users\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
@@ -505,7 +503,7 @@ module XeroRuby
         :return_type => return_type
       )
 
-      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, "ProjectApi", new_options)
       if @api_client.config.debugging
         @api_client.config.logger.debug "API called: ProjectApi#get_projects\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
@@ -587,7 +585,7 @@ module XeroRuby
         :return_type => return_type
       )
 
-      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, "ProjectApi", new_options)
       if @api_client.config.debugging
         @api_client.config.logger.debug "API called: ProjectApi#get_task\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
@@ -602,6 +600,7 @@ module XeroRuby
     # @option opts [Integer] :page Set to 1 by default. The requested number of the page in paged response - Must be a number greater than 0.
     # @option opts [Integer] :page_size Optional, it is set to 50 by default. The number of items to return per page in a paged response - Must be a number between 1 and 500.
     # @option opts [String] :task_ids taskIdsSearch for all tasks that match a comma separated list of taskIds, i.e. GET https://.../tasks?taskIds={taskId},{taskId}
+    # @option opts [ChargeType] :charge_type 
     # @return [Tasks]
     def get_tasks(xero_tenant_id, project_id, opts = {})
       data, _status_code, _headers = get_tasks_with_http_info(xero_tenant_id, project_id, opts)
@@ -616,6 +615,7 @@ module XeroRuby
     # @option opts [Integer] :page Set to 1 by default. The requested number of the page in paged response - Must be a number greater than 0.
     # @option opts [Integer] :page_size Optional, it is set to 50 by default. The number of items to return per page in a paged response - Must be a number between 1 and 500.
     # @option opts [String] :task_ids taskIdsSearch for all tasks that match a comma separated list of taskIds, i.e. GET https://.../tasks?taskIds={taskId},{taskId}
+    # @option opts [ChargeType] :charge_type 
     # @return [Array<(Tasks, Integer, Hash)>] Tasks data, response status code and response headers
     def get_tasks_with_http_info(xero_tenant_id, project_id, opts = {})
       if @api_client.config.debugging
@@ -640,6 +640,7 @@ module XeroRuby
       query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
       query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].nil?
       query_params[:'taskIds'] = opts[:'task_ids'] if !opts[:'task_ids'].nil?
+      query_params[:'chargeType'] = opts[:'charge_type'] if !opts[:'charge_type'].nil?
       
       # 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?
@@ -672,7 +673,7 @@ module XeroRuby
         :return_type => return_type
       )
 
-      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, "ProjectApi", new_options)
       if @api_client.config.debugging
         @api_client.config.logger.debug "API called: ProjectApi#get_tasks\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
@@ -778,7 +779,7 @@ module XeroRuby
         :return_type => return_type
       )
 
-      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, "ProjectApi", new_options)
       if @api_client.config.debugging
         @api_client.config.logger.debug "API called: ProjectApi#get_time_entries\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
@@ -860,7 +861,7 @@ module XeroRuby
         :return_type => return_type
       )
 
-      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, "ProjectApi", new_options)
       if @api_client.config.debugging
         @api_client.config.logger.debug "API called: ProjectApi#get_time_entry\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
@@ -944,7 +945,7 @@ module XeroRuby
         :return_type => return_type
       )
 
-      data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
+      data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, "ProjectApi", new_options)
       if @api_client.config.debugging
         @api_client.config.logger.debug "API called: ProjectApi#patch_project\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
@@ -1028,7 +1029,7 @@ module XeroRuby
         :return_type => return_type
       )
 
-      data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
+      data, status_code, headers = @api_client.call_api(:PUT, local_var_path, "ProjectApi", new_options)
       if @api_client.config.debugging
         @api_client.config.logger.debug "API called: ProjectApi#update_project\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
@@ -1116,7 +1117,7 @@ module XeroRuby
         :return_type => return_type
       )
 
-      data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
+      data, status_code, headers = @api_client.call_api(:PUT, local_var_path, "ProjectApi", new_options)
       if @api_client.config.debugging
         @api_client.config.logger.debug "API called: ProjectApi#update_time_entry\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end

data/lib/xero-ruby/api_client.rb

@@ -3,7 +3,7 @@
 
 #No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
 
-The version of the OpenAPI document: 2.3.2
+The version of the OpenAPI document: 2.8.0
 Contact: api@xero.com
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 4.3.1
@@ -62,6 +62,26 @@ module XeroRuby
       XeroRuby::ProjectApi.new(self)
     end
 
+    def files_api
+      @config.base_url = @config.files_url
+      XeroRuby::FilesApi.new(self)
+    end
+
+    def payroll_au_api
+      @config.base_url = @config.payroll_au_url
+      XeroRuby::PayrollAuApi.new(self)
+    end
+
+    def payroll_nz_api
+      @config.base_url = @config.payroll_nz_url
+      XeroRuby::PayrollNzApi.new(self)
+    end
+    
+    def payroll_uk_api
+      @config.base_url = @config.payroll_uk_url
+      XeroRuby::PayrollUkApi.new(self)
+    end
+
     # Token Helpers
     def token_set
       XeroRuby.configure.token_set
@@ -105,6 +125,7 @@ module XeroRuby
         req.headers['Content-Type'] = 'application/x-www-form-urlencoded'
         req.body = URI.encode_www_form(data)
       end
+      return_error(response) unless response.success?
       body = JSON.parse(response.body)
       set_token_set(body)
       return body
@@ -112,27 +133,22 @@ module XeroRuby
 
     # Connection heplers
     def connections
-      response = Faraday.get('https://api.xero.com/connections') do |req|
-        req.headers['Authorization'] = "Bearer #{access_token}" 
-        req.headers['Content-Type'] = 'application/json'
-      end
-      body = JSON.parse(response.body)
-      return body
+      opts = { :header_params => {'Content-Type': 'application/json'}, :auth_names => ['OAuth2'] }
+      response = call_api(:GET, 'https://api.xero.com/connections/', nil, opts)
+      response[0]
     end
 
     def disconnect(connection_id)
-      Faraday.delete("https://api.xero.com/connections/#{connection_id}") do |req|
-        req.headers['Authorization'] = "Bearer #{access_token}"
-        req.headers['Content-Type'] = 'application/json'
-      end
-      return connections
+      opts = { :header_params => {'Content-Type': 'application/json'}, :auth_names => ['OAuth2'] }
+      call_api(:DELETE, "https://api.xero.com/connections/#{connection_id}", nil, opts)
+      connections
     end
 
     # Call an API with given options.
     #
     # @return [Array<(Object, Integer, Hash)>] an array of 3 elements:
     #   the data deserialized from response body (could be nil), response status code and response headers.
-    def call_api(http_method, path, opts = {})
+    def call_api(http_method, path, api_client, opts = {})
       ssl_options = {
         :ca_file => @config.ssl_ca_file,
         :verify => @config.ssl_verify,
@@ -159,31 +175,35 @@ module XeroRuby
           @config.logger.debug "HTTP response body ~BEGIN~\n#{response.body}\n~END~\n"
         end
 
-        unless response.success?
-          if response.status == 0
-            # Errors from libcurl will be made visible here
-            fail ApiError.new(:code => 0,
-                              :message => response.return_message)
-          else
-            fail ApiError.new(:code => response.status,
-                              :response_headers => response.headers,
-                              :response_body => response.body),
-                 response.reason_phrase
-          end
-        end
+        return_error(response) unless response.success?
       rescue Faraday::TimeoutError
         fail ApiError.new('Connection timed out')
       end
 
       if opts[:return_type]
         prepare_file(response) if opts[:return_type] == 'File'
-        data = deserialize(response, opts[:return_type])
+        data = deserialize(response, opts[:return_type], api_client)
+      elsif !response.body.empty?
+        data = JSON.parse(response.body)
       else
         data = nil
       end
       return data, response.status, response.headers
     end
 
+    def return_error(response)
+      if response.status == 0
+        # Errors from libcurl will be made visible here
+        fail ApiError.new(:code => 0,
+                          :message => response.return_message)
+      else
+        fail ApiError.new(:code => response.status,
+                          :response_headers => response.headers,
+                          :response_body => response.body),
+              response.reason_phrase
+      end
+    end
+
     # Builds the HTTP request
     #
     # @param [String] http_method HTTP method/verb (e.g. POST)
@@ -241,8 +261,7 @@ module XeroRuby
         form_params.each do |key, value|
           case value
           when ::File, ::Tempfile
-            # TODO hardcode to application/octet-stream, need better way to detect content type
-            data[key] = Faraday::UploadIO.new(value.path, 'application/octet-stream', value.path)
+            data[form_params["name"]] = Faraday::UploadIO.new(value.path, form_params["mimeType"], value.path)
           when ::Array, nil
             # let Faraday handle Array and nil parameters
             data[key] = value
@@ -274,7 +293,7 @@ module XeroRuby
     #
     # @param [Response] response HTTP response
     # @param [String] return_type some examples: "User", "Array<User>", "Hash<String, Integer>"
-    def deserialize(response, return_type)
+    def deserialize(response, return_type, api_client)
       body = response.body
 
       # handle file downloading - return the File instance processed in request callbacks
@@ -301,14 +320,14 @@ module XeroRuby
         end
       end 
 
-      convert_to_type(data, return_type)
+      convert_to_type(data, return_type, api_client)
     end
 
     # Convert data to the given return type.
     # @param [Object] data Data to be converted
     # @param [String] return_type Return type
     # @return [Mixed] Data in a particular type
-    def convert_to_type(data, return_type)
+    def convert_to_type(data, return_type, api_client)
       return nil if data.nil?
       case return_type
       when 'String'
@@ -331,44 +350,35 @@ module XeroRuby
       when /\AArray<(.+)>\z/
         # e.g. Array<Pet>
         sub_type = $1
-        data.map { |item| convert_to_type(item, sub_type) }
+        data.map { |item| convert_to_type(item, sub_type, api_client) }
       when /\AHash\<String, (.+)\>\z/
         # e.g. Hash<String, Integer>
         sub_type = $1
         {}.tap do |hash|
-          data.each { |k, v| hash[k] = convert_to_type(v, sub_type) }
+          data.each { |k, v| hash[k] = convert_to_type(v, sub_type, api_client) }
         end
       else
-        api_set = api_set_prefix(return_type)
-        case api_set
-        when 'accounting'
+        case api_client
+        when 'AccountingApi'
           XeroRuby::Accounting.const_get(return_type).build_from_hash(data)
-        when 'assets'
+        when 'AssetApi'
           XeroRuby::Assets.const_get(return_type).build_from_hash(data)
-        when 'projects'
+        when 'ProjectApi'
           XeroRuby::Projects.const_get(return_type).build_from_hash(data)
-        # when 'newapiset' # add new namespace
-          # XeroRuby::<NewAPISet>.const_get(return_type).build_from_hash(data)
+        when 'FilesApi'
+          XeroRuby::Files.const_get(return_type).build_from_hash(data)
+        when 'PayrollAuApi'
+          XeroRuby::PayrollAu.const_get(return_type).build_from_hash(data)
+        when 'PayrollNzApi'
+          XeroRuby::PayrollNz.const_get(return_type).build_from_hash(data)
+        when 'PayrollUkApi'
+          XeroRuby::PayrollUk.const_get(return_type).build_from_hash(data)
         else
           XeroRuby::Accounting.const_get(return_type).build_from_hash(data)
         end
       end
     end
 
-    # Traverses the model tree to find the model's namespacing
-    # based on the deserializing model/return_type name
-    def api_set_prefix(return_type)
-      api_set = ''
-      Find.find("#{File.dirname(__FILE__)}/models/") do |path|
-        model_path = path.split('/')
-        matching_name = model_path.last.gsub('.rb','').gsub("_",'')
-        if return_type.downcase === matching_name
-          api_set = path.split('/')[-2]
-        end
-      end
-      return api_set
-    end
-
     # Save response body into a file in (the defined) temporary folder, using the filename
     # from the "Content-Disposition" header if provided, otherwise a random filename.
     # The response body is written to the file in chunks in order to handle files which
@@ -406,9 +416,13 @@ module XeroRuby
     end
 
     def build_request_url(path)
-      # Add leading and trailing slashes to path
-      path = "/#{path}".gsub(/\/+/, '/')
-      @config.base_url + path
+      if @config.base_url
+        # Add leading and trailing slashes to path
+        path = "/#{path}".gsub(/\/+/, '/')
+        @config.base_url + path
+      else
+        path
+      end
     end
 
     # Update hearder and query params based on authentication settings.

data/lib/xero-ruby/api_error.rb

@@ -3,7 +3,7 @@
 
 #No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
 
-The version of the OpenAPI document: 2.3.2
+The version of the OpenAPI document: 2.8.0
 Contact: api@xero.com
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 4.3.1
@@ -21,8 +21,8 @@ module XeroRuby
     #   ApiError.new(:code => 404, :message => "Not Found")
     def initialize(arg = nil)
       if arg.is_a? Hash
-        if arg.key?(:message) || arg.key?('message')
-          super(arg[:message] || arg['message'])
+        if arg.key?(:message) || arg.key?('message') || arg.key?(:Message) || arg.key?('Message')
+          super(arg[:message] || arg['message'] || arg.key?(:Message) || arg.key?('Message'))
         else
           super arg
         end
@@ -31,6 +31,7 @@ module XeroRuby
           instance_variable_set "@#{k}", v
         end
       else
+        @message = arg
         super arg
       end
     end

data/lib/xero-ruby/configuration.rb

@@ -3,7 +3,7 @@
 
 #No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
 
-The version of the OpenAPI document: 2.3.2
+The version of the OpenAPI document: 2.8.0
 Contact: api@xero.com
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 4.3.1
@@ -30,6 +30,10 @@ module XeroRuby
     attr_accessor :accounting_url
     attr_accessor :asset_url
     attr_accessor :project_url
+    attr_accessor :files_url
+    attr_accessor :payroll_au_url
+    attr_accessor :payroll_nz_url
+    attr_accessor :payroll_uk_url
 
     # Defines API keys used with API Key authentications.
     #
@@ -139,6 +143,10 @@ module XeroRuby
       @accounting_url = 'https://api.xero.com/api.xro/2.0'
       @asset_url = 'https://api.xero.com/assets.xro/1.0'
       @project_url = 'https://api.xero.com/projects.xro/2.0/'
+      @files_url = 'https://api.xero.com/files.xro/1.0/'
+      @payroll_au_url = 'https://api.xero.com/payroll.xro/1.0/'
+      @payroll_nz_url = 'https://api.xero.com/payroll.xro/2.0/'
+      @payroll_uk_url = 'https://api.xero.com/payroll.xro/2.0/'
       @api_key = {}
       @api_key_prefix = {}
       @timeout = 0

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

@@ -3,7 +3,7 @@
 
 #No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
 
-The version of the OpenAPI document: 2.3.2
+The version of the OpenAPI document: 2.8.0
 Contact: api@xero.com
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 4.3.1
@@ -91,6 +91,7 @@ module XeroRuby::Accounting
     CISLABOURINCOME = "CISLABOURINCOME".freeze
     CISLIABILITY = "CISLIABILITY".freeze
     CISMATERIALS = "CISMATERIALS".freeze
+    # duplicate definitions generated: https://github.com/XeroAPI/xero-ruby/issues/53#issuecomment-668893305
     # EMPTY = "".freeze
     
     # Shown if set