mencoro 1.0.0

data/lib/mencoro/models/start_keyword_discovery_job_request.rb

@@ -0,0 +1,266 @@
+=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 StartKeywordDiscoveryJobRequest < ApiModelBase
+    # Free text describing the keywords or topics to expand.
+    attr_accessor :input
+
+    # Language code. Omit to let the provider detect it from the input.
+    attr_accessor :language
+
+    # ISO 3166-1 alpha-2 country. Omit to let the provider infer it.
+    attr_accessor :country
+
+    # Extra queries to keep out of the suggestions for this run. Duplicates are collapsed, after the entry count has been checked against maxItems. The project tracked queries are excluded whether or not this is sent.
+    attr_accessor :exclude_queries
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'input' => :'input',
+        :'language' => :'language',
+        :'country' => :'country',
+        :'exclude_queries' => :'excludeQueries'
+      }
+    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
+      {
+        :'input' => :'String',
+        :'language' => :'String',
+        :'country' => :'String',
+        :'exclude_queries' => :'Array<String>'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'language',
+        :'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::StartKeywordDiscoveryJobRequest` 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::StartKeywordDiscoveryJobRequest`. 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?(:'input')
+        self.input = attributes[:'input']
+      else
+        self.input = nil
+      end
+
+      if attributes.key?(:'language')
+        self.language = attributes[:'language']
+      end
+
+      if attributes.key?(:'country')
+        self.country = attributes[:'country']
+      end
+
+      if attributes.key?(:'exclude_queries')
+        if (value = attributes[:'exclude_queries']).is_a?(Array)
+          self.exclude_queries = 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
+      if @input.nil?
+        invalid_properties.push('invalid value for "input", input cannot be nil.')
+      end
+
+      if @input.to_s.length > 10000
+        invalid_properties.push('invalid value for "input", the character length must be smaller than or equal to 10000.')
+      end
+
+      if !@language.nil? && @language.to_s.length > 5
+        invalid_properties.push('invalid value for "language", the character length must be smaller than or equal to 5.')
+      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
+
+      if !@exclude_queries.nil? && @exclude_queries.length > 5000
+        invalid_properties.push('invalid value for "exclude_queries", number of items must be less than or equal to 5000.')
+      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 @input.nil?
+      return false if @input.to_s.length > 10000
+      return false if !@language.nil? && @language.to_s.length > 5
+      return false if !@country.nil? && @country.to_s.length > 2
+      return false if !@country.nil? && @country.to_s.length < 2
+      return false if !@exclude_queries.nil? && @exclude_queries.length > 5000
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] input Value to be assigned
+    def input=(input)
+      if input.nil?
+        fail ArgumentError, 'input cannot be nil'
+      end
+
+      if input.to_s.length > 10000
+        fail ArgumentError, 'invalid value for "input", the character length must be smaller than or equal to 10000.'
+      end
+
+      @input = input
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] language Value to be assigned
+    def language=(language)
+      if !language.nil? && language.to_s.length > 5
+        fail ArgumentError, 'invalid value for "language", the character length must be smaller than or equal to 5.'
+      end
+
+      @language = language
+    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
+
+    # Custom attribute writer method with validation
+    # @param [Object] exclude_queries Value to be assigned
+    def exclude_queries=(exclude_queries)
+      if exclude_queries.nil?
+        fail ArgumentError, 'exclude_queries cannot be nil'
+      end
+
+      if exclude_queries.length > 5000
+        fail ArgumentError, 'invalid value for "exclude_queries", number of items must be less than or equal to 5000.'
+      end
+
+      @exclude_queries = exclude_queries
+    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 &&
+          input == o.input &&
+          language == o.language &&
+          country == o.country &&
+          exclude_queries == o.exclude_queries
+    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
+      [input, language, country, exclude_queries].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_prompt_discovery_job_request.rb

@@ -0,0 +1,276 @@
+=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 StartPromptDiscoveryJobRequest < ApiModelBase
+    # Free text describing the topics to turn into prompts.
+    attr_accessor :input
+
+    # ISO 3166-1 alpha-2 country the prompts are asked from.
+    attr_accessor :country
+
+    # Language code. Omit to let the provider detect it from the input.
+    attr_accessor :language
+
+    # Extra queries to keep out of the suggestions for this run. Duplicates are collapsed, after the entry count has been checked against maxItems. The project tracked queries are excluded whether or not this is sent.
+    attr_accessor :exclude_queries
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'input' => :'input',
+        :'country' => :'country',
+        :'language' => :'language',
+        :'exclude_queries' => :'excludeQueries'
+      }
+    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
+      {
+        :'input' => :'String',
+        :'country' => :'String',
+        :'language' => :'String',
+        :'exclude_queries' => :'Array<String>'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'language',
+      ])
+    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::StartPromptDiscoveryJobRequest` 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::StartPromptDiscoveryJobRequest`. 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?(:'input')
+        self.input = attributes[:'input']
+      else
+        self.input = nil
+      end
+
+      if attributes.key?(:'country')
+        self.country = attributes[:'country']
+      else
+        self.country = nil
+      end
+
+      if attributes.key?(:'language')
+        self.language = attributes[:'language']
+      end
+
+      if attributes.key?(:'exclude_queries')
+        if (value = attributes[:'exclude_queries']).is_a?(Array)
+          self.exclude_queries = 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
+      if @input.nil?
+        invalid_properties.push('invalid value for "input", input cannot be nil.')
+      end
+
+      if @input.to_s.length > 10000
+        invalid_properties.push('invalid value for "input", the character length must be smaller than or equal to 10000.')
+      end
+
+      if @country.nil?
+        invalid_properties.push('invalid value for "country", country cannot be nil.')
+      end
+
+      if @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.to_s.length < 2
+        invalid_properties.push('invalid value for "country", the character length must be greater than or equal to 2.')
+      end
+
+      if !@language.nil? && @language.to_s.length > 5
+        invalid_properties.push('invalid value for "language", the character length must be smaller than or equal to 5.')
+      end
+
+      if !@exclude_queries.nil? && @exclude_queries.length > 5000
+        invalid_properties.push('invalid value for "exclude_queries", number of items must be less than or equal to 5000.')
+      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 @input.nil?
+      return false if @input.to_s.length > 10000
+      return false if @country.nil?
+      return false if @country.to_s.length > 2
+      return false if @country.to_s.length < 2
+      return false if !@language.nil? && @language.to_s.length > 5
+      return false if !@exclude_queries.nil? && @exclude_queries.length > 5000
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] input Value to be assigned
+    def input=(input)
+      if input.nil?
+        fail ArgumentError, 'input cannot be nil'
+      end
+
+      if input.to_s.length > 10000
+        fail ArgumentError, 'invalid value for "input", the character length must be smaller than or equal to 10000.'
+      end
+
+      @input = input
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] country Value to be assigned
+    def country=(country)
+      if country.nil?
+        fail ArgumentError, 'country cannot be nil'
+      end
+
+      if 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.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
+
+    # Custom attribute writer method with validation
+    # @param [Object] language Value to be assigned
+    def language=(language)
+      if !language.nil? && language.to_s.length > 5
+        fail ArgumentError, 'invalid value for "language", the character length must be smaller than or equal to 5.'
+      end
+
+      @language = language
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] exclude_queries Value to be assigned
+    def exclude_queries=(exclude_queries)
+      if exclude_queries.nil?
+        fail ArgumentError, 'exclude_queries cannot be nil'
+      end
+
+      if exclude_queries.length > 5000
+        fail ArgumentError, 'invalid value for "exclude_queries", number of items must be less than or equal to 5000.'
+      end
+
+      @exclude_queries = exclude_queries
+    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 &&
+          input == o.input &&
+          country == o.country &&
+          language == o.language &&
+          exclude_queries == o.exclude_queries
+    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
+      [input, country, language, exclude_queries].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