cybersource_rest_client 0.0.72 → 0.0.74

data/lib/cybersource_rest_client/models/invoicingv2invoices_order_information_amount_details.rb

@@ -1,314 +1,314 @@
-=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
-  # Contains all of the amount-related fields.
-  class Invoicingv2invoicesOrderInformationAmountDetails
-    # Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters. CyberSource truncates the amount to the correct number of decimal places.  **Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12.  **Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths.  If your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen.   #### Card Present Required to include either this field or `orderInformation.lineItems[].unitPrice` for the order.  #### Invoicing / Pay By Link Required for creating a new invoice or payment link.  #### PIN Debit Amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount.  Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests.  #### GPX This field is optional for reversing an authorization or credit; however, for all other processors, these fields are required.  #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request.   #### DCC for First Data Not used. 
-    attr_accessor :total_amount
-
-    # Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)  #### Used by **Authorization** Required field.  **Authorization Reversal** For an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request.  #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase.  For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).  Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests.  #### GPX This field is optional for reversing an authorization or credit.  #### DCC for First Data Your local currency.  #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency. 
-    attr_accessor :currency
-
-    # Total discount amount applied to the order. 
-    attr_accessor :discount_amount
-
-    # The total discount percentage applied to the order.
-    attr_accessor :discount_percent
-
-    # Sub-amount of the order.
-    attr_accessor :sub_amount
-
-    # The minimum partial amount required to pay the invoice.
-    attr_accessor :minimum_partial_amount
-
-    attr_accessor :tax_details
-
-    attr_accessor :freight
-
-    # Attribute mapping from ruby-style variable name to JSON key.
-    def self.attribute_map
-      {
-        :'total_amount' => :'totalAmount',
-        :'currency' => :'currency',
-        :'discount_amount' => :'discountAmount',
-        :'discount_percent' => :'discountPercent',
-        :'sub_amount' => :'subAmount',
-        :'minimum_partial_amount' => :'minimumPartialAmount',
-        :'tax_details' => :'taxDetails',
-        :'freight' => :'freight'
-      }
-    end
-
-    # Attribute mapping from JSON key to ruby-style variable name.
-    def self.json_map
-      {
-        :'total_amount' => :'total_amount',
-        :'currency' => :'currency',
-        :'discount_amount' => :'discount_amount',
-        :'discount_percent' => :'discount_percent',
-        :'sub_amount' => :'sub_amount',
-        :'minimum_partial_amount' => :'minimum_partial_amount',
-        :'tax_details' => :'tax_details',
-        :'freight' => :'freight'
-      }
-    end
-
-    # Attribute type mapping.
-    def self.swagger_types
-      {
-        :'total_amount' => :'String',
-        :'currency' => :'String',
-        :'discount_amount' => :'String',
-        :'discount_percent' => :'String',
-        :'sub_amount' => :'String',
-        :'minimum_partial_amount' => :'String',
-        :'tax_details' => :'Invoicingv2invoicesOrderInformationAmountDetailsTaxDetails',
-        :'freight' => :'Invoicingv2invoicesOrderInformationAmountDetailsFreight'
-      }
-    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?(:'discountAmount')
-        self.discount_amount = attributes[:'discountAmount']
-      end
-
-      if attributes.has_key?(:'discountPercent')
-        self.discount_percent = attributes[:'discountPercent']
-      end
-
-      if attributes.has_key?(:'subAmount')
-        self.sub_amount = attributes[:'subAmount']
-      end
-
-      if attributes.has_key?(:'minimumPartialAmount')
-        self.minimum_partial_amount = attributes[:'minimumPartialAmount']
-      end
-
-      if attributes.has_key?(:'taxDetails')
-        self.tax_details = attributes[:'taxDetails']
-      end
-
-      if attributes.has_key?(:'freight')
-        self.freight = attributes[:'freight']
-      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?
-        invalid_properties.push('invalid value for "total_amount", total_amount cannot be nil.')
-      end
-
-      if @currency.nil?
-        invalid_properties.push('invalid value for "currency", currency 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 @total_amount.nil?
-      return false if @currency.nil?
-      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?
-        #fail ArgumentError, 'total_amount cannot be nil'
-      #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?
-        #fail ArgumentError, 'currency cannot be nil'
-      #end
-
-      @currency = currency
-    end
-
-    # Custom attribute writer method with validation
-    # @param [Object] discount_amount Value to be assigned
-    def discount_amount=(discount_amount)
-      @discount_amount = discount_amount
-    end
-
-    # Custom attribute writer method with validation
-    # @param [Object] discount_percent Value to be assigned
-    def discount_percent=(discount_percent)
-      @discount_percent = discount_percent
-    end
-
-    # Custom attribute writer method with validation
-    # @param [Object] sub_amount Value to be assigned
-    def sub_amount=(sub_amount)
-      @sub_amount = sub_amount
-    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 &&
-          discount_amount == o.discount_amount &&
-          discount_percent == o.discount_percent &&
-          sub_amount == o.sub_amount &&
-          minimum_partial_amount == o.minimum_partial_amount &&
-          tax_details == o.tax_details &&
-          freight == o.freight
-    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, discount_amount, discount_percent, sub_amount, minimum_partial_amount, tax_details, freight].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
+=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
+  # Contains all of the amount-related fields.
+  class Invoicingv2invoicesOrderInformationAmountDetails
+    # Grand total for the order. This value cannot be negative. You can include a decimal point (.), but no other special characters. CyberSource truncates the amount to the correct number of decimal places.  **Note** For CTV, FDCCompass, Paymentech processors, the maximum length for this field is 12.  **Important** Some processors have specific requirements and limitations, such as maximum amounts and maximum field lengths.  If your processor supports zero amount authorizations, you can set this field to 0 for the authorization to check if the card is lost or stolen.   #### Card Present Required to include either this field or `orderInformation.lineItems[].unitPrice` for the order.  #### Invoicing / Pay By Link Required for creating a new invoice or payment link.  #### PIN Debit Amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount.  Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests.  #### GPX This field is optional for reversing an authorization or credit; however, for all other processors, these fields are required.  #### DCC with a Third-Party Provider Set this field to the converted amount that was returned by the DCC provider. You must include either this field or the 1st line item in the order and the specific line-order amount in your request.   #### DCC for First Data Not used. 
+    attr_accessor :total_amount
+
+    # Currency used for the order. Use the three-character [ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)  #### Used by **Authorization** Required field.  **Authorization Reversal** For an authorization reversal (`reversalInformation`) or a capture (`processingOptions.capture` is set to `true`), you must use the same currency that you used in your payment authorization request.  #### PIN Debit Currency for the amount you requested for the PIN debit purchase. This value is returned for partial authorizations. The issuing bank can approve a partial amount if the balance on the debit card is less than the requested transaction amount. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf). Returned by PIN debit purchase.  For PIN debit reversal requests, you must use the same currency that was used for the PIN debit purchase or PIN debit credit that you are reversing. For the possible values, see the [ISO Standard Currency Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/currencies.pdf).  Required field for PIN Debit purchase and PIN Debit credit requests. Optional field for PIN Debit reversal requests.  #### GPX This field is optional for reversing an authorization or credit.  #### DCC for First Data Your local currency.  #### Tax Calculation Required for international tax and value added tax only. Optional for U.S. and Canadian taxes. Your local currency. 
+    attr_accessor :currency
+
+    # Total discount amount applied to the order. 
+    attr_accessor :discount_amount
+
+    # The total discount percentage applied to the order.
+    attr_accessor :discount_percent
+
+    # Sub-amount of the order.
+    attr_accessor :sub_amount
+
+    # The minimum partial amount required to pay the invoice.
+    attr_accessor :minimum_partial_amount
+
+    attr_accessor :tax_details
+
+    attr_accessor :freight
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'total_amount' => :'totalAmount',
+        :'currency' => :'currency',
+        :'discount_amount' => :'discountAmount',
+        :'discount_percent' => :'discountPercent',
+        :'sub_amount' => :'subAmount',
+        :'minimum_partial_amount' => :'minimumPartialAmount',
+        :'tax_details' => :'taxDetails',
+        :'freight' => :'freight'
+      }
+    end
+
+    # Attribute mapping from JSON key to ruby-style variable name.
+    def self.json_map
+      {
+        :'total_amount' => :'total_amount',
+        :'currency' => :'currency',
+        :'discount_amount' => :'discount_amount',
+        :'discount_percent' => :'discount_percent',
+        :'sub_amount' => :'sub_amount',
+        :'minimum_partial_amount' => :'minimum_partial_amount',
+        :'tax_details' => :'tax_details',
+        :'freight' => :'freight'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'total_amount' => :'String',
+        :'currency' => :'String',
+        :'discount_amount' => :'String',
+        :'discount_percent' => :'String',
+        :'sub_amount' => :'String',
+        :'minimum_partial_amount' => :'String',
+        :'tax_details' => :'Invoicingv2invoicesOrderInformationAmountDetailsTaxDetails',
+        :'freight' => :'Invoicingv2invoicesOrderInformationAmountDetailsFreight'
+      }
+    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?(:'discountAmount')
+        self.discount_amount = attributes[:'discountAmount']
+      end
+
+      if attributes.has_key?(:'discountPercent')
+        self.discount_percent = attributes[:'discountPercent']
+      end
+
+      if attributes.has_key?(:'subAmount')
+        self.sub_amount = attributes[:'subAmount']
+      end
+
+      if attributes.has_key?(:'minimumPartialAmount')
+        self.minimum_partial_amount = attributes[:'minimumPartialAmount']
+      end
+
+      if attributes.has_key?(:'taxDetails')
+        self.tax_details = attributes[:'taxDetails']
+      end
+
+      if attributes.has_key?(:'freight')
+        self.freight = attributes[:'freight']
+      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?
+        invalid_properties.push('invalid value for "total_amount", total_amount cannot be nil.')
+      end
+
+      if @currency.nil?
+        invalid_properties.push('invalid value for "currency", currency 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 @total_amount.nil?
+      return false if @currency.nil?
+      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?
+        #fail ArgumentError, 'total_amount cannot be nil'
+      #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?
+        #fail ArgumentError, 'currency cannot be nil'
+      #end
+
+      @currency = currency
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] discount_amount Value to be assigned
+    def discount_amount=(discount_amount)
+      @discount_amount = discount_amount
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] discount_percent Value to be assigned
+    def discount_percent=(discount_percent)
+      @discount_percent = discount_percent
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] sub_amount Value to be assigned
+    def sub_amount=(sub_amount)
+      @sub_amount = sub_amount
+    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 &&
+          discount_amount == o.discount_amount &&
+          discount_percent == o.discount_percent &&
+          sub_amount == o.sub_amount &&
+          minimum_partial_amount == o.minimum_partial_amount &&
+          tax_details == o.tax_details &&
+          freight == o.freight
+    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, discount_amount, discount_percent, sub_amount, minimum_partial_amount, tax_details, freight].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