xero-ruby 1.1.0 → 5.0.0

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

@@ -0,0 +1,222 @@
+=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
+  require 'bigdecimal'
+
+  class ImportSummaryOrganisation
+
+    attr_accessor :present
+    
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'present' => :'Present'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'present' => :'Boolean'
+      }
+    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::ImportSummaryOrganisation` 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::ImportSummaryOrganisation`. 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?(:'present')
+        self.present = attributes[:'present']
+      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 &&
+          present == o.present
+    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
+      [present].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/invoice.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,118 +13,143 @@ require 'time'
 require 'date'
 
 module XeroRuby::Accounting
+  require 'bigdecimal'
+
   class Invoice
     # See Invoice Types
     attr_accessor :type
+    ACCPAY ||= "ACCPAY".freeze
+    ACCPAYCREDIT ||= "ACCPAYCREDIT".freeze
+    APOVERPAYMENT ||= "APOVERPAYMENT".freeze
+    APPREPAYMENT ||= "APPREPAYMENT".freeze
+    ACCREC ||= "ACCREC".freeze
+    ACCRECCREDIT ||= "ACCRECCREDIT".freeze
+    AROVERPAYMENT ||= "AROVERPAYMENT".freeze
+    ARPREPAYMENT ||= "ARPREPAYMENT".freeze
+    
 
     attr_accessor :contact
-
+    
     # See LineItems
     attr_accessor :line_items
-
+    
     # Date invoice was issued – YYYY-MM-DD. If the Date element is not specified it will default to the current date based on the timezone setting of the organisation
     attr_accessor :date
-
+    
     # Date invoice is due – YYYY-MM-DD
     attr_accessor :due_date
+    
 
     attr_accessor :line_amount_types
-
+    
     # ACCREC – Unique alpha numeric code identifying invoice (when missing will auto-generate from your Organisation Invoice Settings) (max length = 255)
     attr_accessor :invoice_number
-
-    # ACCREC only – additional reference number (max length = 255)
+    
+    # ACCREC only – additional reference number
     attr_accessor :reference
-
+    
     # See BrandingThemes
     attr_accessor :branding_theme_id
-
+    
     # URL link to a source document – shown as “Go to [appName]” in the Xero app
     attr_accessor :url
+    
 
     attr_accessor :currency_code
-
+    
     # The currency rate for a multicurrency invoice. If no rate is specified, the XE.com day rate is used. (max length = [18].[6])
     attr_accessor :currency_rate
-
+    
     # See Invoice Status Codes
     attr_accessor :status
-
+    DRAFT ||= "DRAFT".freeze
+    SUBMITTED ||= "SUBMITTED".freeze
+    DELETED ||= "DELETED".freeze
+    AUTHORISED ||= "AUTHORISED".freeze
+    PAID ||= "PAID".freeze
+    VOIDED ||= "VOIDED".freeze
+    
     # Boolean to set whether the invoice in the Xero app should be marked as “sent”. This can be set only on invoices that have been approved
     attr_accessor :sent_to_contact
-
+    
     # Shown on sales invoices (Accounts Receivable) when this has been set
     attr_accessor :expected_payment_date
-
+    
     # Shown on bills (Accounts Payable) when this has been set
     attr_accessor :planned_payment_date
-
+    
     # CIS deduction for UK contractors
     attr_accessor :cis_deduction
-
+    
+    # CIS Deduction rate for the organisation
+    attr_accessor :cis_rate
+    
     # Total of invoice excluding taxes
     attr_accessor :sub_total
-
+    
     # Total tax on invoice
     attr_accessor :total_tax
-
+    
     # Total of Invoice tax inclusive (i.e. SubTotal + TotalTax). This will be ignored if it doesn’t equal the sum of the LineAmounts
     attr_accessor :total
-
+    
     # Total of discounts applied on the invoice line items
     attr_accessor :total_discount
-
+    
     # Xero generated unique identifier for invoice
     attr_accessor :invoice_id
-
+    
+    # Xero generated unique identifier for repeating invoices
+    attr_accessor :repeating_invoice_id
+    
     # boolean to indicate if an invoice has an attachment
     attr_accessor :has_attachments
-
+    
     # boolean to indicate if an invoice has a discount
     attr_accessor :is_discounted
-
+    
     # See Payments
     attr_accessor :payments
-
+    
     # See Prepayments
     attr_accessor :prepayments
-
+    
     # See Overpayments
     attr_accessor :overpayments
-
+    
     # Amount remaining to be paid on invoice
     attr_accessor :amount_due
-
+    
     # Sum of payments received for invoice
     attr_accessor :amount_paid
-
+    
     # The date the invoice was fully paid. Only returned on fully paid invoices
     attr_accessor :fully_paid_on_date
-
+    
     # Sum of all credit notes, over-payments and pre-payments applied to invoice
     attr_accessor :amount_credited
-
+    
     # Last modified date UTC format
     attr_accessor :updated_date_utc
-
+    
     # Details of credit notes that have been applied to an invoice
     attr_accessor :credit_notes
-
+    
     # Displays array of attachments from the API
     attr_accessor :attachments
-
+    
     # A boolean to indicate if a invoice has an validation errors
     attr_accessor :has_errors
-
+    
     # 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
-
+    
     # Displays array of warning messages from the API
     attr_accessor :warnings
-
+    
     class EnumAttributeValidator
       attr_reader :datatype
       attr_reader :allowable_values
@@ -168,11 +192,13 @@ module XeroRuby::Accounting
         :'expected_payment_date' => :'ExpectedPaymentDate',
         :'planned_payment_date' => :'PlannedPaymentDate',
         :'cis_deduction' => :'CISDeduction',
+        :'cis_rate' => :'CISRate',
         :'sub_total' => :'SubTotal',
         :'total_tax' => :'TotalTax',
         :'total' => :'Total',
         :'total_discount' => :'TotalDiscount',
         :'invoice_id' => :'InvoiceID',
+        :'repeating_invoice_id' => :'RepeatingInvoiceID',
         :'has_attachments' => :'HasAttachments',
         :'is_discounted' => :'IsDiscounted',
         :'payments' => :'Payments',
@@ -206,26 +232,28 @@ module XeroRuby::Accounting
         :'branding_theme_id' => :'String',
         :'url' => :'String',
         :'currency_code' => :'CurrencyCode',
-        :'currency_rate' => :'Float',
+        :'currency_rate' => :'BigDecimal',
         :'status' => :'String',
         :'sent_to_contact' => :'Boolean',
         :'expected_payment_date' => :'Date',
         :'planned_payment_date' => :'Date',
-        :'cis_deduction' => :'Float',
-        :'sub_total' => :'Float',
-        :'total_tax' => :'Float',
-        :'total' => :'Float',
-        :'total_discount' => :'Float',
+        :'cis_deduction' => :'BigDecimal',
+        :'cis_rate' => :'BigDecimal',
+        :'sub_total' => :'BigDecimal',
+        :'total_tax' => :'BigDecimal',
+        :'total' => :'BigDecimal',
+        :'total_discount' => :'BigDecimal',
         :'invoice_id' => :'String',
+        :'repeating_invoice_id' => :'String',
         :'has_attachments' => :'Boolean',
         :'is_discounted' => :'Boolean',
         :'payments' => :'Array<Payment>',
         :'prepayments' => :'Array<Prepayment>',
         :'overpayments' => :'Array<Overpayment>',
-        :'amount_due' => :'Float',
-        :'amount_paid' => :'Float',
+        :'amount_due' => :'BigDecimal',
+        :'amount_paid' => :'BigDecimal',
         :'fully_paid_on_date' => :'Date',
-        :'amount_credited' => :'Float',
+        :'amount_credited' => :'BigDecimal',
         :'updated_date_utc' => :'DateTime',
         :'credit_notes' => :'Array<CreditNote>',
         :'attachments' => :'Array<Attachment>',
@@ -321,6 +349,10 @@ module XeroRuby::Accounting
         self.cis_deduction = attributes[:'cis_deduction']
       end
 
+      if attributes.key?(:'cis_rate')
+        self.cis_rate = attributes[:'cis_rate']
+      end
+
       if attributes.key?(:'sub_total')
         self.sub_total = attributes[:'sub_total']
       end
@@ -341,6 +373,10 @@ module XeroRuby::Accounting
         self.invoice_id = attributes[:'invoice_id']
       end
 
+      if attributes.key?(:'repeating_invoice_id')
+        self.repeating_invoice_id = attributes[:'repeating_invoice_id']
+      end
+
       if attributes.key?(:'has_attachments')
         self.has_attachments = attributes[:'has_attachments']
       else
@@ -403,6 +439,8 @@ module XeroRuby::Accounting
 
       if attributes.key?(:'has_errors')
         self.has_errors = attributes[:'has_errors']
+      else
+        self.has_errors = false
       end
 
       if attributes.key?(:'status_attribute_string')
@@ -430,10 +468,6 @@ module XeroRuby::Accounting
         invalid_properties.push('invalid value for "invoice_number", the character length must be smaller than or equal to 255.')
       end
 
-      if !@reference.nil? && @reference.to_s.length > 255
-        invalid_properties.push('invalid value for "reference", the character length must be smaller than or equal to 255.')
-      end
-
       invalid_properties
     end
 
@@ -443,7 +477,6 @@ module XeroRuby::Accounting
       type_validator = EnumAttributeValidator.new('String', ["ACCPAY", "ACCPAYCREDIT", "APOVERPAYMENT", "APPREPAYMENT", "ACCREC", "ACCRECCREDIT", "AROVERPAYMENT", "ARPREPAYMENT"])
       return false unless type_validator.valid?(@type)
       return false if !@invoice_number.nil? && @invoice_number.to_s.length > 255
-      return false if !@reference.nil? && @reference.to_s.length > 255
       status_validator = EnumAttributeValidator.new('String', ["DRAFT", "SUBMITTED", "DELETED", "AUTHORISED", "PAID", "VOIDED"])
       return false unless status_validator.valid?(@status)
       true
@@ -469,16 +502,6 @@ module XeroRuby::Accounting
       @invoice_number = invoice_number
     end
 
-    # Custom attribute writer method with validation
-    # @param [Object] reference Value to be assigned
-    def reference=(reference)
-      if !reference.nil? && reference.to_s.length > 255
-        fail ArgumentError, 'invalid value for "reference", the character length must be smaller than or equal to 255.'
-      end
-
-      @reference = reference
-    end
-
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] status Object to be assigned
     def status=(status)
@@ -511,11 +534,13 @@ module XeroRuby::Accounting
           expected_payment_date == o.expected_payment_date &&
           planned_payment_date == o.planned_payment_date &&
           cis_deduction == o.cis_deduction &&
+          cis_rate == o.cis_rate &&
           sub_total == o.sub_total &&
           total_tax == o.total_tax &&
           total == o.total &&
           total_discount == o.total_discount &&
           invoice_id == o.invoice_id &&
+          repeating_invoice_id == o.repeating_invoice_id &&
           has_attachments == o.has_attachments &&
           is_discounted == o.is_discounted &&
           payments == o.payments &&
@@ -543,7 +568,7 @@ module XeroRuby::Accounting
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [type, contact, line_items, date, due_date, line_amount_types, invoice_number, reference, branding_theme_id, url, currency_code, currency_rate, status, sent_to_contact, expected_payment_date, planned_payment_date, cis_deduction, sub_total, total_tax, total, total_discount, invoice_id, has_attachments, is_discounted, payments, prepayments, overpayments, amount_due, amount_paid, fully_paid_on_date, amount_credited, updated_date_utc, credit_notes, attachments, has_errors, status_attribute_string, validation_errors, warnings].hash
+      [type, contact, line_items, date, due_date, line_amount_types, invoice_number, reference, branding_theme_id, url, currency_code, currency_rate, status, sent_to_contact, expected_payment_date, planned_payment_date, cis_deduction, cis_rate, sub_total, total_tax, total, total_discount, invoice_id, repeating_invoice_id, has_attachments, is_discounted, payments, prepayments, overpayments, amount_due, amount_paid, fully_paid_on_date, amount_credited, updated_date_utc, credit_notes, attachments, has_errors, status_attribute_string, validation_errors, warnings].hash
     end
 
     # Builds the object from hash
@@ -589,6 +614,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
@@ -628,38 +655,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