mencoro 1.0.0

data/lib/mencoro/models/batch_create_tracked_queries_request_data.rb

@@ -0,0 +1,399 @@
+=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
+  # Tracked queries to create, as a cross product of texts, engines and countries
+  class BatchCreateTrackedQueriesRequestData < ApiModelBase
+    # Prompts or keywords to track. Stored lower-cased with whitespace collapsed and leading list markers removed.
+    attr_accessor :query_texts
+
+    # Engines each text is asked in.
+    attr_accessor :engines
+
+    # ISO 3166-1 alpha-2 countries each text is asked from.
+    attr_accessor :countries
+
+    # ISO 639-1 language the queries are asked in. Omit it to ask the engine without a language.
+    attr_accessor :locale
+
+    # How often every created query is checked.
+    attr_accessor :check_frequency
+
+    # Passes run per check. Applied to AI-engine combinations only: a non-AI engine is always created with 1, whatever is sent here.
+    attr_accessor :n_passes
+
+    # Clusters every created query joins. Must already exist in the project. A combination that is already tracked has these clusters merged into it.
+    attr_accessor :query_cluster_ids
+
+    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
+      {
+        :'query_texts' => :'queryTexts',
+        :'engines' => :'engines',
+        :'countries' => :'countries',
+        :'locale' => :'locale',
+        :'check_frequency' => :'checkFrequency',
+        :'n_passes' => :'nPasses',
+        :'query_cluster_ids' => :'queryClusterIds'
+      }
+    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
+      {
+        :'query_texts' => :'Array<String>',
+        :'engines' => :'Array<String>',
+        :'countries' => :'Array<String>',
+        :'locale' => :'String',
+        :'check_frequency' => :'String',
+        :'n_passes' => :'Integer',
+        :'query_cluster_ids' => :'Array<String>'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'locale',
+      ])
+    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::BatchCreateTrackedQueriesRequestData` 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::BatchCreateTrackedQueriesRequestData`. 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?(:'query_texts')
+        if (value = attributes[:'query_texts']).is_a?(Array)
+          self.query_texts = value
+        end
+      else
+        self.query_texts = nil
+      end
+
+      if attributes.key?(:'engines')
+        if (value = attributes[:'engines']).is_a?(Array)
+          self.engines = value
+        end
+      else
+        self.engines = nil
+      end
+
+      if attributes.key?(:'countries')
+        if (value = attributes[:'countries']).is_a?(Array)
+          self.countries = value
+        end
+      else
+        self.countries = nil
+      end
+
+      if attributes.key?(:'locale')
+        self.locale = attributes[:'locale']
+      end
+
+      if attributes.key?(:'check_frequency')
+        self.check_frequency = attributes[:'check_frequency']
+      else
+        self.check_frequency = nil
+      end
+
+      if attributes.key?(:'n_passes')
+        self.n_passes = attributes[:'n_passes']
+      else
+        self.n_passes = nil
+      end
+
+      if attributes.key?(:'query_cluster_ids')
+        if (value = attributes[:'query_cluster_ids']).is_a?(Array)
+          self.query_cluster_ids = value
+        end
+      else
+        self.query_cluster_ids = 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 @query_texts.nil?
+        invalid_properties.push('invalid value for "query_texts", query_texts cannot be nil.')
+      end
+
+      if @query_texts.length < 1
+        invalid_properties.push('invalid value for "query_texts", number of items must be greater than or equal to 1.')
+      end
+
+      if @engines.nil?
+        invalid_properties.push('invalid value for "engines", engines cannot be nil.')
+      end
+
+      if @engines.length < 1
+        invalid_properties.push('invalid value for "engines", number of items must be greater than or equal to 1.')
+      end
+
+      if @countries.nil?
+        invalid_properties.push('invalid value for "countries", countries cannot be nil.')
+      end
+
+      if @countries.length < 1
+        invalid_properties.push('invalid value for "countries", number of items must be greater than or equal to 1.')
+      end
+
+      if !@locale.nil? && @locale.to_s.length > 2
+        invalid_properties.push('invalid value for "locale", the character length must be smaller than or equal to 2.')
+      end
+
+      if !@locale.nil? && @locale.to_s.length < 2
+        invalid_properties.push('invalid value for "locale", the character length must be greater than or equal to 2.')
+      end
+
+      if @check_frequency.nil?
+        invalid_properties.push('invalid value for "check_frequency", check_frequency cannot be nil.')
+      end
+
+      if @n_passes.nil?
+        invalid_properties.push('invalid value for "n_passes", n_passes cannot be nil.')
+      end
+
+      if @n_passes > 10
+        invalid_properties.push('invalid value for "n_passes", must be smaller than or equal to 10.')
+      end
+
+      if @n_passes < 1
+        invalid_properties.push('invalid value for "n_passes", must be greater than or equal to 1.')
+      end
+
+      if @query_cluster_ids.nil?
+        invalid_properties.push('invalid value for "query_cluster_ids", query_cluster_ids 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 @query_texts.nil?
+      return false if @query_texts.length < 1
+      return false if @engines.nil?
+      return false if @engines.length < 1
+      return false if @countries.nil?
+      return false if @countries.length < 1
+      return false if !@locale.nil? && @locale.to_s.length > 2
+      return false if !@locale.nil? && @locale.to_s.length < 2
+      return false if @check_frequency.nil?
+      check_frequency_validator = EnumAttributeValidator.new('String', ["daily", "weekly", "monthly"])
+      return false unless check_frequency_validator.valid?(@check_frequency)
+      return false if @n_passes.nil?
+      return false if @n_passes > 10
+      return false if @n_passes < 1
+      return false if @query_cluster_ids.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] query_texts Value to be assigned
+    def query_texts=(query_texts)
+      if query_texts.nil?
+        fail ArgumentError, 'query_texts cannot be nil'
+      end
+
+      if query_texts.length < 1
+        fail ArgumentError, 'invalid value for "query_texts", number of items must be greater than or equal to 1.'
+      end
+
+      @query_texts = query_texts
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] countries Value to be assigned
+    def countries=(countries)
+      if countries.nil?
+        fail ArgumentError, 'countries cannot be nil'
+      end
+
+      if countries.length < 1
+        fail ArgumentError, 'invalid value for "countries", number of items must be greater than or equal to 1.'
+      end
+
+      @countries = countries
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] locale Value to be assigned
+    def locale=(locale)
+      if !locale.nil? && locale.to_s.length > 2
+        fail ArgumentError, 'invalid value for "locale", the character length must be smaller than or equal to 2.'
+      end
+
+      if !locale.nil? && locale.to_s.length < 2
+        fail ArgumentError, 'invalid value for "locale", the character length must be greater than or equal to 2.'
+      end
+
+      @locale = locale
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] check_frequency Object to be assigned
+    def check_frequency=(check_frequency)
+      validator = EnumAttributeValidator.new('String', ["daily", "weekly", "monthly"])
+      unless validator.valid?(check_frequency)
+        fail ArgumentError, "invalid value for \"check_frequency\", must be one of #{validator.allowable_values}."
+      end
+      @check_frequency = check_frequency
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] n_passes Value to be assigned
+    def n_passes=(n_passes)
+      if n_passes.nil?
+        fail ArgumentError, 'n_passes cannot be nil'
+      end
+
+      if n_passes > 10
+        fail ArgumentError, 'invalid value for "n_passes", must be smaller than or equal to 10.'
+      end
+
+      if n_passes < 1
+        fail ArgumentError, 'invalid value for "n_passes", must be greater than or equal to 1.'
+      end
+
+      @n_passes = n_passes
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] query_cluster_ids Value to be assigned
+    def query_cluster_ids=(query_cluster_ids)
+      if query_cluster_ids.nil?
+        fail ArgumentError, 'query_cluster_ids cannot be nil'
+      end
+
+      @query_cluster_ids = query_cluster_ids
+    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 &&
+          query_texts == o.query_texts &&
+          engines == o.engines &&
+          countries == o.countries &&
+          locale == o.locale &&
+          check_frequency == o.check_frequency &&
+          n_passes == o.n_passes &&
+          query_cluster_ids == o.query_cluster_ids
+    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
+      [query_texts, engines, countries, locale, check_frequency, n_passes, query_cluster_ids].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/batch_create_tracked_queries_result_resource.rb

@@ -0,0 +1,163 @@
+=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
+  # Per-combination results of creating tracked queries in bulk
+  class BatchCreateTrackedQueriesResultResource < ApiModelBase
+    # Tracked queries created by this call, one entry per query text, engine and country combination.
+    attr_accessor :successful
+
+    # Always present, empty list included: read it rather than inferring success from the status code.
+    attr_accessor :failed
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'successful' => :'successful',
+        :'failed' => :'failed'
+      }
+    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
+      {
+        :'successful' => :'Array<BatchCreateTrackedQueriesResultResourceSuccessfulInner>',
+        :'failed' => :'Array<BatchCreateTrackedQueriesResultResourceFailedInner>'
+      }
+    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::BatchCreateTrackedQueriesResultResource` 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::BatchCreateTrackedQueriesResultResource`. 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?(:'successful')
+        if (value = attributes[:'successful']).is_a?(Array)
+          self.successful = value
+        end
+      end
+
+      if attributes.key?(:'failed')
+        if (value = attributes[:'failed']).is_a?(Array)
+          self.failed = value
+        end
+      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 &&
+          successful == o.successful &&
+          failed == o.failed
+    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
+      [successful, failed].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