xero-ruby 3.4.0 → 3.5.0

data/lib/xero-ruby/api_client.rb

@@ -110,6 +110,11 @@ module XeroRuby
       XeroRuby::AppStoreApi.new(self)
     end
 
+    def finance_api
+      @config.base_url = @config.finance_url
+      XeroRuby::FinanceApi.new(self)
+    end
+
     # Token Helpers
     def token_set
       @config.token_set
@@ -284,6 +289,10 @@ module XeroRuby
         method_base_url = @config.payroll_uk_url
       when "ProjectApi"
         method_base_url = @config.project_url
+      when "AppStoreApi"
+        method_base_url = @config.app_store_url
+      when "FinanceApi"
+        method_base_url = @config.finance_url
       else
         method_base_url = @config.accounting_url
       end
@@ -508,6 +517,8 @@ module XeroRuby
           XeroRuby::PayrollUk.const_get(return_type).build_from_hash(data)
         when 'AppStoreApi'
           XeroRuby::AppStore.const_get(return_type).build_from_hash(data)
+        when 'FinanceApi'
+          XeroRuby::Finance.const_get(return_type).build_from_hash(data)
         else
           XeroRuby::Accounting.const_get(return_type).build_from_hash(data)
         end

data/lib/xero-ruby/configuration.rb

@@ -34,6 +34,7 @@ module XeroRuby
     attr_accessor :payroll_nz_url
     attr_accessor :payroll_uk_url
     attr_accessor :app_store_url
+    attr_accessor :finance_url
 
     # Defines API keys used with API Key authentications.
     #
@@ -151,6 +152,7 @@ module XeroRuby
       @payroll_nz_url = 'https://api.xero.com/payroll.xro/2.0/'
       @payroll_uk_url = 'https://api.xero.com/payroll.xro/2.0/'
       @app_store_url = 'https://api.xero.com/appstore/2.0/'
+      @finance_url = 'https://api.xero.com/finance.xro/1.0/'
       @access_token = nil
       @id_token = nil
       @api_key = {}

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

@@ -19,6 +19,9 @@ module XeroRuby::Accounting
     # Xero identifier
     attr_accessor :contact_id
     
+    # ID for the destination of a merged contact. Only returned when using paging or when fetching a contact by ContactId or ContactNumber.
+    attr_accessor :merged_to_contact_id
+    
     # This can be updated via the API only i.e. This field is read only on the Xero contact screen, used to identify contacts in external systems (max length = 50). If the Contact Number is used, this is displayed as Contact Code in the Contacts UI in Xero.
     attr_accessor :contact_number
     
@@ -40,6 +43,9 @@ module XeroRuby::Accounting
     # Last name of contact person (max length = 255)
     attr_accessor :last_name
     
+    # Company registration number (max length = 50)
+    attr_accessor :company_number
+    
     # Email address of contact person (umlauts not supported) (max length  = 255)
     attr_accessor :email_address
     
@@ -73,6 +79,18 @@ module XeroRuby::Accounting
     # true or false – Boolean that describes if a contact has any AR invoices entered against them. Cannot be set via PUT or POST – it is automatically set when an accounts receivable invoice is generated against this contact.
     attr_accessor :is_customer
     
+    # The default sales line amount type for a contact. Only available when summaryOnly parameter or paging is used, or when fetch by ContactId or ContactNumber.
+    attr_accessor :sales_default_line_amount_type
+    INCLUSIVE = "INCLUSIVE".freeze
+    EXCLUSIVE = "EXCLUSIVE".freeze
+    # NONE = "NONE".freeze
+    
+    # The default purchases line amount type for a contact Only available when summaryOnly parameter or paging is used, or when fetch by ContactId or ContactNumber.
+    attr_accessor :purchases_default_line_amount_type
+    # INCLUSIVE = "INCLUSIVE".freeze
+    # EXCLUSIVE = "EXCLUSIVE".freeze
+    # NONE = "NONE".freeze
+    
 
     attr_accessor :default_currency
     
@@ -162,12 +180,14 @@ module XeroRuby::Accounting
     def self.attribute_map
       {
         :'contact_id' => :'ContactID',
+        :'merged_to_contact_id' => :'MergedToContactID',
         :'contact_number' => :'ContactNumber',
         :'account_number' => :'AccountNumber',
         :'contact_status' => :'ContactStatus',
         :'name' => :'Name',
         :'first_name' => :'FirstName',
         :'last_name' => :'LastName',
+        :'company_number' => :'CompanyNumber',
         :'email_address' => :'EmailAddress',
         :'skype_user_name' => :'SkypeUserName',
         :'contact_persons' => :'ContactPersons',
@@ -179,6 +199,8 @@ module XeroRuby::Accounting
         :'phones' => :'Phones',
         :'is_supplier' => :'IsSupplier',
         :'is_customer' => :'IsCustomer',
+        :'sales_default_line_amount_type' => :'SalesDefaultLineAmountType',
+        :'purchases_default_line_amount_type' => :'PurchasesDefaultLineAmountType',
         :'default_currency' => :'DefaultCurrency',
         :'xero_network_key' => :'XeroNetworkKey',
         :'sales_default_account_code' => :'SalesDefaultAccountCode',
@@ -207,12 +229,14 @@ module XeroRuby::Accounting
     def self.openapi_types
       {
         :'contact_id' => :'String',
+        :'merged_to_contact_id' => :'String',
         :'contact_number' => :'String',
         :'account_number' => :'String',
         :'contact_status' => :'String',
         :'name' => :'String',
         :'first_name' => :'String',
         :'last_name' => :'String',
+        :'company_number' => :'String',
         :'email_address' => :'String',
         :'skype_user_name' => :'String',
         :'contact_persons' => :'Array<ContactPerson>',
@@ -224,6 +248,8 @@ module XeroRuby::Accounting
         :'phones' => :'Array<Phone>',
         :'is_supplier' => :'Boolean',
         :'is_customer' => :'Boolean',
+        :'sales_default_line_amount_type' => :'String',
+        :'purchases_default_line_amount_type' => :'String',
         :'default_currency' => :'CurrencyCode',
         :'xero_network_key' => :'String',
         :'sales_default_account_code' => :'String',
@@ -267,6 +293,10 @@ module XeroRuby::Accounting
         self.contact_id = attributes[:'contact_id']
       end
 
+      if attributes.key?(:'merged_to_contact_id')
+        self.merged_to_contact_id = attributes[:'merged_to_contact_id']
+      end
+
       if attributes.key?(:'contact_number')
         self.contact_number = attributes[:'contact_number']
       end
@@ -291,6 +321,10 @@ module XeroRuby::Accounting
         self.last_name = attributes[:'last_name']
       end
 
+      if attributes.key?(:'company_number')
+        self.company_number = attributes[:'company_number']
+      end
+
       if attributes.key?(:'email_address')
         self.email_address = attributes[:'email_address']
       end
@@ -341,6 +375,14 @@ module XeroRuby::Accounting
         self.is_customer = attributes[:'is_customer']
       end
 
+      if attributes.key?(:'sales_default_line_amount_type')
+        self.sales_default_line_amount_type = attributes[:'sales_default_line_amount_type']
+      end
+
+      if attributes.key?(:'purchases_default_line_amount_type')
+        self.purchases_default_line_amount_type = attributes[:'purchases_default_line_amount_type']
+      end
+
       if attributes.key?(:'default_currency')
         self.default_currency = attributes[:'default_currency']
       end
@@ -464,6 +506,10 @@ module XeroRuby::Accounting
         invalid_properties.push('invalid value for "last_name", the character length must be smaller than or equal to 255.')
       end
 
+      if !@company_number.nil? && @company_number.to_s.length > 50
+        invalid_properties.push('invalid value for "company_number", the character length must be smaller than or equal to 50.')
+      end
+
       if !@email_address.nil? && @email_address.to_s.length > 255
         invalid_properties.push('invalid value for "email_address", the character length must be smaller than or equal to 255.')
       end
@@ -485,8 +531,13 @@ module XeroRuby::Accounting
       return false if !@name.nil? && @name.to_s.length > 255
       return false if !@first_name.nil? && @first_name.to_s.length > 255
       return false if !@last_name.nil? && @last_name.to_s.length > 255
+      return false if !@company_number.nil? && @company_number.to_s.length > 50
       return false if !@email_address.nil? && @email_address.to_s.length > 255
       return false if !@tax_number.nil? && @tax_number.to_s.length > 50
+      sales_default_line_amount_type_validator = EnumAttributeValidator.new('String', ["INCLUSIVE", "EXCLUSIVE", "NONE"])
+      return false unless sales_default_line_amount_type_validator.valid?(@sales_default_line_amount_type)
+      purchases_default_line_amount_type_validator = EnumAttributeValidator.new('String', ["INCLUSIVE", "EXCLUSIVE", "NONE"])
+      return false unless purchases_default_line_amount_type_validator.valid?(@purchases_default_line_amount_type)
       true
     end
 
@@ -550,6 +601,16 @@ module XeroRuby::Accounting
       @last_name = last_name
     end
 
+    # Custom attribute writer method with validation
+    # @param [Object] company_number Value to be assigned
+    def company_number=(company_number)
+      if !company_number.nil? && company_number.to_s.length > 50
+        fail ArgumentError, 'invalid value for "company_number", the character length must be smaller than or equal to 50.'
+      end
+
+      @company_number = company_number
+    end
+
     # Custom attribute writer method with validation
     # @param [Object] email_address Value to be assigned
     def email_address=(email_address)
@@ -570,18 +631,40 @@ module XeroRuby::Accounting
       @tax_number = tax_number
     end
 
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] sales_default_line_amount_type Object to be assigned
+    def sales_default_line_amount_type=(sales_default_line_amount_type)
+      validator = EnumAttributeValidator.new('String', ["INCLUSIVE", "EXCLUSIVE", "NONE"])
+      unless validator.valid?(sales_default_line_amount_type)
+        fail ArgumentError, "invalid value for \"sales_default_line_amount_type\", must be one of #{validator.allowable_values}."
+      end
+      @sales_default_line_amount_type = sales_default_line_amount_type
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] purchases_default_line_amount_type Object to be assigned
+    def purchases_default_line_amount_type=(purchases_default_line_amount_type)
+      validator = EnumAttributeValidator.new('String', ["INCLUSIVE", "EXCLUSIVE", "NONE"])
+      unless validator.valid?(purchases_default_line_amount_type)
+        fail ArgumentError, "invalid value for \"purchases_default_line_amount_type\", must be one of #{validator.allowable_values}."
+      end
+      @purchases_default_line_amount_type = purchases_default_line_amount_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 &&
           contact_id == o.contact_id &&
+          merged_to_contact_id == o.merged_to_contact_id &&
           contact_number == o.contact_number &&
           account_number == o.account_number &&
           contact_status == o.contact_status &&
           name == o.name &&
           first_name == o.first_name &&
           last_name == o.last_name &&
+          company_number == o.company_number &&
           email_address == o.email_address &&
           skype_user_name == o.skype_user_name &&
           contact_persons == o.contact_persons &&
@@ -593,6 +676,8 @@ module XeroRuby::Accounting
           phones == o.phones &&
           is_supplier == o.is_supplier &&
           is_customer == o.is_customer &&
+          sales_default_line_amount_type == o.sales_default_line_amount_type &&
+          purchases_default_line_amount_type == o.purchases_default_line_amount_type &&
           default_currency == o.default_currency &&
           xero_network_key == o.xero_network_key &&
           sales_default_account_code == o.sales_default_account_code &&
@@ -625,7 +710,7 @@ module XeroRuby::Accounting
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [contact_id, contact_number, account_number, contact_status, name, first_name, last_name, email_address, skype_user_name, contact_persons, bank_account_details, tax_number, accounts_receivable_tax_type, accounts_payable_tax_type, addresses, phones, is_supplier, is_customer, default_currency, xero_network_key, sales_default_account_code, purchases_default_account_code, sales_tracking_categories, purchases_tracking_categories, tracking_category_name, tracking_category_option, payment_terms, updated_date_utc, contact_groups, website, branding_theme, batch_payments, discount, balances, attachments, has_attachments, validation_errors, has_validation_errors, status_attribute_string].hash
+      [contact_id, merged_to_contact_id, contact_number, account_number, contact_status, name, first_name, last_name, company_number, email_address, skype_user_name, contact_persons, bank_account_details, tax_number, accounts_receivable_tax_type, accounts_payable_tax_type, addresses, phones, is_supplier, is_customer, sales_default_line_amount_type, purchases_default_line_amount_type, default_currency, xero_network_key, sales_default_account_code, purchases_default_account_code, sales_tracking_categories, purchases_tracking_categories, tracking_category_name, tracking_category_option, payment_terms, updated_date_utc, contact_groups, website, branding_theme, batch_payments, discount, balances, attachments, has_attachments, validation_errors, has_validation_errors, status_attribute_string].hash
     end
 
     # Builds the object from hash

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

@@ -0,0 +1,342 @@
+=begin
+#Xero Finance API
+
+#The Finance API is a collection of endpoints which customers can use in the course of a loan application, which may assist lenders to gain the confidence they need to provide capital.
+
+Contact: api@xero.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.3.1
+
+=end
+
+require 'time'
+require 'date'
+
+module XeroRuby::Finance
+  require 'bigdecimal'
+
+  class AccountUsage
+    # The month this usage item contains data for
+    attr_accessor :month
+    
+    # The account this usage item contains data for
+    attr_accessor :account_id
+    
+    # The currency code this usage item contains data for
+    attr_accessor :currency_code
+    
+    # Total received
+    attr_accessor :total_received
+    
+    # Count of received
+    attr_accessor :count_received
+    
+    # Total paid
+    attr_accessor :total_paid
+    
+    # Count of paid
+    attr_accessor :count_paid
+    
+    # Total value of manual journals
+    attr_accessor :total_manual_journal
+    
+    # Count of manual journals
+    attr_accessor :count_manual_journal
+    
+    # The name of the account
+    attr_accessor :account_name
+    
+    # Shown if set
+    attr_accessor :reporting_code
+    
+    # Shown if set
+    attr_accessor :reporting_code_name
+    
+    # Last modified date UTC format
+    attr_accessor :report_code_updated_date_utc
+    
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'month' => :'month',
+        :'account_id' => :'accountId',
+        :'currency_code' => :'currencyCode',
+        :'total_received' => :'totalReceived',
+        :'count_received' => :'countReceived',
+        :'total_paid' => :'totalPaid',
+        :'count_paid' => :'countPaid',
+        :'total_manual_journal' => :'totalManualJournal',
+        :'count_manual_journal' => :'countManualJournal',
+        :'account_name' => :'accountName',
+        :'reporting_code' => :'reportingCode',
+        :'reporting_code_name' => :'reportingCodeName',
+        :'report_code_updated_date_utc' => :'reportCodeUpdatedDateUtc'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'month' => :'String',
+        :'account_id' => :'String',
+        :'currency_code' => :'String',
+        :'total_received' => :'BigDecimal',
+        :'count_received' => :'Integer',
+        :'total_paid' => :'BigDecimal',
+        :'count_paid' => :'Integer',
+        :'total_manual_journal' => :'BigDecimal',
+        :'count_manual_journal' => :'Integer',
+        :'account_name' => :'String',
+        :'reporting_code' => :'String',
+        :'reporting_code_name' => :'String',
+        :'report_code_updated_date_utc' => :'DateTime'
+      }
+    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::Finance::AccountUsage` 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::Finance::AccountUsage`. 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?(:'month')
+        self.month = attributes[:'month']
+      end
+
+      if attributes.key?(:'account_id')
+        self.account_id = attributes[:'account_id']
+      end
+
+      if attributes.key?(:'currency_code')
+        self.currency_code = attributes[:'currency_code']
+      end
+
+      if attributes.key?(:'total_received')
+        self.total_received = attributes[:'total_received']
+      end
+
+      if attributes.key?(:'count_received')
+        self.count_received = attributes[:'count_received']
+      end
+
+      if attributes.key?(:'total_paid')
+        self.total_paid = attributes[:'total_paid']
+      end
+
+      if attributes.key?(:'count_paid')
+        self.count_paid = attributes[:'count_paid']
+      end
+
+      if attributes.key?(:'total_manual_journal')
+        self.total_manual_journal = attributes[:'total_manual_journal']
+      end
+
+      if attributes.key?(:'count_manual_journal')
+        self.count_manual_journal = attributes[:'count_manual_journal']
+      end
+
+      if attributes.key?(:'account_name')
+        self.account_name = attributes[:'account_name']
+      end
+
+      if attributes.key?(:'reporting_code')
+        self.reporting_code = attributes[:'reporting_code']
+      end
+
+      if attributes.key?(:'reporting_code_name')
+        self.reporting_code_name = attributes[:'reporting_code_name']
+      end
+
+      if attributes.key?(:'report_code_updated_date_utc')
+        self.report_code_updated_date_utc = attributes[:'report_code_updated_date_utc']
+      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 &&
+          month == o.month &&
+          account_id == o.account_id &&
+          currency_code == o.currency_code &&
+          total_received == o.total_received &&
+          count_received == o.count_received &&
+          total_paid == o.total_paid &&
+          count_paid == o.count_paid &&
+          total_manual_journal == o.total_manual_journal &&
+          count_manual_journal == o.count_manual_journal &&
+          account_name == o.account_name &&
+          reporting_code == o.reporting_code &&
+          reporting_code_name == o.reporting_code_name &&
+          report_code_updated_date_utc == o.report_code_updated_date_utc
+    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
+      [month, account_id, currency_code, total_received, count_received, total_paid, count_paid, total_manual_journal, count_manual_journal, account_name, reporting_code, reporting_code_name, report_code_updated_date_utc].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::Finance.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