xero-ruby 2.8.2 → 2.9.0

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

@@ -32,13 +32,14 @@ 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
+      @config = append_to_default_config(config)
+
       @user_agent = "xero-ruby-#{VERSION}"
       @default_headers = {
         'Content-Type' => 'application/json',
@@ -46,6 +47,12 @@ module XeroRuby
       }
     end
 
+    def append_to_default_config(user_config)
+      config = Configuration.default
+      user_config.each{|k,v| config.send("#{k}=", v) } if user_config
+      config
+    end
+
     def authorization_url
       url = "#{@config.login_url}?response_type=code&client_id=#{@client_id}&redirect_uri=#{@redirect_uri}&scope=#{CGI.escape(@scopes)}"
       url << "&state=#{@state}" if @state
@@ -258,6 +265,7 @@ module XeroRuby
         end
       end
       request.headers = header_params
+      request.options.timeout = @config.timeout
       request.body = req_body
       request.url url
       request.params = query_params

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

@@ -46,6 +46,7 @@ module XeroRuby::PayrollUk
     # The type of the payment of the corresponding salary and wages
     attr_accessor :payment_type
     SALARY = "Salary".freeze
+    HOURLY = "Hourly".freeze
     
     class EnumAttributeValidator
       attr_reader :datatype
@@ -193,7 +194,7 @@ module XeroRuby::PayrollUk
       status_validator = EnumAttributeValidator.new('String', ["Active", "Pending", "History"])
       return false unless status_validator.valid?(@status)
       return false if @payment_type.nil?
-      payment_type_validator = EnumAttributeValidator.new('String', ["Salary"])
+      payment_type_validator = EnumAttributeValidator.new('String', ["Salary", "Hourly"])
       return false unless payment_type_validator.valid?(@payment_type)
       true
     end
@@ -211,7 +212,7 @@ module XeroRuby::PayrollUk
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] payment_type Object to be assigned
     def payment_type=(payment_type)
-      validator = EnumAttributeValidator.new('String', ["Salary"])
+      validator = EnumAttributeValidator.new('String', ["Salary", "Hourly"])
       unless validator.valid?(payment_type)
         fail ArgumentError, "invalid value for \"payment_type\", must be one of #{validator.allowable_values}."
       end

data/lib/xero-ruby/version.rb

@@ -11,5 +11,5 @@ The version of the XeroOpenAPI document: 2.10.4
 =end
 
 module XeroRuby
-  VERSION = '2.8.2'
+  VERSION = '2.9.0'
 end

data/spec/api_client_spec.rb

@@ -137,6 +137,17 @@ describe XeroRuby::ApiClient do
       api_client.connections
       expect(api_client.config.base_url).to eq('https://api.xero.com')  
     end
+
+    it "does not mutate the original opts hash" do
+      expect(api_client).to receive(:call_api).and_return('')
+      opts = {
+        where: {
+          invoice_number: ['=', "INV-0060"]
+        }
+      }
+      api_client.accounting_api.get_invoices('active_tenant_id', opts)
+      expect(opts).to eq({:where=>{:invoice_number=>["=", "INV-0060"]}})
+    end
   end
 
   describe '#deserialize' do

data/spec/configuration_spec.rb

@@ -16,4 +16,21 @@ describe XeroRuby::Configuration do
       expect(config.payroll_uk_url).to eq('https://api.xero.com/payroll.xro/2.0/')
     end
   end
+
+  describe 'config' do
+    it 'should apply the default configuration options' do
+      client = XeroRuby::ApiClient.new(credentials: {})
+      expect(client.config.login_url).to eq('https://login.xero.com/identity/connect/authorize')
+    end
+
+    it 'should allow you to overwrite the default configuration options' do
+      client = XeroRuby::ApiClient.new(credentials: {}, config: {login_url: 'ngrok.login.xero.test'})
+      expect(client.config.login_url).to eq('ngrok.login.xero.test')
+    end
+
+    it 'should allow you to set the timeout config option' do
+      client = XeroRuby::ApiClient.new(credentials: {}, config: {timeout: 30})
+      expect(client.config.timeout).to eq(30)
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: xero-ruby
 version: !ruby/object:Gem::Version
-  version: 2.8.2
+  version: 2.9.0
 platform: ruby
 authors:
 - Xero API Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-04-02 00:00:00.000000000 Z
+date: 2021-04-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday