cybersource_rest_client 0.0.86 → 0.0.88

data/lib/cybersource_rest_client/models/unifiedrisk_order_shipping.rb

@@ -0,0 +1,464 @@
+=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 UnifiedriskOrderShipping
+    # 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 :address_line1
+
+    # 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 :address_line2
+
+    # 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 :address_line3
+
+    # 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) (maximum length: 2)   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  
+    attr_accessor :administrative_area
+
+    # Country of the shipping address. Use the two-character [ISO Standard Country Codes.]
+    attr_accessor :country
+
+    # Shipping destination of item. Example: Commercial, Residential, Store
+    attr_accessor :destination_types
+
+    # 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
+
+    # First name of the recipient.#### Litle Maximum length: 25#### All other processors Maximum length: 60Optional field.
+    attr_accessor :first_name
+
+    # Last name of the recipient.#### Litle Maximum length: 25#### All other processors Maximum length: 60Optional field.
+    attr_accessor :last_name
+
+    # Middle name of the recipient.#### Litle Maximum length: 25#### All other processors Maximum length: 60Optional field.
+    attr_accessor :middle_name
+
+    # Phone number associated with the shipping address.
+    attr_accessor :phone_number
+
+    # 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-6789When the billing country is Canada, the 6-digit postal code must follow this format: [alpha][numeric][alpha][space][numeric][
+    attr_accessor :postal_code
+
+    # Indicates destination chosen for the transaction. Possible values: - 01- Ship to cardholder billing address - 02- Ship to another verified address on file with merchant - 03- Ship to address that is different than billing address - 04- Ship to store (store address should be populated on request) - 05- Digital goods - 06- Travel and event tickets, not shipped - 07- Other
+    attr_accessor :destination_code
+
+    # Delivery/fulfillment method  Possible values: - shipToHome - storePickup - lockerPickup - curbside
+    attr_accessor :delivery_type
+
+    # Boolean that indicates whether the customer requested gift wrapping for this purchase. This field can contain one of the following values: - true: The customer requested gift wrapping. - false: The customer did not request gift wrapping.
+    attr_accessor :gift_wrap
+
+    # 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  
+    attr_accessor :shipping_method
+
+    attr_accessor :store
+
+    attr_accessor :store_address
+
+    # Email address of the recipient or shipping contact for order confirmation, dispatch notifications, and delivery tracking
+    attr_accessor :email
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'address_line1' => :'addressLine1',
+        :'address_line2' => :'addressLine2',
+        :'address_line3' => :'addressLine3',
+        :'administrative_area' => :'administrativeArea',
+        :'country' => :'country',
+        :'destination_types' => :'destinationTypes',
+        :'locality' => :'locality',
+        :'first_name' => :'firstName',
+        :'last_name' => :'lastName',
+        :'middle_name' => :'middleName',
+        :'phone_number' => :'phoneNumber',
+        :'postal_code' => :'postalCode',
+        :'destination_code' => :'destinationCode',
+        :'delivery_type' => :'deliveryType',
+        :'gift_wrap' => :'giftWrap',
+        :'shipping_method' => :'shippingMethod',
+        :'store' => :'store',
+        :'store_address' => :'storeAddress',
+        :'email' => :'email'
+      }
+    end
+
+    # Attribute mapping from JSON key to ruby-style variable name.
+    def self.json_map
+      {
+        :'address_line1' => :'address_line1',
+        :'address_line2' => :'address_line2',
+        :'address_line3' => :'address_line3',
+        :'administrative_area' => :'administrative_area',
+        :'country' => :'country',
+        :'destination_types' => :'destination_types',
+        :'locality' => :'locality',
+        :'first_name' => :'first_name',
+        :'last_name' => :'last_name',
+        :'middle_name' => :'middle_name',
+        :'phone_number' => :'phone_number',
+        :'postal_code' => :'postal_code',
+        :'destination_code' => :'destination_code',
+        :'delivery_type' => :'delivery_type',
+        :'gift_wrap' => :'gift_wrap',
+        :'shipping_method' => :'shipping_method',
+        :'store' => :'store',
+        :'store_address' => :'store_address',
+        :'email' => :'email'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'address_line1' => :'String',
+        :'address_line2' => :'String',
+        :'address_line3' => :'String',
+        :'administrative_area' => :'String',
+        :'country' => :'String',
+        :'destination_types' => :'String',
+        :'locality' => :'String',
+        :'first_name' => :'String',
+        :'last_name' => :'String',
+        :'middle_name' => :'String',
+        :'phone_number' => :'String',
+        :'postal_code' => :'String',
+        :'destination_code' => :'Integer',
+        :'delivery_type' => :'String',
+        :'gift_wrap' => :'BOOLEAN',
+        :'shipping_method' => :'String',
+        :'store' => :'UnifiedriskOrderShippingStore',
+        :'store_address' => :'UnifiedriskOrderShippingStoreAddress',
+        :'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?(:'addressLine1')
+        self.address_line1 = attributes[:'addressLine1']
+      end
+
+      if attributes.has_key?(:'addressLine2')
+        self.address_line2 = attributes[:'addressLine2']
+      end
+
+      if attributes.has_key?(:'addressLine3')
+        self.address_line3 = attributes[:'addressLine3']
+      end
+
+      if attributes.has_key?(:'administrativeArea')
+        self.administrative_area = attributes[:'administrativeArea']
+      end
+
+      if attributes.has_key?(:'country')
+        self.country = attributes[:'country']
+      end
+
+      if attributes.has_key?(:'destinationTypes')
+        self.destination_types = attributes[:'destinationTypes']
+      end
+
+      if attributes.has_key?(:'locality')
+        self.locality = attributes[:'locality']
+      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?(:'middleName')
+        self.middle_name = attributes[:'middleName']
+      end
+
+      if attributes.has_key?(:'phoneNumber')
+        self.phone_number = attributes[:'phoneNumber']
+      end
+
+      if attributes.has_key?(:'postalCode')
+        self.postal_code = attributes[:'postalCode']
+      end
+
+      if attributes.has_key?(:'destinationCode')
+        self.destination_code = attributes[:'destinationCode']
+      end
+
+      if attributes.has_key?(:'deliveryType')
+        self.delivery_type = attributes[:'deliveryType']
+      end
+
+      if attributes.has_key?(:'giftWrap')
+        self.gift_wrap = attributes[:'giftWrap']
+      end
+
+      if attributes.has_key?(:'shippingMethod')
+        self.shipping_method = attributes[:'shippingMethod']
+      end
+
+      if attributes.has_key?(:'store')
+        self.store = attributes[:'store']
+      end
+
+      if attributes.has_key?(:'storeAddress')
+        self.store_address = attributes[:'storeAddress']
+      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] address_line1 Value to be assigned
+    def address_line1=(address_line1)
+      @address_line1 = address_line1
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] address_line2 Value to be assigned
+    def address_line2=(address_line2)
+      @address_line2 = address_line2
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] address_line3 Value to be assigned
+    def address_line3=(address_line3)
+      @address_line3 = address_line3
+    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] country Value to be assigned
+    def country=(country)
+      @country = country
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] destination_types Value to be assigned
+    def destination_types=(destination_types)
+      @destination_types = destination_types
+    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] 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] middle_name Value to be assigned
+    def middle_name=(middle_name)
+      @middle_name = middle_name
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] phone_number Value to be assigned
+    def phone_number=(phone_number)
+      @phone_number = phone_number
+    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] shipping_method Value to be assigned
+    def shipping_method=(shipping_method)
+      @shipping_method = shipping_method
+    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 &&
+          address_line1 == o.address_line1 &&
+          address_line2 == o.address_line2 &&
+          address_line3 == o.address_line3 &&
+          administrative_area == o.administrative_area &&
+          country == o.country &&
+          destination_types == o.destination_types &&
+          locality == o.locality &&
+          first_name == o.first_name &&
+          last_name == o.last_name &&
+          middle_name == o.middle_name &&
+          phone_number == o.phone_number &&
+          postal_code == o.postal_code &&
+          destination_code == o.destination_code &&
+          delivery_type == o.delivery_type &&
+          gift_wrap == o.gift_wrap &&
+          shipping_method == o.shipping_method &&
+          store == o.store &&
+          store_address == o.store_address &&
+          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
+      [address_line1, address_line2, address_line3, administrative_area, country, destination_types, locality, first_name, last_name, middle_name, phone_number, postal_code, destination_code, delivery_type, gift_wrap, shipping_method, store, store_address, 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