cybersource_rest_client 0.0.83 → 0.0.84

data/lib/cybersource_rest_client/models/get_subscriptions_payments_response_subscription_payment.rb

@@ -0,0 +1,356 @@
+=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
+  class GetSubscriptionsPaymentsResponseSubscriptionPayment
+    # Identifier assigned by Recurring Billing to uniquely reference this billing cycle's payment, distinct from the Cybersource transactionID.
+    attr_accessor :id
+
+    # The current status of the payment.  Possible values:    - SCHEDULED    - PAID   - FAILED   - SKIPPED   - SCHEDULED_SKIPPED 
+    attr_accessor :status
+
+    # The type of payment. Possible values: - STANDARD - RETRY 
+    attr_accessor :payment_type
+
+    # An unique identification number generated by Cybersource to identify the submitted request. Returned by all services. It is also appended to the endpoint of the resource. On incremental authorizations, this value with be the same as the identification number returned in the original authorization response. 
+    attr_accessor :transaction_id
+
+    # The date and time of the payment processing.
+    attr_accessor :date
+
+    # 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
+
+    # The start date of the billing cycle for this payment.
+    attr_accessor :billing_start_date
+
+    # The end date of the billing cycle for this payment.
+    attr_accessor :billing_end_date
+
+    # The billing cycle number.
+    attr_accessor :billing_cycle
+
+    # The sequential number of the payment in the subscription.
+    attr_accessor :payment_number
+
+    # The amount billed for this payment.
+    attr_accessor :billing_amount
+
+    # The setup fee associated with the payment.
+    attr_accessor :setup_fee
+
+    # The surcharge amount, if any.
+    attr_accessor :surcharge_amount
+
+    # The description for the surcharge.
+    attr_accessor :surcharge_description
+
+    # Indicates if the payment is modifiable, meaning it can be skipped or restored.
+    attr_accessor :modifiable
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'id' => :'id',
+        :'status' => :'status',
+        :'payment_type' => :'paymentType',
+        :'transaction_id' => :'transactionID',
+        :'date' => :'date',
+        :'currency' => :'currency',
+        :'billing_start_date' => :'billingStartDate',
+        :'billing_end_date' => :'billingEndDate',
+        :'billing_cycle' => :'billingCycle',
+        :'payment_number' => :'paymentNumber',
+        :'billing_amount' => :'billingAmount',
+        :'setup_fee' => :'setupFee',
+        :'surcharge_amount' => :'surchargeAmount',
+        :'surcharge_description' => :'surchargeDescription',
+        :'modifiable' => :'modifiable'
+      }
+    end
+
+    # Attribute mapping from JSON key to ruby-style variable name.
+    def self.json_map
+      {
+        :'id' => :'id',
+        :'status' => :'status',
+        :'payment_type' => :'payment_type',
+        :'transaction_id' => :'transaction_id',
+        :'date' => :'date',
+        :'currency' => :'currency',
+        :'billing_start_date' => :'billing_start_date',
+        :'billing_end_date' => :'billing_end_date',
+        :'billing_cycle' => :'billing_cycle',
+        :'payment_number' => :'payment_number',
+        :'billing_amount' => :'billing_amount',
+        :'setup_fee' => :'setup_fee',
+        :'surcharge_amount' => :'surcharge_amount',
+        :'surcharge_description' => :'surcharge_description',
+        :'modifiable' => :'modifiable'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'id' => :'String',
+        :'status' => :'String',
+        :'payment_type' => :'String',
+        :'transaction_id' => :'String',
+        :'date' => :'DateTime',
+        :'currency' => :'String',
+        :'billing_start_date' => :'DateTime',
+        :'billing_end_date' => :'DateTime',
+        :'billing_cycle' => :'String',
+        :'payment_number' => :'String',
+        :'billing_amount' => :'String',
+        :'setup_fee' => :'String',
+        :'surcharge_amount' => :'String',
+        :'surcharge_description' => :'String',
+        :'modifiable' => :'BOOLEAN'
+      }
+    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?(:'id')
+        self.id = attributes[:'id']
+      end
+
+      if attributes.has_key?(:'status')
+        self.status = attributes[:'status']
+      end
+
+      if attributes.has_key?(:'paymentType')
+        self.payment_type = attributes[:'paymentType']
+      end
+
+      if attributes.has_key?(:'transactionID')
+        self.transaction_id = attributes[:'transactionID']
+      end
+
+      if attributes.has_key?(:'date')
+        self.date = attributes[:'date']
+      end
+
+      if attributes.has_key?(:'currency')
+        self.currency = attributes[:'currency']
+      end
+
+      if attributes.has_key?(:'billingStartDate')
+        self.billing_start_date = attributes[:'billingStartDate']
+      end
+
+      if attributes.has_key?(:'billingEndDate')
+        self.billing_end_date = attributes[:'billingEndDate']
+      end
+
+      if attributes.has_key?(:'billingCycle')
+        self.billing_cycle = attributes[:'billingCycle']
+      end
+
+      if attributes.has_key?(:'paymentNumber')
+        self.payment_number = attributes[:'paymentNumber']
+      end
+
+      if attributes.has_key?(:'billingAmount')
+        self.billing_amount = attributes[:'billingAmount']
+      end
+
+      if attributes.has_key?(:'setupFee')
+        self.setup_fee = attributes[:'setupFee']
+      end
+
+      if attributes.has_key?(:'surchargeAmount')
+        self.surcharge_amount = attributes[:'surchargeAmount']
+      end
+
+      if attributes.has_key?(:'surchargeDescription')
+        self.surcharge_description = attributes[:'surchargeDescription']
+      end
+
+      if attributes.has_key?(:'modifiable')
+        self.modifiable = attributes[:'modifiable']
+      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
+      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?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] transaction_id Value to be assigned
+    def transaction_id=(transaction_id)
+      @transaction_id = transaction_id
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] currency Value to be assigned
+    def currency=(currency)
+      @currency = 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 &&
+          id == o.id &&
+          status == o.status &&
+          payment_type == o.payment_type &&
+          transaction_id == o.transaction_id &&
+          date == o.date &&
+          currency == o.currency &&
+          billing_start_date == o.billing_start_date &&
+          billing_end_date == o.billing_end_date &&
+          billing_cycle == o.billing_cycle &&
+          payment_number == o.payment_number &&
+          billing_amount == o.billing_amount &&
+          setup_fee == o.setup_fee &&
+          surcharge_amount == o.surcharge_amount &&
+          surcharge_description == o.surcharge_description &&
+          modifiable == o.modifiable
+    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
+      [id, status, payment_type, transaction_id, date, currency, billing_start_date, billing_end_date, billing_cycle, payment_number, billing_amount, setup_fee, surcharge_amount, surcharge_description, modifiable].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

data/lib/cybersource_rest_client/models/inline_response_201_1_tokenized_card.rb

@@ -61,8 +61,13 @@ module CyberSource
     # Payment account reference. 
     attr_accessor :payment_account_reference
 
+    # A sequence counter used as part of the input to the TAVV cryptogram and it is incremented for each cryptogram generation. This field is only returned for Visa network tokens. 
+    attr_accessor :application_transaction_counter
+
     attr_accessor :card
 
+    attr_accessor :verification_results
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -82,7 +87,9 @@ module CyberSource
         :'eci' => :'eci',
         :'requestor_id' => :'requestorId',
         :'payment_account_reference' => :'paymentAccountReference',
-        :'card' => :'card'
+        :'application_transaction_counter' => :'applicationTransactionCounter',
+        :'card' => :'card',
+        :'verification_results' => :'verificationResults'
       }
     end
 
@@ -105,7 +112,9 @@ module CyberSource
         :'eci' => :'eci',
         :'requestor_id' => :'requestor_id',
         :'payment_account_reference' => :'payment_account_reference',
-        :'card' => :'card'
+        :'application_transaction_counter' => :'application_transaction_counter',
+        :'card' => :'card',
+        :'verification_results' => :'verification_results'
       }
     end
 
@@ -128,7 +137,9 @@ module CyberSource
         :'eci' => :'String',
         :'requestor_id' => :'String',
         :'payment_account_reference' => :'String',
-        :'card' => :'Tmsv2TokenizedCardCard'
+        :'application_transaction_counter' => :'String',
+        :'card' => :'Tmsv2TokenizedCardCard',
+        :'verification_results' => :'Tmsv2TokenizedCardVerificationResults'
       }
     end
 
@@ -204,9 +215,17 @@ module CyberSource
         self.payment_account_reference = attributes[:'paymentAccountReference']
       end
 
+      if attributes.has_key?(:'applicationTransactionCounter')
+        self.application_transaction_counter = attributes[:'applicationTransactionCounter']
+      end
+
       if attributes.has_key?(:'card')
         self.card = attributes[:'card']
       end
+
+      if attributes.has_key?(:'verificationResults')
+        self.verification_results = attributes[:'verificationResults']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -249,7 +268,9 @@ module CyberSource
           eci == o.eci &&
           requestor_id == o.requestor_id &&
           payment_account_reference == o.payment_account_reference &&
-          card == o.card
+          application_transaction_counter == o.application_transaction_counter &&
+          card == o.card &&
+          verification_results == o.verification_results
     end
 
     # @see the `==` method
@@ -261,7 +282,7 @@ module CyberSource
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [id, object, source, state, enrollment_id, token_reference_id, number, expiration_month, expiration_year, type, reason, cryptogram, security_code, eci, requestor_id, payment_account_reference, card].hash
+      [id, object, source, state, enrollment_id, token_reference_id, number, expiration_month, expiration_year, type, reason, cryptogram, security_code, eci, requestor_id, payment_account_reference, application_transaction_counter, card, verification_results].hash
     end
 
     # Builds the object from hash

data/lib/cybersource_rest_client/models/inline_response_201_4_setups_commerce_solutions.rb

@@ -19,12 +19,15 @@ module CyberSource
 
     attr_accessor :bin_lookup
 
+    attr_accessor :agentic_commerce
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'token_management' => :'tokenManagement',
         :'account_updater' => :'accountUpdater',
-        :'bin_lookup' => :'binLookup'
+        :'bin_lookup' => :'binLookup',
+        :'agentic_commerce' => :'agenticCommerce'
       }
     end
 
@@ -33,7 +36,8 @@ module CyberSource
       {
         :'token_management' => :'token_management',
         :'account_updater' => :'account_updater',
-        :'bin_lookup' => :'bin_lookup'
+        :'bin_lookup' => :'bin_lookup',
+        :'agentic_commerce' => :'agentic_commerce'
       }
     end
 
@@ -42,7 +46,8 @@ module CyberSource
       {
         :'token_management' => :'InlineResponse2014SetupsPaymentsCardProcessing',
         :'account_updater' => :'InlineResponse2014SetupsPaymentsCardProcessing',
-        :'bin_lookup' => :'InlineResponse2014SetupsPaymentsCardProcessing'
+        :'bin_lookup' => :'InlineResponse2014SetupsPaymentsCardProcessing',
+        :'agentic_commerce' => :'InlineResponse2014SetupsPaymentsCardProcessing'
       }
     end
 
@@ -65,6 +70,10 @@ module CyberSource
       if attributes.has_key?(:'binLookup')
         self.bin_lookup = attributes[:'binLookup']
       end
+
+      if attributes.has_key?(:'agenticCommerce')
+        self.agentic_commerce = attributes[:'agenticCommerce']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -87,7 +96,8 @@ module CyberSource
       self.class == o.class &&
           token_management == o.token_management &&
           account_updater == o.account_updater &&
-          bin_lookup == o.bin_lookup
+          bin_lookup == o.bin_lookup &&
+          agentic_commerce == o.agentic_commerce
     end
 
     # @see the `==` method
@@ -99,7 +109,7 @@ module CyberSource
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [token_management, account_updater, bin_lookup].hash
+      [token_management, account_updater, bin_lookup, agentic_commerce].hash
     end
 
     # Builds the object from hash

data/lib/cybersource_rest_client/models/inline_response_201_4_setups_payments.rb

@@ -53,6 +53,10 @@ module CyberSource
 
     attr_accessor :batch_upload
 
+    attr_accessor :transact_guard
+
+    attr_accessor :microform
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -75,7 +79,9 @@ module CyberSource
         :'unified_checkout' => :'unifiedCheckout',
         :'receivables_manager' => :'receivablesManager',
         :'service_fee' => :'serviceFee',
-        :'batch_upload' => :'batchUpload'
+        :'batch_upload' => :'batchUpload',
+        :'transact_guard' => :'transactGuard',
+        :'microform' => :'microform'
       }
     end
 
@@ -101,7 +107,9 @@ module CyberSource
         :'unified_checkout' => :'unified_checkout',
         :'receivables_manager' => :'receivables_manager',
         :'service_fee' => :'service_fee',
-        :'batch_upload' => :'batch_upload'
+        :'batch_upload' => :'batch_upload',
+        :'transact_guard' => :'transact_guard',
+        :'microform' => :'microform'
       }
     end
 
@@ -127,7 +135,9 @@ module CyberSource
         :'unified_checkout' => :'InlineResponse2014SetupsPaymentsDigitalPayments',
         :'receivables_manager' => :'InlineResponse2014SetupsPaymentsDigitalPayments',
         :'service_fee' => :'InlineResponse2014SetupsPaymentsCardProcessing',
-        :'batch_upload' => :'InlineResponse2014SetupsPaymentsDigitalPayments'
+        :'batch_upload' => :'InlineResponse2014SetupsPaymentsDigitalPayments',
+        :'transact_guard' => :'InlineResponse2014SetupsPaymentsDigitalPayments',
+        :'microform' => :'InlineResponse2014SetupsPaymentsCardProcessing'
       }
     end
 
@@ -218,6 +228,14 @@ module CyberSource
       if attributes.has_key?(:'batchUpload')
         self.batch_upload = attributes[:'batchUpload']
       end
+
+      if attributes.has_key?(:'transactGuard')
+        self.transact_guard = attributes[:'transactGuard']
+      end
+
+      if attributes.has_key?(:'microform')
+        self.microform = attributes[:'microform']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -257,7 +275,9 @@ module CyberSource
           unified_checkout == o.unified_checkout &&
           receivables_manager == o.receivables_manager &&
           service_fee == o.service_fee &&
-          batch_upload == o.batch_upload
+          batch_upload == o.batch_upload &&
+          transact_guard == o.transact_guard &&
+          microform == o.microform
     end
 
     # @see the `==` method
@@ -269,7 +289,7 @@ module CyberSource
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [card_processing, alternative_payment_methods, card_present_connect, e_check, payer_authentication, digital_payments, secure_acceptance, virtual_terminal, currency_conversion, tax, customer_invoicing, recurring_billing, cybs_ready_terminal, payment_orchestration, payouts, pay_by_link, unified_checkout, receivables_manager, service_fee, batch_upload].hash
+      [card_processing, alternative_payment_methods, card_present_connect, e_check, payer_authentication, digital_payments, secure_acceptance, virtual_terminal, currency_conversion, tax, customer_invoicing, recurring_billing, cybs_ready_terminal, payment_orchestration, payouts, pay_by_link, unified_checkout, receivables_manager, service_fee, batch_upload, transact_guard, microform].hash
     end
 
     # Builds the object from hash

data/lib/cybersource_rest_client/models/inline_response_201_4_setups_risk.rb

@@ -17,11 +17,14 @@ module CyberSource
 
     attr_accessor :decision_manager
 
+    attr_accessor :enhanced_authentication
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'fraud_management_essentials' => :'fraudManagementEssentials',
-        :'decision_manager' => :'decisionManager'
+        :'decision_manager' => :'decisionManager',
+        :'enhanced_authentication' => :'enhancedAuthentication'
       }
     end
 
@@ -29,7 +32,8 @@ module CyberSource
     def self.json_map
       {
         :'fraud_management_essentials' => :'fraud_management_essentials',
-        :'decision_manager' => :'decision_manager'
+        :'decision_manager' => :'decision_manager',
+        :'enhanced_authentication' => :'enhanced_authentication'
       }
     end
 
@@ -37,7 +41,8 @@ module CyberSource
     def self.swagger_types
       {
         :'fraud_management_essentials' => :'InlineResponse2014SetupsPaymentsCardProcessing',
-        :'decision_manager' => :'InlineResponse2014SetupsPaymentsCardProcessing'
+        :'decision_manager' => :'InlineResponse2014SetupsPaymentsCardProcessing',
+        :'enhanced_authentication' => :'InlineResponse2014SetupsPaymentsCardProcessing'
       }
     end
 
@@ -56,6 +61,10 @@ module CyberSource
       if attributes.has_key?(:'decisionManager')
         self.decision_manager = attributes[:'decisionManager']
       end
+
+      if attributes.has_key?(:'enhancedAuthentication')
+        self.enhanced_authentication = attributes[:'enhancedAuthentication']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -77,7 +86,8 @@ module CyberSource
       return true if self.equal?(o)
       self.class == o.class &&
           fraud_management_essentials == o.fraud_management_essentials &&
-          decision_manager == o.decision_manager
+          decision_manager == o.decision_manager &&
+          enhanced_authentication == o.enhanced_authentication
     end
 
     # @see the `==` method
@@ -89,7 +99,7 @@ module CyberSource
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [fraud_management_essentials, decision_manager].hash
+      [fraud_management_essentials, decision_manager, enhanced_authentication].hash
     end
 
     # Builds the object from hash