mencoro 1.0.1 → 2.0.1

data/lib/mencoro/models/tracked_query_rank_tracking_time_series.rb

@@ -0,0 +1,176 @@
+=begin
+#Mencoro API
+
+#Public API for Mencoro customers. Authenticate with an API key: `Authorization: Bearer mencoro_sk_...`. Every write operation requires an `Idempotency-Key` header: a retry carrying the same key and body within 30 days is answered from the stored result without running again; after 30 days the key is forgotten and a retry runs as a new operation.
+
+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 TrackedQueryRankTrackingTimeSeries < ApiModelBase
+    attr_accessor :points
+
+    attr_accessor :data_dirty_since
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'points' => :'points',
+        :'data_dirty_since' => :'dataDirtySince'
+      }
+    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
+      {
+        :'points' => :'Array<TimeSeriesPoint>',
+        :'data_dirty_since' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'data_dirty_since'
+      ])
+    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::TrackedQueryRankTrackingTimeSeries` 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::TrackedQueryRankTrackingTimeSeries`. 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?(:'points')
+        if (value = attributes[:'points']).is_a?(Array)
+          self.points = value
+        end
+      else
+        self.points = nil
+      end
+
+      if attributes.key?(:'data_dirty_since')
+        self.data_dirty_since = attributes[:'data_dirty_since']
+      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 @points.nil?
+        invalid_properties.push('invalid value for "points", points 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 @points.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] points Value to be assigned
+    def points=(points)
+      if points.nil?
+        fail ArgumentError, 'points cannot be nil'
+      end
+
+      @points = points
+    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 &&
+          points == o.points &&
+          data_dirty_since == o.data_dirty_since
+    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
+      [points, data_dirty_since].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/tracked_query_resource.rb

@@ -1,7 +1,7 @@
 =begin
 #Mencoro API
 
-#Public API for Mencoro customers. Authenticate with an API key: `Authorization: Bearer mencoro_sk_...`.
+#Public API for Mencoro customers. Authenticate with an API key: `Authorization: Bearer mencoro_sk_...`. Every write operation requires an `Idempotency-Key` header: a retry carrying the same key and body within 30 days is answered from the stored result without running again; after 30 days the key is forgotten and a retry runs as a new operation.
 
 The version of the OpenAPI document: 1.0.0
 Contact: support@mencoro.com
@@ -317,7 +317,7 @@ module Mencoro
       return false if @id.nil?
       return false if @query_text.nil?
       return false if @engine.nil?
-      engine_validator = EnumAttributeValidator.new('String', ["chatgpt", "perplexity", "google_ai_overview", "google_ai_mode", "google_serp", "google_shopping"])
+      engine_validator = EnumAttributeValidator.new('String', ["chatgpt", "claude", "perplexity", "google_ai_overview", "google_ai_mode", "google_serp", "google_shopping"])
       return false unless engine_validator.valid?(@engine)
       return false if @country.nil?
       return false if @status.nil?
@@ -354,7 +354,7 @@ module Mencoro
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] engine Object to be assigned
     def engine=(engine)
-      validator = EnumAttributeValidator.new('String', ["chatgpt", "perplexity", "google_ai_overview", "google_ai_mode", "google_serp", "google_shopping"])
+      validator = EnumAttributeValidator.new('String', ["chatgpt", "claude", "perplexity", "google_ai_overview", "google_ai_mode", "google_serp", "google_shopping"])
       unless validator.valid?(engine)
         fail ArgumentError, "invalid value for \"engine\", must be one of #{validator.allowable_values}."
       end

data/lib/mencoro/models/tracked_query_usage_resource.rb

@@ -1,7 +1,7 @@
 =begin
 #Mencoro API
 
-#Public API for Mencoro customers. Authenticate with an API key: `Authorization: Bearer mencoro_sk_...`.
+#Public API for Mencoro customers. Authenticate with an API key: `Authorization: Bearer mencoro_sk_...`. Every write operation requires an `Idempotency-Key` header: a retry carrying the same key and body within 30 days is answered from the stored result without running again; after 30 days the key is forgotten and a retry runs as a new operation.
 
 The version of the OpenAPI document: 1.0.0
 Contact: support@mencoro.com
@@ -16,7 +16,7 @@ require 'time'
 module Mencoro
   # How many tracked queries an organization has configured
   class TrackedQueryUsageResource < ApiModelBase
-    # Tracked queries across every project of the organization, archived projects included, counting active and paused queries alike. Never null; 0 means none are configured.
+    # Tracked queries across every project of the organization the caller can access, archived projects included, counting active and paused queries alike. Never null; 0 means none are configured.
     attr_accessor :tracked_query_count
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/mencoro/models/update_organization_request.rb

@@ -1,7 +1,7 @@
 =begin
 #Mencoro API
 
-#Public API for Mencoro customers. Authenticate with an API key: `Authorization: Bearer mencoro_sk_...`.
+#Public API for Mencoro customers. Authenticate with an API key: `Authorization: Bearer mencoro_sk_...`. Every write operation requires an `Idempotency-Key` header: a retry carrying the same key and body within 30 days is answered from the stored result without running again; after 30 days the key is forgotten and a retry runs as a new operation.
 
 The version of the OpenAPI document: 1.0.0
 Contact: support@mencoro.com

data/lib/mencoro/models/update_project_brand_profile_request.rb

@@ -1,7 +1,7 @@
 =begin
 #Mencoro API
 
-#Public API for Mencoro customers. Authenticate with an API key: `Authorization: Bearer mencoro_sk_...`.
+#Public API for Mencoro customers. Authenticate with an API key: `Authorization: Bearer mencoro_sk_...`. Every write operation requires an `Idempotency-Key` header: a retry carrying the same key and body within 30 days is answered from the stored result without running again; after 30 days the key is forgotten and a retry runs as a new operation.
 
 The version of the OpenAPI document: 1.0.0
 Contact: support@mencoro.com

data/lib/mencoro/models/update_project_request.rb

@@ -1,7 +1,7 @@
 =begin
 #Mencoro API
 
-#Public API for Mencoro customers. Authenticate with an API key: `Authorization: Bearer mencoro_sk_...`.
+#Public API for Mencoro customers. Authenticate with an API key: `Authorization: Bearer mencoro_sk_...`. Every write operation requires an `Idempotency-Key` header: a retry carrying the same key and body within 30 days is answered from the stored result without running again; after 30 days the key is forgotten and a retry runs as a new operation.
 
 The version of the OpenAPI document: 1.0.0
 Contact: support@mencoro.com

data/lib/mencoro/version.rb

@@ -1,7 +1,7 @@
 =begin
 #Mencoro API
 
-#Public API for Mencoro customers. Authenticate with an API key: `Authorization: Bearer mencoro_sk_...`.
+#Public API for Mencoro customers. Authenticate with an API key: `Authorization: Bearer mencoro_sk_...`. Every write operation requires an `Idempotency-Key` header: a retry carrying the same key and body within 30 days is answered from the stored result without running again; after 30 days the key is forgotten and a retry runs as a new operation.
 
 The version of the OpenAPI document: 1.0.0
 Contact: support@mencoro.com
@@ -11,5 +11,5 @@ Generator version: 7.24.0
 =end
 
 module Mencoro
-  VERSION = '1.0.1'
+  VERSION = '2.0.1'
 end

data/lib/mencoro.rb

@@ -1,7 +1,7 @@
 =begin
 #Mencoro API
 
-#Public API for Mencoro customers. Authenticate with an API key: `Authorization: Bearer mencoro_sk_...`.
+#Public API for Mencoro customers. Authenticate with an API key: `Authorization: Bearer mencoro_sk_...`. Every write operation requires an `Idempotency-Key` header: a retry carrying the same key and body within 30 days is answered from the stored result without running again; after 30 days the key is forgotten and a retry runs as a new operation.
 
 The version of the OpenAPI document: 1.0.0
 Contact: support@mencoro.com
@@ -27,6 +27,7 @@ require 'mencoro/models/apply_clustering_job_outcome_failed_inner'
 require 'mencoro/models/apply_clustering_job_outcome_skipped_clusters_inner'
 require 'mencoro/models/apply_clustering_job_outcome_successful_inner'
 require 'mencoro/models/async_job_resource'
+require 'mencoro/models/async_job_resource_error'
 require 'mencoro/models/batch_change_tracked_query_check_frequency_request_data'
 require 'mencoro/models/batch_change_tracked_query_passes_request_data'
 require 'mencoro/models/batch_create_query_clusters_outcome'
@@ -55,12 +56,19 @@ require 'mencoro/models/change_member_role_request'
 require 'mencoro/models/change_tracked_query_check_frequency_request_data'
 require 'mencoro/models/change_tracked_query_passes_request_data'
 require 'mencoro/models/citation_resource'
+require 'mencoro/models/cited_source_row'
+require 'mencoro/models/cited_sources_response'
+require 'mencoro/models/cluster_breakdown_row'
 require 'mencoro/models/cluster_membership_request_data'
+require 'mencoro/models/competitor_co_occurrence_response'
+require 'mencoro/models/competitor_co_occurrence_row'
 require 'mencoro/models/competitor_resource'
+require 'mencoro/models/competitor_share_of_voice'
 require 'mencoro/models/create_competitor_request'
 require 'mencoro/models/create_invitation200_response'
 require 'mencoro/models/create_invitation201_response'
 require 'mencoro/models/create_invitation_request'
+require 'mencoro/models/create_invitation_request_project_access'
 require 'mencoro/models/create_organization201_response'
 require 'mencoro/models/create_organization_request'
 require 'mencoro/models/create_project_request'
@@ -91,6 +99,8 @@ require 'mencoro/models/get_tracking_coverage200_response'
 require 'mencoro/models/get_tracking_coverage200_response_sample_inner'
 require 'mencoro/models/invitation_resource'
 require 'mencoro/models/keyword_listing_resource'
+require 'mencoro/models/keyword_listing_resource_carried_positions'
+require 'mencoro/models/keyword_listing_resource_carried_positions_serp'
 require 'mencoro/models/keyword_listing_resource_mention_type_counts'
 require 'mencoro/models/list_ai_responses200_response'
 require 'mencoro/models/list_competitors200_response'
@@ -104,20 +114,37 @@ require 'mencoro/models/list_search_snapshots200_response'
 require 'mencoro/models/list_shopping_snapshots200_response'
 require 'mencoro/models/me_resource'
 require 'mencoro/models/member_resource'
+require 'mencoro/models/mention_match_resource'
+require 'mencoro/models/mention_sample_response'
+require 'mencoro/models/mention_type_counts'
 require 'mencoro/models/operation_effect'
 require 'mencoro/models/organization_resource'
+require 'mencoro/models/per_competitor_sentiment'
+require 'mencoro/models/per_engine_sentiment'
+require 'mencoro/models/per_entity_metrics'
+require 'mencoro/models/position_distribution_bucket'
 require 'mencoro/models/preview_organization_operation200_response'
 require 'mencoro/models/preview_organization_operation200_response_organization'
 require 'mencoro/models/preview_organization_operation_request'
 require 'mencoro/models/project_detail_resource'
 require 'mencoro/models/project_detail_resource_competitors_inner'
+require 'mencoro/models/project_mention_mix_response'
+require 'mencoro/models/project_mention_samples_response'
+require 'mencoro/models/project_rank_tracking_cluster_breakdown'
+require 'mencoro/models/project_rank_tracking_stats'
+require 'mencoro/models/project_rank_tracking_time_series'
 require 'mencoro/models/project_resource'
+require 'mencoro/models/project_sentiment_breakdown'
 require 'mencoro/models/projected_monthly_checks_resource'
 require 'mencoro/models/query_cluster_resource'
 require 'mencoro/models/report_ai_response_request'
 require 'mencoro/models/search_result_resource'
 require 'mencoro/models/search_snapshot_resource'
 require 'mencoro/models/search_tracked_queries200_response'
+require 'mencoro/models/search_tracked_query_mention_matches200_response'
+require 'mencoro/models/search_tracked_query_serp_matches200_response'
+require 'mencoro/models/serp_match_resource'
+require 'mencoro/models/set_member_project_access_request'
 require 'mencoro/models/shopping_offer_resource'
 require 'mencoro/models/shopping_snapshot_resource'
 require 'mencoro/models/start_brand_discovery_job_request'
@@ -127,8 +154,12 @@ require 'mencoro/models/start_keyword_discovery_job_request'
 require 'mencoro/models/start_prompt_discovery_job_request'
 require 'mencoro/models/submitted_checks_resource'
 require 'mencoro/models/subscription_resource'
+require 'mencoro/models/time_series_point'
 require 'mencoro/models/tracked_query_count_resource'
 require 'mencoro/models/tracked_query_detail_resource'
+require 'mencoro/models/tracked_query_mover_row'
+require 'mencoro/models/tracked_query_movers_response'
+require 'mencoro/models/tracked_query_rank_tracking_time_series'
 require 'mencoro/models/tracked_query_resource'
 require 'mencoro/models/tracked_query_usage_resource'
 require 'mencoro/models/update_organization_request'

data/mencoro.gemspec

@@ -3,7 +3,7 @@
 =begin
 #Mencoro API
 
-#Public API for Mencoro customers. Authenticate with an API key: `Authorization: Bearer mencoro_sk_...`.
+#Public API for Mencoro customers. Authenticate with an API key: `Authorization: Bearer mencoro_sk_...`. Every write operation requires an `Idempotency-Key` header: a retry carrying the same key and body within 30 days is answered from the stored result without running again; after 30 days the key is forgotten and a retry runs as a new operation.
 
 The version of the OpenAPI document: 1.0.0
 Contact: support@mencoro.com
@@ -23,7 +23,7 @@ Gem::Specification.new do |s|
   s.email       = ["support@mencoro.com"]
   s.homepage    = "https://openapi-generator.tech"
   s.summary     = "Mencoro API Ruby Gem"
-  s.description = "Public API for Mencoro customers. Authenticate with an API key: `Authorization: Bearer mencoro_sk_...`."
+  s.description = "Public API for Mencoro customers. Authenticate with an API key: `Authorization: Bearer mencoro_sk_...`. Every write operation requires an `Idempotency-Key` header: a retry carrying the same key and body within 30 days is answered from the stored result without running again; after 30 days the key is forgotten and a retry runs as a new operation."
   s.license     = "MIT"
   s.required_ruby_version = ">= 2.7"
   s.metadata    = {}

data/spec/models/async_job_resource_error_spec.rb

@@ -0,0 +1,46 @@
+=begin
+#Mencoro API
+
+#Public API for Mencoro customers. Authenticate with an API key: `Authorization: Bearer mencoro_sk_...`. Every write operation requires an `Idempotency-Key` header: a retry carrying the same key and body within 30 days is answered from the stored result without running again; after 30 days the key is forgotten and a retry runs as a new operation.
+
+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 'spec_helper'
+require 'json'
+require 'date'
+
+# Unit tests for Mencoro::AsyncJobResourceError
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe Mencoro::AsyncJobResourceError do
+  #let(:instance) { Mencoro::AsyncJobResourceError.new }
+
+  describe 'test an instance of AsyncJobResourceError' do
+    it 'should create an instance of AsyncJobResourceError' do
+      # uncomment below to test the instance creation
+      #expect(instance).to be_instance_of(Mencoro::AsyncJobResourceError)
+    end
+  end
+
+  describe 'test attribute "code"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+      # validator = Petstore::EnumTest::EnumAttributeValidator.new('String', ["timed_out", "provider_failed", "submission_failed", "internal_error"])
+      # validator.allowable_values.each do |value|
+      #   expect { instance.code = value }.not_to raise_error
+      # end
+    end
+  end
+
+  describe 'test attribute "message"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+end

data/spec/models/cited_source_row_spec.rb

@@ -0,0 +1,78 @@
+=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 'spec_helper'
+require 'json'
+require 'date'
+
+# Unit tests for Mencoro::CitedSourceRow
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe Mencoro::CitedSourceRow do
+  #let(:instance) { Mencoro::CitedSourceRow.new }
+
+  describe 'test an instance of CitedSourceRow' do
+    it 'should create an instance of CitedSourceRow' do
+      # uncomment below to test the instance creation
+      #expect(instance).to be_instance_of(Mencoro::CitedSourceRow)
+    end
+  end
+
+  describe 'test attribute "group_key"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  describe 'test attribute "domain"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  describe 'test attribute "citation_count"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  describe 'test attribute "distinct_query_count"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  describe 'test attribute "distinct_response_count"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  describe 'test attribute "avg_position"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  describe 'test attribute "sample_title"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  describe 'test attribute "sample_url"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+end

data/spec/models/cited_sources_response_spec.rb

@@ -0,0 +1,42 @@
+=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 'spec_helper'
+require 'json'
+require 'date'
+
+# Unit tests for Mencoro::CitedSourcesResponse
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe Mencoro::CitedSourcesResponse do
+  #let(:instance) { Mencoro::CitedSourcesResponse.new }
+
+  describe 'test an instance of CitedSourcesResponse' do
+    it 'should create an instance of CitedSourcesResponse' do
+      # uncomment below to test the instance creation
+      #expect(instance).to be_instance_of(Mencoro::CitedSourcesResponse)
+    end
+  end
+
+  describe 'test attribute "sources"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  describe 'test attribute "total"' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+end