Skip to content

Commit 6394c43

Browse files
algolia-botKalmar99Jonas Kalmar Rønningmillotp
committed
feat(specs): add support for widgets / banners in search for the csharp client (generated)
algolia/api-clients-automation#3870 Co-authored-by: algolia-bot <[email protected]> Co-authored-by: Jonas <[email protected]> Co-authored-by: Jonas Kalmar Rønning <[email protected]> Co-authored-by: Pierre Millot <[email protected]>
1 parent 178b542 commit 6394c43

File tree

14 files changed

+464
-2
lines changed

14 files changed

+464
-2
lines changed

‎src/main/scala/algoliasearch/recommend/Banner.scala‎

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
/** Recommend API The Recommend API lets you retrieve recommendations from one of Algolia's AI recommendation models
2+
* that you previously trained on your data. ## Client libraries Use Algolia's API clients and libraries to reliably
3+
* integrate Algolia's APIs with your apps. The official API clients are covered by Algolia's [Service Level
4+
* Agreement](https://www.algolia.com/policies/sla/). See: [Algolia's
5+
* ecosystem](https://www.algolia.com/doc/guides/getting-started/how-algolia-works/in-depth/ecosystem/) ## Base URLs
6+
* The base URLs for requests to the Recommend API are: - `https://{APPLICATION_ID}.algolia.net` -
7+
* `https://{APPLICATION_ID}-dsn.algolia.net`. If your subscription includes a [Distributed Search
8+
* Network](https://dashboard.algolia.com/infra), this ensures that requests are sent to servers closest to users. Both
9+
* URLs provide high availability by distributing requests with load balancing. **All requests must use HTTPS.** ##
10+
* Retry strategy To guarantee a high availability, implement a retry strategy for all API requests using the URLs of
11+
* your servers as fallbacks: - `https://{APPLICATION_ID}-1.algolianet.com` -
12+
* `https://{APPLICATION_ID}-2.algolianet.com` - `https://{APPLICATION_ID}-3.algolianet.com` These URLs use a different
13+
* DNS provider than the primary URLs. You should randomize this list to ensure an even load across the three servers.
14+
* All Algolia API clients implement this retry strategy. ## Authentication To authenticate your API requests, add
15+
* these headers: - `x-algolia-application-id`. Your Algolia application ID. - `x-algolia-api-key`. An API key with the
16+
* necessary permissions to make the request. The required access control list (ACL) to make a request is listed in
17+
* each endpoint's reference. You can find your application ID and API key in the [Algolia
18+
* dashboard](https://dashboard.algolia.com/account). ## Request format Request bodies must be JSON objects. ##
19+
* Response status and errors The Recommend API returns JSON responses. Since JSON doesn't guarantee any specific
20+
* ordering, don't rely on the order of attributes in the API response. Successful responses return a `2xx` status.
21+
* Client errors return a `4xx` status. Server errors are indicated by a `5xx` status. Error responses have a `message`
22+
* property with more information. ## Version The current version of the Recommend API is version 1, as indicated by
23+
* the `/1/` in each endpoint's URL.
24+
*
25+
* The version of the OpenAPI document: 1.0.0
26+
*
27+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
28+
* https://openapi-generator.tech Do not edit the class manually.
29+
*/
30+
package algoliasearch.recommend
31+
32+
/** a search banner with image and url.
33+
*/
34+
case class Banner(
35+
image: Option[BannerImage] = scala.None,
36+
link: Option[BannerLink] = scala.None
37+
)

‎src/main/scala/algoliasearch/recommend/BannerImage.scala‎

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
/** Recommend API The Recommend API lets you retrieve recommendations from one of Algolia's AI recommendation models
2+
* that you previously trained on your data. ## Client libraries Use Algolia's API clients and libraries to reliably
3+
* integrate Algolia's APIs with your apps. The official API clients are covered by Algolia's [Service Level
4+
* Agreement](https://www.algolia.com/policies/sla/). See: [Algolia's
5+
* ecosystem](https://www.algolia.com/doc/guides/getting-started/how-algolia-works/in-depth/ecosystem/) ## Base URLs
6+
* The base URLs for requests to the Recommend API are: - `https://{APPLICATION_ID}.algolia.net` -
7+
* `https://{APPLICATION_ID}-dsn.algolia.net`. If your subscription includes a [Distributed Search
8+
* Network](https://dashboard.algolia.com/infra), this ensures that requests are sent to servers closest to users. Both
9+
* URLs provide high availability by distributing requests with load balancing. **All requests must use HTTPS.** ##
10+
* Retry strategy To guarantee a high availability, implement a retry strategy for all API requests using the URLs of
11+
* your servers as fallbacks: - `https://{APPLICATION_ID}-1.algolianet.com` -
12+
* `https://{APPLICATION_ID}-2.algolianet.com` - `https://{APPLICATION_ID}-3.algolianet.com` These URLs use a different
13+
* DNS provider than the primary URLs. You should randomize this list to ensure an even load across the three servers.
14+
* All Algolia API clients implement this retry strategy. ## Authentication To authenticate your API requests, add
15+
* these headers: - `x-algolia-application-id`. Your Algolia application ID. - `x-algolia-api-key`. An API key with the
16+
* necessary permissions to make the request. The required access control list (ACL) to make a request is listed in
17+
* each endpoint's reference. You can find your application ID and API key in the [Algolia
18+
* dashboard](https://dashboard.algolia.com/account). ## Request format Request bodies must be JSON objects. ##
19+
* Response status and errors The Recommend API returns JSON responses. Since JSON doesn't guarantee any specific
20+
* ordering, don't rely on the order of attributes in the API response. Successful responses return a `2xx` status.
21+
* Client errors return a `4xx` status. Server errors are indicated by a `5xx` status. Error responses have a `message`
22+
* property with more information. ## Version The current version of the Recommend API is version 1, as indicated by
23+
* the `/1/` in each endpoint's URL.
24+
*
25+
* The version of the OpenAPI document: 1.0.0
26+
*
27+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
28+
* https://openapi-generator.tech Do not edit the class manually.
29+
*/
30+
package algoliasearch.recommend
31+
32+
/** image of a search banner.
33+
*/
34+
case class BannerImage(
35+
urls: Option[BannerImageUrl] = scala.None,
36+
title: Option[String] = scala.None
37+
)

‎src/main/scala/algoliasearch/recommend/BannerImageUrl.scala‎

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
/** Recommend API The Recommend API lets you retrieve recommendations from one of Algolia's AI recommendation models
2+
* that you previously trained on your data. ## Client libraries Use Algolia's API clients and libraries to reliably
3+
* integrate Algolia's APIs with your apps. The official API clients are covered by Algolia's [Service Level
4+
* Agreement](https://www.algolia.com/policies/sla/). See: [Algolia's
5+
* ecosystem](https://www.algolia.com/doc/guides/getting-started/how-algolia-works/in-depth/ecosystem/) ## Base URLs
6+
* The base URLs for requests to the Recommend API are: - `https://{APPLICATION_ID}.algolia.net` -
7+
* `https://{APPLICATION_ID}-dsn.algolia.net`. If your subscription includes a [Distributed Search
8+
* Network](https://dashboard.algolia.com/infra), this ensures that requests are sent to servers closest to users. Both
9+
* URLs provide high availability by distributing requests with load balancing. **All requests must use HTTPS.** ##
10+
* Retry strategy To guarantee a high availability, implement a retry strategy for all API requests using the URLs of
11+
* your servers as fallbacks: - `https://{APPLICATION_ID}-1.algolianet.com` -
12+
* `https://{APPLICATION_ID}-2.algolianet.com` - `https://{APPLICATION_ID}-3.algolianet.com` These URLs use a different
13+
* DNS provider than the primary URLs. You should randomize this list to ensure an even load across the three servers.
14+
* All Algolia API clients implement this retry strategy. ## Authentication To authenticate your API requests, add
15+
* these headers: - `x-algolia-application-id`. Your Algolia application ID. - `x-algolia-api-key`. An API key with the
16+
* necessary permissions to make the request. The required access control list (ACL) to make a request is listed in
17+
* each endpoint's reference. You can find your application ID and API key in the [Algolia
18+
* dashboard](https://dashboard.algolia.com/account). ## Request format Request bodies must be JSON objects. ##
19+
* Response status and errors The Recommend API returns JSON responses. Since JSON doesn't guarantee any specific
20+
* ordering, don't rely on the order of attributes in the API response. Successful responses return a `2xx` status.
21+
* Client errors return a `4xx` status. Server errors are indicated by a `5xx` status. Error responses have a `message`
22+
* property with more information. ## Version The current version of the Recommend API is version 1, as indicated by
23+
* the `/1/` in each endpoint's URL.
24+
*
25+
* The version of the OpenAPI document: 1.0.0
26+
*
27+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
28+
* https://openapi-generator.tech Do not edit the class manually.
29+
*/
30+
package algoliasearch.recommend
31+
32+
/** url for a search banner image.
33+
*/
34+
case class BannerImageUrl(
35+
url: Option[String] = scala.None
36+
)

‎src/main/scala/algoliasearch/recommend/BannerLink.scala‎

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
/** Recommend API The Recommend API lets you retrieve recommendations from one of Algolia's AI recommendation models
2+
* that you previously trained on your data. ## Client libraries Use Algolia's API clients and libraries to reliably
3+
* integrate Algolia's APIs with your apps. The official API clients are covered by Algolia's [Service Level
4+
* Agreement](https://www.algolia.com/policies/sla/). See: [Algolia's
5+
* ecosystem](https://www.algolia.com/doc/guides/getting-started/how-algolia-works/in-depth/ecosystem/) ## Base URLs
6+
* The base URLs for requests to the Recommend API are: - `https://{APPLICATION_ID}.algolia.net` -
7+
* `https://{APPLICATION_ID}-dsn.algolia.net`. If your subscription includes a [Distributed Search
8+
* Network](https://dashboard.algolia.com/infra), this ensures that requests are sent to servers closest to users. Both
9+
* URLs provide high availability by distributing requests with load balancing. **All requests must use HTTPS.** ##
10+
* Retry strategy To guarantee a high availability, implement a retry strategy for all API requests using the URLs of
11+
* your servers as fallbacks: - `https://{APPLICATION_ID}-1.algolianet.com` -
12+
* `https://{APPLICATION_ID}-2.algolianet.com` - `https://{APPLICATION_ID}-3.algolianet.com` These URLs use a different
13+
* DNS provider than the primary URLs. You should randomize this list to ensure an even load across the three servers.
14+
* All Algolia API clients implement this retry strategy. ## Authentication To authenticate your API requests, add
15+
* these headers: - `x-algolia-application-id`. Your Algolia application ID. - `x-algolia-api-key`. An API key with the
16+
* necessary permissions to make the request. The required access control list (ACL) to make a request is listed in
17+
* each endpoint's reference. You can find your application ID and API key in the [Algolia
18+
* dashboard](https://dashboard.algolia.com/account). ## Request format Request bodies must be JSON objects. ##
19+
* Response status and errors The Recommend API returns JSON responses. Since JSON doesn't guarantee any specific
20+
* ordering, don't rely on the order of attributes in the API response. Successful responses return a `2xx` status.
21+
* Client errors return a `4xx` status. Server errors are indicated by a `5xx` status. Error responses have a `message`
22+
* property with more information. ## Version The current version of the Recommend API is version 1, as indicated by
23+
* the `/1/` in each endpoint's URL.
24+
*
25+
* The version of the OpenAPI document: 1.0.0
26+
*
27+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
28+
* https://openapi-generator.tech Do not edit the class manually.
29+
*/
30+
package algoliasearch.recommend
31+
32+
/** link for a banner defined in merchandising studio.
33+
*/
34+
case class BannerLink(
35+
url: Option[String] = scala.None
36+
)

‎src/main/scala/algoliasearch/recommend/Banners.scala‎

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
/** Recommend API The Recommend API lets you retrieve recommendations from one of Algolia's AI recommendation models
2+
* that you previously trained on your data. ## Client libraries Use Algolia's API clients and libraries to reliably
3+
* integrate Algolia's APIs with your apps. The official API clients are covered by Algolia's [Service Level
4+
* Agreement](https://www.algolia.com/policies/sla/). See: [Algolia's
5+
* ecosystem](https://www.algolia.com/doc/guides/getting-started/how-algolia-works/in-depth/ecosystem/) ## Base URLs
6+
* The base URLs for requests to the Recommend API are: - `https://{APPLICATION_ID}.algolia.net` -
7+
* `https://{APPLICATION_ID}-dsn.algolia.net`. If your subscription includes a [Distributed Search
8+
* Network](https://dashboard.algolia.com/infra), this ensures that requests are sent to servers closest to users. Both
9+
* URLs provide high availability by distributing requests with load balancing. **All requests must use HTTPS.** ##
10+
* Retry strategy To guarantee a high availability, implement a retry strategy for all API requests using the URLs of
11+
* your servers as fallbacks: - `https://{APPLICATION_ID}-1.algolianet.com` -
12+
* `https://{APPLICATION_ID}-2.algolianet.com` - `https://{APPLICATION_ID}-3.algolianet.com` These URLs use a different
13+
* DNS provider than the primary URLs. You should randomize this list to ensure an even load across the three servers.
14+
* All Algolia API clients implement this retry strategy. ## Authentication To authenticate your API requests, add
15+
* these headers: - `x-algolia-application-id`. Your Algolia application ID. - `x-algolia-api-key`. An API key with the
16+
* necessary permissions to make the request. The required access control list (ACL) to make a request is listed in
17+
* each endpoint's reference. You can find your application ID and API key in the [Algolia
18+
* dashboard](https://dashboard.algolia.com/account). ## Request format Request bodies must be JSON objects. ##
19+
* Response status and errors The Recommend API returns JSON responses. Since JSON doesn't guarantee any specific
20+
* ordering, don't rely on the order of attributes in the API response. Successful responses return a `2xx` status.
21+
* Client errors return a `4xx` status. Server errors are indicated by a `5xx` status. Error responses have a `message`
22+
* property with more information. ## Version The current version of the Recommend API is version 1, as indicated by
23+
* the `/1/` in each endpoint's URL.
24+
*
25+
* The version of the OpenAPI document: 1.0.0
26+
*
27+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
28+
* https://openapi-generator.tech Do not edit the class manually.
29+
*/
30+
package algoliasearch.recommend
31+
32+
/** banners defined in the merchandising studio for the given search.
33+
*/
34+
case class Banners(
35+
banners: Option[Banner] = scala.None
36+
)

‎src/main/scala/algoliasearch/recommend/RenderingContent.scala‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,5 +34,6 @@ package algoliasearch.recommend
3434
*/
3535
case class RenderingContent(
3636
facetOrdering: Option[FacetOrdering] = scala.None,
37-
redirect: Option[RedirectURL] = scala.None
37+
redirect: Option[RedirectURL] = scala.None,
38+
widgets: Option[Widgets] = scala.None
3839
)

‎src/main/scala/algoliasearch/recommend/Widgets.scala‎

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
/** Recommend API The Recommend API lets you retrieve recommendations from one of Algolia's AI recommendation models
2+
* that you previously trained on your data. ## Client libraries Use Algolia's API clients and libraries to reliably
3+
* integrate Algolia's APIs with your apps. The official API clients are covered by Algolia's [Service Level
4+
* Agreement](https://www.algolia.com/policies/sla/). See: [Algolia's
5+
* ecosystem](https://www.algolia.com/doc/guides/getting-started/how-algolia-works/in-depth/ecosystem/) ## Base URLs
6+
* The base URLs for requests to the Recommend API are: - `https://{APPLICATION_ID}.algolia.net` -
7+
* `https://{APPLICATION_ID}-dsn.algolia.net`. If your subscription includes a [Distributed Search
8+
* Network](https://dashboard.algolia.com/infra), this ensures that requests are sent to servers closest to users. Both
9+
* URLs provide high availability by distributing requests with load balancing. **All requests must use HTTPS.** ##
10+
* Retry strategy To guarantee a high availability, implement a retry strategy for all API requests using the URLs of
11+
* your servers as fallbacks: - `https://{APPLICATION_ID}-1.algolianet.com` -
12+
* `https://{APPLICATION_ID}-2.algolianet.com` - `https://{APPLICATION_ID}-3.algolianet.com` These URLs use a different
13+
* DNS provider than the primary URLs. You should randomize this list to ensure an even load across the three servers.
14+
* All Algolia API clients implement this retry strategy. ## Authentication To authenticate your API requests, add
15+
* these headers: - `x-algolia-application-id`. Your Algolia application ID. - `x-algolia-api-key`. An API key with the
16+
* necessary permissions to make the request. The required access control list (ACL) to make a request is listed in
17+
* each endpoint's reference. You can find your application ID and API key in the [Algolia
18+
* dashboard](https://dashboard.algolia.com/account). ## Request format Request bodies must be JSON objects. ##
19+
* Response status and errors The Recommend API returns JSON responses. Since JSON doesn't guarantee any specific
20+
* ordering, don't rely on the order of attributes in the API response. Successful responses return a `2xx` status.
21+
* Client errors return a `4xx` status. Server errors are indicated by a `5xx` status. Error responses have a `message`
22+
* property with more information. ## Version The current version of the Recommend API is version 1, as indicated by
23+
* the `/1/` in each endpoint's URL.
24+
*
25+
* The version of the OpenAPI document: 1.0.0
26+
*
27+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
28+
* https://openapi-generator.tech Do not edit the class manually.
29+
*/
30+
package algoliasearch.recommend
31+
32+
/** widgets returned from any rules that are applied to the current search.
33+
*/
34+
case class Widgets(
35+
banners: Option[Banners] = scala.None
36+
)

0 commit comments

Comments
 (0)