xero-ruby 1.1.0 → 5.0.0

data/lib/xero-ruby/configuration.rb

@@ -1,12 +1,11 @@
 =begin
-#Accounting API
+#Xero Accounting API
 
 #No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
 
-The version of the OpenAPI document: 2.1.3
 Contact: api@xero.com
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 4.3.0
+OpenAPI Generator version: 4.3.1
 
 =end
 
@@ -29,6 +28,13 @@ module XeroRuby
     # Defines base paths for seperate API's
     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
+    attr_accessor :app_store_url
+    attr_accessor :finance_url
 
     # Defines API keys used with API Key authentications.
     #
@@ -56,8 +62,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
@@ -123,9 +132,6 @@ module XeroRuby
 
     # Set this to customize parameters encoding of array parameter with multi collectionFormat.
     # Default to nil.
-    #
-    # @see The params_encoding option of Ethon. Related source code:
-    # https://github.com/typhoeus/ethon/blob/master/lib/ethon/easy/queryable.rb#L96
     attr_accessor :params_encoding
 
     attr_accessor :inject_format
@@ -137,9 +143,18 @@ module XeroRuby
       @host = 'api.xero.com'
       @base_path = '/api.xro/2.0'
       @login_url = 'https://login.xero.com/identity/connect/authorize'
-      @token_url = 'https://identity.xero.com/connect/token'
+      @token_url = 'https://identity.xero.com/connect'
       @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/'
+      @app_store_url = 'https://api.xero.com/appstore/2.0/'
+      @finance_url = 'https://api.xero.com/finance.xro/1.0/'
+      @access_token = nil
+      @id_token = nil
       @api_key = {}
       @api_key_prefix = {}
       @timeout = 0
@@ -185,6 +200,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
@@ -219,7 +242,7 @@ module XeroRuby
       [
         {
           url: "https://api.xero.com/api.xro/2.0",
-          description: "Xero Accounting API servers",
+          description: "The Xero Accounting API exposes accounting and related functions of the main Xero application and can be used for a variety of purposes such as creating transactions like invoices and credit notes, right through to extracting accounting data via our reports endpoint.",
         }
       ]
     end

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

@@ -1,12 +1,11 @@
 =begin
-#Accounting API
+#Xero Accounting API
 
 #No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
 
-The version of the OpenAPI document: 2.1.3
 Contact: api@xero.com
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 4.3.0
+OpenAPI Generator version: 4.3.1
 
 =end
 
@@ -14,65 +13,103 @@ require 'time'
 require 'date'
 
 module XeroRuby::Accounting
+  require 'bigdecimal'
+
   class Account
     # Customer defined alpha numeric account code e.g 200 or SALES (max length = 10)
     attr_accessor :code
-
+    
     # Name of account (max length = 150)
     attr_accessor :name
-
+    
     # The Xero identifier for an account – specified as a string following  the endpoint name   e.g. /297c2dc5-cc47-4afd-8ec8-74990b8761e9
     attr_accessor :account_id
+    
 
     attr_accessor :type
-
+    
     # For bank accounts only (Account Type BANK)
     attr_accessor :bank_account_number
-
+    
     # Accounts with a status of ACTIVE can be updated to ARCHIVED. See Account Status Codes
     attr_accessor :status
-
+    ACTIVE ||= "ACTIVE".freeze
+    ARCHIVED ||= "ARCHIVED".freeze
+    DELETED ||= "DELETED".freeze
+    
     # Description of the Account. Valid for all types of accounts except bank accounts (max length = 4000)
     attr_accessor :description
-
+    
     # For bank accounts only. See Bank Account types
     attr_accessor :bank_account_type
+    BANK ||= "BANK".freeze
+    CREDITCARD ||= "CREDITCARD".freeze
+    PAYPAL ||= "PAYPAL".freeze
+    NONE ||= "NONE".freeze
+    EMPTY ||= "".freeze
+    
 
     attr_accessor :currency_code
-
-    # The tax type from TaxRates
+    
+    # The tax type from taxRates
     attr_accessor :tax_type
-
+    
     # Boolean – describes whether account can have payments applied to it
     attr_accessor :enable_payments_to_account
-
+    
     # Boolean – describes whether account code is available for use with expense claims
     attr_accessor :show_in_expense_claims
-
+    
     # See Account Class Types
     attr_accessor :_class
-
+    ASSET ||= "ASSET".freeze
+    EQUITY ||= "EQUITY".freeze
+    EXPENSE ||= "EXPENSE".freeze
+    LIABILITY ||= "LIABILITY".freeze
+    REVENUE ||= "REVENUE".freeze
+    
     # If this is a system account then this element is returned. See System Account types. Note that non-system accounts may have this element set as either “” or null.
     attr_accessor :system_account
-
+    DEBTORS ||= "DEBTORS".freeze
+    CREDITORS ||= "CREDITORS".freeze
+    BANKCURRENCYGAIN ||= "BANKCURRENCYGAIN".freeze
+    GST ||= "GST".freeze
+    GSTONIMPORTS ||= "GSTONIMPORTS".freeze
+    HISTORICAL ||= "HISTORICAL".freeze
+    REALISEDCURRENCYGAIN ||= "REALISEDCURRENCYGAIN".freeze
+    RETAINEDEARNINGS ||= "RETAINEDEARNINGS".freeze
+    ROUNDING ||= "ROUNDING".freeze
+    TRACKINGTRANSFERS ||= "TRACKINGTRANSFERS".freeze
+    UNPAIDEXPCLM ||= "UNPAIDEXPCLM".freeze
+    UNREALISEDCURRENCYGAIN ||= "UNREALISEDCURRENCYGAIN".freeze
+    WAGEPAYABLES ||= "WAGEPAYABLES".freeze
+    CISASSETS ||= "CISASSETS".freeze
+    CISASSET ||= "CISASSET".freeze
+    CISLABOUR ||= "CISLABOUR".freeze
+    CISLABOUREXPENSE ||= "CISLABOUREXPENSE".freeze
+    CISLABOURINCOME ||= "CISLABOURINCOME".freeze
+    CISLIABILITY ||= "CISLIABILITY".freeze
+    CISMATERIALS ||= "CISMATERIALS".freeze
+    EMPTY ||= "".freeze
+    
     # Shown if set
     attr_accessor :reporting_code
-
+    
     # Shown if set
     attr_accessor :reporting_code_name
-
+    
     # boolean to indicate if an account has an attachment (read only)
     attr_accessor :has_attachments
-
+    
     # Last modified date UTC format
     attr_accessor :updated_date_utc
-
+    
     # Boolean – describes whether the account is shown in the watchlist widget on the dashboard
     attr_accessor :add_to_watchlist
-
+    
     # Displays array of validation error messages from the API
     attr_accessor :validation_errors
-
+    
     class EnumAttributeValidator
       attr_reader :datatype
       attr_reader :allowable_values
@@ -251,10 +288,6 @@ module XeroRuby::Accounting
     # @return Array for valid properties with the reasons
     def list_invalid_properties
       invalid_properties = Array.new
-      if !@code.nil? && @code.to_s.length > 10
-        invalid_properties.push('invalid value for "code", the character length must be smaller than or equal to 10.')
-      end
-
       if !@name.nil? && @name.to_s.length > 150
         invalid_properties.push('invalid value for "name", the character length must be smaller than or equal to 150.')
       end
@@ -265,7 +298,6 @@ module XeroRuby::Accounting
     # Check to see if the all the properties in the model are valid
     # @return true if the model is valid
     def valid?
-      return false if !@code.nil? && @code.to_s.length > 10
       return false if !@name.nil? && @name.to_s.length > 150
       status_validator = EnumAttributeValidator.new('String', ["ACTIVE", "ARCHIVED", "DELETED"])
       return false unless status_validator.valid?(@status)
@@ -278,16 +310,6 @@ module XeroRuby::Accounting
       true
     end
 
-    # Custom attribute writer method with validation
-    # @param [Object] code Value to be assigned
-    def code=(code)
-      if !code.nil? && code.to_s.length > 10
-        fail ArgumentError, 'invalid value for "code", the character length must be smaller than or equal to 10.'
-      end
-
-      @code = code
-    end
-
     # Custom attribute writer method with validation
     # @param [Object] name Value to be assigned
     def name=(name)
@@ -420,6 +442,8 @@ module XeroRuby::Accounting
         value.to_i
       when :Float
         value.to_f
+      when :BigDecimal
+        BigDecimal(value.to_s)
       when :Boolean
         if value.to_s =~ /\A(true|t|yes|y|1)\z/i
           true
@@ -459,38 +483,53 @@ 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: false)
       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, downcase: downcase)
       end
       hash
     end
 
+    # Returns the object in the form of hash with snake_case
+    def to_attributes
+      to_hash(downcase: true)
+    end
+
     # Outputs non-array value in the form of hash
     # For object, use to_hash. Otherwise, just return the value
     # @param [Object] value Any valid value
     # @return [Hash] Returns the value in the form of hash
-    def _to_hash(value)
+    def _to_hash(value, downcase: false)
       if value.is_a?(Array)
-        value.compact.map { |v| _to_hash(v) }
+        value.map do |v|
+          v.to_hash(downcase: downcase)
+        end
       elsif value.is_a?(Hash)
         {}.tap do |hash|
-          value.each { |k, v| hash[k] = _to_hash(v) }
+          value.map { |k, v| hash[k] = _to_hash(v, downcase: downcase) }
         end
       elsif value.respond_to? :to_hash
-        value.to_hash
+        value.to_hash(downcase: downcase)
       else
         value
       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).to_s
+      if datestring.include?('Date')
+        date_pattern = /\/Date\((-?\d+)(\+\d+)?\)\//
+        original, date, timezone = *date_pattern.match(datestring)
+        date = (date.to_i / 1000)
+        Time.at(date).utc.strftime('%Y-%m-%dT%H:%M:%S%z').to_s
+      elsif /(\d\d\d\d)-(\d\d)/.match(datestring) # handles dates w/out Days: YYYY-MM*-DD
+        Time.parse(datestring + '-01').strftime('%Y-%m-%dT%H:%M:%S').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

@@ -1,12 +1,11 @@
 =begin
-#Accounting API
+#Xero Accounting API
 
 #No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
 
-The version of the OpenAPI document: 2.1.3
 Contact: api@xero.com
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 4.3.0
+OpenAPI Generator version: 4.3.1
 
 =end
 
@@ -15,28 +14,24 @@ require 'date'
 
 module XeroRuby::Accounting
   class AccountType
-    BANK = "BANK".freeze
-    CURRENT = "CURRENT".freeze
-    CURRLIAB = "CURRLIAB".freeze
-    DEPRECIATN = "DEPRECIATN".freeze
-    DIRECTCOSTS = "DIRECTCOSTS".freeze
-    EQUITY = "EQUITY".freeze
-    EXPENSE = "EXPENSE".freeze
-    FIXED = "FIXED".freeze
-    INVENTORY = "INVENTORY".freeze
-    LIABILITY = "LIABILITY".freeze
-    NONCURRENT = "NONCURRENT".freeze
-    OTHERINCOME = "OTHERINCOME".freeze
-    OVERHEADS = "OVERHEADS".freeze
-    PREPAYMENT = "PREPAYMENT".freeze
-    REVENUE = "REVENUE".freeze
-    SALES = "SALES".freeze
-    TERMLIAB = "TERMLIAB".freeze
-    PAYGLIABILITY = "PAYGLIABILITY".freeze
-    PAYG = "PAYG".freeze
-    SUPERANNUATIONEXPENSE = "SUPERANNUATIONEXPENSE".freeze
-    SUPERANNUATIONLIABILITY = "SUPERANNUATIONLIABILITY".freeze
-    WAGESEXPENSE = "WAGESEXPENSE".freeze
+    BANK ||= "BANK".freeze
+    CURRENT ||= "CURRENT".freeze
+    CURRLIAB ||= "CURRLIAB".freeze
+    DEPRECIATN ||= "DEPRECIATN".freeze
+    DIRECTCOSTS ||= "DIRECTCOSTS".freeze
+    EQUITY ||= "EQUITY".freeze
+    EXPENSE ||= "EXPENSE".freeze
+    FIXED ||= "FIXED".freeze
+    INVENTORY ||= "INVENTORY".freeze
+    LIABILITY ||= "LIABILITY".freeze
+    NONCURRENT ||= "NONCURRENT".freeze
+    OTHERINCOME ||= "OTHERINCOME".freeze
+    OVERHEADS ||= "OVERHEADS".freeze
+    PREPAYMENT ||= "PREPAYMENT".freeze
+    REVENUE ||= "REVENUE".freeze
+    SALES ||= "SALES".freeze
+    TERMLIAB ||= "TERMLIAB".freeze
+    PAYG ||= "PAYG".freeze
 
     # Builds the enum from string
     # @param [String] The enum value in the form of the string

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

@@ -1,12 +1,11 @@
 =begin
-#Accounting API
+#Xero Accounting API
 
 #No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
 
-The version of the OpenAPI document: 2.1.3
 Contact: api@xero.com
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 4.3.0
+OpenAPI Generator version: 4.3.1
 
 =end
 
@@ -14,9 +13,12 @@ require 'time'
 require 'date'
 
 module XeroRuby::Accounting
+  require 'bigdecimal'
+
   class Accounts
-    attr_accessor :accounts
 
+    attr_accessor :accounts
+    
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -129,6 +131,8 @@ module XeroRuby::Accounting
         value.to_i
       when :Float
         value.to_f
+      when :BigDecimal
+        BigDecimal(value.to_s)
       when :Boolean
         if value.to_s =~ /\A(true|t|yes|y|1)\z/i
           true
@@ -168,38 +172,53 @@ 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: false)
       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, downcase: downcase)
       end
       hash
     end
 
+    # Returns the object in the form of hash with snake_case
+    def to_attributes
+      to_hash(downcase: true)
+    end
+
     # Outputs non-array value in the form of hash
     # For object, use to_hash. Otherwise, just return the value
     # @param [Object] value Any valid value
     # @return [Hash] Returns the value in the form of hash
-    def _to_hash(value)
+    def _to_hash(value, downcase: false)
       if value.is_a?(Array)
-        value.compact.map { |v| _to_hash(v) }
+        value.map do |v|
+          v.to_hash(downcase: downcase)
+        end
       elsif value.is_a?(Hash)
         {}.tap do |hash|
-          value.each { |k, v| hash[k] = _to_hash(v) }
+          value.map { |k, v| hash[k] = _to_hash(v, downcase: downcase) }
         end
       elsif value.respond_to? :to_hash
-        value.to_hash
+        value.to_hash(downcase: downcase)
       else
         value
       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).to_s
+      if datestring.include?('Date')
+        date_pattern = /\/Date\((-?\d+)(\+\d+)?\)\//
+        original, date, timezone = *date_pattern.match(datestring)
+        date = (date.to_i / 1000)
+        Time.at(date).utc.strftime('%Y-%m-%dT%H:%M:%S%z').to_s
+      elsif /(\d\d\d\d)-(\d\d)/.match(datestring) # handles dates w/out Days: YYYY-MM*-DD
+        Time.parse(datestring + '-01').strftime('%Y-%m-%dT%H:%M:%S').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

@@ -1,12 +1,11 @@
 =begin
-#Accounting API
+#Xero Accounting API
 
 #No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
 
-The version of the OpenAPI document: 2.1.3
 Contact: api@xero.com
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 4.3.0
+OpenAPI Generator version: 4.3.1
 
 =end
 
@@ -14,11 +13,15 @@ require 'time'
 require 'date'
 
 module XeroRuby::Accounting
+  require 'bigdecimal'
+
   class AccountsPayable
+
     attr_accessor :outstanding
+    
 
     attr_accessor :overdue
-
+    
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -30,8 +33,8 @@ module XeroRuby::Accounting
     # Attribute type mapping.
     def self.openapi_types
       {
-        :'outstanding' => :'Float',
-        :'overdue' => :'Float'
+        :'outstanding' => :'BigDecimal',
+        :'overdue' => :'BigDecimal'
       }
     end
 
@@ -136,6 +139,8 @@ module XeroRuby::Accounting
         value.to_i
       when :Float
         value.to_f
+      when :BigDecimal
+        BigDecimal(value.to_s)
       when :Boolean
         if value.to_s =~ /\A(true|t|yes|y|1)\z/i
           true
@@ -175,38 +180,53 @@ 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: false)
       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, downcase: downcase)
       end
       hash
     end
 
+    # Returns the object in the form of hash with snake_case
+    def to_attributes
+      to_hash(downcase: true)
+    end
+
     # Outputs non-array value in the form of hash
     # For object, use to_hash. Otherwise, just return the value
     # @param [Object] value Any valid value
     # @return [Hash] Returns the value in the form of hash
-    def _to_hash(value)
+    def _to_hash(value, downcase: false)
       if value.is_a?(Array)
-        value.compact.map { |v| _to_hash(v) }
+        value.map do |v|
+          v.to_hash(downcase: downcase)
+        end
       elsif value.is_a?(Hash)
         {}.tap do |hash|
-          value.each { |k, v| hash[k] = _to_hash(v) }
+          value.map { |k, v| hash[k] = _to_hash(v, downcase: downcase) }
         end
       elsif value.respond_to? :to_hash
-        value.to_hash
+        value.to_hash(downcase: downcase)
       else
         value
       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).to_s
+      if datestring.include?('Date')
+        date_pattern = /\/Date\((-?\d+)(\+\d+)?\)\//
+        original, date, timezone = *date_pattern.match(datestring)
+        date = (date.to_i / 1000)
+        Time.at(date).utc.strftime('%Y-%m-%dT%H:%M:%S%z').to_s
+      elsif /(\d\d\d\d)-(\d\d)/.match(datestring) # handles dates w/out Days: YYYY-MM*-DD
+        Time.parse(datestring + '-01').strftime('%Y-%m-%dT%H:%M:%S').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