mencoro 1.0.0

data/lib/mencoro/models/start_brand_name_suggestion_job_request.rb

@@ -0,0 +1,287 @@
+=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
+  class StartBrandNameSuggestionJobRequest < ApiModelBase
+    # The display name of the entity to find aliases for.
+    attr_accessor :name
+
+    # The entity website domains. At least one is required: the web search is grounded on them, and without one the name alone is ambiguous. Duplicates are collapsed, after the entry count has been checked against maxItems.
+    attr_accessor :website_domains
+
+    # Names already known, excluded from the suggestions. Duplicates are collapsed, after the entry count has been checked against maxItems.
+    attr_accessor :entered_brand_names
+
+    # ISO 3166-1 alpha-2 country used to localize the web search.
+    attr_accessor :country
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'name' => :'name',
+        :'website_domains' => :'websiteDomains',
+        :'entered_brand_names' => :'enteredBrandNames',
+        :'country' => :'country'
+      }
+    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
+      {
+        :'name' => :'String',
+        :'website_domains' => :'Array<String>',
+        :'entered_brand_names' => :'Array<String>',
+        :'country' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'country'
+      ])
+    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::StartBrandNameSuggestionJobRequest` 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::StartBrandNameSuggestionJobRequest`. 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?(:'name')
+        self.name = attributes[:'name']
+      else
+        self.name = nil
+      end
+
+      if attributes.key?(:'website_domains')
+        if (value = attributes[:'website_domains']).is_a?(Array)
+          self.website_domains = value
+        end
+      else
+        self.website_domains = nil
+      end
+
+      if attributes.key?(:'entered_brand_names')
+        if (value = attributes[:'entered_brand_names']).is_a?(Array)
+          self.entered_brand_names = value
+        end
+      end
+
+      if attributes.key?(:'country')
+        self.country = attributes[:'country']
+      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 @name.nil?
+        invalid_properties.push('invalid value for "name", name cannot be nil.')
+      end
+
+      if @name.to_s.length > 255
+        invalid_properties.push('invalid value for "name", the character length must be smaller than or equal to 255.')
+      end
+
+      if @website_domains.nil?
+        invalid_properties.push('invalid value for "website_domains", website_domains cannot be nil.')
+      end
+
+      if @website_domains.length > 25
+        invalid_properties.push('invalid value for "website_domains", number of items must be less than or equal to 25.')
+      end
+
+      if @website_domains.length < 1
+        invalid_properties.push('invalid value for "website_domains", number of items must be greater than or equal to 1.')
+      end
+
+      if !@entered_brand_names.nil? && @entered_brand_names.length > 100
+        invalid_properties.push('invalid value for "entered_brand_names", number of items must be less than or equal to 100.')
+      end
+
+      if !@country.nil? && @country.to_s.length > 2
+        invalid_properties.push('invalid value for "country", the character length must be smaller than or equal to 2.')
+      end
+
+      if !@country.nil? && @country.to_s.length < 2
+        invalid_properties.push('invalid value for "country", the character length must be greater than or equal to 2.')
+      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 @name.nil?
+      return false if @name.to_s.length > 255
+      return false if @website_domains.nil?
+      return false if @website_domains.length > 25
+      return false if @website_domains.length < 1
+      return false if !@entered_brand_names.nil? && @entered_brand_names.length > 100
+      return false if !@country.nil? && @country.to_s.length > 2
+      return false if !@country.nil? && @country.to_s.length < 2
+      true
+    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
+
+      if name.to_s.length > 255
+        fail ArgumentError, 'invalid value for "name", the character length must be smaller than or equal to 255.'
+      end
+
+      @name = name
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] website_domains Value to be assigned
+    def website_domains=(website_domains)
+      if website_domains.nil?
+        fail ArgumentError, 'website_domains cannot be nil'
+      end
+
+      if website_domains.length > 25
+        fail ArgumentError, 'invalid value for "website_domains", number of items must be less than or equal to 25.'
+      end
+
+      if website_domains.length < 1
+        fail ArgumentError, 'invalid value for "website_domains", number of items must be greater than or equal to 1.'
+      end
+
+      @website_domains = website_domains
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] entered_brand_names Value to be assigned
+    def entered_brand_names=(entered_brand_names)
+      if entered_brand_names.nil?
+        fail ArgumentError, 'entered_brand_names cannot be nil'
+      end
+
+      if entered_brand_names.length > 100
+        fail ArgumentError, 'invalid value for "entered_brand_names", number of items must be less than or equal to 100.'
+      end
+
+      @entered_brand_names = entered_brand_names
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] country Value to be assigned
+    def country=(country)
+      if !country.nil? && country.to_s.length > 2
+        fail ArgumentError, 'invalid value for "country", the character length must be smaller than or equal to 2.'
+      end
+
+      if !country.nil? && country.to_s.length < 2
+        fail ArgumentError, 'invalid value for "country", the character length must be greater than or equal to 2.'
+      end
+
+      @country = country
+    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 &&
+          name == o.name &&
+          website_domains == o.website_domains &&
+          entered_brand_names == o.entered_brand_names &&
+          country == o.country
+    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
+      [name, website_domains, entered_brand_names, country].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/start_clustering_job_request_data.rb

@@ -0,0 +1,249 @@
+=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 a clustering job should group, and how
+  class StartClusteringJobRequestData < ApiModelBase
+    # The tracked queries to cluster. Duplicates are collapsed.
+    attr_accessor :tracked_query_ids
+
+    # fill_gaps groups only tracked queries that belong to no cluster; add_on_top adds the new clusters to whatever each query already has; full_regroup replaces the current clusters with the job's.
+    attr_accessor :mode
+
+    # When true the job may only use clusters the project already has, and leaves a query ungrouped rather than inventing a name for it.
+    attr_accessor :restrict_to_existing_clusters
+
+    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
+      {
+        :'tracked_query_ids' => :'trackedQueryIds',
+        :'mode' => :'mode',
+        :'restrict_to_existing_clusters' => :'restrictToExistingClusters'
+      }
+    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
+      {
+        :'tracked_query_ids' => :'Array<String>',
+        :'mode' => :'String',
+        :'restrict_to_existing_clusters' => :'Boolean'
+      }
+    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::StartClusteringJobRequestData` 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::StartClusteringJobRequestData`. 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?(:'tracked_query_ids')
+        if (value = attributes[:'tracked_query_ids']).is_a?(Array)
+          self.tracked_query_ids = value
+        end
+      else
+        self.tracked_query_ids = nil
+      end
+
+      if attributes.key?(:'mode')
+        self.mode = attributes[:'mode']
+      else
+        self.mode = nil
+      end
+
+      if attributes.key?(:'restrict_to_existing_clusters')
+        self.restrict_to_existing_clusters = attributes[:'restrict_to_existing_clusters']
+      else
+        self.restrict_to_existing_clusters = false
+      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 @tracked_query_ids.nil?
+        invalid_properties.push('invalid value for "tracked_query_ids", tracked_query_ids cannot be nil.')
+      end
+
+      if @tracked_query_ids.length > 500
+        invalid_properties.push('invalid value for "tracked_query_ids", number of items must be less than or equal to 500.')
+      end
+
+      if @tracked_query_ids.length < 1
+        invalid_properties.push('invalid value for "tracked_query_ids", number of items must be greater than or equal to 1.')
+      end
+
+      if @mode.nil?
+        invalid_properties.push('invalid value for "mode", mode 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 @tracked_query_ids.nil?
+      return false if @tracked_query_ids.length > 500
+      return false if @tracked_query_ids.length < 1
+      return false if @mode.nil?
+      mode_validator = EnumAttributeValidator.new('String', ["fill_gaps", "full_regroup", "add_on_top"])
+      return false unless mode_validator.valid?(@mode)
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] tracked_query_ids Value to be assigned
+    def tracked_query_ids=(tracked_query_ids)
+      if tracked_query_ids.nil?
+        fail ArgumentError, 'tracked_query_ids cannot be nil'
+      end
+
+      if tracked_query_ids.length > 500
+        fail ArgumentError, 'invalid value for "tracked_query_ids", number of items must be less than or equal to 500.'
+      end
+
+      if tracked_query_ids.length < 1
+        fail ArgumentError, 'invalid value for "tracked_query_ids", number of items must be greater than or equal to 1.'
+      end
+
+      @tracked_query_ids = tracked_query_ids
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] mode Object to be assigned
+    def mode=(mode)
+      validator = EnumAttributeValidator.new('String', ["fill_gaps", "full_regroup", "add_on_top"])
+      unless validator.valid?(mode)
+        fail ArgumentError, "invalid value for \"mode\", must be one of #{validator.allowable_values}."
+      end
+      @mode = mode
+    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 &&
+          tracked_query_ids == o.tracked_query_ids &&
+          mode == o.mode &&
+          restrict_to_existing_clusters == o.restrict_to_existing_clusters
+    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
+      [tracked_query_ids, mode, restrict_to_existing_clusters].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