Skip to content

Commit 99621fb

Browse files
algolia-botaymeric-giraudet
algolia-bot
and
aymeric-giraudet
committed
chore: generated code for commit 632827be. [skip ci]
algolia/api-clients-automation@632827b Co-authored-by: algolia-bot <[email protected]> Co-authored-by: Aymeric Giraudet <[email protected]>
1 parent 9a772be commit 99621fb

17 files changed

+146
-64
lines changed

‎.openapi-generator/FILES‎

Lines changed: 93 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,96 @@
1+
.openapi-generator-ignore
12
AlgoliaSearchClient.podspec
23
Package.swift
34
Sources/Core/Helpers/Version.swift
4-
Sources/Usage/Models/GetUsage200Response.swift
5-
Sources/Usage/Models/GetUsage200ResponseStatisticsInner.swift
6-
Sources/Usage/Models/GetUsage400Response.swift
7-
Sources/Usage/Models/GetUsage400ResponseError.swift
8-
Sources/Usage/Models/GetUsage400ResponseErrorErrorsInner.swift
9-
Sources/Usage/Models/Granularity.swift
10-
Sources/Usage/Models/Statistic.swift
11-
Sources/Usage/Models/StatisticValue.swift
12-
Sources/Usage/Models/UsageErrorBase.swift
13-
Sources/Usage/UsageClient.swift
14-
Sources/Usage/UsageClientConfiguration.swift
5+
Sources/Recommend/Models/AutoFacetFilter.swift
6+
Sources/Recommend/Models/BaseRecommendRequest.swift
7+
Sources/Recommend/Models/BoughtTogetherQuery.swift
8+
Sources/Recommend/Models/FallbackParams.swift
9+
Sources/Recommend/Models/FbtModel.swift
10+
Sources/Recommend/Models/FrequentlyBoughtTogether.swift
11+
Sources/Recommend/Models/GetRecommendTaskResponse.swift
12+
Sources/Recommend/Models/GetRecommendationsParams.swift
13+
Sources/Recommend/Models/GetRecommendationsResponse.swift
14+
Sources/Recommend/Models/HideConsequenceObject.swift
15+
Sources/Recommend/Models/LookingSimilar.swift
16+
Sources/Recommend/Models/LookingSimilarModel.swift
17+
Sources/Recommend/Models/LookingSimilarQuery.swift
18+
Sources/Recommend/Models/ParamsConsequence.swift
19+
Sources/Recommend/Models/PromoteConsequenceObject.swift
20+
Sources/Recommend/Models/RecommendAdvancedSyntaxFeatures.swift
21+
Sources/Recommend/Models/RecommendAlternativesAsExact.swift
22+
Sources/Recommend/Models/RecommendAroundPrecision.swift
23+
Sources/Recommend/Models/RecommendAroundPrecisionFromValueInner.swift
24+
Sources/Recommend/Models/RecommendAroundRadius.swift
25+
Sources/Recommend/Models/RecommendAroundRadiusAll.swift
26+
Sources/Recommend/Models/RecommendBaseSearchParams.swift
27+
Sources/Recommend/Models/RecommendBaseSearchParamsWithoutQuery.swift
28+
Sources/Recommend/Models/RecommendBaseSearchResponse.swift
29+
Sources/Recommend/Models/RecommendCondition.swift
30+
Sources/Recommend/Models/RecommendConsequence.swift
31+
Sources/Recommend/Models/RecommendDeletedAtResponse.swift
32+
Sources/Recommend/Models/RecommendDistinct.swift
33+
Sources/Recommend/Models/RecommendErrorBase.swift
34+
Sources/Recommend/Models/RecommendExactOnSingleWordQuery.swift
35+
Sources/Recommend/Models/RecommendExhaustive.swift
36+
Sources/Recommend/Models/RecommendFacetFilters.swift
37+
Sources/Recommend/Models/RecommendFacetOrdering.swift
38+
Sources/Recommend/Models/RecommendFacets.swift
39+
Sources/Recommend/Models/RecommendFacetsStats.swift
40+
Sources/Recommend/Models/RecommendHighlightResult.swift
41+
Sources/Recommend/Models/RecommendHighlightResultOption.swift
42+
Sources/Recommend/Models/RecommendHit.swift
43+
Sources/Recommend/Models/RecommendIgnorePlurals.swift
44+
Sources/Recommend/Models/RecommendIndexSettingsAsSearchParams.swift
45+
Sources/Recommend/Models/RecommendMatchLevel.swift
46+
Sources/Recommend/Models/RecommendMatchedGeoLocation.swift
47+
Sources/Recommend/Models/RecommendMode.swift
48+
Sources/Recommend/Models/RecommendModels.swift
49+
Sources/Recommend/Models/RecommendNumericFilters.swift
50+
Sources/Recommend/Models/RecommendOptionalFilters.swift
51+
Sources/Recommend/Models/RecommendPersonalization.swift
52+
Sources/Recommend/Models/RecommendQueryType.swift
53+
Sources/Recommend/Models/RecommendRankingInfo.swift
54+
Sources/Recommend/Models/RecommendReRankingApplyFilter.swift
55+
Sources/Recommend/Models/RecommendRedirect.swift
56+
Sources/Recommend/Models/RecommendRedirectRuleIndexMetadata.swift
57+
Sources/Recommend/Models/RecommendRedirectRuleIndexMetadataData.swift
58+
Sources/Recommend/Models/RecommendRemoveStopWords.swift
59+
Sources/Recommend/Models/RecommendRemoveWordsIfNoResults.swift
60+
Sources/Recommend/Models/RecommendRenderingContent.swift
61+
Sources/Recommend/Models/RecommendRule.swift
62+
Sources/Recommend/Models/RecommendRuleMetadata.swift
63+
Sources/Recommend/Models/RecommendSearchParams.swift
64+
Sources/Recommend/Models/RecommendSearchParamsObject.swift
65+
Sources/Recommend/Models/RecommendSearchParamsQuery.swift
66+
Sources/Recommend/Models/RecommendSemanticSearch.swift
67+
Sources/Recommend/Models/RecommendSnippetResult.swift
68+
Sources/Recommend/Models/RecommendSnippetResultOption.swift
69+
Sources/Recommend/Models/RecommendSortRemainingBy.swift
70+
Sources/Recommend/Models/RecommendSupportedLanguage.swift
71+
Sources/Recommend/Models/RecommendTagFilters.swift
72+
Sources/Recommend/Models/RecommendTaskStatus.swift
73+
Sources/Recommend/Models/RecommendTypoTolerance.swift
74+
Sources/Recommend/Models/RecommendTypoToleranceEnum.swift
75+
Sources/Recommend/Models/RecommendValue.swift
76+
Sources/Recommend/Models/RecommendationsHit.swift
77+
Sources/Recommend/Models/RecommendationsHits.swift
78+
Sources/Recommend/Models/RecommendationsRequest.swift
79+
Sources/Recommend/Models/RecommendationsResults.swift
80+
Sources/Recommend/Models/RecommendedForYou.swift
81+
Sources/Recommend/Models/RecommendedForYouModel.swift
82+
Sources/Recommend/Models/RecommendedForYouQuery.swift
83+
Sources/Recommend/Models/RelatedModel.swift
84+
Sources/Recommend/Models/RelatedProducts.swift
85+
Sources/Recommend/Models/RelatedQuery.swift
86+
Sources/Recommend/Models/SearchRecommendRulesParams.swift
87+
Sources/Recommend/Models/SearchRecommendRulesResponse.swift
88+
Sources/Recommend/Models/TrendingFacetHit.swift
89+
Sources/Recommend/Models/TrendingFacets.swift
90+
Sources/Recommend/Models/TrendingFacetsModel.swift
91+
Sources/Recommend/Models/TrendingFacetsQuery.swift
92+
Sources/Recommend/Models/TrendingItems.swift
93+
Sources/Recommend/Models/TrendingItemsModel.swift
94+
Sources/Recommend/Models/TrendingItemsQuery.swift
95+
Sources/Recommend/RecommendClient.swift
96+
Sources/Recommend/RecommendClientConfiguration.swift

‎Sources/Ingestion/Models/DestinationIndexName.swift‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ public struct DestinationIndexName: Codable, JSONEncodable {
1313
/// Attributes from your source to exclude from Algolia records. Not all your data attributes will be useful for
1414
/// searching. Keeping your Algolia records small increases indexing and search performance. - Exclude nested
1515
/// attributes with `.` notation. For example, `foo.bar` indexes the `foo` attribute and all its children **except**
16-
/// the `bar` attribute. - Exclude attributes from arrays with `[i]`, where `i` is the index of the array element.
16+
/// the `bar` attribute. - Exclude attributes from arrays with `[i]`, where `i` is the index of the array element.
1717
/// For example, `foo.[0].bar` only excludes the `bar` attribute from the first element of the `foo` array, but
1818
/// indexes the complete `foo` attribute for all other elements. Use `*` as wildcard: `foo.[*].bar` excludes `bar`
1919
/// from all elements of the `foo` array.

‎Sources/Search/Models/BaseIndexSettings.swift‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ import Foundation
77
#endif
88

99
public struct BaseIndexSettings: Codable, JSONEncodable {
10-
/// Attributes used for [faceting](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/).
10+
/// Attributes used for [faceting](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/).
1111
/// Facets are attributes that let you categorize search results. They can be used for filtering search results. By
1212
/// default, no attribute is used for faceting. Attribute names are case-sensitive. **Modifiers** -
1313
/// `filterOnly(\"ATTRIBUTE\")`. Allows using this attribute as a filter, but doesn't evalue the facet values. -
@@ -16,7 +16,7 @@ public struct BaseIndexSettings: Codable, JSONEncodable {
1616
/// this modifier to searchable facets: `afterDistinct(searchable(ATTRIBUTE))`.
1717
public var attributesForFaceting: [String]?
1818
/// Creates [replica
19-
/// indices](https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/in-depth/replicas/).
19+
/// indices](https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/in-depth/replicas/).
2020
/// Replicas are copies of a primary index with the same records but different settings, synonyms, or rules. If you
2121
/// want to offer a different ranking or sorting of your search results, you'll use replica indices. All index
2222
/// operations on a primary index are automatically forwarded to its replicas. To add a replica index, you must
@@ -69,7 +69,7 @@ public struct BaseIndexSettings: Codable, JSONEncodable {
6969
/// Numeric attributes that can be used as [numerical filters](https://www.algolia.com/doc/guides/managing-results/rules/detecting-intent/how-to/applying-a-custom-filter-for-a-specific-query/#numerical-filters).
7070
/// Attribute names are case-sensitive. By default, all numeric attributes are available as numerical filters. For
7171
/// faster indexing, reduce the number of numeric attributes. If you want to turn off filtering for all numeric
72-
/// attributes, specifiy an attribute that doesn't exist in your index, such as `NO_NUMERIC_FILTERING`.
72+
/// attributes, specifiy an attribute that doesn't exist in your index, such as `NO_NUMERIC_FILTERING`.
7373
/// **Modifier** - `equalOnly(\"ATTRIBUTE\")`. Support only filtering based on equality comparisons `=` and `!=`.
7474
public var numericAttributesForFiltering: [String]?
7575
/// Controls which separators are indexed. Separators are all non-letter characters except spaces and currency

‎Sources/Search/Models/BrowseParamsObject.swift‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ public struct BrowseParamsObject: Codable, JSONEncodable {
2121
/// upper limits of the range (inclusive). - **Facet filters.** `<facet>:<value>` where `<facet>` is a facet
2222
/// attribute (case-sensitive) and `<value>` a facet value. - **Tag filters.** `_tags:<value>` or just `<value>`
2323
/// (case-sensitive). - **Boolean filters.** `<facet>: true | false`. You can combine filters with `AND`, `OR`, and
24-
/// `NOT` operators with the following restrictions: - You can only combine filters of the same type with `OR`.
24+
// `NOT` operators with the following restrictions: - You can only combine filters of the same type with `OR`.
2525
/// **Not supported:** `facet:value OR num > 3`. - You can't use `NOT` with combinations of filters. **Not
2626
/// supported:** `NOT(facet:value OR facet:value)` - You can't combine conjunctions (`AND`) with `OR`. **Not
2727
/// supported:** `facet:value OR (facet:value AND facet:value)` Use quotes around your filters, if the facet
@@ -221,7 +221,7 @@ public struct BrowseParamsObject: Codable, JSONEncodable {
221221
/// matches. - `singleWordSynonym`. Single-word synonyms, such as \"NY/NYC\" are considered exact matches. -
222222
/// `multiWordsSynonym`. Multi-word synonyms, such as \"NY/New York\" are considered exact matches.
223223
public var alternativesAsExact: [SearchAlternativesAsExact]?
224-
/// Advanced search syntax features you want to support. - `exactPhrase`. Phrases in quotes must match exactly.
224+
// Advanced search syntax features you want to support. - `exactPhrase`. Phrases in quotes must match exactly.
225225
/// For example, `sparkly blue \"iPhone case\"` only returns records with the exact string \"iPhone case\". -
226226
/// `excludeWords`. Query words prefixed with a `-` must not occur in a record. For example, `search -engine`
227227
/// matches records that contain \"search\" but not \"engine\". This setting only has an effect if `advancedSyntax`
@@ -261,7 +261,7 @@ public struct BrowseParamsObject: Codable, JSONEncodable {
261261
/// attribute is determined by the order in the `searchableAttributes` setting.
262262
public var attributeCriteriaComputedByMinProximity: Bool?
263263
public var renderingContent: SearchRenderingContent?
264-
/// Whether this search will use [Dynamic Re-Ranking](https://www.algolia.com/doc/guides/algolia-ai/re-ranking/).
264+
// Whether this search will use [Dynamic Re-Ranking](https://www.algolia.com/doc/guides/algolia-ai/re-ranking/).
265265
/// This setting only has an effect if you activated Dynamic Re-Ranking for this index in the Algolia dashboard.
266266
public var enableReRanking: Bool?
267267
public var reRankingApplyFilter: SearchReRankingApplyFilter?

‎Sources/Search/Models/DeleteByParams.swift‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ public struct DeleteByParams: Codable, JSONEncodable {
1414
/// upper limits of the range (inclusive). - **Facet filters.** `<facet>:<value>` where `<facet>` is a facet
1515
/// attribute (case-sensitive) and `<value>` a facet value. - **Tag filters.** `_tags:<value>` or just `<value>`
1616
/// (case-sensitive). - **Boolean filters.** `<facet>: true | false`. You can combine filters with `AND`, `OR`, and
17-
/// `NOT` operators with the following restrictions: - You can only combine filters of the same type with `OR`.
17+
// `NOT` operators with the following restrictions: - You can only combine filters of the same type with `OR`.
1818
/// **Not supported:** `facet:value OR num > 3`. - You can't use `NOT` with combinations of filters. **Not
1919
/// supported:** `NOT(facet:value OR facet:value)` - You can't combine conjunctions (`AND`) with `OR`. **Not
2020
/// supported:** `facet:value OR (facet:value AND facet:value)` Use quotes around your filters, if the facet

‎Sources/Search/Models/IndexSettings.swift‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ import Foundation
88

99
/// Index settings.
1010
public struct IndexSettings: Codable, JSONEncodable {
11-
/// Attributes used for [faceting](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/).
11+
/// Attributes used for [faceting](https://www.algolia.com/doc/guides/managing-results/refine-results/faceting/).
1212
/// Facets are attributes that let you categorize search results. They can be used for filtering search results. By
1313
/// default, no attribute is used for faceting. Attribute names are case-sensitive. **Modifiers** -
1414
/// `filterOnly(\"ATTRIBUTE\")`. Allows using this attribute as a filter, but doesn't evalue the facet values. -
@@ -17,7 +17,7 @@ public struct IndexSettings: Codable, JSONEncodable {
1717
/// this modifier to searchable facets: `afterDistinct(searchable(ATTRIBUTE))`.
1818
public var attributesForFaceting: [String]?
1919
/// Creates [replica
20-
/// indices](https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/in-depth/replicas/).
20+
/// indices](https://www.algolia.com/doc/guides/managing-results/refine-results/sorting/in-depth/replicas/).
2121
/// Replicas are copies of a primary index with the same records but different settings, synonyms, or rules. If you
2222
/// want to offer a different ranking or sorting of your search results, you'll use replica indices. All index
2323
/// operations on a primary index are automatically forwarded to its replicas. To add a replica index, you must
@@ -70,7 +70,7 @@ public struct IndexSettings: Codable, JSONEncodable {
7070
/// Numeric attributes that can be used as [numerical filters](https://www.algolia.com/doc/guides/managing-results/rules/detecting-intent/how-to/applying-a-custom-filter-for-a-specific-query/#numerical-filters).
7171
/// Attribute names are case-sensitive. By default, all numeric attributes are available as numerical filters. For
7272
/// faster indexing, reduce the number of numeric attributes. If you want to turn off filtering for all numeric
73-
/// attributes, specifiy an attribute that doesn't exist in your index, such as `NO_NUMERIC_FILTERING`.
73+
/// attributes, specifiy an attribute that doesn't exist in your index, such as `NO_NUMERIC_FILTERING`.
7474
/// **Modifier** - `equalOnly(\"ATTRIBUTE\")`. Support only filtering based on equality comparisons `=` and `!=`.
7575
public var numericAttributesForFiltering: [String]?
7676
/// Controls which separators are indexed. Separators are all non-letter characters except spaces and currency
@@ -215,7 +215,7 @@ public struct IndexSettings: Codable, JSONEncodable {
215215
/// matches. - `singleWordSynonym`. Single-word synonyms, such as \"NY/NYC\" are considered exact matches. -
216216
/// `multiWordsSynonym`. Multi-word synonyms, such as \"NY/New York\" are considered exact matches.
217217
public var alternativesAsExact: [SearchAlternativesAsExact]?
218-
/// Advanced search syntax features you want to support. - `exactPhrase`. Phrases in quotes must match exactly.
218+
// Advanced search syntax features you want to support. - `exactPhrase`. Phrases in quotes must match exactly.
219219
/// For example, `sparkly blue \"iPhone case\"` only returns records with the exact string \"iPhone case\". -
220220
/// `excludeWords`. Query words prefixed with a `-` must not occur in a record. For example, `search -engine`
221221
/// matches records that contain \"search\" but not \"engine\". This setting only has an effect if `advancedSyntax`
@@ -255,7 +255,7 @@ public struct IndexSettings: Codable, JSONEncodable {
255255
/// attribute is determined by the order in the `searchableAttributes` setting.
256256
public var attributeCriteriaComputedByMinProximity: Bool?
257257
public var renderingContent: SearchRenderingContent?
258-
/// Whether this search will use [Dynamic Re-Ranking](https://www.algolia.com/doc/guides/algolia-ai/re-ranking/).
258+
// Whether this search will use [Dynamic Re-Ranking](https://www.algolia.com/doc/guides/algolia-ai/re-ranking/).
259259
/// This setting only has an effect if you activated Dynamic Re-Ranking for this index in the Algolia dashboard.
260260
public var enableReRanking: Bool?
261261
public var reRankingApplyFilter: SearchReRankingApplyFilter?

‎Sources/Search/Models/SearchBaseSearchParams.swift‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ public struct SearchBaseSearchParams: Codable, JSONEncodable {
2121
/// upper limits of the range (inclusive). - **Facet filters.** `<facet>:<value>` where `<facet>` is a facet
2222
/// attribute (case-sensitive) and `<value>` a facet value. - **Tag filters.** `_tags:<value>` or just `<value>`
2323
/// (case-sensitive). - **Boolean filters.** `<facet>: true | false`. You can combine filters with `AND`, `OR`, and
24-
/// `NOT` operators with the following restrictions: - You can only combine filters of the same type with `OR`.
24+
// `NOT` operators with the following restrictions: - You can only combine filters of the same type with `OR`.
2525
/// **Not supported:** `facet:value OR num > 3`. - You can't use `NOT` with combinations of filters. **Not
2626
/// supported:** `NOT(facet:value OR facet:value)` - You can't combine conjunctions (`AND`) with `OR`. **Not
2727
/// supported:** `facet:value OR (facet:value AND facet:value)` Use quotes around your filters, if the facet

‎Sources/Search/Models/SearchBaseSearchParamsWithoutQuery.swift‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ public struct SearchBaseSearchParamsWithoutQuery: Codable, JSONEncodable {
1919
/// upper limits of the range (inclusive). - **Facet filters.** `<facet>:<value>` where `<facet>` is a facet
2020
/// attribute (case-sensitive) and `<value>` a facet value. - **Tag filters.** `_tags:<value>` or just `<value>`
2121
/// (case-sensitive). - **Boolean filters.** `<facet>: true | false`. You can combine filters with `AND`, `OR`, and
22-
/// `NOT` operators with the following restrictions: - You can only combine filters of the same type with `OR`.
22+
// `NOT` operators with the following restrictions: - You can only combine filters of the same type with `OR`.
2323
/// **Not supported:** `facet:value OR num > 3`. - You can't use `NOT` with combinations of filters. **Not
2424
/// supported:** `NOT(facet:value OR facet:value)` - You can't combine conjunctions (`AND`) with `OR`. **Not
2525
/// supported:** `facet:value OR (facet:value AND facet:value)` Use quotes around your filters, if the facet

0 commit comments

Comments
 (0)