class UltracartClient::AffiliateLink
Attributes
Unique object identifier associated with this link
Managed link OID that this link object was generated from
Affiliate object ID associated with this link
The affiliate program item this managed link is associated with
Code associated with the link
Creative (image or text) associated with this link
Custom HTML associated with this link
Approved status of the custom html
Custom landing page URL if configured
True if the link has been deleted
Invisible link approval status
Invisible link URL prefix
Name of the link
Type of link
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/ultracart_api/models/affiliate_link.rb, line 82 def self.attribute_map { :'affiliate_link_oid' => :'affiliate_link_oid', :'affiliate_managed_link_oid' => :'affiliate_managed_link_oid', :'affiliate_oid' => :'affiliate_oid', :'affiliate_program_item_oid' => :'affiliate_program_item_oid', :'code' => :'code', :'creative_oid' => :'creative_oid', :'custom_html' => :'custom_html', :'custom_html_approval_status' => :'custom_html_approval_status', :'custom_landing_url' => :'custom_landing_url', :'deleted' => :'deleted', :'invisible_link_approval_status' => :'invisible_link_approval_status', :'invisible_link_url_prefix' => :'invisible_link_url_prefix', :'name' => :'name', :'type' => :'type' } end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/ultracart_api/models/affiliate_link.rb, line 123 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?(:'affiliate_link_oid') self.affiliate_link_oid = attributes[:'affiliate_link_oid'] end if attributes.has_key?(:'affiliate_managed_link_oid') self.affiliate_managed_link_oid = attributes[:'affiliate_managed_link_oid'] end if attributes.has_key?(:'affiliate_oid') self.affiliate_oid = attributes[:'affiliate_oid'] end if attributes.has_key?(:'affiliate_program_item_oid') self.affiliate_program_item_oid = attributes[:'affiliate_program_item_oid'] end if attributes.has_key?(:'code') self.code = attributes[:'code'] end if attributes.has_key?(:'creative_oid') self.creative_oid = attributes[:'creative_oid'] end if attributes.has_key?(:'custom_html') self.custom_html = attributes[:'custom_html'] end if attributes.has_key?(:'custom_html_approval_status') self.custom_html_approval_status = attributes[:'custom_html_approval_status'] end if attributes.has_key?(:'custom_landing_url') self.custom_landing_url = attributes[:'custom_landing_url'] end if attributes.has_key?(:'deleted') self.deleted = attributes[:'deleted'] end if attributes.has_key?(:'invisible_link_approval_status') self.invisible_link_approval_status = attributes[:'invisible_link_approval_status'] end if attributes.has_key?(:'invisible_link_url_prefix') self.invisible_link_url_prefix = attributes[:'invisible_link_url_prefix'] end if attributes.has_key?(:'name') self.name = attributes[:'name'] end if attributes.has_key?(:'type') self.type = attributes[:'type'] end end
Attribute type mapping.
# File lib/ultracart_api/models/affiliate_link.rb, line 102 def self.swagger_types { :'affiliate_link_oid' => :'Integer', :'affiliate_managed_link_oid' => :'Integer', :'affiliate_oid' => :'Integer', :'affiliate_program_item_oid' => :'Integer', :'code' => :'String', :'creative_oid' => :'Integer', :'custom_html' => :'String', :'custom_html_approval_status' => :'String', :'custom_landing_url' => :'String', :'deleted' => :'BOOLEAN', :'invisible_link_approval_status' => :'String', :'invisible_link_url_prefix' => :'String', :'name' => :'String', :'type' => :'String' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/ultracart_api/models/affiliate_link.rb, line 237 def ==(o) return true if self.equal?(o) self.class == o.class && affiliate_link_oid == o.affiliate_link_oid && affiliate_managed_link_oid == o.affiliate_managed_link_oid && affiliate_oid == o.affiliate_oid && affiliate_program_item_oid == o.affiliate_program_item_oid && code == o.code && creative_oid == o.creative_oid && custom_html == o.custom_html && custom_html_approval_status == o.custom_html_approval_status && custom_landing_url == o.custom_landing_url && deleted == o.deleted && invisible_link_approval_status == o.invisible_link_approval_status && invisible_link_url_prefix == o.invisible_link_url_prefix && name == o.name && type == o.type 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/affiliate_link.rb, line 292 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/affiliate_link.rb, line 358 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
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/affiliate_link.rb, line 271 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
Custom attribute writer method checking allowed values (enum). @param [Object] custom_html_approval_status
Object to be assigned
# File lib/ultracart_api/models/affiliate_link.rb, line 207 def custom_html_approval_status=(custom_html_approval_status) validator = EnumAttributeValidator.new('String', ['Pending', 'Approved', 'Rejected']) unless validator.valid?(custom_html_approval_status) fail ArgumentError, 'invalid value for "custom_html_approval_status", must be one of #{validator.allowable_values}.' end @custom_html_approval_status = custom_html_approval_status end
@see the `==` method @param [Object] Object to be compared
# File lib/ultracart_api/models/affiliate_link.rb, line 258 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/ultracart_api/models/affiliate_link.rb, line 264 def hash [affiliate_link_oid, affiliate_managed_link_oid, affiliate_oid, affiliate_program_item_oid, code, creative_oid, custom_html, custom_html_approval_status, custom_landing_url, deleted, invisible_link_approval_status, invisible_link_url_prefix, name, type].hash end
Custom attribute writer method checking allowed values (enum). @param [Object] invisible_link_approval_status
Object to be assigned
# File lib/ultracart_api/models/affiliate_link.rb, line 217 def invisible_link_approval_status=(invisible_link_approval_status) validator = EnumAttributeValidator.new('String', ['Pending', 'Approved', 'Rejected']) unless validator.valid?(invisible_link_approval_status) fail ArgumentError, 'invalid value for "invisible_link_approval_status", must be one of #{validator.allowable_values}.' end @invisible_link_approval_status = invisible_link_approval_status 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/affiliate_link.rb, line 188 def list_invalid_properties invalid_properties = Array.new invalid_properties end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/ultracart_api/models/affiliate_link.rb, line 344 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/affiliate_link.rb, line 332 def to_s to_hash.to_s end
Custom attribute writer method checking allowed values (enum). @param [Object] type Object to be assigned
# File lib/ultracart_api/models/affiliate_link.rb, line 227 def type=(type) validator = EnumAttributeValidator.new('String', ['image', 'text', 'invisible', 'direct']) unless validator.valid?(type) fail ArgumentError, 'invalid value for "type", must be one of #{validator.allowable_values}.' end @type = type 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/affiliate_link.rb, line 195 def valid? custom_html_approval_status_validator = EnumAttributeValidator.new('String', ['Pending', 'Approved', 'Rejected']) return false unless custom_html_approval_status_validator.valid?(@custom_html_approval_status) invisible_link_approval_status_validator = EnumAttributeValidator.new('String', ['Pending', 'Approved', 'Rejected']) return false unless invisible_link_approval_status_validator.valid?(@invisible_link_approval_status) type_validator = EnumAttributeValidator.new('String', ['image', 'text', 'invisible', 'direct']) return false unless type_validator.valid?(@type) true end