api-sdk-rb 1.11.66

data/lib/api-sdk-rb/models/partner_analytics_of_widget.rb

@@ -0,0 +1,300 @@
+=begin
+#Widgetic API Gateway
+
+#API documentation for the Widgetic API Gateway
+
+The version of the OpenAPI document: 1.0.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.9.0
+
+=end
+
+require 'date'
+require 'time'
+
+module ApiSdkRb
+  # What one widget's compositions did in a period.
+  class PartnerAnalyticsOfWidget
+    attr_accessor :widget_id
+
+    # Null when the widget has been deleted since
+    attr_accessor :widget_name
+
+    attr_accessor :views
+
+    attr_accessor :interactions
+
+    attr_accessor :visitors
+
+    # How many different compositions of the widget were viewed
+    attr_accessor :compositions_viewed
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'widget_id' => :'widgetId',
+        :'widget_name' => :'widgetName',
+        :'views' => :'views',
+        :'interactions' => :'interactions',
+        :'visitors' => :'visitors',
+        :'compositions_viewed' => :'compositionsViewed'
+      }
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'widget_id' => :'String',
+        :'widget_name' => :'String',
+        :'views' => :'Integer',
+        :'interactions' => :'Integer',
+        :'visitors' => :'Integer',
+        :'compositions_viewed' => :'Integer'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'widget_name',
+      ])
+    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 `ApiSdkRb::PartnerAnalyticsOfWidget` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!self.class.attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `ApiSdkRb::PartnerAnalyticsOfWidget`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'widget_id')
+        self.widget_id = attributes[:'widget_id']
+      else
+        self.widget_id = nil
+      end
+
+      if attributes.key?(:'widget_name')
+        self.widget_name = attributes[:'widget_name']
+      else
+        self.widget_name = nil
+      end
+
+      if attributes.key?(:'views')
+        self.views = attributes[:'views']
+      else
+        self.views = nil
+      end
+
+      if attributes.key?(:'interactions')
+        self.interactions = attributes[:'interactions']
+      else
+        self.interactions = nil
+      end
+
+      if attributes.key?(:'visitors')
+        self.visitors = attributes[:'visitors']
+      else
+        self.visitors = nil
+      end
+
+      if attributes.key?(:'compositions_viewed')
+        self.compositions_viewed = attributes[:'compositions_viewed']
+      else
+        self.compositions_viewed = 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 @widget_id.nil?
+        invalid_properties.push('invalid value for "widget_id", widget_id cannot be nil.')
+      end
+
+      if @views.nil?
+        invalid_properties.push('invalid value for "views", views cannot be nil.')
+      end
+
+      if @interactions.nil?
+        invalid_properties.push('invalid value for "interactions", interactions cannot be nil.')
+      end
+
+      if @visitors.nil?
+        invalid_properties.push('invalid value for "visitors", visitors cannot be nil.')
+      end
+
+      if @compositions_viewed.nil?
+        invalid_properties.push('invalid value for "compositions_viewed", compositions_viewed 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 @widget_id.nil?
+      return false if @views.nil?
+      return false if @interactions.nil?
+      return false if @visitors.nil?
+      return false if @compositions_viewed.nil?
+      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 &&
+          widget_id == o.widget_id &&
+          widget_name == o.widget_name &&
+          views == o.views &&
+          interactions == o.interactions &&
+          visitors == o.visitors &&
+          compositions_viewed == o.compositions_viewed
+    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
+      [widget_id, widget_name, views, interactions, visitors, compositions_viewed].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
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def self._deserialize(type, value)
+      case type.to_sym
+      when :Time
+        Time.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
+        # models (e.g. Pet) or oneOf
+        klass = ApiSdkRb.const_get(type)
+        klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.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)
+        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
+
+    # 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/api-sdk-rb/models/partner_analytics_summary.rb

@@ -0,0 +1,336 @@
+=begin
+#Widgetic API Gateway
+
+#API documentation for the Widgetic API Gateway
+
+The version of the OpenAPI document: 1.0.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.9.0
+
+=end
+
+require 'date'
+require 'time'
+
+module ApiSdkRb
+  # What was done with the partner's published widgets in a period.
+  class PartnerAnalyticsSummary
+    attr_accessor :partner_id
+
+    attr_accessor :period
+
+    # The managed user the report is narrowed to. Null for the whole account.
+    attr_accessor :managed_user_id
+
+    # How many times a composition was shown to a visitor
+    attr_accessor :views
+
+    # How many times a visitor did something with a composition
+    attr_accessor :interactions
+
+    # How many different visitors viewed. A visitor is a browsing session; an event that carries no session is counted for the signed-in user instead. An event that carries neither is a view and no visitor. 
+    attr_accessor :visitors
+
+    # How many different compositions were viewed
+    attr_accessor :compositions_viewed
+
+    # How many different managed users had a composition viewed
+    attr_accessor :managed_users_viewed
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'partner_id' => :'partnerId',
+        :'period' => :'period',
+        :'managed_user_id' => :'managedUserId',
+        :'views' => :'views',
+        :'interactions' => :'interactions',
+        :'visitors' => :'visitors',
+        :'compositions_viewed' => :'compositionsViewed',
+        :'managed_users_viewed' => :'managedUsersViewed'
+      }
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'partner_id' => :'String',
+        :'period' => :'PartnerReportPeriod',
+        :'managed_user_id' => :'String',
+        :'views' => :'Integer',
+        :'interactions' => :'Integer',
+        :'visitors' => :'Integer',
+        :'compositions_viewed' => :'Integer',
+        :'managed_users_viewed' => :'Integer'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'managed_user_id',
+      ])
+    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 `ApiSdkRb::PartnerAnalyticsSummary` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!self.class.attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `ApiSdkRb::PartnerAnalyticsSummary`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'partner_id')
+        self.partner_id = attributes[:'partner_id']
+      else
+        self.partner_id = nil
+      end
+
+      if attributes.key?(:'period')
+        self.period = attributes[:'period']
+      else
+        self.period = nil
+      end
+
+      if attributes.key?(:'managed_user_id')
+        self.managed_user_id = attributes[:'managed_user_id']
+      else
+        self.managed_user_id = nil
+      end
+
+      if attributes.key?(:'views')
+        self.views = attributes[:'views']
+      else
+        self.views = nil
+      end
+
+      if attributes.key?(:'interactions')
+        self.interactions = attributes[:'interactions']
+      else
+        self.interactions = nil
+      end
+
+      if attributes.key?(:'visitors')
+        self.visitors = attributes[:'visitors']
+      else
+        self.visitors = nil
+      end
+
+      if attributes.key?(:'compositions_viewed')
+        self.compositions_viewed = attributes[:'compositions_viewed']
+      else
+        self.compositions_viewed = nil
+      end
+
+      if attributes.key?(:'managed_users_viewed')
+        self.managed_users_viewed = attributes[:'managed_users_viewed']
+      else
+        self.managed_users_viewed = 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 @partner_id.nil?
+        invalid_properties.push('invalid value for "partner_id", partner_id cannot be nil.')
+      end
+
+      if @period.nil?
+        invalid_properties.push('invalid value for "period", period cannot be nil.')
+      end
+
+      if @views.nil?
+        invalid_properties.push('invalid value for "views", views cannot be nil.')
+      end
+
+      if @interactions.nil?
+        invalid_properties.push('invalid value for "interactions", interactions cannot be nil.')
+      end
+
+      if @visitors.nil?
+        invalid_properties.push('invalid value for "visitors", visitors cannot be nil.')
+      end
+
+      if @compositions_viewed.nil?
+        invalid_properties.push('invalid value for "compositions_viewed", compositions_viewed cannot be nil.')
+      end
+
+      if @managed_users_viewed.nil?
+        invalid_properties.push('invalid value for "managed_users_viewed", managed_users_viewed 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 @partner_id.nil?
+      return false if @period.nil?
+      return false if @views.nil?
+      return false if @interactions.nil?
+      return false if @visitors.nil?
+      return false if @compositions_viewed.nil?
+      return false if @managed_users_viewed.nil?
+      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 &&
+          partner_id == o.partner_id &&
+          period == o.period &&
+          managed_user_id == o.managed_user_id &&
+          views == o.views &&
+          interactions == o.interactions &&
+          visitors == o.visitors &&
+          compositions_viewed == o.compositions_viewed &&
+          managed_users_viewed == o.managed_users_viewed
+    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
+      [partner_id, period, managed_user_id, views, interactions, visitors, compositions_viewed, managed_users_viewed].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
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def self._deserialize(type, value)
+      case type.to_sym
+      when :Time
+        Time.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
+        # models (e.g. Pet) or oneOf
+        klass = ApiSdkRb.const_get(type)
+        klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.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)
+        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
+
+    # 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