class UltracartClient::OrderMarketing
Attributes
Advertising source
True if the customer has opted into mailing list subscription
Referral code
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/ultracart_api/models/order_marketing.rb, line 27 def self.attribute_map { :'advertising_source' => :'advertising_source', :'mailing_list' => :'mailing_list', :'referral_code' => :'referral_code' } end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/ultracart_api/models/order_marketing.rb, line 46 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?(:'advertising_source') self.advertising_source = attributes[:'advertising_source'] end if attributes.has_key?(:'mailing_list') self.mailing_list = attributes[:'mailing_list'] end if attributes.has_key?(:'referral_code') self.referral_code = attributes[:'referral_code'] end end
Attribute type mapping.
# File lib/ultracart_api/models/order_marketing.rb, line 36 def self.swagger_types { :'advertising_source' => :'String', :'mailing_list' => :'BOOLEAN', :'referral_code' => :'String' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/ultracart_api/models/order_marketing.rb, line 110 def ==(o) return true if self.equal?(o) self.class == o.class && advertising_source == o.advertising_source && mailing_list == o.mailing_list && referral_code == o.referral_code end
Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data
# File lib/ultracart_api/models/order_marketing.rb, line 154 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 = UltracartClient.const_get(type).new temp_model.build_from_hash(value) end 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
# File lib/ultracart_api/models/order_marketing.rb, line 220 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
Custom attribute writer method with validation @param [Object] advertising_source
Value to be assigned
# File lib/ultracart_api/models/order_marketing.rb, line 90 def advertising_source=(advertising_source) if !advertising_source.nil? && advertising_source.to_s.length > 50 fail ArgumentError, 'invalid value for "advertising_source", the character length must be smaller than or equal to 50.' end @advertising_source = advertising_source end
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# File lib/ultracart_api/models/order_marketing.rb, line 133 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 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
@see the `==` method @param [Object] Object to be compared
# File lib/ultracart_api/models/order_marketing.rb, line 120 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/ultracart_api/models/order_marketing.rb, line 126 def hash [advertising_source, mailing_list, referral_code].hash end
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons
# File lib/ultracart_api/models/order_marketing.rb, line 67 def list_invalid_properties invalid_properties = Array.new if !@advertising_source.nil? && @advertising_source.to_s.length > 50 invalid_properties.push('invalid value for "advertising_source", the character length must be smaller than or equal to 50.') end if !@referral_code.nil? && @referral_code.to_s.length > 30 invalid_properties.push('invalid value for "referral_code", the character length must be smaller than or equal to 30.') end invalid_properties end
Custom attribute writer method with validation @param [Object] referral_code
Value to be assigned
# File lib/ultracart_api/models/order_marketing.rb, line 100 def referral_code=(referral_code) if !referral_code.nil? && referral_code.to_s.length > 30 fail ArgumentError, 'invalid value for "referral_code", the character length must be smaller than or equal to 30.' end @referral_code = referral_code end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/ultracart_api/models/order_marketing.rb, line 206 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
Returns the string representation of the object @return [String] String presentation of the object
# File lib/ultracart_api/models/order_marketing.rb, line 194 def to_s to_hash.to_s end
Check to see if the all the properties in the model are valid @return true if the model is valid
# File lib/ultracart_api/models/order_marketing.rb, line 82 def valid? return false if !@advertising_source.nil? && @advertising_source.to_s.length > 50 return false if !@referral_code.nil? && @referral_code.to_s.length > 30 true end