cybersource_rest_client 0.0.82 → 0.0.84

data/lib/cybersource_rest_client/models/ucv1sessions_data_order_information_line_items.rb

@@ -0,0 +1,702 @@
+=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 Ucv1sessionsDataOrderInformationLineItems
+    # Code identifying the product.
+    attr_accessor :product_code
+
+    # Name of the product.
+    attr_accessor :product_name
+
+    # Stock Keeping Unit identifier
+    attr_accessor :product_sku
+
+    # Quantity of the product
+    attr_accessor :quantity
+
+    # Price per unit
+    attr_accessor :unit_price
+
+    # Unit of measure (e.g. EA, KG, LB)
+    attr_accessor :unit_of_measure
+
+    # Total amount for the line item
+    attr_accessor :total_amount
+
+    # The tax rate of an item. Maximum of 2 decimal places. Valid range is 0 or 0.01 to 99.99. 
+    attr_accessor :tax_rate
+
+    # Country where item will be shipped
+    attr_accessor :shipping_country_code
+
+    # Tax amount applied
+    attr_accessor :tax_amount
+
+    # Indicates if tax applied after discount
+    attr_accessor :tax_applied_after_discount
+
+    # Tax status indicator
+    attr_accessor :tax_status_indicator
+
+    # Tax type code
+    attr_accessor :tax_type_code
+
+    # Indicates if amount includes tax
+    attr_accessor :amount_includes_tax
+
+    # Type of supply
+    attr_accessor :type_of_supply
+
+    # Commodity code
+    attr_accessor :commodity_code
+
+    # Discount amount applied
+    attr_accessor :discount_amount
+
+    # Indicates if discount applied
+    attr_accessor :discount_applied
+
+    # Discount rate applied
+    attr_accessor :discount_rate
+
+    # Invoice number for the line item
+    attr_accessor :invoice_number
+
+    attr_accessor :tax_details
+
+    # Fulfillment type
+    attr_accessor :fulfillment_type
+
+    # Weight of the product
+    attr_accessor :weight
+
+    # Weight identifier
+    attr_accessor :weight_identifier
+
+    # Unit of weight of the product
+    attr_accessor :weight_unit
+
+    # Reference data code
+    attr_accessor :reference_data_code
+
+    # Reference data number
+    attr_accessor :reference_data_number
+
+    # Unit tax amount
+    attr_accessor :unit_tax_amount
+
+    # Description of the product
+    attr_accessor :product_description
+
+    # Gift card currency
+    attr_accessor :gift_card_currency
+
+    # Shipping destination types
+    attr_accessor :shipping_destination_types
+
+    # Indicates if item is a gift
+    attr_accessor :gift
+
+    attr_accessor :passenger
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'product_code' => :'productCode',
+        :'product_name' => :'productName',
+        :'product_sku' => :'productSku',
+        :'quantity' => :'quantity',
+        :'unit_price' => :'unitPrice',
+        :'unit_of_measure' => :'unitOfMeasure',
+        :'total_amount' => :'totalAmount',
+        :'tax_rate' => :'taxRate',
+        :'shipping_country_code' => :'shippingCountryCode',
+        :'tax_amount' => :'taxAmount',
+        :'tax_applied_after_discount' => :'taxAppliedAfterDiscount',
+        :'tax_status_indicator' => :'taxStatusIndicator',
+        :'tax_type_code' => :'taxTypeCode',
+        :'amount_includes_tax' => :'amountIncludesTax',
+        :'type_of_supply' => :'typeOfSupply',
+        :'commodity_code' => :'commodityCode',
+        :'discount_amount' => :'discountAmount',
+        :'discount_applied' => :'discountApplied',
+        :'discount_rate' => :'discountRate',
+        :'invoice_number' => :'invoiceNumber',
+        :'tax_details' => :'taxDetails',
+        :'fulfillment_type' => :'fulfillmentType',
+        :'weight' => :'weight',
+        :'weight_identifier' => :'weightIdentifier',
+        :'weight_unit' => :'weightUnit',
+        :'reference_data_code' => :'referenceDataCode',
+        :'reference_data_number' => :'referenceDataNumber',
+        :'unit_tax_amount' => :'unitTaxAmount',
+        :'product_description' => :'productDescription',
+        :'gift_card_currency' => :'giftCardCurrency',
+        :'shipping_destination_types' => :'shippingDestinationTypes',
+        :'gift' => :'gift',
+        :'passenger' => :'passenger'
+      }
+    end
+
+    # Attribute mapping from JSON key to ruby-style variable name.
+    def self.json_map
+      {
+        :'product_code' => :'product_code',
+        :'product_name' => :'product_name',
+        :'product_sku' => :'product_sku',
+        :'quantity' => :'quantity',
+        :'unit_price' => :'unit_price',
+        :'unit_of_measure' => :'unit_of_measure',
+        :'total_amount' => :'total_amount',
+        :'tax_rate' => :'tax_rate',
+        :'shipping_country_code' => :'shipping_country_code',
+        :'tax_amount' => :'tax_amount',
+        :'tax_applied_after_discount' => :'tax_applied_after_discount',
+        :'tax_status_indicator' => :'tax_status_indicator',
+        :'tax_type_code' => :'tax_type_code',
+        :'amount_includes_tax' => :'amount_includes_tax',
+        :'type_of_supply' => :'type_of_supply',
+        :'commodity_code' => :'commodity_code',
+        :'discount_amount' => :'discount_amount',
+        :'discount_applied' => :'discount_applied',
+        :'discount_rate' => :'discount_rate',
+        :'invoice_number' => :'invoice_number',
+        :'tax_details' => :'tax_details',
+        :'fulfillment_type' => :'fulfillment_type',
+        :'weight' => :'weight',
+        :'weight_identifier' => :'weight_identifier',
+        :'weight_unit' => :'weight_unit',
+        :'reference_data_code' => :'reference_data_code',
+        :'reference_data_number' => :'reference_data_number',
+        :'unit_tax_amount' => :'unit_tax_amount',
+        :'product_description' => :'product_description',
+        :'gift_card_currency' => :'gift_card_currency',
+        :'shipping_destination_types' => :'shipping_destination_types',
+        :'gift' => :'gift',
+        :'passenger' => :'passenger'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'product_code' => :'String',
+        :'product_name' => :'String',
+        :'product_sku' => :'String',
+        :'quantity' => :'Integer',
+        :'unit_price' => :'String',
+        :'unit_of_measure' => :'String',
+        :'total_amount' => :'String',
+        :'tax_rate' => :'String',
+        :'shipping_country_code' => :'String',
+        :'tax_amount' => :'String',
+        :'tax_applied_after_discount' => :'String',
+        :'tax_status_indicator' => :'String',
+        :'tax_type_code' => :'String',
+        :'amount_includes_tax' => :'BOOLEAN',
+        :'type_of_supply' => :'String',
+        :'commodity_code' => :'String',
+        :'discount_amount' => :'String',
+        :'discount_applied' => :'BOOLEAN',
+        :'discount_rate' => :'String',
+        :'invoice_number' => :'String',
+        :'tax_details' => :'Upv1capturecontextsDataOrderInformationLineItemsTaxDetails',
+        :'fulfillment_type' => :'String',
+        :'weight' => :'String',
+        :'weight_identifier' => :'String',
+        :'weight_unit' => :'String',
+        :'reference_data_code' => :'String',
+        :'reference_data_number' => :'String',
+        :'unit_tax_amount' => :'String',
+        :'product_description' => :'String',
+        :'gift_card_currency' => :'String',
+        :'shipping_destination_types' => :'String',
+        :'gift' => :'BOOLEAN',
+        :'passenger' => :'Upv1capturecontextsDataOrderInformationLineItemsPassenger'
+      }
+    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?(:'productCode')
+        self.product_code = attributes[:'productCode']
+      end
+
+      if attributes.has_key?(:'productName')
+        self.product_name = attributes[:'productName']
+      end
+
+      if attributes.has_key?(:'productSku')
+        self.product_sku = attributes[:'productSku']
+      end
+
+      if attributes.has_key?(:'quantity')
+        self.quantity = attributes[:'quantity']
+      end
+
+      if attributes.has_key?(:'unitPrice')
+        self.unit_price = attributes[:'unitPrice']
+      end
+
+      if attributes.has_key?(:'unitOfMeasure')
+        self.unit_of_measure = attributes[:'unitOfMeasure']
+      end
+
+      if attributes.has_key?(:'totalAmount')
+        self.total_amount = attributes[:'totalAmount']
+      end
+
+      if attributes.has_key?(:'taxRate')
+        self.tax_rate = attributes[:'taxRate']
+      end
+
+      if attributes.has_key?(:'shippingCountryCode')
+        self.shipping_country_code = attributes[:'shippingCountryCode']
+      end
+
+      if attributes.has_key?(:'taxAmount')
+        self.tax_amount = attributes[:'taxAmount']
+      end
+
+      if attributes.has_key?(:'taxAppliedAfterDiscount')
+        self.tax_applied_after_discount = attributes[:'taxAppliedAfterDiscount']
+      end
+
+      if attributes.has_key?(:'taxStatusIndicator')
+        self.tax_status_indicator = attributes[:'taxStatusIndicator']
+      end
+
+      if attributes.has_key?(:'taxTypeCode')
+        self.tax_type_code = attributes[:'taxTypeCode']
+      end
+
+      if attributes.has_key?(:'amountIncludesTax')
+        self.amount_includes_tax = attributes[:'amountIncludesTax']
+      end
+
+      if attributes.has_key?(:'typeOfSupply')
+        self.type_of_supply = attributes[:'typeOfSupply']
+      end
+
+      if attributes.has_key?(:'commodityCode')
+        self.commodity_code = attributes[:'commodityCode']
+      end
+
+      if attributes.has_key?(:'discountAmount')
+        self.discount_amount = attributes[:'discountAmount']
+      end
+
+      if attributes.has_key?(:'discountApplied')
+        self.discount_applied = attributes[:'discountApplied']
+      end
+
+      if attributes.has_key?(:'discountRate')
+        self.discount_rate = attributes[:'discountRate']
+      end
+
+      if attributes.has_key?(:'invoiceNumber')
+        self.invoice_number = attributes[:'invoiceNumber']
+      end
+
+      if attributes.has_key?(:'taxDetails')
+        self.tax_details = attributes[:'taxDetails']
+      end
+
+      if attributes.has_key?(:'fulfillmentType')
+        self.fulfillment_type = attributes[:'fulfillmentType']
+      end
+
+      if attributes.has_key?(:'weight')
+        self.weight = attributes[:'weight']
+      end
+
+      if attributes.has_key?(:'weightIdentifier')
+        self.weight_identifier = attributes[:'weightIdentifier']
+      end
+
+      if attributes.has_key?(:'weightUnit')
+        self.weight_unit = attributes[:'weightUnit']
+      end
+
+      if attributes.has_key?(:'referenceDataCode')
+        self.reference_data_code = attributes[:'referenceDataCode']
+      end
+
+      if attributes.has_key?(:'referenceDataNumber')
+        self.reference_data_number = attributes[:'referenceDataNumber']
+      end
+
+      if attributes.has_key?(:'unitTaxAmount')
+        self.unit_tax_amount = attributes[:'unitTaxAmount']
+      end
+
+      if attributes.has_key?(:'productDescription')
+        self.product_description = attributes[:'productDescription']
+      end
+
+      if attributes.has_key?(:'giftCardCurrency')
+        self.gift_card_currency = attributes[:'giftCardCurrency']
+      end
+
+      if attributes.has_key?(:'shippingDestinationTypes')
+        self.shipping_destination_types = attributes[:'shippingDestinationTypes']
+      end
+
+      if attributes.has_key?(:'gift')
+        self.gift = attributes[:'gift']
+      end
+
+      if attributes.has_key?(:'passenger')
+        self.passenger = attributes[:'passenger']
+      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] product_code Value to be assigned
+    def product_code=(product_code)
+      @product_code = product_code
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] product_name Value to be assigned
+    def product_name=(product_name)
+      @product_name = product_name
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] product_sku Value to be assigned
+    def product_sku=(product_sku)
+      @product_sku = product_sku
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] quantity Value to be assigned
+    def quantity=(quantity)
+      @quantity = quantity
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] unit_price Value to be assigned
+    def unit_price=(unit_price)
+      @unit_price = unit_price
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] unit_of_measure Value to be assigned
+    def unit_of_measure=(unit_of_measure)
+      @unit_of_measure = unit_of_measure
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] total_amount Value to be assigned
+    def total_amount=(total_amount)
+      @total_amount = total_amount
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] tax_rate Value to be assigned
+    def tax_rate=(tax_rate)
+      @tax_rate = tax_rate
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] shipping_country_code Value to be assigned
+    def shipping_country_code=(shipping_country_code)
+      @shipping_country_code = shipping_country_code
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] tax_amount Value to be assigned
+    def tax_amount=(tax_amount)
+      @tax_amount = tax_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_status_indicator Value to be assigned
+    def tax_status_indicator=(tax_status_indicator)
+      @tax_status_indicator = tax_status_indicator
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] tax_type_code Value to be assigned
+    def tax_type_code=(tax_type_code)
+      @tax_type_code = tax_type_code
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] type_of_supply Value to be assigned
+    def type_of_supply=(type_of_supply)
+      @type_of_supply = type_of_supply
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] commodity_code Value to be assigned
+    def commodity_code=(commodity_code)
+      @commodity_code = commodity_code
+    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] discount_rate Value to be assigned
+    def discount_rate=(discount_rate)
+      @discount_rate = discount_rate
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] invoice_number Value to be assigned
+    def invoice_number=(invoice_number)
+      @invoice_number = invoice_number
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] weight Value to be assigned
+    def weight=(weight)
+      @weight = weight
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] weight_identifier Value to be assigned
+    def weight_identifier=(weight_identifier)
+      @weight_identifier = weight_identifier
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] weight_unit Value to be assigned
+    def weight_unit=(weight_unit)
+      @weight_unit = weight_unit
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] reference_data_code Value to be assigned
+    def reference_data_code=(reference_data_code)
+      @reference_data_code = reference_data_code
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] reference_data_number Value to be assigned
+    def reference_data_number=(reference_data_number)
+      @reference_data_number = reference_data_number
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] unit_tax_amount Value to be assigned
+    def unit_tax_amount=(unit_tax_amount)
+      @unit_tax_amount = unit_tax_amount
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] product_description Value to be assigned
+    def product_description=(product_description)
+      @product_description = product_description
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] gift_card_currency Value to be assigned
+    def gift_card_currency=(gift_card_currency)
+      @gift_card_currency = gift_card_currency
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] shipping_destination_types Value to be assigned
+    def shipping_destination_types=(shipping_destination_types)
+      @shipping_destination_types = shipping_destination_types
+    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 &&
+          product_code == o.product_code &&
+          product_name == o.product_name &&
+          product_sku == o.product_sku &&
+          quantity == o.quantity &&
+          unit_price == o.unit_price &&
+          unit_of_measure == o.unit_of_measure &&
+          total_amount == o.total_amount &&
+          tax_rate == o.tax_rate &&
+          shipping_country_code == o.shipping_country_code &&
+          tax_amount == o.tax_amount &&
+          tax_applied_after_discount == o.tax_applied_after_discount &&
+          tax_status_indicator == o.tax_status_indicator &&
+          tax_type_code == o.tax_type_code &&
+          amount_includes_tax == o.amount_includes_tax &&
+          type_of_supply == o.type_of_supply &&
+          commodity_code == o.commodity_code &&
+          discount_amount == o.discount_amount &&
+          discount_applied == o.discount_applied &&
+          discount_rate == o.discount_rate &&
+          invoice_number == o.invoice_number &&
+          tax_details == o.tax_details &&
+          fulfillment_type == o.fulfillment_type &&
+          weight == o.weight &&
+          weight_identifier == o.weight_identifier &&
+          weight_unit == o.weight_unit &&
+          reference_data_code == o.reference_data_code &&
+          reference_data_number == o.reference_data_number &&
+          unit_tax_amount == o.unit_tax_amount &&
+          product_description == o.product_description &&
+          gift_card_currency == o.gift_card_currency &&
+          shipping_destination_types == o.shipping_destination_types &&
+          gift == o.gift &&
+          passenger == o.passenger
+    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
+      [product_code, product_name, product_sku, quantity, unit_price, unit_of_measure, total_amount, tax_rate, shipping_country_code, tax_amount, tax_applied_after_discount, tax_status_indicator, tax_type_code, amount_includes_tax, type_of_supply, commodity_code, discount_amount, discount_applied, discount_rate, invoice_number, tax_details, fulfillment_type, weight, weight_identifier, weight_unit, reference_data_code, reference_data_number, unit_tax_amount, product_description, gift_card_currency, shipping_destination_types, gift, passenger].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