xero-ruby 2.5.1 → 2.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cd45eb905d350e9480a972d1754a51c9e6a385859e9217edb55e1fada869432d
-  data.tar.gz: ca93756ba4a748d60f86912c863f664393d71c9c0d14e6bf71442b756d594ed3
+  metadata.gz: e31ff3c90718184423dc2c2e4eaeb4ce2bc068b3ebad4c94017703e8ecd87e71
+  data.tar.gz: 5d831820660d5eae61a43a1f2c8cfd3ce40a3cbe1721697f657b5b61dc7bea36
 SHA512:
-  metadata.gz: 6a140a7c1182d243bed2465bc9e4c3849f630adbf01cd8bb23109fd91597cb6340562c18aeb429ec492681acf7c4b507c9e0d62595d90bbd3f0a581fcf25cbad
-  data.tar.gz: 0244720a3942dd5ac14ab2d6a3bab3b7a3833b0b1e2a18d176fe73d89acbe47c1c8740078eb917f12980d88b2c4708be7121715db9b1ef80cd143ea7a503c107
+  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)
@@ -331,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.8.0
 Contact: api@xero.com
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 4.3.1

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.8.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
@@ -15322,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
@@ -15332,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.8.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.8.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.8.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.8.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.8.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.8.0
 Contact: api@xero.com
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 4.3.1

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.8.0
 Contact: api@xero.com
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 4.3.1
@@ -44,7 +43,8 @@ module XeroRuby
     end
 
     def authorization_url
-      url = "#{@config.login_url}?response_type=code&client_id=#{@client_id}&redirect_uri=#{@redirect_uri}&scope=#{@scopes}&state=#{@state}"
+      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
 
@@ -134,14 +134,16 @@ module XeroRuby
 
     # Connection heplers
     def connections
+      @config.base_url = 'https://api.xero.com'
       opts = { :header_params => {'Content-Type': 'application/json'}, :auth_names => ['OAuth2'] }
-      response = call_api(:GET, 'https://api.xero.com/connections/', nil, opts)
+      response = call_api(:GET, '/connections/', nil, opts)
       response[0]
     end
 
     def disconnect(connection_id)
+      @config.base_url = 'https://api.xero.com'
       opts = { :header_params => {'Content-Type': 'application/json'}, :auth_names => ['OAuth2'] }
-      call_api(:DELETE, "https://api.xero.com/connections/#{connection_id}", nil, opts)
+      call_api(:DELETE, '/connections/#{connection_id}', nil, opts)
       connections
     end
 

data/lib/xero-ruby/api_error.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.8.0
 Contact: api@xero.com
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 4.3.1

data/lib/xero-ruby/configuration.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.8.0
 Contact: api@xero.com
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 4.3.1

data/lib/xero-ruby/models/accounting/account.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.8.0
 Contact: api@xero.com
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 4.3.1
@@ -91,7 +90,6 @@ 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
@@ -485,12 +483,13 @@ module XeroRuby::Accounting
 
     # Returns the object in the form of hash
     # @return [Hash] Returns the object in the form of hash
-    def to_hash
+    def to_hash(downcase: true)
       hash = {}
       self.class.attribute_map.each_pair do |attr, param|
         value = self.send(attr)
         next if value.nil?
-        hash[param] = _to_hash(value)
+        key = downcase ? attr : param
+        hash[key] = _to_hash(value)
       end
       hash
     end
@@ -513,10 +512,13 @@ module XeroRuby::Accounting
       end
     end
 
-    # customized data_parser
     def parse_date(datestring)
-      seconds_since_epoch = datestring.scan(/[0-9]+/)[0].to_i / 1000.0
-      return Time.at(seconds_since_epoch).strftime('%Y-%m-%dT%l:%M:%S%z').to_s
+      if datestring.include?('Date')
+        seconds_since_epoch = datestring.scan(/[0-9]+/)[0].to_i / 1000.0
+        Time.at(seconds_since_epoch).utc.strftime('%Y-%m-%dT%H:%M:%S%z').to_s
+      else # handle date 'types' for small subset of payroll API's
+        Time.parse(datestring).strftime('%Y-%m-%dT%H:%M:%S').to_s
+      end
     end
   end
 end

data/lib/xero-ruby/models/accounting/account_type.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.8.0
 Contact: api@xero.com
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 4.3.1

data/lib/xero-ruby/models/accounting/accounts.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.8.0
 Contact: api@xero.com
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 4.3.1
@@ -173,12 +172,13 @@ module XeroRuby::Accounting
 
     # Returns the object in the form of hash
     # @return [Hash] Returns the object in the form of hash
-    def to_hash
+    def to_hash(downcase: true)
       hash = {}
       self.class.attribute_map.each_pair do |attr, param|
         value = self.send(attr)
         next if value.nil?
-        hash[param] = _to_hash(value)
+        key = downcase ? attr : param
+        hash[key] = _to_hash(value)
       end
       hash
     end
@@ -201,10 +201,13 @@ module XeroRuby::Accounting
       end
     end
 
-    # customized data_parser
     def parse_date(datestring)
-      seconds_since_epoch = datestring.scan(/[0-9]+/)[0].to_i / 1000.0
-      return Time.at(seconds_since_epoch).strftime('%Y-%m-%dT%l:%M:%S%z').to_s
+      if datestring.include?('Date')
+        seconds_since_epoch = datestring.scan(/[0-9]+/)[0].to_i / 1000.0
+        Time.at(seconds_since_epoch).utc.strftime('%Y-%m-%dT%H:%M:%S%z').to_s
+      else # handle date 'types' for small subset of payroll API's
+        Time.parse(datestring).strftime('%Y-%m-%dT%H:%M:%S').to_s
+      end
     end
   end
 end

data/lib/xero-ruby/models/accounting/accounts_payable.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.8.0
 Contact: api@xero.com
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 4.3.1
@@ -181,12 +180,13 @@ module XeroRuby::Accounting
 
     # Returns the object in the form of hash
     # @return [Hash] Returns the object in the form of hash
-    def to_hash
+    def to_hash(downcase: true)
       hash = {}
       self.class.attribute_map.each_pair do |attr, param|
         value = self.send(attr)
         next if value.nil?
-        hash[param] = _to_hash(value)
+        key = downcase ? attr : param
+        hash[key] = _to_hash(value)
       end
       hash
     end
@@ -209,10 +209,13 @@ module XeroRuby::Accounting
       end
     end
 
-    # customized data_parser
     def parse_date(datestring)
-      seconds_since_epoch = datestring.scan(/[0-9]+/)[0].to_i / 1000.0
-      return Time.at(seconds_since_epoch).strftime('%Y-%m-%dT%l:%M:%S%z').to_s
+      if datestring.include?('Date')
+        seconds_since_epoch = datestring.scan(/[0-9]+/)[0].to_i / 1000.0
+        Time.at(seconds_since_epoch).utc.strftime('%Y-%m-%dT%H:%M:%S%z').to_s
+      else # handle date 'types' for small subset of payroll API's
+        Time.parse(datestring).strftime('%Y-%m-%dT%H:%M:%S').to_s
+      end
     end
   end
 end

data/lib/xero-ruby/models/accounting/accounts_receivable.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.8.0
 Contact: api@xero.com
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 4.3.1
@@ -181,12 +180,13 @@ module XeroRuby::Accounting
 
     # Returns the object in the form of hash
     # @return [Hash] Returns the object in the form of hash
-    def to_hash
+    def to_hash(downcase: true)
       hash = {}
       self.class.attribute_map.each_pair do |attr, param|
         value = self.send(attr)
         next if value.nil?
-        hash[param] = _to_hash(value)
+        key = downcase ? attr : param
+        hash[key] = _to_hash(value)
       end
       hash
     end
@@ -209,10 +209,13 @@ module XeroRuby::Accounting
       end
     end
 
-    # customized data_parser
     def parse_date(datestring)
-      seconds_since_epoch = datestring.scan(/[0-9]+/)[0].to_i / 1000.0
-      return Time.at(seconds_since_epoch).strftime('%Y-%m-%dT%l:%M:%S%z').to_s
+      if datestring.include?('Date')
+        seconds_since_epoch = datestring.scan(/[0-9]+/)[0].to_i / 1000.0
+        Time.at(seconds_since_epoch).utc.strftime('%Y-%m-%dT%H:%M:%S%z').to_s
+      else # handle date 'types' for small subset of payroll API's
+        Time.parse(datestring).strftime('%Y-%m-%dT%H:%M:%S').to_s
+      end
     end
   end
 end

data/lib/xero-ruby/models/accounting/action.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.8.0
 Contact: api@xero.com
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 4.3.1
@@ -217,12 +216,13 @@ module XeroRuby::Accounting
 
     # Returns the object in the form of hash
     # @return [Hash] Returns the object in the form of hash
-    def to_hash
+    def to_hash(downcase: true)
       hash = {}
       self.class.attribute_map.each_pair do |attr, param|
         value = self.send(attr)
         next if value.nil?
-        hash[param] = _to_hash(value)
+        key = downcase ? attr : param
+        hash[key] = _to_hash(value)
       end
       hash
     end
@@ -245,10 +245,13 @@ module XeroRuby::Accounting
       end
     end
 
-    # customized data_parser
     def parse_date(datestring)
-      seconds_since_epoch = datestring.scan(/[0-9]+/)[0].to_i / 1000.0
-      return Time.at(seconds_since_epoch).strftime('%Y-%m-%dT%l:%M:%S%z').to_s
+      if datestring.include?('Date')
+        seconds_since_epoch = datestring.scan(/[0-9]+/)[0].to_i / 1000.0
+        Time.at(seconds_since_epoch).utc.strftime('%Y-%m-%dT%H:%M:%S%z').to_s
+      else # handle date 'types' for small subset of payroll API's
+        Time.parse(datestring).strftime('%Y-%m-%dT%H:%M:%S').to_s
+      end
     end
   end
 end

data/lib/xero-ruby/models/accounting/actions.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.8.0
 Contact: api@xero.com
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 4.3.1
@@ -173,12 +172,13 @@ module XeroRuby::Accounting
 
     # Returns the object in the form of hash
     # @return [Hash] Returns the object in the form of hash
-    def to_hash
+    def to_hash(downcase: true)
       hash = {}
       self.class.attribute_map.each_pair do |attr, param|
         value = self.send(attr)
         next if value.nil?
-        hash[param] = _to_hash(value)
+        key = downcase ? attr : param
+        hash[key] = _to_hash(value)
       end
       hash
     end
@@ -201,10 +201,13 @@ module XeroRuby::Accounting
       end
     end
 
-    # customized data_parser
     def parse_date(datestring)
-      seconds_since_epoch = datestring.scan(/[0-9]+/)[0].to_i / 1000.0
-      return Time.at(seconds_since_epoch).strftime('%Y-%m-%dT%l:%M:%S%z').to_s
+      if datestring.include?('Date')
+        seconds_since_epoch = datestring.scan(/[0-9]+/)[0].to_i / 1000.0
+        Time.at(seconds_since_epoch).utc.strftime('%Y-%m-%dT%H:%M:%S%z').to_s
+      else # handle date 'types' for small subset of payroll API's
+        Time.parse(datestring).strftime('%Y-%m-%dT%H:%M:%S').to_s
+      end
     end
   end
 end