cybersource_rest_client 0.0.86 → 0.0.87

data/lib/cybersource_rest_client/models/unifiedrisk_payment_batch.rb

@@ -0,0 +1,323 @@
+=begin
+#CyberSource Merged Spec
+
+#All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html
+
+OpenAPI spec version: 0.0.1
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.38
+=end
+
+require 'date'
+
+module CyberSource
+  # Container for ACH/BACS batch payment metadata including file control fields, batch counts, and integrity checksums
+  class UnifiedriskPaymentBatch
+    # Unique sequential identifier for this batch within the batch file, used for tracking and reconciliation of ACH or BACS batch submissions
+    attr_accessor :batch_number
+
+    # Human-readable description of the business purpose for the batch (e.g., \"Payroll\", \"Vendor Payments\"). Corresponds to the ISO 20022 CategoryPurpose code
+    attr_accessor :category_purpose_description
+
+    # Indicates this entry is the last record in the current batch. Used to signal batch boundary during file processing
+    attr_accessor :end_of_batch_indicator
+
+    # Indicates this entry is the last record in the entire batch file. Used to trigger final file validation and processing
+    attr_accessor :end_of_file_indicator
+
+    # Sequential record number of the entry detail record within the batch, used for file integrity checks and record-level reconciliation
+    attr_accessor :entry_detail_rec_num
+
+    # Single character modifier (A-Z) used to distinguish multiple batch files submitted on the same day for the same originator
+    attr_accessor :file_id_modifier
+
+    # Count of addenda records associated with this batch entry, used for validating batch completeness during file processing
+    attr_accessor :number_of_addenda_records
+
+    # ACH service class code indicating the type of entries in the batch. Values - \"200\" (mixed), \"220\" (credits only), \"225\" (debits only), \"280\" (automated accounting)
+    attr_accessor :service_class_code
+
+    # Total number of batches contained in this file, used for file-level control validation and balancing
+    attr_accessor :total_batch_count_in_file
+
+    # Total count of entry detail records within this batch, used for batch-level balancing and reconciliation
+    attr_accessor :total_batch_entries
+
+    # Total count of all entry detail records across all batches in the file, used for file-level reconciliation
+    attr_accessor :total_entry_count_in_file
+
+    # Arithmetic sum of all routing transit numbers within the batch/file, used as a checksum for routing number validation
+    attr_accessor :total_entry_hash
+
+    # Total count of distinct routing transit numbers in the file, used for clearing house validation and routing verification
+    attr_accessor :total_transit_count_in_file
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'batch_number' => :'batchNumber',
+        :'category_purpose_description' => :'categoryPurposeDescription',
+        :'end_of_batch_indicator' => :'endOfBatchIndicator',
+        :'end_of_file_indicator' => :'endOfFileIndicator',
+        :'entry_detail_rec_num' => :'entryDetailRecNum',
+        :'file_id_modifier' => :'fileIdModifier',
+        :'number_of_addenda_records' => :'numberOfAddendaRecords',
+        :'service_class_code' => :'serviceClassCode',
+        :'total_batch_count_in_file' => :'totalBatchCountInFile',
+        :'total_batch_entries' => :'totalBatchEntries',
+        :'total_entry_count_in_file' => :'totalEntryCountInFile',
+        :'total_entry_hash' => :'totalEntryHash',
+        :'total_transit_count_in_file' => :'totalTransitCountInFile'
+      }
+    end
+
+    # Attribute mapping from JSON key to ruby-style variable name.
+    def self.json_map
+      {
+        :'batch_number' => :'batch_number',
+        :'category_purpose_description' => :'category_purpose_description',
+        :'end_of_batch_indicator' => :'end_of_batch_indicator',
+        :'end_of_file_indicator' => :'end_of_file_indicator',
+        :'entry_detail_rec_num' => :'entry_detail_rec_num',
+        :'file_id_modifier' => :'file_id_modifier',
+        :'number_of_addenda_records' => :'number_of_addenda_records',
+        :'service_class_code' => :'service_class_code',
+        :'total_batch_count_in_file' => :'total_batch_count_in_file',
+        :'total_batch_entries' => :'total_batch_entries',
+        :'total_entry_count_in_file' => :'total_entry_count_in_file',
+        :'total_entry_hash' => :'total_entry_hash',
+        :'total_transit_count_in_file' => :'total_transit_count_in_file'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'batch_number' => :'String',
+        :'category_purpose_description' => :'String',
+        :'end_of_batch_indicator' => :'BOOLEAN',
+        :'end_of_file_indicator' => :'BOOLEAN',
+        :'entry_detail_rec_num' => :'Float',
+        :'file_id_modifier' => :'String',
+        :'number_of_addenda_records' => :'Float',
+        :'service_class_code' => :'String',
+        :'total_batch_count_in_file' => :'Float',
+        :'total_batch_entries' => :'Float',
+        :'total_entry_count_in_file' => :'Float',
+        :'total_entry_hash' => :'Float',
+        :'total_transit_count_in_file' => :'Float'
+      }
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      return unless attributes.is_a?(Hash)
+
+      # convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
+
+      if attributes.has_key?(:'batchNumber')
+        self.batch_number = attributes[:'batchNumber']
+      end
+
+      if attributes.has_key?(:'categoryPurposeDescription')
+        self.category_purpose_description = attributes[:'categoryPurposeDescription']
+      end
+
+      if attributes.has_key?(:'endOfBatchIndicator')
+        self.end_of_batch_indicator = attributes[:'endOfBatchIndicator']
+      end
+
+      if attributes.has_key?(:'endOfFileIndicator')
+        self.end_of_file_indicator = attributes[:'endOfFileIndicator']
+      end
+
+      if attributes.has_key?(:'entryDetailRecNum')
+        self.entry_detail_rec_num = attributes[:'entryDetailRecNum']
+      end
+
+      if attributes.has_key?(:'fileIdModifier')
+        self.file_id_modifier = attributes[:'fileIdModifier']
+      end
+
+      if attributes.has_key?(:'numberOfAddendaRecords')
+        self.number_of_addenda_records = attributes[:'numberOfAddendaRecords']
+      end
+
+      if attributes.has_key?(:'serviceClassCode')
+        self.service_class_code = attributes[:'serviceClassCode']
+      end
+
+      if attributes.has_key?(:'totalBatchCountInFile')
+        self.total_batch_count_in_file = attributes[:'totalBatchCountInFile']
+      end
+
+      if attributes.has_key?(:'totalBatchEntries')
+        self.total_batch_entries = attributes[:'totalBatchEntries']
+      end
+
+      if attributes.has_key?(:'totalEntryCountInFile')
+        self.total_entry_count_in_file = attributes[:'totalEntryCountInFile']
+      end
+
+      if attributes.has_key?(:'totalEntryHash')
+        self.total_entry_hash = attributes[:'totalEntryHash']
+      end
+
+      if attributes.has_key?(:'totalTransitCountInFile')
+        self.total_transit_count_in_file = attributes[:'totalTransitCountInFile']
+      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 &&
+          batch_number == o.batch_number &&
+          category_purpose_description == o.category_purpose_description &&
+          end_of_batch_indicator == o.end_of_batch_indicator &&
+          end_of_file_indicator == o.end_of_file_indicator &&
+          entry_detail_rec_num == o.entry_detail_rec_num &&
+          file_id_modifier == o.file_id_modifier &&
+          number_of_addenda_records == o.number_of_addenda_records &&
+          service_class_code == o.service_class_code &&
+          total_batch_count_in_file == o.total_batch_count_in_file &&
+          total_batch_entries == o.total_batch_entries &&
+          total_entry_count_in_file == o.total_entry_count_in_file &&
+          total_entry_hash == o.total_entry_hash &&
+          total_transit_count_in_file == o.total_transit_count_in_file
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Fixnum] Hash code
+    def hash
+      [batch_number, category_purpose_description, end_of_batch_indicator, end_of_file_indicator, entry_detail_rec_num, file_id_modifier, number_of_addenda_records, service_class_code, total_batch_count_in_file, total_batch_entries, total_entry_count_in_file, total_entry_hash, total_transit_count_in_file].hash
+    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.swagger_types.each_pair do |key, type|
+        if type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the the attribute
+          # is documented as an array but the input is not
+          if attributes[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{self.class.json_map[key]}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{self.class.json_map[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(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      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
+        temp_model = CyberSource.const_get(type).new
+        temp_model.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
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        next if value.nil?
+        hash[param] = _to_hash(value)
+      end
+      hash
+    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)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+  end
+end