xero-ruby 3.16.0 → 10.0.0

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

@@ -43,6 +43,7 @@ module XeroRuby::Accounting
     CAD ||= "CAD".freeze
     CDF ||= "CDF".freeze
     CHF ||= "CHF".freeze
+    CLF ||= "CLF".freeze
     CLP ||= "CLP".freeze
     CNY ||= "CNY".freeze
     COP ||= "COP".freeze
@@ -55,6 +56,7 @@ module XeroRuby::Accounting
     DKK ||= "DKK".freeze
     DOP ||= "DOP".freeze
     DZD ||= "DZD".freeze
+    EEK ||= "EEK".freeze
     EGP ||= "EGP".freeze
     ERN ||= "ERN".freeze
     ETB ||= "ETB".freeze
@@ -63,7 +65,6 @@ module XeroRuby::Accounting
     FKP ||= "FKP".freeze
     GBP ||= "GBP".freeze
     GEL ||= "GEL".freeze
-    GGP ||= "GGP".freeze
     GHS ||= "GHS".freeze
     GIP ||= "GIP".freeze
     GMD ||= "GMD".freeze
@@ -77,12 +78,10 @@ module XeroRuby::Accounting
     HUF ||= "HUF".freeze
     IDR ||= "IDR".freeze
     ILS ||= "ILS".freeze
-    IMP ||= "IMP".freeze
     INR ||= "INR".freeze
     IQD ||= "IQD".freeze
     IRR ||= "IRR".freeze
     ISK ||= "ISK".freeze
-    JEP ||= "JEP".freeze
     JMD ||= "JMD".freeze
     JOD ||= "JOD".freeze
     JPY ||= "JPY".freeze
@@ -101,6 +100,7 @@ module XeroRuby::Accounting
     LRD ||= "LRD".freeze
     LSL ||= "LSL".freeze
     LTL ||= "LTL".freeze
+    LVL ||= "LVL".freeze
     LYD ||= "LYD".freeze
     MAD ||= "MAD".freeze
     MDL ||= "MDL".freeze
@@ -109,11 +109,13 @@ module XeroRuby::Accounting
     MMK ||= "MMK".freeze
     MNT ||= "MNT".freeze
     MOP ||= "MOP".freeze
+    MRO ||= "MRO".freeze
     MRU ||= "MRU".freeze
     MUR ||= "MUR".freeze
     MVR ||= "MVR".freeze
     MWK ||= "MWK".freeze
     MXN ||= "MXN".freeze
+    MXV ||= "MXV".freeze
     MYR ||= "MYR".freeze
     MZN ||= "MZN".freeze
     NAD ||= "NAD".freeze
@@ -142,11 +144,13 @@ module XeroRuby::Accounting
     SEK ||= "SEK".freeze
     SGD ||= "SGD".freeze
     SHP ||= "SHP".freeze
+    SKK ||= "SKK".freeze
+    SLE ||= "SLE".freeze
     SLL ||= "SLL".freeze
     SOS ||= "SOS".freeze
-    SPL ||= "SPL".freeze
     SRD ||= "SRD".freeze
-    STN ||= "STN".freeze
+    STN ||= "STD".freeze
+    STD ||= "STN".freeze
     SVC ||= "SVC".freeze
     SYP ||= "SYP".freeze
     SZL ||= "SZL".freeze
@@ -157,7 +161,6 @@ module XeroRuby::Accounting
     TOP ||= "TOP".freeze
     TRY_LIRA ||= "TRY".freeze
     TTD ||= "TTD".freeze
-    TVD ||= "TVD".freeze
     TWD ||= "TWD".freeze
     TZS ||= "TZS".freeze
     UAH ||= "UAH".freeze
@@ -166,12 +169,12 @@ module XeroRuby::Accounting
     UYU ||= "UYU".freeze
     UZS ||= "UZS".freeze
     VEF ||= "VEF".freeze
+    VES ||= "VES".freeze
     VND ||= "VND".freeze
     VUV ||= "VUV".freeze
     WST ||= "WST".freeze
     XAF ||= "XAF".freeze
     XCD ||= "XCD".freeze
-    XDR ||= "XDR".freeze
     XOF ||= "XOF".freeze
     XPF ||= "XPF".freeze
     YER ||= "YER".freeze
@@ -179,7 +182,6 @@ module XeroRuby::Accounting
     ZMW ||= "ZMW".freeze
     ZMK ||= "ZMK".freeze
     ZWD ||= "ZWD".freeze
-    EMPTY_CURRENCY ||= "".freeze
 
     # Builds the enum from string
     # @param [String] The enum value in the form of the string

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

@@ -150,6 +150,9 @@ module XeroRuby::Accounting
     # Displays array of warning messages from the API
     attr_accessor :warnings
     
+    # An array of addresses used to auto calculate sales tax
+    attr_accessor :invoice_addresses
+    
     class EnumAttributeValidator
       attr_reader :datatype
       attr_reader :allowable_values
@@ -214,7 +217,8 @@ module XeroRuby::Accounting
         :'has_errors' => :'HasErrors',
         :'status_attribute_string' => :'StatusAttributeString',
         :'validation_errors' => :'ValidationErrors',
-        :'warnings' => :'Warnings'
+        :'warnings' => :'Warnings',
+        :'invoice_addresses' => :'InvoiceAddresses'
       }
     end
 
@@ -260,7 +264,8 @@ module XeroRuby::Accounting
         :'has_errors' => :'Boolean',
         :'status_attribute_string' => :'String',
         :'validation_errors' => :'Array<ValidationError>',
-        :'warnings' => :'Array<ValidationError>'
+        :'warnings' => :'Array<ValidationError>',
+        :'invoice_addresses' => :'Array<InvoiceAddress>'
       }
     end
 
@@ -458,6 +463,12 @@ module XeroRuby::Accounting
           self.warnings = value
         end
       end
+
+      if attributes.key?(:'invoice_addresses')
+        if (value = attributes[:'invoice_addresses']).is_a?(Array)
+          self.invoice_addresses = value
+        end
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -556,7 +567,8 @@ module XeroRuby::Accounting
           has_errors == o.has_errors &&
           status_attribute_string == o.status_attribute_string &&
           validation_errors == o.validation_errors &&
-          warnings == o.warnings
+          warnings == o.warnings &&
+          invoice_addresses == o.invoice_addresses
     end
 
     # @see the `==` method
@@ -568,7 +580,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, 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
+      [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, invoice_addresses].hash
     end
 
     # Builds the object from hash

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

@@ -0,0 +1,338 @@
+=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 InvoiceAddress
+    # Indicates whether the address is defined as origin (FROM) or destination (TO)
+    attr_accessor :invoice_address_type
+    FROM ||= "FROM".freeze
+    TO ||= "TO".freeze
+    
+    # First line of a physical address
+    attr_accessor :address_line1
+    
+    # Second line of a physical address
+    attr_accessor :address_line2
+    
+    # Third line of a physical address
+    attr_accessor :address_line3
+    
+    # Fourth line of a physical address
+    attr_accessor :address_line4
+    
+    # City of a physical address
+    attr_accessor :city
+    
+    # Region or state of a physical address
+    attr_accessor :region
+    
+    # Postal code of a physical address
+    attr_accessor :postal_code
+    
+    # Country of a physical address
+    attr_accessor :country
+    
+    class EnumAttributeValidator
+      attr_reader :datatype
+      attr_reader :allowable_values
+
+      def initialize(datatype, allowable_values)
+        @allowable_values = allowable_values.map do |value|
+          case datatype.to_s
+          when /Integer/i
+            value.to_i
+          when /Float/i
+            value.to_f
+          else
+            value
+          end
+        end
+      end
+
+      def valid?(value)
+        !value || allowable_values.include?(value)
+      end
+    end
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'invoice_address_type' => :'InvoiceAddressType',
+        :'address_line1' => :'AddressLine1',
+        :'address_line2' => :'AddressLine2',
+        :'address_line3' => :'AddressLine3',
+        :'address_line4' => :'AddressLine4',
+        :'city' => :'City',
+        :'region' => :'Region',
+        :'postal_code' => :'PostalCode',
+        :'country' => :'Country'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'invoice_address_type' => :'String',
+        :'address_line1' => :'String',
+        :'address_line2' => :'String',
+        :'address_line3' => :'String',
+        :'address_line4' => :'String',
+        :'city' => :'String',
+        :'region' => :'String',
+        :'postal_code' => :'String',
+        :'country' => :'String'
+      }
+    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::InvoiceAddress` 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::InvoiceAddress`. 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?(:'invoice_address_type')
+        self.invoice_address_type = attributes[:'invoice_address_type']
+      end
+
+      if attributes.key?(:'address_line1')
+        self.address_line1 = attributes[:'address_line1']
+      end
+
+      if attributes.key?(:'address_line2')
+        self.address_line2 = attributes[:'address_line2']
+      end
+
+      if attributes.key?(:'address_line3')
+        self.address_line3 = attributes[:'address_line3']
+      end
+
+      if attributes.key?(:'address_line4')
+        self.address_line4 = attributes[:'address_line4']
+      end
+
+      if attributes.key?(:'city')
+        self.city = attributes[:'city']
+      end
+
+      if attributes.key?(:'region')
+        self.region = attributes[:'region']
+      end
+
+      if attributes.key?(:'postal_code')
+        self.postal_code = attributes[:'postal_code']
+      end
+
+      if attributes.key?(:'country')
+        self.country = attributes[:'country']
+      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?
+      invoice_address_type_validator = EnumAttributeValidator.new('String', ["FROM", "TO"])
+      return false unless invoice_address_type_validator.valid?(@invoice_address_type)
+      true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] invoice_address_type Object to be assigned
+    def invoice_address_type=(invoice_address_type)
+      validator = EnumAttributeValidator.new('String', ["FROM", "TO"])
+      unless validator.valid?(invoice_address_type)
+        fail ArgumentError, "invalid value for \"invoice_address_type\", must be one of #{validator.allowable_values}."
+      end
+      @invoice_address_type = invoice_address_type
+    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 &&
+          invoice_address_type == o.invoice_address_type &&
+          address_line1 == o.address_line1 &&
+          address_line2 == o.address_line2 &&
+          address_line3 == o.address_line3 &&
+          address_line4 == o.address_line4 &&
+          city == o.city &&
+          region == o.region &&
+          postal_code == o.postal_code &&
+          country == o.country
+    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
+      [invoice_address_type, address_line1, address_line2, address_line3, address_line4, city, region, postal_code, country].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/invoices.rb

@@ -17,11 +17,19 @@ module XeroRuby::Accounting
 
   class Invoices
 
+    attr_accessor :pagination
+    
+    # Displays array of warning messages from the API
+    attr_accessor :warnings
+    
+
     attr_accessor :invoices
     
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
+        :'pagination' => :'pagination',
+        :'warnings' => :'Warnings',
         :'invoices' => :'Invoices'
       }
     end
@@ -29,6 +37,8 @@ module XeroRuby::Accounting
     # Attribute type mapping.
     def self.openapi_types
       {
+        :'pagination' => :'Pagination',
+        :'warnings' => :'Array<ValidationError>',
         :'invoices' => :'Array<Invoice>'
       }
     end
@@ -48,6 +58,16 @@ module XeroRuby::Accounting
         h[k.to_sym] = v
       }
 
+      if attributes.key?(:'pagination')
+        self.pagination = attributes[:'pagination']
+      end
+
+      if attributes.key?(:'warnings')
+        if (value = attributes[:'warnings']).is_a?(Array)
+          self.warnings = value
+        end
+      end
+
       if attributes.key?(:'invoices')
         if (value = attributes[:'invoices']).is_a?(Array)
           self.invoices = value
@@ -73,6 +93,8 @@ module XeroRuby::Accounting
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
+          pagination == o.pagination &&
+          warnings == o.warnings &&
           invoices == o.invoices
     end
 
@@ -85,7 +107,7 @@ module XeroRuby::Accounting
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [invoices].hash
+      [pagination, warnings, invoices].hash
     end
 
     # Builds the object from hash

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

@@ -16,12 +16,16 @@ module XeroRuby::Accounting
   require 'bigdecimal'
 
   class Journals
+    # Displays array of warning messages from the API
+    attr_accessor :warnings
+    
 
     attr_accessor :journals
     
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
+        :'warnings' => :'Warnings',
         :'journals' => :'Journals'
       }
     end
@@ -29,6 +33,7 @@ module XeroRuby::Accounting
     # Attribute type mapping.
     def self.openapi_types
       {
+        :'warnings' => :'Array<ValidationError>',
         :'journals' => :'Array<Journal>'
       }
     end
@@ -48,6 +53,12 @@ module XeroRuby::Accounting
         h[k.to_sym] = v
       }
 
+      if attributes.key?(:'warnings')
+        if (value = attributes[:'warnings']).is_a?(Array)
+          self.warnings = value
+        end
+      end
+
       if attributes.key?(:'journals')
         if (value = attributes[:'journals']).is_a?(Array)
           self.journals = value
@@ -73,6 +84,7 @@ module XeroRuby::Accounting
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
+          warnings == o.warnings &&
           journals == o.journals
     end
 
@@ -85,7 +97,7 @@ module XeroRuby::Accounting
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [journals].hash
+      [warnings, journals].hash
     end
 
     # Builds the object from hash