algolia 3.0.0.beta.11 → 3.0.0.beta.13

data/lib/algolia/models/ingestion/entity_type.rb

@@ -0,0 +1,32 @@
+# Code generated by OpenAPI Generator (https://openapi-generator.tech), manual changes will be lost - read more on https://github.com/algolia/api-clients-automation. DO NOT EDIT.
+
+require "date"
+require "time"
+
+module Algolia
+  module Ingestion
+    class EntityType
+      PRODUCT = "product".freeze
+      COLLECTION = "collection".freeze
+
+      def self.all_vars
+        @all_vars ||= [PRODUCT, COLLECTION].freeze
+      end
+
+      # Builds the enum from string
+      # @param [String] The enum value in the form of the string
+      # @return [String] The enum value
+      def self.build_from_hash(value)
+        new.build_from_hash(value)
+      end
+
+      # Builds the enum from string
+      # @param [String] The enum value in the form of the string
+      # @return [String] The enum value
+      def build_from_hash(value)
+        return value if EntityType.all_vars.include?(value)
+        raise "Invalid ENUM value #{value} for class #EntityType"
+      end
+    end
+  end
+end

data/lib/algolia/models/ingestion/{destination_index_prefix.rb → model.rb}

@@ -5,14 +5,25 @@ require "time"
 
 module Algolia
   module Ingestion
-    class DestinationIndexPrefix
-      # String added to the beginning of all indices created by this destination.
-      attr_accessor :index_prefix
+    class Model
+      attr_accessor :fullname
+
+      attr_accessor :model_name
+
+      attr_accessor :system_prompt
+
+      attr_accessor :id
+
+      attr_accessor :provider
 
       # Attribute mapping from ruby-style variable name to JSON key.
       def self.attribute_map
         {
-          :index_prefix => :indexPrefix
+          :fullname => :fullname,
+          :model_name => :modelName,
+          :system_prompt => :systemPrompt,
+          :id => :id,
+          :provider => :provider
         }
       end
 
@@ -24,7 +35,11 @@ module Algolia
       # Attribute type mapping.
       def self.types_mapping
         {
-          :index_prefix => :"String"
+          :fullname => :"String",
+          :model_name => :"String",
+          :system_prompt => :"String",
+          :id => :"String",
+          :provider => :"String"
         }
       end
 
@@ -39,10 +54,7 @@ module Algolia
       # @param [Hash] attributes Model attributes in the form of hash
       def initialize(attributes = {})
         if (!attributes.is_a?(Hash))
-          raise(
-            ArgumentError,
-            "The input argument (attributes) must be a hash in `Algolia::DestinationIndexPrefix` initialize method"
-          )
+          raise ArgumentError, "The input argument (attributes) must be a hash in `Algolia::Model` initialize method"
         end
 
         # check to see if the attribute exists and convert string to symbol for hash key
@@ -50,7 +62,7 @@ module Algolia
           if (!self.class.attribute_map.key?(k.to_sym))
             raise(
               ArgumentError,
-              "`#{k}` is not a valid attribute in `Algolia::DestinationIndexPrefix`. Please check the name to make sure it's valid. List of attributes: " +
+              "`#{k}` is not a valid attribute in `Algolia::Model`. Please check the name to make sure it's valid. List of attributes: " +
                 self.class.attribute_map.keys.inspect
             )
           end
@@ -58,10 +70,34 @@ module Algolia
           h[k.to_sym] = v
         }
 
-        if attributes.key?(:index_prefix)
-          self.index_prefix = attributes[:index_prefix]
+        if attributes.key?(:fullname)
+          self.fullname = attributes[:fullname]
+        else
+          self.fullname = nil
+        end
+
+        if attributes.key?(:model_name)
+          self.model_name = attributes[:model_name]
+        else
+          self.model_name = nil
+        end
+
+        if attributes.key?(:system_prompt)
+          self.system_prompt = attributes[:system_prompt]
+        else
+          self.system_prompt = nil
+        end
+
+        if attributes.key?(:id)
+          self.id = attributes[:id]
+        else
+          self.id = nil
+        end
+
+        if attributes.key?(:provider)
+          self.provider = attributes[:provider]
         else
-          self.index_prefix = nil
+          self.provider = nil
         end
       end
 
@@ -70,7 +106,11 @@ module Algolia
       def ==(other)
         return true if self.equal?(other)
         self.class == other.class &&
-          index_prefix == other.index_prefix
+          fullname == other.fullname &&
+          model_name == other.model_name &&
+          system_prompt == other.system_prompt &&
+          id == other.id &&
+          provider == other.provider
       end
 
       # @see the `==` method
@@ -82,7 +122,7 @@ module Algolia
       # Calculates hash code according to all attributes.
       # @return [Integer] Hash code
       def hash
-        [index_prefix].hash
+        [fullname, model_name, system_prompt, id, provider].hash
       end
 
       # Builds the object from hash

data/lib/algolia/models/{recommend/trending_items.rb → ingestion/run_source_payload.rb}

@@ -4,17 +4,18 @@ require "date"
 require "time"
 
 module Algolia
-  module Recommend
-    class TrendingItems
-      # Facet attribute. To be used in combination with `facetValue`. If specified, only recommendations matching the facet filter will be returned.
-      attr_accessor :facet_name
+  module Ingestion
+    class RunSourcePayload
+      # List of index names to include in reidexing/update.
+      attr_accessor :index_to_include
 
-      # Facet value. To be used in combination with `facetName`. If specified, only recommendations matching the facet filter will be returned.
-      attr_accessor :facet_value
+      # List of index names to exclude in reidexing/update.
+      attr_accessor :index_to_exclude
 
-      attr_accessor :model
+      # List of entityID to update.
+      attr_accessor :entity_ids
 
-      attr_accessor :fallback_parameters
+      attr_accessor :entity_type
 
       class EnumAttributeValidator
         attr_reader :datatype
@@ -41,10 +42,10 @@ module Algolia
       # Attribute mapping from ruby-style variable name to JSON key.
       def self.attribute_map
         {
-          :facet_name => :facetName,
-          :facet_value => :facetValue,
-          :model => :model,
-          :fallback_parameters => :fallbackParameters
+          :index_to_include => :indexToInclude,
+          :index_to_exclude => :indexToExclude,
+          :entity_ids => :entityIDs,
+          :entity_type => :entityType
         }
       end
 
@@ -56,10 +57,10 @@ module Algolia
       # Attribute type mapping.
       def self.types_mapping
         {
-          :facet_name => :"String",
-          :facet_value => :"String",
-          :model => :"TrendingItemsModel",
-          :fallback_parameters => :"SearchParamsObject"
+          :index_to_include => :"Array<String>",
+          :index_to_exclude => :"Array<String>",
+          :entity_ids => :"Array<String>",
+          :entity_type => :"EntityType"
         }
       end
 
@@ -76,7 +77,7 @@ module Algolia
         if (!attributes.is_a?(Hash))
           raise(
             ArgumentError,
-            "The input argument (attributes) must be a hash in `Algolia::TrendingItems` initialize method"
+            "The input argument (attributes) must be a hash in `Algolia::RunSourcePayload` initialize method"
           )
         end
 
@@ -85,7 +86,7 @@ module Algolia
           if (!self.class.attribute_map.key?(k.to_sym))
             raise(
               ArgumentError,
-              "`#{k}` is not a valid attribute in `Algolia::TrendingItems`. Please check the name to make sure it's valid. List of attributes: " +
+              "`#{k}` is not a valid attribute in `Algolia::RunSourcePayload`. Please check the name to make sure it's valid. List of attributes: " +
                 self.class.attribute_map.keys.inspect
             )
           end
@@ -93,22 +94,26 @@ module Algolia
           h[k.to_sym] = v
         }
 
-        if attributes.key?(:facet_name)
-          self.facet_name = attributes[:facet_name]
+        if attributes.key?(:index_to_include)
+          if (value = attributes[:index_to_include]).is_a?(Array)
+            self.index_to_include = value
+          end
         end
 
-        if attributes.key?(:facet_value)
-          self.facet_value = attributes[:facet_value]
+        if attributes.key?(:index_to_exclude)
+          if (value = attributes[:index_to_exclude]).is_a?(Array)
+            self.index_to_exclude = value
+          end
         end
 
-        if attributes.key?(:model)
-          self.model = attributes[:model]
-        else
-          self.model = nil
+        if attributes.key?(:entity_ids)
+          if (value = attributes[:entity_ids]).is_a?(Array)
+            self.entity_ids = value
+          end
         end
 
-        if attributes.key?(:fallback_parameters)
-          self.fallback_parameters = attributes[:fallback_parameters]
+        if attributes.key?(:entity_type)
+          self.entity_type = attributes[:entity_type]
         end
       end
 
@@ -117,10 +122,10 @@ module Algolia
       def ==(other)
         return true if self.equal?(other)
         self.class == other.class &&
-          facet_name == other.facet_name &&
-          facet_value == other.facet_value &&
-          model == other.model &&
-          fallback_parameters == other.fallback_parameters
+          index_to_include == other.index_to_include &&
+          index_to_exclude == other.index_to_exclude &&
+          entity_ids == other.entity_ids &&
+          entity_type == other.entity_type
       end
 
       # @see the `==` method
@@ -132,7 +137,7 @@ module Algolia
       # Calculates hash code according to all attributes.
       # @return [Integer] Hash code
       def hash
-        [facet_name, facet_value, model, fallback_parameters].hash
+        [index_to_include, index_to_exclude, entity_ids, entity_type].hash
       end
 
       # Builds the object from hash
@@ -201,7 +206,7 @@ module Algolia
           # model
         else
           # models (e.g. Pet) or oneOf
-          klass = Algolia::Recommend.const_get(type)
+          klass = Algolia::Ingestion.const_get(type)
           klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass
             .build_from_hash(value)
         end

data/lib/algolia/models/{search/base_get_api_key_response.rb → ingestion/run_source_response.rb}

@@ -4,18 +4,18 @@ require "date"
 require "time"
 
 module Algolia
-  module Search
-    class BaseGetApiKeyResponse
-      # API key.
-      attr_accessor :value
+  module Ingestion
+    class RunSourceResponse
+      # Map of taskID sent for reindex with the corresponding runID.
+      attr_accessor :task_with_run_id
 
-      # Timestamp when the object was created, in milliseconds since the Unix epoch.
+      # Date of creation in RFC 3339 format.
       attr_accessor :created_at
 
       # Attribute mapping from ruby-style variable name to JSON key.
       def self.attribute_map
         {
-          :value => :value,
+          :task_with_run_id => :taskWithRunID,
           :created_at => :createdAt
         }
       end
@@ -28,8 +28,8 @@ module Algolia
       # Attribute type mapping.
       def self.types_mapping
         {
-          :value => :"String",
-          :created_at => :"Integer"
+          :task_with_run_id => :"Hash<String, String>",
+          :created_at => :"String"
         }
       end
 
@@ -46,7 +46,7 @@ module Algolia
         if (!attributes.is_a?(Hash))
           raise(
             ArgumentError,
-            "The input argument (attributes) must be a hash in `Algolia::BaseGetApiKeyResponse` initialize method"
+            "The input argument (attributes) must be a hash in `Algolia::RunSourceResponse` initialize method"
           )
         end
 
@@ -55,7 +55,7 @@ module Algolia
           if (!self.class.attribute_map.key?(k.to_sym))
             raise(
               ArgumentError,
-              "`#{k}` is not a valid attribute in `Algolia::BaseGetApiKeyResponse`. Please check the name to make sure it's valid. List of attributes: " +
+              "`#{k}` is not a valid attribute in `Algolia::RunSourceResponse`. Please check the name to make sure it's valid. List of attributes: " +
                 self.class.attribute_map.keys.inspect
             )
           end
@@ -63,8 +63,12 @@ module Algolia
           h[k.to_sym] = v
         }
 
-        if attributes.key?(:value)
-          self.value = attributes[:value]
+        if attributes.key?(:task_with_run_id)
+          if (value = attributes[:task_with_run_id]).is_a?(Hash)
+            self.task_with_run_id = value
+          end
+        else
+          self.task_with_run_id = nil
         end
 
         if attributes.key?(:created_at)
@@ -79,7 +83,7 @@ module Algolia
       def ==(other)
         return true if self.equal?(other)
         self.class == other.class &&
-          value == other.value &&
+          task_with_run_id == other.task_with_run_id &&
           created_at == other.created_at
       end
 
@@ -92,7 +96,7 @@ module Algolia
       # Calculates hash code according to all attributes.
       # @return [Integer] Hash code
       def hash
-        [value, created_at].hash
+        [task_with_run_id, created_at].hash
       end
 
       # Builds the object from hash
@@ -161,7 +165,7 @@ module Algolia
           # model
         else
           # models (e.g. Pet) or oneOf
-          klass = Algolia::Search.const_get(type)
+          klass = Algolia::Ingestion.const_get(type)
           klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass
             .build_from_hash(value)
         end

data/lib/algolia/models/ingestion/{transformation_try_response_error.rb → transformation_error.rb}

@@ -6,7 +6,7 @@ require "time"
 module Algolia
   module Ingestion
     # The error if the transformation failed.
-    class TransformationTryResponseError
+    class TransformationError
       # The error status code.
       attr_accessor :code
 
@@ -47,7 +47,7 @@ module Algolia
         if (!attributes.is_a?(Hash))
           raise(
             ArgumentError,
-            "The input argument (attributes) must be a hash in `Algolia::TransformationTryResponseError` initialize method"
+            "The input argument (attributes) must be a hash in `Algolia::TransformationError` initialize method"
           )
         end
 
@@ -56,7 +56,7 @@ module Algolia
           if (!self.class.attribute_map.key?(k.to_sym))
             raise(
               ArgumentError,
-              "`#{k}` is not a valid attribute in `Algolia::TransformationTryResponseError`. Please check the name to make sure it's valid. List of attributes: " +
+              "`#{k}` is not a valid attribute in `Algolia::TransformationError`. Please check the name to make sure it's valid. List of attributes: " +
                 self.class.attribute_map.keys.inspect
             )
           end

data/lib/algolia/models/ingestion/{source_shopify_base.rb → transformation_models.rb}

@@ -5,14 +5,14 @@ require "time"
 
 module Algolia
   module Ingestion
-    class SourceShopifyBase
-      # URL of the Shopify store.
-      attr_accessor :shop_url
+    # List of available AI models for transformation purposes.
+    class TransformationModels
+      attr_accessor :llms
 
       # Attribute mapping from ruby-style variable name to JSON key.
       def self.attribute_map
         {
-          :shop_url => :shopURL
+          :llms => :llms
         }
       end
 
@@ -24,7 +24,7 @@ module Algolia
       # Attribute type mapping.
       def self.types_mapping
         {
-          :shop_url => :"String"
+          :llms => :"Array<Model>"
         }
       end
 
@@ -41,7 +41,7 @@ module Algolia
         if (!attributes.is_a?(Hash))
           raise(
             ArgumentError,
-            "The input argument (attributes) must be a hash in `Algolia::SourceShopifyBase` initialize method"
+            "The input argument (attributes) must be a hash in `Algolia::TransformationModels` initialize method"
           )
         end
 
@@ -50,7 +50,7 @@ module Algolia
           if (!self.class.attribute_map.key?(k.to_sym))
             raise(
               ArgumentError,
-              "`#{k}` is not a valid attribute in `Algolia::SourceShopifyBase`. Please check the name to make sure it's valid. List of attributes: " +
+              "`#{k}` is not a valid attribute in `Algolia::TransformationModels`. Please check the name to make sure it's valid. List of attributes: " +
                 self.class.attribute_map.keys.inspect
             )
           end
@@ -58,10 +58,12 @@ module Algolia
           h[k.to_sym] = v
         }
 
-        if attributes.key?(:shop_url)
-          self.shop_url = attributes[:shop_url]
+        if attributes.key?(:llms)
+          if (value = attributes[:llms]).is_a?(Array)
+            self.llms = value
+          end
         else
-          self.shop_url = nil
+          self.llms = nil
         end
       end
 
@@ -70,7 +72,7 @@ module Algolia
       def ==(other)
         return true if self.equal?(other)
         self.class == other.class &&
-          shop_url == other.shop_url
+          llms == other.llms
       end
 
       # @see the `==` method
@@ -82,7 +84,7 @@ module Algolia
       # Calculates hash code according to all attributes.
       # @return [Integer] Hash code
       def hash
-        [shop_url].hash
+        [llms].hash
       end
 
       # Builds the object from hash

data/lib/algolia/models/ingestion/transformation_try_response.rb

@@ -28,7 +28,7 @@ module Algolia
       def self.types_mapping
         {
           :payloads => :"Array<Object>",
-          :error => :"TransformationTryResponseError"
+          :error => :"TransformationError"
         }
       end
 

data/lib/algolia/models/monitoring/{incidents_inner.rb → incident_entry.rb}

@@ -5,7 +5,7 @@ require "time"
 
 module Algolia
   module Monitoring
-    class IncidentsInner
+    class IncidentEntry
       # Timestamp, measured in milliseconds since the Unix epoch.
       attr_accessor :t
 
@@ -45,7 +45,7 @@ module Algolia
         if (!attributes.is_a?(Hash))
           raise(
             ArgumentError,
-            "The input argument (attributes) must be a hash in `Algolia::IncidentsInner` initialize method"
+            "The input argument (attributes) must be a hash in `Algolia::IncidentEntry` initialize method"
           )
         end
 
@@ -54,7 +54,7 @@ module Algolia
           if (!self.class.attribute_map.key?(k.to_sym))
             raise(
               ArgumentError,
-              "`#{k}` is not a valid attribute in `Algolia::IncidentsInner`. Please check the name to make sure it's valid. List of attributes: " +
+              "`#{k}` is not a valid attribute in `Algolia::IncidentEntry`. Please check the name to make sure it's valid. List of attributes: " +
                 self.class.attribute_map.keys.inspect
             )
           end

data/lib/algolia/models/monitoring/{indexing_time_response_metrics.rb → indexing_metric.rb}

@@ -5,7 +5,7 @@ require "time"
 
 module Algolia
   module Monitoring
-    class IndexingTimeResponseMetrics
+    class IndexingMetric
       attr_accessor :indexing
 
       # Attribute mapping from ruby-style variable name to JSON key.
@@ -40,7 +40,7 @@ module Algolia
         if (!attributes.is_a?(Hash))
           raise(
             ArgumentError,
-            "The input argument (attributes) must be a hash in `Algolia::IndexingTimeResponseMetrics` initialize method"
+            "The input argument (attributes) must be a hash in `Algolia::IndexingMetric` initialize method"
           )
         end
 
@@ -49,7 +49,7 @@ module Algolia
           if (!self.class.attribute_map.key?(k.to_sym))
             raise(
               ArgumentError,
-              "`#{k}` is not a valid attribute in `Algolia::IndexingTimeResponseMetrics`. Please check the name to make sure it's valid. List of attributes: " +
+              "`#{k}` is not a valid attribute in `Algolia::IndexingMetric`. Please check the name to make sure it's valid. List of attributes: " +
                 self.class.attribute_map.keys.inspect
             )
           end

data/lib/algolia/models/monitoring/indexing_time_response.rb

@@ -23,7 +23,7 @@ module Algolia
       # Attribute type mapping.
       def self.types_mapping
         {
-          :metrics => :"IndexingTimeResponseMetrics"
+          :metrics => :"IndexingMetric"
         }
       end
 

data/lib/algolia/models/monitoring/infrastructure_response.rb

@@ -23,7 +23,7 @@ module Algolia
       # Attribute type mapping.
       def self.types_mapping
         {
-          :metrics => :"InfrastructureResponseMetrics"
+          :metrics => :"Metrics"
         }
       end
 

data/lib/algolia/models/monitoring/{latency_response_metrics.rb → latency_metric.rb}

@@ -5,7 +5,7 @@ require "time"
 
 module Algolia
   module Monitoring
-    class LatencyResponseMetrics
+    class LatencyMetric
       attr_accessor :latency
 
       # Attribute mapping from ruby-style variable name to JSON key.
@@ -40,7 +40,7 @@ module Algolia
         if (!attributes.is_a?(Hash))
           raise(
             ArgumentError,
-            "The input argument (attributes) must be a hash in `Algolia::LatencyResponseMetrics` initialize method"
+            "The input argument (attributes) must be a hash in `Algolia::LatencyMetric` initialize method"
           )
         end
 
@@ -49,7 +49,7 @@ module Algolia
           if (!self.class.attribute_map.key?(k.to_sym))
             raise(
               ArgumentError,
-              "`#{k}` is not a valid attribute in `Algolia::LatencyResponseMetrics`. Please check the name to make sure it's valid. List of attributes: " +
+              "`#{k}` is not a valid attribute in `Algolia::LatencyMetric`. Please check the name to make sure it's valid. List of attributes: " +
                 self.class.attribute_map.keys.inspect
             )
           end

data/lib/algolia/models/monitoring/latency_response.rb

@@ -23,7 +23,7 @@ module Algolia
       # Attribute type mapping.
       def self.types_mapping
         {
-          :metrics => :"LatencyResponseMetrics"
+          :metrics => :"LatencyMetric"
         }
       end
 

data/lib/algolia/models/monitoring/{infrastructure_response_metrics.rb → metrics.rb}

@@ -5,7 +5,7 @@ require "time"
 
 module Algolia
   module Monitoring
-    class InfrastructureResponseMetrics
+    class Metrics
       # CPU idleness in %.
       attr_accessor :cpu_usage
 
@@ -59,10 +59,7 @@ module Algolia
       # @param [Hash] attributes Model attributes in the form of hash
       def initialize(attributes = {})
         if (!attributes.is_a?(Hash))
-          raise(
-            ArgumentError,
-            "The input argument (attributes) must be a hash in `Algolia::InfrastructureResponseMetrics` initialize method"
-          )
+          raise ArgumentError, "The input argument (attributes) must be a hash in `Algolia::Metrics` initialize method"
         end
 
         # check to see if the attribute exists and convert string to symbol for hash key
@@ -70,7 +67,7 @@ module Algolia
           if (!self.class.attribute_map.key?(k.to_sym))
             raise(
               ArgumentError,
-              "`#{k}` is not a valid attribute in `Algolia::InfrastructureResponseMetrics`. Please check the name to make sure it's valid. List of attributes: " +
+              "`#{k}` is not a valid attribute in `Algolia::Metrics`. Please check the name to make sure it's valid. List of attributes: " +
                 self.class.attribute_map.keys.inspect
             )
           end