xero-ruby 2.3.1 → 2.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 27699a618c553b30814d155cc208eb69643173ee2a165a31412d62288dbbb2fa
-  data.tar.gz: 8ad9d483a375baaaa01dbab76c882bb14ec51b5363148e7e25159753e994ac9f
+  metadata.gz: e31ff3c90718184423dc2c2e4eaeb4ce2bc068b3ebad4c94017703e8ecd87e71
+  data.tar.gz: 5d831820660d5eae61a43a1f2c8cfd3ce40a3cbe1721697f657b5b61dc7bea36
 SHA512:
-  metadata.gz: 54a5162180d95e0ac0042f83d8626e432ce71ff3bace82a2d675133af6b468f1435810f937029fbf7aedaec31e1813ff13cfc943422cfebcf6445361eef66ac5
-  data.tar.gz: 5260248c63f8dc58821e06450c6d708ae3ffcc60bafd1943326e7ba0bf0057e7c47e5c7f74a4e4f9913856147834b8d341dbbb652d1f171a5143d47901280ce8
+  metadata.gz: d283c2e0c4f92da33f7bc16665f4ef67570e5f7eadac0ac80d024b57667845df702d7d71be5664c0118b52d3040c18fc3e16363652fe20f69867ffee79afc5ed
+  data.tar.gz: 65cb61a5b45cbada2376223aa4eef5eb00a161f258b8a07d68556bfa210f7ee982cda44144fecfb3af98b91a3d84ec5f50063e5ab740861d4a2c107d8a991a81

data/README.md

@@ -1,10 +1,10 @@
 # xero-ruby
 Xero Ruby SDK for OAuth 2.0 generated from [Xero API OpenAPI Spec](https://github.com/XeroAPI/Xero-OpenAPI).
 
-[![RubyGem](https://img.shields.io/badge/xero--ruby%20gem-v0.2.4-brightgreen)](https://rubygems.org/gems/xero-ruby)
+[![RubyGem](https://img.shields.io/badge/xero--ruby%20gem-v2.6.0-brightgreen)](https://rubygems.org/gems/xero-ruby)
 
 # Documentation
-Xero Ruby SDK supports Xero's OAuth2.0 authentication and supports the following Xero API sets.
+Xero Ruby SDK supports Xero's OAuth2.0 authentication and the following Xero API sets.
 
 ## API Client Docs
 * [Accounting Api Docs](/docs/accounting/AccountingApi.md)
@@ -61,7 +61,8 @@ creds = {
   client_id: ENV['CLIENT_ID'],
   client_secret: ENV['CLIENT_SECRET'],
   redirect_uri: ENV['REDIRECT_URI'],
-  scopes: ENV['SCOPES']
+  scopes: ENV['SCOPES'],
+  state: "this-can-be-a-custom-state-parameter" # optional
 }
 xero_client ||= XeroRuby::ApiClient.new(credentials: creds)
 ```
@@ -86,6 +87,9 @@ In your callback route catch, calling `get_token_set_from_callback` will exchang
 token_set = xero_client.get_token_set_from_callback(params)
 
 # save token_set JSON in a datastore in relation to the user authentication
+
+puts params['state']
+=> "this-can-be-a-custom-state-parameter"
 ```
 
 ## Making API calls once you have a token_set
@@ -327,4 +331,25 @@ xero_client.accounting_api.get_bank_transfers(tenant_id, opts).bank_transfers
 ## Sample App
 The best resource to understanding how to best leverage this SDK is the sample applications showing all the features of the gem.
 > https://github.com/XeroAPI/xero-ruby-oauth2-starter (Sinatra - simple getting started)
-> https://github.com/XeroAPI/xero-ruby-oauth2-app (Rails - full featured examples)
+> https://github.com/XeroAPI/xero-ruby-oauth2-app (Rails - full featured examples)
+
+## Contributing
+Most of the repo code is auto generated but PR's on issues you encounter are highly encouraged. Xero maintainers will re-incorporate them back into the core SDK build. To develop this gem locally against your project you can use the following development pattern:
+
+> xero-ruby
+```bash
+gem build
+mv xero-ruby-<vsn>.gem xero-ruby.gem
+pwd
+=> /Users/chris.knight/code/sdks/xero-ruby/
+```
+
+> xero-ruby-oauth2-app
+Replace gem file with local path:
+```bash
+gem 'xero-ruby', path: '/Users/chris.knight/code/sdks/xero-ruby/'
+bundle install
+```
+
+## Testing 
+* `rspec spec/`

data/lib/xero-ruby.rb

@@ -3,7 +3,6 @@
 
 #No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
 
-The version of the OpenAPI document: 2.4.0
 Contact: api@xero.com
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 4.3.1
@@ -112,6 +111,7 @@ require 'xero-ruby/models/payroll_nz/accounts'
 require 'xero-ruby/models/payroll_nz/address'
 require 'xero-ruby/models/payroll_nz/bank_account'
 require 'xero-ruby/models/payroll_nz/benefit'
+require 'xero-ruby/models/payroll_nz/calendar_type'
 require 'xero-ruby/models/payroll_nz/deduction'
 require 'xero-ruby/models/payroll_nz/deduction_line'
 require 'xero-ruby/models/payroll_nz/deduction_object'
@@ -331,10 +331,12 @@ require 'xero-ruby/models/accounting/accounts_receivable'
 require 'xero-ruby/models/accounting/action'
 require 'xero-ruby/models/accounting/actions'
 require 'xero-ruby/models/accounting/address'
+require 'xero-ruby/models/accounting/address_for_organisation'
 require 'xero-ruby/models/accounting/allocation'
 require 'xero-ruby/models/accounting/allocations'
 require 'xero-ruby/models/accounting/attachment'
 require 'xero-ruby/models/accounting/attachments'
+require 'xero-ruby/models/accounting/balance_details'
 require 'xero-ruby/models/accounting/balances'
 require 'xero-ruby/models/accounting/bank_transaction'
 require 'xero-ruby/models/accounting/bank_transactions'
@@ -354,6 +356,8 @@ require 'xero-ruby/models/accounting/contact_group'
 require 'xero-ruby/models/accounting/contact_groups'
 require 'xero-ruby/models/accounting/contact_person'
 require 'xero-ruby/models/accounting/contacts'
+require 'xero-ruby/models/accounting/conversion_balances'
+require 'xero-ruby/models/accounting/conversion_date'
 require 'xero-ruby/models/accounting/country_code'
 require 'xero-ruby/models/accounting/credit_note'
 require 'xero-ruby/models/accounting/credit_notes'
@@ -369,6 +373,10 @@ require 'xero-ruby/models/accounting/expense_claims'
 require 'xero-ruby/models/accounting/external_link'
 require 'xero-ruby/models/accounting/history_record'
 require 'xero-ruby/models/accounting/history_records'
+require 'xero-ruby/models/accounting/import_summary'
+require 'xero-ruby/models/accounting/import_summary_accounts'
+require 'xero-ruby/models/accounting/import_summary_object'
+require 'xero-ruby/models/accounting/import_summary_organisation'
 require 'xero-ruby/models/accounting/invoice'
 require 'xero-ruby/models/accounting/invoice_reminder'
 require 'xero-ruby/models/accounting/invoice_reminders'
@@ -426,6 +434,7 @@ require 'xero-ruby/models/accounting/request_empty'
 require 'xero-ruby/models/accounting/row_type'
 require 'xero-ruby/models/accounting/sales_tracking_category'
 require 'xero-ruby/models/accounting/schedule'
+require 'xero-ruby/models/accounting/setup'
 require 'xero-ruby/models/accounting/tax_component'
 require 'xero-ruby/models/accounting/tax_rate'
 require 'xero-ruby/models/accounting/tax_rates'

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

@@ -3,7 +3,6 @@
 
 #No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
 
-The version of the OpenAPI document: 2.4.0
 Contact: api@xero.com
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 4.3.1
@@ -595,6 +594,7 @@ module XeroRuby
       return data, status_code, headers
     end
 
+    # Allows you to create history record for a bank transfers
     # @param xero_tenant_id [String] Xero identifier for Tenant
     # @param bank_transfer_id [String] Xero generated unique identifier for a bank transfer
     # @param history_records [HistoryRecords] HistoryRecords containing an array of HistoryRecord objects in body of request
@@ -605,6 +605,7 @@ module XeroRuby
       data
     end
 
+    # Allows you to create history record for a bank transfers
     # @param xero_tenant_id [String] Xero identifier for Tenant
     # @param bank_transfer_id [String] Xero generated unique identifier for a bank transfer
     # @param history_records [HistoryRecords] HistoryRecords containing an array of HistoryRecord objects in body of request
@@ -1663,6 +1664,7 @@ module XeroRuby
       return data, status_code, headers
     end
 
+    # Allows you to create a new currency for an org
     # @param xero_tenant_id [String] Xero identifier for Tenant
     # @param currency [Currency] Currency obejct in the body of request
     # @param [Hash] opts the optional parameters
@@ -1672,6 +1674,7 @@ module XeroRuby
       data
     end
 
+    # Allows you to create a new currency for an org
     # @param xero_tenant_id [String] Xero identifier for Tenant
     # @param currency [Currency] Currency obejct in the body of request
     # @param [Hash] opts the optional parameters
@@ -13879,7 +13882,7 @@ module XeroRuby
     # Allows you to retrieve report for BalanceSheet
     # @param xero_tenant_id [String] Xero identifier for Tenant
     # @param [Hash] opts the optional parameters
-    # @option opts [String] :date The date of the Balance Sheet report
+    # @option opts [Date] :date The date of the Balance Sheet report
     # @option opts [Integer] :periods The number of periods for the Balance Sheet report
     # @option opts [String] :timeframe The period size to compare to (MONTH, QUARTER, YEAR)
     # @option opts [String] :tracking_option_id1 The tracking option 1 for the Balance Sheet report
@@ -13895,7 +13898,7 @@ module XeroRuby
     # Allows you to retrieve report for BalanceSheet
     # @param xero_tenant_id [String] Xero identifier for Tenant
     # @param [Hash] opts the optional parameters
-    # @option opts [String] :date The date of the Balance Sheet report
+    # @option opts [Date] :date The date of the Balance Sheet report
     # @option opts [Integer] :periods The number of periods for the Balance Sheet report
     # @option opts [String] :timeframe The period size to compare to (MONTH, QUARTER, YEAR)
     # @option opts [String] :tracking_option_id1 The tracking option 1 for the Balance Sheet report
@@ -14817,6 +14820,82 @@ module XeroRuby
       return data, status_code, headers
     end
 
+    # Allows you to set the chart of accounts, the conversion date and conversion balances
+    # @param xero_tenant_id [String] Xero identifier for Tenant
+    # @param setup [Setup] Object including an accounts array, a conversion balances array and a conversion date object in body of request
+    # @param [Hash] opts the optional parameters
+    # @return [ImportSummaryObject]
+    def post_setup(xero_tenant_id, setup, opts = {})
+      data, _status_code, _headers = post_setup_with_http_info(xero_tenant_id, setup, opts)
+      data
+    end
+
+    # Allows you to set the chart of accounts, the conversion date and conversion balances
+    # @param xero_tenant_id [String] Xero identifier for Tenant
+    # @param setup [Setup] Object including an accounts array, a conversion balances array and a conversion date object in body of request
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(ImportSummaryObject, Integer, Hash)>] ImportSummaryObject data, response status code and response headers
+    def post_setup_with_http_info(xero_tenant_id, setup, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: AccountingApi.post_setup ...'
+      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.post_setup"
+      end
+      # verify the required parameter 'setup' is set
+      if @api_client.config.client_side_validation && setup.nil?
+        fail ArgumentError, "Missing the required parameter 'setup' when calling AccountingApi.post_setup"
+      end
+      # resource path
+      local_var_path = '/Setup'
+
+      # 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'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+      header_params[:'xero-tenant-id'] = xero_tenant_id
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:body] || @api_client.object_to_http_body(setup) 
+
+      # return_type
+      return_type = opts[:return_type] || 'ImportSummaryObject' 
+
+      # 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(:POST, local_var_path, "AccountingApi", new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: AccountingApi#post_setup\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Allows you to update a chart of accounts
     # @param xero_tenant_id [String] Xero identifier for Tenant
     # @param account_id [String] Unique identifier for retrieving single object
@@ -15246,6 +15325,7 @@ module XeroRuby
       return data, status_code, headers
     end
 
+    # Allows you to update one contact in a Xero organisation
     # @param xero_tenant_id [String] Xero identifier for Tenant
     # @param contact_id [String] Unique identifier for a Contact
     # @param contacts [Contacts] an array of Contacts containing single Contact object with properties to update
@@ -15256,6 +15336,7 @@ module XeroRuby
       data
     end
 
+    # Allows you to update one contact in a Xero organisation
     # @param xero_tenant_id [String] Xero identifier for Tenant
     # @param contact_id [String] Unique identifier for a Contact
     # @param contacts [Contacts] an array of Contacts containing single Contact object with properties to update

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

@@ -3,7 +3,6 @@
 
 #This is the Xero Assets API
 
-The version of the OpenAPI document: 2.4.0
 Contact: api@xero.com
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 4.3.1

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

@@ -3,7 +3,6 @@
 
 #No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
 
-The version of the OpenAPI document: 2.4.0
 Contact: api@xero.com
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 4.3.1

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

@@ -3,7 +3,6 @@
 
 #This is the Xero Payroll API for orgs in Australia region.
 
-The version of the OpenAPI document: 2.4.0
 Contact: api@xero.com
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 4.3.1

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

@@ -3,7 +3,6 @@
 
 #This is the Xero Payroll API for orgs in the NZ region.
 
-The version of the OpenAPI document: 2.4.0
 Contact: api@xero.com
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 4.3.1

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

@@ -3,7 +3,6 @@
 
 #This is the Xero Payroll API for orgs in the UK region.
 
-The version of the OpenAPI document: 2.4.0
 Contact: api@xero.com
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 4.3.1

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

@@ -3,7 +3,6 @@
 
 #This is the Xero Projects API
 
-The version of the OpenAPI document: 2.4.0
 Contact: api@xero.com
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 4.3.1
@@ -600,6 +599,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)
@@ -614,6 +614,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
@@ -638,6 +639,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?

data/lib/xero-ruby/api_client.rb

@@ -3,7 +3,6 @@
 
 #No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
 
-The version of the OpenAPI document: 2.4.0
 Contact: api@xero.com
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 4.3.1
@@ -34,6 +33,7 @@ module XeroRuby
       @client_secret = credentials[:client_secret]
       @redirect_uri = credentials[:redirect_uri]
       @scopes = credentials[:scopes]
+      @state = credentials[:state]
       @config = config
       @user_agent = "xero-ruby-#{VERSION}"
       @default_headers = {
@@ -44,6 +44,7 @@ module XeroRuby
 
     def authorization_url
       url = "#{@config.login_url}?response_type=code&client_id=#{@client_id}&redirect_uri=#{@redirect_uri}&scope=#{@scopes}"
+      url << "&state=#{@state}" if @state
       return url
     end
 
@@ -125,6 +126,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
@@ -132,20 +134,17 @@ 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
+      @config.base_url = 'https://api.xero.com'
+      opts = { :header_params => {'Content-Type': 'application/json'}, :auth_names => ['OAuth2'] }
+      response = call_api(:GET, '/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
+      @config.base_url = 'https://api.xero.com'
+      opts = { :header_params => {'Content-Type': 'application/json'}, :auth_names => ['OAuth2'] }
+      call_api(:DELETE, '/connections/#{connection_id}', nil, opts)
+      connections
     end
 
     # Call an API with given options.
@@ -179,18 +178,7 @@ 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
@@ -198,12 +186,27 @@ module XeroRuby
       if opts[:return_type]
         prepare_file(response) if opts[:return_type] == 'File'
         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)
@@ -416,9 +419,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.