xero-ruby 3.9.0 → 7.0.0

data/lib/xero-ruby/models/app_store/usage_records_list.rb

@@ -0,0 +1,230 @@
+=begin
+#Xero AppStore API
+
+#These endpoints are for Xero Partners to interact with the App Store Billing platform
+
+Contact: api@xero.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.3.1
+
+=end
+
+require 'time'
+require 'date'
+
+module XeroRuby::AppStore
+  # Response to get usage record
+  require 'bigdecimal'
+
+  class UsageRecordsList
+    # A collection of usage records
+    attr_accessor :usage_records
+    
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'usage_records' => :'usageRecords'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'usage_records' => :'Array<UsageRecord>'
+      }
+    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::AppStore::UsageRecordsList` 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::AppStore::UsageRecordsList`. 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?(:'usage_records')
+        if (value = attributes[:'usage_records']).is_a?(Array)
+          self.usage_records = value
+        end
+      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
+      if @usage_records.nil?
+        invalid_properties.push('invalid value for "usage_records", usage_records cannot be nil.')
+      end
+
+      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?
+      return false if @usage_records.nil?
+      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 &&
+          usage_records == o.usage_records
+    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
+      [usage_records].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::AppStore.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/files/association.rb

@@ -16,6 +16,15 @@ module XeroRuby::Files
   require 'bigdecimal'
 
   class Association
+    # Boolean flag to determines whether the file is sent with the document it is attached to on client facing communications. Note- The SendWithObject element is only returned when using /Associations/{ObjectId} endpoint.
+    attr_accessor :send_with_object
+    
+    # The name of the associated file. Note- The Name element is only returned when using /Associations/{ObjectId} endpoint.
+    attr_accessor :name
+    
+    # The size of the associated file in bytes. Note- The Size element is only returned when using /Associations/{ObjectId} endpoint.
+    attr_accessor :size
+    
     # The unique identifier of the file
     attr_accessor :file_id
     
@@ -31,6 +40,9 @@ module XeroRuby::Files
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
+        :'send_with_object' => :'SendWithObject',
+        :'name' => :'Name',
+        :'size' => :'Size',
         :'file_id' => :'FileId',
         :'object_id' => :'ObjectId',
         :'object_group' => :'ObjectGroup',
@@ -41,6 +53,9 @@ module XeroRuby::Files
     # Attribute type mapping.
     def self.openapi_types
       {
+        :'send_with_object' => :'Boolean',
+        :'name' => :'String',
+        :'size' => :'Integer',
         :'file_id' => :'String',
         :'object_id' => :'String',
         :'object_group' => :'ObjectGroup',
@@ -63,6 +78,18 @@ module XeroRuby::Files
         h[k.to_sym] = v
       }
 
+      if attributes.key?(:'send_with_object')
+        self.send_with_object = attributes[:'send_with_object']
+      end
+
+      if attributes.key?(:'name')
+        self.name = attributes[:'name']
+      end
+
+      if attributes.key?(:'size')
+        self.size = attributes[:'size']
+      end
+
       if attributes.key?(:'file_id')
         self.file_id = attributes[:'file_id']
       end
@@ -98,6 +125,9 @@ module XeroRuby::Files
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
+          send_with_object == o.send_with_object &&
+          name == o.name &&
+          size == o.size &&
           file_id == o.file_id &&
           object_id == o.object_id &&
           object_group == o.object_group &&
@@ -113,7 +143,7 @@ module XeroRuby::Files
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [file_id, object_id, object_group, object_type].hash
+      [send_with_object, name, size, file_id, object_id, object_group, object_type].hash
     end
 
     # Builds the object from hash

data/lib/xero-ruby/models/finance/problem_type.rb

@@ -24,6 +24,7 @@ module XeroRuby::Finance
     REQUEST_TIMEOUT ||= "request-timeout".freeze
     SERVICE_UNAVAILABLE ||= "service-unavailable".freeze
     UNAUTHORIZED ||= "unauthorized".freeze
+    RATE_LIMIT_ERROR ||= "rate-limit-error".freeze
 
     # Builds the enum from string
     # @param [String] The enum value in the form of the string

data/lib/xero-ruby/models/finance/statement_line_response.rb

@@ -22,6 +22,9 @@ module XeroRuby::Finance
     # Date of when statement line was posted
     attr_accessor :posted_date
     
+    # Payee description of statement line
+    attr_accessor :payee
+    
     # Reference description of statement line
     attr_accessor :reference
     
@@ -60,6 +63,7 @@ module XeroRuby::Finance
       {
         :'statement_line_id' => :'statementLineId',
         :'posted_date' => :'postedDate',
+        :'payee' => :'payee',
         :'reference' => :'reference',
         :'notes' => :'notes',
         :'cheque_no' => :'chequeNo',
@@ -79,6 +83,7 @@ module XeroRuby::Finance
       {
         :'statement_line_id' => :'String',
         :'posted_date' => :'Date',
+        :'payee' => :'String',
         :'reference' => :'String',
         :'notes' => :'String',
         :'cheque_no' => :'String',
@@ -116,6 +121,10 @@ module XeroRuby::Finance
         self.posted_date = attributes[:'posted_date']
       end
 
+      if attributes.key?(:'payee')
+        self.payee = attributes[:'payee']
+      end
+
       if attributes.key?(:'reference')
         self.reference = attributes[:'reference']
       end
@@ -185,6 +194,7 @@ module XeroRuby::Finance
       self.class == o.class &&
           statement_line_id == o.statement_line_id &&
           posted_date == o.posted_date &&
+          payee == o.payee &&
           reference == o.reference &&
           notes == o.notes &&
           cheque_no == o.cheque_no &&
@@ -207,7 +217,7 @@ module XeroRuby::Finance
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [statement_line_id, posted_date, reference, notes, cheque_no, amount, transaction_date, type, is_reconciled, is_duplicate, is_deleted, payments, bank_transactions].hash
+      [statement_line_id, posted_date, payee, reference, notes, cheque_no, amount, transaction_date, type, is_reconciled, is_duplicate, is_deleted, payments, bank_transactions].hash
     end
 
     # Builds the object from hash

data/lib/xero-ruby/models/finance/statement_response.rb

@@ -28,15 +28,21 @@ module XeroRuby::Finance
     # Utc date time of when the statement was imported in Xero
     attr_accessor :imported_date_time_utc
     
-    # Indicates the source of the statement data. Either imported from 1) direct bank feed OR 2) manual customer entry or upload. Manual import sources are STMTIMPORTSRC/MANUAL, STMTIMPORTSRC/CSV, STMTIMPORTSRC/OFX, Ofx or STMTIMPORTSRC/QIF. All other import sources are direct and, depending on the direct solution, may contain the name of the financial institution.
+    # Identifies where the statement data in Xero was sourced, 1) direct bank feed, automatically loaded from the bank (eg STMTIMPORTSRC/CBAFEED); 2) indirect bank feed, automatically loaded from a 3rd party provider (eg STMTIMPORTSRC/YODLEE); 3) manually uploaded bank feed (eg STMTIMPORTSRC/CSV) or 4) manually entered statement data (STMTIMPORTSRC/MANUAL).
     attr_accessor :import_source
     
-    # Opening balance sourced from imported bank statements (if supplied). Note, for manually uploaded statements, this balance is also manual and usually not supplied.
+    # Opening balance sourced from imported bank statements (if supplied). Note, for manually uploaded statements, this balance is also manual and usually not supplied. Where not supplied, the value will be 0.
     attr_accessor :start_balance
     
-    # Closing balance sourced from imported bank statements (if supplied). Note, for manually uploaded statements, this balance is also manual and usually not supplied.
+    # Closing balance sourced from imported bank statements (if supplied). Note, for manually uploaded statements, this balance is also manual and usually not supplied. Where not supplied, the value will be 0.
     attr_accessor :end_balance
     
+    # Opening statement balance calculated in Xero (= bank account conversion balance plus sum of imported bank statement lines). Note: If indicative statement balance doesn't match imported statement balance for the same date, either the conversion (opening at inception) balance in Xero is wrong or there's an error in the bank statement lines in Xero. Ref: https://central.xero.com/s/article/Compare-the-statement-balance-in-Xero-to-your-actual-bank-balance?userregion=true 
+    attr_accessor :indicative_start_balance
+    
+    # Closing statement balance calculated in Xero (= bank account conversion balance plus sum of imported bank statement lines). Note: If indicative statement balance doesn't match imported statement balance for the same date, either the conversion (opening at inception) balance in Xero is wrong or there's an error in the bank statement lines in Xero. Ref: https://central.xero.com/s/article/Compare-the-statement-balance-in-Xero-to-your-actual-bank-balance?userregion=true  
+    attr_accessor :indicative_end_balance
+    
     # List of statement lines
     attr_accessor :statement_lines
     
@@ -50,6 +56,8 @@ module XeroRuby::Finance
         :'import_source' => :'importSource',
         :'start_balance' => :'startBalance',
         :'end_balance' => :'endBalance',
+        :'indicative_start_balance' => :'indicativeStartBalance',
+        :'indicative_end_balance' => :'indicativeEndBalance',
         :'statement_lines' => :'statementLines'
       }
     end
@@ -64,6 +72,8 @@ module XeroRuby::Finance
         :'import_source' => :'String',
         :'start_balance' => :'BigDecimal',
         :'end_balance' => :'BigDecimal',
+        :'indicative_start_balance' => :'BigDecimal',
+        :'indicative_end_balance' => :'BigDecimal',
         :'statement_lines' => :'Array<StatementLineResponse>'
       }
     end
@@ -111,6 +121,14 @@ module XeroRuby::Finance
         self.end_balance = attributes[:'end_balance']
       end
 
+      if attributes.key?(:'indicative_start_balance')
+        self.indicative_start_balance = attributes[:'indicative_start_balance']
+      end
+
+      if attributes.key?(:'indicative_end_balance')
+        self.indicative_end_balance = attributes[:'indicative_end_balance']
+      end
+
       if attributes.key?(:'statement_lines')
         if (value = attributes[:'statement_lines']).is_a?(Array)
           self.statement_lines = value
@@ -143,6 +161,8 @@ module XeroRuby::Finance
           import_source == o.import_source &&
           start_balance == o.start_balance &&
           end_balance == o.end_balance &&
+          indicative_start_balance == o.indicative_start_balance &&
+          indicative_end_balance == o.indicative_end_balance &&
           statement_lines == o.statement_lines
     end
 
@@ -155,7 +175,7 @@ module XeroRuby::Finance
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [statement_id, start_date, end_date, imported_date_time_utc, import_source, start_balance, end_balance, statement_lines].hash
+      [statement_id, start_date, end_date, imported_date_time_utc, import_source, start_balance, end_balance, indicative_start_balance, indicative_end_balance, statement_lines].hash
     end
 
     # Builds the object from hash

data/lib/xero-ruby/models/payroll_au/allowance_type.rb

@@ -20,7 +20,6 @@ module XeroRuby::PayrollAu
     MEALS ||= "MEALS".freeze
     TRAVEL ||= "TRAVEL".freeze
     OTHER ||= "OTHER".freeze
-    JOBKEEPER ||= "JOBKEEPER".freeze
     TOOLS ||= "TOOLS".freeze
     TASKS ||= "TASKS".freeze
     QUALIFICATIONS ||= "QUALIFICATIONS".freeze