cybersource_rest_client 0.0.86 → 0.0.88

data/lib/cybersource_rest_client/models/vpri_transaction_insights_additional_data_card_bin_data.rb

@@ -0,0 +1,357 @@
+=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
+  # Card BIN (Bank Identification Number) metadata returned by the BIN lookup service. Present when BIN lookup succeeds; absent on no-match or lookup error.
+  class VpriTransactionInsightsAdditionalDataCardBinData
+    # The BIN submitted for lookup, consisting of the first 6 or 8 digits of the card number, identifying the issuing institution.
+    attr_accessor :issuer_bin
+
+    # ISO 3166-1 alpha-2 country code of the card-issuing institution. Useful for detecting geographic mismatches between issuer and transaction origin.
+    attr_accessor :issuer_bin_country
+
+    # Full name of the card-issuing bank or financial institution.
+    attr_accessor :issuer_name
+
+    # Resolved card BIN returned by the lookup service, which may differ from issuerBin in certain co-branded or affiliated card scenarios.
+    attr_accessor :card_bin
+
+    # Funding source type of the card indicating how transactions are funded (e.g., CREDIT, DEBIT, PREPAID). Used for risk segmentation by payment method.
+    attr_accessor :card_funding_source
+
+    # Sub-classification of the funding source (e.g., business, consumer). Enables more granular risk profiling within a funding source category.
+    attr_accessor :card_funding_source_sub_type
+
+    # Card network brand code (e.g., 001 for Visa, 002 for Mastercard). Used for brand-specific fraud rule application.
+    attr_accessor :card_brand
+
+    # Product identifier for the card product issued. May be an alphanumeric code or a product name depending on the issuer.
+    attr_accessor :card_product_id
+
+    # Human-readable description of the card product. Useful for client-facing displays or product-level fraud analysis.
+    attr_accessor :card_product_description
+
+    # Result status of the BIN lookup. Indicates whether the BIN was successfully matched in the lookup service.  Possible values: - matched - no_match - error
+    attr_accessor :status
+
+    # BIN-lookup-specific warnings. An empty array indicates a clean lookup. Warning codes include BIN_NO_MATCH, BIN_INPUT_MISSING, BIN_LOOKUP_ERROR, BIN_AMBIGUOUS, BIN_LOOKUP_INPUT_ERROR.
+    attr_accessor :warnings
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'issuer_bin' => :'issuerBin',
+        :'issuer_bin_country' => :'issuerBinCountry',
+        :'issuer_name' => :'issuerName',
+        :'card_bin' => :'cardBin',
+        :'card_funding_source' => :'cardFundingSource',
+        :'card_funding_source_sub_type' => :'cardFundingSourceSubType',
+        :'card_brand' => :'cardBrand',
+        :'card_product_id' => :'cardProductID',
+        :'card_product_description' => :'cardProductDescription',
+        :'status' => :'status',
+        :'warnings' => :'warnings'
+      }
+    end
+
+    # Attribute mapping from JSON key to ruby-style variable name.
+    def self.json_map
+      {
+        :'issuer_bin' => :'issuer_bin',
+        :'issuer_bin_country' => :'issuer_bin_country',
+        :'issuer_name' => :'issuer_name',
+        :'card_bin' => :'card_bin',
+        :'card_funding_source' => :'card_funding_source',
+        :'card_funding_source_sub_type' => :'card_funding_source_sub_type',
+        :'card_brand' => :'card_brand',
+        :'card_product_id' => :'card_product_id',
+        :'card_product_description' => :'card_product_description',
+        :'status' => :'status',
+        :'warnings' => :'warnings'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'issuer_bin' => :'String',
+        :'issuer_bin_country' => :'String',
+        :'issuer_name' => :'String',
+        :'card_bin' => :'String',
+        :'card_funding_source' => :'String',
+        :'card_funding_source_sub_type' => :'String',
+        :'card_brand' => :'String',
+        :'card_product_id' => :'String',
+        :'card_product_description' => :'String',
+        :'status' => :'String',
+        :'warnings' => :'Array<UnifiedRiskPost201ResponseResultsRISKINSIGHTSPackagesTransactionInsightsInsightsWarnings>'
+      }
+    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?(:'issuerBin')
+        self.issuer_bin = attributes[:'issuerBin']
+      end
+
+      if attributes.has_key?(:'issuerBinCountry')
+        self.issuer_bin_country = attributes[:'issuerBinCountry']
+      end
+
+      if attributes.has_key?(:'issuerName')
+        self.issuer_name = attributes[:'issuerName']
+      end
+
+      if attributes.has_key?(:'cardBin')
+        self.card_bin = attributes[:'cardBin']
+      end
+
+      if attributes.has_key?(:'cardFundingSource')
+        self.card_funding_source = attributes[:'cardFundingSource']
+      end
+
+      if attributes.has_key?(:'cardFundingSourceSubType')
+        self.card_funding_source_sub_type = attributes[:'cardFundingSourceSubType']
+      end
+
+      if attributes.has_key?(:'cardBrand')
+        self.card_brand = attributes[:'cardBrand']
+      end
+
+      if attributes.has_key?(:'cardProductID')
+        self.card_product_id = attributes[:'cardProductID']
+      end
+
+      if attributes.has_key?(:'cardProductDescription')
+        self.card_product_description = attributes[:'cardProductDescription']
+      end
+
+      if attributes.has_key?(:'status')
+        self.status = attributes[:'status']
+      end
+
+      if attributes.has_key?(:'warnings')
+        if (value = attributes[:'warnings']).is_a?(Array)
+          self.warnings = value
+        end
+      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
+
+    # Custom attribute writer method with validation
+    # @param [Object] issuer_bin Value to be assigned
+    def issuer_bin=(issuer_bin)
+      @issuer_bin = issuer_bin
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] issuer_bin_country Value to be assigned
+    def issuer_bin_country=(issuer_bin_country)
+      @issuer_bin_country = issuer_bin_country
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] issuer_name Value to be assigned
+    def issuer_name=(issuer_name)
+      @issuer_name = issuer_name
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] card_bin Value to be assigned
+    def card_bin=(card_bin)
+      @card_bin = card_bin
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] card_funding_source Value to be assigned
+    def card_funding_source=(card_funding_source)
+      @card_funding_source = card_funding_source
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] card_funding_source_sub_type Value to be assigned
+    def card_funding_source_sub_type=(card_funding_source_sub_type)
+      @card_funding_source_sub_type = card_funding_source_sub_type
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] card_brand Value to be assigned
+    def card_brand=(card_brand)
+      @card_brand = card_brand
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] card_product_id Value to be assigned
+    def card_product_id=(card_product_id)
+      @card_product_id = card_product_id
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] card_product_description Value to be assigned
+    def card_product_description=(card_product_description)
+      @card_product_description = card_product_description
+    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 &&
+          issuer_bin == o.issuer_bin &&
+          issuer_bin_country == o.issuer_bin_country &&
+          issuer_name == o.issuer_name &&
+          card_bin == o.card_bin &&
+          card_funding_source == o.card_funding_source &&
+          card_funding_source_sub_type == o.card_funding_source_sub_type &&
+          card_brand == o.card_brand &&
+          card_product_id == o.card_product_id &&
+          card_product_description == o.card_product_description &&
+          status == o.status &&
+          warnings == o.warnings
+    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
+      [issuer_bin, issuer_bin_country, issuer_name, card_bin, card_funding_source, card_funding_source_sub_type, card_brand, card_product_id, card_product_description, status, warnings].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