xero-ruby 6.0.0 → 8.0.0

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

@@ -0,0 +1,253 @@
+=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
+  # Pagination information
+  require 'bigdecimal'
+
+  class PageInfo
+
+    attr_accessor :page
+    
+
+    attr_accessor :page_size
+    
+
+    attr_accessor :total_pages
+    
+
+    attr_accessor :total_rows
+    
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'page' => :'Page',
+        :'page_size' => :'PageSize',
+        :'total_pages' => :'TotalPages',
+        :'total_rows' => :'TotalRows'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'page' => :'Integer',
+        :'page_size' => :'Integer',
+        :'total_pages' => :'Integer',
+        :'total_rows' => :'Integer'
+      }
+    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::PageInfo` 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::PageInfo`. 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?(:'page')
+        self.page = attributes[:'page']
+      end
+
+      if attributes.key?(:'page_size')
+        self.page_size = attributes[:'page_size']
+      end
+
+      if attributes.key?(:'total_pages')
+        self.total_pages = attributes[:'total_pages']
+      end
+
+      if attributes.key?(:'total_rows')
+        self.total_rows = attributes[:'total_rows']
+      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 &&
+          page == o.page &&
+          page_size == o.page_size &&
+          total_pages == o.total_pages &&
+          total_rows == o.total_rows
+    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
+      [page, page_size, total_pages, total_rows].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/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/data_source_response.rb

@@ -16,49 +16,49 @@ module XeroRuby::Finance
   require 'bigdecimal'
 
   class DataSourceResponse
-    # Sum of the amounts of all statement lines where the source of the data was a direct bank feed in to Xero.   This gives an indication on the certainty of correctness of the data.
+    # Sum of the amounts of all statement lines where the source of the data was a direct bank feed in to Xero via an API integration.   This could be from a bank or aggregator.   This gives an indication on the certainty of correctness of the data.
     attr_accessor :direct_bank_feed
     
-    # Sum of the amounts of all statement lines where the source of the data was a indirect bank feed to Xero (usually via Yodlee).   This gives an indication on the certainty of correctness of the data.
+    # No longer in use.
     attr_accessor :indirect_bank_feed
     
-    # Sum of the amounts of all statement lines where the source of the data was a CSV file upload in to Xero.   This gives an indication on the certainty of correctness of the data.
+    # Sum of the amounts of all statement lines where the source of the data was a file manually uploaded in to Xero.   This gives an indication on the certainty of correctness of the data.
     attr_accessor :file_upload
     
-    # Sum of the amounts of all statement lines where the source of the data was manually keyed in to Xero.   This gives an indication on the certainty of correctness of the data.
+    # Sum of the amounts of all statement lines where the source of the data was manually input in to Xero.   This gives an indication on the certainty of correctness of the data.
     attr_accessor :manual
     
-    # Sum of the amounts of all statement lines where the source of the data was a direct bank feed in to Xero.  This gives an indication on the certainty of correctness of the data.  Only positive transactions are included.
+    # Sum of the amounts of all statement lines where the source of the data was a direct bank feed in to Xero via an API integration.   This could be from a bank or aggregator.  This gives an indication on the certainty of correctness of the data.  Only positive transactions are included.
     attr_accessor :direct_bank_feed_pos
     
-    # Sum of the amounts of all statement lines where the source of the data was a indirect bank feed to Xero (usually via Yodlee).   This gives an indication on the certainty of correctness of the data. Only positive transactions are included.
+    # No longer in use.
     attr_accessor :indirect_bank_feed_pos
     
-    # Sum of the amounts of all statement lines where the source of the data was a CSV file upload in to Xero.   This gives an indication on the certainty of correctness of the data. Only positive transactions are included.
+    # Sum of the amounts of all statement lines where the source of the data was a file manually uploaded in to Xero.   This gives an indication on the certainty of correctness of the data. Only positive transactions are included.
     attr_accessor :file_upload_pos
     
-    # Sum of the amounts of all statement lines where the source of the data was manually keyed in to Xero.   This gives an indication on the certainty of correctness of the data. Only positive transactions are included.
+    # Sum of the amounts of all statement lines where the source of the data was manually input in to Xero.   This gives an indication on the certainty of correctness of the data. Only positive transactions are included.
     attr_accessor :manual_pos
     
-    # Sum of the amounts of all statement lines where the source of the data was a direct bank feed in to Xero.   This gives an indication on the certainty of correctness of the data.  Only negative transactions are included.
+    # Sum of the amounts of all statement lines where the source of the data was a direct bank feed in to Xero via an API integration.   This could be from a bank or aggregator.   This gives an indication on the certainty of correctness of the data.  Only negative transactions are included.
     attr_accessor :direct_bank_feed_neg
     
-    # Sum of the amounts of all statement lines where the source of the data was a indirect bank feed to Xero (usually via Yodlee).   This gives an indication on the certainty of correctness of the data.  Only negative transactions are included.
+    # No longer in use.
     attr_accessor :indirect_bank_feed_neg
     
-    # Sum of the amounts of all statement lines where the source of the data was a CSV file upload in to Xero.   This gives an indication on the certainty of correctness of the data.  Only negative transactions are included.
+    # Sum of the amounts of all statement lines where the source of the data was a file manually uploaded in to Xero.   This gives an indication on the certainty of correctness of the data.  Only negative transactions are included.
     attr_accessor :file_upload_neg
     
-    # Sum of the amounts of all statement lines where the source of the data was manually keyed in to Xero.   This gives an indication on the certainty of correctness of the data.  Only negative transactions are included.
+    # Sum of the amounts of all statement lines where the source of the data was manually input in to Xero.   This gives an indication on the certainty of correctness of the data.  Only negative transactions are included.
     attr_accessor :manual_neg
     
-    # Sum of the amounts of all statement lines where the source of the data was any other category.   This gives an indication on the certainty of correctness of the data.  Only positive transactions are included.
+    # Sum of the amounts of all statement lines where the source of the data was unknown.   This gives an indication on the certainty of correctness of the data.  Only positive transactions are included.
     attr_accessor :other_pos
     
-    # Sum of the amounts of all statement lines where the source of the data was any other category.   This gives an indication on the certainty of correctness of the data.  Only negative transactions are included.
+    # Sum of the amounts of all statement lines where the source of the data was unknown.   This gives an indication on the certainty of correctness of the data.  Only negative transactions are included.
     attr_accessor :other_neg
     
-    # Sum of the amounts of all statement lines where the source of the data was any other category.   This gives an indication on the certainty of correctness of the data.
+    # Sum of the amounts of all statement lines where the source of the data was unknown.   This gives an indication on the certainty of correctness of the data.
     attr_accessor :other
     
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/xero-ruby/version.rb

@@ -7,9 +7,9 @@ Contact: api@xero.com
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 4.3.1
 
-The version of the XeroOpenAPI document: 3.0.3
+The version of the XeroOpenAPI document: 5.0.0
 =end
 
 module XeroRuby
-  VERSION = '6.0.0'
+  VERSION = '8.0.0'
 end

data/lib/xero-ruby.rb

@@ -453,6 +453,15 @@ require 'xero-ruby/models/accounting/error'
 require 'xero-ruby/models/accounting/expense_claim'
 require 'xero-ruby/models/accounting/expense_claims'
 require 'xero-ruby/models/accounting/external_link'
+require 'xero-ruby/models/accounting/get_bank_transactions_response'
+require 'xero-ruby/models/accounting/get_contacts_response'
+require 'xero-ruby/models/accounting/get_credit_notes_response'
+require 'xero-ruby/models/accounting/get_invoices_response'
+require 'xero-ruby/models/accounting/get_manual_journals_response'
+require 'xero-ruby/models/accounting/get_overpayments_response'
+require 'xero-ruby/models/accounting/get_payments_response'
+require 'xero-ruby/models/accounting/get_prepayments_response'
+require 'xero-ruby/models/accounting/get_purchase_orders_response'
 require 'xero-ruby/models/accounting/history_record'
 require 'xero-ruby/models/accounting/history_records'
 require 'xero-ruby/models/accounting/import_summary'
@@ -483,6 +492,7 @@ require 'xero-ruby/models/accounting/organisation'
 require 'xero-ruby/models/accounting/organisations'
 require 'xero-ruby/models/accounting/overpayment'
 require 'xero-ruby/models/accounting/overpayments'
+require 'xero-ruby/models/accounting/page_info'
 require 'xero-ruby/models/accounting/payment'
 require 'xero-ruby/models/accounting/payment_delete'
 require 'xero-ruby/models/accounting/payment_service'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: xero-ruby
 version: !ruby/object:Gem::Version
-  version: 6.0.0
+  version: 8.0.0
 platform: ruby
 authors:
 - Xero API Team
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-05-07 00:00:00.000000000 Z
+date: 2024-07-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -166,6 +166,15 @@ files:
 - lib/xero-ruby/models/accounting/expense_claim.rb
 - lib/xero-ruby/models/accounting/expense_claims.rb
 - lib/xero-ruby/models/accounting/external_link.rb
+- lib/xero-ruby/models/accounting/get_bank_transactions_response.rb
+- lib/xero-ruby/models/accounting/get_contacts_response.rb
+- lib/xero-ruby/models/accounting/get_credit_notes_response.rb
+- lib/xero-ruby/models/accounting/get_invoices_response.rb
+- lib/xero-ruby/models/accounting/get_manual_journals_response.rb
+- lib/xero-ruby/models/accounting/get_overpayments_response.rb
+- lib/xero-ruby/models/accounting/get_payments_response.rb
+- lib/xero-ruby/models/accounting/get_prepayments_response.rb
+- lib/xero-ruby/models/accounting/get_purchase_orders_response.rb
 - lib/xero-ruby/models/accounting/history_record.rb
 - lib/xero-ruby/models/accounting/history_records.rb
 - lib/xero-ruby/models/accounting/import_summary.rb
@@ -196,6 +205,7 @@ files:
 - lib/xero-ruby/models/accounting/organisations.rb
 - lib/xero-ruby/models/accounting/overpayment.rb
 - lib/xero-ruby/models/accounting/overpayments.rb
+- lib/xero-ruby/models/accounting/page_info.rb
 - lib/xero-ruby/models/accounting/payment.rb
 - lib/xero-ruby/models/accounting/payment_delete.rb
 - lib/xero-ruby/models/accounting/payment_service.rb