cybersource_rest_client 0.0.8 → 0.0.9

data/lib/cybersource_rest_client/models/ptsv2credits_point_of_sale_information_emv.rb

@@ -14,13 +14,13 @@ require 'date'
 
 module CyberSource
   class Ptsv2creditsPointOfSaleInformationEmv
-    # EMV data that is transmitted from the chip card to the issuer, and from the issuer to the chip card. The EMV data is in the tag-length-value format and includes chip card tags, terminal tags, and transaction detail tags.  `Important` The following tags contain sensitive information and **must not** be included in this field:   - **56**: Track 1 equivalent data  - **57**: Track 2 equivalent data  - **5A**: Application PAN  - **5F20**: Cardholder name  - **5F24**: Application expiration date (This sensitivity has been relaxed for cmcic, amexdirect, fdiglobal, opdfde, six)  - **99**: Transaction PIN  - **9F0B**: Cardholder name (extended)  - **9F1F**: Track 1 discretionary data  - **9F20**: Track 2 discretionary data  For captures, this field is required for contact EMV transactions. Otherwise, it is optional.  For credits, this field is required for contact EMV stand-alone credits and contactless EMV stand-alone credits. Otherwise, it is optional.  `Important` For contact EMV captures, contact EMV stand-alone credits, and contactless EMV stand-alone credits, you must include the following tags in this field. For all other types of EMV transactions, the following tags are optional.   - **95**: Terminal verification results  - **9F10**: Issuer application data  - **9F26**: Application cryptogram 
+    # EMV data that is transmitted from the chip card to the issuer, and from the issuer to the chip card. The EMV data is in the tag-length-value format and includes chip card tags, terminal tags, and transaction detail tags.  See \"Europay, MasterCard, Visa (EMV),\" page 10. For information about the individual tags, see the “Application Specification” section in the EMV 4.3 Specifications: http://emvco.com  **Important** The following tags contain sensitive information and **must not** be included in this field:   - **56**: Track 1 equivalent data  - **57**: Track 2 equivalent data  - **5A**: Application PAN  - **5F20**: Cardholder name  - **5F24**: Application expiration date (This sensitivity has been relaxed for cmcic, amexdirect, fdiglobal, opdfde, and six)  - **99**: Transaction PIN  - **9F0B**: Cardholder name (extended)  - **9F1F**: Track 1 discretionary data  - **9F20**: Track 2 discretionary data  For captures, this field is required for contact EMV transactions. Otherwise, it is optional.  For credits, this field is required for contact EMV stand-alone credits and contactless EMV stand-alone credits. Otherwise, it is optional.  **Important** For contact EMV captures, contact EMV stand-alone credits, and contactless EMV stand-alone credits, you must include the following tags in this field. For all other types of EMV transactions, the following tags are optional.   - **95**: Terminal verification results  - **9F10**: Issuer application data  - **9F26**: Application cryptogram 
     attr_accessor :tags
 
-    # Indicates whether a fallback method was used to enter credit card information into the POS terminal. When a technical problem prevents a successful exchange of information between a chip card and a chip-capable terminal:   1. Swipe the card or key the credit card information into the POS terminal.  2. Use the pos_entry_mode field to indicate whether the information was swiped or keyed.  This field is supported only on **Chase Paymentech Solutions** and **GPN**. 
+    # Indicates whether a fallback method was used to enter credit card information into the POS terminal. When a technical problem prevents a successful exchange of information between a chip card and a chip-capable terminal:   1. Swipe the card or key the credit card information into the POS terminal.  2. Use the pointOfSaleInformation.entryMode field to indicate whether the information was swiped or keyed.  Possible values:  - **true**  - **false** (default)  This field is supported only on **Chase Paymentech Solutions** and **GPN**. 
     attr_accessor :fallback
 
-    # Reason for the EMV fallback transaction. An EMV fallback transaction occurs when an EMV transaction fails for one of these reasons:   - Technical failure: the EMV terminal or EMV card cannot read and process chip data.  - Empty candidate list failure: the EMV terminal does not have any applications in common with the EMV card.    EMV terminals are coded to determine whether the terminal and EMV card have any applications in common.    EMV terminals provide this information to you.  Possible values:   - **1**: Transaction was initiated with information from a magnetic stripe, and the previous transaction at the       EMV terminal either used information from a successful chip read or it was not a chip transaction.  - **2**: Transaction was initiated with information from a magnetic stripe, and the previous transaction at the       EMV terminal was an EMV fallback transaction because the attempted chip read was unsuccessful.  This field is supported only on **GPN**. 
+    # Reason for the EMV fallback transaction. An EMV fallback transaction occurs when an EMV transaction fails for one of these reasons:   - Technical failure: the EMV terminal or EMV card cannot read and process chip data.  - Empty candidate list failure: the EMV terminal does not have any applications in common with the EMV card.    EMV terminals are coded to determine whether the terminal and EMV card have any applications in common.    EMV terminals provide this information to you.  Possible values:   - **1**: Transaction was initiated with information from a magnetic stripe, and the previous transaction at the       EMV terminal either used information from a successful chip read or it was not a chip transaction.  - **2**: Transaction was initiated with information from a magnetic stripe, and the previous transaction at the       EMV terminal was an EMV fallback transaction because the attempted chip read was unsuccessful.  This field is supported only on **GPN**.  **NOTE**: Merchants must include this field in a request whenever a transaction must fall back to swiped mode. 
     attr_accessor :fallback_condition
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/cybersource_rest_client/models/ptsv2credits_processing_information.rb

@@ -17,22 +17,22 @@ module CyberSource
     # Type of transaction. Some payment card companies use this information when determining discount rates. When you omit this field for **Ingenico ePayments**, the processor uses the default transaction type they have on file for you instead of the default value listed here. 
     attr_accessor :commerce_indicator
 
-    # Value that identifies the processor/acquirer to use for the transaction. This value is supported only for **CyberSource through VisaNet**. 
+    # Value that identifies the processor/acquirer to use for the transaction. This value is supported only for **CyberSource through VisaNet**.  Contact CyberSource Customer Support to get the value for this field. 
     attr_accessor :processor_id
 
-    # Type of digital payment solution that is being used for the transaction. Possible Values:   - **visacheckout**: Visa Checkout.  - **001**: Apple Pay.  - **005**: Masterpass. Required for Masterpass transactions on OmniPay Direct.  - **006**: Android Pay.  - **008**: Samsung Pay. 
+    # Type of digital payment solution for the transaction. Possible Values:   - **visacheckout**: Visa Checkout. This value is required for Visa Checkout transactions. See Visa Checkout Using the SCMP API.  - **005**: Masterpass. This value is required for Masterpass transactions on OmniPay Direct. See \"Masterpass,\" page 153. 
     attr_accessor :payment_solution
 
     # Please check with Cybersource customer support to see if your merchant account is configured correctly so you can include this field in your request. * For Payouts: max length for FDCCompass is String (22). 
     attr_accessor :reconciliation_id
 
-    # Value that links the current payment request to the original request. Set this value to the ID that was returned in the reply message from the original payment request.  This value is used for:   - Partial authorizations.  - Split shipments. 
+    # Value that links the current authorization request to the original authorization request. Set this value to the ID that was returned in the reply message from the original authorization request.  This value is used for:   - Partial authorizations: See \"Partial Authorizations,\" page 88.  - Split shipments: See \"Split Shipments,\" page 210. 
     attr_accessor :link_id
 
-    # Attribute that lets you define custom grouping for your processor reports. This field is supported only for **Litle**. 
+    # Attribute that lets you define custom grouping for your processor reports. This field is supported only for **Worldpay VAP**.  See \"Report Groups,\" page 234. 
     attr_accessor :report_group
 
-    # Identifier for the **Visa Checkout** order. Visa Checkout provides a unique order ID for every transaction in the Visa Checkout **callID** field. 
+    # Identifier for the **Visa Checkout** order. Visa Checkout provides a unique order ID for every transaction in the Visa Checkout **callID** field.  For more details, see Visa Checkout Using the SCMP API. 
     attr_accessor :visa_checkout_id
 
     # Set this field to 3 to indicate that the request includes Level III data.
@@ -40,6 +40,8 @@ module CyberSource
 
     attr_accessor :recurring_options
 
+    attr_accessor :bank_transfer_options
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -51,7 +53,8 @@ module CyberSource
         :'report_group' => :'reportGroup',
         :'visa_checkout_id' => :'visaCheckoutId',
         :'purchase_level' => :'purchaseLevel',
-        :'recurring_options' => :'recurringOptions'
+        :'recurring_options' => :'recurringOptions',
+        :'bank_transfer_options' => :'bankTransferOptions'
       }
     end
 
@@ -66,7 +69,8 @@ module CyberSource
         :'report_group' => :'String',
         :'visa_checkout_id' => :'String',
         :'purchase_level' => :'String',
-        :'recurring_options' => :'Ptsv2paymentsidrefundsProcessingInformationRecurringOptions'
+        :'recurring_options' => :'Ptsv2paymentsidrefundsProcessingInformationRecurringOptions',
+        :'bank_transfer_options' => :'Ptsv2creditsProcessingInformationBankTransferOptions'
       }
     end
 
@@ -113,6 +117,10 @@ module CyberSource
       if attributes.has_key?(:'recurringOptions')
         self.recurring_options = attributes[:'recurringOptions']
       end
+
+      if attributes.has_key?(:'bankTransferOptions')
+        self.bank_transfer_options = attributes[:'bankTransferOptions']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -261,7 +269,8 @@ module CyberSource
           report_group == o.report_group &&
           visa_checkout_id == o.visa_checkout_id &&
           purchase_level == o.purchase_level &&
-          recurring_options == o.recurring_options
+          recurring_options == o.recurring_options &&
+          bank_transfer_options == o.bank_transfer_options
     end
 
     # @see the `==` method
@@ -273,7 +282,7 @@ module CyberSource
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [commerce_indicator, processor_id, payment_solution, reconciliation_id, link_id, report_group, visa_checkout_id, purchase_level, recurring_options].hash
+      [commerce_indicator, processor_id, payment_solution, reconciliation_id, link_id, report_group, visa_checkout_id, purchase_level, recurring_options, bank_transfer_options].hash
     end
 
     # Builds the object from hash

data/lib/cybersource_rest_client/models/ptsv2credits_processing_information_bank_transfer_options.rb

@@ -0,0 +1,349 @@
+=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 Ptsv2creditsProcessingInformationBankTransferOptions
+    # Payment related information.  This information is included on the customer’s statement. 
+    attr_accessor :customer_memo
+
+    # Authorization method used for the transaction. See \"SEC Codes,\" page 89.  TeleCheck Accepts only the following values: - **PPD** - **TEL** - **WEB** 
+    attr_accessor :sec_code
+
+    # City in which the terminal is located. If more than four alphanumeric characters are submitted, the transaction will be declined.  You cannot include any special characters. 
+    attr_accessor :terminal_city
+
+    # State in which the terminal is located. If more than two alphanumeric characters are submitted, the transaction will be declined.  You cannot include any special characters. 
+    attr_accessor :terminal_state
+
+    # Effective date for the transaction. The effective date must be within 45 days of the current day. If you do not include this value, CyberSource sets the effective date to the next business day.  Format: `MMDDYYYY`  Supported only for the CyberSource ACH Service. 
+    attr_accessor :effective_date
+
+    # Identifier for a partial payment or partial credit.  The value for each debit request or credit request must be unique within the scope of the order. See \"Multiple Partial Credits,\" page 41. 
+    attr_accessor :partial_payment_id
+
+    # Method used for settlement.  Possible values: - **A**: Automated Clearing House (default for credits and for transactions using Canadian dollars) - **F**: Facsimile draft (U.S. dollars only) - **B**: Best possible (U.S. dollars only) (default if the field has not already been configured for your merchant ID)  See \"Settlement Delivery Methods,\" page 44. 
+    attr_accessor :settlement_method
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'customer_memo' => :'customerMemo',
+        :'sec_code' => :'secCode',
+        :'terminal_city' => :'terminalCity',
+        :'terminal_state' => :'terminalState',
+        :'effective_date' => :'effectiveDate',
+        :'partial_payment_id' => :'partialPaymentId',
+        :'settlement_method' => :'settlementMethod'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'customer_memo' => :'String',
+        :'sec_code' => :'String',
+        :'terminal_city' => :'String',
+        :'terminal_state' => :'String',
+        :'effective_date' => :'String',
+        :'partial_payment_id' => :'String',
+        :'settlement_method' => :'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?(:'customerMemo')
+        self.customer_memo = attributes[:'customerMemo']
+      end
+
+      if attributes.has_key?(:'secCode')
+        self.sec_code = attributes[:'secCode']
+      end
+
+      if attributes.has_key?(:'terminalCity')
+        self.terminal_city = attributes[:'terminalCity']
+      end
+
+      if attributes.has_key?(:'terminalState')
+        self.terminal_state = attributes[:'terminalState']
+      end
+
+      if attributes.has_key?(:'effectiveDate')
+        self.effective_date = attributes[:'effectiveDate']
+      end
+
+      if attributes.has_key?(:'partialPaymentId')
+        self.partial_payment_id = attributes[:'partialPaymentId']
+      end
+
+      if attributes.has_key?(:'settlementMethod')
+        self.settlement_method = attributes[:'settlementMethod']
+      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 !@customer_memo.nil? && @customer_memo.to_s.length > 80
+        invalid_properties.push('invalid value for "customer_memo", the character length must be smaller than or equal to 80.')
+      end
+
+      if !@sec_code.nil? && @sec_code.to_s.length > 3
+        invalid_properties.push('invalid value for "sec_code", the character length must be smaller than or equal to 3.')
+      end
+
+      if !@terminal_city.nil? && @terminal_city.to_s.length > 4
+        invalid_properties.push('invalid value for "terminal_city", the character length must be smaller than or equal to 4.')
+      end
+
+      if !@terminal_state.nil? && @terminal_state.to_s.length > 2
+        invalid_properties.push('invalid value for "terminal_state", the character length must be smaller than or equal to 2.')
+      end
+
+      if !@effective_date.nil? && @effective_date.to_s.length > 8
+        invalid_properties.push('invalid value for "effective_date", the character length must be smaller than or equal to 8.')
+      end
+
+      if !@partial_payment_id.nil? && @partial_payment_id.to_s.length > 25
+        invalid_properties.push('invalid value for "partial_payment_id", the character length must be smaller than or equal to 25.')
+      end
+
+      if !@settlement_method.nil? && @settlement_method.to_s.length > 1
+        invalid_properties.push('invalid value for "settlement_method", 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 !@customer_memo.nil? && @customer_memo.to_s.length > 80
+      return false if !@sec_code.nil? && @sec_code.to_s.length > 3
+      return false if !@terminal_city.nil? && @terminal_city.to_s.length > 4
+      return false if !@terminal_state.nil? && @terminal_state.to_s.length > 2
+      return false if !@effective_date.nil? && @effective_date.to_s.length > 8
+      return false if !@partial_payment_id.nil? && @partial_payment_id.to_s.length > 25
+      return false if !@settlement_method.nil? && @settlement_method.to_s.length > 1
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] customer_memo Value to be assigned
+    def customer_memo=(customer_memo)
+      if !customer_memo.nil? && customer_memo.to_s.length > 80
+        fail ArgumentError, 'invalid value for "customer_memo", the character length must be smaller than or equal to 80.'
+      end
+
+      @customer_memo = customer_memo
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] sec_code Value to be assigned
+    def sec_code=(sec_code)
+      if !sec_code.nil? && sec_code.to_s.length > 3
+        fail ArgumentError, 'invalid value for "sec_code", the character length must be smaller than or equal to 3.'
+      end
+
+      @sec_code = sec_code
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] terminal_city Value to be assigned
+    def terminal_city=(terminal_city)
+      if !terminal_city.nil? && terminal_city.to_s.length > 4
+        fail ArgumentError, 'invalid value for "terminal_city", the character length must be smaller than or equal to 4.'
+      end
+
+      @terminal_city = terminal_city
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] terminal_state Value to be assigned
+    def terminal_state=(terminal_state)
+      if !terminal_state.nil? && terminal_state.to_s.length > 2
+        fail ArgumentError, 'invalid value for "terminal_state", the character length must be smaller than or equal to 2.'
+      end
+
+      @terminal_state = terminal_state
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] effective_date Value to be assigned
+    def effective_date=(effective_date)
+      if !effective_date.nil? && effective_date.to_s.length > 8
+        fail ArgumentError, 'invalid value for "effective_date", the character length must be smaller than or equal to 8.'
+      end
+
+      @effective_date = effective_date
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] partial_payment_id Value to be assigned
+    def partial_payment_id=(partial_payment_id)
+      if !partial_payment_id.nil? && partial_payment_id.to_s.length > 25
+        fail ArgumentError, 'invalid value for "partial_payment_id", the character length must be smaller than or equal to 25.'
+      end
+
+      @partial_payment_id = partial_payment_id
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] settlement_method Value to be assigned
+    def settlement_method=(settlement_method)
+      if !settlement_method.nil? && settlement_method.to_s.length > 1
+        fail ArgumentError, 'invalid value for "settlement_method", the character length must be smaller than or equal to 1.'
+      end
+
+      @settlement_method = settlement_method
+    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 &&
+          customer_memo == o.customer_memo &&
+          sec_code == o.sec_code &&
+          terminal_city == o.terminal_city &&
+          terminal_state == o.terminal_state &&
+          effective_date == o.effective_date &&
+          partial_payment_id == o.partial_payment_id &&
+          settlement_method == o.settlement_method
+    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
+      [customer_memo, sec_code, terminal_city, terminal_state, effective_date, partial_payment_id, settlement_method].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