cybersource_rest_client 0.0.86 → 0.0.88

data/lib/cybersource_rest_client/models/vpri_request.rb

@@ -0,0 +1,505 @@
+=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
+  # Unified risk assessment request with action-based routing
+  class VpriRequest
+    # Actions to perform. For VPRI, specify VISA_PROTECT_RISK_INSIGHTS. Multiple actions may be included in a single request to invoke additional services simultaneously.
+    attr_accessor :actions
+
+    # The events to be performed under specific actions. For VISA_PROTECT_RISK_INSIGHTS, supported values are LABELS and INSIGHTS.
+    attr_accessor :events
+
+    attr_accessor :transaction
+
+    # Unique identifier for the risk assessment request
+    attr_accessor :request_id
+
+    # The time that the real-world event occurred.
+    attr_accessor :event_time
+
+    # The context in which the request is made.
+    attr_accessor :context
+
+    # Indicates whether the request is live or a test.
+    attr_accessor :mode
+
+    # Brief description or comments about the request
+    attr_accessor :request_comments
+
+    # Version of the request schema
+    attr_accessor :schema_version
+
+    attr_accessor :partner
+
+    attr_accessor :payment
+
+    attr_accessor :order
+
+    attr_accessor :customer
+
+    attr_accessor :risk_assessment
+
+    attr_accessor :travel
+
+    attr_accessor :merchant
+
+    attr_accessor :acquirer
+
+    attr_accessor :device
+
+    attr_accessor :session
+
+    # Free-form field for information not catered for by other components. Must not contain cardholder data or sensitive auth data.
+    attr_accessor :supplementary_data
+
+    attr_accessor :labels
+
+    attr_accessor :account
+
+    attr_accessor :authentication
+
+    attr_accessor :authorization
+
+    attr_accessor :browser
+
+    attr_accessor :initiating_party
+
+    attr_accessor :terminal
+
+    attr_accessor :third_party_risk
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'actions' => :'actions',
+        :'events' => :'events',
+        :'transaction' => :'transaction',
+        :'request_id' => :'requestId',
+        :'event_time' => :'eventTime',
+        :'context' => :'context',
+        :'mode' => :'mode',
+        :'request_comments' => :'requestComments',
+        :'schema_version' => :'schemaVersion',
+        :'partner' => :'partner',
+        :'payment' => :'payment',
+        :'order' => :'order',
+        :'customer' => :'customer',
+        :'risk_assessment' => :'riskAssessment',
+        :'travel' => :'travel',
+        :'merchant' => :'merchant',
+        :'acquirer' => :'acquirer',
+        :'device' => :'device',
+        :'session' => :'session',
+        :'supplementary_data' => :'supplementaryData',
+        :'labels' => :'labels',
+        :'account' => :'account',
+        :'authentication' => :'authentication',
+        :'authorization' => :'authorization',
+        :'browser' => :'browser',
+        :'initiating_party' => :'initiatingParty',
+        :'terminal' => :'terminal',
+        :'third_party_risk' => :'thirdPartyRisk'
+      }
+    end
+
+    # Attribute mapping from JSON key to ruby-style variable name.
+    def self.json_map
+      {
+        :'actions' => :'actions',
+        :'events' => :'events',
+        :'transaction' => :'transaction',
+        :'request_id' => :'request_id',
+        :'event_time' => :'event_time',
+        :'context' => :'context',
+        :'mode' => :'mode',
+        :'request_comments' => :'request_comments',
+        :'schema_version' => :'schema_version',
+        :'partner' => :'partner',
+        :'payment' => :'payment',
+        :'order' => :'order',
+        :'customer' => :'customer',
+        :'risk_assessment' => :'risk_assessment',
+        :'travel' => :'travel',
+        :'merchant' => :'merchant',
+        :'acquirer' => :'acquirer',
+        :'device' => :'device',
+        :'session' => :'session',
+        :'supplementary_data' => :'supplementary_data',
+        :'labels' => :'labels',
+        :'account' => :'account',
+        :'authentication' => :'authentication',
+        :'authorization' => :'authorization',
+        :'browser' => :'browser',
+        :'initiating_party' => :'initiating_party',
+        :'terminal' => :'terminal',
+        :'third_party_risk' => :'third_party_risk'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'actions' => :'Array<String>',
+        :'events' => :'Array<String>',
+        :'transaction' => :'UnifiedriskTransaction',
+        :'request_id' => :'String',
+        :'event_time' => :'DateTime',
+        :'context' => :'String',
+        :'mode' => :'String',
+        :'request_comments' => :'String',
+        :'schema_version' => :'Integer',
+        :'partner' => :'UnifiedriskPartner',
+        :'payment' => :'UnifiedriskPayment',
+        :'order' => :'UnifiedriskOrder',
+        :'customer' => :'UnifiedriskCustomer',
+        :'risk_assessment' => :'UnifiedriskRiskAssessment',
+        :'travel' => :'UnifiedriskTravel',
+        :'merchant' => :'UnifiedriskMerchant',
+        :'acquirer' => :'UnifiedriskAcquirer',
+        :'device' => :'UnifiedriskDevice',
+        :'session' => :'UnifiedriskSession',
+        :'supplementary_data' => :'String',
+        :'labels' => :'UnifiedriskLabels',
+        :'account' => :'UnifiedriskAccount',
+        :'authentication' => :'UnifiedriskAuthentication',
+        :'authorization' => :'UnifiedriskAuthorization',
+        :'browser' => :'UnifiedriskBrowser',
+        :'initiating_party' => :'UnifiedriskInitiatingParty',
+        :'terminal' => :'UnifiedriskTerminal',
+        :'third_party_risk' => :'UnifiedriskThirdPartyRisk'
+      }
+    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?(:'actions')
+        if (value = attributes[:'actions']).is_a?(Array)
+          self.actions = value
+        end
+      end
+
+      if attributes.has_key?(:'events')
+        if (value = attributes[:'events']).is_a?(Array)
+          self.events = value
+        end
+      end
+
+      if attributes.has_key?(:'transaction')
+        self.transaction = attributes[:'transaction']
+      end
+
+      if attributes.has_key?(:'requestId')
+        self.request_id = attributes[:'requestId']
+      end
+
+      if attributes.has_key?(:'eventTime')
+        self.event_time = attributes[:'eventTime']
+      end
+
+      if attributes.has_key?(:'context')
+        self.context = attributes[:'context']
+      end
+
+      if attributes.has_key?(:'mode')
+        self.mode = attributes[:'mode']
+      end
+
+      if attributes.has_key?(:'requestComments')
+        self.request_comments = attributes[:'requestComments']
+      end
+
+      if attributes.has_key?(:'schemaVersion')
+        self.schema_version = attributes[:'schemaVersion']
+      end
+
+      if attributes.has_key?(:'partner')
+        self.partner = attributes[:'partner']
+      end
+
+      if attributes.has_key?(:'payment')
+        self.payment = attributes[:'payment']
+      end
+
+      if attributes.has_key?(:'order')
+        self.order = attributes[:'order']
+      end
+
+      if attributes.has_key?(:'customer')
+        self.customer = attributes[:'customer']
+      end
+
+      if attributes.has_key?(:'riskAssessment')
+        self.risk_assessment = attributes[:'riskAssessment']
+      end
+
+      if attributes.has_key?(:'travel')
+        self.travel = attributes[:'travel']
+      end
+
+      if attributes.has_key?(:'merchant')
+        self.merchant = attributes[:'merchant']
+      end
+
+      if attributes.has_key?(:'acquirer')
+        self.acquirer = attributes[:'acquirer']
+      end
+
+      if attributes.has_key?(:'device')
+        self.device = attributes[:'device']
+      end
+
+      if attributes.has_key?(:'session')
+        self.session = attributes[:'session']
+      end
+
+      if attributes.has_key?(:'supplementaryData')
+        self.supplementary_data = attributes[:'supplementaryData']
+      end
+
+      if attributes.has_key?(:'labels')
+        self.labels = attributes[:'labels']
+      end
+
+      if attributes.has_key?(:'account')
+        self.account = attributes[:'account']
+      end
+
+      if attributes.has_key?(:'authentication')
+        self.authentication = attributes[:'authentication']
+      end
+
+      if attributes.has_key?(:'authorization')
+        self.authorization = attributes[:'authorization']
+      end
+
+      if attributes.has_key?(:'browser')
+        self.browser = attributes[:'browser']
+      end
+
+      if attributes.has_key?(:'initiatingParty')
+        self.initiating_party = attributes[:'initiatingParty']
+      end
+
+      if attributes.has_key?(:'terminal')
+        self.terminal = attributes[:'terminal']
+      end
+
+      if attributes.has_key?(:'thirdPartyRisk')
+        self.third_party_risk = attributes[:'thirdPartyRisk']
+      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 @actions.nil?
+        invalid_properties.push('invalid value for "actions", actions cannot be nil.')
+      end
+
+      if @events.nil?
+        invalid_properties.push('invalid value for "events", events cannot be nil.')
+      end
+
+      if @transaction.nil?
+        invalid_properties.push('invalid value for "transaction", transaction cannot be nil.')
+      end
+
+      if @event_time.nil?
+        invalid_properties.push('invalid value for "event_time", event_time 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 @actions.nil?
+      return false if @events.nil?
+      return false if @transaction.nil?
+      return false if @event_time.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] mode Value to be assigned
+    def mode=(mode)
+      @mode = mode
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] request_comments Value to be assigned
+    def request_comments=(request_comments)
+      @request_comments = request_comments
+    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 &&
+          actions == o.actions &&
+          events == o.events &&
+          transaction == o.transaction &&
+          request_id == o.request_id &&
+          event_time == o.event_time &&
+          context == o.context &&
+          mode == o.mode &&
+          request_comments == o.request_comments &&
+          schema_version == o.schema_version &&
+          partner == o.partner &&
+          payment == o.payment &&
+          order == o.order &&
+          customer == o.customer &&
+          risk_assessment == o.risk_assessment &&
+          travel == o.travel &&
+          merchant == o.merchant &&
+          acquirer == o.acquirer &&
+          device == o.device &&
+          session == o.session &&
+          supplementary_data == o.supplementary_data &&
+          labels == o.labels &&
+          account == o.account &&
+          authentication == o.authentication &&
+          authorization == o.authorization &&
+          browser == o.browser &&
+          initiating_party == o.initiating_party &&
+          terminal == o.terminal &&
+          third_party_risk == o.third_party_risk
+    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
+      [actions, events, transaction, request_id, event_time, context, mode, request_comments, schema_version, partner, payment, order, customer, risk_assessment, travel, merchant, acquirer, device, session, supplementary_data, labels, account, authentication, authorization, browser, initiating_party, terminal, third_party_risk].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/vpri_transaction_insights_additional_data.rb

@@ -0,0 +1,190 @@
+=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
+  # Supplementary data enriching the transaction risk assessment, such as card BIN metadata.
+  class VpriTransactionInsightsAdditionalData
+    attr_accessor :card_bin_data
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'card_bin_data' => :'cardBinData'
+      }
+    end
+
+    # Attribute mapping from JSON key to ruby-style variable name.
+    def self.json_map
+      {
+        :'card_bin_data' => :'card_bin_data'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'card_bin_data' => :'VpriTransactionInsightsAdditionalDataCardBinData'
+      }
+    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?(:'cardBinData')
+        self.card_bin_data = attributes[:'cardBinData']
+      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 &&
+          card_bin_data == o.card_bin_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
+      [card_bin_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