feat(specs): add support for widgets / banners in search for the csha…

…rp 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]>
algolia · Oct 6, 2024 · d1a192d · d1a192d
1 parent 8805c6d
commit d1a192d
Show file tree

Hide file tree

Showing 25 changed files with 222 additions and 0 deletions.
diff --git a/packages/algoliasearch/builds/models.ts b/packages/algoliasearch/builds/models.ts
@@ -12,6 +12,11 @@ import type {
   AroundRadiusAll,
   AutomaticFacetFilter,
   AutomaticFacetFilters,
+  Banner,
+  BannerImage,
+  BannerImageUrl,
+  BannerLink,
+  Banners,
   BaseIndexSettings,
   BaseSearchParams,
   BaseSearchParamsWithoutQuery,
@@ -78,6 +83,7 @@ import type {
   TypoTolerance,
   TypoToleranceEnum,
   Value,
+  Widgets,
 } from '@algolia/client-search';
 import { apiClientVersion } from '@algolia/client-search';
 
@@ -101,6 +107,11 @@ export {
   AroundRadiusAll,
   AutomaticFacetFilter,
   AutomaticFacetFilters,
+  Banner,
+  BannerImage,
+  BannerImageUrl,
+  BannerLink,
+  Banners,
   BaseIndexSettings,
   BaseSearchParams,
   BaseSearchParamsWithoutQuery,
@@ -168,6 +179,7 @@ export {
   TypoTolerance,
   TypoToleranceEnum,
   Value,
+  Widgets,
 };
 
 /**

diff --git a/packages/algoliasearch/lite/model/banner.ts b/packages/algoliasearch/lite/model/banner.ts
@@ -0,0 +1,13 @@
+// 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.
+
+import type { BannerImage } from './bannerImage';
+import type { BannerLink } from './bannerLink';
+
+/**
+ * A search banner with image and url.
+ */
+export type Banner = {
+  image?: BannerImage;
+
+  link?: BannerLink;
+};
diff --git a/packages/algoliasearch/lite/model/bannerImage.ts b/packages/algoliasearch/lite/model/bannerImage.ts
@@ -0,0 +1,12 @@
+// 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.
+
+import type { BannerImageUrl } from './bannerImageUrl';
+
+/**
+ * Image of a search banner.
+ */
+export type BannerImage = {
+  urls?: BannerImageUrl;
+
+  title?: string;
+};
diff --git a/packages/algoliasearch/lite/model/bannerImageUrl.ts b/packages/algoliasearch/lite/model/bannerImageUrl.ts
@@ -0,0 +1,8 @@
+// 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.
+
+/**
+ * Url for a search banner image.
+ */
+export type BannerImageUrl = {
+  url?: string;
+};
diff --git a/packages/algoliasearch/lite/model/bannerLink.ts b/packages/algoliasearch/lite/model/bannerLink.ts
@@ -0,0 +1,8 @@
+// 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.
+
+/**
+ * Link for a banner defined in merchandising studio.
+ */
+export type BannerLink = {
+  url?: string;
+};
diff --git a/packages/algoliasearch/lite/model/banners.ts b/packages/algoliasearch/lite/model/banners.ts
@@ -0,0 +1,10 @@
+// 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.
+
+import type { Banner } from './banner';
+
+/**
+ * Banners defined in the merchandising studio for the given search.
+ */
+export type Banners = {
+  banners?: Banner;
+};
diff --git a/packages/algoliasearch/lite/model/index.ts b/packages/algoliasearch/lite/model/index.ts
@@ -9,6 +9,11 @@ export * from './aroundRadius';
 export * from './aroundRadiusAll';
 export * from './automaticFacetFilter';
 export * from './automaticFacetFilters';
+export * from './banner';
+export * from './bannerImage';
+export * from './bannerImageUrl';
+export * from './bannerLink';
+export * from './banners';
 export * from './baseGetApiKeyResponse';
 export * from './baseIndexSettings';
 export * from './baseRecommendIndexSettings';
@@ -119,5 +124,6 @@ export * from './trendingItemsQuery';
 export * from './typoTolerance';
 export * from './typoToleranceEnum';
 export * from './value';
+export * from './widgets';
 export * from './withPrimary';
 export * from './clientMethodProps';
diff --git a/packages/algoliasearch/lite/model/renderingContent.ts b/packages/algoliasearch/lite/model/renderingContent.ts
@@ -2,6 +2,7 @@
 
 import type { FacetOrdering } from './facetOrdering';
 import type { RedirectURL } from './redirectURL';
+import type { Widgets } from './widgets';
 
 /**
  * Extra data that can be used in the search UI.  You can use this to control aspects of your search UI, such as, the order of facet names and values without changing your frontend code.
@@ -10,4 +11,6 @@ export type RenderingContent = {
   facetOrdering?: FacetOrdering;
 
   redirect?: RedirectURL;
+
+  widgets?: Widgets;
 };
diff --git a/packages/algoliasearch/lite/model/widgets.ts b/packages/algoliasearch/lite/model/widgets.ts
@@ -0,0 +1,10 @@
+// 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.
+
+import type { Banners } from './banners';
+
+/**
+ * Widgets returned from any rules that are applied to the current search.
+ */
+export type Widgets = {
+  banners?: Banners;
+};
diff --git a/packages/client-search/model/banner.ts b/packages/client-search/model/banner.ts
@@ -0,0 +1,13 @@
+// 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.
+
+import type { BannerImage } from './bannerImage';
+import type { BannerLink } from './bannerLink';
+
+/**
+ * A search banner with image and url.
+ */
+export type Banner = {
+  image?: BannerImage;
+
+  link?: BannerLink;
+};
diff --git a/packages/client-search/model/bannerImage.ts b/packages/client-search/model/bannerImage.ts
@@ -0,0 +1,12 @@
+// 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.
+
+import type { BannerImageUrl } from './bannerImageUrl';
+
+/**
+ * Image of a search banner.
+ */
+export type BannerImage = {
+  urls?: BannerImageUrl;
+
+  title?: string;
+};
diff --git a/packages/client-search/model/bannerImageUrl.ts b/packages/client-search/model/bannerImageUrl.ts
@@ -0,0 +1,8 @@
+// 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.
+
+/**
+ * Url for a search banner image.
+ */
+export type BannerImageUrl = {
+  url?: string;
+};
diff --git a/packages/client-search/model/bannerLink.ts b/packages/client-search/model/bannerLink.ts
@@ -0,0 +1,8 @@
+// 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.
+
+/**
+ * Link for a banner defined in merchandising studio.
+ */
+export type BannerLink = {
+  url?: string;
+};
diff --git a/packages/client-search/model/banners.ts b/packages/client-search/model/banners.ts
@@ -0,0 +1,10 @@
+// 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.
+
+import type { Banner } from './banner';
+
+/**
+ * Banners defined in the merchandising studio for the given search.
+ */
+export type Banners = {
+  banners?: Banner;
+};
diff --git a/packages/client-search/model/index.ts b/packages/client-search/model/index.ts
@@ -15,6 +15,11 @@ export * from './assignUserIdParams';
 export * from './attributeToUpdate';
 export * from './automaticFacetFilter';
 export * from './automaticFacetFilters';
+export * from './banner';
+export * from './bannerImage';
+export * from './bannerImageUrl';
+export * from './bannerLink';
+export * from './banners';
 export * from './baseGetApiKeyResponse';
 export * from './baseIndexSettings';
 export * from './baseSearchParams';
@@ -173,5 +178,6 @@ export * from './userHighlightResult';
 export * from './userHit';
 export * from './userId';
 export * from './value';
+export * from './widgets';
 export * from './withPrimary';
 export * from './clientMethodProps';
diff --git a/packages/client-search/model/renderingContent.ts b/packages/client-search/model/renderingContent.ts
@@ -2,6 +2,7 @@
 
 import type { FacetOrdering } from './facetOrdering';
 import type { RedirectURL } from './redirectURL';
+import type { Widgets } from './widgets';
 
 /**
  * Extra data that can be used in the search UI.  You can use this to control aspects of your search UI, such as, the order of facet names and values without changing your frontend code.
@@ -10,4 +11,6 @@ export type RenderingContent = {
   facetOrdering?: FacetOrdering;
 
   redirect?: RedirectURL;
+
+  widgets?: Widgets;
 };
diff --git a/packages/client-search/model/widgets.ts b/packages/client-search/model/widgets.ts
@@ -0,0 +1,10 @@
+// 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.
+
+import type { Banners } from './banners';
+
+/**
+ * Widgets returned from any rules that are applied to the current search.
+ */
+export type Widgets = {
+  banners?: Banners;
+};
diff --git a/packages/recommend/model/banner.ts b/packages/recommend/model/banner.ts
@@ -0,0 +1,13 @@
+// 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.
+
+import type { BannerImage } from './bannerImage';
+import type { BannerLink } from './bannerLink';
+
+/**
+ * A search banner with image and url.
+ */
+export type Banner = {
+  image?: BannerImage;
+
+  link?: BannerLink;
+};
diff --git a/packages/recommend/model/bannerImage.ts b/packages/recommend/model/bannerImage.ts
@@ -0,0 +1,12 @@
+// 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.
+
+import type { BannerImageUrl } from './bannerImageUrl';
+
+/**
+ * Image of a search banner.
+ */
+export type BannerImage = {
+  urls?: BannerImageUrl;
+
+  title?: string;
+};
diff --git a/packages/recommend/model/bannerImageUrl.ts b/packages/recommend/model/bannerImageUrl.ts
@@ -0,0 +1,8 @@
+// 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.
+
+/**
+ * Url for a search banner image.
+ */
+export type BannerImageUrl = {
+  url?: string;
+};
diff --git a/packages/recommend/model/bannerLink.ts b/packages/recommend/model/bannerLink.ts
@@ -0,0 +1,8 @@
+// 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.
+
+/**
+ * Link for a banner defined in merchandising studio.
+ */
+export type BannerLink = {
+  url?: string;
+};
diff --git a/packages/recommend/model/banners.ts b/packages/recommend/model/banners.ts
@@ -0,0 +1,10 @@
+// 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.
+
+import type { Banner } from './banner';
+
+/**
+ * Banners defined in the merchandising studio for the given search.
+ */
+export type Banners = {
+  banners?: Banner;
+};
diff --git a/packages/recommend/model/index.ts b/packages/recommend/model/index.ts
@@ -6,6 +6,11 @@ export * from './aroundPrecision';
 export * from './aroundRadius';
 export * from './aroundRadiusAll';
 export * from './autoFacetFilter';
+export * from './banner';
+export * from './bannerImage';
+export * from './bannerImageUrl';
+export * from './bannerLink';
+export * from './banners';
 export * from './baseIndexSettings';
 export * from './baseRecommendIndexSettings';
 export * from './baseRecommendRequest';
@@ -93,4 +98,5 @@ export * from './trendingItemsQuery';
 export * from './typoTolerance';
 export * from './typoToleranceEnum';
 export * from './value';
+export * from './widgets';
 export * from './clientMethodProps';
diff --git a/packages/recommend/model/renderingContent.ts b/packages/recommend/model/renderingContent.ts
@@ -2,6 +2,7 @@
 
 import type { FacetOrdering } from './facetOrdering';
 import type { RedirectURL } from './redirectURL';
+import type { Widgets } from './widgets';
 
 /**
  * Extra data that can be used in the search UI.  You can use this to control aspects of your search UI, such as, the order of facet names and values without changing your frontend code.
@@ -10,4 +11,6 @@ export type RenderingContent = {
   facetOrdering?: FacetOrdering;
 
   redirect?: RedirectURL;
+
+  widgets?: Widgets;
 };
diff --git a/packages/recommend/model/widgets.ts b/packages/recommend/model/widgets.ts
@@ -0,0 +1,10 @@
+// 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.
+
+import type { Banners } from './banners';
+
+/**
+ * Widgets returned from any rules that are applied to the current search.
+ */
+export type Widgets = {
+  banners?: Banners;
+};