mencoro 1.0.1 → 2.0.1

data/lib/mencoro/models/get_organization_overview200_response_projects_inner.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
@@ -21,12 +21,22 @@ module Mencoro
 
     attr_accessor :status
 
+    # Configured tracked queries of the project, paused ones included.
     attr_accessor :tracked_query_count
 
+    # How many of trackedQueryCount run on an AI answer engine (ChatGPT, Claude, Perplexity, Google AI Overview, Google AI Mode).
+    attr_accessor :ai_tracked_query_count
+
+    # How many of trackedQueryCount run on classic Google SERP.
+    attr_accessor :serp_tracked_query_count
+
+    # How many of trackedQueryCount run on Google Shopping.
+    attr_accessor :shopping_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.
+    # 0-100 percentage of AI checks (one per tracked query x engine x UTC day) across all retained data that mentioned the brand, each check counted as the share of its passes that did; 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.
@@ -42,6 +52,9 @@ module Mencoro
         :'name' => :'name',
         :'status' => :'status',
         :'tracked_query_count' => :'trackedQueryCount',
+        :'ai_tracked_query_count' => :'aiTrackedQueryCount',
+        :'serp_tracked_query_count' => :'serpTrackedQueryCount',
+        :'shopping_tracked_query_count' => :'shoppingTrackedQueryCount',
         :'share_of_voice' => :'shareOfVoice',
         :'mention_rate' => :'mentionRate',
         :'avg_mention_position' => :'avgMentionPosition',
@@ -66,6 +79,9 @@ module Mencoro
         :'name' => :'String',
         :'status' => :'String',
         :'tracked_query_count' => :'Integer',
+        :'ai_tracked_query_count' => :'Integer',
+        :'serp_tracked_query_count' => :'Integer',
+        :'shopping_tracked_query_count' => :'Integer',
         :'share_of_voice' => :'Float',
         :'mention_rate' => :'Integer',
         :'avg_mention_position' => :'Float',
@@ -115,6 +131,18 @@ module Mencoro
         self.tracked_query_count = attributes[:'tracked_query_count']
       end
 
+      if attributes.key?(:'ai_tracked_query_count')
+        self.ai_tracked_query_count = attributes[:'ai_tracked_query_count']
+      end
+
+      if attributes.key?(:'serp_tracked_query_count')
+        self.serp_tracked_query_count = attributes[:'serp_tracked_query_count']
+      end
+
+      if attributes.key?(:'shopping_tracked_query_count')
+        self.shopping_tracked_query_count = attributes[:'shopping_tracked_query_count']
+      end
+
       if attributes.key?(:'share_of_voice')
         self.share_of_voice = attributes[:'share_of_voice']
       end
@@ -156,6 +184,9 @@ module Mencoro
           name == o.name &&
           status == o.status &&
           tracked_query_count == o.tracked_query_count &&
+          ai_tracked_query_count == o.ai_tracked_query_count &&
+          serp_tracked_query_count == o.serp_tracked_query_count &&
+          shopping_tracked_query_count == o.shopping_tracked_query_count &&
           share_of_voice == o.share_of_voice &&
           mention_rate == o.mention_rate &&
           avg_mention_position == o.avg_mention_position &&
@@ -171,7 +202,7 @@ module Mencoro
     # 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
+      [project_id, name, status, tracked_query_count, ai_tracked_query_count, serp_tracked_query_count, shopping_tracked_query_count, share_of_voice, mention_rate, avg_mention_position, positivity_index].hash
     end
 
     # Builds the object from hash

data/lib/mencoro/models/get_organization_stats200_response.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/get_organization_stats200_response_invitations.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
@@ -15,7 +15,7 @@ require 'time'
 
 module Mencoro
   class GetOrganizationStats200ResponseInvitations < ApiModelBase
-    # Invitations still awaiting an answer. Accepted, cancelled and expired ones are excluded.
+    # Invitations still awaiting an answer. Accepted, cancelled and expired ones are excluded. Null for a member restricted to selected projects.
     attr_accessor :pending
 
     # Attribute mapping from ruby-style variable name to JSON key.
@@ -45,6 +45,7 @@ module Mencoro
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
+        :'pending'
       ])
     end
 
@@ -92,11 +93,7 @@ module Mencoro
     # Custom attribute writer method with validation
     # @param [Object] pending Value to be assigned
     def pending=(pending)
-      if pending.nil?
-        fail ArgumentError, 'pending cannot be nil'
-      end
-
-      if pending < 0
+      if !pending.nil? && pending < 0
         fail ArgumentError, 'invalid value for "pending", must be greater than or equal to 0.'
       end
 

data/lib/mencoro/models/get_organization_stats200_response_members.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
@@ -15,7 +15,7 @@ require 'time'
 
 module Mencoro
   class GetOrganizationStats200ResponseMembers < ApiModelBase
-    # Active memberships. Suspended members are excluded.
+    # Active memberships. Suspended members are excluded. Null for a member restricted to selected projects.
     attr_accessor :total
 
     # Attribute mapping from ruby-style variable name to JSON key.
@@ -45,6 +45,7 @@ module Mencoro
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
+        :'total'
       ])
     end
 
@@ -92,11 +93,7 @@ module Mencoro
     # Custom attribute writer method with validation
     # @param [Object] total Value to be assigned
     def total=(total)
-      if total.nil?
-        fail ArgumentError, 'total cannot be nil'
-      end
-
-      if total < 0
+      if !total.nil? && total < 0
         fail ArgumentError, 'invalid value for "total", must be greater than or equal to 0.'
       end
 

data/lib/mencoro/models/get_organization_stats200_response_projects.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
@@ -15,7 +15,7 @@ require 'time'
 
 module Mencoro
   class GetOrganizationStats200ResponseProjects < ApiModelBase
-    # Every project in the organization, archived ones included.
+    # Every project of the organization the caller can access, archived ones included.
     attr_accessor :total
 
     # Projects that are not archived; never greater than `total`.

data/lib/mencoro/models/get_share_of_voice_formula200_response.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/get_tracking_coverage200_response.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/get_tracking_coverage200_response_sample_inner.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/invitation_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
@@ -30,6 +30,12 @@ module Mencoro
 
     attr_accessor :accepted_at
 
+    # Which projects of the organization the invitee reaches on accepting: every project, or only projectIds
+    attr_accessor :project_access_mode
+
+    # The projects a selected access reaches, limited to those still in the organization; empty when the mode is all. It may be empty on selected once its projects left the organization, which grants nothing
+    attr_accessor :project_ids
+
     class EnumAttributeValidator
       attr_reader :datatype
       attr_reader :allowable_values
@@ -61,7 +67,9 @@ module Mencoro
         :'state' => :'state',
         :'created_at' => :'createdAt',
         :'expires_at' => :'expiresAt',
-        :'accepted_at' => :'acceptedAt'
+        :'accepted_at' => :'acceptedAt',
+        :'project_access_mode' => :'projectAccessMode',
+        :'project_ids' => :'projectIds'
       }
     end
 
@@ -84,14 +92,16 @@ module Mencoro
         :'state' => :'String',
         :'created_at' => :'Time',
         :'expires_at' => :'Time',
-        :'accepted_at' => :'Time'
+        :'accepted_at' => :'Time',
+        :'project_access_mode' => :'String',
+        :'project_ids' => :'Array<String>'
       }
     end
 
     # List of attributes with nullable: true
     def self.openapi_nullable
       Set.new([
-        :'accepted_at'
+        :'accepted_at',
       ])
     end
 
@@ -150,6 +160,20 @@ module Mencoro
       if attributes.key?(:'accepted_at')
         self.accepted_at = attributes[:'accepted_at']
       end
+
+      if attributes.key?(:'project_access_mode')
+        self.project_access_mode = attributes[:'project_access_mode']
+      else
+        self.project_access_mode = nil
+      end
+
+      if attributes.key?(:'project_ids')
+        if (value = attributes[:'project_ids']).is_a?(Array)
+          self.project_ids = value
+        end
+      else
+        self.project_ids = nil
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -181,6 +205,14 @@ module Mencoro
         invalid_properties.push('invalid value for "expires_at", expires_at cannot be nil.')
       end
 
+      if @project_access_mode.nil?
+        invalid_properties.push('invalid value for "project_access_mode", project_access_mode cannot be nil.')
+      end
+
+      if @project_ids.nil?
+        invalid_properties.push('invalid value for "project_ids", project_ids cannot be nil.')
+      end
+
       invalid_properties
     end
 
@@ -198,6 +230,10 @@ module Mencoro
       return false unless state_validator.valid?(@state)
       return false if @created_at.nil?
       return false if @expires_at.nil?
+      return false if @project_access_mode.nil?
+      project_access_mode_validator = EnumAttributeValidator.new('String', ["all", "selected"])
+      return false unless project_access_mode_validator.valid?(@project_access_mode)
+      return false if @project_ids.nil?
       true
     end
 
@@ -261,6 +297,26 @@ module Mencoro
       @expires_at = expires_at
     end
 
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] project_access_mode Object to be assigned
+    def project_access_mode=(project_access_mode)
+      validator = EnumAttributeValidator.new('String', ["all", "selected"])
+      unless validator.valid?(project_access_mode)
+        fail ArgumentError, "invalid value for \"project_access_mode\", must be one of #{validator.allowable_values}."
+      end
+      @project_access_mode = project_access_mode
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] project_ids Value to be assigned
+    def project_ids=(project_ids)
+      if project_ids.nil?
+        fail ArgumentError, 'project_ids cannot be nil'
+      end
+
+      @project_ids = project_ids
+    end
+
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)
@@ -272,7 +328,9 @@ module Mencoro
           state == o.state &&
           created_at == o.created_at &&
           expires_at == o.expires_at &&
-          accepted_at == o.accepted_at
+          accepted_at == o.accepted_at &&
+          project_access_mode == o.project_access_mode &&
+          project_ids == o.project_ids
     end
 
     # @see the `==` method
@@ -284,7 +342,7 @@ module Mencoro
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, email, role, state, created_at, expires_at, accepted_at].hash
+      [id, email, role, state, created_at, expires_at, accepted_at, project_access_mode, project_ids].hash
     end
 
     # Builds the object from hash

data/lib/mencoro/models/keyword_listing_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
@@ -49,34 +49,34 @@ module Mencoro
     # Distinct check frequencies across the variants.
     attr_accessor :check_frequencies
 
-    # Distinct pass counts across the variants. A pass is one budget unit per check.
+    # Distinct pass counts across the variants. Each Claude pass consumes five checks; each other engine pass consumes one.
     attr_accessor :n_passes_values
 
     # The most recent completed check across the variants. Null when none has ever completed — not a check that found nothing.
     attr_accessor :last_checked_at
 
-    # Average position in traditional search over the window. 1-based, LOWER is better.
+    # Average position in traditional search over the window. 1-based, LOWER is better. A variant not checked in the window contributes its latest earlier measurement instead; see carriedPositions.
     attr_accessor :avg_serp_position
 
-    # Signed improvement in avgSerpPosition against the previous window. Positive is better.
+    # Signed improvement in avgSerpPosition against the previous window. Positive is better. Null when carriedPositions.serp is set.
     attr_accessor :trend_serp
 
-    # Average position in shopping results over the window. 1-based, LOWER is better.
+    # Average position in shopping results over the window. 1-based, LOWER is better. A variant not checked in the window contributes its latest earlier measurement instead; see carriedPositions.
     attr_accessor :avg_shopping_position
 
-    # Signed improvement in avgShoppingPosition. Positive is better.
+    # Signed improvement in avgShoppingPosition. Positive is better. Null when carriedPositions.shopping is set.
     attr_accessor :trend_shopping
 
-    # Average position of the brand mention inside the AI answer. 1-based, LOWER is better.
+    # Average position of the brand mention inside the AI answer. 1-based, LOWER is better. A variant not checked in the window contributes its latest earlier measurement instead; see carriedPositions.
     attr_accessor :avg_mention_position
 
-    # Signed improvement in avgMentionPosition. Positive is better.
+    # Signed improvement in avgMentionPosition. Positive is better. Null when carriedPositions.mention is set.
     attr_accessor :trend_mention
 
-    # Average position of a cited link to the brand. 1-based, LOWER is better.
+    # Average position of a cited link to the brand. 1-based, LOWER is better. A variant not checked in the window contributes its latest earlier measurement instead; see carriedPositions.
     attr_accessor :avg_link_position
 
-    # Signed improvement in avgLinkPosition. Positive is better.
+    # Signed improvement in avgLinkPosition. Positive is better. Null when carriedPositions.link is set.
     attr_accessor :trend_link
 
     # Day-to-day spread of the mention position (a standard deviation): LOWER means steadier.
@@ -123,6 +123,8 @@ module Mencoro
 
     attr_accessor :mention_type_counts
 
+    attr_accessor :carried_positions
+
     class EnumAttributeValidator
       attr_reader :datatype
       attr_reader :allowable_values
@@ -183,7 +185,8 @@ module Mencoro
         :'sentiment_neutral' => :'sentimentNeutral',
         :'sentiment_negative' => :'sentimentNegative',
         :'avg_mention_count' => :'avgMentionCount',
-        :'mention_type_counts' => :'mentionTypeCounts'
+        :'mention_type_counts' => :'mentionTypeCounts',
+        :'carried_positions' => :'carriedPositions'
       }
     end
 
@@ -235,7 +238,8 @@ module Mencoro
         :'sentiment_neutral' => :'Integer',
         :'sentiment_negative' => :'Integer',
         :'avg_mention_count' => :'Float',
-        :'mention_type_counts' => :'KeywordListingResourceMentionTypeCounts'
+        :'mention_type_counts' => :'KeywordListingResourceMentionTypeCounts',
+        :'carried_positions' => :'KeywordListingResourceCarriedPositions'
       }
     end
 
@@ -470,6 +474,12 @@ module Mencoro
       else
         self.mention_type_counts = nil
       end
+
+      if attributes.key?(:'carried_positions')
+        self.carried_positions = attributes[:'carried_positions']
+      else
+        self.carried_positions = nil
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -541,6 +551,10 @@ module Mencoro
         invalid_properties.push('invalid value for "mention_type_counts", mention_type_counts cannot be nil.')
       end
 
+      if @carried_positions.nil?
+        invalid_properties.push('invalid value for "carried_positions", carried_positions cannot be nil.')
+      end
+
       invalid_properties
     end
 
@@ -566,6 +580,7 @@ module Mencoro
       return false if @sentiment_neutral.nil?
       return false if @sentiment_negative.nil?
       return false if @mention_type_counts.nil?
+      return false if @carried_positions.nil?
       true
     end
 
@@ -699,6 +714,16 @@ module Mencoro
       @mention_type_counts = mention_type_counts
     end
 
+    # Custom attribute writer method with validation
+    # @param [Object] carried_positions Value to be assigned
+    def carried_positions=(carried_positions)
+      if carried_positions.nil?
+        fail ArgumentError, 'carried_positions cannot be nil'
+      end
+
+      @carried_positions = carried_positions
+    end
+
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)
@@ -739,7 +764,8 @@ module Mencoro
           sentiment_neutral == o.sentiment_neutral &&
           sentiment_negative == o.sentiment_negative &&
           avg_mention_count == o.avg_mention_count &&
-          mention_type_counts == o.mention_type_counts
+          mention_type_counts == o.mention_type_counts &&
+          carried_positions == o.carried_positions
     end
 
     # @see the `==` method
@@ -751,7 +777,7 @@ module Mencoro
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [keyword, keyword_normalized, variant_count, variant_ids, engines, countries, query_cluster_ids, has_unclustered_variant, status_summary, statuses, check_frequencies, n_passes_values, last_checked_at, avg_serp_position, trend_serp, avg_shopping_position, trend_shopping, avg_mention_position, trend_mention, avg_link_position, trend_link, mention_position_stability, trend_stability, positivity_index, trend_positivity, mention_rate, trend_mention_rate, serp_rate, trend_serp_rate, share_of_voice, trend_share_of_voice, sentiment_positive, sentiment_neutral, sentiment_negative, avg_mention_count, mention_type_counts].hash
+      [keyword, keyword_normalized, variant_count, variant_ids, engines, countries, query_cluster_ids, has_unclustered_variant, status_summary, statuses, check_frequencies, n_passes_values, last_checked_at, avg_serp_position, trend_serp, avg_shopping_position, trend_shopping, avg_mention_position, trend_mention, avg_link_position, trend_link, mention_position_stability, trend_stability, positivity_index, trend_positivity, mention_rate, trend_mention_rate, serp_rate, trend_serp_rate, share_of_voice, trend_share_of_voice, sentiment_positive, sentiment_neutral, sentiment_negative, avg_mention_count, mention_type_counts, carried_positions].hash
     end
 
     # Builds the object from hash