Skip to content

Commit

Permalink
feat(specs): add recommend batch rules endpoint (generated)
Browse files Browse the repository at this point in the history
algolia/api-clients-automation#3782

Co-authored-by: algolia-bot <accounts+algolia-api-client-bot@algolia.com>
Co-authored-by: Raed <raed.chammam@algolia.com>
Co-authored-by: Pierre Millot <pierre.millot@algolia.com>
Co-authored-by: Clément Vannicatte <vannicattec@gmail.com>
  • Loading branch information
4 people committed Sep 27, 2024
1 parent a060cef commit 793d6c7
Show file tree
Hide file tree
Showing 4 changed files with 526 additions and 4 deletions.
57 changes: 57 additions & 0 deletions lib/algolia/api/recommend_client.rb
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,63 @@ def set_client_api_key(api_key)
@api_client.set_client_api_key(api_key)
end

# Create or update a batch of Recommend Rules Each Recommend Rule is created or updated, depending on whether a Recommend Rule with the same &#x60;objectID&#x60; already exists. You may also specify &#x60;true&#x60; for &#x60;clearExistingRules&#x60;, in which case the batch will atomically replace all the existing Recommend Rules. Recommend Rules are similar to Search Rules, except that the conditions and consequences apply to a [source item](/doc/guides/algolia-recommend/overview/#recommend-models) instead of a query. The main differences are the following: - Conditions &#x60;pattern&#x60; and &#x60;anchoring&#x60; are unavailable. - Condition &#x60;filters&#x60; triggers if the source item matches the specified filters. - Condition &#x60;filters&#x60; accepts numeric filters. - Consequence &#x60;params&#x60; only covers filtering parameters. - Consequence &#x60;automaticFacetFilters&#x60; doesn&#39;t require a facet value placeholder (it tries to match the data source item&#39;s attributes instead).
#
# Required API Key ACLs:
# - editSettings
# @param index_name [String] Name of the index on which to perform the operation. (required)
# @param model [RecommendModels] [Recommend model](https://www.algolia.com/doc/guides/algolia-recommend/overview/#recommend-models). (required)
# @param recommend_rule [Array<RecommendRule>]
# @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 batch_recommend_rules_with_http_info(index_name, model, recommend_rule = nil, request_options = {})
# verify the required parameter 'index_name' is set
if @api_client.config.client_side_validation && index_name.nil?
raise ArgumentError, "Parameter `index_name` is required when calling `batch_recommend_rules`."
end
# verify the required parameter 'model' is set
if @api_client.config.client_side_validation && model.nil?
raise ArgumentError, "Parameter `model` is required when calling `batch_recommend_rules`."
end

path = "/1/indexes/{indexName}/{model}/recommend/rules/batch"
.sub("{" + "indexName" + "}", Transport.encode_uri(index_name.to_s))
.sub("{" + "model" + "}", Transport.encode_uri(model.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(recommend_rule)

new_options = request_options.merge(
:operation => :"RecommendClient.batch_recommend_rules",
:header_params => header_params,
:query_params => query_params,
:body => post_body,
:use_read_transporter => false
)

@api_client.call_api(:POST, path, new_options)
end

# Create or update a batch of Recommend Rules Each Recommend Rule is created or updated, depending on whether a Recommend Rule with the same `objectID` already exists. You may also specify `true` for `clearExistingRules`, in which case the batch will atomically replace all the existing Recommend Rules. Recommend Rules are similar to Search Rules, except that the conditions and consequences apply to a [source item](/doc/guides/algolia-recommend/overview/#recommend-models) instead of a query. The main differences are the following: - Conditions `pattern` and `anchoring` are unavailable. - Condition `filters` triggers if the source item matches the specified filters. - Condition `filters` accepts numeric filters. - Consequence `params` only covers filtering parameters. - Consequence `automaticFacetFilters` doesn't require a facet value placeholder (it tries to match the data source item's attributes instead).
#
# Required API Key ACLs:
# - editSettings
# @param index_name [String] Name of the index on which to perform the operation. (required)
# @param model [RecommendModels] [Recommend model](https://www.algolia.com/doc/guides/algolia-recommend/overview/#recommend-models). (required)
# @param recommend_rule [Array<RecommendRule>]
# @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 [RecommendUpdatedAtResponse]
def batch_recommend_rules(index_name, model, recommend_rule = nil, request_options = {})
response = batch_recommend_rules_with_http_info(index_name, model, recommend_rule, request_options)
@api_client.deserialize(
response.body,
request_options[:debug_return_type] || "Recommend::RecommendUpdatedAtResponse"
)
end

# This method allow you to send requests to the Algolia REST API.

# @param path [String] Path of the endpoint, anything after \&quot;/1\&quot; must be specified. (required)
Expand Down
20 changes: 16 additions & 4 deletions lib/algolia/models/recommend/recommend_rule.rb
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,9 @@ class RecommendRule
# Indicates whether to enable the rule. If it isn't enabled, it isn't applied at query time.
attr_accessor :enabled

# Time periods when the rule is active.
attr_accessor :validity

# Attribute mapping from ruby-style variable name to JSON key.
def self.attribute_map
{
Expand All @@ -30,7 +33,8 @@ def self.attribute_map
:condition => :condition,
:consequence => :consequence,
:description => :description,
:enabled => :enabled
:enabled => :enabled,
:validity => :validity
}
end

Expand All @@ -47,7 +51,8 @@ def self.types_mapping
:condition => :"Condition",
:consequence => :"Consequence",
:description => :"String",
:enabled => :"Boolean"
:enabled => :"Boolean",
:validity => :"Array<TimeRange>"
}
end

Expand Down Expand Up @@ -104,6 +109,12 @@ def initialize(attributes = {})
if attributes.key?(:enabled)
self.enabled = attributes[:enabled]
end

if attributes.key?(:validity)
if (value = attributes[:validity]).is_a?(Array)
self.validity = value
end
end
end

# Checks equality by comparing each attribute.
Expand All @@ -116,7 +127,8 @@ def ==(other)
condition == other.condition &&
consequence == other.consequence &&
description == other.description &&
enabled == other.enabled
enabled == other.enabled &&
validity == other.validity
end

# @see the `==` method
Expand All @@ -128,7 +140,7 @@ def eql?(other)
# Calculates hash code according to all attributes.
# @return [Integer] Hash code
def hash
[_metadata, object_id, condition, consequence, description, enabled].hash
[_metadata, object_id, condition, consequence, description, enabled, validity].hash
end

# Builds the object from hash
Expand Down
227 changes: 227 additions & 0 deletions lib/algolia/models/recommend/recommend_updated_at_response.rb
Original file line number Diff line number Diff line change
@@ -0,0 +1,227 @@
# 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 Recommend
# Response, taskID, and update timestamp.
class RecommendUpdatedAtResponse
# Unique identifier of a task. A successful API response means that a task was added to a queue. It might not run immediately. You can check the task's progress with the [`task` operation](#tag/Indices/operation/getTask) and this `taskID`.
attr_accessor :task_id

# Date and time when the object was updated, in RFC 3339 format.
attr_accessor :updated_at

# Attribute mapping from ruby-style variable name to JSON key.
def self.attribute_map
{
:task_id => :taskID,
:updated_at => :updatedAt
}
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
{
:task_id => :"Integer",
:updated_at => :"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))
raise(
ArgumentError,
"The input argument (attributes) must be a hash in `Algolia::RecommendUpdatedAtResponse` 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::RecommendUpdatedAtResponse`. 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?(:task_id)
self.task_id = attributes[:task_id]
else
self.task_id = nil
end

if attributes.key?(:updated_at)
self.updated_at = attributes[:updated_at]
else
self.updated_at = 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 &&
task_id == other.task_id &&
updated_at == other.updated_at
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
[task_id, updated_at].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
# model
else
# models (e.g. Pet) or oneOf
klass = Algolia::Recommend.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
Loading

0 comments on commit 793d6c7

Please sign in to comment.