From 4dee983e67c5fbc8c43aac3e50482ba7b0ad3d47 Mon Sep 17 00:00:00 2001 From: algolia-bot Date: Thu, 25 Jul 2024 15:52:42 +0000 Subject: [PATCH] feat(specs): add v2 endpoints for ingestion MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit https://github.com/algolia/api-clients-automation/pull/3416 Co-authored-by: algolia-bot Co-authored-by: Clément Vannicatte --- lib/algolia/api/ingestion_client.rb | 54 ++++ lib/algolia/models/ingestion/action.rb | 45 ++++ lib/algolia/models/ingestion/batch_request.rb | 247 ++++++++++++++++++ .../models/ingestion/batch_write_params.rb | 216 +++++++++++++++ 4 files changed, 562 insertions(+) create mode 100644 lib/algolia/models/ingestion/action.rb create mode 100644 lib/algolia/models/ingestion/batch_request.rb create mode 100644 lib/algolia/models/ingestion/batch_write_params.rb diff --git a/lib/algolia/api/ingestion_client.rb b/lib/algolia/api/ingestion_client.rb index 020c9cc1..3e20e28b 100644 --- a/lib/algolia/api/ingestion_client.rb +++ b/lib/algolia/api/ingestion_client.rb @@ -2213,6 +2213,60 @@ def list_transformations(sort = nil, order = nil, request_options = {}) ) end + # Push a `batch` request payload through the Pipeline. You can check the status of task pushes with the observability endpoints. + # + # Required API Key ACLs: + # - addObject + # - deleteIndex + # - editSettings + # @param task_id [String] Unique identifier of a task. (required) + # @param batch_write_params [BatchWriteParams] Request body of a Search API `batch` request that will be pushed in the Connectors pipeline. (required) + # @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 [Http::Response] the response + def push_task_with_http_info(task_id, batch_write_params, request_options = {}) + # verify the required parameter 'task_id' is set + if @api_client.config.client_side_validation && task_id.nil? + raise ArgumentError, "Parameter `task_id` is required when calling `push_task`." + end + # verify the required parameter 'batch_write_params' is set + if @api_client.config.client_side_validation && batch_write_params.nil? + raise ArgumentError, "Parameter `batch_write_params` is required when calling `push_task`." + end + + path = "/2/tasks/{taskID}/push".sub("{" + "taskID" + "}", Transport.encode_uri(task_id.to_s)) + query_params = {} + query_params = query_params.merge(request_options[:query_params]) unless request_options[:query_params].nil? + header_params = {} + header_params = header_params.merge(request_options[:header_params]) unless request_options[:header_params].nil? + + post_body = request_options[:debug_body] || @api_client.object_to_http_body(batch_write_params) + + new_options = request_options.merge( + :operation => :"IngestionClient.push_task", + :header_params => header_params, + :query_params => query_params, + :body => post_body, + :use_read_transporter => false + ) + + @api_client.call_api(:POST, path, new_options) + end + + # Push a `batch` request payload through the Pipeline. You can check the status of task pushes with the observability endpoints. + # + # Required API Key ACLs: + # - addObject + # - deleteIndex + # - editSettings + # @param task_id [String] Unique identifier of a task. (required) + # @param batch_write_params [BatchWriteParams] Request body of a Search API `batch` request that will be pushed in the Connectors pipeline. (required) + # @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 [RunResponse] + def push_task(task_id, batch_write_params, request_options = {}) + response = push_task_with_http_info(task_id, batch_write_params, request_options) + @api_client.deserialize(response.body, request_options[:debug_return_type] || "Ingestion::RunResponse") + end + # Runs a task. You can check the status of task runs with the observability endpoints. # # Required API Key ACLs: diff --git a/lib/algolia/models/ingestion/action.rb b/lib/algolia/models/ingestion/action.rb new file mode 100644 index 00000000..0c64e0d9 --- /dev/null +++ b/lib/algolia/models/ingestion/action.rb @@ -0,0 +1,45 @@ +# 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 Action + ADD_OBJECT = "addObject".freeze + UPDATE_OBJECT = "updateObject".freeze + PARTIAL_UPDATE_OBJECT = "partialUpdateObject".freeze + PARTIAL_UPDATE_OBJECT_NO_CREATE = "partialUpdateObjectNoCreate".freeze + DELETE_OBJECT = "deleteObject".freeze + DELETE = "delete".freeze + CLEAR = "clear".freeze + + def self.all_vars + @all_vars ||= [ + ADD_OBJECT, + UPDATE_OBJECT, + PARTIAL_UPDATE_OBJECT, + PARTIAL_UPDATE_OBJECT_NO_CREATE, + DELETE_OBJECT, + DELETE, + CLEAR + ].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 Action.all_vars.include?(value) + raise "Invalid ENUM value #{value} for class #Action" + end + end + end +end diff --git a/lib/algolia/models/ingestion/batch_request.rb b/lib/algolia/models/ingestion/batch_request.rb new file mode 100644 index 00000000..decf1ab9 --- /dev/null +++ b/lib/algolia/models/ingestion/batch_request.rb @@ -0,0 +1,247 @@ +# 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 BatchRequest + attr_accessor :action + + # Operation arguments (varies with specified `action`). + attr_accessor :body + + class EnumAttributeValidator + attr_reader :datatype + attr_reader :allowable_values + + def initialize(datatype, allowable_values) + @allowable_values = allowable_values.map do |value| + case datatype.to_s + when /Integer/i + value.to_i + when /Float/i + value.to_f + else + value + end + end + end + + def valid?(value) + !value || allowable_values.include?(value) + end + end + + # Attribute mapping from ruby-style variable name to JSON key. + def self.attribute_map + { + :action => :action, + :body => :body + } + 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 + { + :action => :"Action", + :body => :"Object" + } + 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)) + raise( + ArgumentError, + "The input argument (attributes) must be a hash in `Algolia::BatchRequest` initialize method" + ) + end + + # check to see if the attribute exists and convert string to symbol for hash key + attributes = attributes.each_with_object({}) { |(k, v), h| + if (!self.class.attribute_map.key?(k.to_sym)) + raise( + ArgumentError, + "`#{k}` is not a valid attribute in `Algolia::BatchRequest`. 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 + } + + if attributes.key?(:action) + self.action = attributes[:action] + else + self.action = nil + end + + if attributes.key?(:body) + self.body = attributes[:body] + else + self.body = nil + end + end + + # Checks equality by comparing each attribute. + # @param [Object] Object to be compared + def ==(other) + return true if self.equal?(other) + self.class == other.class && + action == other.action && + body == other.body + 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 + [action, body].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<(?.+)>\z/ + inner_type = Regexp.last_match[:inner_type] + value.map { |v| _deserialize(inner_type, v) } + when /\AHash<(?.+?), (?.+)>\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 + # model + else + # 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 diff --git a/lib/algolia/models/ingestion/batch_write_params.rb b/lib/algolia/models/ingestion/batch_write_params.rb new file mode 100644 index 00000000..f31a727e --- /dev/null +++ b/lib/algolia/models/ingestion/batch_write_params.rb @@ -0,0 +1,216 @@ +# 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 + # Batch parameters. + class BatchWriteParams + attr_accessor :requests + + # Attribute mapping from ruby-style variable name to JSON key. + def self.attribute_map + { + :requests => :requests + } + 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 + { + :requests => :"Array" + } + 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)) + raise( + ArgumentError, + "The input argument (attributes) must be a hash in `Algolia::BatchWriteParams` initialize method" + ) + end + + # check to see if the attribute exists and convert string to symbol for hash key + attributes = attributes.each_with_object({}) { |(k, v), h| + if (!self.class.attribute_map.key?(k.to_sym)) + raise( + ArgumentError, + "`#{k}` is not a valid attribute in `Algolia::BatchWriteParams`. 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 + } + + if attributes.key?(:requests) + if (value = attributes[:requests]).is_a?(Array) + self.requests = value + end + else + self.requests = nil + end + end + + # Checks equality by comparing each attribute. + # @param [Object] Object to be compared + def ==(other) + return true if self.equal?(other) + self.class == other.class && + requests == other.requests + 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 + [requests].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<(?.+)>\z/ + inner_type = Regexp.last_match[:inner_type] + value.map { |v| _deserialize(inner_type, v) } + when /\AHash<(?.+?), (?.+)>\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 + # model + else + # 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