mencoro 1.0.0

data/lib/mencoro/models/cluster_membership_request_data.rb

@@ -0,0 +1,186 @@
+=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
+  # The clusters a tracked query is added to or removed from
+  class ClusterMembershipRequestData < ApiModelBase
+    # Ids of the query clusters. Duplicates are collapsed. Every id must belong to the project in the path.
+    attr_accessor :query_cluster_ids
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'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_cluster_ids' => :'Array<String>'
+      }
+    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::ClusterMembershipRequestData` 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::ClusterMembershipRequestData`. 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_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_cluster_ids.nil?
+        invalid_properties.push('invalid value for "query_cluster_ids", query_cluster_ids cannot be nil.')
+      end
+
+      if @query_cluster_ids.length > 100
+        invalid_properties.push('invalid value for "query_cluster_ids", number of items must be less than or equal to 100.')
+      end
+
+      if @query_cluster_ids.length < 1
+        invalid_properties.push('invalid value for "query_cluster_ids", number of items must be greater than or equal to 1.')
+      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_cluster_ids.nil?
+      return false if @query_cluster_ids.length > 100
+      return false if @query_cluster_ids.length < 1
+      true
+    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
+
+      if query_cluster_ids.length > 100
+        fail ArgumentError, 'invalid value for "query_cluster_ids", number of items must be less than or equal to 100.'
+      end
+
+      if query_cluster_ids.length < 1
+        fail ArgumentError, 'invalid value for "query_cluster_ids", number of items must be greater than or equal to 1.'
+      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_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_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/competitor_resource.rb

@@ -0,0 +1,250 @@
+=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
+  # A competitor tracked by a project
+  class CompetitorResource < ApiModelBase
+    attr_accessor :id
+
+    # The competitor's display name
+    attr_accessor :name
+
+    # Domains a result is matched against for this competitor
+    attr_accessor :website_domains
+
+    # Names a mention is matched against for this competitor
+    attr_accessor :brand_names
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'id' => :'id',
+        :'name' => :'name',
+        :'website_domains' => :'websiteDomains',
+        :'brand_names' => :'brandNames'
+      }
+    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
+      {
+        :'id' => :'String',
+        :'name' => :'String',
+        :'website_domains' => :'Array<String>',
+        :'brand_names' => :'Array<String>'
+      }
+    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::CompetitorResource` 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::CompetitorResource`. 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?(:'id')
+        self.id = attributes[:'id']
+      else
+        self.id = nil
+      end
+
+      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?(:'brand_names')
+        if (value = attributes[:'brand_names']).is_a?(Array)
+          self.brand_names = value
+        end
+      else
+        self.brand_names = 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 @id.nil?
+        invalid_properties.push('invalid value for "id", id cannot be nil.')
+      end
+
+      if @name.nil?
+        invalid_properties.push('invalid value for "name", name cannot be nil.')
+      end
+
+      if @website_domains.nil?
+        invalid_properties.push('invalid value for "website_domains", website_domains cannot be nil.')
+      end
+
+      if @brand_names.nil?
+        invalid_properties.push('invalid value for "brand_names", brand_names 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 @id.nil?
+      return false if @name.nil?
+      return false if @website_domains.nil?
+      return false if @brand_names.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] id Value to be assigned
+    def id=(id)
+      if id.nil?
+        fail ArgumentError, 'id cannot be nil'
+      end
+
+      @id = id
+    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
+
+      @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
+
+      @website_domains = website_domains
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] brand_names Value to be assigned
+    def brand_names=(brand_names)
+      if brand_names.nil?
+        fail ArgumentError, 'brand_names cannot be nil'
+      end
+
+      @brand_names = brand_names
+    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 &&
+          id == o.id &&
+          name == o.name &&
+          website_domains == o.website_domains &&
+          brand_names == o.brand_names
+    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
+      [id, name, website_domains, brand_names].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/create_competitor_request.rb

@@ -0,0 +1,247 @@
+=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 CreateCompetitorRequest < ApiModelBase
+    # The competitor's display name
+    attr_accessor :name
+
+    # Domains a result is matched against for this competitor. A full URL or a bare host.
+    attr_accessor :website_domains
+
+    # Names a mention is matched against for this competitor
+    attr_accessor :brand_names
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'name' => :'name',
+        :'website_domains' => :'websiteDomains',
+        :'brand_names' => :'brandNames'
+      }
+    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>',
+        :'brand_names' => :'Array<String>'
+      }
+    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::CreateCompetitorRequest` 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::CreateCompetitorRequest`. 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']
+      end
+
+      if attributes.key?(:'website_domains')
+        if (value = attributes[:'website_domains']).is_a?(Array)
+          self.website_domains = value
+        end
+      end
+
+      if attributes.key?(:'brand_names')
+        if (value = attributes[:'brand_names']).is_a?(Array)
+          self.brand_names = 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 !@name.nil? && @name.to_s.length > 200
+        invalid_properties.push('invalid value for "name", the character length must be smaller than or equal to 200.')
+      end
+
+      if !@website_domains.nil? && @website_domains.length > 100
+        invalid_properties.push('invalid value for "website_domains", number of items must be less than or equal to 100.')
+      end
+
+      if !@website_domains.nil? && @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 !@brand_names.nil? && @brand_names.length > 100
+        invalid_properties.push('invalid value for "brand_names", number of items must be less than or equal to 100.')
+      end
+
+      if !@brand_names.nil? && @brand_names.length < 1
+        invalid_properties.push('invalid value for "brand_names", number of items must be greater than or equal to 1.')
+      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? && @name.to_s.length > 200
+      return false if !@website_domains.nil? && @website_domains.length > 100
+      return false if !@website_domains.nil? && @website_domains.length < 1
+      return false if !@brand_names.nil? && @brand_names.length > 100
+      return false if !@brand_names.nil? && @brand_names.length < 1
+      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 > 200
+        fail ArgumentError, 'invalid value for "name", the character length must be smaller than or equal to 200.'
+      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 > 100
+        fail ArgumentError, 'invalid value for "website_domains", number of items must be less than or equal to 100.'
+      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] brand_names Value to be assigned
+    def brand_names=(brand_names)
+      if brand_names.nil?
+        fail ArgumentError, 'brand_names cannot be nil'
+      end
+
+      if brand_names.length > 100
+        fail ArgumentError, 'invalid value for "brand_names", number of items must be less than or equal to 100.'
+      end
+
+      if brand_names.length < 1
+        fail ArgumentError, 'invalid value for "brand_names", number of items must be greater than or equal to 1.'
+      end
+
+      @brand_names = brand_names
+    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 &&
+          brand_names == o.brand_names
+    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, brand_names].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