algolia 3.0.0.alpha.16 → 3.0.0.alpha.17

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (116) hide show
  1. checksums.yaml +4 -4
  2. data/.openapi-generator/FILES +10 -167
  3. data/CHANGELOG.md +9 -0
  4. data/Gemfile.lock +1 -1
  5. data/lib/algolia/api/analytics_client.rb +76 -76
  6. data/lib/algolia/api/recommend_client.rb +22 -22
  7. data/lib/algolia/api/search_client.rb +8 -8
  8. data/lib/algolia/api/usage_client.rb +329 -0
  9. data/lib/algolia/models/analytics/get_status_response.rb +1 -1
  10. data/lib/algolia/models/ingestion/auth_algolia_insights.rb +212 -0
  11. data/lib/algolia/models/{recommend/consequence_query_object.rb → ingestion/auth_algolia_insights_partial.rb} +21 -24
  12. data/lib/algolia/models/ingestion/auth_input.rb +1 -0
  13. data/lib/algolia/models/ingestion/auth_input_partial.rb +1 -0
  14. data/lib/algolia/models/ingestion/authentication_type.rb +2 -1
  15. data/lib/algolia/models/insights/added_to_cart_object_ids.rb +1 -1
  16. data/lib/algolia/models/insights/added_to_cart_object_ids_after_search.rb +1 -1
  17. data/lib/algolia/models/insights/clicked_filters.rb +1 -1
  18. data/lib/algolia/models/insights/clicked_object_ids.rb +1 -1
  19. data/lib/algolia/models/insights/clicked_object_ids_after_search.rb +1 -1
  20. data/lib/algolia/models/insights/converted_filters.rb +1 -1
  21. data/lib/algolia/models/insights/converted_object_ids.rb +1 -1
  22. data/lib/algolia/models/insights/converted_object_ids_after_search.rb +1 -1
  23. data/lib/algolia/models/insights/purchased_object_ids.rb +1 -1
  24. data/lib/algolia/models/insights/purchased_object_ids_after_search.rb +1 -1
  25. data/lib/algolia/models/insights/viewed_filters.rb +1 -1
  26. data/lib/algolia/models/insights/viewed_object_ids.rb +1 -1
  27. data/lib/algolia/models/monitoring/incidents_inner.rb +1 -1
  28. data/lib/algolia/models/monitoring/probes_metric.rb +1 -1
  29. data/lib/algolia/models/monitoring/time_inner.rb +1 -1
  30. data/lib/algolia/models/query-suggestions/get_config_status200_response.rb +2 -2
  31. data/lib/algolia/models/query-suggestions/get_log_file200_response.rb +1 -1
  32. data/lib/algolia/models/recommend/auto_facet_filter.rb +208 -0
  33. data/lib/algolia/models/recommend/base_recommend_request.rb +36 -7
  34. data/lib/algolia/models/recommend/base_search_params.rb +1 -1
  35. data/lib/algolia/models/recommend/base_search_params_without_query.rb +1 -1
  36. data/lib/algolia/models/recommend/bought_together_query.rb +319 -0
  37. data/lib/algolia/models/recommend/condition.rb +12 -62
  38. data/lib/algolia/models/recommend/consequence.rb +32 -54
  39. data/lib/algolia/models/recommend/deleted_at_response.rb +1 -1
  40. data/lib/algolia/models/recommend/{recommended_for_you_query_parameters.rb → fallback_params.rb} +9 -12
  41. data/lib/algolia/models/recommend/{edit_type.rb → fbt_model.rb} +5 -6
  42. data/lib/algolia/models/recommend/{base_trending_facets_query.rb → frequently_bought_together.rb} +20 -18
  43. data/lib/algolia/models/recommend/get_recommendations_params.rb +2 -2
  44. data/lib/algolia/models/recommend/{consequence_hide.rb → hide_consequence_object.rb} +4 -6
  45. data/lib/algolia/models/recommend/index_settings_as_search_params.rb +5 -5
  46. data/lib/algolia/models/recommend/{base_recommendations_query.rb → looking_similar.rb} +6 -15
  47. data/lib/algolia/models/recommend/{anchoring.rb → looking_similar_model.rb} +5 -8
  48. data/lib/algolia/models/recommend/looking_similar_query.rb +328 -0
  49. data/lib/algolia/models/recommend/{params.rb → params_consequence.rb} +26 -28
  50. data/lib/algolia/models/recommend/{promote_object_id.rb → promote_consequence_object.rb} +19 -9
  51. data/lib/algolia/models/recommend/{rule_response.rb → recommend_rule.rb} +13 -18
  52. data/lib/algolia/models/recommend/{rule_response_metadata.rb → recommend_rule_metadata.rb} +5 -4
  53. data/lib/algolia/models/recommend/recommendations_hits.rb +4 -24
  54. data/lib/algolia/models/recommend/recommendations_request.rb +3 -1
  55. data/lib/algolia/models/recommend/recommendations_results.rb +4 -24
  56. data/lib/algolia/models/recommend/{base_recommended_for_you_query.rb → recommended_for_you.rb} +5 -14
  57. data/lib/algolia/models/recommend/recommended_for_you_query.rb +35 -15
  58. data/lib/algolia/models/recommend/{recommendation_models.rb → related_model.rb} +4 -5
  59. data/lib/algolia/models/recommend/{edit.rb → related_products.rb} +27 -24
  60. data/lib/algolia/models/recommend/{recommendations_query.rb → related_query.rb} +39 -19
  61. data/lib/algolia/models/recommend/{consequence_params.rb → search_params.rb} +25 -44
  62. data/lib/algolia/models/recommend/search_params_object.rb +6 -6
  63. data/lib/algolia/models/recommend/search_recommend_rules_params.rb +58 -10
  64. data/lib/algolia/models/recommend/search_recommend_rules_response.rb +2 -2
  65. data/lib/algolia/models/recommend/trending_facet_hit.rb +2 -2
  66. data/lib/algolia/models/recommend/trending_facets.rb +243 -0
  67. data/lib/algolia/models/recommend/trending_facets_query.rb +50 -10
  68. data/lib/algolia/models/recommend/{base_trending_items_query.rb → trending_items.rb} +12 -15
  69. data/lib/algolia/models/recommend/trending_items_query.rb +42 -16
  70. data/lib/algolia/models/search/add_api_key_response.rb +1 -1
  71. data/lib/algolia/models/search/base_get_api_key_response.rb +1 -1
  72. data/lib/algolia/models/search/base_index_settings.rb +4 -4
  73. data/lib/algolia/models/search/base_search_params.rb +1 -1
  74. data/lib/algolia/models/search/base_search_params_without_query.rb +1 -1
  75. data/lib/algolia/models/search/browse_params_object.rb +6 -6
  76. data/lib/algolia/models/search/consequence_params.rb +6 -6
  77. data/lib/algolia/models/search/created_at_response.rb +1 -1
  78. data/lib/algolia/models/search/delete_api_key_response.rb +1 -1
  79. data/lib/algolia/models/search/delete_by_params.rb +1 -1
  80. data/lib/algolia/models/search/delete_source_response.rb +1 -1
  81. data/lib/algolia/models/search/deleted_at_response.rb +1 -1
  82. data/lib/algolia/models/search/fetched_index.rb +1 -1
  83. data/lib/algolia/models/search/get_api_key_response.rb +1 -1
  84. data/lib/algolia/models/search/index_settings.rb +9 -9
  85. data/lib/algolia/models/search/index_settings_as_search_params.rb +5 -5
  86. data/lib/algolia/models/search/log.rb +1 -1
  87. data/lib/algolia/models/search/remove_user_id_response.rb +1 -1
  88. data/lib/algolia/models/search/replace_source_response.rb +1 -1
  89. data/lib/algolia/models/search/save_object_response.rb +1 -1
  90. data/lib/algolia/models/search/save_synonym_response.rb +1 -1
  91. data/lib/algolia/models/search/search_for_facets.rb +6 -6
  92. data/lib/algolia/models/search/search_for_hits.rb +6 -6
  93. data/lib/algolia/models/search/search_params_object.rb +6 -6
  94. data/lib/algolia/models/search/search_user_ids_response.rb +1 -1
  95. data/lib/algolia/models/search/secured_api_key_restrictions.rb +1 -1
  96. data/lib/algolia/models/search/update_api_key_response.rb +1 -1
  97. data/lib/algolia/models/search/updated_at_response.rb +1 -1
  98. data/lib/algolia/models/search/updated_at_with_object_id_response.rb +1 -1
  99. data/lib/algolia/models/search/updated_rule_response.rb +1 -1
  100. data/lib/algolia/models/search/user_hit.rb +1 -1
  101. data/lib/algolia/models/search/user_id.rb +1 -1
  102. data/lib/algolia/models/usage/error_base.rb +205 -0
  103. data/lib/algolia/models/usage/get_usage200_response.rb +198 -0
  104. data/lib/algolia/models/usage/get_usage200_response_statistics_inner.rb +206 -0
  105. data/lib/algolia/models/{recommend/base_recommended_for_you_query_parameters.rb → usage/get_usage400_response.rb} +13 -14
  106. data/lib/algolia/models/usage/get_usage400_response_error.rb +216 -0
  107. data/lib/algolia/models/usage/get_usage400_response_error_errors_inner.rb +225 -0
  108. data/lib/algolia/models/usage/granularity.rb +33 -0
  109. data/lib/algolia/models/usage/statistic.rb +116 -0
  110. data/lib/algolia/models/{recommend/promote.rb → usage/statistic_value.rb} +5 -5
  111. data/lib/algolia/version.rb +1 -1
  112. metadata +34 -25
  113. data/lib/algolia/models/recommend/automatic_facet_filter.rb +0 -220
  114. data/lib/algolia/models/recommend/automatic_facet_filters.rb +0 -97
  115. data/lib/algolia/models/recommend/consequence_query.rb +0 -97
  116. data/lib/algolia/models/recommend/promote_object_ids.rb +0 -228
@@ -0,0 +1,225 @@
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 Usage
8
+ class GetUsage400ResponseErrorErrorsInner
9
+ attr_accessor :code
10
+
11
+ attr_accessor :message
12
+
13
+ attr_accessor :line
14
+
15
+ attr_accessor :position
16
+
17
+ # Attribute mapping from ruby-style variable name to JSON key.
18
+ def self.attribute_map
19
+ {
20
+ :code => :code,
21
+ :message => :message,
22
+ :line => :line,
23
+ :position => :position
24
+ }
25
+ end
26
+
27
+ # Returns all the JSON keys this model knows about
28
+ def self.acceptable_attributes
29
+ attribute_map.values
30
+ end
31
+
32
+ # Attribute type mapping.
33
+ def self.types_mapping
34
+ {
35
+ :code => :String,
36
+ :message => :String,
37
+ :line => :Integer,
38
+ :position => :Integer
39
+ }
40
+ end
41
+
42
+ # List of attributes with nullable: true
43
+ def self.openapi_nullable
44
+ Set.new([])
45
+ end
46
+
47
+ # Initializes the object
48
+ # @param [Hash] attributes Model attributes in the form of hash
49
+ def initialize(attributes = {})
50
+ unless attributes.is_a?(Hash)
51
+ raise ArgumentError, "The input argument (attributes) must be a hash in `Algolia::GetUsage400ResponseErrorErrorsInner` initialize method"
52
+ end
53
+
54
+ # check to see if the attribute exists and convert string to symbol for hash key
55
+ attributes = attributes.each_with_object({}) do |(k, v), h|
56
+ unless self.class.attribute_map.key?(k.to_sym)
57
+ raise ArgumentError,
58
+ "`#{k}` is not a valid attribute in `Algolia::GetUsage400ResponseErrorErrorsInner`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
59
+ end
60
+
61
+ h[k.to_sym] = v
62
+ end
63
+
64
+ if attributes.key?(:code)
65
+ self.code = attributes[:code]
66
+ end
67
+
68
+ if attributes.key?(:message)
69
+ self.message = attributes[:message]
70
+ else
71
+ self.message = nil
72
+ end
73
+
74
+ if attributes.key?(:line)
75
+ self.line = attributes[:line]
76
+ end
77
+
78
+ if attributes.key?(:position)
79
+ self.position = attributes[:position]
80
+ end
81
+ end
82
+
83
+ # Checks equality by comparing each attribute.
84
+ # @param [Object] Object to be compared
85
+ def ==(other)
86
+ return true if equal?(other)
87
+
88
+ self.class == other.class &&
89
+ code == other.code &&
90
+ message == other.message &&
91
+ line == other.line &&
92
+ position == other.position
93
+ end
94
+
95
+ # @see the `==` method
96
+ # @param [Object] Object to be compared
97
+ def eql?(other)
98
+ self == other
99
+ end
100
+
101
+ # Calculates hash code according to all attributes.
102
+ # @return [Integer] Hash code
103
+ def hash
104
+ [code, message, line, position].hash
105
+ end
106
+
107
+ # Builds the object from hash
108
+ # @param [Hash] attributes Model attributes in the form of hash
109
+ # @return [Object] Returns the model itself
110
+ def self.build_from_hash(attributes)
111
+ return nil unless attributes.is_a?(Hash)
112
+
113
+ attributes = attributes.transform_keys(&:to_sym)
114
+ transformed_hash = {}
115
+ types_mapping.each_pair do |key, type|
116
+ if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
117
+ transformed_hash[key.to_sym] = nil
118
+ elsif type =~ /\AArray<(.*)>/i
119
+ # check to ensure the input is an array given that the attribute
120
+ # is documented as an array but the input is not
121
+ if attributes[attribute_map[key]].is_a?(Array)
122
+ transformed_hash[key.to_sym] = attributes[attribute_map[key]].map { |v| _deserialize(::Regexp.last_match(1), v) }
123
+ end
124
+ elsif !attributes[attribute_map[key]].nil?
125
+ transformed_hash[key.to_sym] = _deserialize(type, attributes[attribute_map[key]])
126
+ end
127
+ end
128
+ new(transformed_hash)
129
+ end
130
+
131
+ # Deserializes the data based on type
132
+ # @param string type Data type
133
+ # @param string value Value to be deserialized
134
+ # @return [Object] Deserialized data
135
+ def self._deserialize(type, value)
136
+ case type.to_sym
137
+ when :Time
138
+ Time.parse(value)
139
+ when :Date
140
+ Date.parse(value)
141
+ when :String
142
+ value.to_s
143
+ when :Integer
144
+ value.to_i
145
+ when :Float
146
+ value.to_f
147
+ when :Boolean
148
+ if value.to_s =~ /\A(true|t|yes|y|1)\z/i
149
+ true
150
+ else
151
+ false
152
+ end
153
+ when :Object
154
+ # generic object (usually a Hash), return directly
155
+ value
156
+ when /\AArray<(?<inner_type>.+)>\z/
157
+ inner_type = Regexp.last_match[:inner_type]
158
+ value.map { |v| _deserialize(inner_type, v) }
159
+ when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
160
+ k_type = Regexp.last_match[:k_type]
161
+ v_type = Regexp.last_match[:v_type]
162
+ {}.tap do |hash|
163
+ value.each do |k, v|
164
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
165
+ end
166
+ end
167
+ else # model
168
+ # models (e.g. Pet) or oneOf
169
+ klass = Algolia::Usage.const_get(type)
170
+ klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
171
+ end
172
+ end
173
+
174
+ # Returns the string representation of the object
175
+ # @return [String] String presentation of the object
176
+ def to_s
177
+ to_hash.to_s
178
+ end
179
+
180
+ # to_body is an alias to to_hash (backward compatibility)
181
+ # @return [Hash] Returns the object in the form of hash
182
+ def to_body
183
+ to_hash
184
+ end
185
+
186
+ def to_json(*_args)
187
+ to_hash.to_json
188
+ end
189
+
190
+ # Returns the object in the form of hash
191
+ # @return [Hash] Returns the object in the form of hash
192
+ def to_hash
193
+ hash = {}
194
+ self.class.attribute_map.each_pair do |attr, param|
195
+ value = send(attr)
196
+ if value.nil?
197
+ is_nullable = self.class.openapi_nullable.include?(attr)
198
+ next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
199
+ end
200
+
201
+ hash[param] = _to_hash(value)
202
+ end
203
+ hash
204
+ end
205
+
206
+ # Outputs non-array value in the form of hash
207
+ # For object, use to_hash. Otherwise, just return the value
208
+ # @param [Object] value Any valid value
209
+ # @return [Hash] Returns the value in the form of hash
210
+ def _to_hash(value)
211
+ if value.is_a?(Array)
212
+ value.compact.map { |v| _to_hash(v) }
213
+ elsif value.is_a?(Hash)
214
+ {}.tap do |hash|
215
+ value.each { |k, v| hash[k] = _to_hash(v) }
216
+ end
217
+ elsif value.respond_to? :to_hash
218
+ value.to_hash
219
+ else
220
+ value
221
+ end
222
+ end
223
+ end
224
+ end
225
+ end
@@ -0,0 +1,33 @@
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 Usage
8
+ class Granularity
9
+ HOURLY = "hourly".freeze
10
+ DAILY = "daily".freeze
11
+
12
+ def self.all_vars
13
+ @all_vars ||= [HOURLY, DAILY].freeze
14
+ end
15
+
16
+ # Builds the enum from string
17
+ # @param [String] The enum value in the form of the string
18
+ # @return [String] The enum value
19
+ def self.build_from_hash(value)
20
+ new.build_from_hash(value)
21
+ end
22
+
23
+ # Builds the enum from string
24
+ # @param [String] The enum value in the form of the string
25
+ # @return [String] The enum value
26
+ def build_from_hash(value)
27
+ return value if Granularity.all_vars.include?(value)
28
+
29
+ raise "Invalid ENUM value #{value} for class #Granularity"
30
+ end
31
+ end
32
+ end
33
+ end
@@ -0,0 +1,116 @@
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 Usage
8
+ class Statistic
9
+ ALL = "*".freeze
10
+ SEARCH_OPERATIONS = "search_operations".freeze
11
+ TOTAL_SEARCH_OPERATIONS = "total_search_operations".freeze
12
+ TOTAL_SEARCH_REQUESTS = "total_search_requests".freeze
13
+ QUERIES_OPERATIONS = "queries_operations".freeze
14
+ MULTI_QUERIES_OPERATIONS = "multi_queries_operations".freeze
15
+ ACL_OPERATIONS = "acl_operations".freeze
16
+ TOTAL_ACL_OPERATIONS = "total_acl_operations".freeze
17
+ GET_API_KEYS_OPERATIONS = "get_api_keys_operations".freeze
18
+ GET_API_KEY_OPERATIONS = "get_api_key_operations".freeze
19
+ ADD_API_KEY_OPERATIONS = "add_api_key_operations".freeze
20
+ UPDATE_API_KEY_OPERATIONS = "update_api_key_operations".freeze
21
+ DELETE_API_KEY_OPERATIONS = "delete_api_key_operations".freeze
22
+ LIST_API_KEY_OPERATIONS = "list_api_key_operations".freeze
23
+ INDEXING_OPERATIONS = "indexing_operations".freeze
24
+ TOTAL_INDEXING_OPERATIONS = "total_indexing_operations".freeze
25
+ BROWSE_OPERATIONS = "browse_operations".freeze
26
+ CLEAR_INDEX_OPERATIONS = "clear_index_operations".freeze
27
+ COPY_MOVE_OPERATIONS = "copy_move_operations".freeze
28
+ DELETE_INDEX_OPERATIONS = "delete_index_operations".freeze
29
+ GET_LOG_OPERATIONS = "get_log_operations".freeze
30
+ GET_SETTINGS_OPERATIONS = "get_settings_operations".freeze
31
+ SET_SETTINGS_OPERATIONS = "set_settings_operations".freeze
32
+ LIST_INDICES_OPERATIONS = "list_indices_operations".freeze
33
+ WAIT_TASK_OPERATIONS = "wait_task_operations".freeze
34
+ RECORD_OPERATIONS = "record_operations".freeze
35
+ TOTAL_RECORDS_OPERATIONS = "total_records_operations".freeze
36
+ ADD_RECORD_OPERATIONS = "add_record_operations".freeze
37
+ BATCH_OPERATIONS = "batch_operations".freeze
38
+ DELETE_BY_QUERY_OPERATIONS = "delete_by_query_operations".freeze
39
+ DELETE_RECORD_OPERATIONS = "delete_record_operations".freeze
40
+ GET_RECORD_OPERATIONS = "get_record_operations".freeze
41
+ PARTIAL_UPDATE_RECORD_OPERATIONS = "partial_update_record_operations".freeze
42
+ UPDATE_RECORD_OPERATIONS = "update_record_operations".freeze
43
+ SYNONYM_OPERATIONS = "synonym_operations".freeze
44
+ TOTAL_SYNONYM_OPERATIONS = "total_synonym_operations".freeze
45
+ BATCH_SYNONYM_OPERATIONS = "batch_synonym_operations".freeze
46
+ CLEAR_SYNONYM_OPERATIONS = "clear_synonym_operations".freeze
47
+ DELETE_SYNONYM_OPERATIONS = "delete_synonym_operations".freeze
48
+ GET_SYNONYM_OPERATIONS = "get_synonym_operations".freeze
49
+ QUERY_SYNONYM_OPERATIONS = "query_synonym_operations".freeze
50
+ UPDATE_SYNONYM_OPERATIONS = "update_synonym_operations".freeze
51
+ RULE_OPERATIONS = "rule_operations".freeze
52
+ TOTAL_RULES_OPERATIONS = "total_rules_operations".freeze
53
+ BATCH_RULES_OPERATIONS = "batch_rules_operations".freeze
54
+ CLEAR_RULES_OPERATIONS = "clear_rules_operations".freeze
55
+ DELETE_RULES_OPERATIONS = "delete_rules_operations".freeze
56
+ GET_RULES_OPERATIONS = "get_rules_operations".freeze
57
+ SAVE_RULES_OPERATIONS = "save_rules_operations".freeze
58
+ SEARCH_RULES_OPERATIONS = "search_rules_operations".freeze
59
+ TOTAL_RECOMMEND_REQUESTS = "total_recommend_requests".freeze
60
+ TOTAL_WRITE_OPERATIONS = "total_write_operations".freeze
61
+ TOTAL_READ_OPERATIONS = "total_read_operations".freeze
62
+ TOTAL_OPERATIONS = "total_operations".freeze
63
+ QUERYSUGGESTIONS_TOTAL_SEARCH_OPERATIONS = "querysuggestions_total_search_operations".freeze
64
+ QUERYSUGGESTIONS_TOTAL_SEARCH_REQUESTS = "querysuggestions_total_search_requests".freeze
65
+ QUERYSUGGESTIONS_TOTAL_ACL_OPERATIONS = "querysuggestions_total_acl_operations".freeze
66
+ QUERYSUGGESTIONS_TOTAL_INDEXING_OPERATIONS = "querysuggestions_total_indexing_operations".freeze
67
+ QUERYSUGGESTIONS_TOTAL_RECORDS_OPERATIONS = "querysuggestions_total_records_operations".freeze
68
+ QUERYSUGGESTIONS_TOTAL_SYNONYM_OPERATIONS = "querysuggestions_total_synonym_operations".freeze
69
+ QUERYSUGGESTIONS_TOTAL_RULES_OPERATIONS = "querysuggestions_total_rules_operations".freeze
70
+ QUERYSUGGESTIONS_TOTAL_WRITE_OPERATIONS = "querysuggestions_total_write_operations".freeze
71
+ QUERYSUGGESTIONS_TOTAL_READ_OPERATIONS = "querysuggestions_total_read_operations".freeze
72
+ QUERYSUGGESTIONS_TOTAL_OPERATIONS = "querysuggestions_total_operations".freeze
73
+ AVG_PROCESSING_TIME = "avg_processing_time".freeze
74
+ N90P_PROCESSING_TIME = "90p_processing_time".freeze
75
+ N99P_PROCESSING_TIME = "99p_processing_time".freeze
76
+ QUERIES_ABOVE_LAST_MS_PROCESSING_TIME = "queries_above_last_ms_processing_time".freeze
77
+ RECORDS = "records".freeze
78
+ DATA_SIZE = "data_size".freeze
79
+ FILE_SIZE = "file_size".freeze
80
+ MAX_QPS = "max_qps".freeze
81
+ REGION_MAX_QPS = "region_max_qps".freeze
82
+ TOTAL_MAX_QPS = "total_max_qps".freeze
83
+ USED_SEARCH_CAPACITY = "used_search_capacity".freeze
84
+ AVG_USED_SEARCH_CAPACITY = "avg_used_search_capacity".freeze
85
+ REGION_USED_SEARCH_CAPACITY = "region_used_search_capacity".freeze
86
+ REGION_AVG_USED_SEARCH_CAPACITY = "region_avg_used_search_capacity".freeze
87
+ TOTAL_USED_SEARCH_CAPACITY = "total_used_search_capacity".freeze
88
+ TOTAL_AVG_USED_SEARCH_CAPACITY = "total_avg_used_search_capacity".freeze
89
+ DEGRADED_QUERIES_SSD_USED_QUERIES_IMPACTED = "degraded_queries_ssd_used_queries_impacted".freeze
90
+ DEGRADED_QUERIES_SSD_USED_SECONDS_IMPACTED = "degraded_queries_ssd_used_seconds_impacted".freeze
91
+ DEGRADED_QUERIES_MAX_CAPACITY_QUERIES_IMPACTED = "degraded_queries_max_capacity_queries_impacted".freeze
92
+ DEGRADED_QUERIES_MAX_CAPACITY_SECONDS_IMPACTED = "degraded_queries_max_capacity_seconds_impacted".freeze
93
+
94
+ def self.all_vars
95
+ @all_vars ||= [ALL, SEARCH_OPERATIONS, TOTAL_SEARCH_OPERATIONS, TOTAL_SEARCH_REQUESTS, QUERIES_OPERATIONS, MULTI_QUERIES_OPERATIONS, ACL_OPERATIONS, TOTAL_ACL_OPERATIONS,
96
+ GET_API_KEYS_OPERATIONS, GET_API_KEY_OPERATIONS, ADD_API_KEY_OPERATIONS, UPDATE_API_KEY_OPERATIONS, DELETE_API_KEY_OPERATIONS, LIST_API_KEY_OPERATIONS, INDEXING_OPERATIONS, TOTAL_INDEXING_OPERATIONS, BROWSE_OPERATIONS, CLEAR_INDEX_OPERATIONS, COPY_MOVE_OPERATIONS, DELETE_INDEX_OPERATIONS, GET_LOG_OPERATIONS, GET_SETTINGS_OPERATIONS, SET_SETTINGS_OPERATIONS, LIST_INDICES_OPERATIONS, WAIT_TASK_OPERATIONS, RECORD_OPERATIONS, TOTAL_RECORDS_OPERATIONS, ADD_RECORD_OPERATIONS, BATCH_OPERATIONS, DELETE_BY_QUERY_OPERATIONS, DELETE_RECORD_OPERATIONS, GET_RECORD_OPERATIONS, PARTIAL_UPDATE_RECORD_OPERATIONS, UPDATE_RECORD_OPERATIONS, SYNONYM_OPERATIONS, TOTAL_SYNONYM_OPERATIONS, BATCH_SYNONYM_OPERATIONS, CLEAR_SYNONYM_OPERATIONS, DELETE_SYNONYM_OPERATIONS, GET_SYNONYM_OPERATIONS, QUERY_SYNONYM_OPERATIONS, UPDATE_SYNONYM_OPERATIONS, RULE_OPERATIONS, TOTAL_RULES_OPERATIONS, BATCH_RULES_OPERATIONS, CLEAR_RULES_OPERATIONS, DELETE_RULES_OPERATIONS, GET_RULES_OPERATIONS, SAVE_RULES_OPERATIONS, SEARCH_RULES_OPERATIONS, TOTAL_RECOMMEND_REQUESTS, TOTAL_WRITE_OPERATIONS, TOTAL_READ_OPERATIONS, TOTAL_OPERATIONS, QUERYSUGGESTIONS_TOTAL_SEARCH_OPERATIONS, QUERYSUGGESTIONS_TOTAL_SEARCH_REQUESTS, QUERYSUGGESTIONS_TOTAL_ACL_OPERATIONS, QUERYSUGGESTIONS_TOTAL_INDEXING_OPERATIONS, QUERYSUGGESTIONS_TOTAL_RECORDS_OPERATIONS, QUERYSUGGESTIONS_TOTAL_SYNONYM_OPERATIONS, QUERYSUGGESTIONS_TOTAL_RULES_OPERATIONS, QUERYSUGGESTIONS_TOTAL_WRITE_OPERATIONS, QUERYSUGGESTIONS_TOTAL_READ_OPERATIONS, QUERYSUGGESTIONS_TOTAL_OPERATIONS, AVG_PROCESSING_TIME, N90P_PROCESSING_TIME, N99P_PROCESSING_TIME, QUERIES_ABOVE_LAST_MS_PROCESSING_TIME, RECORDS, DATA_SIZE, FILE_SIZE, MAX_QPS, REGION_MAX_QPS, TOTAL_MAX_QPS, USED_SEARCH_CAPACITY, AVG_USED_SEARCH_CAPACITY, REGION_USED_SEARCH_CAPACITY, REGION_AVG_USED_SEARCH_CAPACITY, TOTAL_USED_SEARCH_CAPACITY, TOTAL_AVG_USED_SEARCH_CAPACITY, DEGRADED_QUERIES_SSD_USED_QUERIES_IMPACTED, DEGRADED_QUERIES_SSD_USED_SECONDS_IMPACTED, DEGRADED_QUERIES_MAX_CAPACITY_QUERIES_IMPACTED, DEGRADED_QUERIES_MAX_CAPACITY_SECONDS_IMPACTED].freeze
97
+ end
98
+
99
+ # Builds the enum from string
100
+ # @param [String] The enum value in the form of the string
101
+ # @return [String] The enum value
102
+ def self.build_from_hash(value)
103
+ new.build_from_hash(value)
104
+ end
105
+
106
+ # Builds the enum from string
107
+ # @param [String] The enum value in the form of the string
108
+ # @return [String] The enum value
109
+ def build_from_hash(value)
110
+ return value if Statistic.all_vars.include?(value)
111
+
112
+ raise "Invalid ENUM value #{value} for class #Statistic"
113
+ end
114
+ end
115
+ end
116
+ end
@@ -4,14 +4,14 @@ require 'date'
4
4
  require 'time'
5
5
 
6
6
  module Algolia
7
- module Recommend
8
- module Promote
7
+ module Usage
8
+ module StatisticValue
9
9
  class << self
10
10
  # List of class defined in oneOf (OpenAPI v3)
11
11
  def openapi_one_of
12
12
  [
13
- :PromoteObjectID,
14
- :PromoteObjectIDs
13
+ :'Hash<String, Integer>',
14
+ :Integer
15
15
  ]
16
16
  end
17
17
 
@@ -71,7 +71,7 @@ module Algolia
71
71
  return data.each_with_object({}) { |(k, v), hsh| hsh[k] = find_and_cast_into_type(sub_type, v) }
72
72
  end
73
73
  else # model
74
- const = Algolia::Recommend.const_get(klass)
74
+ const = Algolia::Usage.const_get(klass)
75
75
  if const
76
76
  if const.respond_to?(:openapi_one_of) # nested oneOf model
77
77
  model = const.build(data)
@@ -1,5 +1,5 @@
1
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
2
 
3
3
  module Algolia
4
- VERSION = '3.0.0.alpha.16'.freeze
4
+ VERSION = '3.0.0.alpha.17'.freeze
5
5
  end
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: algolia
3
3
  version: !ruby/object:Gem::Version
4
- version: 3.0.0.alpha.16
4
+ version: 3.0.0.alpha.17
5
5
  platform: ruby
6
6
  authors:
7
7
  - Algolia
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2024-04-03 00:00:00.000000000 Z
11
+ date: 2024-04-09 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: faraday
@@ -135,6 +135,7 @@ files:
135
135
  - lib/algolia/api/query_suggestions_client.rb
136
136
  - lib/algolia/api/recommend_client.rb
137
137
  - lib/algolia/api/search_client.rb
138
+ - lib/algolia/api/usage_client.rb
138
139
  - lib/algolia/api_client.rb
139
140
  - lib/algolia/api_error.rb
140
141
  - lib/algolia/configuration.rb
@@ -211,6 +212,8 @@ files:
211
212
  - lib/algolia/models/analytics/top_searches_response_with_revenue_analytics.rb
212
213
  - lib/algolia/models/ingestion/action_type.rb
213
214
  - lib/algolia/models/ingestion/auth_algolia.rb
215
+ - lib/algolia/models/ingestion/auth_algolia_insights.rb
216
+ - lib/algolia/models/ingestion/auth_algolia_insights_partial.rb
214
217
  - lib/algolia/models/ingestion/auth_algolia_partial.rb
215
218
  - lib/algolia/models/ingestion/auth_api_key.rb
216
219
  - lib/algolia/models/ingestion/auth_api_key_partial.rb
@@ -397,32 +400,20 @@ files:
397
400
  - lib/algolia/models/query-suggestions/source_index.rb
398
401
  - lib/algolia/models/recommend/advanced_syntax_features.rb
399
402
  - lib/algolia/models/recommend/alternatives_as_exact.rb
400
- - lib/algolia/models/recommend/anchoring.rb
401
403
  - lib/algolia/models/recommend/around_precision.rb
402
404
  - lib/algolia/models/recommend/around_precision_from_value_inner.rb
403
405
  - lib/algolia/models/recommend/around_radius.rb
404
406
  - lib/algolia/models/recommend/around_radius_all.rb
405
- - lib/algolia/models/recommend/automatic_facet_filter.rb
406
- - lib/algolia/models/recommend/automatic_facet_filters.rb
407
+ - lib/algolia/models/recommend/auto_facet_filter.rb
407
408
  - lib/algolia/models/recommend/base_recommend_request.rb
408
- - lib/algolia/models/recommend/base_recommendations_query.rb
409
- - lib/algolia/models/recommend/base_recommended_for_you_query.rb
410
- - lib/algolia/models/recommend/base_recommended_for_you_query_parameters.rb
411
409
  - lib/algolia/models/recommend/base_search_params.rb
412
410
  - lib/algolia/models/recommend/base_search_params_without_query.rb
413
411
  - lib/algolia/models/recommend/base_search_response.rb
414
- - lib/algolia/models/recommend/base_trending_facets_query.rb
415
- - lib/algolia/models/recommend/base_trending_items_query.rb
412
+ - lib/algolia/models/recommend/bought_together_query.rb
416
413
  - lib/algolia/models/recommend/condition.rb
417
414
  - lib/algolia/models/recommend/consequence.rb
418
- - lib/algolia/models/recommend/consequence_hide.rb
419
- - lib/algolia/models/recommend/consequence_params.rb
420
- - lib/algolia/models/recommend/consequence_query.rb
421
- - lib/algolia/models/recommend/consequence_query_object.rb
422
415
  - lib/algolia/models/recommend/deleted_at_response.rb
423
416
  - lib/algolia/models/recommend/distinct.rb
424
- - lib/algolia/models/recommend/edit.rb
425
- - lib/algolia/models/recommend/edit_type.rb
426
417
  - lib/algolia/models/recommend/error_base.rb
427
418
  - lib/algolia/models/recommend/exact_on_single_word_query.rb
428
419
  - lib/algolia/models/recommend/exhaustive.rb
@@ -430,46 +421,53 @@ files:
430
421
  - lib/algolia/models/recommend/facet_ordering.rb
431
422
  - lib/algolia/models/recommend/facets.rb
432
423
  - lib/algolia/models/recommend/facets_stats.rb
424
+ - lib/algolia/models/recommend/fallback_params.rb
425
+ - lib/algolia/models/recommend/fbt_model.rb
426
+ - lib/algolia/models/recommend/frequently_bought_together.rb
433
427
  - lib/algolia/models/recommend/get_recommend_task_response.rb
434
428
  - lib/algolia/models/recommend/get_recommendations_params.rb
435
429
  - lib/algolia/models/recommend/get_recommendations_response.rb
430
+ - lib/algolia/models/recommend/hide_consequence_object.rb
436
431
  - lib/algolia/models/recommend/highlight_result.rb
437
432
  - lib/algolia/models/recommend/highlight_result_option.rb
438
433
  - lib/algolia/models/recommend/ignore_plurals.rb
439
434
  - lib/algolia/models/recommend/index_settings_as_search_params.rb
435
+ - lib/algolia/models/recommend/looking_similar.rb
436
+ - lib/algolia/models/recommend/looking_similar_model.rb
437
+ - lib/algolia/models/recommend/looking_similar_query.rb
440
438
  - lib/algolia/models/recommend/match_level.rb
441
439
  - lib/algolia/models/recommend/matched_geo_location.rb
442
440
  - lib/algolia/models/recommend/mixed_search_filters.rb
443
441
  - lib/algolia/models/recommend/mode.rb
444
442
  - lib/algolia/models/recommend/numeric_filters.rb
445
443
  - lib/algolia/models/recommend/optional_filters.rb
446
- - lib/algolia/models/recommend/params.rb
444
+ - lib/algolia/models/recommend/params_consequence.rb
447
445
  - lib/algolia/models/recommend/personalization.rb
448
- - lib/algolia/models/recommend/promote.rb
449
- - lib/algolia/models/recommend/promote_object_id.rb
450
- - lib/algolia/models/recommend/promote_object_ids.rb
446
+ - lib/algolia/models/recommend/promote_consequence_object.rb
451
447
  - lib/algolia/models/recommend/query_type.rb
452
448
  - lib/algolia/models/recommend/ranking_info.rb
453
449
  - lib/algolia/models/recommend/re_ranking_apply_filter.rb
454
450
  - lib/algolia/models/recommend/recommend_hit.rb
455
451
  - lib/algolia/models/recommend/recommend_models.rb
456
- - lib/algolia/models/recommend/recommendation_models.rb
452
+ - lib/algolia/models/recommend/recommend_rule.rb
453
+ - lib/algolia/models/recommend/recommend_rule_metadata.rb
457
454
  - lib/algolia/models/recommend/recommendations_hit.rb
458
455
  - lib/algolia/models/recommend/recommendations_hits.rb
459
- - lib/algolia/models/recommend/recommendations_query.rb
460
456
  - lib/algolia/models/recommend/recommendations_request.rb
461
457
  - lib/algolia/models/recommend/recommendations_results.rb
458
+ - lib/algolia/models/recommend/recommended_for_you.rb
462
459
  - lib/algolia/models/recommend/recommended_for_you_model.rb
463
460
  - lib/algolia/models/recommend/recommended_for_you_query.rb
464
- - lib/algolia/models/recommend/recommended_for_you_query_parameters.rb
465
461
  - lib/algolia/models/recommend/redirect.rb
466
462
  - lib/algolia/models/recommend/redirect_rule_index_metadata.rb
467
463
  - lib/algolia/models/recommend/redirect_rule_index_metadata_data.rb
464
+ - lib/algolia/models/recommend/related_model.rb
465
+ - lib/algolia/models/recommend/related_products.rb
466
+ - lib/algolia/models/recommend/related_query.rb
468
467
  - lib/algolia/models/recommend/remove_stop_words.rb
469
468
  - lib/algolia/models/recommend/remove_words_if_no_results.rb
470
469
  - lib/algolia/models/recommend/rendering_content.rb
471
- - lib/algolia/models/recommend/rule_response.rb
472
- - lib/algolia/models/recommend/rule_response_metadata.rb
470
+ - lib/algolia/models/recommend/search_params.rb
473
471
  - lib/algolia/models/recommend/search_params_object.rb
474
472
  - lib/algolia/models/recommend/search_params_query.rb
475
473
  - lib/algolia/models/recommend/search_recommend_rules_params.rb
@@ -482,8 +480,10 @@ files:
482
480
  - lib/algolia/models/recommend/tag_filters.rb
483
481
  - lib/algolia/models/recommend/task_status.rb
484
482
  - lib/algolia/models/recommend/trending_facet_hit.rb
483
+ - lib/algolia/models/recommend/trending_facets.rb
485
484
  - lib/algolia/models/recommend/trending_facets_model.rb
486
485
  - lib/algolia/models/recommend/trending_facets_query.rb
486
+ - lib/algolia/models/recommend/trending_items.rb
487
487
  - lib/algolia/models/recommend/trending_items_model.rb
488
488
  - lib/algolia/models/recommend/trending_items_query.rb
489
489
  - lib/algolia/models/recommend/typo_tolerance.rb
@@ -655,6 +655,15 @@ files:
655
655
  - lib/algolia/models/search/user_hit.rb
656
656
  - lib/algolia/models/search/user_id.rb
657
657
  - lib/algolia/models/search/value.rb
658
+ - lib/algolia/models/usage/error_base.rb
659
+ - lib/algolia/models/usage/get_usage200_response.rb
660
+ - lib/algolia/models/usage/get_usage200_response_statistics_inner.rb
661
+ - lib/algolia/models/usage/get_usage400_response.rb
662
+ - lib/algolia/models/usage/get_usage400_response_error.rb
663
+ - lib/algolia/models/usage/get_usage400_response_error_errors_inner.rb
664
+ - lib/algolia/models/usage/granularity.rb
665
+ - lib/algolia/models/usage/statistic.rb
666
+ - lib/algolia/models/usage/statistic_value.rb
658
667
  - lib/algolia/transport/call_type.rb
659
668
  - lib/algolia/transport/echo_requester.rb
660
669
  - lib/algolia/transport/http/http_requester.rb