@empathyco/x-components 3.0.0-alpha.39 → 3.0.0-alpha.391

package/docs/API-reference/api/x-adapter-platform.platformadapter.search.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-adapter-platform](./x-adapter-platform.md) &gt; [PlatformAdapter](./x-adapter-platform.platformadapter.md) &gt; [search](./x-adapter-platform.platformadapter.search.md)
+
+## PlatformAdapter.search property
+
+**Signature:**
+
+```typescript
+search: ExtendableEndpointAdapter<SearchRequest, SearchResponse>;
+```

package/docs/API-reference/api/x-adapter-platform.platformadapter.semanticqueries.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-adapter-platform](./x-adapter-platform.md) &gt; [PlatformAdapter](./x-adapter-platform.platformadapter.md) &gt; [semanticQueries](./x-adapter-platform.platformadapter.semanticqueries.md)
+
+## PlatformAdapter.semanticQueries property
+
+**Signature:**
+
+```typescript
+semanticQueries: ExtendableEndpointAdapter<SemanticQueriesRequest, SemanticQueriesResponse>;
+```

package/docs/API-reference/api/x-adapter-platform.platformadapter.tagging.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-adapter-platform](./x-adapter-platform.md) &gt; [PlatformAdapter](./x-adapter-platform.platformadapter.md) &gt; [tagging](./x-adapter-platform.platformadapter.tagging.md)
+
+## PlatformAdapter.tagging property
+
+**Signature:**
+
+```typescript
+tagging: ExtendableEndpointAdapter<TaggingRequest, void>;
+```

package/docs/API-reference/api/x-adapter-platform.platformbanner.id.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-adapter-platform](./x-adapter-platform.md) &gt; [PlatformBanner](./x-adapter-platform.platformbanner.md) &gt; [id](./x-adapter-platform.platformbanner.id.md)
+
+## PlatformBanner.id property
+
+**Signature:**
+
+```typescript
+id: string;
+```

package/docs/API-reference/api/x-adapter-platform.platformbanner.image_url.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-adapter-platform](./x-adapter-platform.md) &gt; [PlatformBanner](./x-adapter-platform.platformbanner.md) &gt; [image\_url](./x-adapter-platform.platformbanner.image_url.md)
+
+## PlatformBanner.image\_url property
+
+**Signature:**
+
+```typescript
+image_url: string;
+```

package/docs/API-reference/api/x-adapter-platform.platformbanner.md

@@ -0,0 +1,25 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-adapter-platform](./x-adapter-platform.md) &gt; [PlatformBanner](./x-adapter-platform.platformbanner.md)
+
+## PlatformBanner interface
+
+Banner model for the `platform` API.
+
+**Signature:**
+
+```typescript
+export interface PlatformBanner 
+```
+
+## Properties
+
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [id](./x-adapter-platform.platformbanner.id.md) |  | string |  |
+|  [image\_url](./x-adapter-platform.platformbanner.image_url.md) |  | string |  |
+|  [position?](./x-adapter-platform.platformbanner.position.md) |  | number | _(Optional)_ |
+|  [tagging?](./x-adapter-platform.platformbanner.tagging.md) |  | { query?: string; click?: string; } | _(Optional)_ |
+|  [title](./x-adapter-platform.platformbanner.title.md) |  | string |  |
+|  [url](./x-adapter-platform.platformbanner.url.md) |  | string |  |
+

package/docs/API-reference/api/x-adapter-platform.platformbanner.position.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-adapter-platform](./x-adapter-platform.md) &gt; [PlatformBanner](./x-adapter-platform.platformbanner.md) &gt; [position](./x-adapter-platform.platformbanner.position.md)
+
+## PlatformBanner.position property
+
+**Signature:**
+
+```typescript
+position?: number;
+```

package/docs/API-reference/api/x-adapter-platform.platformbanner.tagging.md

@@ -0,0 +1,14 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-adapter-platform](./x-adapter-platform.md) &gt; [PlatformBanner](./x-adapter-platform.platformbanner.md) &gt; [tagging](./x-adapter-platform.platformbanner.tagging.md)
+
+## PlatformBanner.tagging property
+
+**Signature:**
+
+```typescript
+tagging?: {
+        query?: string;
+        click?: string;
+    };
+```

package/docs/API-reference/api/x-adapter-platform.platformbanner.title.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-adapter-platform](./x-adapter-platform.md) &gt; [PlatformBanner](./x-adapter-platform.platformbanner.md) &gt; [title](./x-adapter-platform.platformbanner.title.md)
+
+## PlatformBanner.title property
+
+**Signature:**
+
+```typescript
+title: string;
+```

package/docs/API-reference/api/x-adapter-platform.platformbanner.url.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-adapter-platform](./x-adapter-platform.md) &gt; [PlatformBanner](./x-adapter-platform.platformbanner.md) &gt; [url](./x-adapter-platform.platformbanner.url.md)
+
+## PlatformBanner.url property
+
+**Signature:**
+
+```typescript
+url: string;
+```

package/docs/API-reference/api/x-adapter-platform.platformfacet.facet.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-adapter-platform](./x-adapter-platform.md) &gt; [PlatformFacet](./x-adapter-platform.platformfacet.md) &gt; [facet](./x-adapter-platform.platformfacet.facet.md)
+
+## PlatformFacet.facet property
+
+**Signature:**
+
+```typescript
+facet: string;
+```

package/docs/API-reference/api/x-adapter-platform.platformfacet.md

@@ -0,0 +1,22 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-adapter-platform](./x-adapter-platform.md) &gt; [PlatformFacet](./x-adapter-platform.platformfacet.md)
+
+## PlatformFacet interface
+
+Facet model for the `platform` API.
+
+**Signature:**
+
+```typescript
+export interface PlatformFacet 
+```
+
+## Properties
+
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [facet](./x-adapter-platform.platformfacet.facet.md) |  | string |  |
+|  [type](./x-adapter-platform.platformfacet.type.md) |  | [PlatformFacetType](./x-adapter-platform.platformfacettype.md) |  |
+|  [values](./x-adapter-platform.platformfacet.values.md) |  | [PlatformFilter](./x-adapter-platform.platformfilter.md)<!-- -->\[\] |  |
+

package/docs/API-reference/api/x-adapter-platform.platformfacet.type.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-adapter-platform](./x-adapter-platform.md) &gt; [PlatformFacet](./x-adapter-platform.platformfacet.md) &gt; [type](./x-adapter-platform.platformfacet.type.md)
+
+## PlatformFacet.type property
+
+**Signature:**
+
+```typescript
+type: PlatformFacetType;
+```

package/docs/API-reference/api/x-adapter-platform.platformfacet.values.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-adapter-platform](./x-adapter-platform.md) &gt; [PlatformFacet](./x-adapter-platform.platformfacet.md) &gt; [values](./x-adapter-platform.platformfacet.values.md)
+
+## PlatformFacet.values property
+
+**Signature:**
+
+```typescript
+values: PlatformFilter[];
+```

package/docs/API-reference/api/x-adapter-platform.platformfacettype.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-adapter-platform](./x-adapter-platform.md) &gt; [PlatformFacetType](./x-adapter-platform.platformfacettype.md)
+
+## PlatformFacetType type
+
+Facet type for the `platform` API. It can be: value, hierarchical or range.
+
+**Signature:**
+
+```typescript
+export type PlatformFacetType = 'value' | 'hierarchical' | 'range';
+```

package/docs/API-reference/api/x-adapter-platform.platformfilter.count.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-adapter-platform](./x-adapter-platform.md) &gt; [PlatformFilter](./x-adapter-platform.platformfilter.md) &gt; [count](./x-adapter-platform.platformfilter.count.md)
+
+## PlatformFilter.count property
+
+**Signature:**
+
+```typescript
+count: number;
+```

package/docs/API-reference/api/x-adapter-platform.platformfilter.filter.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-adapter-platform](./x-adapter-platform.md) &gt; [PlatformFilter](./x-adapter-platform.platformfilter.md) &gt; [filter](./x-adapter-platform.platformfilter.filter.md)
+
+## PlatformFilter.filter property
+
+**Signature:**
+
+```typescript
+filter: string;
+```

package/docs/API-reference/api/x-adapter-platform.platformfilter.id.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-adapter-platform](./x-adapter-platform.md) &gt; [PlatformFilter](./x-adapter-platform.platformfilter.md) &gt; [id](./x-adapter-platform.platformfilter.id.md)
+
+## PlatformFilter.id property
+
+**Signature:**
+
+```typescript
+id: string;
+```

package/docs/API-reference/api/x-adapter-platform.platformfilter.md

@@ -0,0 +1,23 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-adapter-platform](./x-adapter-platform.md) &gt; [PlatformFilter](./x-adapter-platform.platformfilter.md)
+
+## PlatformFilter interface
+
+Filter model for the `platform` API.
+
+**Signature:**
+
+```typescript
+export interface PlatformFilter 
+```
+
+## Properties
+
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [count](./x-adapter-platform.platformfilter.count.md) |  | number |  |
+|  [filter](./x-adapter-platform.platformfilter.filter.md) |  | string |  |
+|  [id](./x-adapter-platform.platformfilter.id.md) |  | string |  |
+|  [value](./x-adapter-platform.platformfilter.value.md) |  | string |  |
+

package/docs/API-reference/api/x-adapter-platform.platformfilter.value.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-adapter-platform](./x-adapter-platform.md) &gt; [PlatformFilter](./x-adapter-platform.platformfilter.md) &gt; [value](./x-adapter-platform.platformfilter.value.md)
+
+## PlatformFilter.value property
+
+**Signature:**
+
+```typescript
+value: string;
+```

package/docs/API-reference/api/x-adapter-platform.platformhierarchicalfilter.children.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-adapter-platform](./x-adapter-platform.md) &gt; [PlatformHierarchicalFilter](./x-adapter-platform.platformhierarchicalfilter.md) &gt; [children](./x-adapter-platform.platformhierarchicalfilter.children.md)
+
+## PlatformHierarchicalFilter.children property
+
+**Signature:**
+
+```typescript
+children: PlatformFacet;
+```

package/docs/API-reference/api/x-adapter-platform.platformhierarchicalfilter.md

@@ -0,0 +1,21 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-adapter-platform](./x-adapter-platform.md) &gt; [PlatformHierarchicalFilter](./x-adapter-platform.platformhierarchicalfilter.md)
+
+## PlatformHierarchicalFilter interface
+
+HierarchicalFilter model for the `platform` API.
+
+**Signature:**
+
+```typescript
+export interface PlatformHierarchicalFilter extends PlatformFilter 
+```
+**Extends:** [PlatformFilter](./x-adapter-platform.platformfilter.md)
+
+## Properties
+
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [children](./x-adapter-platform.platformhierarchicalfilter.children.md) |  | [PlatformFacet](./x-adapter-platform.platformfacet.md) |  |
+

package/docs/API-reference/api/x-adapter-platform.platformidentifierresultsrequest.md

@@ -0,0 +1,15 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-adapter-platform](./x-adapter-platform.md) &gt; [PlatformIdentifierResultsRequest](./x-adapter-platform.platformidentifierresultsrequest.md)
+
+## PlatformIdentifierResultsRequest interface
+
+Request for the `identifier results` endpoint.
+
+**Signature:**
+
+```typescript
+export interface PlatformIdentifierResultsRequest extends PlatformQueryableRequest, PlatformPageableRequest, PlatformTrackableRequest, PlatformExtraParamsRequest 
+```
+**Extends:** PlatformQueryableRequest, PlatformPageableRequest, PlatformTrackableRequest, PlatformExtraParamsRequest
+

package/docs/API-reference/api/x-adapter-platform.platformidentifierresultsresponse.catalog.md

@@ -0,0 +1,16 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-adapter-platform](./x-adapter-platform.md) &gt; [PlatformIdentifierResultsResponse](./x-adapter-platform.platformidentifierresultsresponse.md) &gt; [catalog](./x-adapter-platform.platformidentifierresultsresponse.catalog.md)
+
+## PlatformIdentifierResultsResponse.catalog property
+
+**Signature:**
+
+```typescript
+catalog: {
+        content: PlatformResult[];
+        tagging: {
+            query: string;
+        };
+    };
+```

package/docs/API-reference/api/x-adapter-platform.platformidentifierresultsresponse.md

@@ -0,0 +1,20 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-adapter-platform](./x-adapter-platform.md) &gt; [PlatformIdentifierResultsResponse](./x-adapter-platform.platformidentifierresultsresponse.md)
+
+## PlatformIdentifierResultsResponse interface
+
+Response for the `identifier results` endpoint.
+
+**Signature:**
+
+```typescript
+export interface PlatformIdentifierResultsResponse 
+```
+
+## Properties
+
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [catalog](./x-adapter-platform.platformidentifierresultsresponse.catalog.md) |  | { content: [PlatformResult](./x-adapter-platform.platformresult.md)<!-- -->\[\]; tagging: { query: string; }; } |  |
+

package/docs/API-reference/api/x-adapter-platform.platformnextqueriesrequest.md

@@ -0,0 +1,15 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-adapter-platform](./x-adapter-platform.md) &gt; [PlatformNextQueriesRequest](./x-adapter-platform.platformnextqueriesrequest.md)
+
+## PlatformNextQueriesRequest interface
+
+Request for the `next queries` endpoint with `extra params`<!-- -->.
+
+**Signature:**
+
+```typescript
+export interface PlatformNextQueriesRequest extends PlatformQueryableRequest, PlatformExtraParamsRequest 
+```
+**Extends:** PlatformQueryableRequest, PlatformExtraParamsRequest
+

package/docs/API-reference/api/x-adapter-platform.platformnextqueriesresponse.data.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-adapter-platform](./x-adapter-platform.md) &gt; [PlatformNextQueriesResponse](./x-adapter-platform.platformnextqueriesresponse.md) &gt; [data](./x-adapter-platform.platformnextqueriesresponse.data.md)
+
+## PlatformNextQueriesResponse.data property
+
+**Signature:**
+
+```typescript
+data: {
+        nextqueries: PlatformNextQuery[];
+    };
+```

package/docs/API-reference/api/x-adapter-platform.platformnextqueriesresponse.md

@@ -0,0 +1,20 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-adapter-platform](./x-adapter-platform.md) &gt; [PlatformNextQueriesResponse](./x-adapter-platform.platformnextqueriesresponse.md)
+
+## PlatformNextQueriesResponse interface
+
+Response for the `next queries` endpoint.
+
+**Signature:**
+
+```typescript
+export interface PlatformNextQueriesResponse 
+```
+
+## Properties
+
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [data](./x-adapter-platform.platformnextqueriesresponse.data.md) |  | { nextqueries: [PlatformNextQuery](./x-adapter-platform.platformnextquery.md)<!-- -->\[\]; } |  |
+

package/docs/API-reference/api/x-adapter-platform.platformnextquery.md

@@ -0,0 +1,22 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-adapter-platform](./x-adapter-platform.md) &gt; [PlatformNextQuery](./x-adapter-platform.platformnextquery.md)
+
+## PlatformNextQuery interface
+
+Next query model for the `platform` API.
+
+**Signature:**
+
+```typescript
+export interface PlatformNextQuery 
+```
+
+## Properties
+
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [position](./x-adapter-platform.platformnextquery.position.md) |  | number |  |
+|  [query](./x-adapter-platform.platformnextquery.query.md) |  | string |  |
+|  [source](./x-adapter-platform.platformnextquery.source.md) |  | 'ORGANIC' \| 'CURATED' |  |
+

package/docs/API-reference/api/x-adapter-platform.platformnextquery.position.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-adapter-platform](./x-adapter-platform.md) &gt; [PlatformNextQuery](./x-adapter-platform.platformnextquery.md) &gt; [position](./x-adapter-platform.platformnextquery.position.md)
+
+## PlatformNextQuery.position property
+
+**Signature:**
+
+```typescript
+position: number;
+```

package/docs/API-reference/api/x-adapter-platform.platformnextquery.query.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-adapter-platform](./x-adapter-platform.md) &gt; [PlatformNextQuery](./x-adapter-platform.platformnextquery.md) &gt; [query](./x-adapter-platform.platformnextquery.query.md)
+
+## PlatformNextQuery.query property
+
+**Signature:**
+
+```typescript
+query: string;
+```

package/docs/API-reference/api/x-adapter-platform.platformnextquery.source.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-adapter-platform](./x-adapter-platform.md) &gt; [PlatformNextQuery](./x-adapter-platform.platformnextquery.md) &gt; [source](./x-adapter-platform.platformnextquery.source.md)
+
+## PlatformNextQuery.source property
+
+**Signature:**
+
+```typescript
+source: 'ORGANIC' | 'CURATED';
+```

package/docs/API-reference/api/x-adapter-platform.platformpartialresult.content.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-adapter-platform](./x-adapter-platform.md) &gt; [PlatformPartialResult](./x-adapter-platform.platformpartialresult.md) &gt; [content](./x-adapter-platform.platformpartialresult.content.md)
+
+## PlatformPartialResult.content property
+
+**Signature:**
+
+```typescript
+content: PlatformResult[];
+```

package/docs/API-reference/api/x-adapter-platform.platformpartialresult.md

@@ -0,0 +1,22 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-adapter-platform](./x-adapter-platform.md) &gt; [PlatformPartialResult](./x-adapter-platform.platformpartialresult.md)
+
+## PlatformPartialResult interface
+
+Partial results model in platform.
+
+**Signature:**
+
+```typescript
+export interface PlatformPartialResult 
+```
+
+## Properties
+
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [content](./x-adapter-platform.platformpartialresult.content.md) |  | [PlatformResult](./x-adapter-platform.platformresult.md)<!-- -->\[\] |  |
+|  [numFound](./x-adapter-platform.platformpartialresult.numfound.md) |  | number |  |
+|  [term](./x-adapter-platform.platformpartialresult.term.md) |  | string |  |
+

package/docs/API-reference/api/x-adapter-platform.platformpartialresult.numfound.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-adapter-platform](./x-adapter-platform.md) &gt; [PlatformPartialResult](./x-adapter-platform.platformpartialresult.md) &gt; [numFound](./x-adapter-platform.platformpartialresult.numfound.md)
+
+## PlatformPartialResult.numFound property
+
+**Signature:**
+
+```typescript
+numFound: number;
+```

package/docs/API-reference/api/x-adapter-platform.platformpartialresult.term.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-adapter-platform](./x-adapter-platform.md) &gt; [PlatformPartialResult](./x-adapter-platform.platformpartialresult.md) &gt; [term](./x-adapter-platform.platformpartialresult.term.md)
+
+## PlatformPartialResult.term property
+
+**Signature:**
+
+```typescript
+term: string;
+```

package/docs/API-reference/api/x-adapter-platform.platformpopularsearchesrequest.md

@@ -0,0 +1,15 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-adapter-platform](./x-adapter-platform.md) &gt; [PlatformPopularSearchesRequest](./x-adapter-platform.platformpopularsearchesrequest.md)
+
+## PlatformPopularSearchesRequest interface
+
+Platform request for the `popular searches` endpoint.
+
+**Signature:**
+
+```typescript
+export interface PlatformPopularSearchesRequest extends PlatformPageableRequest, PlatformExtraParamsRequest 
+```
+**Extends:** PlatformPageableRequest, PlatformExtraParamsRequest
+

package/docs/API-reference/api/x-adapter-platform.platformpopularsearchesresponse.md

@@ -0,0 +1,20 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-adapter-platform](./x-adapter-platform.md) &gt; [PlatformPopularSearchesResponse](./x-adapter-platform.platformpopularsearchesresponse.md)
+
+## PlatformPopularSearchesResponse interface
+
+Response for the `popular searches` endpoint.
+
+**Signature:**
+
+```typescript
+export interface PlatformPopularSearchesResponse 
+```
+
+## Properties
+
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [topTrends](./x-adapter-platform.platformpopularsearchesresponse.toptrends.md) |  | { content: [PlatformSuggestion](./x-adapter-platform.platformsuggestion.md)<!-- -->\[\]; } |  |
+

package/docs/API-reference/api/x-adapter-platform.platformpopularsearchesresponse.toptrends.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-adapter-platform](./x-adapter-platform.md) &gt; [PlatformPopularSearchesResponse](./x-adapter-platform.platformpopularsearchesresponse.md) &gt; [topTrends](./x-adapter-platform.platformpopularsearchesresponse.toptrends.md)
+
+## PlatformPopularSearchesResponse.topTrends property
+
+**Signature:**
+
+```typescript
+topTrends: {
+        content: PlatformSuggestion[];
+    };
+```

package/docs/API-reference/api/x-adapter-platform.platformpromoted.id.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-adapter-platform](./x-adapter-platform.md) &gt; [PlatformPromoted](./x-adapter-platform.platformpromoted.md) &gt; [id](./x-adapter-platform.platformpromoted.id.md)
+
+## PlatformPromoted.id property
+
+**Signature:**
+
+```typescript
+id: string;
+```

package/docs/API-reference/api/x-adapter-platform.platformpromoted.image_url.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@empathyco/x-adapter-platform](./x-adapter-platform.md) &gt; [PlatformPromoted](./x-adapter-platform.platformpromoted.md) &gt; [image\_url](./x-adapter-platform.platformpromoted.image_url.md)
+
+## PlatformPromoted.image\_url property
+
+**Signature:**
+
+```typescript
+image_url: string;
+```