cybersource_rest_client 0.0.86 → 0.0.87

data/lib/cybersource_rest_client/models/unifiedrisk_payment_card_token_details.rb

@@ -0,0 +1,380 @@
+=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
+  class UnifiedriskPaymentCardTokenDetails
+    # Token provider type: network_token or merchant_token      Possible values: - network_token - merchant_token
+    attr_accessor :provider_type
+
+    # Type of payment credential being used. Visa, MasterCard, AMEX
+    attr_accessor :type
+
+    # Transient Token JWT ID
+    attr_accessor :jti
+
+    # Token number replacing PAN    
+    attr_accessor :number
+
+    # Token expiration month    
+    attr_accessor :expiration_month
+
+    # Token expiration year    
+    attr_accessor :expiration_year
+
+    # BIN from underlying card    
+    attr_accessor :bin
+
+    # Last 4 digits of card    
+    attr_accessor :last4
+
+    # Combined expiration date of the network token in MMYYYY format, used when the token's lifecycle is managed separately from the underlying PAN
+    attr_accessor :expiration_date
+
+    # Unique identifier of the token requestor (e.g., merchant or PSP) registered with the token service provider for DPAN provisioning and lifecycle management
+    attr_accessor :requestor_id
+
+    # A cryptographic value generated during tokenization (TAVV or CAVV) that authenticates the token for a specific transaction, preventing token replay attacks
+    attr_accessor :cryptogram
+
+    # Current lifecycle status of the network token (e.g., ACTIVE, SUSPENDED, DEACTIVATED). Tokens that are not ACTIVE should not be used for payment
+    attr_accessor :status
+
+    # Indicates the validity or expiry state of the cryptogram, helping detect stale or replayed token authentication attempts
+    attr_accessor :cryptogra_validity
+
+    # Indicates the authentication assurance level of the token provisioning process (e.g., APP_VERIFIED, CARDHOLDER_VERIFIED), impacting liability shift decisions
+    attr_accessor :assurance_method
+
+    # Supplementary data associated with the network token, such as merchant category restrictions, wallet provider metadata, or tokenization service payload extensions
+    attr_accessor :additional_data
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'provider_type' => :'providerType',
+        :'type' => :'type',
+        :'jti' => :'jti',
+        :'number' => :'number',
+        :'expiration_month' => :'expirationMonth',
+        :'expiration_year' => :'expirationYear',
+        :'bin' => :'bin',
+        :'last4' => :'last4',
+        :'expiration_date' => :'expirationDate',
+        :'requestor_id' => :'requestorId',
+        :'cryptogram' => :'cryptogram',
+        :'status' => :'status',
+        :'cryptogra_validity' => :'cryptograValidity',
+        :'assurance_method' => :'assuranceMethod',
+        :'additional_data' => :'additionalData'
+      }
+    end
+
+    # Attribute mapping from JSON key to ruby-style variable name.
+    def self.json_map
+      {
+        :'provider_type' => :'provider_type',
+        :'type' => :'type',
+        :'jti' => :'jti',
+        :'number' => :'number',
+        :'expiration_month' => :'expiration_month',
+        :'expiration_year' => :'expiration_year',
+        :'bin' => :'bin',
+        :'last4' => :'last4',
+        :'expiration_date' => :'expiration_date',
+        :'requestor_id' => :'requestor_id',
+        :'cryptogram' => :'cryptogram',
+        :'status' => :'status',
+        :'cryptogra_validity' => :'cryptogra_validity',
+        :'assurance_method' => :'assurance_method',
+        :'additional_data' => :'additional_data'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'provider_type' => :'String',
+        :'type' => :'String',
+        :'jti' => :'String',
+        :'number' => :'String',
+        :'expiration_month' => :'String',
+        :'expiration_year' => :'String',
+        :'bin' => :'String',
+        :'last4' => :'String',
+        :'expiration_date' => :'String',
+        :'requestor_id' => :'String',
+        :'cryptogram' => :'String',
+        :'status' => :'String',
+        :'cryptogra_validity' => :'String',
+        :'assurance_method' => :'String',
+        :'additional_data' => :'String'
+      }
+    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?(:'providerType')
+        self.provider_type = attributes[:'providerType']
+      end
+
+      if attributes.has_key?(:'type')
+        self.type = attributes[:'type']
+      end
+
+      if attributes.has_key?(:'jti')
+        self.jti = attributes[:'jti']
+      end
+
+      if attributes.has_key?(:'number')
+        self.number = attributes[:'number']
+      end
+
+      if attributes.has_key?(:'expirationMonth')
+        self.expiration_month = attributes[:'expirationMonth']
+      end
+
+      if attributes.has_key?(:'expirationYear')
+        self.expiration_year = attributes[:'expirationYear']
+      end
+
+      if attributes.has_key?(:'bin')
+        self.bin = attributes[:'bin']
+      end
+
+      if attributes.has_key?(:'last4')
+        self.last4 = attributes[:'last4']
+      end
+
+      if attributes.has_key?(:'expirationDate')
+        self.expiration_date = attributes[:'expirationDate']
+      end
+
+      if attributes.has_key?(:'requestorId')
+        self.requestor_id = attributes[:'requestorId']
+      end
+
+      if attributes.has_key?(:'cryptogram')
+        self.cryptogram = attributes[:'cryptogram']
+      end
+
+      if attributes.has_key?(:'status')
+        self.status = attributes[:'status']
+      end
+
+      if attributes.has_key?(:'cryptograValidity')
+        self.cryptogra_validity = attributes[:'cryptograValidity']
+      end
+
+      if attributes.has_key?(:'assuranceMethod')
+        self.assurance_method = attributes[:'assuranceMethod']
+      end
+
+      if attributes.has_key?(:'additionalData')
+        self.additional_data = attributes[:'additionalData']
+      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] jti Value to be assigned
+    def jti=(jti)
+      @jti = jti
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] number Value to be assigned
+    def number=(number)
+      @number = number
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] expiration_month Value to be assigned
+    def expiration_month=(expiration_month)
+      @expiration_month = expiration_month
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] expiration_year Value to be assigned
+    def expiration_year=(expiration_year)
+      @expiration_year = expiration_year
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] bin Value to be assigned
+    def bin=(bin)
+      @bin = bin
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] last4 Value to be assigned
+    def last4=(last4)
+      @last4 = last4
+    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 &&
+          provider_type == o.provider_type &&
+          type == o.type &&
+          jti == o.jti &&
+          number == o.number &&
+          expiration_month == o.expiration_month &&
+          expiration_year == o.expiration_year &&
+          bin == o.bin &&
+          last4 == o.last4 &&
+          expiration_date == o.expiration_date &&
+          requestor_id == o.requestor_id &&
+          cryptogram == o.cryptogram &&
+          status == o.status &&
+          cryptogra_validity == o.cryptogra_validity &&
+          assurance_method == o.assurance_method &&
+          additional_data == o.additional_data
+    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
+      [provider_type, type, jti, number, expiration_month, expiration_year, bin, last4, expiration_date, requestor_id, cryptogram, status, cryptogra_validity, assurance_method, additional_data].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

data/lib/cybersource_rest_client/models/unifiedrisk_payment_check.rb

@@ -0,0 +1,289 @@
+=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 check-specific payment details including MICR line data, deposit location, and split deposit information
+  class UnifiedriskPaymentCheck
+    # Serial number printed on the physical check, used for duplicate detection, check fraud prevention, and reconciliation
+    attr_accessor :check_number
+
+    # Unique identifier for the deposit slip associated with the check deposit, used for linking deposited checks to branch transactions
+    attr_accessor :deposit_slip_id
+
+    attr_accessor :deposit_location
+
+    # Account number encoded in the MICR (Magnetic Ink Character Recognition) line at the bottom of the check, used for automated account identification
+    attr_accessor :micr_account_number
+
+    # Bank routing and transit number (RTN) encoded in the MICR line of the check, identifying the financial institution on which the check is drawn
+    attr_accessor :routing_transit_number
+
+    # Indicates whether the check deposit has been split across multiple accounts. Split deposits may indicate structuring or kiting attempts
+    attr_accessor :split_deposit_flag
+
+    # First destination account ID in a split check deposit, used for tracking the allocation of funds across multiple accounts
+    attr_accessor :split_account_id1
+
+    # Second destination account ID in a split check deposit
+    attr_accessor :split_account_id2
+
+    # Third destination account ID in a split check deposit
+    attr_accessor :split_account_id3
+
+    # Fourth destination account ID in a split check deposit
+    attr_accessor :split_account_id4
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'check_number' => :'checkNumber',
+        :'deposit_slip_id' => :'depositSlipId',
+        :'deposit_location' => :'depositLocation',
+        :'micr_account_number' => :'micrAccountNumber',
+        :'routing_transit_number' => :'routingTransitNumber',
+        :'split_deposit_flag' => :'splitDepositFlag',
+        :'split_account_id1' => :'splitAccountId1',
+        :'split_account_id2' => :'splitAccountId2',
+        :'split_account_id3' => :'splitAccountId3',
+        :'split_account_id4' => :'splitAccountId4'
+      }
+    end
+
+    # Attribute mapping from JSON key to ruby-style variable name.
+    def self.json_map
+      {
+        :'check_number' => :'check_number',
+        :'deposit_slip_id' => :'deposit_slip_id',
+        :'deposit_location' => :'deposit_location',
+        :'micr_account_number' => :'micr_account_number',
+        :'routing_transit_number' => :'routing_transit_number',
+        :'split_deposit_flag' => :'split_deposit_flag',
+        :'split_account_id1' => :'split_account_id1',
+        :'split_account_id2' => :'split_account_id2',
+        :'split_account_id3' => :'split_account_id3',
+        :'split_account_id4' => :'split_account_id4'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'check_number' => :'String',
+        :'deposit_slip_id' => :'String',
+        :'deposit_location' => :'UnifiedriskPaymentCheckDepositLocation',
+        :'micr_account_number' => :'String',
+        :'routing_transit_number' => :'String',
+        :'split_deposit_flag' => :'BOOLEAN',
+        :'split_account_id1' => :'String',
+        :'split_account_id2' => :'String',
+        :'split_account_id3' => :'String',
+        :'split_account_id4' => :'String'
+      }
+    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?(:'checkNumber')
+        self.check_number = attributes[:'checkNumber']
+      end
+
+      if attributes.has_key?(:'depositSlipId')
+        self.deposit_slip_id = attributes[:'depositSlipId']
+      end
+
+      if attributes.has_key?(:'depositLocation')
+        self.deposit_location = attributes[:'depositLocation']
+      end
+
+      if attributes.has_key?(:'micrAccountNumber')
+        self.micr_account_number = attributes[:'micrAccountNumber']
+      end
+
+      if attributes.has_key?(:'routingTransitNumber')
+        self.routing_transit_number = attributes[:'routingTransitNumber']
+      end
+
+      if attributes.has_key?(:'splitDepositFlag')
+        self.split_deposit_flag = attributes[:'splitDepositFlag']
+      end
+
+      if attributes.has_key?(:'splitAccountId1')
+        self.split_account_id1 = attributes[:'splitAccountId1']
+      end
+
+      if attributes.has_key?(:'splitAccountId2')
+        self.split_account_id2 = attributes[:'splitAccountId2']
+      end
+
+      if attributes.has_key?(:'splitAccountId3')
+        self.split_account_id3 = attributes[:'splitAccountId3']
+      end
+
+      if attributes.has_key?(:'splitAccountId4')
+        self.split_account_id4 = attributes[:'splitAccountId4']
+      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 &&
+          check_number == o.check_number &&
+          deposit_slip_id == o.deposit_slip_id &&
+          deposit_location == o.deposit_location &&
+          micr_account_number == o.micr_account_number &&
+          routing_transit_number == o.routing_transit_number &&
+          split_deposit_flag == o.split_deposit_flag &&
+          split_account_id1 == o.split_account_id1 &&
+          split_account_id2 == o.split_account_id2 &&
+          split_account_id3 == o.split_account_id3 &&
+          split_account_id4 == o.split_account_id4
+    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
+      [check_number, deposit_slip_id, deposit_location, micr_account_number, routing_transit_number, split_deposit_flag, split_account_id1, split_account_id2, split_account_id3, split_account_id4].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