cybersource_rest_client 0.0.22 → 0.0.28

data/lib/cybersource_rest_client/models/vasv2tax_order_information_ship_to.rb

@@ -0,0 +1,286 @@
+=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.2.3
+
+=end
+
+require 'date'
+
+module CyberSource
+  class Vasv2taxOrderInformationShipTo
+    # 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)  Required field for authorization if any shipping address information is included in the request; otherwise, optional.  #### Tax Calculation Optional field for U.S., Canadian, international tax, and value added taxes. Billing address objects will be used to determine the cardholder’s location when shipTo objects are not present. 
+    attr_accessor :country
+
+    # 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)  Required field for authorization if any shipping address information is included in the request and shipping to the U.S. or Canada; otherwise, optional.  #### Tax Calculation Optional field for U.S. and Canadian taxes. Not applicable to international and value added taxes. Billing address objects will be used to determine the cardholder’s location when shipTo objects are not present. 
+    attr_accessor :administrative_area
+
+    # City of the shipping address.  Required field for authorization if any shipping address information is included in the request and shipping to the U.S. or Canada; otherwise, optional.  #### Tax Calculation Optional field for U.S. and Canadian taxes. Not applicable to international and value added taxes. Billing address objects will be used to determine the cardholder’s location when shipTo objects are not present. 
+    attr_accessor :locality
+
+    # Postal code for the shipping address. The postal code must consist of 5 to 9 digits.  Required field for authorization if any shipping address information is included in the request and shipping to the U.S. or Canada; otherwise, optional.  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  #### American Express Direct Before sending the postal code to the processor, all nonalphanumeric characters are removed and, if the remaining value is longer than nine characters, the value is truncated starting from the right side. #### Tax Calculation Optional field for U.S. and Canadian taxes. Not applicable to international and value added taxes. Billing address objects will be used to determine the cardholder’s location when shipTo objects are not present. 
+    attr_accessor :postal_code
+
+    # First line of the shipping address.  Required field for authorization if any shipping address information is included in the request; otherwise, optional.  #### Tax Calculation Optional field for U.S. and Canadian taxes. Not applicable to international and value added taxes. Billing address objects will be used to determine the cardholder’s location when shipTo objects are not present. 
+    attr_accessor :address1
+
+    # Second line of the shipping address.  Optional field.  #### Tax Calculation Optional field for U.S. and Canadian taxes. Not applicable to international and value added taxes. Billing address objects will be used to determine the cardholder’s location when shipTo objects are not present. 
+    attr_accessor :address2
+
+    # Third line of the shipping address.  #### Tax Calculation Optional field for U.S. and Canadian taxes. Not applicable to international and value added taxes. Billing address objects will be used to determine the cardholder’s location when shipTo objects are not present. 
+    attr_accessor :address3
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'country' => :'country',
+        :'administrative_area' => :'administrativeArea',
+        :'locality' => :'locality',
+        :'postal_code' => :'postalCode',
+        :'address1' => :'address1',
+        :'address2' => :'address2',
+        :'address3' => :'address3'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'country' => :'String',
+        :'administrative_area' => :'String',
+        :'locality' => :'String',
+        :'postal_code' => :'String',
+        :'address1' => :'String',
+        :'address2' => :'String',
+        :'address3' => :'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?(:'country')
+        self.country = attributes[:'country']
+      end
+
+      if attributes.has_key?(:'administrativeArea')
+        self.administrative_area = attributes[:'administrativeArea']
+      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?(:'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
+    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] country Value to be assigned
+    def country=(country)
+      @country = country
+    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] 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] 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] address3 Value to be assigned
+    def address3=(address3)
+      @address3 = address3
+    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 &&
+          country == o.country &&
+          administrative_area == o.administrative_area &&
+          locality == o.locality &&
+          postal_code == o.postal_code &&
+          address1 == o.address1 &&
+          address2 == o.address2 &&
+          address3 == o.address3
+    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
+      [country, administrative_area, locality, postal_code, address1, address2, address3].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      self.class.swagger_types.each_pair do |key, type|
+        if type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the the attribute
+          # is documented as an array but the input is not
+          if attributes[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        end # or else data not found in attributes(hash), not an issue as the data can be optional
+      end
+
+      self
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def _deserialize(type, value)
+      case type.to_sym
+      when :DateTime
+        DateTime.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :BOOLEAN
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        temp_model = CyberSource.const_get(type).new
+        temp_model.build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        next if value.nil?
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+  end
+end

data/lib/cybersource_rest_client/models/{tms_v1_instrument_identifiers_payment_instruments_get200_response__embedded_buyer_information.rb → vasv2tax_order_information_shipping_details.rb}

@@ -13,35 +13,36 @@ Swagger Codegen version: 2.2.3
 require 'date'
 
 module CyberSource
-  class TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBuyerInformation
-    # Tax identifier for the customer’s company.  **Important**: Contact your TeleCheck representative to find out whether this field is required or optional. 
-    attr_accessor :company_tax_id
+  class Vasv2taxOrderInformationShippingDetails
+    # City where the product is shipped from. This field is used only when the `orderInformation.shipTo.administrativeArea` and `orderInformation.shipTo.country` fields are present.  **NOTE** If this field appears in a `lineItems` object, then the value of this field in the `lineItems` object overrides the value of the corresponding field at the request-level or order-level object.  #### Tax Calculation This field is used to determine tax rules and/or rates applied to the transaction based on sourcing.  Optional for U.S. and Canadian taxes. Not applicable to international and value added taxes. 
+    attr_accessor :ship_from_locality
 
-    # Currency used by the customer. Accepts input in the ISO 4217 standard, stores as ISO 4217 Alpha.
-    attr_accessor :currency
+    # Country from which the order is shipped. This field is used only when `orderInformation.shippingDetails.shipFromLocality` and `orderInformation.shippingDetails.shipFromAdministrativeArea` are present. Use the [ISO Standard Country Codes](http://apps.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf).  **NOTE** If this field appears in a `lineItems` object, then the value of this field in the `lineItems` object overrides the value of the corresponding field at the request-level or order-level object.  #### Tax Calculation This field is used to determine tax rules and/ or rates applied to the transaction based on sourcing.  Optional for U.S., Canadian, international tax, and value added taxes. 
+    attr_accessor :ship_from_country
 
-    # Date of birth of the customer.  Format: `YYYY-MM-DD` or `YYYYMMDD` 
-    attr_accessor :date_of_birth
+    # Postal code where the product is shipped from.  #### Tax Calculation This field is used to determine tax rules and/or rates applied to the transaction based on sourcing.  Optional for U.S. and Canadian taxes. Not applicable to international and value added taxes. 
+    attr_accessor :ship_from_postal_code
 
-    attr_accessor :personal_identification
+    # State from which the order is shipped. This field is used only when `orderInformation.shippingDetails.shipFromLocality` and `orderInformation.shippingDetails.shipFromCountry` are present. Use the [State, Province, and Territory Codes for the United States and Canada](http://apps.cybersource.com/library/documentation/sbc/quickref/states_and_provinces.pdf).  **NOTE** If this field appears in a `lineItems` object, then the value of this field in the `lineItems` object overrides the value of the corresponding field at the request-level or order-level object.  #### Tax Calculation This field is used to determine tax rules and/or rates applied to the transaction based on sourcing.  Optional for U.S. and Canadian taxes. Not applicable to international and value added taxes. 
+    attr_accessor :ship_from_administrative_area
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'company_tax_id' => :'companyTaxID',
-        :'currency' => :'currency',
-        :'date_of_birth' => :'dateOfBirth',
-        :'personal_identification' => :'personalIdentification'
+        :'ship_from_locality' => :'shipFromLocality',
+        :'ship_from_country' => :'shipFromCountry',
+        :'ship_from_postal_code' => :'shipFromPostalCode',
+        :'ship_from_administrative_area' => :'shipFromAdministrativeArea'
       }
     end
 
     # Attribute type mapping.
     def self.swagger_types
       {
-        :'company_tax_id' => :'String',
-        :'currency' => :'String',
-        :'date_of_birth' => :'String',
-        :'personal_identification' => :'Array<TmsV1InstrumentIdentifiersPaymentInstrumentsGet200ResponseEmbeddedBuyerInformationPersonalIdentification>'
+        :'ship_from_locality' => :'String',
+        :'ship_from_country' => :'String',
+        :'ship_from_postal_code' => :'String',
+        :'ship_from_administrative_area' => :'String'
       }
     end
 
@@ -53,22 +54,20 @@ module CyberSource
       # convert string to symbol for hash key
       attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
 
-      if attributes.has_key?(:'companyTaxID')
-        self.company_tax_id = attributes[:'companyTaxID']
+      if attributes.has_key?(:'shipFromLocality')
+        self.ship_from_locality = attributes[:'shipFromLocality']
       end
 
-      if attributes.has_key?(:'currency')
-        self.currency = attributes[:'currency']
+      if attributes.has_key?(:'shipFromCountry')
+        self.ship_from_country = attributes[:'shipFromCountry']
       end
 
-      if attributes.has_key?(:'dateOfBirth')
-        self.date_of_birth = attributes[:'dateOfBirth']
+      if attributes.has_key?(:'shipFromPostalCode')
+        self.ship_from_postal_code = attributes[:'shipFromPostalCode']
       end
 
-      if attributes.has_key?(:'personalIdentification')
-        if (value = attributes[:'personalIdentification']).is_a?(Array)
-          self.personal_identification = value
-        end
+      if attributes.has_key?(:'shipFromAdministrativeArea')
+        self.ship_from_administrative_area = attributes[:'shipFromAdministrativeArea']
       end
     end
 
@@ -76,76 +75,37 @@ module CyberSource
     # @return Array for valid properties with the reasons
     def list_invalid_properties
       invalid_properties = Array.new
-      if !@company_tax_id.nil? && @company_tax_id.to_s.length > 9
-        invalid_properties.push('invalid value for "company_tax_id", the character length must be smaller than or equal to 9.')
-      end
-
-      if !@currency.nil? && @currency.to_s.length > 3
-        invalid_properties.push('invalid value for "currency", the character length must be smaller than or equal to 3.')
-      end
-
-      if !@currency.nil? && @currency.to_s.length < 3
-        invalid_properties.push('invalid value for "currency", the character length must be great than or equal to 3.')
-      end
-
-      if !@date_of_birth.nil? && @date_of_birth.to_s.length > 10
-        invalid_properties.push('invalid value for "date_of_birth", the character length must be smaller than or equal to 10.')
-      end
-
-      if !@date_of_birth.nil? && @date_of_birth.to_s.length < 8
-        invalid_properties.push('invalid value for "date_of_birth", the character length must be great than or equal to 8.')
-      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 !@company_tax_id.nil? && @company_tax_id.to_s.length > 9
-      return false if !@currency.nil? && @currency.to_s.length > 3
-      return false if !@currency.nil? && @currency.to_s.length < 3
-      return false if !@date_of_birth.nil? && @date_of_birth.to_s.length > 10
-      return false if !@date_of_birth.nil? && @date_of_birth.to_s.length < 8
       true
     end
 
     # Custom attribute writer method with validation
-    # @param [Object] company_tax_id Value to be assigned
-    def company_tax_id=(company_tax_id)
-      if !company_tax_id.nil? && company_tax_id.to_s.length > 9
-        fail ArgumentError, 'invalid value for "company_tax_id", the character length must be smaller than or equal to 9.'
-      end
-
-      @company_tax_id = company_tax_id
+    # @param [Object] ship_from_locality Value to be assigned
+    def ship_from_locality=(ship_from_locality)
+      @ship_from_locality = ship_from_locality
     end
 
     # Custom attribute writer method with validation
-    # @param [Object] currency Value to be assigned
-    def currency=(currency)
-      if !currency.nil? && currency.to_s.length > 3
-        fail ArgumentError, 'invalid value for "currency", the character length must be smaller than or equal to 3.'
-      end
-
-      if !currency.nil? && currency.to_s.length < 3
-        fail ArgumentError, 'invalid value for "currency", the character length must be great than or equal to 3.'
-      end
-
-      @currency = currency
+    # @param [Object] ship_from_country Value to be assigned
+    def ship_from_country=(ship_from_country)
+      @ship_from_country = ship_from_country
     end
 
     # Custom attribute writer method with validation
-    # @param [Object] date_of_birth Value to be assigned
-    def date_of_birth=(date_of_birth)
-      if !date_of_birth.nil? && date_of_birth.to_s.length > 10
-        fail ArgumentError, 'invalid value for "date_of_birth", the character length must be smaller than or equal to 10.'
-      end
-
-      if !date_of_birth.nil? && date_of_birth.to_s.length < 8
-        fail ArgumentError, 'invalid value for "date_of_birth", the character length must be great than or equal to 8.'
-      end
+    # @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
 
-      @date_of_birth = date_of_birth
+    # Custom attribute writer method with validation
+    # @param [Object] ship_from_administrative_area Value to be assigned
+    def ship_from_administrative_area=(ship_from_administrative_area)
+      @ship_from_administrative_area = ship_from_administrative_area
     end
 
     # Checks equality by comparing each attribute.
@@ -153,10 +113,10 @@ module CyberSource
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
-          company_tax_id == o.company_tax_id &&
-          currency == o.currency &&
-          date_of_birth == o.date_of_birth &&
-          personal_identification == o.personal_identification
+          ship_from_locality == o.ship_from_locality &&
+          ship_from_country == o.ship_from_country &&
+          ship_from_postal_code == o.ship_from_postal_code &&
+          ship_from_administrative_area == o.ship_from_administrative_area
     end
 
     # @see the `==` method
@@ -168,7 +128,7 @@ module CyberSource
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [company_tax_id, currency, date_of_birth, personal_identification].hash
+      [ship_from_locality, ship_from_country, ship_from_postal_code, ship_from_administrative_area].hash
     end
 
     # Builds the object from hash