mencoro 1.0.0

data/lib/mencoro/models/project_resource.rb

@@ -0,0 +1,422 @@
+=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
+  # A project and its headline metrics
+  class ProjectResource < ApiModelBase
+    attr_accessor :id
+
+    attr_accessor :name
+
+    attr_accessor :status
+
+    attr_accessor :created_at
+
+    # Number of tracked queries in the project
+    attr_accessor :tracked_query_count
+
+    # Average position in traditional search results. Null when unknown.
+    attr_accessor :avg_serp_position
+
+    # Average position in shopping results. Null when unknown.
+    attr_accessor :avg_shopping_position
+
+    # Average position of the brand mention inside AI answers. Null when unknown.
+    attr_accessor :avg_mention_position
+
+    # Average position of a cited link to the brand. Null when unknown.
+    attr_accessor :avg_link_position
+
+    # Share of checks where the brand was mentioned. Null when unknown.
+    attr_accessor :mention_rate
+
+    attr_accessor :serp_rate
+
+    attr_accessor :shopping_rate
+
+    # Sentiment balance of the brand's mentions. Null when unknown.
+    attr_accessor :positivity_index
+
+    # Share of voice against the tracked competitors. Null when unknown.
+    attr_accessor :share_of_voice
+
+    attr_accessor :serp_position_stability
+
+    attr_accessor :shopping_position_stability
+
+    # When a rank was last detected for this project.
+    attr_accessor :last_rank_detected_at
+
+    class EnumAttributeValidator
+      attr_reader :datatype
+      attr_reader :allowable_values
+
+      def initialize(datatype, allowable_values)
+        @allowable_values = allowable_values.map do |value|
+          case datatype.to_s
+          when /Integer/i
+            value.to_i
+          when /Float/i
+            value.to_f
+          else
+            value
+          end
+        end
+      end
+
+      def valid?(value)
+        !value || allowable_values.include?(value)
+      end
+    end
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'id' => :'id',
+        :'name' => :'name',
+        :'status' => :'status',
+        :'created_at' => :'createdAt',
+        :'tracked_query_count' => :'trackedQueryCount',
+        :'avg_serp_position' => :'avgSerpPosition',
+        :'avg_shopping_position' => :'avgShoppingPosition',
+        :'avg_mention_position' => :'avgMentionPosition',
+        :'avg_link_position' => :'avgLinkPosition',
+        :'mention_rate' => :'mentionRate',
+        :'serp_rate' => :'serpRate',
+        :'shopping_rate' => :'shoppingRate',
+        :'positivity_index' => :'positivityIndex',
+        :'share_of_voice' => :'shareOfVoice',
+        :'serp_position_stability' => :'serpPositionStability',
+        :'shopping_position_stability' => :'shoppingPositionStability',
+        :'last_rank_detected_at' => :'lastRankDetectedAt'
+      }
+    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
+      {
+        :'id' => :'String',
+        :'name' => :'String',
+        :'status' => :'String',
+        :'created_at' => :'Time',
+        :'tracked_query_count' => :'Integer',
+        :'avg_serp_position' => :'Float',
+        :'avg_shopping_position' => :'Float',
+        :'avg_mention_position' => :'Float',
+        :'avg_link_position' => :'Float',
+        :'mention_rate' => :'Integer',
+        :'serp_rate' => :'Integer',
+        :'shopping_rate' => :'Integer',
+        :'positivity_index' => :'Integer',
+        :'share_of_voice' => :'Float',
+        :'serp_position_stability' => :'Float',
+        :'shopping_position_stability' => :'Float',
+        :'last_rank_detected_at' => :'Time'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'avg_serp_position',
+        :'avg_shopping_position',
+        :'avg_mention_position',
+        :'avg_link_position',
+        :'mention_rate',
+        :'serp_rate',
+        :'shopping_rate',
+        :'positivity_index',
+        :'share_of_voice',
+        :'serp_position_stability',
+        :'shopping_position_stability',
+        :'last_rank_detected_at'
+      ])
+    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::ProjectResource` 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::ProjectResource`. 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?(:'id')
+        self.id = attributes[:'id']
+      else
+        self.id = nil
+      end
+
+      if attributes.key?(:'name')
+        self.name = attributes[:'name']
+      else
+        self.name = nil
+      end
+
+      if attributes.key?(:'status')
+        self.status = attributes[:'status']
+      else
+        self.status = nil
+      end
+
+      if attributes.key?(:'created_at')
+        self.created_at = attributes[:'created_at']
+      else
+        self.created_at = nil
+      end
+
+      if attributes.key?(:'tracked_query_count')
+        self.tracked_query_count = attributes[:'tracked_query_count']
+      else
+        self.tracked_query_count = nil
+      end
+
+      if attributes.key?(:'avg_serp_position')
+        self.avg_serp_position = attributes[:'avg_serp_position']
+      end
+
+      if attributes.key?(:'avg_shopping_position')
+        self.avg_shopping_position = attributes[:'avg_shopping_position']
+      end
+
+      if attributes.key?(:'avg_mention_position')
+        self.avg_mention_position = attributes[:'avg_mention_position']
+      end
+
+      if attributes.key?(:'avg_link_position')
+        self.avg_link_position = attributes[:'avg_link_position']
+      end
+
+      if attributes.key?(:'mention_rate')
+        self.mention_rate = attributes[:'mention_rate']
+      end
+
+      if attributes.key?(:'serp_rate')
+        self.serp_rate = attributes[:'serp_rate']
+      end
+
+      if attributes.key?(:'shopping_rate')
+        self.shopping_rate = attributes[:'shopping_rate']
+      end
+
+      if attributes.key?(:'positivity_index')
+        self.positivity_index = attributes[:'positivity_index']
+      end
+
+      if attributes.key?(:'share_of_voice')
+        self.share_of_voice = attributes[:'share_of_voice']
+      end
+
+      if attributes.key?(:'serp_position_stability')
+        self.serp_position_stability = attributes[:'serp_position_stability']
+      end
+
+      if attributes.key?(:'shopping_position_stability')
+        self.shopping_position_stability = attributes[:'shopping_position_stability']
+      end
+
+      if attributes.key?(:'last_rank_detected_at')
+        self.last_rank_detected_at = attributes[:'last_rank_detected_at']
+      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 @id.nil?
+        invalid_properties.push('invalid value for "id", id cannot be nil.')
+      end
+
+      if @name.nil?
+        invalid_properties.push('invalid value for "name", name cannot be nil.')
+      end
+
+      if @status.nil?
+        invalid_properties.push('invalid value for "status", status cannot be nil.')
+      end
+
+      if @created_at.nil?
+        invalid_properties.push('invalid value for "created_at", created_at cannot be nil.')
+      end
+
+      if @tracked_query_count.nil?
+        invalid_properties.push('invalid value for "tracked_query_count", tracked_query_count 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 @id.nil?
+      return false if @name.nil?
+      return false if @status.nil?
+      status_validator = EnumAttributeValidator.new('String', ["active", "archived"])
+      return false unless status_validator.valid?(@status)
+      return false if @created_at.nil?
+      return false if @tracked_query_count.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] id Value to be assigned
+    def id=(id)
+      if id.nil?
+        fail ArgumentError, 'id cannot be nil'
+      end
+
+      @id = id
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] name Value to be assigned
+    def name=(name)
+      if name.nil?
+        fail ArgumentError, 'name cannot be nil'
+      end
+
+      @name = name
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] status Object to be assigned
+    def status=(status)
+      validator = EnumAttributeValidator.new('String', ["active", "archived"])
+      unless validator.valid?(status)
+        fail ArgumentError, "invalid value for \"status\", must be one of #{validator.allowable_values}."
+      end
+      @status = status
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] created_at Value to be assigned
+    def created_at=(created_at)
+      if created_at.nil?
+        fail ArgumentError, 'created_at cannot be nil'
+      end
+
+      @created_at = created_at
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] tracked_query_count Value to be assigned
+    def tracked_query_count=(tracked_query_count)
+      if tracked_query_count.nil?
+        fail ArgumentError, 'tracked_query_count cannot be nil'
+      end
+
+      @tracked_query_count = tracked_query_count
+    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 &&
+          id == o.id &&
+          name == o.name &&
+          status == o.status &&
+          created_at == o.created_at &&
+          tracked_query_count == o.tracked_query_count &&
+          avg_serp_position == o.avg_serp_position &&
+          avg_shopping_position == o.avg_shopping_position &&
+          avg_mention_position == o.avg_mention_position &&
+          avg_link_position == o.avg_link_position &&
+          mention_rate == o.mention_rate &&
+          serp_rate == o.serp_rate &&
+          shopping_rate == o.shopping_rate &&
+          positivity_index == o.positivity_index &&
+          share_of_voice == o.share_of_voice &&
+          serp_position_stability == o.serp_position_stability &&
+          shopping_position_stability == o.shopping_position_stability &&
+          last_rank_detected_at == o.last_rank_detected_at
+    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
+      [id, name, status, created_at, tracked_query_count, avg_serp_position, avg_shopping_position, avg_mention_position, avg_link_position, mention_rate, serp_rate, shopping_rate, positivity_index, share_of_voice, serp_position_stability, shopping_position_stability, last_rank_detected_at].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/projected_monthly_checks_resource.rb

@@ -0,0 +1,211 @@
+=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
+  # What an organization's current tracking configuration would consume in a month
+  class ProjectedMonthlyChecksResource < ApiModelBase
+    # Checks a month of the current configuration would consume: for each ACTIVE tracked query, its runs per month (daily 30, weekly 4, monthly 1) multiplied by its nPasses, summed. Never null.
+    attr_accessor :projected_monthly_checks
+
+    # Active tracked queries the projection was summed over, across every project of the organization, archived projects included. Paused queries are excluded from both figures. Never null.
+    attr_accessor :active_tracked_query_count
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'projected_monthly_checks' => :'projectedMonthlyChecks',
+        :'active_tracked_query_count' => :'activeTrackedQueryCount'
+      }
+    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
+      {
+        :'projected_monthly_checks' => :'Integer',
+        :'active_tracked_query_count' => :'Integer'
+      }
+    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::ProjectedMonthlyChecksResource` 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::ProjectedMonthlyChecksResource`. 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?(:'projected_monthly_checks')
+        self.projected_monthly_checks = attributes[:'projected_monthly_checks']
+      else
+        self.projected_monthly_checks = nil
+      end
+
+      if attributes.key?(:'active_tracked_query_count')
+        self.active_tracked_query_count = attributes[:'active_tracked_query_count']
+      else
+        self.active_tracked_query_count = 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 @projected_monthly_checks.nil?
+        invalid_properties.push('invalid value for "projected_monthly_checks", projected_monthly_checks cannot be nil.')
+      end
+
+      if @projected_monthly_checks < 0
+        invalid_properties.push('invalid value for "projected_monthly_checks", must be greater than or equal to 0.')
+      end
+
+      if @active_tracked_query_count.nil?
+        invalid_properties.push('invalid value for "active_tracked_query_count", active_tracked_query_count cannot be nil.')
+      end
+
+      if @active_tracked_query_count < 0
+        invalid_properties.push('invalid value for "active_tracked_query_count", must be greater than or equal to 0.')
+      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 @projected_monthly_checks.nil?
+      return false if @projected_monthly_checks < 0
+      return false if @active_tracked_query_count.nil?
+      return false if @active_tracked_query_count < 0
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] projected_monthly_checks Value to be assigned
+    def projected_monthly_checks=(projected_monthly_checks)
+      if projected_monthly_checks.nil?
+        fail ArgumentError, 'projected_monthly_checks cannot be nil'
+      end
+
+      if projected_monthly_checks < 0
+        fail ArgumentError, 'invalid value for "projected_monthly_checks", must be greater than or equal to 0.'
+      end
+
+      @projected_monthly_checks = projected_monthly_checks
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] active_tracked_query_count Value to be assigned
+    def active_tracked_query_count=(active_tracked_query_count)
+      if active_tracked_query_count.nil?
+        fail ArgumentError, 'active_tracked_query_count cannot be nil'
+      end
+
+      if active_tracked_query_count < 0
+        fail ArgumentError, 'invalid value for "active_tracked_query_count", must be greater than or equal to 0.'
+      end
+
+      @active_tracked_query_count = active_tracked_query_count
+    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 &&
+          projected_monthly_checks == o.projected_monthly_checks &&
+          active_tracked_query_count == o.active_tracked_query_count
+    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
+      [projected_monthly_checks, active_tracked_query_count].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