cybersource_rest_client 0.0.19 → 0.0.26

data/lib/cybersource_rest_client/models/vasv2tax_order_information_shipping_details.rb

@@ -0,0 +1,274 @@
+=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 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
+
+    # 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
+
+    # 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
+
+    # 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
+      {
+        :'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
+      {
+        :'ship_from_locality' => :'String',
+        :'ship_from_country' => :'String',
+        :'ship_from_postal_code' => :'String',
+        :'ship_from_administrative_area' => :'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?(:'shipFromLocality')
+        self.ship_from_locality = attributes[:'shipFromLocality']
+      end
+
+      if attributes.has_key?(:'shipFromCountry')
+        self.ship_from_country = attributes[:'shipFromCountry']
+      end
+
+      if attributes.has_key?(:'shipFromPostalCode')
+        self.ship_from_postal_code = attributes[:'shipFromPostalCode']
+      end
+
+      if attributes.has_key?(:'shipFromAdministrativeArea')
+        self.ship_from_administrative_area = attributes[:'shipFromAdministrativeArea']
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      if !@ship_from_locality.nil? && @ship_from_locality.to_s.length > 50
+        invalid_properties.push('invalid value for "ship_from_locality", the character length must be smaller than or equal to 50.')
+      end
+
+      if !@ship_from_country.nil? && @ship_from_country.to_s.length > 2
+        invalid_properties.push('invalid value for "ship_from_country", the character length must be smaller than or equal to 2.')
+      end
+
+      if !@ship_from_postal_code.nil? && @ship_from_postal_code.to_s.length > 10
+        invalid_properties.push('invalid value for "ship_from_postal_code", the character length must be smaller than or equal to 10.')
+      end
+
+      if !@ship_from_administrative_area.nil? && @ship_from_administrative_area.to_s.length > 2
+        invalid_properties.push('invalid value for "ship_from_administrative_area", the character length must be smaller than or equal to 2.')
+      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 !@ship_from_locality.nil? && @ship_from_locality.to_s.length > 50
+      return false if !@ship_from_country.nil? && @ship_from_country.to_s.length > 2
+      return false if !@ship_from_postal_code.nil? && @ship_from_postal_code.to_s.length > 10
+      return false if !@ship_from_administrative_area.nil? && @ship_from_administrative_area.to_s.length > 2
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] ship_from_locality Value to be assigned
+    def ship_from_locality=(ship_from_locality)
+      if !ship_from_locality.nil? && ship_from_locality.to_s.length > 50
+        fail ArgumentError, 'invalid value for "ship_from_locality", the character length must be smaller than or equal to 50.'
+      end
+
+      @ship_from_locality = ship_from_locality
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] ship_from_country Value to be assigned
+    def ship_from_country=(ship_from_country)
+      if !ship_from_country.nil? && ship_from_country.to_s.length > 2
+        fail ArgumentError, 'invalid value for "ship_from_country", the character length must be smaller than or equal to 2.'
+      end
+
+      @ship_from_country = ship_from_country
+    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)
+      if !ship_from_postal_code.nil? && ship_from_postal_code.to_s.length > 10
+        fail ArgumentError, 'invalid value for "ship_from_postal_code", the character length must be smaller than or equal to 10.'
+      end
+
+      @ship_from_postal_code = ship_from_postal_code
+    end
+
+    # 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)
+      if !ship_from_administrative_area.nil? && ship_from_administrative_area.to_s.length > 2
+        fail ArgumentError, 'invalid value for "ship_from_administrative_area", the character length must be smaller than or equal to 2.'
+      end
+
+      @ship_from_administrative_area = ship_from_administrative_area
+    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 &&
+          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
+    # @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
+      [ship_from_locality, ship_from_country, ship_from_postal_code, ship_from_administrative_area].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/vasv2tax_tax_information.rb

@@ -0,0 +1,278 @@
+=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 Vasv2taxTaxInformation
+    # Reporting date of transaction. Format: YYYYMMDD. Defaults to current date if not specified. Also the default tax calculation date unless a different date is specified in `orderInformation.invoiceDetails.invoiceDate`.  Optional for U.S., Canadian, international tax, and value added taxes. 
+    attr_accessor :reporting_date
+
+    # If a past or future date is specified in `orderInformation.invoiceDetails.invoiceDate`, then provide the reason for that for audit purposes. Typical reasons include: 'Return', 'Layaway', 'Imported'.  Optional for U.S., Canadian, international tax, and value added taxes. 
+    attr_accessor :date_override_reason
+
+    # Comma-separated list of states or provinces in which merchandise is taxable. Note merchandise may be still be non-taxable or tax exempt depending on the product taxability. Indicate the type of product you are selling in the product code field for product-level taxability rules to be applied. Do not use both the `taxInformation.nexus` and `taxInformation.noNexus` fields in your request. If you do not include this field in a tax calculation service request, the tax system makes its calculations as if you have nexus in every US state or Canadian province. 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).  If you indicate you do not have nexus in the destination state, jurisdiction level fields are left blank in the Tax Detail Report.  Optional field for U.S. and Canadian taxes only. Either this field or `taxInformation.noNexus` is required if you do not have nexus in every state or province.  Not applicable for international and value added taxes. 
+    attr_accessor :nexus
+
+    # Comma-separated list of states or provinces where you do not have nexus. Check with a tax advisor to determine where your business has nexus. Do not use both the `taxInformation.nexus` and `taxInformation.noNexus` fields in your request. If you do not include this field in a tax calculation service request, the tax system makes its calculations as if you have nexus in every US state or Canadian province. 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).  If you indicate you do not have nexus in the destination state, jurisdiction level fields are left blank in the Tax Detail Report.  Optional field for U.S. and Canadian taxes only. Either this field or `taxInformation.nexus` is required if you do not have nexus in every state or province.  Not applicable for international and value added taxes. 
+    attr_accessor :no_nexus
+
+    # Whether or not to display tax amounts for each line item. This field can contain one of the following values: - `Yes` - Display tax amounts for each line item - `No` (default) - Do not display tax amounts for each line item  Optional for U.S., Canadian, international tax, and value added taxes. 
+    attr_accessor :show_tax_per_line_item
+
+    # Indicates whether this is a committed tax transaction. For a committed tax transaction, the status in the Tax Detail Report is “Committed.” For an uncommitted tax transaction, the status in the Tax Detail Report is “Uncommitted.” Possible values: - `true`: This is a committed tax transaction. - `false` (default): This is not a committed tax transaction.  A committed tax request is a tax service request that sets the status field in the Tax Detail Report to committed. The committed status indicates that the amount calculated by the tax service is included in the amount of a capture or credit.  Use a void service request to cancels a committed tax request or a committed refund tax request. The void transaction is included as a separate entry in the Tax Detail Report. The value of the status field is cancelled. The value of the link ID is the request ID of the committed tax request or refund tax request that was voided. You can use the value of the link ID to reconcile your orders.  Optional for U.S., Canadian, international tax, and value added taxes. 
+    attr_accessor :commit_indicator
+
+    # Indicates whether this is a refund tax transaction. For a refund tax transaction, amounts in the Tax Detail Report will be negative. Possible values: - `true`: This is a refund tax transaction. - `false` (default): This is not a refund tax transaction.  A refund tax request is a tax service request that sets the transaction type field in the Tax Detail Report to refunded and makes the reported amount negative. Tax amounts are returned as positive amounts in reply messages, but they are saved in reports as negative amounts which enables the reporting software to accurately calculate the aggregate amounts.  Optional for U.S., Canadian, international tax, and value added taxes. 
+    attr_accessor :refund_indicator
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'reporting_date' => :'reportingDate',
+        :'date_override_reason' => :'dateOverrideReason',
+        :'nexus' => :'nexus',
+        :'no_nexus' => :'noNexus',
+        :'show_tax_per_line_item' => :'showTaxPerLineItem',
+        :'commit_indicator' => :'commitIndicator',
+        :'refund_indicator' => :'refundIndicator'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'reporting_date' => :'String',
+        :'date_override_reason' => :'String',
+        :'nexus' => :'Array<String>',
+        :'no_nexus' => :'Array<String>',
+        :'show_tax_per_line_item' => :'String',
+        :'commit_indicator' => :'BOOLEAN',
+        :'refund_indicator' => :'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?(:'reportingDate')
+        self.reporting_date = attributes[:'reportingDate']
+      end
+
+      if attributes.has_key?(:'dateOverrideReason')
+        self.date_override_reason = attributes[:'dateOverrideReason']
+      end
+
+      if attributes.has_key?(:'nexus')
+        if (value = attributes[:'nexus']).is_a?(Array)
+          self.nexus = value
+        end
+      end
+
+      if attributes.has_key?(:'noNexus')
+        if (value = attributes[:'noNexus']).is_a?(Array)
+          self.no_nexus = value
+        end
+      end
+
+      if attributes.has_key?(:'showTaxPerLineItem')
+        self.show_tax_per_line_item = attributes[:'showTaxPerLineItem']
+      end
+
+      if attributes.has_key?(:'commitIndicator')
+        self.commit_indicator = attributes[:'commitIndicator']
+      end
+
+      if attributes.has_key?(:'refundIndicator')
+        self.refund_indicator = attributes[:'refundIndicator']
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      if !@reporting_date.nil? && @reporting_date.to_s.length > 8
+        invalid_properties.push('invalid value for "reporting_date", the character length must be smaller than or equal to 8.')
+      end
+
+      if !@date_override_reason.nil? && @date_override_reason.to_s.length > 50
+        invalid_properties.push('invalid value for "date_override_reason", the character length must be smaller than or equal to 50.')
+      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 !@reporting_date.nil? && @reporting_date.to_s.length > 8
+      return false if !@date_override_reason.nil? && @date_override_reason.to_s.length > 50
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] reporting_date Value to be assigned
+    def reporting_date=(reporting_date)
+      if !reporting_date.nil? && reporting_date.to_s.length > 8
+        fail ArgumentError, 'invalid value for "reporting_date", the character length must be smaller than or equal to 8.'
+      end
+
+      @reporting_date = reporting_date
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] date_override_reason Value to be assigned
+    def date_override_reason=(date_override_reason)
+      if !date_override_reason.nil? && date_override_reason.to_s.length > 50
+        fail ArgumentError, 'invalid value for "date_override_reason", the character length must be smaller than or equal to 50.'
+      end
+
+      @date_override_reason = date_override_reason
+    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 &&
+          reporting_date == o.reporting_date &&
+          date_override_reason == o.date_override_reason &&
+          nexus == o.nexus &&
+          no_nexus == o.no_nexus &&
+          show_tax_per_line_item == o.show_tax_per_line_item &&
+          commit_indicator == o.commit_indicator &&
+          refund_indicator == o.refund_indicator
+    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
+      [reporting_date, date_override_reason, nexus, no_nexus, show_tax_per_line_item, commit_indicator, refund_indicator].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