xero-ruby 3.6.0 → 3.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 471817aae937985bd56abe5d70a1e3d078c24e2d87971205e30c1583a05c3e37
-  data.tar.gz: 70990d160ea9bdaac183acd06eaab41e0b680525b386b2c1411cf33ec3fbef9a
+  metadata.gz: 29e6f0618655087a784f836d1267fca44bde1a7ab7d0e43fa979eee59e635185
+  data.tar.gz: b62700762b38fe788780dfc19bd0bd40b9cfe14911c66b431449c815aa8c9469
 SHA512:
-  metadata.gz: 5f47679440b82e924e68da60d26fbb6d7062c47ef026272be763740ad826392781d7dd260a04b5e139d09de2a54336c0602c51746df819554e2a625f8fdf7dbd
-  data.tar.gz: 353ca2bcb1d9395d5d68fdb3474ab1c86f54f9474bd8b5135616c3469173683c927d2bea4cfd5a457dae2ab1ee4caf34ff6c9adac81c7f219e8dba3e4f1298fe
+  metadata.gz: 9d3c5d78a58a4a32a53f4cbf4b5e236730bb93362534c43d4d201e8543aa82b77ceda220a76feab29c4bfea7112b0d69f83e1552170fbe6eeca6b0fb16a3bf82
+  data.tar.gz: 6912ff3d5ba867f63e7694fa14899f32641e0e9a8525d187a6576b969f1a81ef7349e28b2ef29b91b0b0ef2b117b57ad90980c6cbc4ef8fdcd302ee47240b5bf

data/lib/xero-ruby/api/finance_api.rb

@@ -315,6 +315,101 @@ module XeroRuby
       return data, status_code, headers
     end
 
+    # Get Bank Statement Accounting
+    # For lenders that prefer using bank statement data as the source of truth.  We provide a data point that will allow access to customer bank statements, plus for reconciled bank transactions the matching accounting, invoice and billing data as well.  As customers reconcile bank statements to invoices and bills, this transaction detail will provide valuable insight for lender's assessment measures. 
+    # @param xero_tenant_id [String] Xero identifier for Tenant
+    # @param bank_account_id [String] string, GUID    Bank account Id
+    # @param from_date [String] date, yyyy-MM-dd     Specifies the start date of the query period.   The maximum range of the query period is 12 months. If the specified query period is more than 12 months the request will be rejected.
+    # @param to_date [String] date, yyyy-MM-dd     Specifies the end date of the query period.   If the end date is a future date, the request will be rejected.
+    # @param [Hash] opts the optional parameters
+    # @option opts [Boolean] :summary_only boolean, true/false    The default value is true if no parameter is provided.    In summary mode, the response will exclude the computation-heavy LineItems fields from bank transaction, invoice, credit note, prepayment and overpayment data, making the API calls quicker and more efficient.
+    # @return [BankStatementAccountingResponse]
+    def get_bank_statement_accounting(xero_tenant_id, bank_account_id, from_date, to_date, opts = {})
+      data, _status_code, _headers = get_bank_statement_accounting_with_http_info(xero_tenant_id, bank_account_id, from_date, to_date, opts)
+      data
+    end
+
+    # Get Bank Statement Accounting
+    # For lenders that prefer using bank statement data as the source of truth.  We provide a data point that will allow access to customer bank statements, plus for reconciled bank transactions the matching accounting, invoice and billing data as well.  As customers reconcile bank statements to invoices and bills, this transaction detail will provide valuable insight for lender's assessment measures. 
+    # @param xero_tenant_id [String] Xero identifier for Tenant
+    # @param bank_account_id [String] string, GUID    Bank account Id
+    # @param from_date [String] date, yyyy-MM-dd     Specifies the start date of the query period.   The maximum range of the query period is 12 months. If the specified query period is more than 12 months the request will be rejected.
+    # @param to_date [String] date, yyyy-MM-dd     Specifies the end date of the query period.   If the end date is a future date, the request will be rejected.
+    # @param [Hash] opts the optional parameters
+    # @option opts [Boolean] :summary_only boolean, true/false    The default value is true if no parameter is provided.    In summary mode, the response will exclude the computation-heavy LineItems fields from bank transaction, invoice, credit note, prepayment and overpayment data, making the API calls quicker and more efficient.
+    # @return [Array<(BankStatementAccountingResponse, Integer, Hash)>] BankStatementAccountingResponse data, response status code and response headers
+    def get_bank_statement_accounting_with_http_info(xero_tenant_id, bank_account_id, from_date, to_date, options = {})
+      opts = options.dup
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: FinanceApi.get_bank_statement_accounting ...'
+      end
+      # verify the required parameter 'xero_tenant_id' is set
+      if @api_client.config.client_side_validation && xero_tenant_id.nil?
+        fail ArgumentError, "Missing the required parameter 'xero_tenant_id' when calling FinanceApi.get_bank_statement_accounting"
+      end
+      # verify the required parameter 'bank_account_id' is set
+      if @api_client.config.client_side_validation && bank_account_id.nil?
+        fail ArgumentError, "Missing the required parameter 'bank_account_id' when calling FinanceApi.get_bank_statement_accounting"
+      end
+      # verify the required parameter 'from_date' is set
+      if @api_client.config.client_side_validation && from_date.nil?
+        fail ArgumentError, "Missing the required parameter 'from_date' when calling FinanceApi.get_bank_statement_accounting"
+      end
+      # verify the required parameter 'to_date' is set
+      if @api_client.config.client_side_validation && to_date.nil?
+        fail ArgumentError, "Missing the required parameter 'to_date' when calling FinanceApi.get_bank_statement_accounting"
+      end
+      # resource path
+      local_var_path = '/BankStatementsPlus/statements'
+
+      # camelize keys of incoming `where` opts
+      opts[:'where'] = @api_client.parameterize_where(opts[:'where']) if !opts[:'where'].nil?
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'BankAccountID'] = bank_account_id
+      query_params[:'FromDate'] = from_date
+      query_params[:'ToDate'] = to_date
+      query_params[:'SummaryOnly'] = opts[:'summary_only'] if !opts[:'summary_only'].nil?
+      
+      # XeroAPI's `IDs` convention openapi-generator does not snake_case properly.. manual over-riding `i_ds` malformations:
+      query_params[:'IDs'] = @api_client.build_collection_param(opts[:'ids'], :csv) if !opts[:'ids'].nil?
+      query_params[:'ContactIDs'] = @api_client.build_collection_param(opts[:'contact_ids'], :csv) if !opts[:'contact_ids'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      header_params[:'xero-tenant-id'] = xero_tenant_id
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:body] 
+
+      # return_type
+      return_type = opts[:return_type] || 'BankStatementAccountingResponse' 
+
+      # auth_names
+      auth_names = opts[:auth_names] || ['OAuth2']
+
+      new_options = opts.merge(
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, "FinanceApi", new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: FinanceApi#get_bank_statement_accounting\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Get cash validation
     # Summarizes the total cash position for each account for an org
     # @param xero_tenant_id [String] Xero identifier for Tenant

data/lib/xero-ruby/api/payroll_uk_api.rb

@@ -3594,7 +3594,7 @@ module XeroRuby
     # Retrieves employees
     # @param xero_tenant_id [String] Xero identifier for Tenant
     # @param [Hash] opts the optional parameters
-    # @option opts [String] :filter Filter by first name and/or lastname
+    # @option opts [String] :filter Filter by first name, lastname, and/or whether they are an off-payroll worker
     # @option opts [Integer] :page Page number which specifies the set of records to retrieve. By default the number of the records per set is 100.
     # @return [Employees]
     def get_employees(xero_tenant_id, opts = {})
@@ -3605,7 +3605,7 @@ module XeroRuby
     # Retrieves employees
     # @param xero_tenant_id [String] Xero identifier for Tenant
     # @param [Hash] opts the optional parameters
-    # @option opts [String] :filter Filter by first name and/or lastname
+    # @option opts [String] :filter Filter by first name, lastname, and/or whether they are an off-payroll worker
     # @option opts [Integer] :page Page number which specifies the set of records to retrieve. By default the number of the records per set is 100.
     # @return [Array<(Employees, Integer, Hash)>] Employees data, response status code and response headers
     def get_employees_with_http_info(xero_tenant_id, options = {})

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

@@ -43,6 +43,9 @@ module XeroRuby::Accounting
     # The tax amount is auto calculated as a percentage of the line amount (see below) based on the tax rate. This value can be overriden if the calculated <TaxAmount> is not correct.
     attr_accessor :tax_amount
     
+
+    attr_accessor :item
+    
     # If you wish to omit either of the <Quantity> or <UnitAmount> you can provide a LineAmount and Xero will calculate the missing amount for you. The line amount reflects the discounted price if a DiscountRate has been used . i.e LineAmount = Quantity * Unit Amount * ((100 – DiscountRate)/100)
     attr_accessor :line_amount
     
@@ -70,6 +73,7 @@ module XeroRuby::Accounting
         :'account_id' => :'AccountID',
         :'tax_type' => :'TaxType',
         :'tax_amount' => :'TaxAmount',
+        :'item' => :'Item',
         :'line_amount' => :'LineAmount',
         :'tracking' => :'Tracking',
         :'discount_rate' => :'DiscountRate',
@@ -90,6 +94,7 @@ module XeroRuby::Accounting
         :'account_id' => :'String',
         :'tax_type' => :'String',
         :'tax_amount' => :'BigDecimal',
+        :'item' => :'LineItemItem',
         :'line_amount' => :'BigDecimal',
         :'tracking' => :'Array<LineItemTracking>',
         :'discount_rate' => :'BigDecimal',
@@ -149,6 +154,10 @@ module XeroRuby::Accounting
         self.tax_amount = attributes[:'tax_amount']
       end
 
+      if attributes.key?(:'item')
+        self.item = attributes[:'item']
+      end
+
       if attributes.key?(:'line_amount')
         self.line_amount = attributes[:'line_amount']
       end
@@ -199,6 +208,7 @@ module XeroRuby::Accounting
           account_id == o.account_id &&
           tax_type == o.tax_type &&
           tax_amount == o.tax_amount &&
+          item == o.item &&
           line_amount == o.line_amount &&
           tracking == o.tracking &&
           discount_rate == o.discount_rate &&
@@ -215,7 +225,7 @@ module XeroRuby::Accounting
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [line_item_id, description, quantity, unit_amount, item_code, account_code, account_id, tax_type, tax_amount, line_amount, tracking, discount_rate, discount_amount, repeating_invoice_id].hash
+      [line_item_id, description, quantity, unit_amount, item_code, account_code, account_id, tax_type, tax_amount, item, line_amount, tracking, discount_rate, discount_amount, repeating_invoice_id].hash
     end
 
     # Builds the object from hash

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

@@ -0,0 +1,272 @@
+=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 LineItemItem
+    # User defined item code (max length = 30)
+    attr_accessor :code
+    
+    # The name of the item (max length = 50)
+    attr_accessor :name
+    
+    # The Xero identifier for an Item
+    attr_accessor :item_id
+    
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'code' => :'Code',
+        :'name' => :'Name',
+        :'item_id' => :'ItemID'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'code' => :'String',
+        :'name' => :'String',
+        :'item_id' => :'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::LineItemItem` 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::LineItemItem`. 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?(:'code')
+        self.code = attributes[:'code']
+      end
+
+      if attributes.key?(:'name')
+        self.name = attributes[:'name']
+      end
+
+      if attributes.key?(:'item_id')
+        self.item_id = attributes[:'item_id']
+      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 !@code.nil? && @code.to_s.length > 30
+        invalid_properties.push('invalid value for "code", the character length must be smaller than or equal to 30.')
+      end
+
+      if !@name.nil? && @name.to_s.length > 50
+        invalid_properties.push('invalid value for "name", the character length must be smaller than or equal to 50.')
+      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 !@code.nil? && @code.to_s.length > 30
+      return false if !@name.nil? && @name.to_s.length > 50
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] code Value to be assigned
+    def code=(code)
+      if !code.nil? && code.to_s.length > 30
+        fail ArgumentError, 'invalid value for "code", the character length must be smaller than or equal to 30.'
+      end
+
+      @code = code
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] name Value to be assigned
+    def name=(name)
+      if !name.nil? && name.to_s.length > 50
+        fail ArgumentError, 'invalid value for "name", the character length must be smaller than or equal to 50.'
+      end
+
+      @name = name
+    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 &&
+          code == o.code &&
+          name == o.name &&
+          item_id == o.item_id
+    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
+      [code, name, item_id].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