algolia 3.4.0 → 3.5.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +15 -0
- data/Gemfile.lock +1 -1
- data/lib/algolia/api/abtesting_client.rb +0 -7
- data/lib/algolia/api/analytics_client.rb +32 -88
- data/lib/algolia/api/ingestion_client.rb +2 -170
- data/lib/algolia/api/insights_client.rb +0 -22
- data/lib/algolia/api/monitoring_client.rb +11 -11
- data/lib/algolia/api/search_client.rb +19 -74
- data/lib/algolia/models/abtesting/ab_tests_variant.rb +0 -18
- data/lib/algolia/models/abtesting/ab_tests_variant_search_params.rb +0 -18
- data/lib/algolia/models/abtesting/add_ab_tests_request.rb +0 -18
- data/lib/algolia/models/abtesting/minimum_detectable_effect.rb +0 -18
- data/lib/algolia/models/abtesting/schedule_ab_tests_request.rb +0 -18
- data/lib/algolia/models/abtesting/variant.rb +0 -18
- data/lib/algolia/models/analytics/click_position.rb +0 -32
- data/lib/algolia/models/analytics/daily_add_to_cart_rates.rb +0 -28
- data/lib/algolia/models/analytics/daily_average_clicks.rb +0 -24
- data/lib/algolia/models/analytics/daily_click_through_rates.rb +0 -28
- data/lib/algolia/models/analytics/daily_conversion_rates.rb +0 -28
- data/lib/algolia/models/analytics/daily_no_click_rates.rb +0 -32
- data/lib/algolia/models/analytics/daily_no_results_rates.rb +0 -18
- data/lib/algolia/models/analytics/daily_purchase_rates.rb +0 -14
- data/lib/algolia/models/analytics/daily_searches_no_clicks.rb +0 -14
- data/lib/algolia/models/analytics/daily_searches_no_results.rb +0 -14
- data/lib/algolia/models/analytics/get_add_to_cart_rate_response.rb +0 -28
- data/lib/algolia/models/analytics/get_average_click_position_response.rb +0 -24
- data/lib/algolia/models/analytics/get_click_positions_response.rb +0 -18
- data/lib/algolia/models/analytics/get_click_through_rate_response.rb +0 -28
- data/lib/algolia/models/analytics/get_conversion_rate_response.rb +0 -28
- data/lib/algolia/models/analytics/get_no_click_rate_response.rb +0 -32
- data/lib/algolia/models/analytics/get_no_results_rate_response.rb +0 -18
- data/lib/algolia/models/analytics/get_purchase_rate_response.rb +0 -14
- data/lib/algolia/models/analytics/top_hit_with_analytics.rb +0 -56
- data/lib/algolia/models/analytics/top_hit_with_revenue_analytics.rb +0 -98
- data/lib/algolia/models/analytics/top_search_with_analytics.rb +0 -90
- data/lib/algolia/models/analytics/top_search_with_revenue_analytics.rb +0 -132
- data/lib/algolia/models/ingestion/event.rb +0 -14
- data/lib/algolia/models/ingestion/pagination.rb +0 -60
- data/lib/algolia/models/ingestion/run.rb +0 -18
- data/lib/algolia/models/ingestion/source_csv.rb +0 -21
- data/lib/algolia/models/ingestion/task.rb +0 -18
- data/lib/algolia/models/ingestion/task_create.rb +0 -18
- data/lib/algolia/models/ingestion/task_create_v1.rb +0 -18
- data/lib/algolia/models/ingestion/task_update.rb +0 -18
- data/lib/algolia/models/ingestion/task_update_v1.rb +0 -18
- data/lib/algolia/models/ingestion/task_v1.rb +0 -18
- data/lib/algolia/models/ingestion/transformation.rb +1 -1
- data/lib/algolia/models/ingestion/transformation_create.rb +1 -1
- data/lib/algolia/models/insights/added_to_cart_object_ids.rb +0 -123
- data/lib/algolia/models/insights/added_to_cart_object_ids_after_search.rb +0 -149
- data/lib/algolia/models/insights/clicked_filters.rb +0 -105
- data/lib/algolia/models/insights/clicked_object_ids.rb +0 -105
- data/lib/algolia/models/insights/clicked_object_ids_after_search.rb +0 -149
- data/lib/algolia/models/insights/converted_filters.rb +0 -105
- data/lib/algolia/models/insights/converted_object_ids.rb +0 -105
- data/lib/algolia/models/insights/converted_object_ids_after_search.rb +0 -131
- data/lib/algolia/models/insights/insights_events.rb +0 -18
- data/lib/algolia/models/insights/object_data_after_search.rb +0 -26
- data/lib/algolia/models/insights/purchased_object_ids.rb +0 -123
- data/lib/algolia/models/insights/purchased_object_ids_after_search.rb +0 -123
- data/lib/algolia/models/insights/viewed_filters.rb +0 -105
- data/lib/algolia/models/insights/viewed_object_ids.rb +0 -105
- data/lib/algolia/models/personalization/personalization_strategy_params.rb +0 -18
- data/lib/algolia/models/query-suggestions/configuration.rb +0 -17
- data/lib/algolia/models/query-suggestions/configuration_response.rb +0 -17
- data/lib/algolia/models/query-suggestions/configuration_with_index.rb +0 -17
- data/lib/algolia/models/query-suggestions/source_index.rb +0 -28
- data/lib/algolia/models/recommend/banner.rb +218 -0
- data/lib/algolia/models/{query-suggestions/base_query_suggestions_configuration_response.rb → recommend/banner_image.rb} +31 -38
- data/lib/algolia/models/{query-suggestions/base_query_suggestions_configuration_with_index.rb → recommend/banner_image_url.rb} +23 -23
- data/lib/algolia/models/{query-suggestions/get_config_status200_response.rb → recommend/banner_link.rb} +13 -53
- data/lib/algolia/models/recommend/bought_together_query.rb +0 -36
- data/lib/algolia/models/recommend/condition.rb +0 -15
- data/lib/algolia/models/recommend/consequence.rb +0 -28
- data/lib/algolia/models/recommend/fallback_params.rb +8 -100
- data/lib/algolia/models/recommend/looking_similar_query.rb +0 -36
- data/lib/algolia/models/recommend/numeric_filters.rb +1 -1
- data/lib/algolia/models/recommend/promote_consequence_object.rb +0 -14
- data/lib/algolia/models/recommend/ranking_info.rb +0 -112
- data/lib/algolia/models/recommend/recommend_hit.rb +0 -18
- data/lib/algolia/models/recommend/recommend_search_params.rb +8 -100
- data/lib/algolia/models/recommend/recommendations_results.rb +0 -61
- data/lib/algolia/models/recommend/recommended_for_you_query.rb +0 -36
- data/lib/algolia/models/recommend/related_query.rb +0 -36
- data/lib/algolia/models/recommend/rendering_content.rb +14 -5
- data/lib/algolia/models/recommend/search_recommend_rules_params.rb +0 -50
- data/lib/algolia/models/recommend/search_recommend_rules_response.rb +0 -14
- data/lib/algolia/models/recommend/trending_facet_hit.rb +0 -18
- data/lib/algolia/models/recommend/trending_facets_query.rb +0 -36
- data/lib/algolia/models/recommend/trending_items_query.rb +0 -36
- data/lib/algolia/models/recommend/typo_tolerance.rb +1 -1
- data/lib/algolia/models/recommend/widgets.rb +212 -0
- data/lib/algolia/models/search/api_key.rb +1 -1
- data/lib/algolia/models/search/banner.rb +218 -0
- data/lib/algolia/models/{query-suggestions/get_log_file200_response.rb → search/banner_image.rb} +21 -61
- data/lib/algolia/models/search/banner_image_url.rb +212 -0
- data/lib/algolia/models/search/banner_link.rb +212 -0
- data/lib/algolia/models/search/browse_params_object.rb +4 -132
- data/lib/algolia/models/search/browse_response.rb +0 -61
- data/lib/algolia/models/search/condition.rb +0 -15
- data/lib/algolia/models/search/consequence.rb +0 -28
- data/lib/algolia/models/search/consequence_params.rb +4 -132
- data/lib/algolia/models/search/delete_by_params.rb +1 -1
- data/lib/algolia/models/search/get_api_key_response.rb +1 -1
- data/lib/algolia/models/search/index_settings.rb +7 -85
- data/lib/algolia/models/search/log.rb +0 -34
- data/lib/algolia/models/search/numeric_filters.rb +1 -1
- data/lib/algolia/models/search/promote_object_ids.rb +0 -14
- data/lib/algolia/models/search/ranking_info.rb +0 -112
- data/lib/algolia/models/search/rendering_content.rb +14 -5
- data/lib/algolia/models/search/rule.rb +0 -18
- data/lib/algolia/models/search/search_dictionary_entries_params.rb +0 -32
- data/lib/algolia/models/search/search_dictionary_entries_response.rb +0 -14
- data/lib/algolia/models/search/search_for_facet_values_request.rb +0 -14
- data/lib/algolia/models/search/search_for_facets.rb +4 -132
- data/lib/algolia/models/search/search_for_hits.rb +4 -132
- data/lib/algolia/models/search/search_params_object.rb +4 -132
- data/lib/algolia/models/search/search_response.rb +0 -61
- data/lib/algolia/models/search/search_rules_params.rb +0 -32
- data/lib/algolia/models/search/search_synonyms_params.rb +0 -32
- data/lib/algolia/models/search/search_user_ids_params.rb +0 -32
- data/lib/algolia/models/search/search_user_ids_response.rb +0 -32
- data/lib/algolia/models/search/settings_response.rb +7 -85
- data/lib/algolia/models/search/typo_tolerance.rb +1 -1
- data/lib/algolia/models/search/user_hit.rb +0 -15
- data/lib/algolia/models/search/user_id.rb +0 -15
- data/lib/algolia/models/search/widgets.rb +212 -0
- data/lib/algolia/version.rb +1 -1
- metadata +12 -9
- data/lib/algolia/models/query-suggestions/query_suggestions_configuration.rb +0 -276
- data/lib/algolia/models/query-suggestions/query_suggestions_configuration_response.rb +0 -316
- data/lib/algolia/models/query-suggestions/query_suggestions_configuration_with_index.rb +0 -295
@@ -0,0 +1,212 @@
|
|
1
|
+
# 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.
|
2
|
+
|
3
|
+
require "date"
|
4
|
+
require "time"
|
5
|
+
|
6
|
+
module Algolia
|
7
|
+
module Search
|
8
|
+
# url for a search banner image.
|
9
|
+
class BannerImageUrl
|
10
|
+
attr_accessor :url
|
11
|
+
|
12
|
+
# Attribute mapping from ruby-style variable name to JSON key.
|
13
|
+
def self.attribute_map
|
14
|
+
{
|
15
|
+
:url => :url
|
16
|
+
}
|
17
|
+
end
|
18
|
+
|
19
|
+
# Returns all the JSON keys this model knows about
|
20
|
+
def self.acceptable_attributes
|
21
|
+
attribute_map.values
|
22
|
+
end
|
23
|
+
|
24
|
+
# Attribute type mapping.
|
25
|
+
def self.types_mapping
|
26
|
+
{
|
27
|
+
:url => :"String"
|
28
|
+
}
|
29
|
+
end
|
30
|
+
|
31
|
+
# List of attributes with nullable: true
|
32
|
+
def self.openapi_nullable
|
33
|
+
Set.new(
|
34
|
+
[]
|
35
|
+
)
|
36
|
+
end
|
37
|
+
|
38
|
+
# Initializes the object
|
39
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
40
|
+
def initialize(attributes = {})
|
41
|
+
if (!attributes.is_a?(Hash))
|
42
|
+
raise(
|
43
|
+
ArgumentError,
|
44
|
+
"The input argument (attributes) must be a hash in `Algolia::BannerImageUrl` initialize method"
|
45
|
+
)
|
46
|
+
end
|
47
|
+
|
48
|
+
# check to see if the attribute exists and convert string to symbol for hash key
|
49
|
+
attributes = attributes.each_with_object({}) { |(k, v), h|
|
50
|
+
if (!self.class.attribute_map.key?(k.to_sym))
|
51
|
+
raise(
|
52
|
+
ArgumentError,
|
53
|
+
"`#{k}` is not a valid attribute in `Algolia::BannerImageUrl`. Please check the name to make sure it's valid. List of attributes: " +
|
54
|
+
self.class.attribute_map.keys.inspect
|
55
|
+
)
|
56
|
+
end
|
57
|
+
|
58
|
+
h[k.to_sym] = v
|
59
|
+
}
|
60
|
+
|
61
|
+
if attributes.key?(:url)
|
62
|
+
self.url = attributes[:url]
|
63
|
+
end
|
64
|
+
end
|
65
|
+
|
66
|
+
# Checks equality by comparing each attribute.
|
67
|
+
# @param [Object] Object to be compared
|
68
|
+
def ==(other)
|
69
|
+
return true if self.equal?(other)
|
70
|
+
self.class == other.class &&
|
71
|
+
url == other.url
|
72
|
+
end
|
73
|
+
|
74
|
+
# @see the `==` method
|
75
|
+
# @param [Object] Object to be compared
|
76
|
+
def eql?(other)
|
77
|
+
self == other
|
78
|
+
end
|
79
|
+
|
80
|
+
# Calculates hash code according to all attributes.
|
81
|
+
# @return [Integer] Hash code
|
82
|
+
def hash
|
83
|
+
[url].hash
|
84
|
+
end
|
85
|
+
|
86
|
+
# Builds the object from hash
|
87
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
88
|
+
# @return [Object] Returns the model itself
|
89
|
+
def self.build_from_hash(attributes)
|
90
|
+
return nil unless attributes.is_a?(Hash)
|
91
|
+
attributes = attributes.transform_keys(&:to_sym)
|
92
|
+
transformed_hash = {}
|
93
|
+
types_mapping.each_pair do |key, type|
|
94
|
+
if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
|
95
|
+
transformed_hash[key.to_sym] = nil
|
96
|
+
elsif type =~ /\AArray<(.*)>/i
|
97
|
+
# check to ensure the input is an array given that the attribute
|
98
|
+
# is documented as an array but the input is not
|
99
|
+
if attributes[attribute_map[key]].is_a?(Array)
|
100
|
+
transformed_hash[key.to_sym] = attributes[attribute_map[key]].map { |v|
|
101
|
+
_deserialize(::Regexp.last_match(1), v)
|
102
|
+
}
|
103
|
+
end
|
104
|
+
elsif !attributes[attribute_map[key]].nil?
|
105
|
+
transformed_hash[key.to_sym] = _deserialize(type, attributes[attribute_map[key]])
|
106
|
+
end
|
107
|
+
end
|
108
|
+
|
109
|
+
new(transformed_hash)
|
110
|
+
end
|
111
|
+
|
112
|
+
# Deserializes the data based on type
|
113
|
+
# @param string type Data type
|
114
|
+
# @param string value Value to be deserialized
|
115
|
+
# @return [Object] Deserialized data
|
116
|
+
def self._deserialize(type, value)
|
117
|
+
case type.to_sym
|
118
|
+
when :Time
|
119
|
+
Time.parse(value)
|
120
|
+
when :Date
|
121
|
+
Date.parse(value)
|
122
|
+
when :String
|
123
|
+
value.to_s
|
124
|
+
when :Integer
|
125
|
+
value.to_i
|
126
|
+
when :Float
|
127
|
+
value.to_f
|
128
|
+
when :Boolean
|
129
|
+
if value.to_s =~ /\A(true|t|yes|y|1)\z/i
|
130
|
+
true
|
131
|
+
else
|
132
|
+
false
|
133
|
+
end
|
134
|
+
|
135
|
+
when :Object
|
136
|
+
# generic object (usually a Hash), return directly
|
137
|
+
value
|
138
|
+
when /\AArray<(?<inner_type>.+)>\z/
|
139
|
+
inner_type = Regexp.last_match[:inner_type]
|
140
|
+
value.map { |v| _deserialize(inner_type, v) }
|
141
|
+
when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
|
142
|
+
k_type = Regexp.last_match[:k_type]
|
143
|
+
v_type = Regexp.last_match[:v_type]
|
144
|
+
{}.tap do |hash|
|
145
|
+
value.each do |k, v|
|
146
|
+
hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
|
147
|
+
end
|
148
|
+
end
|
149
|
+
# model
|
150
|
+
else
|
151
|
+
# models (e.g. Pet) or oneOf
|
152
|
+
klass = Algolia::Search.const_get(type)
|
153
|
+
klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass
|
154
|
+
.build_from_hash(value)
|
155
|
+
end
|
156
|
+
end
|
157
|
+
|
158
|
+
# Returns the string representation of the object
|
159
|
+
# @return [String] String presentation of the object
|
160
|
+
def to_s
|
161
|
+
to_hash.to_s
|
162
|
+
end
|
163
|
+
|
164
|
+
# to_body is an alias to to_hash (backward compatibility)
|
165
|
+
# @return [Hash] Returns the object in the form of hash
|
166
|
+
def to_body
|
167
|
+
to_hash
|
168
|
+
end
|
169
|
+
|
170
|
+
def to_json(*_args)
|
171
|
+
to_hash.to_json
|
172
|
+
end
|
173
|
+
|
174
|
+
# Returns the object in the form of hash
|
175
|
+
# @return [Hash] Returns the object in the form of hash
|
176
|
+
def to_hash
|
177
|
+
hash = {}
|
178
|
+
self.class.attribute_map.each_pair do |attr, param|
|
179
|
+
value = send(attr)
|
180
|
+
if value.nil?
|
181
|
+
is_nullable = self.class.openapi_nullable.include?(attr)
|
182
|
+
next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
|
183
|
+
end
|
184
|
+
|
185
|
+
hash[param] = _to_hash(value)
|
186
|
+
end
|
187
|
+
|
188
|
+
hash
|
189
|
+
end
|
190
|
+
|
191
|
+
# Outputs non-array value in the form of hash
|
192
|
+
# For object, use to_hash. Otherwise, just return the value
|
193
|
+
# @param [Object] value Any valid value
|
194
|
+
# @return [Hash] Returns the value in the form of hash
|
195
|
+
def _to_hash(value)
|
196
|
+
if value.is_a?(Array)
|
197
|
+
value.compact.map { |v| _to_hash(v) }
|
198
|
+
elsif value.is_a?(Hash)
|
199
|
+
{}.tap do |hash|
|
200
|
+
value.each { |k, v| hash[k] = _to_hash(v) }
|
201
|
+
end
|
202
|
+
elsif value.respond_to?(:to_hash)
|
203
|
+
value.to_hash
|
204
|
+
else
|
205
|
+
value
|
206
|
+
end
|
207
|
+
end
|
208
|
+
|
209
|
+
end
|
210
|
+
|
211
|
+
end
|
212
|
+
end
|
@@ -0,0 +1,212 @@
|
|
1
|
+
# 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.
|
2
|
+
|
3
|
+
require "date"
|
4
|
+
require "time"
|
5
|
+
|
6
|
+
module Algolia
|
7
|
+
module Search
|
8
|
+
# link for a banner defined in merchandising studio.
|
9
|
+
class BannerLink
|
10
|
+
attr_accessor :url
|
11
|
+
|
12
|
+
# Attribute mapping from ruby-style variable name to JSON key.
|
13
|
+
def self.attribute_map
|
14
|
+
{
|
15
|
+
:url => :url
|
16
|
+
}
|
17
|
+
end
|
18
|
+
|
19
|
+
# Returns all the JSON keys this model knows about
|
20
|
+
def self.acceptable_attributes
|
21
|
+
attribute_map.values
|
22
|
+
end
|
23
|
+
|
24
|
+
# Attribute type mapping.
|
25
|
+
def self.types_mapping
|
26
|
+
{
|
27
|
+
:url => :"String"
|
28
|
+
}
|
29
|
+
end
|
30
|
+
|
31
|
+
# List of attributes with nullable: true
|
32
|
+
def self.openapi_nullable
|
33
|
+
Set.new(
|
34
|
+
[]
|
35
|
+
)
|
36
|
+
end
|
37
|
+
|
38
|
+
# Initializes the object
|
39
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
40
|
+
def initialize(attributes = {})
|
41
|
+
if (!attributes.is_a?(Hash))
|
42
|
+
raise(
|
43
|
+
ArgumentError,
|
44
|
+
"The input argument (attributes) must be a hash in `Algolia::BannerLink` initialize method"
|
45
|
+
)
|
46
|
+
end
|
47
|
+
|
48
|
+
# check to see if the attribute exists and convert string to symbol for hash key
|
49
|
+
attributes = attributes.each_with_object({}) { |(k, v), h|
|
50
|
+
if (!self.class.attribute_map.key?(k.to_sym))
|
51
|
+
raise(
|
52
|
+
ArgumentError,
|
53
|
+
"`#{k}` is not a valid attribute in `Algolia::BannerLink`. Please check the name to make sure it's valid. List of attributes: " +
|
54
|
+
self.class.attribute_map.keys.inspect
|
55
|
+
)
|
56
|
+
end
|
57
|
+
|
58
|
+
h[k.to_sym] = v
|
59
|
+
}
|
60
|
+
|
61
|
+
if attributes.key?(:url)
|
62
|
+
self.url = attributes[:url]
|
63
|
+
end
|
64
|
+
end
|
65
|
+
|
66
|
+
# Checks equality by comparing each attribute.
|
67
|
+
# @param [Object] Object to be compared
|
68
|
+
def ==(other)
|
69
|
+
return true if self.equal?(other)
|
70
|
+
self.class == other.class &&
|
71
|
+
url == other.url
|
72
|
+
end
|
73
|
+
|
74
|
+
# @see the `==` method
|
75
|
+
# @param [Object] Object to be compared
|
76
|
+
def eql?(other)
|
77
|
+
self == other
|
78
|
+
end
|
79
|
+
|
80
|
+
# Calculates hash code according to all attributes.
|
81
|
+
# @return [Integer] Hash code
|
82
|
+
def hash
|
83
|
+
[url].hash
|
84
|
+
end
|
85
|
+
|
86
|
+
# Builds the object from hash
|
87
|
+
# @param [Hash] attributes Model attributes in the form of hash
|
88
|
+
# @return [Object] Returns the model itself
|
89
|
+
def self.build_from_hash(attributes)
|
90
|
+
return nil unless attributes.is_a?(Hash)
|
91
|
+
attributes = attributes.transform_keys(&:to_sym)
|
92
|
+
transformed_hash = {}
|
93
|
+
types_mapping.each_pair do |key, type|
|
94
|
+
if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
|
95
|
+
transformed_hash[key.to_sym] = nil
|
96
|
+
elsif type =~ /\AArray<(.*)>/i
|
97
|
+
# check to ensure the input is an array given that the attribute
|
98
|
+
# is documented as an array but the input is not
|
99
|
+
if attributes[attribute_map[key]].is_a?(Array)
|
100
|
+
transformed_hash[key.to_sym] = attributes[attribute_map[key]].map { |v|
|
101
|
+
_deserialize(::Regexp.last_match(1), v)
|
102
|
+
}
|
103
|
+
end
|
104
|
+
elsif !attributes[attribute_map[key]].nil?
|
105
|
+
transformed_hash[key.to_sym] = _deserialize(type, attributes[attribute_map[key]])
|
106
|
+
end
|
107
|
+
end
|
108
|
+
|
109
|
+
new(transformed_hash)
|
110
|
+
end
|
111
|
+
|
112
|
+
# Deserializes the data based on type
|
113
|
+
# @param string type Data type
|
114
|
+
# @param string value Value to be deserialized
|
115
|
+
# @return [Object] Deserialized data
|
116
|
+
def self._deserialize(type, value)
|
117
|
+
case type.to_sym
|
118
|
+
when :Time
|
119
|
+
Time.parse(value)
|
120
|
+
when :Date
|
121
|
+
Date.parse(value)
|
122
|
+
when :String
|
123
|
+
value.to_s
|
124
|
+
when :Integer
|
125
|
+
value.to_i
|
126
|
+
when :Float
|
127
|
+
value.to_f
|
128
|
+
when :Boolean
|
129
|
+
if value.to_s =~ /\A(true|t|yes|y|1)\z/i
|
130
|
+
true
|
131
|
+
else
|
132
|
+
false
|
133
|
+
end
|
134
|
+
|
135
|
+
when :Object
|
136
|
+
# generic object (usually a Hash), return directly
|
137
|
+
value
|
138
|
+
when /\AArray<(?<inner_type>.+)>\z/
|
139
|
+
inner_type = Regexp.last_match[:inner_type]
|
140
|
+
value.map { |v| _deserialize(inner_type, v) }
|
141
|
+
when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
|
142
|
+
k_type = Regexp.last_match[:k_type]
|
143
|
+
v_type = Regexp.last_match[:v_type]
|
144
|
+
{}.tap do |hash|
|
145
|
+
value.each do |k, v|
|
146
|
+
hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
|
147
|
+
end
|
148
|
+
end
|
149
|
+
# model
|
150
|
+
else
|
151
|
+
# models (e.g. Pet) or oneOf
|
152
|
+
klass = Algolia::Search.const_get(type)
|
153
|
+
klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass
|
154
|
+
.build_from_hash(value)
|
155
|
+
end
|
156
|
+
end
|
157
|
+
|
158
|
+
# Returns the string representation of the object
|
159
|
+
# @return [String] String presentation of the object
|
160
|
+
def to_s
|
161
|
+
to_hash.to_s
|
162
|
+
end
|
163
|
+
|
164
|
+
# to_body is an alias to to_hash (backward compatibility)
|
165
|
+
# @return [Hash] Returns the object in the form of hash
|
166
|
+
def to_body
|
167
|
+
to_hash
|
168
|
+
end
|
169
|
+
|
170
|
+
def to_json(*_args)
|
171
|
+
to_hash.to_json
|
172
|
+
end
|
173
|
+
|
174
|
+
# Returns the object in the form of hash
|
175
|
+
# @return [Hash] Returns the object in the form of hash
|
176
|
+
def to_hash
|
177
|
+
hash = {}
|
178
|
+
self.class.attribute_map.each_pair do |attr, param|
|
179
|
+
value = send(attr)
|
180
|
+
if value.nil?
|
181
|
+
is_nullable = self.class.openapi_nullable.include?(attr)
|
182
|
+
next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
|
183
|
+
end
|
184
|
+
|
185
|
+
hash[param] = _to_hash(value)
|
186
|
+
end
|
187
|
+
|
188
|
+
hash
|
189
|
+
end
|
190
|
+
|
191
|
+
# Outputs non-array value in the form of hash
|
192
|
+
# For object, use to_hash. Otherwise, just return the value
|
193
|
+
# @param [Object] value Any valid value
|
194
|
+
# @return [Hash] Returns the value in the form of hash
|
195
|
+
def _to_hash(value)
|
196
|
+
if value.is_a?(Array)
|
197
|
+
value.compact.map { |v| _to_hash(v) }
|
198
|
+
elsif value.is_a?(Hash)
|
199
|
+
{}.tap do |hash|
|
200
|
+
value.each { |k, v| hash[k] = _to_hash(v) }
|
201
|
+
end
|
202
|
+
elsif value.respond_to?(:to_hash)
|
203
|
+
value.to_hash
|
204
|
+
else
|
205
|
+
value
|
206
|
+
end
|
207
|
+
end
|
208
|
+
|
209
|
+
end
|
210
|
+
|
211
|
+
end
|
212
|
+
end
|
@@ -44,7 +44,7 @@ module Algolia
|
|
44
44
|
# Number of hits to retrieve (used in combination with `offset`).
|
45
45
|
attr_accessor :length
|
46
46
|
|
47
|
-
# Coordinates for the center of a circle, expressed as a comma-separated string of latitude and longitude. Only records included within circle around this central location are included in the results. The radius of the circle is determined by the `aroundRadius` and `minimumAroundRadius` settings. This parameter is ignored if you also specify `insidePolygon` or `insideBoundingBox`.
|
47
|
+
# Coordinates for the center of a circle, expressed as a comma-separated string of latitude and longitude. Only records included within a circle around this central location are included in the results. The radius of the circle is determined by the `aroundRadius` and `minimumAroundRadius` settings. This parameter is ignored if you also specify `insidePolygon` or `insideBoundingBox`.
|
48
48
|
attr_accessor :around_lat_lng
|
49
49
|
|
50
50
|
# Whether to obtain the coordinates from the request's IP address.
|
@@ -173,10 +173,10 @@ module Algolia
|
|
173
173
|
# Whether to support phrase matching and excluding words from search queries. Use the `advancedSyntaxFeatures` parameter to control which feature is supported.
|
174
174
|
attr_accessor :advanced_syntax
|
175
175
|
|
176
|
-
# Words that should be considered optional when found in the query. By default, records must match all words in the search query to be included in the search results. Adding optional words can help to increase the number of search results by running an additional search query that doesn't include the optional words. For example, if the search query is \"action video\" and \"video\" is an optional word, the search engine runs two queries. One for \"action video\" and one for \"action\". Records that match all words are ranked higher. For a search query with 4 or more words **and** all its words are optional, the number of matched words required for a record to be included in the search results increases for every 1,000 records: - If `optionalWords` has less than 10 words, the required number of matched words increases by 1: results 1 to 1,000 require 1 matched word, results 1,001 to 2000 need 2 matched words. - If `optionalWords` has 10 or more words, the number of required matched words increases by the number of optional words
|
176
|
+
# Words that should be considered optional when found in the query. By default, records must match all words in the search query to be included in the search results. Adding optional words can help to increase the number of search results by running an additional search query that doesn't include the optional words. For example, if the search query is \"action video\" and \"video\" is an optional word, the search engine runs two queries. One for \"action video\" and one for \"action\". Records that match all words are ranked higher. For a search query with 4 or more words **and** all its words are optional, the number of matched words required for a record to be included in the search results increases for every 1,000 records: - If `optionalWords` has less than 10 words, the required number of matched words increases by 1: results 1 to 1,000 require 1 matched word, results 1,001 to 2000 need 2 matched words. - If `optionalWords` has 10 or more words, the number of required matched words increases by the number of optional words divided by 5 (rounded down). For example, with 18 optional words: results 1 to 1,000 require 1 matched word, results 1,001 to 2000 need 4 matched words. For more information, see [Optional words](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/empty-or-insufficient-results/#creating-a-list-of-optional-words).
|
177
177
|
attr_accessor :optional_words
|
178
178
|
|
179
|
-
# Searchable attributes for which you want to [turn off the Exact ranking criterion](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/override-search-engine-defaults/in-depth/adjust-exact-settings/#turn-off-exact-for-some-attributes). Attribute names are case-sensitive. This can be useful for attributes with long values, where the
|
179
|
+
# Searchable attributes for which you want to [turn off the Exact ranking criterion](https://www.algolia.com/doc/guides/managing-results/optimize-search-results/override-search-engine-defaults/in-depth/adjust-exact-settings/#turn-off-exact-for-some-attributes). Attribute names are case-sensitive. This can be useful for attributes with long values, where the likelihood of an exact match is high, such as product descriptions. Turning off the Exact ranking criterion for these attributes favors exact matching on other attributes. This reduces the impact of individual attributes with a lot of content on ranking.
|
180
180
|
attr_accessor :disable_exact_on_attributes
|
181
181
|
|
182
182
|
attr_accessor :exact_on_single_word_query
|
@@ -189,7 +189,7 @@ module Algolia
|
|
189
189
|
|
190
190
|
attr_accessor :distinct
|
191
191
|
|
192
|
-
# Whether to replace a highlighted word with the matched synonym. By default, the original words are highlighted even if a synonym matches. For example, with `home` as a synonym for `house` and a search for `home`, records matching either \"home\" or \"house\" are included in the search results, and either \"home\" or \"house\" are highlighted. With `replaceSynonymsInHighlight` set to `true`, a search for `home` still matches the same records, but all
|
192
|
+
# Whether to replace a highlighted word with the matched synonym. By default, the original words are highlighted even if a synonym matches. For example, with `home` as a synonym for `house` and a search for `home`, records matching either \"home\" or \"house\" are included in the search results, and either \"home\" or \"house\" are highlighted. With `replaceSynonymsInHighlight` set to `true`, a search for `home` still matches the same records, but all occurrences of \"house\" are replaced by \"home\" in the highlighted response.
|
193
193
|
attr_accessor :replace_synonyms_in_highlight
|
194
194
|
|
195
195
|
# Minimum proximity score for two matching words. This adjusts the [Proximity ranking criterion](https://www.algolia.com/doc/guides/managing-results/relevance-overview/in-depth/ranking-criteria/#proximity) by equally scoring matches that are farther apart. For example, if `minProximity` is 2, neighboring matches and matches with one word between them would have the same score.
|
@@ -776,134 +776,6 @@ module Algolia
|
|
776
776
|
end
|
777
777
|
end
|
778
778
|
|
779
|
-
# Custom attribute writer method with validation
|
780
|
-
# @param [Object] page Value to be assigned
|
781
|
-
def page=(page)
|
782
|
-
if page.nil?
|
783
|
-
raise ArgumentError, "page cannot be nil"
|
784
|
-
end
|
785
|
-
|
786
|
-
if page < 0
|
787
|
-
raise ArgumentError, "invalid value for \"page\", must be greater than or equal to 0."
|
788
|
-
end
|
789
|
-
|
790
|
-
@page = page
|
791
|
-
end
|
792
|
-
|
793
|
-
# Custom attribute writer method with validation
|
794
|
-
# @param [Object] length Value to be assigned
|
795
|
-
def length=(length)
|
796
|
-
if length.nil?
|
797
|
-
raise ArgumentError, "length cannot be nil"
|
798
|
-
end
|
799
|
-
|
800
|
-
if length > 1000
|
801
|
-
raise ArgumentError, "invalid value for \"length\", must be smaller than or equal to 1000."
|
802
|
-
end
|
803
|
-
|
804
|
-
if length < 0
|
805
|
-
raise ArgumentError, "invalid value for \"length\", must be greater than or equal to 0."
|
806
|
-
end
|
807
|
-
|
808
|
-
@length = length
|
809
|
-
end
|
810
|
-
|
811
|
-
# Custom attribute writer method with validation
|
812
|
-
# @param [Object] minimum_around_radius Value to be assigned
|
813
|
-
def minimum_around_radius=(minimum_around_radius)
|
814
|
-
if minimum_around_radius.nil?
|
815
|
-
raise ArgumentError, "minimum_around_radius cannot be nil"
|
816
|
-
end
|
817
|
-
|
818
|
-
if minimum_around_radius < 1
|
819
|
-
raise ArgumentError, "invalid value for \"minimum_around_radius\", must be greater than or equal to 1."
|
820
|
-
end
|
821
|
-
|
822
|
-
@minimum_around_radius = minimum_around_radius
|
823
|
-
end
|
824
|
-
|
825
|
-
# Custom attribute writer method with validation
|
826
|
-
# @param [Object] personalization_impact Value to be assigned
|
827
|
-
def personalization_impact=(personalization_impact)
|
828
|
-
if personalization_impact.nil?
|
829
|
-
raise ArgumentError, "personalization_impact cannot be nil"
|
830
|
-
end
|
831
|
-
|
832
|
-
if personalization_impact > 100
|
833
|
-
raise ArgumentError, "invalid value for \"personalization_impact\", must be smaller than or equal to 100."
|
834
|
-
end
|
835
|
-
|
836
|
-
if personalization_impact < 0
|
837
|
-
raise ArgumentError, "invalid value for \"personalization_impact\", must be greater than or equal to 0."
|
838
|
-
end
|
839
|
-
|
840
|
-
@personalization_impact = personalization_impact
|
841
|
-
end
|
842
|
-
|
843
|
-
# Custom attribute writer method with validation
|
844
|
-
# @param [Object] hits_per_page Value to be assigned
|
845
|
-
def hits_per_page=(hits_per_page)
|
846
|
-
if hits_per_page.nil?
|
847
|
-
raise ArgumentError, "hits_per_page cannot be nil"
|
848
|
-
end
|
849
|
-
|
850
|
-
if hits_per_page > 1000
|
851
|
-
raise ArgumentError, "invalid value for \"hits_per_page\", must be smaller than or equal to 1000."
|
852
|
-
end
|
853
|
-
|
854
|
-
if hits_per_page < 1
|
855
|
-
raise ArgumentError, "invalid value for \"hits_per_page\", must be greater than or equal to 1."
|
856
|
-
end
|
857
|
-
|
858
|
-
@hits_per_page = hits_per_page
|
859
|
-
end
|
860
|
-
|
861
|
-
# Custom attribute writer method with validation
|
862
|
-
# @param [Object] min_proximity Value to be assigned
|
863
|
-
def min_proximity=(min_proximity)
|
864
|
-
if min_proximity.nil?
|
865
|
-
raise ArgumentError, "min_proximity cannot be nil"
|
866
|
-
end
|
867
|
-
|
868
|
-
if min_proximity > 7
|
869
|
-
raise ArgumentError, "invalid value for \"min_proximity\", must be smaller than or equal to 7."
|
870
|
-
end
|
871
|
-
|
872
|
-
if min_proximity < 1
|
873
|
-
raise ArgumentError, "invalid value for \"min_proximity\", must be greater than or equal to 1."
|
874
|
-
end
|
875
|
-
|
876
|
-
@min_proximity = min_proximity
|
877
|
-
end
|
878
|
-
|
879
|
-
# Custom attribute writer method with validation
|
880
|
-
# @param [Object] max_facet_hits Value to be assigned
|
881
|
-
def max_facet_hits=(max_facet_hits)
|
882
|
-
if max_facet_hits.nil?
|
883
|
-
raise ArgumentError, "max_facet_hits cannot be nil"
|
884
|
-
end
|
885
|
-
|
886
|
-
if max_facet_hits > 100
|
887
|
-
raise ArgumentError, "invalid value for \"max_facet_hits\", must be smaller than or equal to 100."
|
888
|
-
end
|
889
|
-
|
890
|
-
@max_facet_hits = max_facet_hits
|
891
|
-
end
|
892
|
-
|
893
|
-
# Custom attribute writer method with validation
|
894
|
-
# @param [Object] max_values_per_facet Value to be assigned
|
895
|
-
def max_values_per_facet=(max_values_per_facet)
|
896
|
-
if max_values_per_facet.nil?
|
897
|
-
raise ArgumentError, "max_values_per_facet cannot be nil"
|
898
|
-
end
|
899
|
-
|
900
|
-
if max_values_per_facet > 1000
|
901
|
-
raise ArgumentError, "invalid value for \"max_values_per_facet\", must be smaller than or equal to 1000."
|
902
|
-
end
|
903
|
-
|
904
|
-
@max_values_per_facet = max_values_per_facet
|
905
|
-
end
|
906
|
-
|
907
779
|
# Checks equality by comparing each attribute.
|
908
780
|
# @param [Object] Object to be compared
|
909
781
|
def ==(other)
|
@@ -372,67 +372,6 @@ module Algolia
|
|
372
372
|
end
|
373
373
|
end
|
374
374
|
|
375
|
-
# Custom attribute writer method with validation
|
376
|
-
# @param [Object] ab_test_variant_id Value to be assigned
|
377
|
-
def ab_test_variant_id=(ab_test_variant_id)
|
378
|
-
if ab_test_variant_id.nil?
|
379
|
-
raise ArgumentError, "ab_test_variant_id cannot be nil"
|
380
|
-
end
|
381
|
-
|
382
|
-
if ab_test_variant_id < 1
|
383
|
-
raise ArgumentError, "invalid value for \"ab_test_variant_id\", must be greater than or equal to 1."
|
384
|
-
end
|
385
|
-
|
386
|
-
@ab_test_variant_id = ab_test_variant_id
|
387
|
-
end
|
388
|
-
|
389
|
-
# Custom attribute writer method with validation
|
390
|
-
# @param [Object] around_lat_lng Value to be assigned
|
391
|
-
def around_lat_lng=(around_lat_lng)
|
392
|
-
if around_lat_lng.nil?
|
393
|
-
raise ArgumentError, "around_lat_lng cannot be nil"
|
394
|
-
end
|
395
|
-
|
396
|
-
pattern = /^(-?\d+(\.\d+)?),\s*(-?\d+(\.\d+)?)$/
|
397
|
-
if around_lat_lng !~ pattern
|
398
|
-
raise ArgumentError, "invalid value for \"around_lat_lng\", must conform to the pattern #{pattern}."
|
399
|
-
end
|
400
|
-
|
401
|
-
@around_lat_lng = around_lat_lng
|
402
|
-
end
|
403
|
-
|
404
|
-
# Custom attribute writer method with validation
|
405
|
-
# @param [Object] page Value to be assigned
|
406
|
-
def page=(page)
|
407
|
-
if page.nil?
|
408
|
-
raise ArgumentError, "page cannot be nil"
|
409
|
-
end
|
410
|
-
|
411
|
-
if page < 0
|
412
|
-
raise ArgumentError, "invalid value for \"page\", must be greater than or equal to 0."
|
413
|
-
end
|
414
|
-
|
415
|
-
@page = page
|
416
|
-
end
|
417
|
-
|
418
|
-
# Custom attribute writer method with validation
|
419
|
-
# @param [Object] hits_per_page Value to be assigned
|
420
|
-
def hits_per_page=(hits_per_page)
|
421
|
-
if hits_per_page.nil?
|
422
|
-
raise ArgumentError, "hits_per_page cannot be nil"
|
423
|
-
end
|
424
|
-
|
425
|
-
if hits_per_page > 1000
|
426
|
-
raise ArgumentError, "invalid value for \"hits_per_page\", must be smaller than or equal to 1000."
|
427
|
-
end
|
428
|
-
|
429
|
-
if hits_per_page < 1
|
430
|
-
raise ArgumentError, "invalid value for \"hits_per_page\", must be greater than or equal to 1."
|
431
|
-
end
|
432
|
-
|
433
|
-
@hits_per_page = hits_per_page
|
434
|
-
end
|
435
|
-
|
436
375
|
# Checks equality by comparing each attribute.
|
437
376
|
# @param [Object] Object to be compared
|
438
377
|
def ==(other)
|
@@ -98,21 +98,6 @@ module Algolia
|
|
98
98
|
end
|
99
99
|
end
|
100
100
|
|
101
|
-
# Custom attribute writer method with validation
|
102
|
-
# @param [Object] context Value to be assigned
|
103
|
-
def context=(context)
|
104
|
-
if context.nil?
|
105
|
-
raise ArgumentError, "context cannot be nil"
|
106
|
-
end
|
107
|
-
|
108
|
-
pattern = /[A-Za-z0-9_-]+/
|
109
|
-
if context !~ pattern
|
110
|
-
raise ArgumentError, "invalid value for \"context\", must conform to the pattern #{pattern}."
|
111
|
-
end
|
112
|
-
|
113
|
-
@context = context
|
114
|
-
end
|
115
|
-
|
116
101
|
# Checks equality by comparing each attribute.
|
117
102
|
# @param [Object] Object to be compared
|
118
103
|
def ==(other)
|