zernio-sdk 0.0.821 → 0.0.823

data/lib/zernio-sdk/models/analytics_delta_entry_metrics.rb

@@ -0,0 +1,507 @@
+=begin
+#Zernio API
+
+#API reference for Zernio. Authenticate with a Bearer API key. Base URL: https://zernio.com/api  Versioning and deprecation: all endpoints are versioned in the URL path (current version: /v1). Breaking changes only ship in a new path version; existing versions keep working. Deprecated operations are marked 'deprecated: true' in this spec and announced in the changelog (https://zernio.com/changelog) before removal.  Errors: every 4xx/5xx response is application/json with a machine-readable 'code' and a human-readable 'error' message (see the ErrorResponse schema). 
+
+The version of the OpenAPI document: 1.0.4
+Contact: support@zernio.com
+Generated by: https://openapi-generator.tech
+Generator version: 7.19.0
+
+=end
+
+require 'date'
+require 'time'
+
+module Zernio
+  # Metrics a platform does not report are 0, not absent.
+  class AnalyticsDeltaEntryMetrics < ApiModelBase
+    attr_accessor :impressions
+
+    attr_accessor :reach
+
+    attr_accessor :likes
+
+    attr_accessor :comments
+
+    attr_accessor :shares
+
+    attr_accessor :saves
+
+    attr_accessor :sends
+
+    attr_accessor :clicks
+
+    attr_accessor :views
+
+    # Follows attributed to this post (Instagram)
+    attr_accessor :follows
+
+    # Instagram Reels average watch time, in milliseconds
+    attr_accessor :ig_reels_avg_watch_time
+
+    # Instagram Reels total watch time, in milliseconds
+    attr_accessor :ig_reels_video_view_total_time
+
+    attr_accessor :reposts
+
+    # Instagram Reels skip rate, 0 to 1
+    attr_accessor :reels_skip_rate
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'impressions' => :'impressions',
+        :'reach' => :'reach',
+        :'likes' => :'likes',
+        :'comments' => :'comments',
+        :'shares' => :'shares',
+        :'saves' => :'saves',
+        :'sends' => :'sends',
+        :'clicks' => :'clicks',
+        :'views' => :'views',
+        :'follows' => :'follows',
+        :'ig_reels_avg_watch_time' => :'igReelsAvgWatchTime',
+        :'ig_reels_video_view_total_time' => :'igReelsVideoViewTotalTime',
+        :'reposts' => :'reposts',
+        :'reels_skip_rate' => :'reelsSkipRate'
+      }
+    end
+
+    # Returns attribute mapping this model knows about
+    def self.acceptable_attribute_map
+      attribute_map
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      acceptable_attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'impressions' => :'Integer',
+        :'reach' => :'Integer',
+        :'likes' => :'Integer',
+        :'comments' => :'Integer',
+        :'shares' => :'Integer',
+        :'saves' => :'Integer',
+        :'sends' => :'Integer',
+        :'clicks' => :'Integer',
+        :'views' => :'Integer',
+        :'follows' => :'Integer',
+        :'ig_reels_avg_watch_time' => :'Integer',
+        :'ig_reels_video_view_total_time' => :'Integer',
+        :'reposts' => :'Integer',
+        :'reels_skip_rate' => :'Float'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `Zernio::AnalyticsDeltaEntryMetrics` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      acceptable_attribute_map = self.class.acceptable_attribute_map
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!acceptable_attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `Zernio::AnalyticsDeltaEntryMetrics`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'impressions')
+        self.impressions = attributes[:'impressions']
+      else
+        self.impressions = nil
+      end
+
+      if attributes.key?(:'reach')
+        self.reach = attributes[:'reach']
+      else
+        self.reach = nil
+      end
+
+      if attributes.key?(:'likes')
+        self.likes = attributes[:'likes']
+      else
+        self.likes = nil
+      end
+
+      if attributes.key?(:'comments')
+        self.comments = attributes[:'comments']
+      else
+        self.comments = nil
+      end
+
+      if attributes.key?(:'shares')
+        self.shares = attributes[:'shares']
+      else
+        self.shares = nil
+      end
+
+      if attributes.key?(:'saves')
+        self.saves = attributes[:'saves']
+      else
+        self.saves = nil
+      end
+
+      if attributes.key?(:'sends')
+        self.sends = attributes[:'sends']
+      else
+        self.sends = nil
+      end
+
+      if attributes.key?(:'clicks')
+        self.clicks = attributes[:'clicks']
+      else
+        self.clicks = nil
+      end
+
+      if attributes.key?(:'views')
+        self.views = attributes[:'views']
+      else
+        self.views = nil
+      end
+
+      if attributes.key?(:'follows')
+        self.follows = attributes[:'follows']
+      else
+        self.follows = nil
+      end
+
+      if attributes.key?(:'ig_reels_avg_watch_time')
+        self.ig_reels_avg_watch_time = attributes[:'ig_reels_avg_watch_time']
+      else
+        self.ig_reels_avg_watch_time = nil
+      end
+
+      if attributes.key?(:'ig_reels_video_view_total_time')
+        self.ig_reels_video_view_total_time = attributes[:'ig_reels_video_view_total_time']
+      else
+        self.ig_reels_video_view_total_time = nil
+      end
+
+      if attributes.key?(:'reposts')
+        self.reposts = attributes[:'reposts']
+      else
+        self.reposts = nil
+      end
+
+      if attributes.key?(:'reels_skip_rate')
+        self.reels_skip_rate = attributes[:'reels_skip_rate']
+      else
+        self.reels_skip_rate = nil
+      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
+      warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
+      invalid_properties = Array.new
+      if @impressions.nil?
+        invalid_properties.push('invalid value for "impressions", impressions cannot be nil.')
+      end
+
+      if @reach.nil?
+        invalid_properties.push('invalid value for "reach", reach cannot be nil.')
+      end
+
+      if @likes.nil?
+        invalid_properties.push('invalid value for "likes", likes cannot be nil.')
+      end
+
+      if @comments.nil?
+        invalid_properties.push('invalid value for "comments", comments cannot be nil.')
+      end
+
+      if @shares.nil?
+        invalid_properties.push('invalid value for "shares", shares cannot be nil.')
+      end
+
+      if @saves.nil?
+        invalid_properties.push('invalid value for "saves", saves cannot be nil.')
+      end
+
+      if @sends.nil?
+        invalid_properties.push('invalid value for "sends", sends cannot be nil.')
+      end
+
+      if @clicks.nil?
+        invalid_properties.push('invalid value for "clicks", clicks cannot be nil.')
+      end
+
+      if @views.nil?
+        invalid_properties.push('invalid value for "views", views cannot be nil.')
+      end
+
+      if @follows.nil?
+        invalid_properties.push('invalid value for "follows", follows cannot be nil.')
+      end
+
+      if @ig_reels_avg_watch_time.nil?
+        invalid_properties.push('invalid value for "ig_reels_avg_watch_time", ig_reels_avg_watch_time cannot be nil.')
+      end
+
+      if @ig_reels_video_view_total_time.nil?
+        invalid_properties.push('invalid value for "ig_reels_video_view_total_time", ig_reels_video_view_total_time cannot be nil.')
+      end
+
+      if @reposts.nil?
+        invalid_properties.push('invalid value for "reposts", reposts cannot be nil.')
+      end
+
+      if @reels_skip_rate.nil?
+        invalid_properties.push('invalid value for "reels_skip_rate", reels_skip_rate cannot be nil.')
+      end
+
+      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?
+      warn '[DEPRECATED] the `valid?` method is obsolete'
+      return false if @impressions.nil?
+      return false if @reach.nil?
+      return false if @likes.nil?
+      return false if @comments.nil?
+      return false if @shares.nil?
+      return false if @saves.nil?
+      return false if @sends.nil?
+      return false if @clicks.nil?
+      return false if @views.nil?
+      return false if @follows.nil?
+      return false if @ig_reels_avg_watch_time.nil?
+      return false if @ig_reels_video_view_total_time.nil?
+      return false if @reposts.nil?
+      return false if @reels_skip_rate.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] impressions Value to be assigned
+    def impressions=(impressions)
+      if impressions.nil?
+        fail ArgumentError, 'impressions cannot be nil'
+      end
+
+      @impressions = impressions
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] reach Value to be assigned
+    def reach=(reach)
+      if reach.nil?
+        fail ArgumentError, 'reach cannot be nil'
+      end
+
+      @reach = reach
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] likes Value to be assigned
+    def likes=(likes)
+      if likes.nil?
+        fail ArgumentError, 'likes cannot be nil'
+      end
+
+      @likes = likes
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] comments Value to be assigned
+    def comments=(comments)
+      if comments.nil?
+        fail ArgumentError, 'comments cannot be nil'
+      end
+
+      @comments = comments
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] shares Value to be assigned
+    def shares=(shares)
+      if shares.nil?
+        fail ArgumentError, 'shares cannot be nil'
+      end
+
+      @shares = shares
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] saves Value to be assigned
+    def saves=(saves)
+      if saves.nil?
+        fail ArgumentError, 'saves cannot be nil'
+      end
+
+      @saves = saves
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] sends Value to be assigned
+    def sends=(sends)
+      if sends.nil?
+        fail ArgumentError, 'sends cannot be nil'
+      end
+
+      @sends = sends
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] clicks Value to be assigned
+    def clicks=(clicks)
+      if clicks.nil?
+        fail ArgumentError, 'clicks cannot be nil'
+      end
+
+      @clicks = clicks
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] views Value to be assigned
+    def views=(views)
+      if views.nil?
+        fail ArgumentError, 'views cannot be nil'
+      end
+
+      @views = views
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] follows Value to be assigned
+    def follows=(follows)
+      if follows.nil?
+        fail ArgumentError, 'follows cannot be nil'
+      end
+
+      @follows = follows
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] ig_reels_avg_watch_time Value to be assigned
+    def ig_reels_avg_watch_time=(ig_reels_avg_watch_time)
+      if ig_reels_avg_watch_time.nil?
+        fail ArgumentError, 'ig_reels_avg_watch_time cannot be nil'
+      end
+
+      @ig_reels_avg_watch_time = ig_reels_avg_watch_time
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] ig_reels_video_view_total_time Value to be assigned
+    def ig_reels_video_view_total_time=(ig_reels_video_view_total_time)
+      if ig_reels_video_view_total_time.nil?
+        fail ArgumentError, 'ig_reels_video_view_total_time cannot be nil'
+      end
+
+      @ig_reels_video_view_total_time = ig_reels_video_view_total_time
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] reposts Value to be assigned
+    def reposts=(reposts)
+      if reposts.nil?
+        fail ArgumentError, 'reposts cannot be nil'
+      end
+
+      @reposts = reposts
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] reels_skip_rate Value to be assigned
+    def reels_skip_rate=(reels_skip_rate)
+      if reels_skip_rate.nil?
+        fail ArgumentError, 'reels_skip_rate cannot be nil'
+      end
+
+      @reels_skip_rate = reels_skip_rate
+    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 &&
+          impressions == o.impressions &&
+          reach == o.reach &&
+          likes == o.likes &&
+          comments == o.comments &&
+          shares == o.shares &&
+          saves == o.saves &&
+          sends == o.sends &&
+          clicks == o.clicks &&
+          views == o.views &&
+          follows == o.follows &&
+          ig_reels_avg_watch_time == o.ig_reels_avg_watch_time &&
+          ig_reels_video_view_total_time == o.ig_reels_video_view_total_time &&
+          reposts == o.reposts &&
+          reels_skip_rate == o.reels_skip_rate
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [impressions, reach, likes, comments, shares, saves, sends, clicks, views, follows, ig_reels_avg_watch_time, ig_reels_video_view_total_time, reposts, reels_skip_rate].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      attributes = attributes.transform_keys(&:to_sym)
+      transformed_hash = {}
+      openapi_types.each_pair do |key, type|
+        if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = nil
+        elsif 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[attribute_map[key]].is_a?(Array)
+            transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
+          end
+        elsif !attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
+        end
+      end
+      new(transformed_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)
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+  end
+
+end