ultracart_api 3.1.17 → 3.1.41

data/lib/ultracart_api/models/screen_recording_ad_platform.rb

@@ -0,0 +1,235 @@
+=begin
+#UltraCart Rest API V2
+
+#UltraCart REST API Version 2
+
+OpenAPI spec version: 2.0.0
+Contact: support@ultracart.com
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.15-SNAPSHOT
+
+=end
+
+require 'date'
+
+module UltracartClient
+  class ScreenRecordingAdPlatform
+    # Facebook Click Id (Cookie)
+    attr_accessor :fbc
+
+    # Facebook Click Id Parameter (Parameter)
+    attr_accessor :fbclid
+
+    # Facebook Browser Id (Cookie)
+    attr_accessor :fbp
+
+    # Google Analytics CID (Cookie)
+    attr_accessor :gacid
+
+    # Google Adwords Click Id (Parameter)
+    attr_accessor :glcid
+
+    # Bing Click Id (Parameter
+    attr_accessor :msclkid
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'fbc' => :'fbc',
+        :'fbclid' => :'fbclid',
+        :'fbp' => :'fbp',
+        :'gacid' => :'gacid',
+        :'glcid' => :'glcid',
+        :'msclkid' => :'msclkid'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'fbc' => :'String',
+        :'fbclid' => :'String',
+        :'fbp' => :'String',
+        :'gacid' => :'String',
+        :'glcid' => :'String',
+        :'msclkid' => :'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?(:'fbc')
+        self.fbc = attributes[:'fbc']
+      end
+
+      if attributes.has_key?(:'fbclid')
+        self.fbclid = attributes[:'fbclid']
+      end
+
+      if attributes.has_key?(:'fbp')
+        self.fbp = attributes[:'fbp']
+      end
+
+      if attributes.has_key?(:'gacid')
+        self.gacid = attributes[:'gacid']
+      end
+
+      if attributes.has_key?(:'glcid')
+        self.glcid = attributes[:'glcid']
+      end
+
+      if attributes.has_key?(:'msclkid')
+        self.msclkid = attributes[:'msclkid']
+      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
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          fbc == o.fbc &&
+          fbclid == o.fbclid &&
+          fbp == o.fbp &&
+          gacid == o.gacid &&
+          glcid == o.glcid &&
+          msclkid == o.msclkid
+    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
+      [fbc, fbclid, fbp, gacid, glcid, msclkid].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 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
+
+    # 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 = UltracartClient.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

data/lib/ultracart_api/models/screen_recording_filter.rb

@@ -14,8 +14,20 @@ require 'date'
 
 module UltracartClient
   class ScreenRecordingFilter
+    attr_accessor :affiliate_email
+
+    attr_accessor :affiliate_id
+
+    attr_accessor :communications_campaign_name
+
+    attr_accessor :communications_email_subject
+
+    attr_accessor :communications_flow_name
+
     attr_accessor :email
 
+    attr_accessor :email_domain
+
     attr_accessor :email_identified
 
     attr_accessor :end_timestamp
@@ -30,6 +42,10 @@ module UltracartClient
 
     attr_accessor :geolocation_state
 
+    attr_accessor :language_iso_code
+
+    attr_accessor :last_x_days
+
     attr_accessor :max_filter_values
 
     attr_accessor :order_id
@@ -40,6 +56,10 @@ module UltracartClient
 
     attr_accessor :placed_order
 
+    attr_accessor :preferred_language
+
+    attr_accessor :referrer_domain
+
     attr_accessor :screen_recording_uuids
 
     attr_accessor :screen_sizes
@@ -66,6 +86,10 @@ module UltracartClient
 
     attr_accessor :user_ip
 
+    attr_accessor :utm_campaign
+
+    attr_accessor :utm_source
+
     attr_accessor :visitor_number
 
     attr_accessor :watched
@@ -73,7 +97,13 @@ module UltracartClient
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
+        :'affiliate_email' => :'affiliate_email',
+        :'affiliate_id' => :'affiliate_id',
+        :'communications_campaign_name' => :'communications_campaign_name',
+        :'communications_email_subject' => :'communications_email_subject',
+        :'communications_flow_name' => :'communications_flow_name',
         :'email' => :'email',
+        :'email_domain' => :'email_domain',
         :'email_identified' => :'email_identified',
         :'end_timestamp' => :'end_timestamp',
         :'esp_customer_uuid' => :'esp_customer_uuid',
@@ -81,11 +111,15 @@ module UltracartClient
         :'geolocation' => :'geolocation',
         :'geolocation_country' => :'geolocation_country',
         :'geolocation_state' => :'geolocation_state',
+        :'language_iso_code' => :'language_iso_code',
+        :'last_x_days' => :'last_x_days',
         :'max_filter_values' => :'max_filter_values',
         :'order_id' => :'order_id',
         :'page_view_count' => :'page_view_count',
         :'page_views' => :'page_views',
         :'placed_order' => :'placed_order',
+        :'preferred_language' => :'preferred_language',
+        :'referrer_domain' => :'referrer_domain',
         :'screen_recording_uuids' => :'screen_recording_uuids',
         :'screen_sizes' => :'screen_sizes',
         :'skip_filter_values' => :'skip_filter_values',
@@ -99,6 +133,8 @@ module UltracartClient
         :'user_agent_os_name' => :'user_agent_os_name',
         :'user_agent_os_version' => :'user_agent_os_version',
         :'user_ip' => :'user_ip',
+        :'utm_campaign' => :'utm_campaign',
+        :'utm_source' => :'utm_source',
         :'visitor_number' => :'visitor_number',
         :'watched' => :'watched'
       }
@@ -107,7 +143,13 @@ module UltracartClient
     # Attribute type mapping.
     def self.swagger_types
       {
+        :'affiliate_email' => :'String',
+        :'affiliate_id' => :'Integer',
+        :'communications_campaign_name' => :'String',
+        :'communications_email_subject' => :'String',
+        :'communications_flow_name' => :'String',
         :'email' => :'ScreenRecordingFilterStringSearch',
+        :'email_domain' => :'String',
         :'email_identified' => :'BOOLEAN',
         :'end_timestamp' => :'ScreenRecordingFilterRangeDate',
         :'esp_customer_uuid' => :'String',
@@ -115,11 +157,15 @@ module UltracartClient
         :'geolocation' => :'ScreenRecordingFilterGeoDistance',
         :'geolocation_country' => :'ScreenRecordingFilterStringSearch',
         :'geolocation_state' => :'ScreenRecordingFilterStringSearch',
+        :'language_iso_code' => :'ScreenRecordingFilterStringSearch',
+        :'last_x_days' => :'Integer',
         :'max_filter_values' => :'Integer',
         :'order_id' => :'ScreenRecordingFilterStringSearch',
         :'page_view_count' => :'ScreenRecordingFilterRangeInteger',
         :'page_views' => :'Array<ScreenRecordingFilterPageView>',
         :'placed_order' => :'BOOLEAN',
+        :'preferred_language' => :'ScreenRecordingFilterStringSearch',
+        :'referrer_domain' => :'String',
         :'screen_recording_uuids' => :'Array<String>',
         :'screen_sizes' => :'Array<String>',
         :'skip_filter_values' => :'BOOLEAN',
@@ -133,6 +179,8 @@ module UltracartClient
         :'user_agent_os_name' => :'String',
         :'user_agent_os_version' => :'String',
         :'user_ip' => :'ScreenRecordingFilterIpSearch',
+        :'utm_campaign' => :'String',
+        :'utm_source' => :'String',
         :'visitor_number' => :'Integer',
         :'watched' => :'BOOLEAN'
       }
@@ -146,10 +194,34 @@ module UltracartClient
       # 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_email')
+        self.affiliate_email = attributes[:'affiliate_email']
+      end
+
+      if attributes.has_key?(:'affiliate_id')
+        self.affiliate_id = attributes[:'affiliate_id']
+      end
+
+      if attributes.has_key?(:'communications_campaign_name')
+        self.communications_campaign_name = attributes[:'communications_campaign_name']
+      end
+
+      if attributes.has_key?(:'communications_email_subject')
+        self.communications_email_subject = attributes[:'communications_email_subject']
+      end
+
+      if attributes.has_key?(:'communications_flow_name')
+        self.communications_flow_name = attributes[:'communications_flow_name']
+      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?(:'email_identified')
         self.email_identified = attributes[:'email_identified']
       end
@@ -178,6 +250,14 @@ module UltracartClient
         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?(:'last_x_days')
+        self.last_x_days = attributes[:'last_x_days']
+      end
+
       if attributes.has_key?(:'max_filter_values')
         self.max_filter_values = attributes[:'max_filter_values']
       end
@@ -200,6 +280,14 @@ module UltracartClient
         self.placed_order = attributes[:'placed_order']
       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?(:'screen_recording_uuids')
         if (value = attributes[:'screen_recording_uuids']).is_a?(Array)
           self.screen_recording_uuids = value
@@ -258,6 +346,14 @@ module UltracartClient
         self.user_ip = attributes[:'user_ip']
       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_number')
         self.visitor_number = attributes[:'visitor_number']
       end
@@ -285,7 +381,13 @@ module UltracartClient
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
+          affiliate_email == o.affiliate_email &&
+          affiliate_id == o.affiliate_id &&
+          communications_campaign_name == o.communications_campaign_name &&
+          communications_email_subject == o.communications_email_subject &&
+          communications_flow_name == o.communications_flow_name &&
           email == o.email &&
+          email_domain == o.email_domain &&
           email_identified == o.email_identified &&
           end_timestamp == o.end_timestamp &&
           esp_customer_uuid == o.esp_customer_uuid &&
@@ -293,11 +395,15 @@ module UltracartClient
           geolocation == o.geolocation &&
           geolocation_country == o.geolocation_country &&
           geolocation_state == o.geolocation_state &&
+          language_iso_code == o.language_iso_code &&
+          last_x_days == o.last_x_days &&
           max_filter_values == o.max_filter_values &&
           order_id == o.order_id &&
           page_view_count == o.page_view_count &&
           page_views == o.page_views &&
           placed_order == o.placed_order &&
+          preferred_language == o.preferred_language &&
+          referrer_domain == o.referrer_domain &&
           screen_recording_uuids == o.screen_recording_uuids &&
           screen_sizes == o.screen_sizes &&
           skip_filter_values == o.skip_filter_values &&
@@ -311,6 +417,8 @@ module UltracartClient
           user_agent_os_name == o.user_agent_os_name &&
           user_agent_os_version == o.user_agent_os_version &&
           user_ip == o.user_ip &&
+          utm_campaign == o.utm_campaign &&
+          utm_source == o.utm_source &&
           visitor_number == o.visitor_number &&
           watched == o.watched
     end
@@ -324,7 +432,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [email, email_identified, end_timestamp, esp_customer_uuid, favorite, geolocation, geolocation_country, geolocation_state, max_filter_values, order_id, page_view_count, page_views, placed_order, screen_recording_uuids, screen_sizes, skip_filter_values, skip_hits, start_timestamp, tags, time_on_site, user_agent_device_name, user_agent_name, user_agent_original, user_agent_os_name, user_agent_os_version, user_ip, visitor_number, watched].hash
+      [affiliate_email, affiliate_id, communications_campaign_name, communications_email_subject, communications_flow_name, email, email_domain, email_identified, end_timestamp, esp_customer_uuid, favorite, geolocation, geolocation_country, geolocation_state, language_iso_code, last_x_days, max_filter_values, order_id, page_view_count, page_views, placed_order, preferred_language, referrer_domain, screen_recording_uuids, screen_sizes, skip_filter_values, skip_hits, start_timestamp, tags, time_on_site, user_agent_device_name, user_agent_name, user_agent_original, user_agent_os_name, user_agent_os_version, user_ip, utm_campaign, utm_source, visitor_number, watched].hash
     end
 
     # Builds the object from hash