xero-ruby 1.1.0 → 5.0.0

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

@@ -0,0 +1,243 @@
+=begin
+#Xero Accounting API
+
+#No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+Contact: api@xero.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.3.1
+
+=end
+
+require 'time'
+require 'date'
+
+module XeroRuby::Accounting
+  # An array to specify multiple currency balances of an account
+  require 'bigdecimal'
+
+  class BalanceDetails
+    # The opening balances of the account. Debits are positive, credits are negative values
+    attr_accessor :balance
+    
+    # The currency of the balance (Not required for base currency)
+    attr_accessor :currency_code
+    
+    # (Optional) Exchange rate to base currency when money is spent or received. If not specified, XE rate for the day is applied
+    attr_accessor :currency_rate
+    
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'balance' => :'Balance',
+        :'currency_code' => :'CurrencyCode',
+        :'currency_rate' => :'CurrencyRate'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'balance' => :'Float',
+        :'currency_code' => :'String',
+        :'currency_rate' => :'BigDecimal'
+      }
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `XeroRuby::Accounting::BalanceDetails` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!self.class.attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `XeroRuby::Accounting::BalanceDetails`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'balance')
+        self.balance = attributes[:'balance']
+      end
+
+      if attributes.key?(:'currency_code')
+        self.currency_code = attributes[:'currency_code']
+      end
+
+      if attributes.key?(:'currency_rate')
+        self.currency_rate = attributes[:'currency_rate']
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      true
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          balance == o.balance &&
+          currency_code == o.currency_code &&
+          currency_rate == o.currency_rate
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [balance, currency_code, currency_rate].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      new.build_from_hash(attributes)
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      self.class.openapi_types.each_pair do |key, type|
+        if type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        end # or else data not found in attributes(hash), not an issue as the data can be optional
+      end
+
+      self
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def _deserialize(type, value)
+      case type.to_sym
+      when :DateTime
+        DateTime.parse(parse_date(value))
+      when :Date
+        Date.parse(parse_date(value))
+      when :String
+        value.to_s
+      when :Integer
+        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
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        XeroRuby::Accounting.const_get(type).build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash(downcase: false)
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        next if value.nil?
+        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, downcase: false)
+      if value.is_a?(Array)
+        value.map do |v|
+          v.to_hash(downcase: downcase)
+        end
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.map { |k, v| hash[k] = _to_hash(v, downcase: downcase) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash(downcase: downcase)
+      else
+        value
+      end
+    end
+
+    def parse_date(datestring)
+      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/balances.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,11 +14,15 @@ require 'date'
 
 module XeroRuby::Accounting
   # The raw AccountsReceivable(sales invoices) and AccountsPayable(bills) outstanding and overdue amounts, not converted to base currency (read only)
+  require 'bigdecimal'
+
   class Balances
+
     attr_accessor :accounts_receivable
+    
 
     attr_accessor :accounts_payable
-
+    
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -137,6 +140,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
@@ -176,38 +181,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/bank_transaction.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,69 +13,86 @@ require 'time'
 require 'date'
 
 module XeroRuby::Accounting
+  require 'bigdecimal'
+
   class BankTransaction
     # See Bank Transaction Types
     attr_accessor :type
+    RECEIVE ||= "RECEIVE".freeze
+    RECEIVE_OVERPAYMENT ||= "RECEIVE-OVERPAYMENT".freeze
+    RECEIVE_PREPAYMENT ||= "RECEIVE-PREPAYMENT".freeze
+    SPEND ||= "SPEND".freeze
+    SPEND_OVERPAYMENT ||= "SPEND-OVERPAYMENT".freeze
+    SPEND_PREPAYMENT ||= "SPEND-PREPAYMENT".freeze
+    RECEIVE_TRANSFER ||= "RECEIVE-TRANSFER".freeze
+    SPEND_TRANSFER ||= "SPEND-TRANSFER".freeze
+    
 
     attr_accessor :contact
-
+    
     # See LineItems
     attr_accessor :line_items
+    
 
     attr_accessor :bank_account
-
+    
     # Boolean to show if transaction is reconciled
     attr_accessor :is_reconciled
-
+    
     # Date of transaction – YYYY-MM-DD
     attr_accessor :date
-
+    
     # Reference for the transaction. Only supported for SPEND and RECEIVE transactions.
     attr_accessor :reference
+    
 
     attr_accessor :currency_code
-
+    
     # Exchange rate to base currency when money is spent or received. e.g.0.7500 Only used for bank transactions in non base currency. If this isn’t specified for non base currency accounts then either the user-defined rate (preference) or the XE.com day rate will be used. Setting currency is only supported on overpayments.
     attr_accessor :currency_rate
-
+    
     # URL link to a source document – shown as “Go to App Name”
     attr_accessor :url
-
+    
     # See Bank Transaction Status Codes
     attr_accessor :status
+    AUTHORISED ||= "AUTHORISED".freeze
+    DELETED ||= "DELETED".freeze
+    VOIDED ||= "VOIDED".freeze
+    
 
     attr_accessor :line_amount_types
-
+    
     # Total of bank transaction excluding taxes
     attr_accessor :sub_total
-
+    
     # Total tax on bank transaction
     attr_accessor :total_tax
-
+    
     # Total of bank transaction tax inclusive
     attr_accessor :total
-
+    
     # Xero generated unique identifier for bank transaction
     attr_accessor :bank_transaction_id
-
+    
     # Xero generated unique identifier for a Prepayment. This will be returned on BankTransactions with a Type of SPEND-PREPAYMENT or RECEIVE-PREPAYMENT
     attr_accessor :prepayment_id
-
+    
     # Xero generated unique identifier for an Overpayment. This will be returned on BankTransactions with a Type of SPEND-OVERPAYMENT or RECEIVE-OVERPAYMENT
     attr_accessor :overpayment_id
-
+    
     # Last modified date UTC format
     attr_accessor :updated_date_utc
-
+    
     # Boolean to indicate if a bank transaction has an attachment
     attr_accessor :has_attachments
-
+    
     # A string to indicate if a invoice status
     attr_accessor :status_attribute_string
-
+    
     # Displays array of validation error messages from the API
     attr_accessor :validation_errors
-
+    
     class EnumAttributeValidator
       attr_reader :datatype
       attr_reader :allowable_values
@@ -138,13 +154,13 @@ module XeroRuby::Accounting
         :'date' => :'Date',
         :'reference' => :'String',
         :'currency_code' => :'CurrencyCode',
-        :'currency_rate' => :'Float',
+        :'currency_rate' => :'BigDecimal',
         :'url' => :'String',
         :'status' => :'String',
         :'line_amount_types' => :'LineAmountTypes',
-        :'sub_total' => :'Float',
-        :'total_tax' => :'Float',
-        :'total' => :'Float',
+        :'sub_total' => :'BigDecimal',
+        :'total_tax' => :'BigDecimal',
+        :'total' => :'BigDecimal',
         :'bank_transaction_id' => :'String',
         :'prepayment_id' => :'String',
         :'overpayment_id' => :'String',
@@ -273,10 +289,6 @@ module XeroRuby::Accounting
         invalid_properties.push('invalid value for "type", type cannot be nil.')
       end
 
-      if @contact.nil?
-        invalid_properties.push('invalid value for "contact", contact cannot be nil.')
-      end
-
       if @line_items.nil?
         invalid_properties.push('invalid value for "line_items", line_items cannot be nil.')
       end
@@ -294,7 +306,6 @@ module XeroRuby::Accounting
       return false if @type.nil?
       type_validator = EnumAttributeValidator.new('String', ["RECEIVE", "RECEIVE-OVERPAYMENT", "RECEIVE-PREPAYMENT", "SPEND", "SPEND-OVERPAYMENT", "SPEND-PREPAYMENT", "RECEIVE-TRANSFER", "SPEND-TRANSFER"])
       return false unless type_validator.valid?(@type)
-      return false if @contact.nil?
       return false if @line_items.nil?
       return false if @bank_account.nil?
       status_validator = EnumAttributeValidator.new('String', ["AUTHORISED", "DELETED", "VOIDED"])
@@ -406,6 +417,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
@@ -445,38 +458,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/bank_transactions.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 BankTransactions
-    attr_accessor :bank_transactions
 
+    attr_accessor :bank_transactions
+    
     # 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