mencoro 1.0.0

data/lib/mencoro/models/get_organization_overview200_response.rb

@@ -0,0 +1,158 @@
+=begin
+#Mencoro API
+
+#Public API for Mencoro customers. Authenticate with an API key: `Authorization: Bearer mencoro_sk_...`.
+
+The version of the OpenAPI document: 1.0.0
+Contact: support@mencoro.com
+Generated by: https://openapi-generator.tech
+Generator version: 7.24.0
+
+=end
+
+require 'date'
+require 'time'
+
+module Mencoro
+  class GetOrganizationOverview200Response < ApiModelBase
+    attr_accessor :projects
+
+    attr_accessor :aggregate
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'projects' => :'projects',
+        :'aggregate' => :'aggregate'
+      }
+    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
+      {
+        :'projects' => :'Array<GetOrganizationOverview200ResponseProjectsInner>',
+        :'aggregate' => :'GetOrganizationOverview200ResponseAggregate'
+      }
+    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 `Mencoro::GetOrganizationOverview200Response` 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 `Mencoro::GetOrganizationOverview200Response`. 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?(:'projects')
+        if (value = attributes[:'projects']).is_a?(Array)
+          self.projects = value
+        end
+      end
+
+      if attributes.key?(:'aggregate')
+        self.aggregate = attributes[:'aggregate']
+      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
+      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'
+      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 &&
+          projects == o.projects &&
+          aggregate == o.aggregate
+    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
+      [projects, aggregate].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

data/lib/mencoro/models/get_organization_overview200_response_aggregate.rb

@@ -0,0 +1,209 @@
+=begin
+#Mencoro API
+
+#Public API for Mencoro customers. Authenticate with an API key: `Authorization: Bearer mencoro_sk_...`.
+
+The version of the OpenAPI document: 1.0.0
+Contact: support@mencoro.com
+Generated by: https://openapi-generator.tech
+Generator version: 7.24.0
+
+=end
+
+require 'date'
+require 'time'
+
+module Mencoro
+  class GetOrganizationOverview200ResponseAggregate < ApiModelBase
+    # Active projects in the organization, the length of `projects`.
+    attr_accessor :project_count
+
+    # How many of those have a share of voice; the averages below are means over the projects that report each metric, never over the ones still null.
+    attr_accessor :projects_with_data
+
+    attr_accessor :total_tracked_queries
+
+    # Null when no project reports a share of voice.
+    attr_accessor :avg_share_of_voice
+
+    attr_accessor :avg_mention_rate
+
+    # 1-based rank; LOWER is better.
+    attr_accessor :avg_mention_position
+
+    attr_accessor :avg_positivity_index
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'project_count' => :'projectCount',
+        :'projects_with_data' => :'projectsWithData',
+        :'total_tracked_queries' => :'totalTrackedQueries',
+        :'avg_share_of_voice' => :'avgShareOfVoice',
+        :'avg_mention_rate' => :'avgMentionRate',
+        :'avg_mention_position' => :'avgMentionPosition',
+        :'avg_positivity_index' => :'avgPositivityIndex'
+      }
+    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
+      {
+        :'project_count' => :'Integer',
+        :'projects_with_data' => :'Integer',
+        :'total_tracked_queries' => :'Integer',
+        :'avg_share_of_voice' => :'Float',
+        :'avg_mention_rate' => :'Integer',
+        :'avg_mention_position' => :'Float',
+        :'avg_positivity_index' => :'Integer'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'avg_share_of_voice',
+        :'avg_mention_rate',
+        :'avg_mention_position',
+        :'avg_positivity_index'
+      ])
+    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 `Mencoro::GetOrganizationOverview200ResponseAggregate` 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 `Mencoro::GetOrganizationOverview200ResponseAggregate`. 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?(:'project_count')
+        self.project_count = attributes[:'project_count']
+      end
+
+      if attributes.key?(:'projects_with_data')
+        self.projects_with_data = attributes[:'projects_with_data']
+      end
+
+      if attributes.key?(:'total_tracked_queries')
+        self.total_tracked_queries = attributes[:'total_tracked_queries']
+      end
+
+      if attributes.key?(:'avg_share_of_voice')
+        self.avg_share_of_voice = attributes[:'avg_share_of_voice']
+      end
+
+      if attributes.key?(:'avg_mention_rate')
+        self.avg_mention_rate = attributes[:'avg_mention_rate']
+      end
+
+      if attributes.key?(:'avg_mention_position')
+        self.avg_mention_position = attributes[:'avg_mention_position']
+      end
+
+      if attributes.key?(:'avg_positivity_index')
+        self.avg_positivity_index = attributes[:'avg_positivity_index']
+      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
+      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'
+      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 &&
+          project_count == o.project_count &&
+          projects_with_data == o.projects_with_data &&
+          total_tracked_queries == o.total_tracked_queries &&
+          avg_share_of_voice == o.avg_share_of_voice &&
+          avg_mention_rate == o.avg_mention_rate &&
+          avg_mention_position == o.avg_mention_position &&
+          avg_positivity_index == o.avg_positivity_index
+    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
+      [project_count, projects_with_data, total_tracked_queries, avg_share_of_voice, avg_mention_rate, avg_mention_position, avg_positivity_index].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

data/lib/mencoro/models/get_organization_overview200_response_projects_inner.rb

@@ -0,0 +1,218 @@
+=begin
+#Mencoro API
+
+#Public API for Mencoro customers. Authenticate with an API key: `Authorization: Bearer mencoro_sk_...`.
+
+The version of the OpenAPI document: 1.0.0
+Contact: support@mencoro.com
+Generated by: https://openapi-generator.tech
+Generator version: 7.24.0
+
+=end
+
+require 'date'
+require 'time'
+
+module Mencoro
+  class GetOrganizationOverview200ResponseProjectsInner < ApiModelBase
+    attr_accessor :project_id
+
+    attr_accessor :name
+
+    attr_accessor :status
+
+    attr_accessor :tracked_query_count
+
+    # 0-100 percentage share of weighted AI mentions against all tracked brands; higher is better. Null when the project has no rank data yet.
+    attr_accessor :share_of_voice
+
+    # 0-100 percentage of tracked queries with a result; higher is better. Null when the project has no rank data yet.
+    attr_accessor :mention_rate
+
+    # 1-based average rank of the brand within the answer; LOWER is better. Null when the project has no rank data yet.
+    attr_accessor :avg_mention_position
+
+    # 0-100 sentiment score; higher is better. Null when the project has no rank data yet.
+    attr_accessor :positivity_index
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'project_id' => :'projectId',
+        :'name' => :'name',
+        :'status' => :'status',
+        :'tracked_query_count' => :'trackedQueryCount',
+        :'share_of_voice' => :'shareOfVoice',
+        :'mention_rate' => :'mentionRate',
+        :'avg_mention_position' => :'avgMentionPosition',
+        :'positivity_index' => :'positivityIndex'
+      }
+    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
+      {
+        :'project_id' => :'String',
+        :'name' => :'String',
+        :'status' => :'String',
+        :'tracked_query_count' => :'Integer',
+        :'share_of_voice' => :'Float',
+        :'mention_rate' => :'Integer',
+        :'avg_mention_position' => :'Float',
+        :'positivity_index' => :'Integer'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'share_of_voice',
+        :'mention_rate',
+        :'avg_mention_position',
+        :'positivity_index'
+      ])
+    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 `Mencoro::GetOrganizationOverview200ResponseProjectsInner` 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 `Mencoro::GetOrganizationOverview200ResponseProjectsInner`. 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?(:'project_id')
+        self.project_id = attributes[:'project_id']
+      end
+
+      if attributes.key?(:'name')
+        self.name = attributes[:'name']
+      end
+
+      if attributes.key?(:'status')
+        self.status = attributes[:'status']
+      end
+
+      if attributes.key?(:'tracked_query_count')
+        self.tracked_query_count = attributes[:'tracked_query_count']
+      end
+
+      if attributes.key?(:'share_of_voice')
+        self.share_of_voice = attributes[:'share_of_voice']
+      end
+
+      if attributes.key?(:'mention_rate')
+        self.mention_rate = attributes[:'mention_rate']
+      end
+
+      if attributes.key?(:'avg_mention_position')
+        self.avg_mention_position = attributes[:'avg_mention_position']
+      end
+
+      if attributes.key?(:'positivity_index')
+        self.positivity_index = attributes[:'positivity_index']
+      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
+      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'
+      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 &&
+          project_id == o.project_id &&
+          name == o.name &&
+          status == o.status &&
+          tracked_query_count == o.tracked_query_count &&
+          share_of_voice == o.share_of_voice &&
+          mention_rate == o.mention_rate &&
+          avg_mention_position == o.avg_mention_position &&
+          positivity_index == o.positivity_index
+    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
+      [project_id, name, status, tracked_query_count, share_of_voice, mention_rate, avg_mention_position, positivity_index].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