cybersource_rest_client 0.0.83 → 0.0.85

data/lib/cybersource_rest_client/models/ucv1sessions_data_order_information_ship_to.rb

@@ -0,0 +1,388 @@
+=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 Ucv1sessionsDataOrderInformationShipTo
+    # First line of the shipping address. 
+    attr_accessor :address1
+
+    # Second line of the shipping address. 
+    attr_accessor :address2
+
+    # Third line of the shipping address. 
+    attr_accessor :address3
+
+    # Fourth line of the shipping address.
+    attr_accessor :address4
+
+    # State or province of the shipping address.  Use the [State, Province, and Territory Codes for the United States and Canada](https://developer.cybersource.com/library/documentation/sbc/quickref/states_and_provinces.pdf) 
+    attr_accessor :administrative_area
+
+    # Building number in the street address. 
+    attr_accessor :building_number
+
+    # Country of the shipping address.  Use the two-character [ISO Standard Country Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf) 
+    attr_accessor :country
+
+    # Neighborhood, community, or region within a city or municipality.
+    attr_accessor :district
+
+    # City of the shipping address. 
+    attr_accessor :locality
+
+    # Postal code for the shipping address. The postal code must consist of 5 to 9 digits. 
+    attr_accessor :postal_code
+
+    # First name of the recipient
+    attr_accessor :first_name
+
+    # Last name of the recipient.
+    attr_accessor :last_name
+
+    # Email of the recipient.
+    attr_accessor :email
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'address1' => :'address1',
+        :'address2' => :'address2',
+        :'address3' => :'address3',
+        :'address4' => :'address4',
+        :'administrative_area' => :'administrativeArea',
+        :'building_number' => :'buildingNumber',
+        :'country' => :'country',
+        :'district' => :'district',
+        :'locality' => :'locality',
+        :'postal_code' => :'postalCode',
+        :'first_name' => :'firstName',
+        :'last_name' => :'lastName',
+        :'email' => :'email'
+      }
+    end
+
+    # Attribute mapping from JSON key to ruby-style variable name.
+    def self.json_map
+      {
+        :'address1' => :'address1',
+        :'address2' => :'address2',
+        :'address3' => :'address3',
+        :'address4' => :'address4',
+        :'administrative_area' => :'administrative_area',
+        :'building_number' => :'building_number',
+        :'country' => :'country',
+        :'district' => :'district',
+        :'locality' => :'locality',
+        :'postal_code' => :'postal_code',
+        :'first_name' => :'first_name',
+        :'last_name' => :'last_name',
+        :'email' => :'email'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'address1' => :'String',
+        :'address2' => :'String',
+        :'address3' => :'String',
+        :'address4' => :'String',
+        :'administrative_area' => :'String',
+        :'building_number' => :'String',
+        :'country' => :'String',
+        :'district' => :'String',
+        :'locality' => :'String',
+        :'postal_code' => :'String',
+        :'first_name' => :'String',
+        :'last_name' => :'String',
+        :'email' => :'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?(:'address1')
+        self.address1 = attributes[:'address1']
+      end
+
+      if attributes.has_key?(:'address2')
+        self.address2 = attributes[:'address2']
+      end
+
+      if attributes.has_key?(:'address3')
+        self.address3 = attributes[:'address3']
+      end
+
+      if attributes.has_key?(:'address4')
+        self.address4 = attributes[:'address4']
+      end
+
+      if attributes.has_key?(:'administrativeArea')
+        self.administrative_area = attributes[:'administrativeArea']
+      end
+
+      if attributes.has_key?(:'buildingNumber')
+        self.building_number = attributes[:'buildingNumber']
+      end
+
+      if attributes.has_key?(:'country')
+        self.country = attributes[:'country']
+      end
+
+      if attributes.has_key?(:'district')
+        self.district = attributes[:'district']
+      end
+
+      if attributes.has_key?(:'locality')
+        self.locality = attributes[:'locality']
+      end
+
+      if attributes.has_key?(:'postalCode')
+        self.postal_code = attributes[:'postalCode']
+      end
+
+      if attributes.has_key?(:'firstName')
+        self.first_name = attributes[:'firstName']
+      end
+
+      if attributes.has_key?(:'lastName')
+        self.last_name = attributes[:'lastName']
+      end
+
+      if attributes.has_key?(:'email')
+        self.email = attributes[:'email']
+      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] address1 Value to be assigned
+    def address1=(address1)
+      @address1 = address1
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] address2 Value to be assigned
+    def address2=(address2)
+      @address2 = address2
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] address4 Value to be assigned
+    def address4=(address4)
+      @address4 = address4
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] administrative_area Value to be assigned
+    def administrative_area=(administrative_area)
+      @administrative_area = administrative_area
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] building_number Value to be assigned
+    def building_number=(building_number)
+      @building_number = building_number
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] district Value to be assigned
+    def district=(district)
+      @district = district
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] locality Value to be assigned
+    def locality=(locality)
+      @locality = locality
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] postal_code Value to be assigned
+    def postal_code=(postal_code)
+      @postal_code = postal_code
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] first_name Value to be assigned
+    def first_name=(first_name)
+      @first_name = first_name
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] last_name Value to be assigned
+    def last_name=(last_name)
+      @last_name = last_name
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] email Value to be assigned
+    def email=(email)
+      @email = email
+    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 &&
+          address1 == o.address1 &&
+          address2 == o.address2 &&
+          address3 == o.address3 &&
+          address4 == o.address4 &&
+          administrative_area == o.administrative_area &&
+          building_number == o.building_number &&
+          country == o.country &&
+          district == o.district &&
+          locality == o.locality &&
+          postal_code == o.postal_code &&
+          first_name == o.first_name &&
+          last_name == o.last_name &&
+          email == o.email
+    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
+      [address1, address2, address3, address4, administrative_area, building_number, country, district, locality, postal_code, first_name, last_name, email].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_order_information_shipping_details.rb

@@ -0,0 +1,213 @@
+=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 Ucv1sessionsDataOrderInformationShippingDetails
+    # Shipping method for the product. Possible values:   - `lowcost`: Lowest-cost service  - `sameday`: Courier or same-day service  - `oneday`: Next-day or overnight service  - `twoday`: Two-day service  - `threeday`: Three-day service  - `pickup`: Store pick-up  - `other`: Other shipping method  - `none`: No shipping method because product is a service or subscription 
+    attr_accessor :shipping_method
+
+    # Postal code for the address from which the goods are shipped, which is used to establish nexus.  The default is the postal code associated with your CyberSource account.  The postal code must consist of 5 to 9 digits.  When the billing country is the U.S., the 9-digit postal code must follow this format:  `[5 digits][dash][4 digits]`  Example 12345-6789  When the billing country is Canada, the 6-digit postal code must follow this format:  `[alpha][numeric][alpha][space] [numeric][alpha][numeric]`  Example A1B 2C3  This field is frequently used for Level II and Level III transactions. 
+    attr_accessor :ship_from_postal_code
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'shipping_method' => :'shippingMethod',
+        :'ship_from_postal_code' => :'shipFromPostalCode'
+      }
+    end
+
+    # Attribute mapping from JSON key to ruby-style variable name.
+    def self.json_map
+      {
+        :'shipping_method' => :'shipping_method',
+        :'ship_from_postal_code' => :'ship_from_postal_code'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'shipping_method' => :'String',
+        :'ship_from_postal_code' => :'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?(:'shippingMethod')
+        self.shipping_method = attributes[:'shippingMethod']
+      end
+
+      if attributes.has_key?(:'shipFromPostalCode')
+        self.ship_from_postal_code = attributes[:'shipFromPostalCode']
+      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] shipping_method Value to be assigned
+    def shipping_method=(shipping_method)
+      @shipping_method = shipping_method
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] ship_from_postal_code Value to be assigned
+    def ship_from_postal_code=(ship_from_postal_code)
+      @ship_from_postal_code = ship_from_postal_code
+    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 &&
+          shipping_method == o.shipping_method &&
+          ship_from_postal_code == o.ship_from_postal_code
+    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
+      [shipping_method, ship_from_postal_code].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_processing_information.rb

@@ -16,8 +16,15 @@ module CyberSource
     # The reconciliation ID
     attr_accessor :reconciliation_id
 
+    # This field is applicable for AFT and OCT transactions.  For list of supported values, please refer to Developer Guide. 
+    attr_accessor :purpose_of_payment
+
     attr_accessor :authorization_options
 
+    attr_accessor :recurring_options
+
+    attr_accessor :bank_transfer_options
+
     # The business application Id<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 :business_application_id
 
@@ -31,7 +38,10 @@ module CyberSource
     def self.attribute_map
       {
         :'reconciliation_id' => :'reconciliationId',
+        :'purpose_of_payment' => :'purposeOfPayment',
         :'authorization_options' => :'authorizationOptions',
+        :'recurring_options' => :'recurringOptions',
+        :'bank_transfer_options' => :'bankTransferOptions',
         :'business_application_id' => :'businessApplicationId',
         :'commerce_indicator' => :'commerceIndicator',
         :'processing_instruction' => :'processingInstruction'
@@ -42,7 +52,10 @@ module CyberSource
     def self.json_map
       {
         :'reconciliation_id' => :'reconciliation_id',
+        :'purpose_of_payment' => :'purpose_of_payment',
         :'authorization_options' => :'authorization_options',
+        :'recurring_options' => :'recurring_options',
+        :'bank_transfer_options' => :'bank_transfer_options',
         :'business_application_id' => :'business_application_id',
         :'commerce_indicator' => :'commerce_indicator',
         :'processing_instruction' => :'processing_instruction'
@@ -53,7 +66,10 @@ module CyberSource
     def self.swagger_types
       {
         :'reconciliation_id' => :'String',
+        :'purpose_of_payment' => :'String',
         :'authorization_options' => :'Ucv1sessionsDataProcessingInformationAuthorizationOptions',
+        :'recurring_options' => :'Ucv1sessionsDataProcessingInformationRecurringOptions',
+        :'bank_transfer_options' => :'Ucv1sessionsDataProcessingInformationBankTransferOptions',
         :'business_application_id' => :'String',
         :'commerce_indicator' => :'String',
         :'processing_instruction' => :'String'
@@ -72,10 +88,22 @@ module CyberSource
         self.reconciliation_id = attributes[:'reconciliationId']
       end
 
+      if attributes.has_key?(:'purposeOfPayment')
+        self.purpose_of_payment = attributes[:'purposeOfPayment']
+      end
+
       if attributes.has_key?(:'authorizationOptions')
         self.authorization_options = attributes[:'authorizationOptions']
       end
 
+      if attributes.has_key?(:'recurringOptions')
+        self.recurring_options = attributes[:'recurringOptions']
+      end
+
+      if attributes.has_key?(:'bankTransferOptions')
+        self.bank_transfer_options = attributes[:'bankTransferOptions']
+      end
+
       if attributes.has_key?(:'businessApplicationId')
         self.business_application_id = attributes[:'businessApplicationId']
       end
@@ -108,6 +136,12 @@ module CyberSource
       @reconciliation_id = reconciliation_id
     end
 
+    # Custom attribute writer method with validation
+    # @param [Object] purpose_of_payment Value to be assigned
+    def purpose_of_payment=(purpose_of_payment)
+      @purpose_of_payment = purpose_of_payment
+    end
+
     # Custom attribute writer method with validation
     # @param [Object] business_application_id Value to be assigned
     def business_application_id=(business_application_id)
@@ -132,7 +166,10 @@ module CyberSource
       return true if self.equal?(o)
       self.class == o.class &&
           reconciliation_id == o.reconciliation_id &&
+          purpose_of_payment == o.purpose_of_payment &&
           authorization_options == o.authorization_options &&
+          recurring_options == o.recurring_options &&
+          bank_transfer_options == o.bank_transfer_options &&
           business_application_id == o.business_application_id &&
           commerce_indicator == o.commerce_indicator &&
           processing_instruction == o.processing_instruction
@@ -147,7 +184,7 @@ module CyberSource
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [reconciliation_id, authorization_options, business_application_id, commerce_indicator, processing_instruction].hash
+      [reconciliation_id, purpose_of_payment, authorization_options, recurring_options, bank_transfer_options, business_application_id, commerce_indicator, processing_instruction].hash
     end
 
     # Builds the object from hash