algolia 3.0.0.beta.3 → 3.0.0.beta.5

data/lib/algolia/api/search_client.rb

@@ -1,5 +1,8 @@
 # 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 'openssl'
+require 'base64'
+
 module Algolia
   class SearchClient
     attr_accessor :api_client
@@ -3129,5 +3132,150 @@ module Algolia
 
       synonyms unless block_given?
     end
+
+    # Helper: Generates a secured API key based on the given `parent_api_key` and given `restrictions`.
+    #
+    # @param parent_api_key [String] Parent API key used the generate the secured key
+    # @param restrictions [SecuredApiKeyRestrictions] Restrictions to apply on the secured key
+    #
+    # @return [String]
+    #
+    def generate_secured_api_key(parent_api_key, restrictions = {})
+      restrictions = restrictions.to_hash
+      if restrictions.key?(:searchParams)
+        # merge searchParams with the root of the restrictions
+
+        restrictions.merge!(restrictions[:searchParams])
+        restrictions.delete(:searchParams)
+      end
+
+      url_encoded_restrictions = Algolia::Transport.stringify_query_params(restrictions).sort.to_h.map do |key, value|
+        "#{key}=#{value}"
+      end.join('&')
+
+      hmac = OpenSSL::HMAC.hexdigest(OpenSSL::Digest.new('sha256'), parent_api_key, url_encoded_restrictions)
+      Base64.encode64("#{hmac}#{url_encoded_restrictions}").gsub("\n", '')
+    end
+
+    # Helper: Retrieves the remaining validity of the previous generated `secured_api_key`, the `validUntil` parameter must have been provided.
+    #
+    # @param secured_api_key [String]
+    #
+    # @return [Integer]
+    #
+    def get_secured_api_key_remaining_validity(secured_api_key)
+      now         = Time.now.to_i
+      decoded_key = Base64.decode64(secured_api_key)
+      regex       = 'validUntil=(\d+)'
+      matches     = decoded_key.match(regex)
+
+      if matches.nil?
+        raise AlgoliaError, 'The SecuredApiKey doesn\'t have a validUntil parameter.'
+      end
+
+      valid_until = matches[1].to_i
+
+      valid_until - now
+    end
+
+    # Helper: Chunks the given `objects` list in subset of 1000 elements max in order to make it fit in `batch` requests.
+    #
+    # @param index_name [String] the `index_name` where the operation will be performed.
+    # @param objects [Array] The array of `objects` to store in the given Algolia `index_name`.
+    # @param action [Action] The `batch` `action` to perform on the given array of `objects`, defaults to `addObject`.
+    # @param wait_for_tasks [Boolean] Whether or not we should wait until every `batch` tasks has been processed, this operation may slow the total execution time of this method but is more reliable.
+    # @param batch_size [int] The size of the chunk of `objects`. The number of `batch` calls will be equal to `length(objects) / batchSize`. Defaults to 1000.
+    # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
+    #
+    # @return [Array<BatchResponse>]
+    #
+    def chunked_batch(index_name, objects, action = Action::ADD_OBJECT, wait_for_tasks = false, batch_size = 1000, request_options = {})
+      responses = []
+      objects.each_slice(batch_size) do |chunk|
+        requests = chunk.map do |object|
+          Search::BatchRequest.new(action: action, body: object)
+        end
+
+        responses.append(batch(index_name, Search::BatchWriteParams.new(requests: requests), request_options))
+      end
+
+      if wait_for_tasks
+        responses.each do |response|
+          wait_for_task(index_name, response.task_id)
+        end
+      end
+
+      responses
+    end
+
+    # Helper: Replaces all objects (records) in the given `index_name` with the given `objects`. A temporary index is created during this process in order to backup your data.
+    #
+    # @param index_name [String] The `index_name` to replace `objects` in.
+    # @param objects [Array] The array of `objects` to store in the given Algolia `index_name`.
+    # @param batch_size [int] The size of the chunk of `objects`. The number of `batch` calls will be equal to `length(objects) / batchSize`. Defaults to 1000.
+    # @param request_options: The request options to send along with the query, they will be merged with the transporter base parameters (headers, query params, timeouts, etc.). (optional)
+    #
+    # @return [Array<ReplaceAllObjectsResponse>]
+    def replace_all_objects(index_name, objects, batch_size = 1000, request_options = {})
+      tmp_index_name = index_name + '_tmp_' + rand(10_000_000).to_s
+
+      copy_operation_response = operation_index(
+        index_name,
+        Search::OperationIndexParams.new(
+          operation: Search::OperationType::COPY,
+          destination: tmp_index_name,
+          scope: [
+            Search::ScopeType::SETTINGS,
+            Search::ScopeType::SYNONYMS,
+            Search::ScopeType::RULES
+          ]
+        ),
+        request_options
+      )
+
+      batch_responses = chunked_batch(
+        tmp_index_name,
+        objects,
+        Search::Action::ADD_OBJECT,
+        true,
+        batch_size,
+        request_options
+      )
+
+      wait_for_task(tmp_index_name, copy_operation_response.task_id)
+
+      copy_operation_response = operation_index(
+        index_name,
+        Search::OperationIndexParams.new(
+          operation: Search::OperationType::COPY,
+          destination: tmp_index_name,
+          scope: [
+            Search::ScopeType::SETTINGS,
+            Search::ScopeType::SYNONYMS,
+            Search::ScopeType::RULES
+          ]
+        ),
+        request_options
+      )
+
+      wait_for_task(tmp_index_name, copy_operation_response.task_id)
+
+      move_operation_response = operation_index(
+        tmp_index_name,
+        Search::OperationIndexParams.new(
+          operation: Search::OperationType::MOVE,
+          destination: index_name
+        ),
+        request_options
+      )
+
+      wait_for_task(tmp_index_name, move_operation_response.task_id)
+
+      Search::ReplaceAllObjectsResponse.new(
+        copy_operation_response: copy_operation_response,
+        batch_responses: batch_responses,
+        move_operation_response: move_operation_response
+      )
+    end
   end
 end

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

@@ -19,10 +19,10 @@ module Algolia
 
       attr_accessor :input
 
-      # Date of creation in RFC3339 format.
+      # Date of creation in RFC 3339 format.
       attr_accessor :created_at
 
-      # Date of last update in RFC3339 format.
+      # Date of last update in RFC 3339 format.
       attr_accessor :updated_at
 
       class EnumAttributeValidator

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

@@ -13,7 +13,7 @@ module Algolia
       # Descriptive name for the resource.
       attr_accessor :name
 
-      # Date of creation in RFC3339 format.
+      # Date of creation in RFC 3339 format.
       attr_accessor :created_at
 
       # Attribute mapping from ruby-style variable name to JSON key.

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

@@ -13,7 +13,7 @@ module Algolia
       # Descriptive name for the resource.
       attr_accessor :name
 
-      # Date of last update in RFC3339 format.
+      # Date of last update in RFC 3339 format.
       attr_accessor :updated_at
 
       # Attribute mapping from ruby-style variable name to JSON key.

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

@@ -6,7 +6,7 @@ require 'time'
 module Algolia
   module Ingestion
     class DeleteResponse
-      # Date of deletion in RFC3339 format.
+      # Date of deletion in RFC 3339 format.
       attr_accessor :deleted_at
 
       # Attribute mapping from ruby-style variable name to JSON key.

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

@@ -17,10 +17,10 @@ module Algolia
 
       attr_accessor :input
 
-      # Date of creation in RFC3339 format.
+      # Date of creation in RFC 3339 format.
       attr_accessor :created_at
 
-      # Date of last update in RFC3339 format.
+      # Date of last update in RFC 3339 format.
       attr_accessor :updated_at
 
       # Universally unique identifier (UUID) of an authentication resource.

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

@@ -13,7 +13,7 @@ module Algolia
       # Descriptive name for the resource.
       attr_accessor :name
 
-      # Date of creation in RFC3339 format.
+      # Date of creation in RFC 3339 format.
       attr_accessor :created_at
 
       # Attribute mapping from ruby-style variable name to JSON key.

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

@@ -13,7 +13,7 @@ module Algolia
       # Descriptive name for the resource.
       attr_accessor :name
 
-      # Date of last update in RFC3339 format.
+      # Date of last update in RFC 3339 format.
       attr_accessor :updated_at
 
       # Attribute mapping from ruby-style variable name to JSON key.

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

@@ -25,7 +25,7 @@ module Algolia
 
       attr_accessor :data
 
-      # Date of publish RFC3339 format.
+      # Date of publish RFC 3339 format.
       attr_accessor :published_at
 
       class EnumAttributeValidator

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

@@ -0,0 +1,212 @@
+# 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
+    # Configured transformations and pagination information.
+    class ListTransformationsResponse
+      attr_accessor :transformations
+
+      attr_accessor :pagination
+
+      # Attribute mapping from ruby-style variable name to JSON key.
+      def self.attribute_map
+        {
+          :transformations => :transformations,
+          :pagination => :pagination
+        }
+      end
+
+      # Returns all the JSON keys this model knows about
+      def self.acceptable_attributes
+        attribute_map.values
+      end
+
+      # Attribute type mapping.
+      def self.types_mapping
+        {
+          :transformations => :'Array<Transformation>',
+          :pagination => :Pagination
+        }
+      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 = {})
+        unless attributes.is_a?(Hash)
+          raise ArgumentError, "The input argument (attributes) must be a hash in `Algolia::ListTransformationsResponse` initialize method"
+        end
+
+        # check to see if the attribute exists and convert string to symbol for hash key
+        attributes = attributes.each_with_object({}) do |(k, v), h|
+          unless self.class.attribute_map.key?(k.to_sym)
+            raise ArgumentError,
+                  "`#{k}` is not a valid attribute in `Algolia::ListTransformationsResponse`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+          end
+
+          h[k.to_sym] = v
+        end
+
+        if attributes.key?(:transformations)
+          if (value = attributes[:transformations]).is_a?(Array)
+            self.transformations = value
+          end
+        else
+          self.transformations = nil
+        end
+
+        if attributes.key?(:pagination)
+          self.pagination = attributes[:pagination]
+        else
+          self.pagination = nil
+        end
+      end
+
+      # Checks equality by comparing each attribute.
+      # @param [Object] Object to be compared
+      def ==(other)
+        return true if equal?(other)
+
+        self.class == other.class &&
+          transformations == other.transformations &&
+          pagination == other.pagination
+      end
+
+      # @see the `==` method
+      # @param [Object] Object to be compared
+      def eql?(other)
+        self == other
+      end
+
+      # Calculates hash code according to all attributes.
+      # @return [Integer] Hash code
+      def hash
+        [transformations, pagination].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 = {}
+        types_mapping.each_pair do |key, type|
+          if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
+            transformed_hash[key.to_sym] = 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.to_sym] = attributes[attribute_map[key]].map { |v| _deserialize(::Regexp.last_match(1), v) }
+            end
+          elsif !attributes[attribute_map[key]].nil?
+            transformed_hash[key.to_sym] = _deserialize(type, attributes[attribute_map[key]])
+          end
+        end
+        new(transformed_hash)
+      end
+
+      # Deserializes the data based on type
+      # @param string type Data type
+      # @param string value Value to be deserialized
+      # @return [Object] Deserialized data
+      def self._deserialize(type, value)
+        case type.to_sym
+        when :Time
+          Time.parse(value)
+        when :Date
+          Date.parse(value)
+        when :String
+          value.to_s
+        when :Integer
+          value.to_i
+        when :Float
+          value.to_f
+        when :Boolean
+          if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+            true
+          else
+            false
+          end
+        when :Object
+          # generic object (usually a Hash), return directly
+          value
+        when /\AArray<(?<inner_type>.+)>\z/
+          inner_type = Regexp.last_match[:inner_type]
+          value.map { |v| _deserialize(inner_type, v) }
+        when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+          k_type = Regexp.last_match[:k_type]
+          v_type = Regexp.last_match[:v_type]
+          {}.tap do |hash|
+            value.each do |k, v|
+              hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+            end
+          end
+        else # model
+          # models (e.g. Pet) or oneOf
+          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
+      end
+
+      # Returns the string representation of the object
+      # @return [String] String presentation of the object
+      def to_s
+        to_hash.to_s
+      end
+
+      # to_body is an alias to to_hash (backward compatibility)
+      # @return [Hash] Returns the object in the form of hash
+      def to_body
+        to_hash
+      end
+
+      def to_json(*_args)
+        to_hash.to_json
+      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 = 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
+
+      # Outputs non-array value in the form of hash
+      # For object, use to_hash. Otherwise, just return the value
+      # @param [Object] value Any valid value
+      # @return [Hash] Returns the value in the form of hash
+      def _to_hash(value)
+        if value.is_a?(Array)
+          value.compact.map { |v| _to_hash(v) }
+        elsif value.is_a?(Hash)
+          {}.tap do |hash|
+            value.each { |k, v| hash[k] = _to_hash(v) }
+          end
+        elsif value.respond_to? :to_hash
+          value.to_hash
+        else
+          value
+        end
+      end
+    end
+  end
+end

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

@@ -7,10 +7,10 @@ module Algolia
   module Ingestion
     # Input for a manually-triggered task whose source is of type `bigquery` and for which extracted data spans a given time range.
     class OnDemandDateUtilsInput
-      # Earliest date in RFC3339 format of the extracted data from Big Query.
+      # Earliest date in RFC 3339 format of the extracted data from Big Query.
       attr_accessor :start_date
 
-      # Latest date in RFC3339 format of the extracted data from Big Query.
+      # Latest date in RFC 3339 format of the extracted data from Big Query.
       attr_accessor :end_date
 
       attr_accessor :mapping

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

@@ -9,7 +9,7 @@ module Algolia
     class OnDemandTrigger
       attr_accessor :type
 
-      # The last time the scheduled task ran in RFC3339 format.
+      # The last time the scheduled task ran in RFC 3339 format.
       attr_accessor :last_run
 
       class EnumAttributeValidator

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

@@ -30,13 +30,13 @@ module Algolia
 
       attr_accessor :type
 
-      # Date of creation in RFC3339 format.
+      # Date of creation in RFC 3339 format.
       attr_accessor :created_at
 
-      # Date of start in RFC3339 format.
+      # Date of start in RFC 3339 format.
       attr_accessor :started_at
 
-      # Date of finish in RFC3339 format.
+      # Date of finish in RFC 3339 format.
       attr_accessor :finished_at
 
       class EnumAttributeValidator

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

@@ -10,7 +10,7 @@ module Algolia
       # Universally unique identifier (UUID) of a task run.
       attr_accessor :run_id
 
-      # Date of creation in RFC3339 format.
+      # Date of creation in RFC 3339 format.
       attr_accessor :created_at
 
       # Attribute mapping from ruby-style variable name to JSON key.

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

@@ -12,10 +12,10 @@ module Algolia
       # Cron expression for the task's schedule.
       attr_accessor :cron
 
-      # The last time the scheduled task ran in RFC3339 format.
+      # The last time the scheduled task ran in RFC 3339 format.
       attr_accessor :last_run
 
-      # The next scheduled run of the task in RFC3339 format.
+      # The next scheduled run of the task in RFC 3339 format.
       attr_accessor :next_run
 
       class EnumAttributeValidator

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

@@ -0,0 +1,35 @@
+# 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 SortKeys
+      NAME = "name".freeze
+      TYPE = "type".freeze
+      UPDATED_AT = "updatedAt".freeze
+      CREATED_AT = "createdAt".freeze
+
+      def self.all_vars
+        @all_vars ||= [NAME, TYPE, UPDATED_AT, CREATED_AT].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 SortKeys.all_vars.include?(value)
+
+        raise "Invalid ENUM value #{value} for class #SortKeys"
+      end
+    end
+  end
+end

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

@@ -18,10 +18,10 @@ module Algolia
       # Universally unique identifier (UUID) of an authentication resource.
       attr_accessor :authentication_id
 
-      # Date of creation in RFC3339 format.
+      # Date of creation in RFC 3339 format.
       attr_accessor :created_at
 
-      # Date of last update in RFC3339 format.
+      # Date of last update in RFC 3339 format.
       attr_accessor :updated_at
 
       class EnumAttributeValidator

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

@@ -12,7 +12,7 @@ module Algolia
       # Descriptive name of the source.
       attr_accessor :name
 
-      # Date of creation in RFC3339 format.
+      # Date of creation in RFC 3339 format.
       attr_accessor :created_at
 
       # Attribute mapping from ruby-style variable name to JSON key.

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

@@ -12,7 +12,7 @@ module Algolia
       # Descriptive name of the source.
       attr_accessor :name
 
-      # Date of last update in RFC3339 format.
+      # Date of last update in RFC 3339 format.
       attr_accessor :updated_at
 
       # Attribute mapping from ruby-style variable name to JSON key.