class UltracartClient::ScreenRecordingFilterValues

Attributes

communications_campaign_names[RW]
communications_email_subjects[RW]
communications_flow_names[RW]
email_domains[RW]
geolocation_countries[RW]
geolocation_states[RW]
language_iso_codes[RW]
max_values[RW]
page_views[RW]
preferred_languages[RW]
referrer_domains[RW]
time_on_site_max[RW]
time_on_site_min[RW]
urls[RW]
user_agent_device_names[RW]
user_agent_device_os_names[RW]
user_agent_device_os_versions[RW]
user_agent_names[RW]
user_agent_originals[RW]
utm_campaigns[RW]
utm_sources[RW]

Public Class Methods

attribute_map() click to toggle source

Attribute mapping from ruby-style variable name to JSON key.

# File lib/ultracart_api/models/screen_recording_filter_values.rb, line 60
def self.attribute_map
  {
    :'communications_campaign_names' => :'communications_campaign_names',
    :'communications_email_subjects' => :'communications_email_subjects',
    :'communications_flow_names' => :'communications_flow_names',
    :'email_domains' => :'email_domains',
    :'geolocation_countries' => :'geolocation_countries',
    :'geolocation_states' => :'geolocation_states',
    :'language_iso_codes' => :'language_iso_codes',
    :'max_values' => :'max_values',
    :'page_views' => :'page_views',
    :'preferred_languages' => :'preferred_languages',
    :'referrer_domains' => :'referrer_domains',
    :'time_on_site_max' => :'time_on_site_max',
    :'time_on_site_min' => :'time_on_site_min',
    :'urls' => :'urls',
    :'user_agent_device_names' => :'user_agent_device_names',
    :'user_agent_device_os_names' => :'user_agent_device_os_names',
    :'user_agent_device_os_versions' => :'user_agent_device_os_versions',
    :'user_agent_names' => :'user_agent_names',
    :'user_agent_originals' => :'user_agent_originals',
    :'utm_campaigns' => :'utm_campaigns',
    :'utm_sources' => :'utm_sources'
  }
end
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash

# File lib/ultracart_api/models/screen_recording_filter_values.rb, line 115
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?(:'communications_campaign_names')
    if (value = attributes[:'communications_campaign_names']).is_a?(Array)
      self.communications_campaign_names = value
    end
  end

  if attributes.has_key?(:'communications_email_subjects')
    if (value = attributes[:'communications_email_subjects']).is_a?(Array)
      self.communications_email_subjects = value
    end
  end

  if attributes.has_key?(:'communications_flow_names')
    if (value = attributes[:'communications_flow_names']).is_a?(Array)
      self.communications_flow_names = value
    end
  end

  if attributes.has_key?(:'email_domains')
    if (value = attributes[:'email_domains']).is_a?(Array)
      self.email_domains = value
    end
  end

  if attributes.has_key?(:'geolocation_countries')
    if (value = attributes[:'geolocation_countries']).is_a?(Array)
      self.geolocation_countries = value
    end
  end

  if attributes.has_key?(:'geolocation_states')
    if (value = attributes[:'geolocation_states']).is_a?(Array)
      self.geolocation_states = value
    end
  end

  if attributes.has_key?(:'language_iso_codes')
    if (value = attributes[:'language_iso_codes']).is_a?(Array)
      self.language_iso_codes = value
    end
  end

  if attributes.has_key?(:'max_values')
    self.max_values = attributes[:'max_values']
  end

  if attributes.has_key?(:'page_views')
    if (value = attributes[:'page_views']).is_a?(Array)
      self.page_views = value
    end
  end

  if attributes.has_key?(:'preferred_languages')
    if (value = attributes[:'preferred_languages']).is_a?(Array)
      self.preferred_languages = value
    end
  end

  if attributes.has_key?(:'referrer_domains')
    if (value = attributes[:'referrer_domains']).is_a?(Array)
      self.referrer_domains = value
    end
  end

  if attributes.has_key?(:'time_on_site_max')
    self.time_on_site_max = attributes[:'time_on_site_max']
  end

  if attributes.has_key?(:'time_on_site_min')
    self.time_on_site_min = attributes[:'time_on_site_min']
  end

  if attributes.has_key?(:'urls')
    if (value = attributes[:'urls']).is_a?(Array)
      self.urls = value
    end
  end

  if attributes.has_key?(:'user_agent_device_names')
    if (value = attributes[:'user_agent_device_names']).is_a?(Array)
      self.user_agent_device_names = value
    end
  end

  if attributes.has_key?(:'user_agent_device_os_names')
    if (value = attributes[:'user_agent_device_os_names']).is_a?(Array)
      self.user_agent_device_os_names = value
    end
  end

  if attributes.has_key?(:'user_agent_device_os_versions')
    if (value = attributes[:'user_agent_device_os_versions']).is_a?(Array)
      self.user_agent_device_os_versions = value
    end
  end

  if attributes.has_key?(:'user_agent_names')
    if (value = attributes[:'user_agent_names']).is_a?(Array)
      self.user_agent_names = value
    end
  end

  if attributes.has_key?(:'user_agent_originals')
    if (value = attributes[:'user_agent_originals']).is_a?(Array)
      self.user_agent_originals = value
    end
  end

  if attributes.has_key?(:'utm_campaigns')
    if (value = attributes[:'utm_campaigns']).is_a?(Array)
      self.utm_campaigns = value
    end
  end

  if attributes.has_key?(:'utm_sources')
    if (value = attributes[:'utm_sources']).is_a?(Array)
      self.utm_sources = value
    end
  end
end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/ultracart_api/models/screen_recording_filter_values.rb, line 87
def self.swagger_types
  {
    :'communications_campaign_names' => :'Array<String>',
    :'communications_email_subjects' => :'Array<String>',
    :'communications_flow_names' => :'Array<String>',
    :'email_domains' => :'Array<String>',
    :'geolocation_countries' => :'Array<String>',
    :'geolocation_states' => :'Array<String>',
    :'language_iso_codes' => :'Array<String>',
    :'max_values' => :'Integer',
    :'page_views' => :'Array<ScreenRecordingFilterValuesPageView>',
    :'preferred_languages' => :'Array<String>',
    :'referrer_domains' => :'Array<String>',
    :'time_on_site_max' => :'Integer',
    :'time_on_site_min' => :'Integer',
    :'urls' => :'Array<String>',
    :'user_agent_device_names' => :'Array<String>',
    :'user_agent_device_os_names' => :'Array<String>',
    :'user_agent_device_os_versions' => :'Array<String>',
    :'user_agent_names' => :'Array<String>',
    :'user_agent_originals' => :'Array<String>',
    :'utm_campaigns' => :'Array<String>',
    :'utm_sources' => :'Array<String>'
  }
end

Public Instance Methods

==(o) click to toggle source

Checks equality by comparing each attribute. @param [Object] Object to be compared

# File lib/ultracart_api/models/screen_recording_filter_values.rb, line 257
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      communications_campaign_names == o.communications_campaign_names &&
      communications_email_subjects == o.communications_email_subjects &&
      communications_flow_names == o.communications_flow_names &&
      email_domains == o.email_domains &&
      geolocation_countries == o.geolocation_countries &&
      geolocation_states == o.geolocation_states &&
      language_iso_codes == o.language_iso_codes &&
      max_values == o.max_values &&
      page_views == o.page_views &&
      preferred_languages == o.preferred_languages &&
      referrer_domains == o.referrer_domains &&
      time_on_site_max == o.time_on_site_max &&
      time_on_site_min == o.time_on_site_min &&
      urls == o.urls &&
      user_agent_device_names == o.user_agent_device_names &&
      user_agent_device_os_names == o.user_agent_device_os_names &&
      user_agent_device_os_versions == o.user_agent_device_os_versions &&
      user_agent_names == o.user_agent_names &&
      user_agent_originals == o.user_agent_originals &&
      utm_campaigns == o.utm_campaigns &&
      utm_sources == o.utm_sources
end
_deserialize(type, value) click to toggle source

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/screen_recording_filter_values.rb, line 319
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
_to_hash(value) click to toggle source

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/screen_recording_filter_values.rb, line 385
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
build_from_hash(attributes) click to toggle source

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/screen_recording_filter_values.rb, line 298
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
eql?(o) click to toggle source

@see the `==` method @param [Object] Object to be compared

# File lib/ultracart_api/models/screen_recording_filter_values.rb, line 285
def eql?(o)
  self == o
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Fixnum] Hash code

# File lib/ultracart_api/models/screen_recording_filter_values.rb, line 291
def hash
  [communications_campaign_names, communications_email_subjects, communications_flow_names, email_domains, geolocation_countries, geolocation_states, language_iso_codes, max_values, page_views, preferred_languages, referrer_domains, time_on_site_max, time_on_site_min, urls, user_agent_device_names, user_agent_device_os_names, user_agent_device_os_versions, user_agent_names, user_agent_originals, utm_campaigns, utm_sources].hash
end
list_invalid_properties() click to toggle source

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons

# File lib/ultracart_api/models/screen_recording_filter_values.rb, line 244
def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end
to_body() click to toggle source

to_body is an alias to to_hash (backward compatibility) @return [Hash] Returns the object in the form of hash

# File lib/ultracart_api/models/screen_recording_filter_values.rb, line 365
def to_body
  to_hash
end
to_hash() click to toggle source

Returns the object in the form of hash @return [Hash] Returns the object in the form of hash

# File lib/ultracart_api/models/screen_recording_filter_values.rb, line 371
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
to_s() click to toggle source

Returns the string representation of the object @return [String] String presentation of the object

# File lib/ultracart_api/models/screen_recording_filter_values.rb, line 359
def to_s
  to_hash.to_s
end
valid?() click to toggle source

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/screen_recording_filter_values.rb, line 251
def valid?
  true
end