mencoro 1.0.1 → 2.0.0

data/lib/mencoro/models/start_brand_name_suggestion_job_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/start_clustering_job_request_data.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/start_keyword_discovery_job_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/start_prompt_discovery_job_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/submitted_checks_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

data/lib/mencoro/models/subscription_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
@@ -14,7 +14,7 @@ require 'date'
 require 'time'
 
 module Mencoro
-  # The current subscription contract of an organization
+  # The current subscription contract of an organization. For a member restricted to selected projects, the plan, the billing cycle, the check budget, its consumption and the deactivation reason are null.
   class SubscriptionResource < ApiModelBase
     # Contract state. \"none\" when the organization has never held a subscription.
     attr_accessor :status
@@ -49,7 +49,7 @@ module Mencoro
     # When paid access ends after a cancellation. Null when the subscription is not cancelled.
     attr_accessor :grace_period_ends_at
 
-    # Why the subscription is currently inactive. Null for an active subscription, and meaningless once \"cancelledAt\" is set - the cancellation supersedes it.
+    # Why the subscription is currently inactive. Null for an active subscription and for a member restricted to selected projects, and meaningless once \"cancelledAt\" is set - the cancellation supersedes it.
     attr_accessor :deactivation_reason
 
     # Whether the organization may use paid features right now: active, or cancelled but still inside its paid grace window.

data/lib/mencoro/models/time_series_point.rb

@@ -0,0 +1,218 @@
+=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 TimeSeriesPoint < ApiModelBase
+    attr_accessor :raw_date
+
+    attr_accessor :brand
+
+    attr_accessor :competitors
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'raw_date' => :'rawDate',
+        :'brand' => :'brand',
+        :'competitors' => :'competitors'
+      }
+    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
+      {
+        :'raw_date' => :'String',
+        :'brand' => :'PerEntityMetrics',
+        :'competitors' => :'Hash<String, PerEntityMetrics>'
+      }
+    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::TimeSeriesPoint` 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::TimeSeriesPoint`. 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?(:'raw_date')
+        self.raw_date = attributes[:'raw_date']
+      else
+        self.raw_date = nil
+      end
+
+      if attributes.key?(:'brand')
+        self.brand = attributes[:'brand']
+      else
+        self.brand = nil
+      end
+
+      if attributes.key?(:'competitors')
+        if (value = attributes[:'competitors']).is_a?(Hash)
+          self.competitors = value
+        end
+      else
+        self.competitors = 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 @raw_date.nil?
+        invalid_properties.push('invalid value for "raw_date", raw_date cannot be nil.')
+      end
+
+      if @brand.nil?
+        invalid_properties.push('invalid value for "brand", brand cannot be nil.')
+      end
+
+      if @competitors.nil?
+        invalid_properties.push('invalid value for "competitors", competitors 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 @raw_date.nil?
+      return false if @brand.nil?
+      return false if @competitors.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] raw_date Value to be assigned
+    def raw_date=(raw_date)
+      if raw_date.nil?
+        fail ArgumentError, 'raw_date cannot be nil'
+      end
+
+      @raw_date = raw_date
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] brand Value to be assigned
+    def brand=(brand)
+      if brand.nil?
+        fail ArgumentError, 'brand cannot be nil'
+      end
+
+      @brand = brand
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] competitors Value to be assigned
+    def competitors=(competitors)
+      if competitors.nil?
+        fail ArgumentError, 'competitors cannot be nil'
+      end
+
+      @competitors = competitors
+    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 &&
+          raw_date == o.raw_date &&
+          brand == o.brand &&
+          competitors == o.competitors
+    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
+      [raw_date, brand, competitors].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_count_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
@@ -14,12 +14,12 @@ require 'date'
 require 'time'
 
 module Mencoro
-  # How many tracked queries a project has, and what checking them would cost in budget units
+  # How many tracked queries a project has, and what checking them would consume in checks
   class TrackedQueryCountResource < ApiModelBase
     # Tracked queries in the project matching the status filter. Every status when none was sent.
     attr_accessor :count
 
-    # Budget cost of force-checking exactly those tracked queries, in check budget units: the sum of each one's configured passes. One unit per pass, the same unit the plan allowance is counted in. Reserves nothing and debits nothing.
+    # Budget cost of force-checking exactly those tracked queries, in checks: the sum of each one's configured passes multiplied by its engine weight. Five checks per Claude pass and one check per pass for every other engine, the same currency as the plan allowance. Reserves nothing and debits nothing.
     attr_accessor :check_cost
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/mencoro/models/tracked_query_detail_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
@@ -257,7 +257,7 @@ module Mencoro
       return false if @project_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 @query_cluster_ids.nil?
@@ -305,7 +305,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