xero-ruby 2.7.1 → 2.9.1

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

@@ -31,7 +31,8 @@ module XeroRuby
     # @param project_create_or_update [ProjectCreateOrUpdate] Create a new project with ProjectCreateOrUpdate object
     # @param [Hash] opts the optional parameters
     # @return [Array<(Project, Integer, Hash)>] Project data, response status code and response headers
-    def create_project_with_http_info(xero_tenant_id, project_create_or_update, opts = {})
+    def create_project_with_http_info(xero_tenant_id, project_create_or_update, options = {})
+      opts = options.dup
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: ProjectApi.create_project ...'
       end
@@ -111,7 +112,8 @@ module XeroRuby
     # @param time_entry_create_or_update [TimeEntryCreateOrUpdate] The time entry object you are creating
     # @param [Hash] opts the optional parameters
     # @return [Array<(TimeEntry, Integer, Hash)>] TimeEntry data, response status code and response headers
-    def create_time_entry_with_http_info(xero_tenant_id, project_id, time_entry_create_or_update, opts = {})
+    def create_time_entry_with_http_info(xero_tenant_id, project_id, time_entry_create_or_update, options = {})
+      opts = options.dup
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: ProjectApi.create_time_entry ...'
       end
@@ -195,7 +197,8 @@ module XeroRuby
     # @param time_entry_id [String] You can specify an individual task by appending the id to the endpoint
     # @param [Hash] opts the optional parameters
     # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
-    def delete_time_entry_with_http_info(xero_tenant_id, project_id, time_entry_id, opts = {})
+    def delete_time_entry_with_http_info(xero_tenant_id, project_id, time_entry_id, options = {})
+      opts = options.dup
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: ProjectApi.delete_time_entry ...'
       end
@@ -273,7 +276,8 @@ module XeroRuby
     # @param project_id [String] You can specify an individual project by appending the projectId to the endpoint
     # @param [Hash] opts the optional parameters
     # @return [Array<(Project, Integer, Hash)>] Project data, response status code and response headers
-    def get_project_with_http_info(xero_tenant_id, project_id, opts = {})
+    def get_project_with_http_info(xero_tenant_id, project_id, options = {})
+      opts = options.dup
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: ProjectApi.get_project ...'
       end
@@ -351,7 +355,8 @@ 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.
     # @return [Array<(ProjectUsers, Integer, Hash)>] ProjectUsers data, response status code and response headers
-    def get_project_users_with_http_info(xero_tenant_id, opts = {})
+    def get_project_users_with_http_info(xero_tenant_id, options = {})
+      opts = options.dup
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: ProjectApi.get_project_users ...'
       end
@@ -441,7 +446,8 @@ 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.
     # @return [Array<(Projects, Integer, Hash)>] Projects data, response status code and response headers
-    def get_projects_with_http_info(xero_tenant_id, opts = {})
+    def get_projects_with_http_info(xero_tenant_id, options = {})
+      opts = options.dup
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: ProjectApi.get_projects ...'
       end
@@ -528,7 +534,8 @@ module XeroRuby
     # @param task_id [String] You can specify an individual task by appending the taskId to the endpoint, i.e. GET https://.../tasks/{taskID}
     # @param [Hash] opts the optional parameters
     # @return [Array<(Task, Integer, Hash)>] Task data, response status code and response headers
-    def get_task_with_http_info(xero_tenant_id, project_id, task_id, opts = {})
+    def get_task_with_http_info(xero_tenant_id, project_id, task_id, options = {})
+      opts = options.dup
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: ProjectApi.get_task ...'
       end
@@ -616,7 +623,8 @@ module XeroRuby
     # @option opts [String] :task_ids taskIdsSearch for all tasks that match a comma separated list of taskIds, i.e. GET https://.../tasks?taskIds&#x3D;{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 = {})
+    def get_tasks_with_http_info(xero_tenant_id, project_id, options = {})
+      opts = options.dup
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: ProjectApi.get_tasks ...'
       end
@@ -716,7 +724,8 @@ module XeroRuby
     # @option opts [DateTime] :date_after_utc ISO 8601 UTC date. Finds all time entries on or after this date filtered on the &#x60;dateUtc&#x60; field.
     # @option opts [DateTime] :date_before_utc ISO 8601 UTC date. Finds all time entries on or before this date filtered on the &#x60;dateUtc&#x60; field.
     # @return [Array<(TimeEntries, Integer, Hash)>] TimeEntries data, response status code and response headers
-    def get_time_entries_with_http_info(xero_tenant_id, project_id, opts = {})
+    def get_time_entries_with_http_info(xero_tenant_id, project_id, options = {})
+      opts = options.dup
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: ProjectApi.get_time_entries ...'
       end
@@ -804,7 +813,8 @@ module XeroRuby
     # @param time_entry_id [String] You can specify an individual time entry by appending the id to the endpoint
     # @param [Hash] opts the optional parameters
     # @return [Array<(TimeEntry, Integer, Hash)>] TimeEntry data, response status code and response headers
-    def get_time_entry_with_http_info(xero_tenant_id, project_id, time_entry_id, opts = {})
+    def get_time_entry_with_http_info(xero_tenant_id, project_id, time_entry_id, options = {})
+      opts = options.dup
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: ProjectApi.get_time_entry ...'
       end
@@ -886,7 +896,8 @@ module XeroRuby
     # @param project_patch [ProjectPatch] Update the status of an existing Project
     # @param [Hash] opts the optional parameters
     # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
-    def patch_project_with_http_info(xero_tenant_id, project_id, project_patch, opts = {})
+    def patch_project_with_http_info(xero_tenant_id, project_id, project_patch, options = {})
+      opts = options.dup
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: ProjectApi.patch_project ...'
       end
@@ -970,7 +981,8 @@ module XeroRuby
     # @param project_create_or_update [ProjectCreateOrUpdate] Request of type ProjectCreateOrUpdate
     # @param [Hash] opts the optional parameters
     # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
-    def update_project_with_http_info(xero_tenant_id, project_id, project_create_or_update, opts = {})
+    def update_project_with_http_info(xero_tenant_id, project_id, project_create_or_update, options = {})
+      opts = options.dup
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: ProjectApi.update_project ...'
       end
@@ -1056,7 +1068,8 @@ module XeroRuby
     # @param time_entry_create_or_update [TimeEntryCreateOrUpdate] The time entry object you are updating
     # @param [Hash] opts the optional parameters
     # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
-    def update_time_entry_with_http_info(xero_tenant_id, project_id, time_entry_id, time_entry_create_or_update, opts = {})
+    def update_time_entry_with_http_info(xero_tenant_id, project_id, time_entry_id, time_entry_create_or_update, options = {})
+      opts = options.dup
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: ProjectApi.update_time_entry ...'
       end

data/lib/xero-ruby/api_client.rb

@@ -16,6 +16,7 @@ require 'tempfile'
 require 'find'
 require 'faraday'
 require 'base64'
+require 'cgi'
 
 module XeroRuby
   class ApiClient
@@ -31,13 +32,15 @@ module XeroRuby
 
     # Initializes the ApiClient
     # @option config [Configuration] Configuration for initializing the object, default to Configuration.default
-    def initialize(config: Configuration.default, credentials: {})
+    def initialize(config: {}, credentials: {})
       @client_id = credentials[:client_id]
       @client_secret = credentials[:client_secret]
       @redirect_uri = credentials[:redirect_uri]
       @scopes = credentials[:scopes]
       @state = credentials[:state]
-      @config = config
+      default_config = Configuration.default.clone
+      @config = append_to_default_config(default_config, config)
+
       @user_agent = "xero-ruby-#{VERSION}"
       @default_headers = {
         'Content-Type' => 'application/json',
@@ -45,8 +48,14 @@ module XeroRuby
       }
     end
 
+    def append_to_default_config(default_config, user_config)
+      config = default_config
+      user_config.each{|k,v| config.send("#{k}=", v)}
+      config
+    end
+
     def authorization_url
-      url = "#{@config.login_url}?response_type=code&client_id=#{@client_id}&redirect_uri=#{@redirect_uri}&scope=#{@scopes}"
+      url = "#{@config.login_url}?response_type=code&client_id=#{@client_id}&redirect_uri=#{@redirect_uri}&scope=#{CGI.escape(@scopes)}"
       url << "&state=#{@state}" if @state
       return url
     end
@@ -88,22 +97,32 @@ module XeroRuby
 
     # Token Helpers
     def token_set
-      XeroRuby.configure.token_set
+      @config.token_set
     end
 
     def access_token
-      XeroRuby.configure.access_token
+      @config.access_token
+    end
+
+    def id_token
+      @config.id_token
     end
 
     def set_token_set(token_set)
       # helper to set the token_set on a client once the user
       # has a valid token set ( access_token & refresh_token )
-      XeroRuby.configure.token_set = token_set
+      @config.token_set = token_set
       set_access_token(token_set['access_token'])
     end
 
     def set_access_token(access_token)
-      XeroRuby.configure.access_token = access_token
+      # puts "access_token -> #{access_token}"
+      @config.access_token = access_token
+      # puts "@config.access_token -> #{@config.access_token}"
+    end
+
+    def set_id_token(id_token)
+      @config.id_token = id_token
     end
 
     def get_token_set_from_callback(params)
@@ -174,7 +193,26 @@ module XeroRuby
         :client_key => @config.ssl_client_key
       }
 
-      connection = Faraday.new(:url => config.base_url, :ssl => ssl_options) do |conn|
+      case api_client
+      when "AccountingApi"
+        method_base_url = @config.accounting_url
+      when "AssetApi"
+        method_base_url = @config.asset_url
+      when "FilesApi"
+       method_base_url = @config.files_url
+      when "PayrollAuApi"
+        method_base_url = @config.payroll_au_url
+      when "PayrollNzApi"
+        method_base_url = @config.payroll_nz_url
+      when "PayrollUkApi"
+        method_base_url = @config.payroll_uk_url
+      when "ProjectApi"
+        method_base_url = @config.project_url
+      else
+        method_base_url = @config.accounting_url
+      end
+
+      connection = Faraday.new(:url => method_base_url, :ssl => ssl_options) do |conn|
         conn.basic_auth(config.username, config.password)
         if opts[:header_params]["Content-Type"] == "multipart/form-data"
           conn.request :multipart
@@ -257,6 +295,8 @@ module XeroRuby
         end
       end
       request.headers = header_params
+      timeout = @config.timeout
+      request.options.timeout = timeout if timeout > 0
       request.body = req_body
       request.url url
       request.params = query_params

data/lib/xero-ruby/configuration.rb

@@ -60,8 +60,11 @@ module XeroRuby
     # @return [String]
     attr_accessor :password
 
-    # Defines the access token (Bearer) used with OAuth2.
+    # Defines the access token (Bearer) used with OAuth2 authorization
     attr_accessor :access_token
+    
+    # Defines OpenID Connect id_token containing Xero user authentication detail
+    attr_accessor :id_token
 
     # Defines the token set used with OAuth2. May include id/access/refresh token & other meta info.
     attr_accessor :token_set
@@ -146,6 +149,8 @@ module XeroRuby
       @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/'
+      @access_token = nil
+      @id_token = nil
       @api_key = {}
       @api_key_prefix = {}
       @timeout = 0
@@ -191,6 +196,14 @@ module XeroRuby
     def base_url=(api_url)
       @base_url = api_url
     end
+
+    def access_token=(access_token)
+      @access_token = access_token
+    end
+
+    def id_token=(id_token)
+      @id_token = id_token
+    end
     
     # Gets API key (with prefix if set).
     # @param [String] param_name the parameter name of API key auth

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

@@ -495,7 +495,7 @@ module XeroRuby::Accounting
     end
 
     # Returns the object in the form of hash with snake_case
-    def attributes
+    def to_attributes
       to_hash(downcase: true)
     end
 

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

@@ -184,7 +184,7 @@ module XeroRuby::Accounting
     end
 
     # Returns the object in the form of hash with snake_case
-    def attributes
+    def to_attributes
       to_hash(downcase: true)
     end
 

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

@@ -192,7 +192,7 @@ module XeroRuby::Accounting
     end
 
     # Returns the object in the form of hash with snake_case
-    def attributes
+    def to_attributes
       to_hash(downcase: true)
     end
 

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

@@ -192,7 +192,7 @@ module XeroRuby::Accounting
     end
 
     # Returns the object in the form of hash with snake_case
-    def attributes
+    def to_attributes
       to_hash(downcase: true)
     end
 

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

@@ -228,7 +228,7 @@ module XeroRuby::Accounting
     end
 
     # Returns the object in the form of hash with snake_case
-    def attributes
+    def to_attributes
       to_hash(downcase: true)
     end
 

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

@@ -184,7 +184,7 @@ module XeroRuby::Accounting
     end
 
     # Returns the object in the form of hash with snake_case
-    def attributes
+    def to_attributes
       to_hash(downcase: true)
     end
 

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

@@ -443,7 +443,7 @@ module XeroRuby::Accounting
     end
 
     # Returns the object in the form of hash with snake_case
-    def attributes
+    def to_attributes
       to_hash(downcase: true)
     end
 

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

@@ -444,7 +444,7 @@ module XeroRuby::Accounting
     end
 
     # Returns the object in the form of hash with snake_case
-    def attributes
+    def to_attributes
       to_hash(downcase: true)
     end
 

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

@@ -269,7 +269,7 @@ module XeroRuby::Accounting
     end
 
     # Returns the object in the form of hash with snake_case
-    def attributes
+    def to_attributes
       to_hash(downcase: true)
     end
 

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

@@ -184,7 +184,7 @@ module XeroRuby::Accounting
     end
 
     # Returns the object in the form of hash with snake_case
-    def attributes
+    def to_attributes
       to_hash(downcase: true)
     end
 

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

@@ -232,7 +232,7 @@ module XeroRuby::Accounting
     end
 
     # Returns the object in the form of hash with snake_case
-    def attributes
+    def to_attributes
       to_hash(downcase: true)
     end
 

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

@@ -184,7 +184,7 @@ module XeroRuby::Accounting
     end
 
     # Returns the object in the form of hash with snake_case
-    def attributes
+    def to_attributes
       to_hash(downcase: true)
     end
 

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

@@ -203,7 +203,7 @@ module XeroRuby::Accounting
     end
 
     # Returns the object in the form of hash with snake_case
-    def attributes
+    def to_attributes
       to_hash(downcase: true)
     end
 

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

@@ -193,7 +193,7 @@ module XeroRuby::Accounting
     end
 
     # Returns the object in the form of hash with snake_case
-    def attributes
+    def to_attributes
       to_hash(downcase: true)
     end
 

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

@@ -470,7 +470,7 @@ module XeroRuby::Accounting
     end
 
     # Returns the object in the form of hash with snake_case
-    def attributes
+    def to_attributes
       to_hash(downcase: true)
     end
 

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

@@ -184,7 +184,7 @@ module XeroRuby::Accounting
     end
 
     # Returns the object in the form of hash with snake_case
-    def attributes
+    def to_attributes
       to_hash(downcase: true)
     end
 

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

@@ -301,7 +301,7 @@ module XeroRuby::Accounting
     end
 
     # Returns the object in the form of hash with snake_case
-    def attributes
+    def to_attributes
       to_hash(downcase: true)
     end