xero-ruby 9.3.0 → 18.0.0

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

@@ -5477,92 +5477,6 @@ module XeroRuby
       return data, status_code, headers
     end
 
-    # Updates a pay run
-    # @param xero_tenant_id [String] Xero identifier for Tenant
-    # @param pay_run_id [String] Identifier for the pay run
-    # @param pay_run [PayRun] 
-    # @param [Hash] opts the optional parameters
-    # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
-    # @return [PayRunObject]
-    def update_pay_run(xero_tenant_id, pay_run_id, pay_run, opts = {})
-      data, _status_code, _headers = update_pay_run_with_http_info(xero_tenant_id, pay_run_id, pay_run, opts)
-      data
-    end
-
-    # Updates a pay run
-    # @param xero_tenant_id [String] Xero identifier for Tenant
-    # @param pay_run_id [String] Identifier for the pay run
-    # @param pay_run [PayRun] 
-    # @param [Hash] opts the optional parameters
-    # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
-    # @return [Array<(PayRunObject, Integer, Hash)>] PayRunObject data, response status code and response headers
-    def update_pay_run_with_http_info(xero_tenant_id, pay_run_id, pay_run, options = {})
-      opts = options.dup
-      if @api_client.config.debugging
-        @api_client.config.logger.debug 'Calling API: PayrollNzApi.update_pay_run ...'
-      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 PayrollNzApi.update_pay_run"
-      end
-      # verify the required parameter 'pay_run_id' is set
-      if @api_client.config.client_side_validation && pay_run_id.nil?
-        fail ArgumentError, "Missing the required parameter 'pay_run_id' when calling PayrollNzApi.update_pay_run"
-      end
-      # verify the required parameter 'pay_run' is set
-      if @api_client.config.client_side_validation && pay_run.nil?
-        fail ArgumentError, "Missing the required parameter 'pay_run' when calling PayrollNzApi.update_pay_run"
-      end
-      # resource path
-      local_var_path = '/PayRuns/{PayRunID}'.sub('{' + 'PayRunID' + '}', pay_run_id.to_s)
-
-      # 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] || {}
-      
-      # 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'])
-      # HTTP header 'Content-Type'
-      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
-      header_params[:'Xero-Tenant-Id'] = xero_tenant_id
-      header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil?
-
-      # form parameters
-      form_params = opts[:form_params] || {}
-
-      # http body (model)
-      post_body = opts[:body] || @api_client.object_to_http_body(pay_run) 
-
-      # return_type
-      return_type = opts[:return_type] || 'PayRunObject' 
-
-      # 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(:PUT, local_var_path, "PayrollNzApi", new_options)
-      if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: PayrollNzApi#update_pay_run\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
-      end
-      return data, status_code, headers
-    end
-
     # Creates an employee pay slip
     # @param xero_tenant_id [String] Xero identifier for Tenant
     # @param pay_slip_id [String] Identifier for the payslip

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

@@ -5379,92 +5379,6 @@ module XeroRuby
       return data, status_code, headers
     end
 
-    # Updates a specific pay run
-    # @param xero_tenant_id [String] Xero identifier for Tenant
-    # @param pay_run_id [String] Identifier for the pay run
-    # @param pay_run [PayRun] 
-    # @param [Hash] opts the optional parameters
-    # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
-    # @return [PayRunObject]
-    def update_pay_run(xero_tenant_id, pay_run_id, pay_run, opts = {})
-      data, _status_code, _headers = update_pay_run_with_http_info(xero_tenant_id, pay_run_id, pay_run, opts)
-      data
-    end
-
-    # Updates a specific pay run
-    # @param xero_tenant_id [String] Xero identifier for Tenant
-    # @param pay_run_id [String] Identifier for the pay run
-    # @param pay_run [PayRun] 
-    # @param [Hash] opts the optional parameters
-    # @option opts [String] :idempotency_key This allows you to safely retry requests without the risk of duplicate processing. 128 character max.
-    # @return [Array<(PayRunObject, Integer, Hash)>] PayRunObject data, response status code and response headers
-    def update_pay_run_with_http_info(xero_tenant_id, pay_run_id, pay_run, options = {})
-      opts = options.dup
-      if @api_client.config.debugging
-        @api_client.config.logger.debug 'Calling API: PayrollUkApi.update_pay_run ...'
-      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 PayrollUkApi.update_pay_run"
-      end
-      # verify the required parameter 'pay_run_id' is set
-      if @api_client.config.client_side_validation && pay_run_id.nil?
-        fail ArgumentError, "Missing the required parameter 'pay_run_id' when calling PayrollUkApi.update_pay_run"
-      end
-      # verify the required parameter 'pay_run' is set
-      if @api_client.config.client_side_validation && pay_run.nil?
-        fail ArgumentError, "Missing the required parameter 'pay_run' when calling PayrollUkApi.update_pay_run"
-      end
-      # resource path
-      local_var_path = '/PayRuns/{PayRunID}'.sub('{' + 'PayRunID' + '}', pay_run_id.to_s)
-
-      # 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] || {}
-      
-      # 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'])
-      # HTTP header 'Content-Type'
-      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
-      header_params[:'Xero-Tenant-Id'] = xero_tenant_id
-      header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil?
-
-      # form parameters
-      form_params = opts[:form_params] || {}
-
-      # http body (model)
-      post_body = opts[:body] || @api_client.object_to_http_body(pay_run) 
-
-      # return_type
-      return_type = opts[:return_type] || 'PayRunObject' 
-
-      # 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(:PUT, local_var_path, "PayrollUkApi", new_options)
-      if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: PayrollUkApi#update_pay_run\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
-      end
-      return data, status_code, headers
-    end
-
     # Updates a specific timesheet line for a specific timesheet
     # @param xero_tenant_id [String] Xero identifier for Tenant
     # @param timesheet_id [String] Identifier for the timesheet

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

@@ -55,9 +55,42 @@ module XeroRuby::Accounting
     # UTC timestamp of creation date of bank transfer
     attr_accessor :created_date_utc
     
+    # AUTHORISED or DELETED (read-only). New bank transfers will have a status of AUTHORISED.
+    attr_accessor :status
+    AUTHORISED ||= "AUTHORISED".freeze
+    DELETED ||= "DELETED".freeze
+    
+    # Optional Tracking Category for the source account – see Tracking. A bank transfer can have a maximum of 2 tracking categories per account.
+    attr_accessor :from_tracking
+    
+    # Optional Tracking Category for the destination account – see Tracking. A bank transfer can have a maximum of 2 tracking categories per account.
+    attr_accessor :to_tracking
+    
     # Displays array of validation error messages from the API
     attr_accessor :validation_errors
     
+    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
       {
@@ -74,6 +107,9 @@ module XeroRuby::Accounting
         :'reference' => :'Reference',
         :'has_attachments' => :'HasAttachments',
         :'created_date_utc' => :'CreatedDateUTC',
+        :'status' => :'Status',
+        :'from_tracking' => :'FromTracking',
+        :'to_tracking' => :'ToTracking',
         :'validation_errors' => :'ValidationErrors'
       }
     end
@@ -94,6 +130,9 @@ module XeroRuby::Accounting
         :'reference' => :'String',
         :'has_attachments' => :'Boolean',
         :'created_date_utc' => :'DateTime',
+        :'status' => :'String',
+        :'from_tracking' => :'Array<TrackingReference>',
+        :'to_tracking' => :'Array<TrackingReference>',
         :'validation_errors' => :'Array<ValidationError>'
       }
     end
@@ -171,6 +210,22 @@ module XeroRuby::Accounting
         self.created_date_utc = attributes[:'created_date_utc']
       end
 
+      if attributes.key?(:'status')
+        self.status = attributes[:'status']
+      end
+
+      if attributes.key?(:'from_tracking')
+        if (value = attributes[:'from_tracking']).is_a?(Array)
+          self.from_tracking = value
+        end
+      end
+
+      if attributes.key?(:'to_tracking')
+        if (value = attributes[:'to_tracking']).is_a?(Array)
+          self.to_tracking = value
+        end
+      end
+
       if attributes.key?(:'validation_errors')
         if (value = attributes[:'validation_errors']).is_a?(Array)
           self.validation_errors = value
@@ -203,9 +258,21 @@ module XeroRuby::Accounting
       return false if @from_bank_account.nil?
       return false if @to_bank_account.nil?
       return false if @amount.nil?
+      status_validator = EnumAttributeValidator.new('String', ["AUTHORISED", "DELETED"])
+      return false unless status_validator.valid?(@status)
       true
     end
 
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] status Object to be assigned
+    def status=(status)
+      validator = EnumAttributeValidator.new('String', ["AUTHORISED", "DELETED"])
+      unless validator.valid?(status)
+        fail ArgumentError, "invalid value for \"status\", must be one of #{validator.allowable_values}."
+      end
+      @status = status
+    end
+
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)
@@ -224,6 +291,9 @@ module XeroRuby::Accounting
           reference == o.reference &&
           has_attachments == o.has_attachments &&
           created_date_utc == o.created_date_utc &&
+          status == o.status &&
+          from_tracking == o.from_tracking &&
+          to_tracking == o.to_tracking &&
           validation_errors == o.validation_errors
     end
 
@@ -236,7 +306,7 @@ module XeroRuby::Accounting
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [from_bank_account, to_bank_account, amount, date, bank_transfer_id, currency_rate, from_bank_transaction_id, to_bank_transaction_id, from_is_reconciled, to_is_reconciled, reference, has_attachments, created_date_utc, validation_errors].hash
+      [from_bank_account, to_bank_account, amount, date, bank_transfer_id, currency_rate, from_bank_transaction_id, to_bank_transaction_id, from_is_reconciled, to_is_reconciled, reference, has_attachments, created_date_utc, status, from_tracking, to_tracking, validation_errors].hash
     end
 
     # Builds the object from hash

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

@@ -0,0 +1,244 @@
+=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 BankTransferDelete
+    # The Xero identifier for a bank transfer
+    attr_accessor :bank_transfer_id
+    
+    # The status of the bank transfer.
+    attr_accessor :status
+    
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'bank_transfer_id' => :'BankTransferID',
+        :'status' => :'Status'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'bank_transfer_id' => :'String',
+        :'status' => :'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::BankTransferDelete` 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::BankTransferDelete`. 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?(:'bank_transfer_id')
+        self.bank_transfer_id = attributes[:'bank_transfer_id']
+      end
+
+      if attributes.key?(:'status')
+        self.status = attributes[:'status']
+      else
+        self.status = 'DELETED'
+      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 @bank_transfer_id.nil?
+        invalid_properties.push('invalid value for "bank_transfer_id", bank_transfer_id cannot be nil.')
+      end
+
+      if @status.nil?
+        invalid_properties.push('invalid value for "status", status cannot be nil.')
+      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 @bank_transfer_id.nil?
+      return false if @status.nil?
+      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 &&
+          bank_transfer_id == o.bank_transfer_id &&
+          status == o.status
+    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
+      [bank_transfer_id, status].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