Skip to content

Commit d75f01c

Browse files
algolia-botgazconroyGary Conroykai687
committed
fix(specs): extend Analytics descriptions (generated)
algolia/api-clients-automation#4360 Co-authored-by: algolia-bot <[email protected]> Co-authored-by: gazconroy <[email protected]> Co-authored-by: Gary Conroy <[email protected]> Co-authored-by: Kai Welke <[email protected]>
1 parent d924762 commit d75f01c

21 files changed

+774
-355
lines changed

‎algoliasearch/src/main/java/com/algolia/api/AnalyticsClient.java

Lines changed: 718 additions & 298 deletions
Large diffs are not rendered by default.

‎algoliasearch/src/main/java/com/algolia/model/analytics/DailyAddToCartRates.java

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,9 +28,9 @@ public DailyAddToCartRates setRate(Double rate) {
2828
}
2929

3030
/**
31-
* Add-to-cart rate, calculated as number of tracked searches with at least one add-to-cart event
32-
* divided by the number of tracked searches. If null, Algolia didn't receive any search requests
33-
* with `clickAnalytics` set to true. minimum: 0 maximum: 1
31+
* Add-to-cart rate: calculated as the number of tracked searches with at least one add-to-cart
32+
* event divided by the number of tracked searches. If null, Algolia didn't receive any search
33+
* requests with `clickAnalytics` set to true. minimum: 0 maximum: 1
3434
*/
3535
@javax.annotation.Nullable
3636
public Double getRate() {

‎algoliasearch/src/main/java/com/algolia/model/analytics/DailyClickThroughRates.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ public DailyClickThroughRates setRate(Double rate) {
2828
}
2929

3030
/**
31-
* Click-through rate, calculated as number of tracked searches with at least one click event
31+
* Click-through rate: calculated as the number of tracked searches with at least one click event
3232
* divided by the number of tracked searches. If null, Algolia didn't receive any search requests
3333
* with `clickAnalytics` set to true. minimum: 0 maximum: 1
3434
*/

‎algoliasearch/src/main/java/com/algolia/model/analytics/DailyConversionRates.java

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,9 +28,9 @@ public DailyConversionRates setRate(Double rate) {
2828
}
2929

3030
/**
31-
* Conversion rate, calculated as number of tracked searches with at least one conversion event
32-
* divided by the number of tracked searches. If null, Algolia didn't receive any search requests
33-
* with `clickAnalytics` set to true. minimum: 0 maximum: 1
31+
* Conversion rate: calculated as the number of tracked searches with at least one conversion
32+
* event divided by the number of tracked searches. If null, Algolia didn't receive any search
33+
* requests with `clickAnalytics` set to true. minimum: 0 maximum: 1
3434
*/
3535
@javax.annotation.Nullable
3636
public Double getRate() {

‎algoliasearch/src/main/java/com/algolia/model/analytics/DailyNoClickRates.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,8 @@ public DailyNoClickRates setRate(Double rate) {
2828
}
2929

3030
/**
31-
* No click rate, calculated as number of tracked searches without any click divided by the number
32-
* of tracked searches. minimum: 0 maximum: 1
31+
* No click rate: calculated as the number of tracked searches without clicks divided by the
32+
* number of tracked searches. minimum: 0 maximum: 1
3333
*/
3434
@javax.annotation.Nonnull
3535
public Double getRate() {

‎algoliasearch/src/main/java/com/algolia/model/analytics/DailyNoResultsRates.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -61,8 +61,8 @@ public DailyNoResultsRates setRate(Double rate) {
6161
}
6262

6363
/**
64-
* No results rate, calculated as number of searches with zero results divided by the total number
65-
* of searches. minimum: 0 maximum: 1
64+
* No results rate: calculated as the number of searches with zero results divided by the total
65+
* number of searches. minimum: 0 maximum: 1
6666
*/
6767
@javax.annotation.Nonnull
6868
public Double getRate() {

‎algoliasearch/src/main/java/com/algolia/model/analytics/DailyPurchaseRates.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ public DailyPurchaseRates setRate(Double rate) {
2828
}
2929

3030
/**
31-
* Purchase rate, calculated as number of tracked searches with at least one purchase event
31+
* Purchase rate: calculated as the number of tracked searches with at least one purchase event
3232
* divided by the number of tracked searches. If null, Algolia didn't receive any search requests
3333
* with `clickAnalytics` set to true. minimum: 0 maximum: 1
3434
*/

‎algoliasearch/src/main/java/com/algolia/model/analytics/DailyRevenue.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ public DailyRevenue putCurrencies(String key, CurrencyCode currenciesItem) {
2828
return this;
2929
}
3030

31-
/** Revenue associated with this search, broken-down by currencies. */
31+
/** Revenue associated with this search: broken down by currency. */
3232
@javax.annotation.Nonnull
3333
public Map<String, CurrencyCode> getCurrencies() {
3434
return currencies;

‎algoliasearch/src/main/java/com/algolia/model/analytics/GetAddToCartRateResponse.java

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -30,9 +30,9 @@ public GetAddToCartRateResponse setRate(Double rate) {
3030
}
3131

3232
/**
33-
* Add-to-cart rate, calculated as number of tracked searches with at least one add-to-cart event
34-
* divided by the number of tracked searches. If null, Algolia didn't receive any search requests
35-
* with `clickAnalytics` set to true. minimum: 0 maximum: 1
33+
* Add-to-cart rate: calculated as the number of tracked searches with at least one add-to-cart
34+
* event divided by the number of tracked searches. If null, Algolia didn't receive any search
35+
* requests with `clickAnalytics` set to true. minimum: 0 maximum: 1
3636
*/
3737
@javax.annotation.Nullable
3838
public Double getRate() {

‎algoliasearch/src/main/java/com/algolia/model/analytics/GetClickThroughRateResponse.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ public GetClickThroughRateResponse setRate(Double rate) {
3030
}
3131

3232
/**
33-
* Click-through rate, calculated as number of tracked searches with at least one click event
33+
* Click-through rate: calculated as the number of tracked searches with at least one click event
3434
* divided by the number of tracked searches. If null, Algolia didn't receive any search requests
3535
* with `clickAnalytics` set to true. minimum: 0 maximum: 1
3636
*/

‎algoliasearch/src/main/java/com/algolia/model/analytics/GetConversionRateResponse.java

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -30,9 +30,9 @@ public GetConversionRateResponse setRate(Double rate) {
3030
}
3131

3232
/**
33-
* Conversion rate, calculated as number of tracked searches with at least one conversion event
34-
* divided by the number of tracked searches. If null, Algolia didn't receive any search requests
35-
* with `clickAnalytics` set to true. minimum: 0 maximum: 1
33+
* Conversion rate: calculated as the number of tracked searches with at least one conversion
34+
* event divided by the number of tracked searches. If null, Algolia didn't receive any search
35+
* requests with `clickAnalytics` set to true. minimum: 0 maximum: 1
3636
*/
3737
@javax.annotation.Nullable
3838
public Double getRate() {

‎algoliasearch/src/main/java/com/algolia/model/analytics/GetNoClickRateResponse.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,8 +30,8 @@ public GetNoClickRateResponse setRate(Double rate) {
3030
}
3131

3232
/**
33-
* No click rate, calculated as number of tracked searches without any click divided by the number
34-
* of tracked searches. minimum: 0 maximum: 1
33+
* No click rate: calculated as the number of tracked searches without clicks divided by the
34+
* number of tracked searches. minimum: 0 maximum: 1
3535
*/
3636
@javax.annotation.Nonnull
3737
public Double getRate() {

‎algoliasearch/src/main/java/com/algolia/model/analytics/GetNoResultsRateResponse.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,8 +30,8 @@ public GetNoResultsRateResponse setRate(Double rate) {
3030
}
3131

3232
/**
33-
* No results rate, calculated as number of searches with zero results divided by the total number
34-
* of searches. minimum: 0 maximum: 1
33+
* No results rate: calculated as the number of searches with zero results divided by the total
34+
* number of searches. minimum: 0 maximum: 1
3535
*/
3636
@javax.annotation.Nonnull
3737
public Double getRate() {

‎algoliasearch/src/main/java/com/algolia/model/analytics/GetPurchaseRateResponse.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ public GetPurchaseRateResponse setRate(Double rate) {
3030
}
3131

3232
/**
33-
* Purchase rate, calculated as number of tracked searches with at least one purchase event
33+
* Purchase rate: calculated as the number of tracked searches with at least one purchase event
3434
* divided by the number of tracked searches. If null, Algolia didn't receive any search requests
3535
* with `clickAnalytics` set to true. minimum: 0 maximum: 1
3636
*/

‎algoliasearch/src/main/java/com/algolia/model/analytics/GetRevenue.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ public GetRevenue putCurrencies(String key, CurrencyCode currenciesItem) {
3030
return this;
3131
}
3232

33-
/** Revenue associated with this search, broken-down by currencies. */
33+
/** Revenue associated with this search: broken down by currency. */
3434
@javax.annotation.Nonnull
3535
public Map<String, CurrencyCode> getCurrencies() {
3636
return currencies;

‎algoliasearch/src/main/java/com/algolia/model/analytics/GetTopFiltersNoResultsResponse.java

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,8 +26,7 @@ public GetTopFiltersNoResultsResponse addValues(GetTopFiltersNoResultsValues val
2626

2727
/**
2828
* Filters for searches without any results. If null, the search term specified with the `search`
29-
* parameter is not a search without results, or the `search` parameter is absent from the
30-
* request.
29+
* parameter isn't a search without results, or the `search` parameter is absent from the request.
3130
*/
3231
@javax.annotation.Nullable
3332
public List<GetTopFiltersNoResultsValues> getValues() {

‎algoliasearch/src/main/java/com/algolia/model/analytics/TopHit.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ public TopHit setHit(String hit) {
2121
return this;
2222
}
2323

24-
/** Object ID of a record that's returned as a search result. */
24+
/** Object ID of a record returned as a search result. */
2525
@javax.annotation.Nonnull
2626
public String getHit() {
2727
return hit;

‎algoliasearch/src/main/java/com/algolia/model/analytics/TopHitWithAnalytics.java

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ public TopHitWithAnalytics setHit(String hit) {
3636
return this;
3737
}
3838

39-
/** Object ID of a record that's returned as a search result. */
39+
/** Object ID of a record returned as a search result. */
4040
@javax.annotation.Nonnull
4141
public String getHit() {
4242
return hit;
@@ -59,7 +59,7 @@ public TopHitWithAnalytics setClickThroughRate(Double clickThroughRate) {
5959
}
6060

6161
/**
62-
* Click-through rate, calculated as number of tracked searches with at least one click event
62+
* Click-through rate: calculated as the number of tracked searches with at least one click event
6363
* divided by the number of tracked searches. If null, Algolia didn't receive any search requests
6464
* with `clickAnalytics` set to true. minimum: 0 maximum: 1
6565
*/
@@ -74,9 +74,9 @@ public TopHitWithAnalytics setConversionRate(Double conversionRate) {
7474
}
7575

7676
/**
77-
* Conversion rate, calculated as number of tracked searches with at least one conversion event
78-
* divided by the number of tracked searches. If null, Algolia didn't receive any search requests
79-
* with `clickAnalytics` set to true. minimum: 0 maximum: 1
77+
* Conversion rate: calculated as the number of tracked searches with at least one conversion
78+
* event divided by the number of tracked searches. If null, Algolia didn't receive any search
79+
* requests with `clickAnalytics` set to true. minimum: 0 maximum: 1
8080
*/
8181
@javax.annotation.Nullable
8282
public Double getConversionRate() {

‎algoliasearch/src/main/java/com/algolia/model/analytics/TopHitWithRevenueAnalytics.java

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ public TopHitWithRevenueAnalytics setHit(String hit) {
5353
return this;
5454
}
5555

56-
/** Object ID of a record that's returned as a search result. */
56+
/** Object ID of a record returned as a search result. */
5757
@javax.annotation.Nonnull
5858
public String getHit() {
5959
return hit;
@@ -76,7 +76,7 @@ public TopHitWithRevenueAnalytics setClickThroughRate(Double clickThroughRate) {
7676
}
7777

7878
/**
79-
* Click-through rate, calculated as number of tracked searches with at least one click event
79+
* Click-through rate: calculated as the number of tracked searches with at least one click event
8080
* divided by the number of tracked searches. If null, Algolia didn't receive any search requests
8181
* with `clickAnalytics` set to true. minimum: 0 maximum: 1
8282
*/
@@ -91,9 +91,9 @@ public TopHitWithRevenueAnalytics setConversionRate(Double conversionRate) {
9191
}
9292

9393
/**
94-
* Conversion rate, calculated as number of tracked searches with at least one conversion event
95-
* divided by the number of tracked searches. If null, Algolia didn't receive any search requests
96-
* with `clickAnalytics` set to true. minimum: 0 maximum: 1
94+
* Conversion rate: calculated as the number of tracked searches with at least one conversion
95+
* event divided by the number of tracked searches. If null, Algolia didn't receive any search
96+
* requests with `clickAnalytics` set to true. minimum: 0 maximum: 1
9797
*/
9898
@javax.annotation.Nullable
9999
public Double getConversionRate() {
@@ -142,9 +142,9 @@ public TopHitWithRevenueAnalytics setAddToCartRate(Double addToCartRate) {
142142
}
143143

144144
/**
145-
* Add-to-cart rate, calculated as number of tracked searches with at least one add-to-cart event
146-
* divided by the number of tracked searches. If null, Algolia didn't receive any search requests
147-
* with `clickAnalytics` set to true. minimum: 0 maximum: 1
145+
* Add-to-cart rate: calculated as the number of tracked searches with at least one add-to-cart
146+
* event divided by the number of tracked searches. If null, Algolia didn't receive any search
147+
* requests with `clickAnalytics` set to true. minimum: 0 maximum: 1
148148
*/
149149
@javax.annotation.Nullable
150150
public Double getAddToCartRate() {
@@ -168,7 +168,7 @@ public TopHitWithRevenueAnalytics setPurchaseRate(Double purchaseRate) {
168168
}
169169

170170
/**
171-
* Purchase rate, calculated as number of tracked searches with at least one purchase event
171+
* Purchase rate: calculated as the number of tracked searches with at least one purchase event
172172
* divided by the number of tracked searches. If null, Algolia didn't receive any search requests
173173
* with `clickAnalytics` set to true. minimum: 0 maximum: 1
174174
*/
@@ -198,7 +198,7 @@ public TopHitWithRevenueAnalytics putCurrencies(String key, CurrencyCode currenc
198198
return this;
199199
}
200200

201-
/** Revenue associated with this search, broken-down by currencies. */
201+
/** Revenue associated with this search: broken down by currency. */
202202
@javax.annotation.Nonnull
203203
public Map<String, CurrencyCode> getCurrencies() {
204204
return currencies;

‎algoliasearch/src/main/java/com/algolia/model/analytics/TopSearchWithAnalytics.java

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ public TopSearchWithAnalytics setClickThroughRate(Double clickThroughRate) {
7070
}
7171

7272
/**
73-
* Click-through rate, calculated as number of tracked searches with at least one click event
73+
* Click-through rate: calculated as the number of tracked searches with at least one click event
7474
* divided by the number of tracked searches. If null, Algolia didn't receive any search requests
7575
* with `clickAnalytics` set to true. minimum: 0 maximum: 1
7676
*/
@@ -115,9 +115,9 @@ public TopSearchWithAnalytics setConversionRate(Double conversionRate) {
115115
}
116116

117117
/**
118-
* Conversion rate, calculated as number of tracked searches with at least one conversion event
119-
* divided by the number of tracked searches. If null, Algolia didn't receive any search requests
120-
* with `clickAnalytics` set to true. minimum: 0 maximum: 1
118+
* Conversion rate: calculated as the number of tracked searches with at least one conversion
119+
* event divided by the number of tracked searches. If null, Algolia didn't receive any search
120+
* requests with `clickAnalytics` set to true. minimum: 0 maximum: 1
121121
*/
122122
@javax.annotation.Nullable
123123
public Double getConversionRate() {

‎algoliasearch/src/main/java/com/algolia/model/analytics/TopSearchWithRevenueAnalytics.java

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,7 @@ public TopSearchWithRevenueAnalytics setClickThroughRate(Double clickThroughRate
8787
}
8888

8989
/**
90-
* Click-through rate, calculated as number of tracked searches with at least one click event
90+
* Click-through rate: calculated as the number of tracked searches with at least one click event
9191
* divided by the number of tracked searches. If null, Algolia didn't receive any search requests
9292
* with `clickAnalytics` set to true. minimum: 0 maximum: 1
9393
*/
@@ -132,9 +132,9 @@ public TopSearchWithRevenueAnalytics setConversionRate(Double conversionRate) {
132132
}
133133

134134
/**
135-
* Conversion rate, calculated as number of tracked searches with at least one conversion event
136-
* divided by the number of tracked searches. If null, Algolia didn't receive any search requests
137-
* with `clickAnalytics` set to true. minimum: 0 maximum: 1
135+
* Conversion rate: calculated as the number of tracked searches with at least one conversion
136+
* event divided by the number of tracked searches. If null, Algolia didn't receive any search
137+
* requests with `clickAnalytics` set to true. minimum: 0 maximum: 1
138138
*/
139139
@javax.annotation.Nullable
140140
public Double getConversionRate() {
@@ -198,7 +198,7 @@ public TopSearchWithRevenueAnalytics putCurrencies(String key, CurrencyCode curr
198198
return this;
199199
}
200200

201-
/** Revenue associated with this search, broken-down by currencies. */
201+
/** Revenue associated with this search: broken down by currency. */
202202
@javax.annotation.Nonnull
203203
public Map<String, CurrencyCode> getCurrencies() {
204204
return currencies;
@@ -210,9 +210,9 @@ public TopSearchWithRevenueAnalytics setAddToCartRate(Double addToCartRate) {
210210
}
211211

212212
/**
213-
* Add-to-cart rate, calculated as number of tracked searches with at least one add-to-cart event
214-
* divided by the number of tracked searches. If null, Algolia didn't receive any search requests
215-
* with `clickAnalytics` set to true. minimum: 0 maximum: 1
213+
* Add-to-cart rate: calculated as the number of tracked searches with at least one add-to-cart
214+
* event divided by the number of tracked searches. If null, Algolia didn't receive any search
215+
* requests with `clickAnalytics` set to true. minimum: 0 maximum: 1
216216
*/
217217
@javax.annotation.Nullable
218218
public Double getAddToCartRate() {
@@ -236,7 +236,7 @@ public TopSearchWithRevenueAnalytics setPurchaseRate(Double purchaseRate) {
236236
}
237237

238238
/**
239-
* Purchase rate, calculated as number of tracked searches with at least one purchase event
239+
* Purchase rate: calculated as the number of tracked searches with at least one purchase event
240240
* divided by the number of tracked searches. If null, Algolia didn't receive any search requests
241241
* with `clickAnalytics` set to true. minimum: 0 maximum: 1
242242
*/

0 commit comments

Comments
 (0)