cybersource_rest_client 0.0.8 → 0.0.9

data/lib/cybersource_rest_client/models/ptsv2payments_merchant_information_merchant_descriptor.rb

@@ -155,12 +155,6 @@ module CyberSource
       true
     end
 
-    # Custom attribute writer method with validation
-    # @param [Object] name Value to be assigned
-    def name=(name)
-      @name = name
-    end
-
     # Custom attribute writer method with validation
     # @param [Object] alternate_name Value to be assigned
     def alternate_name=(alternate_name)

data/lib/cybersource_rest_client/models/ptsv2payments_merchant_information_service_fee_descriptor.rb

@@ -0,0 +1,249 @@
+=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 Ptsv2paymentsMerchantInformationServiceFeeDescriptor
+    # Name of the service provider that is collecting the service fee. The service provider name must consist of 3, 7, or 12 characters followed by an asterisk (*). This value must also include the words “Service Fee.”  When you include more than one consecutive space, extra spaces are removed. Use one of the following formats for this value: - <3-character name>*Service Fee - <7-character name>*Service Fee - <12-character name>*Service Fee  When payments are made in installments, this value must also include installment information such as “1 of 5” or “3 of 7.” For installment payments, use one of the following formats for this value: - <3-character name>*Service Fee*<N> of <M> - <7-character name>*Service Fee*<N> of <M> - <12-character name>*Service Fee*<N> of <M>  where <N> is the payment number and <M> is the total number of payments.  When you do not include this value in your request, CyberSource uses the value that is in your CyberSource account.  This value might be displayed on the cardholder’s statement. 
+    attr_accessor :name
+
+    # Contact information for the service provider that is collecting the service fee. when you include more than one consecutive space, extra spaces are removed.  When you do not include this value in your request, CyberSource uses the value that is in your CyberSource account.  This value might be displayed on the cardholder’s statement. 
+    attr_accessor :contact
+
+    # State or territory in which the service provider is located.  When you do not include this value in your request, CyberSource uses the value that is in your CyberSource account.  This value might be displayed on the cardholder’s statement. 
+    attr_accessor :state
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'name' => :'name',
+        :'contact' => :'contact',
+        :'state' => :'state'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'name' => :'String',
+        :'contact' => :'String',
+        :'state' => :'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?(:'name')
+        self.name = attributes[:'name']
+      end
+
+      if attributes.has_key?(:'contact')
+        self.contact = attributes[:'contact']
+      end
+
+      if attributes.has_key?(:'state')
+        self.state = attributes[:'state']
+      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 !@name.nil? && @name.to_s.length > 22
+        invalid_properties.push('invalid value for "name", the character length must be smaller than or equal to 22.')
+      end
+
+      if !@contact.nil? && @contact.to_s.length > 11
+        invalid_properties.push('invalid value for "contact", the character length must be smaller than or equal to 11.')
+      end
+
+      if !@state.nil? && @state.to_s.length > 20
+        invalid_properties.push('invalid value for "state", the character length must be smaller than or equal to 20.')
+      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 !@name.nil? && @name.to_s.length > 22
+      return false if !@contact.nil? && @contact.to_s.length > 11
+      return false if !@state.nil? && @state.to_s.length > 20
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] name Value to be assigned
+    def name=(name)
+      if !name.nil? && name.to_s.length > 22
+        fail ArgumentError, 'invalid value for "name", the character length must be smaller than or equal to 22.'
+      end
+
+      @name = name
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] contact Value to be assigned
+    def contact=(contact)
+      if !contact.nil? && contact.to_s.length > 11
+        fail ArgumentError, 'invalid value for "contact", the character length must be smaller than or equal to 11.'
+      end
+
+      @contact = contact
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] state Value to be assigned
+    def state=(state)
+      if !state.nil? && state.to_s.length > 20
+        fail ArgumentError, 'invalid value for "state", the character length must be smaller than or equal to 20.'
+      end
+
+      @state = state
+    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 &&
+          name == o.name &&
+          contact == o.contact &&
+          state == o.state
+    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
+      [name, contact, state].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/{ptsv2payments_processing_information_authorization_options_merchant_initiated_transaction.rb → ptsv2payments_merchant_initiated_transaction.rb}

@@ -13,11 +13,11 @@ Swagger Codegen version: 2.2.3
 require 'date'
 
 module CyberSource
-  class Ptsv2paymentsProcessingInformationAuthorizationOptionsMerchantInitiatedTransaction
-    # Reason for the merchant-initiated transaction. Possible values:   - **1**: Resubmission  - **2**: Delayed charge  - **3**: Reauthorization for split shipment  - **4**: No show  - **5**: Account top up  This field is not required for installment payments or recurring payments or when _reAuth.first_ is true. It is required for all other merchant-initiated transactions. This field is supported only for Visa transactions on CyberSource through VisaNet. 
+  class Ptsv2paymentsProcessingInformationAuthorizationOptionsInitiatorMerchantInitiatedTransaction
+    # Reason for the merchant-initiated transaction or incremental authorization. Possible values: - `1`: Resubmission - `2`: Delayed charge - `3`: Reauthorization for split shipment - `4`: No show - `5`: Account top up This field is required only for the five kinds of transactions in the preceding list. This field is supported only for merchant-initiated transactions and incremental authorizations.  **CyberSource through VisaNet**\\ The value for this field corresponds to the following data in the TC 33 capture file5: - Record: CP01 TCR0 - Position: 160-163 - Field: Message Reason Code  **All Processors**\\ See \"Merchant-Initiated Transactions,\" page 196. For CyberSource through VisaNet, see also \"Incremental Authorizations,\" page 40. 
     attr_accessor :reason
 
-    # Transaction identifier that was returned in the payment response field _processorInformation.transactionID_ in the reply message for either the original merchant initiated payment in the series or the previous merchant-initiated payment in the series. <p/> If the current payment request includes a token instead of an account number, the following time limits apply for the value of this field:  For a **resubmission**, the transaction ID must be less than 14 days old.  For a **delayed charge** or **reauthorization**, the transaction ID must be less than 30 days old.  The value for this field does not correspond to any data in the TC 33 capture file. This field is supported only for Visa transactions on CyberSource through VisaNet. 
+    # Network transaction identifier that was returned in the payment response field _processorInformation.transactionID_ in the reply message for either the original merchant-initiated payment in the series or the previous merchant-initiated payment in the series.  If the current payment request includes a token instead of an account number, the following time limits apply for the value of this field: - For a **resubmission**, the transaction ID must be less than 14 days old. - For a **delayed charge** or **reauthorization**, the transaction ID must be less than 30 days old.  **NOTE**: The value for this field does not correspond to any data in the TC 33 capture file5. This field is supported only for Visa transactions on CyberSource through VisaNet. 
     attr_accessor :previous_transaction_id
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/cybersource_rest_client/models/ptsv2payments_order_information_amount_details.rb

@@ -14,10 +14,10 @@ require 'date'
 
 module CyberSource
   class Ptsv2paymentsOrderInformationAmountDetails
-    # 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) 
+    # 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. This information is covered in:  Table 15, \"Authorization Information for Specific Processors,\" on page 43  Table 19, \"Capture Information for Specific Processors,\" on page 58  Table 23, \"Credit Information for Specific Processors,\" on page 75 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. See \"Zero Amount Authorizations,\" page 247.  **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 offer0 and the offerlevel field amount in your request. For details, see \"Dynamic Currency Conversion with a Third Party Provider,\" page 125.  **FDMS South**\\ If you accept IDR or CLP currencies, see the entry for FDMS South in Table 15, \"Authorization Information for Specific Processors,\" on page 43.  **DCC for First Data**\\ Not used. 
     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. 
+    # Currency used for the order. Use the three-character ISO Standard Currency Codes.  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 request for Payment API.  **DCC for First Data**\\ Your local currency. For details, see \"Dynamic Currency Conversion for First Data,\" page 113. 
     attr_accessor :currency
 
     # Total discount amount applied to the order.  For processor-specific information, see the order_discount_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) 
@@ -44,13 +44,13 @@ module CyberSource
     # Total freight or shipping and handling charges for the order. When you include this field in your request, you must also include the **totalAmount** field.  For processor-specific information, see the freight_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 :freight_amount
 
-    # Converted amount returned by the DCC service.  For processor-specific information, see the foreign_amount field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) 
+    # Set this field to the converted amount that was returned by the DCC provider. See \"Dynamic Currency Conversion with a Third Party Provider,\" page 125.  For processor-specific information, see the foreign_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 :foreign_amount
 
-    # Billing currency returned by the DCC service.  For processor-specific information, see the foreign_currency field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) 
+    # Your customer’s billing currency. See \"Dynamic Currency Conversion with a Third Party Provider,\" page 125.  For processor-specific information, see the foreign_currency field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) 
     attr_accessor :foreign_currency
 
-    # Exchange rate returned by the DCC service. Includes a decimal point and a maximum of 4 decimal places.  For processor-specific information, see the exchange_rate field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) 
+    # Exchange rate returned by the DCC service. Includes a decimal point and a maximum of 4 decimal places.  For details, see \"Dynamic Currency Conversion for First Data,\" page 113.  For processor-specific information, see the exchange_rate field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) 
     attr_accessor :exchange_rate
 
     # Time stamp for the exchange rate. This value is returned by the DCC service.  Format: `YYYYMMDD~HH:MM`  where ~ denotes a space.  For processor-specific information, see the exchange_rate_timestamp field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html) 
@@ -68,6 +68,15 @@ module CyberSource
 
     attr_accessor :tax_details
 
+    # Service fee. Required for service fee transactions. 
+    attr_accessor :service_fee_amount
+
+    # Amount in your original local pricing currency.  This value cannot be negative. You can include a decimal point (.) in this field to denote the currency exponent, but you cannot include any other special characters.  If needed, CyberSource truncates the amount to the correct number of decimal places.  For details, see Dynamic Currency Conversion with a Third Party Provider. 
+    attr_accessor :original_amount
+
+    # Your local pricing currency code.  For the possible values, see the ISO Standard Currency Codes.  For details, see Dynamic Currency Conversion with a Third Party Provider. 
+    attr_accessor :original_currency
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -89,7 +98,10 @@ module CyberSource
         :'settlement_amount' => :'settlementAmount',
         :'settlement_currency' => :'settlementCurrency',
         :'amex_additional_amounts' => :'amexAdditionalAmounts',
-        :'tax_details' => :'taxDetails'
+        :'tax_details' => :'taxDetails',
+        :'service_fee_amount' => :'serviceFeeAmount',
+        :'original_amount' => :'originalAmount',
+        :'original_currency' => :'originalCurrency'
       }
     end
 
@@ -114,7 +126,10 @@ module CyberSource
         :'settlement_amount' => :'String',
         :'settlement_currency' => :'String',
         :'amex_additional_amounts' => :'Array<Ptsv2paymentsOrderInformationAmountDetailsAmexAdditionalAmounts>',
-        :'tax_details' => :'Array<Ptsv2paymentsOrderInformationAmountDetailsTaxDetails>'
+        :'tax_details' => :'Array<Ptsv2paymentsOrderInformationAmountDetailsTaxDetails>',
+        :'service_fee_amount' => :'String',
+        :'original_amount' => :'String',
+        :'original_currency' => :'String'
       }
     end
 
@@ -205,6 +220,18 @@ module CyberSource
           self.tax_details = value
         end
       end
+
+      if attributes.has_key?(:'serviceFeeAmount')
+        self.service_fee_amount = attributes[:'serviceFeeAmount']
+      end
+
+      if attributes.has_key?(:'originalAmount')
+        self.original_amount = attributes[:'originalAmount']
+      end
+
+      if attributes.has_key?(:'originalCurrency')
+        self.original_currency = attributes[:'originalCurrency']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -275,6 +302,18 @@ module CyberSource
         invalid_properties.push('invalid value for "settlement_currency", the character length must be smaller than or equal to 3.')
       end
 
+      if !@service_fee_amount.nil? && @service_fee_amount.to_s.length > 15
+        invalid_properties.push('invalid value for "service_fee_amount", the character length must be smaller than or equal to 15.')
+      end
+
+      if !@original_amount.nil? && @original_amount.to_s.length > 15
+        invalid_properties.push('invalid value for "original_amount", the character length must be smaller than or equal to 15.')
+      end
+
+      if !@original_currency.nil? && @original_currency.to_s.length > 15
+        invalid_properties.push('invalid value for "original_currency", the character length must be smaller than or equal to 15.')
+      end
+
       invalid_properties
     end
 
@@ -297,6 +336,9 @@ module CyberSource
       return false if !@exchange_rate_time_stamp.nil? && @exchange_rate_time_stamp.to_s.length > 14
       return false if !@settlement_amount.nil? && @settlement_amount.to_s.length > 12
       return false if !@settlement_currency.nil? && @settlement_currency.to_s.length > 3
+      return false if !@service_fee_amount.nil? && @service_fee_amount.to_s.length > 15
+      return false if !@original_amount.nil? && @original_amount.to_s.length > 15
+      return false if !@original_currency.nil? && @original_currency.to_s.length > 15
       true
     end
 
@@ -460,6 +502,36 @@ module CyberSource
       @settlement_currency = settlement_currency
     end
 
+    # Custom attribute writer method with validation
+    # @param [Object] service_fee_amount Value to be assigned
+    def service_fee_amount=(service_fee_amount)
+      if !service_fee_amount.nil? && service_fee_amount.to_s.length > 15
+        fail ArgumentError, 'invalid value for "service_fee_amount", the character length must be smaller than or equal to 15.'
+      end
+
+      @service_fee_amount = service_fee_amount
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] original_amount Value to be assigned
+    def original_amount=(original_amount)
+      if !original_amount.nil? && original_amount.to_s.length > 15
+        fail ArgumentError, 'invalid value for "original_amount", the character length must be smaller than or equal to 15.'
+      end
+
+      @original_amount = original_amount
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] original_currency Value to be assigned
+    def original_currency=(original_currency)
+      if !original_currency.nil? && original_currency.to_s.length > 15
+        fail ArgumentError, 'invalid value for "original_currency", the character length must be smaller than or equal to 15.'
+      end
+
+      @original_currency = original_currency
+    end
+
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)
@@ -483,7 +555,10 @@ module CyberSource
           settlement_amount == o.settlement_amount &&
           settlement_currency == o.settlement_currency &&
           amex_additional_amounts == o.amex_additional_amounts &&
-          tax_details == o.tax_details
+          tax_details == o.tax_details &&
+          service_fee_amount == o.service_fee_amount &&
+          original_amount == o.original_amount &&
+          original_currency == o.original_currency
     end
 
     # @see the `==` method
@@ -495,7 +570,7 @@ module CyberSource
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [total_amount, currency, discount_amount, duty_amount, tax_amount, national_tax_included, tax_applied_after_discount, tax_applied_level, tax_type_code, freight_amount, foreign_amount, foreign_currency, exchange_rate, exchange_rate_time_stamp, surcharge, settlement_amount, settlement_currency, amex_additional_amounts, tax_details].hash
+      [total_amount, currency, discount_amount, duty_amount, tax_amount, national_tax_included, tax_applied_after_discount, tax_applied_level, tax_type_code, freight_amount, foreign_amount, foreign_currency, exchange_rate, exchange_rate_time_stamp, surcharge, settlement_amount, settlement_currency, amex_additional_amounts, tax_details, service_fee_amount, original_amount, original_currency].hash
     end
 
     # Builds the object from hash