cybersource_rest_client 0.0.15 → 0.0.16

data/lib/cybersource_rest_client/models/tss_v2_transactions_get200_response_order_information_amount_details.rb

@@ -1,324 +1,324 @@
-=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.2.3
-
-=end
-
-require 'date'
-
-module CyberSource
-  class TssV2TransactionsGet200ResponseOrderInformationAmountDetails
-    # 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. For details, see: - \"Authorization Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm). - \"Capture Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm). - \"Credit Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm).  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. For details, see \"Zero Amount Authorizations,\" \"Credit Information for Specific Processors\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)  #### 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. For details, see `grand_total_amount` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf).  #### FDMS South If you accept IDR or CLP currencies, see the entry for FDMS South in \"Authorization Information for Specific Processors\" of the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)  #### DCC for First Data Not used. 
-    attr_accessor :total_amount
-
-    # Currency used for the order. Use the three-character I[ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)  For details about currency as used in partial authorizations, see \"Features for Debit Cards and Prepaid Cards\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)  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.  #### DCC for First Data Your local currency. For details, see the `currency` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf). 
-    attr_accessor :currency
-
-    # Total tax amount for all the items in the order.  For processor-specific information, see the total_tax_amount field in [Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html) 
-    attr_accessor :tax_amount
-
-    # Amount that was authorized. 
-    attr_accessor :authorized_amount
-
-    # 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',
-        :'tax_amount' => :'taxAmount',
-        :'authorized_amount' => :'authorizedAmount',
-        :'settlement_amount' => :'settlementAmount',
-        :'settlement_currency' => :'settlementCurrency'
-      }
-    end
-
-    # Attribute type mapping.
-    def self.swagger_types
-      {
-        :'total_amount' => :'String',
-        :'currency' => :'String',
-        :'tax_amount' => :'String',
-        :'authorized_amount' => :'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?(:'taxAmount')
-        self.tax_amount = attributes[:'taxAmount']
-      end
-
-      if attributes.has_key?(:'authorizedAmount')
-        self.authorized_amount = attributes[:'authorizedAmount']
-      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 !@tax_amount.nil? && @tax_amount.to_s.length > 12
-        invalid_properties.push('invalid value for "tax_amount", the character length must be smaller than or equal to 12.')
-      end
-
-      if !@authorized_amount.nil? && @authorized_amount.to_s.length > 15
-        invalid_properties.push('invalid value for "authorized_amount", the character length must be smaller than or equal to 15.')
-      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 !@tax_amount.nil? && @tax_amount.to_s.length > 12
-      return false if !@authorized_amount.nil? && @authorized_amount.to_s.length > 15
-      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] tax_amount Value to be assigned
-    def tax_amount=(tax_amount)
-      if !tax_amount.nil? && tax_amount.to_s.length > 12
-        fail ArgumentError, 'invalid value for "tax_amount", the character length must be smaller than or equal to 12.'
-      end
-
-      @tax_amount = tax_amount
-    end
-
-    # Custom attribute writer method with validation
-    # @param [Object] authorized_amount Value to be assigned
-    def authorized_amount=(authorized_amount)
-      if !authorized_amount.nil? && authorized_amount.to_s.length > 15
-        fail ArgumentError, 'invalid value for "authorized_amount", the character length must be smaller than or equal to 15.'
-      end
-
-      @authorized_amount = authorized_amount
-    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 &&
-          tax_amount == o.tax_amount &&
-          authorized_amount == o.authorized_amount &&
-          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, tax_amount, authorized_amount, 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
+=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.2.3
+
+=end
+
+require 'date'
+
+module CyberSource
+  class TssV2TransactionsGet200ResponseOrderInformationAmountDetails
+    # 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. For details, see: - \"Authorization Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm). - \"Capture Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm). - \"Credit Information for Specific Processors\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm).  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. For details, see \"Zero Amount Authorizations,\" \"Credit Information for Specific Processors\" in [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)  #### 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. For details, see `grand_total_amount` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf).  #### FDMS South If you accept IDR or CLP currencies, see the entry for FDMS South in \"Authorization Information for Specific Processors\" of the [Credit Card Services Using the SCMP API.](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)  #### DCC for First Data Not used.  #### Invoicing Grand total for the order, this is required for creating a new invoice. 
+    attr_accessor :total_amount
+
+    # Currency used for the order. Use the three-character I[ISO Standard Currency Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/currencies.pdf)  For details about currency as used in partial authorizations, see \"Features for Debit Cards and Prepaid Cards\" in the [Credit Card Services Using the SCMP API Guide](https://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html/wwhelp/wwhimpl/js/html/wwhelp.htm)  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.  #### DCC for First Data Your local currency. For details, see the `currency` field description in [Dynamic Currency Conversion For First Data Using the SCMP API](http://apps.cybersource.com/library/documentation/dev_guides/DCC_FirstData_SCMP/DCC_FirstData_SCMP_API.pdf). 
+    attr_accessor :currency
+
+    # Total tax amount for all the items in the order.  For processor-specific information, see the total_tax_amount field in [Level II and Level III Processing Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/Level_2_3_SCMP_API/html) 
+    attr_accessor :tax_amount
+
+    # Amount that was authorized. 
+    attr_accessor :authorized_amount
+
+    # 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',
+        :'tax_amount' => :'taxAmount',
+        :'authorized_amount' => :'authorizedAmount',
+        :'settlement_amount' => :'settlementAmount',
+        :'settlement_currency' => :'settlementCurrency'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'total_amount' => :'String',
+        :'currency' => :'String',
+        :'tax_amount' => :'String',
+        :'authorized_amount' => :'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?(:'taxAmount')
+        self.tax_amount = attributes[:'taxAmount']
+      end
+
+      if attributes.has_key?(:'authorizedAmount')
+        self.authorized_amount = attributes[:'authorizedAmount']
+      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 !@tax_amount.nil? && @tax_amount.to_s.length > 12
+        invalid_properties.push('invalid value for "tax_amount", the character length must be smaller than or equal to 12.')
+      end
+
+      if !@authorized_amount.nil? && @authorized_amount.to_s.length > 15
+        invalid_properties.push('invalid value for "authorized_amount", the character length must be smaller than or equal to 15.')
+      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 !@tax_amount.nil? && @tax_amount.to_s.length > 12
+      return false if !@authorized_amount.nil? && @authorized_amount.to_s.length > 15
+      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] tax_amount Value to be assigned
+    def tax_amount=(tax_amount)
+      if !tax_amount.nil? && tax_amount.to_s.length > 12
+        fail ArgumentError, 'invalid value for "tax_amount", the character length must be smaller than or equal to 12.'
+      end
+
+      @tax_amount = tax_amount
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] authorized_amount Value to be assigned
+    def authorized_amount=(authorized_amount)
+      if !authorized_amount.nil? && authorized_amount.to_s.length > 15
+        fail ArgumentError, 'invalid value for "authorized_amount", the character length must be smaller than or equal to 15.'
+      end
+
+      @authorized_amount = authorized_amount
+    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 &&
+          tax_amount == o.tax_amount &&
+          authorized_amount == o.authorized_amount &&
+          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, tax_amount, authorized_amount, 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