Skip to content

Commit f0ed2ea

Browse files
algolia-botshortcutsaymeric-giraudet
committed
chore: generated code for commit 07e0748. [skip ci]
Co-authored-by: Clément Vannicatte <[email protected]> Co-authored-by: Aymeric Giraudet <[email protected]>
1 parent 07e0748 commit f0ed2ea

File tree

98 files changed

+6036
-128
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

98 files changed

+6036
-128
lines changed

clients/algoliasearch-client-dart/packages/algoliasearch/lib/algoliasearch_lite.dart

Lines changed: 27 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,11 @@ export 'src/model/around_radius_all.dart';
1414
export 'src/model/automatic_facet_filter.dart';
1515
export 'src/model/base_get_api_key_response.dart';
1616
export 'src/model/base_index_settings.dart';
17+
export 'src/model/base_recommend_request.dart';
1718
export 'src/model/base_search_params.dart';
1819
export 'src/model/base_search_params_without_query.dart';
1920
export 'src/model/base_search_response.dart';
21+
export 'src/model/bought_together_query.dart';
2022
export 'src/model/browse_params_object.dart';
2123
export 'src/model/browse_response.dart';
2224
export 'src/model/consequence_params.dart';
@@ -31,21 +33,38 @@ export 'src/model/facet_hits.dart';
3133
export 'src/model/facet_ordering.dart';
3234
export 'src/model/facets.dart';
3335
export 'src/model/facets_stats.dart';
36+
export 'src/model/fallback_params.dart';
37+
export 'src/model/fbt_model.dart';
38+
export 'src/model/frequently_bought_together.dart';
3439
export 'src/model/get_api_key_response.dart';
40+
export 'src/model/get_recommendations_params.dart';
41+
export 'src/model/get_recommendations_response.dart';
3542
export 'src/model/highlight_result_option.dart';
3643
export 'src/model/hit.dart';
3744
export 'src/model/index_settings.dart';
3845
export 'src/model/index_settings_as_search_params.dart';
46+
export 'src/model/looking_similar.dart';
47+
export 'src/model/looking_similar_model.dart';
48+
export 'src/model/looking_similar_query.dart';
3949
export 'src/model/match_level.dart';
4050
export 'src/model/matched_geo_location.dart';
4151
export 'src/model/mode.dart';
4252
export 'src/model/params.dart';
4353
export 'src/model/personalization.dart';
4454
export 'src/model/query_type.dart';
4555
export 'src/model/ranking_info.dart';
56+
export 'src/model/recommend_hit.dart';
57+
export 'src/model/recommendations_hits.dart';
58+
export 'src/model/recommendations_results.dart';
59+
export 'src/model/recommended_for_you.dart';
60+
export 'src/model/recommended_for_you_model.dart';
61+
export 'src/model/recommended_for_you_query.dart';
4662
export 'src/model/redirect.dart';
4763
export 'src/model/redirect_rule_index_metadata.dart';
4864
export 'src/model/redirect_rule_index_metadata_data.dart';
65+
export 'src/model/related_model.dart';
66+
export 'src/model/related_products.dart';
67+
export 'src/model/related_query.dart';
4968
export 'src/model/remove_words_if_no_results.dart';
5069
export 'src/model/rendering_content.dart';
5170
export 'src/model/search_for_facet_values_response.dart';
@@ -55,9 +74,9 @@ export 'src/model/search_for_hits.dart';
5574
export 'src/model/search_for_hits_options.dart';
5675
export 'src/model/search_hits.dart';
5776
export 'src/model/search_method_params.dart';
77+
export 'src/model/search_params.dart';
5878
export 'src/model/search_params_object.dart';
5979
export 'src/model/search_params_query.dart';
60-
export 'src/model/search_params_string.dart';
6180
export 'src/model/search_response.dart';
6281
export 'src/model/search_responses.dart';
6382
export 'src/model/search_strategy.dart';
@@ -67,6 +86,13 @@ export 'src/model/semantic_search.dart';
6786
export 'src/model/snippet_result_option.dart';
6887
export 'src/model/sort_remaining_by.dart';
6988
export 'src/model/supported_language.dart';
89+
export 'src/model/trending_facet_hit.dart';
90+
export 'src/model/trending_facets.dart';
91+
export 'src/model/trending_facets_model.dart';
92+
export 'src/model/trending_facets_query.dart';
93+
export 'src/model/trending_items.dart';
94+
export 'src/model/trending_items_model.dart';
95+
export 'src/model/trending_items_query.dart';
7096
export 'src/model/typo_tolerance_enum.dart';
7197
export 'src/model/value.dart';
7298

clients/algoliasearch-client-dart/packages/algoliasearch/lib/src/api/search_client.dart

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@ import 'package:algolia_client_core/algolia_client_core.dart';
44
import 'package:algoliasearch/src/deserialize.dart';
55
import 'package:algoliasearch/src/version.dart';
66

7+
import 'package:algoliasearch/src/model/get_recommendations_params.dart';
8+
import 'package:algoliasearch/src/model/get_recommendations_response.dart';
79
import 'package:algoliasearch/src/model/search_method_params.dart';
810
import 'package:algoliasearch/src/model/search_responses.dart';
911

@@ -80,6 +82,35 @@ final class SearchClient implements ApiClient {
8082
);
8183
}
8284

85+
/// Retrieves recommendations from selected AI models.
86+
///
87+
/// Required API Key ACLs:
88+
/// - search
89+
///
90+
/// Parameters:
91+
/// * [getRecommendationsParams]
92+
/// * [requestOptions] additional request configuration.
93+
Future<GetRecommendationsResponse> getRecommendations({
94+
required GetRecommendationsParams getRecommendationsParams,
95+
RequestOptions? requestOptions,
96+
}) async {
97+
final request = ApiRequest(
98+
method: RequestMethod.post,
99+
path: r'/1/indexes/*/recommendations',
100+
isRead: true,
101+
body: getRecommendationsParams.toJson(),
102+
);
103+
final response = await _retryStrategy.execute(
104+
request: request,
105+
options: requestOptions,
106+
);
107+
return deserialize<GetRecommendationsResponse, GetRecommendationsResponse>(
108+
response,
109+
'GetRecommendationsResponse',
110+
growable: true,
111+
);
112+
}
113+
83114
/// Sends multiple search request to one or more indices. This can be useful in these cases: - Different indices for different purposes, such as, one index for products, another one for marketing content. - Multiple searches to the same index—for example, with different filters.
84115
///
85116
/// Required API Key ACLs:

clients/algoliasearch-client-dart/packages/algoliasearch/lib/src/deserialize.dart

Lines changed: 99 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,11 @@ import 'package:algoliasearch/src/model/around_radius_all.dart';
77
import 'package:algoliasearch/src/model/automatic_facet_filter.dart';
88
import 'package:algoliasearch/src/model/base_get_api_key_response.dart';
99
import 'package:algoliasearch/src/model/base_index_settings.dart';
10+
import 'package:algoliasearch/src/model/base_recommend_request.dart';
1011
import 'package:algoliasearch/src/model/base_search_params.dart';
1112
import 'package:algoliasearch/src/model/base_search_params_without_query.dart';
1213
import 'package:algoliasearch/src/model/base_search_response.dart';
14+
import 'package:algoliasearch/src/model/bought_together_query.dart';
1315
import 'package:algoliasearch/src/model/browse_params_object.dart';
1416
import 'package:algoliasearch/src/model/browse_response.dart';
1517
import 'package:algoliasearch/src/model/consequence_params.dart';
@@ -24,21 +26,38 @@ import 'package:algoliasearch/src/model/facet_hits.dart';
2426
import 'package:algoliasearch/src/model/facet_ordering.dart';
2527
import 'package:algoliasearch/src/model/facets.dart';
2628
import 'package:algoliasearch/src/model/facets_stats.dart';
29+
import 'package:algoliasearch/src/model/fallback_params.dart';
30+
import 'package:algoliasearch/src/model/fbt_model.dart';
31+
import 'package:algoliasearch/src/model/frequently_bought_together.dart';
2732
import 'package:algoliasearch/src/model/get_api_key_response.dart';
33+
import 'package:algoliasearch/src/model/get_recommendations_params.dart';
34+
import 'package:algoliasearch/src/model/get_recommendations_response.dart';
2835
import 'package:algoliasearch/src/model/highlight_result_option.dart';
2936
import 'package:algoliasearch/src/model/hit.dart';
3037
import 'package:algoliasearch/src/model/index_settings.dart';
3138
import 'package:algoliasearch/src/model/index_settings_as_search_params.dart';
39+
import 'package:algoliasearch/src/model/looking_similar.dart';
40+
import 'package:algoliasearch/src/model/looking_similar_model.dart';
41+
import 'package:algoliasearch/src/model/looking_similar_query.dart';
3242
import 'package:algoliasearch/src/model/match_level.dart';
3343
import 'package:algoliasearch/src/model/matched_geo_location.dart';
3444
import 'package:algoliasearch/src/model/mode.dart';
3545
import 'package:algoliasearch/src/model/params.dart';
3646
import 'package:algoliasearch/src/model/personalization.dart';
3747
import 'package:algoliasearch/src/model/query_type.dart';
3848
import 'package:algoliasearch/src/model/ranking_info.dart';
49+
import 'package:algoliasearch/src/model/recommend_hit.dart';
50+
import 'package:algoliasearch/src/model/recommendations_hits.dart';
51+
import 'package:algoliasearch/src/model/recommendations_results.dart';
52+
import 'package:algoliasearch/src/model/recommended_for_you.dart';
53+
import 'package:algoliasearch/src/model/recommended_for_you_model.dart';
54+
import 'package:algoliasearch/src/model/recommended_for_you_query.dart';
3955
import 'package:algoliasearch/src/model/redirect.dart';
4056
import 'package:algoliasearch/src/model/redirect_rule_index_metadata.dart';
4157
import 'package:algoliasearch/src/model/redirect_rule_index_metadata_data.dart';
58+
import 'package:algoliasearch/src/model/related_model.dart';
59+
import 'package:algoliasearch/src/model/related_products.dart';
60+
import 'package:algoliasearch/src/model/related_query.dart';
4261
import 'package:algoliasearch/src/model/remove_words_if_no_results.dart';
4362
import 'package:algoliasearch/src/model/rendering_content.dart';
4463
import 'package:algoliasearch/src/model/search_for_facet_values_response.dart';
@@ -48,9 +67,9 @@ import 'package:algoliasearch/src/model/search_for_hits.dart';
4867
import 'package:algoliasearch/src/model/search_for_hits_options.dart';
4968
import 'package:algoliasearch/src/model/search_hits.dart';
5069
import 'package:algoliasearch/src/model/search_method_params.dart';
70+
import 'package:algoliasearch/src/model/search_params.dart';
5171
import 'package:algoliasearch/src/model/search_params_object.dart';
5272
import 'package:algoliasearch/src/model/search_params_query.dart';
53-
import 'package:algoliasearch/src/model/search_params_string.dart';
5473
import 'package:algoliasearch/src/model/search_response.dart';
5574
import 'package:algoliasearch/src/model/search_responses.dart';
5675
import 'package:algoliasearch/src/model/search_strategy.dart';
@@ -60,6 +79,13 @@ import 'package:algoliasearch/src/model/semantic_search.dart';
6079
import 'package:algoliasearch/src/model/snippet_result_option.dart';
6180
import 'package:algoliasearch/src/model/sort_remaining_by.dart';
6281
import 'package:algoliasearch/src/model/supported_language.dart';
82+
import 'package:algoliasearch/src/model/trending_facet_hit.dart';
83+
import 'package:algoliasearch/src/model/trending_facets.dart';
84+
import 'package:algoliasearch/src/model/trending_facets_model.dart';
85+
import 'package:algoliasearch/src/model/trending_facets_query.dart';
86+
import 'package:algoliasearch/src/model/trending_items.dart';
87+
import 'package:algoliasearch/src/model/trending_items_model.dart';
88+
import 'package:algoliasearch/src/model/trending_items_query.dart';
6389
import 'package:algoliasearch/src/model/typo_tolerance_enum.dart';
6490
import 'package:algoliasearch/src/model/value.dart';
6591

@@ -104,6 +130,9 @@ ReturnType deserialize<ReturnType, BaseType>(dynamic value, String targetType,
104130
case 'BaseIndexSettings':
105131
return BaseIndexSettings.fromJson(value as Map<String, dynamic>)
106132
as ReturnType;
133+
case 'BaseRecommendRequest':
134+
return BaseRecommendRequest.fromJson(value as Map<String, dynamic>)
135+
as ReturnType;
107136
case 'BaseSearchParams':
108137
return BaseSearchParams.fromJson(value as Map<String, dynamic>)
109138
as ReturnType;
@@ -113,6 +142,9 @@ ReturnType deserialize<ReturnType, BaseType>(dynamic value, String targetType,
113142
case 'BaseSearchResponse':
114143
return BaseSearchResponse.fromJson(value as Map<String, dynamic>)
115144
as ReturnType;
145+
case 'BoughtTogetherQuery':
146+
return BoughtTogetherQuery.fromJson(value as Map<String, dynamic>)
147+
as ReturnType;
116148
case 'BrowseParamsObject':
117149
return BrowseParamsObject.fromJson(value as Map<String, dynamic>)
118150
as ReturnType;
@@ -146,9 +178,23 @@ ReturnType deserialize<ReturnType, BaseType>(dynamic value, String targetType,
146178
return Facets.fromJson(value as Map<String, dynamic>) as ReturnType;
147179
case 'FacetsStats':
148180
return FacetsStats.fromJson(value as Map<String, dynamic>) as ReturnType;
181+
case 'FallbackParams':
182+
return FallbackParams.fromJson(value as Map<String, dynamic>)
183+
as ReturnType;
184+
case 'FbtModel':
185+
return FbtModel.fromJson(value) as ReturnType;
186+
case 'FrequentlyBoughtTogether':
187+
return FrequentlyBoughtTogether.fromJson(value as Map<String, dynamic>)
188+
as ReturnType;
149189
case 'GetApiKeyResponse':
150190
return GetApiKeyResponse.fromJson(value as Map<String, dynamic>)
151191
as ReturnType;
192+
case 'GetRecommendationsParams':
193+
return GetRecommendationsParams.fromJson(value as Map<String, dynamic>)
194+
as ReturnType;
195+
case 'GetRecommendationsResponse':
196+
return GetRecommendationsResponse.fromJson(value as Map<String, dynamic>)
197+
as ReturnType;
152198
case 'HighlightResultOption':
153199
return HighlightResultOption.fromJson(value as Map<String, dynamic>)
154200
as ReturnType;
@@ -160,6 +206,14 @@ ReturnType deserialize<ReturnType, BaseType>(dynamic value, String targetType,
160206
case 'IndexSettingsAsSearchParams':
161207
return IndexSettingsAsSearchParams.fromJson(value as Map<String, dynamic>)
162208
as ReturnType;
209+
case 'LookingSimilar':
210+
return LookingSimilar.fromJson(value as Map<String, dynamic>)
211+
as ReturnType;
212+
case 'LookingSimilarModel':
213+
return LookingSimilarModel.fromJson(value) as ReturnType;
214+
case 'LookingSimilarQuery':
215+
return LookingSimilarQuery.fromJson(value as Map<String, dynamic>)
216+
as ReturnType;
163217
case 'MatchLevel':
164218
return MatchLevel.fromJson(value) as ReturnType;
165219
case 'MatchedGeoLocation':
@@ -176,6 +230,22 @@ ReturnType deserialize<ReturnType, BaseType>(dynamic value, String targetType,
176230
return QueryType.fromJson(value) as ReturnType;
177231
case 'RankingInfo':
178232
return RankingInfo.fromJson(value as Map<String, dynamic>) as ReturnType;
233+
case 'RecommendHit':
234+
return RecommendHit.fromJson(value as Map<String, dynamic>) as ReturnType;
235+
case 'RecommendationsHits':
236+
return RecommendationsHits.fromJson(value as Map<String, dynamic>)
237+
as ReturnType;
238+
case 'RecommendationsResults':
239+
return RecommendationsResults.fromJson(value as Map<String, dynamic>)
240+
as ReturnType;
241+
case 'RecommendedForYou':
242+
return RecommendedForYou.fromJson(value as Map<String, dynamic>)
243+
as ReturnType;
244+
case 'RecommendedForYouModel':
245+
return RecommendedForYouModel.fromJson(value) as ReturnType;
246+
case 'RecommendedForYouQuery':
247+
return RecommendedForYouQuery.fromJson(value as Map<String, dynamic>)
248+
as ReturnType;
179249
case 'Redirect':
180250
return Redirect.fromJson(value as Map<String, dynamic>) as ReturnType;
181251
case 'RedirectRuleIndexMetadata':
@@ -184,6 +254,13 @@ ReturnType deserialize<ReturnType, BaseType>(dynamic value, String targetType,
184254
case 'RedirectRuleIndexMetadataData':
185255
return RedirectRuleIndexMetadataData.fromJson(
186256
value as Map<String, dynamic>) as ReturnType;
257+
case 'RelatedModel':
258+
return RelatedModel.fromJson(value) as ReturnType;
259+
case 'RelatedProducts':
260+
return RelatedProducts.fromJson(value as Map<String, dynamic>)
261+
as ReturnType;
262+
case 'RelatedQuery':
263+
return RelatedQuery.fromJson(value as Map<String, dynamic>) as ReturnType;
187264
case 'RemoveWordsIfNoResults':
188265
return RemoveWordsIfNoResults.fromJson(value) as ReturnType;
189266
case 'RenderingContent':
@@ -209,15 +286,14 @@ ReturnType deserialize<ReturnType, BaseType>(dynamic value, String targetType,
209286
case 'SearchMethodParams':
210287
return SearchMethodParams.fromJson(value as Map<String, dynamic>)
211288
as ReturnType;
289+
case 'SearchParams':
290+
return SearchParams.fromJson(value as Map<String, dynamic>) as ReturnType;
212291
case 'SearchParamsObject':
213292
return SearchParamsObject.fromJson(value as Map<String, dynamic>)
214293
as ReturnType;
215294
case 'SearchParamsQuery':
216295
return SearchParamsQuery.fromJson(value as Map<String, dynamic>)
217296
as ReturnType;
218-
case 'SearchParamsString':
219-
return SearchParamsString.fromJson(value as Map<String, dynamic>)
220-
as ReturnType;
221297
case 'SearchResponse':
222298
return SearchResponse.fromJson(value as Map<String, dynamic>)
223299
as ReturnType;
@@ -240,6 +316,25 @@ ReturnType deserialize<ReturnType, BaseType>(dynamic value, String targetType,
240316
return SortRemainingBy.fromJson(value) as ReturnType;
241317
case 'SupportedLanguage':
242318
return SupportedLanguage.fromJson(value) as ReturnType;
319+
case 'TrendingFacetHit':
320+
return TrendingFacetHit.fromJson(value as Map<String, dynamic>)
321+
as ReturnType;
322+
case 'TrendingFacets':
323+
return TrendingFacets.fromJson(value as Map<String, dynamic>)
324+
as ReturnType;
325+
case 'TrendingFacetsModel':
326+
return TrendingFacetsModel.fromJson(value) as ReturnType;
327+
case 'TrendingFacetsQuery':
328+
return TrendingFacetsQuery.fromJson(value as Map<String, dynamic>)
329+
as ReturnType;
330+
case 'TrendingItems':
331+
return TrendingItems.fromJson(value as Map<String, dynamic>)
332+
as ReturnType;
333+
case 'TrendingItemsModel':
334+
return TrendingItemsModel.fromJson(value) as ReturnType;
335+
case 'TrendingItemsQuery':
336+
return TrendingItemsQuery.fromJson(value as Map<String, dynamic>)
337+
as ReturnType;
243338
case 'TypoToleranceEnum':
244339
return TypoToleranceEnum.fromJson(value) as ReturnType;
245340
case 'Value':

0 commit comments

Comments
 (0)