algolia 3.0.0.beta.10 → 3.0.0.beta.12

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

@@ -15,7 +15,14 @@ module Algolia
       # Universally unique identifier (UUID) of a destination resource.
       attr_accessor :destination_id
 
-      attr_accessor :trigger
+      # Cron expression for the task's schedule.
+      attr_accessor :cron
+
+      # The last time the scheduled task ran in RFC 3339 format.
+      attr_accessor :last_run
+
+      # The next scheduled run of the task in RFC 3339 format.
+      attr_accessor :next_run
 
       attr_accessor :input
 
@@ -64,7 +71,9 @@ module Algolia
           :task_id => :taskID,
           :source_id => :sourceID,
           :destination_id => :destinationID,
-          :trigger => :trigger,
+          :cron => :cron,
+          :last_run => :lastRun,
+          :next_run => :nextRun,
           :input => :input,
           :enabled => :enabled,
           :failure_threshold => :failureThreshold,
@@ -86,7 +95,9 @@ module Algolia
           :task_id => :"String",
           :source_id => :"String",
           :destination_id => :"String",
-          :trigger => :"Trigger",
+          :cron => :"String",
+          :last_run => :"String",
+          :next_run => :"String",
           :input => :"TaskInput",
           :enabled => :"Boolean",
           :failure_threshold => :"Integer",
@@ -142,10 +153,16 @@ module Algolia
           self.destination_id = nil
         end
 
-        if attributes.key?(:trigger)
-          self.trigger = attributes[:trigger]
-        else
-          self.trigger = nil
+        if attributes.key?(:cron)
+          self.cron = attributes[:cron]
+        end
+
+        if attributes.key?(:last_run)
+          self.last_run = attributes[:last_run]
+        end
+
+        if attributes.key?(:next_run)
+          self.next_run = attributes[:next_run]
         end
 
         if attributes.key?(:input)
@@ -209,7 +226,9 @@ module Algolia
           task_id == other.task_id &&
           source_id == other.source_id &&
           destination_id == other.destination_id &&
-          trigger == other.trigger &&
+          cron == other.cron &&
+          last_run == other.last_run &&
+          next_run == other.next_run &&
           input == other.input &&
           enabled == other.enabled &&
           failure_threshold == other.failure_threshold &&
@@ -232,7 +251,9 @@ module Algolia
           task_id,
           source_id,
           destination_id,
-          trigger,
+          cron,
+          last_run,
+          next_run,
           input,
           enabled,
           failure_threshold,

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

@@ -13,10 +13,11 @@ module Algolia
       # Universally unique identifier (UUID) of a destination resource.
       attr_accessor :destination_id
 
-      attr_accessor :trigger
-
       attr_accessor :action
 
+      # Cron expression for the task's schedule.
+      attr_accessor :cron
+
       # Whether the task is enabled.
       attr_accessor :enabled
 
@@ -55,8 +56,8 @@ module Algolia
         {
           :source_id => :sourceID,
           :destination_id => :destinationID,
-          :trigger => :trigger,
           :action => :action,
+          :cron => :cron,
           :enabled => :enabled,
           :failure_threshold => :failureThreshold,
           :input => :input,
@@ -74,8 +75,8 @@ module Algolia
         {
           :source_id => :"String",
           :destination_id => :"String",
-          :trigger => :"TaskCreateTrigger",
           :action => :"ActionType",
+          :cron => :"String",
           :enabled => :"Boolean",
           :failure_threshold => :"Integer",
           :input => :"TaskInput",
@@ -125,18 +126,16 @@ module Algolia
           self.destination_id = nil
         end
 
-        if attributes.key?(:trigger)
-          self.trigger = attributes[:trigger]
-        else
-          self.trigger = nil
-        end
-
         if attributes.key?(:action)
           self.action = attributes[:action]
         else
           self.action = nil
         end
 
+        if attributes.key?(:cron)
+          self.cron = attributes[:cron]
+        end
+
         if attributes.key?(:enabled)
           self.enabled = attributes[:enabled]
         end
@@ -179,8 +178,8 @@ module Algolia
         self.class == other.class &&
           source_id == other.source_id &&
           destination_id == other.destination_id &&
-          trigger == other.trigger &&
           action == other.action &&
+          cron == other.cron &&
           enabled == other.enabled &&
           failure_threshold == other.failure_threshold &&
           input == other.input &&
@@ -196,7 +195,7 @@ module Algolia
       # Calculates hash code according to all attributes.
       # @return [Integer] Hash code
       def hash
-        [source_id, destination_id, trigger, action, enabled, failure_threshold, input, cursor].hash
+        [source_id, destination_id, action, cron, enabled, failure_threshold, input, cursor].hash
       end
 
       # Builds the object from hash

data/lib/algolia/models/{search/search_for_facets_options.rb → ingestion/task_create_v1.rb}

@@ -4,21 +4,29 @@ require "date"
 require "time"
 
 module Algolia
-  module Search
-    class SearchForFacetsOptions
-      # Facet name.
-      attr_accessor :facet
+  module Ingestion
+    # API request body for creating a task using the V1 shape, please use methods and types that don't contain the V1 suffix.
+    class TaskCreateV1
+      # Universally uniqud identifier (UUID) of a source.
+      attr_accessor :source_id
 
-      # Index name (case-sensitive).
-      attr_accessor :index_name
+      # Universally unique identifier (UUID) of a destination resource.
+      attr_accessor :destination_id
 
-      # Text to search inside the facet's values.
-      attr_accessor :facet_query
+      attr_accessor :trigger
 
-      # Maximum number of facet values to return when [searching for facet values](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/#search-for-facet-values).
-      attr_accessor :max_facet_hits
+      attr_accessor :action
 
-      attr_accessor :type
+      # Whether the task is enabled.
+      attr_accessor :enabled
+
+      # Maximum accepted percentage of failures for a task run to finish successfully.
+      attr_accessor :failure_threshold
+
+      attr_accessor :input
+
+      # Date of the last cursor in RFC 3339 format.
+      attr_accessor :cursor
 
       class EnumAttributeValidator
         attr_reader :datatype
@@ -45,11 +53,14 @@ module Algolia
       # Attribute mapping from ruby-style variable name to JSON key.
       def self.attribute_map
         {
-          :facet => :facet,
-          :index_name => :indexName,
-          :facet_query => :facetQuery,
-          :max_facet_hits => :maxFacetHits,
-          :type => :type
+          :source_id => :sourceID,
+          :destination_id => :destinationID,
+          :trigger => :trigger,
+          :action => :action,
+          :enabled => :enabled,
+          :failure_threshold => :failureThreshold,
+          :input => :input,
+          :cursor => :cursor
         }
       end
 
@@ -61,11 +72,14 @@ module Algolia
       # Attribute type mapping.
       def self.types_mapping
         {
-          :facet => :"String",
-          :index_name => :"String",
-          :facet_query => :"String",
-          :max_facet_hits => :"Integer",
-          :type => :"SearchTypeFacet"
+          :source_id => :"String",
+          :destination_id => :"String",
+          :trigger => :"TaskCreateTrigger",
+          :action => :"ActionType",
+          :enabled => :"Boolean",
+          :failure_threshold => :"Integer",
+          :input => :"TaskInput",
+          :cursor => :"String"
         }
       end
 
@@ -82,7 +96,7 @@ module Algolia
         if (!attributes.is_a?(Hash))
           raise(
             ArgumentError,
-            "The input argument (attributes) must be a hash in `Algolia::SearchForFacetsOptions` initialize method"
+            "The input argument (attributes) must be a hash in `Algolia::TaskCreateV1` initialize method"
           )
         end
 
@@ -91,7 +105,7 @@ module Algolia
           if (!self.class.attribute_map.key?(k.to_sym))
             raise(
               ArgumentError,
-              "`#{k}` is not a valid attribute in `Algolia::SearchForFacetsOptions`. Please check the name to make sure it's valid. List of attributes: " +
+              "`#{k}` is not a valid attribute in `Algolia::TaskCreateV1`. Please check the name to make sure it's valid. List of attributes: " +
                 self.class.attribute_map.keys.inspect
             )
           end
@@ -99,45 +113,63 @@ module Algolia
           h[k.to_sym] = v
         }
 
-        if attributes.key?(:facet)
-          self.facet = attributes[:facet]
+        if attributes.key?(:source_id)
+          self.source_id = attributes[:source_id]
         else
-          self.facet = nil
+          self.source_id = nil
         end
 
-        if attributes.key?(:index_name)
-          self.index_name = attributes[:index_name]
+        if attributes.key?(:destination_id)
+          self.destination_id = attributes[:destination_id]
         else
-          self.index_name = nil
+          self.destination_id = nil
         end
 
-        if attributes.key?(:facet_query)
-          self.facet_query = attributes[:facet_query]
+        if attributes.key?(:trigger)
+          self.trigger = attributes[:trigger]
+        else
+          self.trigger = nil
         end
 
-        if attributes.key?(:max_facet_hits)
-          self.max_facet_hits = attributes[:max_facet_hits]
+        if attributes.key?(:action)
+          self.action = attributes[:action]
+        else
+          self.action = nil
         end
 
-        if attributes.key?(:type)
-          self.type = attributes[:type]
-        else
-          self.type = nil
+        if attributes.key?(:enabled)
+          self.enabled = attributes[:enabled]
+        end
+
+        if attributes.key?(:failure_threshold)
+          self.failure_threshold = attributes[:failure_threshold]
+        end
+
+        if attributes.key?(:input)
+          self.input = attributes[:input]
+        end
+
+        if attributes.key?(:cursor)
+          self.cursor = attributes[:cursor]
         end
       end
 
       # Custom attribute writer method with validation
-      # @param [Object] max_facet_hits Value to be assigned
-      def max_facet_hits=(max_facet_hits)
-        if max_facet_hits.nil?
-          raise ArgumentError, "max_facet_hits cannot be nil"
+      # @param [Object] failure_threshold Value to be assigned
+      def failure_threshold=(failure_threshold)
+        if failure_threshold.nil?
+          raise ArgumentError, "failure_threshold cannot be nil"
+        end
+
+        if failure_threshold > 100
+          raise ArgumentError, "invalid value for \"failure_threshold\", must be smaller than or equal to 100."
         end
 
-        if max_facet_hits > 100
-          raise ArgumentError, "invalid value for \"max_facet_hits\", must be smaller than or equal to 100."
+        if failure_threshold < 0
+          raise ArgumentError, "invalid value for \"failure_threshold\", must be greater than or equal to 0."
         end
 
-        @max_facet_hits = max_facet_hits
+        @failure_threshold = failure_threshold
       end
 
       # Checks equality by comparing each attribute.
@@ -145,11 +177,14 @@ module Algolia
       def ==(other)
         return true if self.equal?(other)
         self.class == other.class &&
-          facet == other.facet &&
-          index_name == other.index_name &&
-          facet_query == other.facet_query &&
-          max_facet_hits == other.max_facet_hits &&
-          type == other.type
+          source_id == other.source_id &&
+          destination_id == other.destination_id &&
+          trigger == other.trigger &&
+          action == other.action &&
+          enabled == other.enabled &&
+          failure_threshold == other.failure_threshold &&
+          input == other.input &&
+          cursor == other.cursor
       end
 
       # @see the `==` method
@@ -161,7 +196,7 @@ module Algolia
       # Calculates hash code according to all attributes.
       # @return [Integer] Hash code
       def hash
-        [facet, index_name, facet_query, max_facet_hits, type].hash
+        [source_id, destination_id, trigger, action, enabled, failure_threshold, input, cursor].hash
       end
 
       # Builds the object from hash
@@ -230,7 +265,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/task_update.rb

@@ -10,7 +10,8 @@ module Algolia
       # Universally unique identifier (UUID) of a destination resource.
       attr_accessor :destination_id
 
-      attr_accessor :trigger
+      # Cron expression for the task's schedule.
+      attr_accessor :cron
 
       attr_accessor :input
 
@@ -24,7 +25,7 @@ module Algolia
       def self.attribute_map
         {
           :destination_id => :destinationID,
-          :trigger => :trigger,
+          :cron => :cron,
           :input => :input,
           :enabled => :enabled,
           :failure_threshold => :failureThreshold
@@ -40,7 +41,7 @@ module Algolia
       def self.types_mapping
         {
           :destination_id => :"String",
-          :trigger => :"TriggerUpdateInput",
+          :cron => :"String",
           :input => :"TaskInput",
           :enabled => :"Boolean",
           :failure_threshold => :"Integer"
@@ -81,8 +82,8 @@ module Algolia
           self.destination_id = attributes[:destination_id]
         end
 
-        if attributes.key?(:trigger)
-          self.trigger = attributes[:trigger]
+        if attributes.key?(:cron)
+          self.cron = attributes[:cron]
         end
 
         if attributes.key?(:input)
@@ -122,7 +123,7 @@ module Algolia
         return true if self.equal?(other)
         self.class == other.class &&
           destination_id == other.destination_id &&
-          trigger == other.trigger &&
+          cron == other.cron &&
           input == other.input &&
           enabled == other.enabled &&
           failure_threshold == other.failure_threshold
@@ -137,7 +138,7 @@ module Algolia
       # Calculates hash code according to all attributes.
       # @return [Integer] Hash code
       def hash
-        [destination_id, trigger, input, enabled, failure_threshold].hash
+        [destination_id, cron, input, enabled, failure_threshold].hash
       end
 
       # Builds the object from hash

data/lib/algolia/models/{search/browse_pagination.rb → ingestion/task_update_v1.rb}

@@ -4,27 +4,30 @@ require "date"
 require "time"
 
 module Algolia
-  module Search
-    class BrowsePagination
-      # Page of search results to retrieve.
-      attr_accessor :page
+  module Ingestion
+    # API request body for updating a task using the V1 shape, please use methods and types that don't contain the V1 suffix.
+    class TaskUpdateV1
+      # Universally unique identifier (UUID) of a destination resource.
+      attr_accessor :destination_id
 
-      # Number of results (hits).
-      attr_accessor :nb_hits
+      attr_accessor :trigger
 
-      # Number of pages of results.
-      attr_accessor :nb_pages
+      attr_accessor :input
 
-      # Number of hits per page.
-      attr_accessor :hits_per_page
+      # Whether the task is enabled.
+      attr_accessor :enabled
+
+      # Maximum accepted percentage of failures for a task run to finish successfully.
+      attr_accessor :failure_threshold
 
       # Attribute mapping from ruby-style variable name to JSON key.
       def self.attribute_map
         {
-          :page => :page,
-          :nb_hits => :nbHits,
-          :nb_pages => :nbPages,
-          :hits_per_page => :hitsPerPage
+          :destination_id => :destinationID,
+          :trigger => :trigger,
+          :input => :input,
+          :enabled => :enabled,
+          :failure_threshold => :failureThreshold
         }
       end
 
@@ -36,10 +39,11 @@ module Algolia
       # Attribute type mapping.
       def self.types_mapping
         {
-          :page => :"Integer",
-          :nb_hits => :"Integer",
-          :nb_pages => :"Integer",
-          :hits_per_page => :"Integer"
+          :destination_id => :"String",
+          :trigger => :"TriggerUpdateInput",
+          :input => :"TaskInput",
+          :enabled => :"Boolean",
+          :failure_threshold => :"Integer"
         }
       end
 
@@ -56,7 +60,7 @@ module Algolia
         if (!attributes.is_a?(Hash))
           raise(
             ArgumentError,
-            "The input argument (attributes) must be a hash in `Algolia::BrowsePagination` initialize method"
+            "The input argument (attributes) must be a hash in `Algolia::TaskUpdateV1` initialize method"
           )
         end
 
@@ -65,7 +69,7 @@ module Algolia
           if (!self.class.attribute_map.key?(k.to_sym))
             raise(
               ArgumentError,
-              "`#{k}` is not a valid attribute in `Algolia::BrowsePagination`. Please check the name to make sure it's valid. List of attributes: " +
+              "`#{k}` is not a valid attribute in `Algolia::TaskUpdateV1`. Please check the name to make sure it's valid. List of attributes: " +
                 self.class.attribute_map.keys.inspect
             )
           end
@@ -73,53 +77,43 @@ module Algolia
           h[k.to_sym] = v
         }
 
-        if attributes.key?(:page)
-          self.page = attributes[:page]
-        end
-
-        if attributes.key?(:nb_hits)
-          self.nb_hits = attributes[:nb_hits]
+        if attributes.key?(:destination_id)
+          self.destination_id = attributes[:destination_id]
         end
 
-        if attributes.key?(:nb_pages)
-          self.nb_pages = attributes[:nb_pages]
+        if attributes.key?(:trigger)
+          self.trigger = attributes[:trigger]
         end
 
-        if attributes.key?(:hits_per_page)
-          self.hits_per_page = attributes[:hits_per_page]
+        if attributes.key?(:input)
+          self.input = attributes[:input]
         end
-      end
 
-      # Custom attribute writer method with validation
-      # @param [Object] page Value to be assigned
-      def page=(page)
-        if page.nil?
-          raise ArgumentError, "page cannot be nil"
+        if attributes.key?(:enabled)
+          self.enabled = attributes[:enabled]
         end
 
-        if page < 0
-          raise ArgumentError, "invalid value for \"page\", must be greater than or equal to 0."
+        if attributes.key?(:failure_threshold)
+          self.failure_threshold = attributes[:failure_threshold]
         end
-
-        @page = page
       end
 
       # Custom attribute writer method with validation
-      # @param [Object] hits_per_page Value to be assigned
-      def hits_per_page=(hits_per_page)
-        if hits_per_page.nil?
-          raise ArgumentError, "hits_per_page cannot be nil"
+      # @param [Object] failure_threshold Value to be assigned
+      def failure_threshold=(failure_threshold)
+        if failure_threshold.nil?
+          raise ArgumentError, "failure_threshold cannot be nil"
         end
 
-        if hits_per_page > 1000
-          raise ArgumentError, "invalid value for \"hits_per_page\", must be smaller than or equal to 1000."
+        if failure_threshold > 100
+          raise ArgumentError, "invalid value for \"failure_threshold\", must be smaller than or equal to 100."
         end
 
-        if hits_per_page < 1
-          raise ArgumentError, "invalid value for \"hits_per_page\", must be greater than or equal to 1."
+        if failure_threshold < 0
+          raise ArgumentError, "invalid value for \"failure_threshold\", must be greater than or equal to 0."
         end
 
-        @hits_per_page = hits_per_page
+        @failure_threshold = failure_threshold
       end
 
       # Checks equality by comparing each attribute.
@@ -127,10 +121,11 @@ module Algolia
       def ==(other)
         return true if self.equal?(other)
         self.class == other.class &&
-          page == other.page &&
-          nb_hits == other.nb_hits &&
-          nb_pages == other.nb_pages &&
-          hits_per_page == other.hits_per_page
+          destination_id == other.destination_id &&
+          trigger == other.trigger &&
+          input == other.input &&
+          enabled == other.enabled &&
+          failure_threshold == other.failure_threshold
       end
 
       # @see the `==` method
@@ -142,7 +137,7 @@ module Algolia
       # Calculates hash code according to all attributes.
       # @return [Integer] Hash code
       def hash
-        [page, nb_hits, nb_pages, hits_per_page].hash
+        [destination_id, trigger, input, enabled, failure_threshold].hash
       end
 
       # Builds the object from hash
@@ -211,7 +206,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