cybersource_rest_client 0.0.8 → 0.0.9

data/lib/cybersource_rest_client/models/pts_v2_payouts_post201_response_order_information_amount_details.rb

@@ -0,0 +1,274 @@
+=begin
+#CyberSource Flex API
+
+#Simple PAN tokenization service
+
+OpenAPI spec version: 0.0.1
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.2.3
+
+=end
+
+require 'date'
+
+module CyberSource
+  class PtsV2PayoutsPost201ResponseOrderInformationAmountDetails
+    # Grand total for the order. You can include a decimal point (.), but no other special characters. CyberSource truncates the amount to the correct number of decimal places.  * CTV, FDCCompass, Paymentech (<= 12)  For processor-specific information, see the grand_total_amount field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) 
+    attr_accessor :total_amount
+
+    # Currency used for the order. Use the three-character ISO Standard Currency Codes.  For an authorization reversal or a capture, you must use the same currency that you used in your request for Payment API. 
+    attr_accessor :currency
+
+    # This is a multicurrency field. It contains the transaction amount (field 4), converted to the Currency used to bill the cardholder’s account. 
+    attr_accessor :settlement_amount
+
+    # This is a multicurrency-only field. It contains a 3-digit numeric code that identifies the currency used by the issuer to bill the cardholder's account. 
+    attr_accessor :settlement_currency
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'total_amount' => :'totalAmount',
+        :'currency' => :'currency',
+        :'settlement_amount' => :'settlementAmount',
+        :'settlement_currency' => :'settlementCurrency'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'total_amount' => :'String',
+        :'currency' => :'String',
+        :'settlement_amount' => :'String',
+        :'settlement_currency' => :'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?(:'totalAmount')
+        self.total_amount = attributes[:'totalAmount']
+      end
+
+      if attributes.has_key?(:'currency')
+        self.currency = attributes[:'currency']
+      end
+
+      if attributes.has_key?(:'settlementAmount')
+        self.settlement_amount = attributes[:'settlementAmount']
+      end
+
+      if attributes.has_key?(:'settlementCurrency')
+        self.settlement_currency = attributes[:'settlementCurrency']
+      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 !@total_amount.nil? && @total_amount.to_s.length > 19
+        invalid_properties.push('invalid value for "total_amount", the character length must be smaller than or equal to 19.')
+      end
+
+      if !@currency.nil? && @currency.to_s.length > 3
+        invalid_properties.push('invalid value for "currency", the character length must be smaller than or equal to 3.')
+      end
+
+      if !@settlement_amount.nil? && @settlement_amount.to_s.length > 12
+        invalid_properties.push('invalid value for "settlement_amount", the character length must be smaller than or equal to 12.')
+      end
+
+      if !@settlement_currency.nil? && @settlement_currency.to_s.length > 3
+        invalid_properties.push('invalid value for "settlement_currency", the character length must be smaller than or equal to 3.')
+      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 !@total_amount.nil? && @total_amount.to_s.length > 19
+      return false if !@currency.nil? && @currency.to_s.length > 3
+      return false if !@settlement_amount.nil? && @settlement_amount.to_s.length > 12
+      return false if !@settlement_currency.nil? && @settlement_currency.to_s.length > 3
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] total_amount Value to be assigned
+    def total_amount=(total_amount)
+      if !total_amount.nil? && total_amount.to_s.length > 19
+        fail ArgumentError, 'invalid value for "total_amount", the character length must be smaller than or equal to 19.'
+      end
+
+      @total_amount = total_amount
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] currency Value to be assigned
+    def currency=(currency)
+      if !currency.nil? && currency.to_s.length > 3
+        fail ArgumentError, 'invalid value for "currency", the character length must be smaller than or equal to 3.'
+      end
+
+      @currency = currency
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] settlement_amount Value to be assigned
+    def settlement_amount=(settlement_amount)
+      if !settlement_amount.nil? && settlement_amount.to_s.length > 12
+        fail ArgumentError, 'invalid value for "settlement_amount", the character length must be smaller than or equal to 12.'
+      end
+
+      @settlement_amount = settlement_amount
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] settlement_currency Value to be assigned
+    def settlement_currency=(settlement_currency)
+      if !settlement_currency.nil? && settlement_currency.to_s.length > 3
+        fail ArgumentError, 'invalid value for "settlement_currency", the character length must be smaller than or equal to 3.'
+      end
+
+      @settlement_currency = settlement_currency
+    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 &&
+          total_amount == o.total_amount &&
+          currency == o.currency &&
+          settlement_amount == o.settlement_amount &&
+          settlement_currency == o.settlement_currency
+    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
+      [total_amount, currency, settlement_amount, settlement_currency].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("#{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(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/pts_v2_payouts_post201_response_processor_information.rb

@@ -0,0 +1,299 @@
+=begin
+#CyberSource Flex API
+
+#Simple PAN tokenization service
+
+OpenAPI spec version: 0.0.1
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.2.3
+
+=end
+
+require 'date'
+
+module CyberSource
+  class PtsV2PayoutsPost201ResponseProcessorInformation
+    # Issuer-generated approval code for the transaction.
+    attr_accessor :approval_code
+
+    # Transaction status from the processor.
+    attr_accessor :response_code
+
+    # Network transaction identifier (TID). This value can be used to identify a specific transaction when you are discussing the transaction with your processor. 
+    attr_accessor :transaction_id
+
+    # This field is returned only for **American Express Direct** and **CyberSource through VisaNet**.  **American Express Direct**  System trace audit number (STAN). This value identifies the transaction and is useful when investigating a chargeback dispute.  **CyberSource through VisaNet**  System trace number that must be printed on the customer’s receipt. 
+    attr_accessor :system_trace_audit_number
+
+    # Used by Visa only and contains the response source/reason code that identifies the source of the response decision. 
+    attr_accessor :response_code_source
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'approval_code' => :'approvalCode',
+        :'response_code' => :'responseCode',
+        :'transaction_id' => :'transactionId',
+        :'system_trace_audit_number' => :'systemTraceAuditNumber',
+        :'response_code_source' => :'responseCodeSource'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'approval_code' => :'String',
+        :'response_code' => :'String',
+        :'transaction_id' => :'String',
+        :'system_trace_audit_number' => :'String',
+        :'response_code_source' => :'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?(:'approvalCode')
+        self.approval_code = attributes[:'approvalCode']
+      end
+
+      if attributes.has_key?(:'responseCode')
+        self.response_code = attributes[:'responseCode']
+      end
+
+      if attributes.has_key?(:'transactionId')
+        self.transaction_id = attributes[:'transactionId']
+      end
+
+      if attributes.has_key?(:'systemTraceAuditNumber')
+        self.system_trace_audit_number = attributes[:'systemTraceAuditNumber']
+      end
+
+      if attributes.has_key?(:'responseCodeSource')
+        self.response_code_source = attributes[:'responseCodeSource']
+      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 !@approval_code.nil? && @approval_code.to_s.length > 6
+        invalid_properties.push('invalid value for "approval_code", the character length must be smaller than or equal to 6.')
+      end
+
+      if !@response_code.nil? && @response_code.to_s.length > 10
+        invalid_properties.push('invalid value for "response_code", the character length must be smaller than or equal to 10.')
+      end
+
+      if !@transaction_id.nil? && @transaction_id.to_s.length > 15
+        invalid_properties.push('invalid value for "transaction_id", the character length must be smaller than or equal to 15.')
+      end
+
+      if !@system_trace_audit_number.nil? && @system_trace_audit_number.to_s.length > 6
+        invalid_properties.push('invalid value for "system_trace_audit_number", the character length must be smaller than or equal to 6.')
+      end
+
+      if !@response_code_source.nil? && @response_code_source.to_s.length > 1
+        invalid_properties.push('invalid value for "response_code_source", the character length must be smaller than or equal to 1.')
+      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 !@approval_code.nil? && @approval_code.to_s.length > 6
+      return false if !@response_code.nil? && @response_code.to_s.length > 10
+      return false if !@transaction_id.nil? && @transaction_id.to_s.length > 15
+      return false if !@system_trace_audit_number.nil? && @system_trace_audit_number.to_s.length > 6
+      return false if !@response_code_source.nil? && @response_code_source.to_s.length > 1
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] approval_code Value to be assigned
+    def approval_code=(approval_code)
+      if !approval_code.nil? && approval_code.to_s.length > 6
+        fail ArgumentError, 'invalid value for "approval_code", the character length must be smaller than or equal to 6.'
+      end
+
+      @approval_code = approval_code
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] response_code Value to be assigned
+    def response_code=(response_code)
+      if !response_code.nil? && response_code.to_s.length > 10
+        fail ArgumentError, 'invalid value for "response_code", the character length must be smaller than or equal to 10.'
+      end
+
+      @response_code = response_code
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] transaction_id Value to be assigned
+    def transaction_id=(transaction_id)
+      if !transaction_id.nil? && transaction_id.to_s.length > 15
+        fail ArgumentError, 'invalid value for "transaction_id", the character length must be smaller than or equal to 15.'
+      end
+
+      @transaction_id = transaction_id
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] system_trace_audit_number Value to be assigned
+    def system_trace_audit_number=(system_trace_audit_number)
+      if !system_trace_audit_number.nil? && system_trace_audit_number.to_s.length > 6
+        fail ArgumentError, 'invalid value for "system_trace_audit_number", the character length must be smaller than or equal to 6.'
+      end
+
+      @system_trace_audit_number = system_trace_audit_number
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] response_code_source Value to be assigned
+    def response_code_source=(response_code_source)
+      if !response_code_source.nil? && response_code_source.to_s.length > 1
+        fail ArgumentError, 'invalid value for "response_code_source", the character length must be smaller than or equal to 1.'
+      end
+
+      @response_code_source = response_code_source
+    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 &&
+          approval_code == o.approval_code &&
+          response_code == o.response_code &&
+          transaction_id == o.transaction_id &&
+          system_trace_audit_number == o.system_trace_audit_number &&
+          response_code_source == o.response_code_source
+    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
+      [approval_code, response_code, transaction_id, system_trace_audit_number, response_code_source].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("#{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(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