class UltracartClient::ScreenRecording

Attributes

ad_platform[RW]
analytics_client_oid[RW]
analytics_session_dts[RW]
analytics_session_oid[RW]
communications_campaign_name[RW]

Campaign Name

communications_campaign_uuid[RW]

Campaign UUID

communications_email_subject[RW]

Email subject

communications_email_uuid[RW]

Email UUID

communications_flow_name[RW]

Flow Name

communications_flow_uuid[RW]

Flow UUID

email[RW]
email_domain[RW]
end_timestamp[RW]

Ending timestamp

esp_customer_uuid[RW]
events_gz_size[RW]
events_json_key[RW]
favorite[RW]

True if the user calling the API has favorited this particular screen recording.

favorites[RW]

Array of user ids that favorited this particular screen recording.

geolocation[RW]
geolocation_country[RW]
geolocation_state[RW]
language_iso_code[RW]

Language ISO code

merchant_id[RW]
merchant_notes[RW]
missing_external_tracking[RW]

True if external page view was not tracked

order_id[RW]
page_view_count[RW]
page_views[RW]
preferred_language[RW]

ISO 3 Letter language code that the customer would prefer

referrer_domain[RW]
rrweb_version[RW]
screen_recording_uuid[RW]
signed_download_url[RW]
start_timestamp[RW]

Starting timestamp

storefront_oids[RW]
storefronts[RW]
tags[RW]
time_on_site[RW]
ucacid[RW]
user_agent[RW]
user_agent_raw[RW]
user_ip[RW]
user_properties[RW]
utm_campaign[RW]

UTM Campaign

utm_source[RW]

UTM Source

visitor_first_seen[RW]

Timestamp this visitor was first seen

visitor_number[RW]
watched[RW]
window_height[RW]
window_width[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.rb, line 134
def self.attribute_map
  {
    :'ad_platform' => :'ad_platform',
    :'analytics_client_oid' => :'analytics_client_oid',
    :'analytics_session_dts' => :'analytics_session_dts',
    :'analytics_session_oid' => :'analytics_session_oid',
    :'communications_campaign_name' => :'communications_campaign_name',
    :'communications_campaign_uuid' => :'communications_campaign_uuid',
    :'communications_email_subject' => :'communications_email_subject',
    :'communications_email_uuid' => :'communications_email_uuid',
    :'communications_flow_name' => :'communications_flow_name',
    :'communications_flow_uuid' => :'communications_flow_uuid',
    :'email' => :'email',
    :'email_domain' => :'email_domain',
    :'end_timestamp' => :'end_timestamp',
    :'esp_customer_uuid' => :'esp_customer_uuid',
    :'events_gz_size' => :'events_gz_size',
    :'events_json_key' => :'events_json_key',
    :'favorite' => :'favorite',
    :'favorites' => :'favorites',
    :'geolocation' => :'geolocation',
    :'geolocation_country' => :'geolocation_country',
    :'geolocation_state' => :'geolocation_state',
    :'language_iso_code' => :'language_iso_code',
    :'merchant_id' => :'merchant_id',
    :'merchant_notes' => :'merchant_notes',
    :'missing_external_tracking' => :'missing_external_tracking',
    :'order_id' => :'order_id',
    :'page_view_count' => :'page_view_count',
    :'page_views' => :'page_views',
    :'preferred_language' => :'preferred_language',
    :'referrer_domain' => :'referrer_domain',
    :'rrweb_version' => :'rrweb_version',
    :'screen_recording_uuid' => :'screen_recording_uuid',
    :'signed_download_url' => :'signed_download_url',
    :'start_timestamp' => :'start_timestamp',
    :'storefront_oids' => :'storefront_oids',
    :'storefronts' => :'storefronts',
    :'tags' => :'tags',
    :'time_on_site' => :'time_on_site',
    :'ucacid' => :'ucacid',
    :'user_agent' => :'user_agent',
    :'user_agent_raw' => :'user_agent_raw',
    :'user_ip' => :'user_ip',
    :'user_properties' => :'user_properties',
    :'utm_campaign' => :'utm_campaign',
    :'utm_source' => :'utm_source',
    :'visitor_first_seen' => :'visitor_first_seen',
    :'visitor_number' => :'visitor_number',
    :'watched' => :'watched',
    :'window_height' => :'window_height',
    :'window_width' => :'window_width'
  }
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.rb, line 247
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?(:'ad_platform')
    self.ad_platform = attributes[:'ad_platform']
  end

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  if attributes.has_key?(:'page_view_count')
    self.page_view_count = attributes[:'page_view_count']
  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_language')
    self.preferred_language = attributes[:'preferred_language']
  end

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  if attributes.has_key?(:'window_width')
    self.window_width = attributes[:'window_width']
  end
end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/ultracart_api/models/screen_recording.rb, line 190
def self.swagger_types
  {
    :'ad_platform' => :'ScreenRecordingAdPlatform',
    :'analytics_client_oid' => :'Integer',
    :'analytics_session_dts' => :'Integer',
    :'analytics_session_oid' => :'Integer',
    :'communications_campaign_name' => :'String',
    :'communications_campaign_uuid' => :'String',
    :'communications_email_subject' => :'String',
    :'communications_email_uuid' => :'String',
    :'communications_flow_name' => :'String',
    :'communications_flow_uuid' => :'String',
    :'email' => :'String',
    :'email_domain' => :'String',
    :'end_timestamp' => :'String',
    :'esp_customer_uuid' => :'String',
    :'events_gz_size' => :'Integer',
    :'events_json_key' => :'String',
    :'favorite' => :'BOOLEAN',
    :'favorites' => :'Array<Integer>',
    :'geolocation' => :'GeoPoint',
    :'geolocation_country' => :'String',
    :'geolocation_state' => :'String',
    :'language_iso_code' => :'String',
    :'merchant_id' => :'String',
    :'merchant_notes' => :'String',
    :'missing_external_tracking' => :'BOOLEAN',
    :'order_id' => :'String',
    :'page_view_count' => :'Integer',
    :'page_views' => :'Array<ScreenRecordingPageView>',
    :'preferred_language' => :'String',
    :'referrer_domain' => :'String',
    :'rrweb_version' => :'String',
    :'screen_recording_uuid' => :'String',
    :'signed_download_url' => :'String',
    :'start_timestamp' => :'String',
    :'storefront_oids' => :'Array<Integer>',
    :'storefronts' => :'Array<ScreenRecordingStoreFront>',
    :'tags' => :'Array<String>',
    :'time_on_site' => :'Integer',
    :'ucacid' => :'String',
    :'user_agent' => :'ScreenRecordingUserAgent',
    :'user_agent_raw' => :'String',
    :'user_ip' => :'String',
    :'user_properties' => :'Array<ScreenRecordingUserProperty>',
    :'utm_campaign' => :'String',
    :'utm_source' => :'String',
    :'visitor_first_seen' => :'String',
    :'visitor_number' => :'Integer',
    :'watched' => :'BOOLEAN',
    :'window_height' => :'Integer',
    :'window_width' => :'Integer'
  }
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.rb, line 481
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      ad_platform == o.ad_platform &&
      analytics_client_oid == o.analytics_client_oid &&
      analytics_session_dts == o.analytics_session_dts &&
      analytics_session_oid == o.analytics_session_oid &&
      communications_campaign_name == o.communications_campaign_name &&
      communications_campaign_uuid == o.communications_campaign_uuid &&
      communications_email_subject == o.communications_email_subject &&
      communications_email_uuid == o.communications_email_uuid &&
      communications_flow_name == o.communications_flow_name &&
      communications_flow_uuid == o.communications_flow_uuid &&
      email == o.email &&
      email_domain == o.email_domain &&
      end_timestamp == o.end_timestamp &&
      esp_customer_uuid == o.esp_customer_uuid &&
      events_gz_size == o.events_gz_size &&
      events_json_key == o.events_json_key &&
      favorite == o.favorite &&
      favorites == o.favorites &&
      geolocation == o.geolocation &&
      geolocation_country == o.geolocation_country &&
      geolocation_state == o.geolocation_state &&
      language_iso_code == o.language_iso_code &&
      merchant_id == o.merchant_id &&
      merchant_notes == o.merchant_notes &&
      missing_external_tracking == o.missing_external_tracking &&
      order_id == o.order_id &&
      page_view_count == o.page_view_count &&
      page_views == o.page_views &&
      preferred_language == o.preferred_language &&
      referrer_domain == o.referrer_domain &&
      rrweb_version == o.rrweb_version &&
      screen_recording_uuid == o.screen_recording_uuid &&
      signed_download_url == o.signed_download_url &&
      start_timestamp == o.start_timestamp &&
      storefront_oids == o.storefront_oids &&
      storefronts == o.storefronts &&
      tags == o.tags &&
      time_on_site == o.time_on_site &&
      ucacid == o.ucacid &&
      user_agent == o.user_agent &&
      user_agent_raw == o.user_agent_raw &&
      user_ip == o.user_ip &&
      user_properties == o.user_properties &&
      utm_campaign == o.utm_campaign &&
      utm_source == o.utm_source &&
      visitor_first_seen == o.visitor_first_seen &&
      visitor_number == o.visitor_number &&
      watched == o.watched &&
      window_height == o.window_height &&
      window_width == o.window_width
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.rb, line 572
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.rb, line 638
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.rb, line 551
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.rb, line 538
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.rb, line 544
def hash
  [ad_platform, analytics_client_oid, analytics_session_dts, analytics_session_oid, communications_campaign_name, communications_campaign_uuid, communications_email_subject, communications_email_uuid, communications_flow_name, communications_flow_uuid, email, email_domain, end_timestamp, esp_customer_uuid, events_gz_size, events_json_key, favorite, favorites, geolocation, geolocation_country, geolocation_state, language_iso_code, merchant_id, merchant_notes, missing_external_tracking, order_id, page_view_count, page_views, preferred_language, referrer_domain, rrweb_version, screen_recording_uuid, signed_download_url, start_timestamp, storefront_oids, storefronts, tags, time_on_site, ucacid, user_agent, user_agent_raw, user_ip, user_properties, utm_campaign, utm_source, visitor_first_seen, visitor_number, watched, window_height, window_width].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.rb, line 468
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.rb, line 618
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.rb, line 624
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.rb, line 612
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.rb, line 475
def valid?
  true
end