cybersource_rest_client 0.0.83 → 0.0.85

data/lib/cybersource_rest_client/models/ucv1sessions_data_installment_information.rb

@@ -0,0 +1,196 @@
+=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 Ucv1sessionsDataInstallmentInformation
+    # Installment number when making payments in installments. Used along with `totalCount` to track which payment is being processed.  For example, the second of 5 payments would be passed to CyberSource as `sequence` = 2 and `totalCount` = 5.  #### Chase Paymentech Solutions and FDC Compass This field is optional because this value is required in the merchant descriptors.  #### CyberSource through VisaNet When you do not include this field in a request for a Crediario installment payment, CyberSource sends a value of 0 to the processor.  For Crediario installment payments, the value for this field corresponds to the following data in the TC 33 capture file*: - Record: CP01 TCR9 - Position: 38-40 - Field: Installment Payment Number  * The TC 33 Capture file contains information about the purchases and refunds that a merchant submits to CyberSource. CyberSource through VisaNet creates the TC 33 Capture file at the end of the day and sends it to the merchant's acquirer, who uses this information to facilitate end-of-day clearing processing with payment card companies. 
+    attr_accessor :sequence
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'sequence' => :'sequence'
+      }
+    end
+
+    # Attribute mapping from JSON key to ruby-style variable name.
+    def self.json_map
+      {
+        :'sequence' => :'sequence'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'sequence' => :'Integer'
+      }
+    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?(:'sequence')
+        self.sequence = attributes[:'sequence']
+      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] sequence Value to be assigned
+    def sequence=(sequence)
+      @sequence = sequence
+    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 &&
+          sequence == o.sequence
+    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
+      [sequence].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/ucv1sessions_data_merchant_information.rb

@@ -15,24 +15,30 @@ module CyberSource
   class Ucv1sessionsDataMerchantInformation
     attr_accessor :merchant_descriptor
 
+    # Your government-assigned tax identification number.  #### Tax Calculation Required field for value added tax only. Not applicable to U.S. and Canadian taxes.  #### CyberSource through VisaNet For CtV processors, the maximum length is 20. 
+    attr_accessor :vat_registration_number
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'merchant_descriptor' => :'merchantDescriptor'
+        :'merchant_descriptor' => :'merchantDescriptor',
+        :'vat_registration_number' => :'vatRegistrationNumber'
       }
     end
 
     # Attribute mapping from JSON key to ruby-style variable name.
     def self.json_map
       {
-        :'merchant_descriptor' => :'merchant_descriptor'
+        :'merchant_descriptor' => :'merchant_descriptor',
+        :'vat_registration_number' => :'vat_registration_number'
       }
     end
 
     # Attribute type mapping.
     def self.swagger_types
       {
-        :'merchant_descriptor' => :'Ucv1sessionsDataMerchantInformationMerchantDescriptor'
+        :'merchant_descriptor' => :'Ucv1sessionsDataMerchantInformationMerchantDescriptor',
+        :'vat_registration_number' => :'String'
       }
     end
 
@@ -47,6 +53,10 @@ module CyberSource
       if attributes.has_key?(:'merchantDescriptor')
         self.merchant_descriptor = attributes[:'merchantDescriptor']
       end
+
+      if attributes.has_key?(:'vatRegistrationNumber')
+        self.vat_registration_number = attributes[:'vatRegistrationNumber']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -62,12 +72,19 @@ module CyberSource
       true
     end
 
+    # Custom attribute writer method with validation
+    # @param [Object] vat_registration_number Value to be assigned
+    def vat_registration_number=(vat_registration_number)
+      @vat_registration_number = vat_registration_number
+    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 &&
-          merchant_descriptor == o.merchant_descriptor
+          merchant_descriptor == o.merchant_descriptor &&
+          vat_registration_number == o.vat_registration_number
     end
 
     # @see the `==` method
@@ -79,7 +96,7 @@ module CyberSource
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [merchant_descriptor].hash
+      [merchant_descriptor, vat_registration_number].hash
     end
 
     # Builds the object from hash

data/lib/cybersource_rest_client/models/ucv1sessions_data_merchant_information_merchant_descriptor.rb

@@ -19,6 +19,9 @@ module CyberSource
     # The alternate name of the merchant<br><br>  Optional field: This field cannot be configured through the Merchant Experience screens in the Business Center, but if required should be provided on a per‑transaction basis in the uc/v1/sessions API request. 
     attr_accessor :alternate_name
 
+    # Contact information for the merchant.  **Note** These are the maximum data lengths for the following payment processors: - FDCCompass (13) - Paymentech (13) 
+    attr_accessor :contact
+
     # The locality of the merchant<br><br>  Optional field: This field cannot be configured through the Merchant Experience screens in the Business Center, but if required should be provided on a per‑transaction basis in the uc/v1/sessions API request. 
     attr_accessor :locality
 
@@ -42,6 +45,7 @@ module CyberSource
       {
         :'name' => :'name',
         :'alternate_name' => :'alternateName',
+        :'contact' => :'contact',
         :'locality' => :'locality',
         :'phone' => :'phone',
         :'country' => :'country',
@@ -56,6 +60,7 @@ module CyberSource
       {
         :'name' => :'name',
         :'alternate_name' => :'alternate_name',
+        :'contact' => :'contact',
         :'locality' => :'locality',
         :'phone' => :'phone',
         :'country' => :'country',
@@ -70,6 +75,7 @@ module CyberSource
       {
         :'name' => :'String',
         :'alternate_name' => :'String',
+        :'contact' => :'String',
         :'locality' => :'String',
         :'phone' => :'String',
         :'country' => :'String',
@@ -95,6 +101,10 @@ module CyberSource
         self.alternate_name = attributes[:'alternateName']
       end
 
+      if attributes.has_key?(:'contact')
+        self.contact = attributes[:'contact']
+      end
+
       if attributes.has_key?(:'locality')
         self.locality = attributes[:'locality']
       end
@@ -145,6 +155,12 @@ module CyberSource
       @alternate_name = alternate_name
     end
 
+    # Custom attribute writer method with validation
+    # @param [Object] contact Value to be assigned
+    def contact=(contact)
+      @contact = contact
+    end
+
     # Custom attribute writer method with validation
     # @param [Object] locality Value to be assigned
     def locality=(locality)
@@ -188,6 +204,7 @@ module CyberSource
       self.class == o.class &&
           name == o.name &&
           alternate_name == o.alternate_name &&
+          contact == o.contact &&
           locality == o.locality &&
           phone == o.phone &&
           country == o.country &&
@@ -205,7 +222,7 @@ module CyberSource
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [name, alternate_name, locality, phone, country, postal_code, administrative_area, address1].hash
+      [name, alternate_name, contact, locality, phone, country, postal_code, administrative_area, address1].hash
     end
 
     # Builds the object from hash

data/lib/cybersource_rest_client/models/ucv1sessions_data_order_information.rb

@@ -23,6 +23,8 @@ module CyberSource
 
     attr_accessor :invoice_details
 
+    attr_accessor :shipping_details
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -30,7 +32,8 @@ module CyberSource
         :'bill_to' => :'billTo',
         :'ship_to' => :'shipTo',
         :'line_items' => :'lineItems',
-        :'invoice_details' => :'invoiceDetails'
+        :'invoice_details' => :'invoiceDetails',
+        :'shipping_details' => :'shippingDetails'
       }
     end
 
@@ -41,7 +44,8 @@ module CyberSource
         :'bill_to' => :'bill_to',
         :'ship_to' => :'ship_to',
         :'line_items' => :'line_items',
-        :'invoice_details' => :'invoice_details'
+        :'invoice_details' => :'invoice_details',
+        :'shipping_details' => :'shipping_details'
       }
     end
 
@@ -50,9 +54,10 @@ module CyberSource
       {
         :'amount_details' => :'Ucv1sessionsDataOrderInformationAmountDetails',
         :'bill_to' => :'Ucv1sessionsDataOrderInformationBillTo',
-        :'ship_to' => :'Upv1capturecontextsDataOrderInformationShipTo',
-        :'line_items' => :'Array<Upv1capturecontextsDataOrderInformationLineItems>',
-        :'invoice_details' => :'Upv1capturecontextsDataOrderInformationInvoiceDetails'
+        :'ship_to' => :'Ucv1sessionsDataOrderInformationShipTo',
+        :'line_items' => :'Array<Ucv1sessionsDataOrderInformationLineItems>',
+        :'invoice_details' => :'Ucv1sessionsDataOrderInformationInvoiceDetails',
+        :'shipping_details' => :'Ucv1sessionsDataOrderInformationShippingDetails'
       }
     end
 
@@ -85,6 +90,10 @@ module CyberSource
       if attributes.has_key?(:'invoiceDetails')
         self.invoice_details = attributes[:'invoiceDetails']
       end
+
+      if attributes.has_key?(:'shippingDetails')
+        self.shipping_details = attributes[:'shippingDetails']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -109,7 +118,8 @@ module CyberSource
           bill_to == o.bill_to &&
           ship_to == o.ship_to &&
           line_items == o.line_items &&
-          invoice_details == o.invoice_details
+          invoice_details == o.invoice_details &&
+          shipping_details == o.shipping_details
     end
 
     # @see the `==` method
@@ -121,7 +131,7 @@ module CyberSource
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [amount_details, bill_to, ship_to, line_items, invoice_details].hash
+      [amount_details, bill_to, ship_to, line_items, invoice_details, shipping_details].hash
     end
 
     # Builds the object from hash

data/lib/cybersource_rest_client/models/ucv1sessions_data_order_information_amount_details.rb

@@ -16,14 +16,26 @@ module CyberSource
     # This field defines the total order amount. 
     attr_accessor :total_amount
 
+    # 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. 
+    attr_accessor :freight_amount
+
+    # Total charges for any import or export duties included in the order. 
+    attr_accessor :duty_amount
+
+    # Total discount amount applied to the order. 
+    attr_accessor :discount_amount
+
+    # Flag that indicates how the merchant manages discounts.  Possible values:   - **0**: no invoice level discount included  - **1**: tax calculated on the postdiscount invoice total  - **2**: tax calculated on the prediscount invoice total 
+    attr_accessor :tax_applied_after_discount
+
+    # Flag that indicates how you calculate tax.  Possible values:   - **0**: net prices with tax calculated at line item level  - **1**: net prices with tax calculated at invoice level  - **2**: gross prices with tax provided at line item level  - **3**: gross prices with tax provided at invoice level  - **4**: no tax applies on the invoice for the transaction 
+    attr_accessor :tax_applied_level
+
     # This field defines the currency applicable to the order. 
     attr_accessor :currency
 
     attr_accessor :surcharge
 
-    # This field defines the discount amount applicable to the order. 
-    attr_accessor :discount_amount
-
     # This field defines the sub total amount applicable to the order. 
     attr_accessor :sub_total_amount
 
@@ -39,9 +51,13 @@ module CyberSource
     def self.attribute_map
       {
         :'total_amount' => :'totalAmount',
+        :'freight_amount' => :'freightAmount',
+        :'duty_amount' => :'dutyAmount',
+        :'discount_amount' => :'discountAmount',
+        :'tax_applied_after_discount' => :'taxAppliedAfterDiscount',
+        :'tax_applied_level' => :'taxAppliedLevel',
         :'currency' => :'currency',
         :'surcharge' => :'surcharge',
-        :'discount_amount' => :'discountAmount',
         :'sub_total_amount' => :'subTotalAmount',
         :'service_fee_amount' => :'serviceFeeAmount',
         :'tax_amount' => :'taxAmount',
@@ -53,9 +69,13 @@ module CyberSource
     def self.json_map
       {
         :'total_amount' => :'total_amount',
+        :'freight_amount' => :'freight_amount',
+        :'duty_amount' => :'duty_amount',
+        :'discount_amount' => :'discount_amount',
+        :'tax_applied_after_discount' => :'tax_applied_after_discount',
+        :'tax_applied_level' => :'tax_applied_level',
         :'currency' => :'currency',
         :'surcharge' => :'surcharge',
-        :'discount_amount' => :'discount_amount',
         :'sub_total_amount' => :'sub_total_amount',
         :'service_fee_amount' => :'service_fee_amount',
         :'tax_amount' => :'tax_amount',
@@ -67,9 +87,13 @@ module CyberSource
     def self.swagger_types
       {
         :'total_amount' => :'String',
+        :'freight_amount' => :'String',
+        :'duty_amount' => :'String',
+        :'discount_amount' => :'String',
+        :'tax_applied_after_discount' => :'String',
+        :'tax_applied_level' => :'String',
         :'currency' => :'String',
         :'surcharge' => :'Upv1capturecontextsDataOrderInformationAmountDetailsSurcharge',
-        :'discount_amount' => :'String',
         :'sub_total_amount' => :'String',
         :'service_fee_amount' => :'String',
         :'tax_amount' => :'String',
@@ -89,18 +113,34 @@ module CyberSource
         self.total_amount = attributes[:'totalAmount']
       end
 
-      if attributes.has_key?(:'currency')
-        self.currency = attributes[:'currency']
+      if attributes.has_key?(:'freightAmount')
+        self.freight_amount = attributes[:'freightAmount']
       end
 
-      if attributes.has_key?(:'surcharge')
-        self.surcharge = attributes[:'surcharge']
+      if attributes.has_key?(:'dutyAmount')
+        self.duty_amount = attributes[:'dutyAmount']
       end
 
       if attributes.has_key?(:'discountAmount')
         self.discount_amount = attributes[:'discountAmount']
       end
 
+      if attributes.has_key?(:'taxAppliedAfterDiscount')
+        self.tax_applied_after_discount = attributes[:'taxAppliedAfterDiscount']
+      end
+
+      if attributes.has_key?(:'taxAppliedLevel')
+        self.tax_applied_level = attributes[:'taxAppliedLevel']
+      end
+
+      if attributes.has_key?(:'currency')
+        self.currency = attributes[:'currency']
+      end
+
+      if attributes.has_key?(:'surcharge')
+        self.surcharge = attributes[:'surcharge']
+      end
+
       if attributes.has_key?(:'subTotalAmount')
         self.sub_total_amount = attributes[:'subTotalAmount']
       end
@@ -139,6 +179,36 @@ module CyberSource
       @total_amount = total_amount
     end
 
+    # Custom attribute writer method with validation
+    # @param [Object] freight_amount Value to be assigned
+    def freight_amount=(freight_amount)
+      @freight_amount = freight_amount
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] duty_amount Value to be assigned
+    def duty_amount=(duty_amount)
+      @duty_amount = duty_amount
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] discount_amount Value to be assigned
+    def discount_amount=(discount_amount)
+      @discount_amount = discount_amount
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] tax_applied_after_discount Value to be assigned
+    def tax_applied_after_discount=(tax_applied_after_discount)
+      @tax_applied_after_discount = tax_applied_after_discount
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] tax_applied_level Value to be assigned
+    def tax_applied_level=(tax_applied_level)
+      @tax_applied_level = tax_applied_level
+    end
+
     # Custom attribute writer method with validation
     # @param [Object] currency Value to be assigned
     def currency=(currency)
@@ -151,9 +221,13 @@ module CyberSource
       return true if self.equal?(o)
       self.class == o.class &&
           total_amount == o.total_amount &&
+          freight_amount == o.freight_amount &&
+          duty_amount == o.duty_amount &&
+          discount_amount == o.discount_amount &&
+          tax_applied_after_discount == o.tax_applied_after_discount &&
+          tax_applied_level == o.tax_applied_level &&
           currency == o.currency &&
           surcharge == o.surcharge &&
-          discount_amount == o.discount_amount &&
           sub_total_amount == o.sub_total_amount &&
           service_fee_amount == o.service_fee_amount &&
           tax_amount == o.tax_amount &&
@@ -169,7 +243,7 @@ module CyberSource
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [total_amount, currency, surcharge, discount_amount, sub_total_amount, service_fee_amount, tax_amount, tax_details].hash
+      [total_amount, freight_amount, duty_amount, discount_amount, tax_applied_after_discount, tax_applied_level, currency, surcharge, sub_total_amount, service_fee_amount, tax_amount, tax_details].hash
     end
 
     # Builds the object from hash