Merge 6171800 into 1e9084a

docs/search-core.appliedqueryfilter.filter.md

@@ -9,5 +9,5 @@ The filter applied to the query results.
 <b>Signature:</b>
 
 ```typescript
-filter: Filter;
+filter: FieldValueFilter;
 ```

docs/search-core.appliedqueryfilter.md

@@ -19,6 +19,6 @@ export interface AppliedQueryFilter
 |  [details?](./search-core.appliedqueryfilter.details.md) | [LocationFilterDetails](./search-core.locationfilterdetails.md) | <i>(Optional)</i> Additional details relevant to the filter with "PLACE" for its [AppliedQueryFilterType](./search-core.appliedqueryfiltertype.md)<!-- -->. |
 |  [displayKey](./search-core.appliedqueryfilter.displaykey.md) | string | The display name of the filter key. |
 |  [displayValue](./search-core.appliedqueryfilter.displayvalue.md) | string | The value used in the filter. |
-|  [filter](./search-core.appliedqueryfilter.filter.md) | [Filter](./search-core.filter.md) | The filter applied to the query results. |
+|  [filter](./search-core.appliedqueryfilter.filter.md) | [FieldValueFilter](./search-core.fieldvaluefilter.md) | The filter applied to the query results. |
 |  [type](./search-core.appliedqueryfilter.type.md) | [AppliedQueryFilterType](./search-core.appliedqueryfiltertype.md) | Represents the type of [AppliedQueryFilter](./search-core.appliedqueryfilter.md) applied to a search. |
 

docs/search-core.autocompleteresult.filter.md

@@ -9,7 +9,7 @@ A filter applied to the autocomplete response.
 <b>Signature:</b>
 
 ```typescript
-filter?: Filter;
+filter?: FieldValueFilter;
 ```
 
 ## Remarks

docs/search-core.autocompleteresult.md

@@ -16,7 +16,7 @@ export interface AutocompleteResult
 
 |  Property | Type | Description |
 |  --- | --- | --- |
-|  [filter?](./search-core.autocompleteresult.filter.md) | [Filter](./search-core.filter.md) | <i>(Optional)</i> A filter applied to the autocomplete response. |
+|  [filter?](./search-core.autocompleteresult.filter.md) | [FieldValueFilter](./search-core.fieldvaluefilter.md) | <i>(Optional)</i> A filter applied to the autocomplete response. |
 |  [key?](./search-core.autocompleteresult.key.md) | string | <i>(Optional)</i> The fieldId which corresponds to the AutocompleteResult value. |
 |  [matchedSubstrings?](./search-core.autocompleteresult.matchedsubstrings.md) | { length: number; offset: number; }\[\] | <i>(Optional)</i> An array of substrings which overlap with the autocomplete input. |
 |  [relatedItem?](./search-core.autocompleteresult.relateditem.md) | [Result](./search-core.result.md) | <i>(Optional)</i> An entity that corresponds to the autocomplete result. |

docs/search-core.builtinfieldtype.md

@@ -0,0 +1,21 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@yext/search-core](./search-core.md) &gt; [BuiltInFieldType](./search-core.builtinfieldtype.md)
+
+## BuiltInFieldType enum
+
+Possible built-in field types for [DirectAnswer.fieldType](./search-core.directanswer.fieldtype.md)<!-- -->.
+
+<b>Signature:</b>
+
+```typescript
+export declare enum BuiltInFieldType 
+```
+
+## Enumeration Members
+
+|  Member | Value | Description |
+|  --- | --- | --- |
+|  Address | <code>&quot;address&quot;</code> |  |
+|  Email | <code>&quot;email&quot;</code> |  |
+

docs/search-core.directanswer.fieldtype.md

@@ -9,5 +9,5 @@ The field type of the direct answer.
 <b>Signature:</b>
 
 ```typescript
-fieldType: string;
+fieldType: BuiltInFieldType | string;
 ```

docs/search-core.directanswer.md

@@ -9,16 +9,16 @@ A direct answer to a search.
 <b>Signature:</b>
 
 ```typescript
-export interface DirectAnswer 
+export interface DirectAnswer<T = unknown> 
 ```
 
 ## Properties
 
 |  Property | Type | Description |
 |  --- | --- | --- |
-|  [fieldType](./search-core.directanswer.fieldtype.md) | string | The field type of the direct answer. |
+|  [fieldType](./search-core.directanswer.fieldtype.md) | [BuiltInFieldType](./search-core.builtinfieldtype.md) \| string | The field type of the direct answer. |
 |  [relatedResult](./search-core.directanswer.relatedresult.md) | [Result](./search-core.result.md) | The entity associated with the direct answer. |
 |  [type](./search-core.directanswer.type.md) | [DirectAnswerType](./search-core.directanswertype.md) | The [DirectAnswerType](./search-core.directanswertype.md)<!-- -->. |
-|  [value?](./search-core.directanswer.value.md) | string | <i>(Optional)</i> The result of the direct answer. |
+|  [value?](./search-core.directanswer.value.md) | T | <i>(Optional)</i> The result of the direct answer. |
 |  [verticalKey](./search-core.directanswer.verticalkey.md) | string | The vertical key of the direct answer. |
 

docs/search-core.directanswer.value.md

@@ -9,7 +9,7 @@ The result of the direct answer.
 <b>Signature:</b>
 
 ```typescript
-value?: string;
+value?: T;
 ```
 
 ## Remarks

docs/search-core.displayablefacet.md

@@ -18,6 +18,5 @@ export interface DisplayableFacet extends Facet
 |  Property | Type | Description |
 |  --- | --- | --- |
 |  [displayName](./search-core.displayablefacet.displayname.md) | string | The name of the facet which is meant to be displayed to the user. |
-|  [fieldId](./search-core.displayablefacet.fieldid.md) | string | The associated fieldId. |
 |  [options](./search-core.displayablefacet.options.md) | [DisplayableFacetOption](./search-core.displayablefacetoption.md)<!-- -->\[\] | An array of [DisplayableFacetOption](./search-core.displayablefacetoption.md) |
 

docs/search-core.displayablefacetoption.md

@@ -19,7 +19,5 @@ export interface DisplayableFacetOption extends FacetOption
 |  --- | --- | --- |
 |  [count](./search-core.displayablefacetoption.count.md) | number | The number of results associated with this facet option. |
 |  [displayName](./search-core.displayablefacetoption.displayname.md) | string | The name of the facet option which is meant to be displayed to the end user. |
-|  [matcher](./search-core.displayablefacetoption.matcher.md) | [Matcher](./search-core.matcher.md) | A Matcher is a filtering operation. |
 |  [selected](./search-core.displayablefacetoption.selected.md) | boolean | Whether or not the filter is selected in the search results. |
-|  [value](./search-core.displayablefacetoption.value.md) | string \| number \| boolean \| [NumberRangeValue](./search-core.numberrangevalue.md) | The value to compare. |
 

docs/search-core.email.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@yext/search-core](./search-core.md) &gt; [Email](./search-core.email.md)
+
+## Email type
+
+A type to use in email direct answer's value [FieldValueDirectAnswer.value](./search-core.fieldvaluedirectanswer.value.md)<!-- -->.
+
+<b>Signature:</b>
+
+```typescript
+export declare type Email = string[];
+```

docs/search-core.emaildirectanswer.fieldtype.md

@@ -0,0 +1,11 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@yext/search-core](./search-core.md) &gt; [EmailDirectAnswer](./search-core.emaildirectanswer.md) &gt; [fieldType](./search-core.emaildirectanswer.fieldtype.md)
+
+## EmailDirectAnswer.fieldType property
+
+<b>Signature:</b>
+
+```typescript
+fieldType: BuiltInFieldType.Email;
+```

docs/search-core.emaildirectanswer.md

@@ -0,0 +1,21 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@yext/search-core](./search-core.md) &gt; [EmailDirectAnswer](./search-core.emaildirectanswer.md)
+
+## EmailDirectAnswer interface
+
+A interface for direct answers [FieldValueDirectAnswer](./search-core.fieldvaluedirectanswer.md) with email values.
+
+<b>Signature:</b>
+
+```typescript
+export interface EmailDirectAnswer extends FieldValueDirectAnswer<Email> 
+```
+<b>Extends:</b> [FieldValueDirectAnswer](./search-core.fieldvaluedirectanswer.md)<!-- -->&lt;[Email](./search-core.email.md)<!-- -->&gt;
+
+## Properties
+
+|  Property | Type | Description |
+|  --- | --- | --- |
+|  [fieldType](./search-core.emaildirectanswer.fieldtype.md) | [BuiltInFieldType.Email](./search-core.builtinfieldtype.md) |  |
+

docs/search-core.facetoption.md

@@ -9,13 +9,13 @@ A filter associated with the facet.
 <b>Signature:</b>
 
 ```typescript
-export interface FacetOption 
+export interface FacetOption extends Omit<FieldValueFilter, 'fieldId'> 
 ```
+<b>Extends:</b> Omit&lt;[FieldValueFilter](./search-core.fieldvaluefilter.md)<!-- -->, 'fieldId'&gt;
 
 ## Properties
 
 |  Property | Type | Description |
 |  --- | --- | --- |
-|  [matcher](./search-core.facetoption.matcher.md) | [Matcher](./search-core.matcher.md) | A Matcher is a filtering operation. |
-|  [value](./search-core.facetoption.value.md) | string \| number \| boolean \| [NumberRangeValue](./search-core.numberrangevalue.md) | The value to compare. |
+|  [value](./search-core.facetoption.value.md) | Exclude&lt;[FieldValueFilter](./search-core.fieldvaluefilter.md)<!-- -->\['value'\], [NearFilterValue](./search-core.nearfiltervalue.md)<!-- -->&gt; | The value to compare. |
 

docs/search-core.facetoption.value.md

@@ -9,7 +9,7 @@ The value to compare.
 <b>Signature:</b>
 
 ```typescript
-value: string | number | boolean | NumberRangeValue;
+value: Exclude<FieldValueFilter['value'], NearFilterValue>;
 ```
 
 ## Example

docs/search-core.featuredsnippetdirectanswer.fieldtype.md

@@ -9,5 +9,5 @@ The field type of the direct answer.
 <b>Signature:</b>
 
 ```typescript
-fieldType: string;
+fieldType: BuiltInFieldType | string;
 ```

docs/search-core.featuredsnippetdirectanswer.md

@@ -9,18 +9,18 @@ A direct answer which was found within a document.
 <b>Signature:</b>
 
 ```typescript
-export interface FeaturedSnippetDirectAnswer extends DirectAnswer 
+export interface FeaturedSnippetDirectAnswer<T = unknown> extends DirectAnswer<T> 
 ```
-<b>Extends:</b> [DirectAnswer](./search-core.directanswer.md)
+<b>Extends:</b> [DirectAnswer](./search-core.directanswer.md)<!-- -->&lt;T&gt;
 
 ## Properties
 
 |  Property | Type | Description |
 |  --- | --- | --- |
-|  [fieldType](./search-core.featuredsnippetdirectanswer.fieldtype.md) | string | The field type of the direct answer. |
+|  [fieldType](./search-core.featuredsnippetdirectanswer.fieldtype.md) | [BuiltInFieldType](./search-core.builtinfieldtype.md) \| string | The field type of the direct answer. |
 |  [relatedResult](./search-core.featuredsnippetdirectanswer.relatedresult.md) | [Result](./search-core.result.md) | The entity associated with the direct answer. |
 |  [snippet](./search-core.featuredsnippetdirectanswer.snippet.md) | [Snippet](./search-core.snippet.md) | The snippet where the direct answer was found. |
 |  [type](./search-core.featuredsnippetdirectanswer.type.md) | [DirectAnswerType.FeaturedSnippet](./search-core.directanswertype.md) | [DirectAnswerType](./search-core.directanswertype.md)<!-- -->.FeaturedSnippet. |
-|  [value?](./search-core.featuredsnippetdirectanswer.value.md) | string | <i>(Optional)</i> The result of the direct answer. |
+|  [value?](./search-core.featuredsnippetdirectanswer.value.md) | T | <i>(Optional)</i> The result of the direct answer. |
 |  [verticalKey](./search-core.featuredsnippetdirectanswer.verticalkey.md) | string | The vertical key of the direct answer. |
 

docs/search-core.featuredsnippetdirectanswer.value.md

@@ -9,7 +9,7 @@ The result of the direct answer.
 <b>Signature:</b>
 
 ```typescript
-value?: string;
+value?: T;
 ```
 
 ## Remarks

docs/search-core.fieldvaluedirectanswer.fieldtype.md

@@ -9,5 +9,5 @@ The field type of the direct answer.
 <b>Signature:</b>
 
 ```typescript
-fieldType: string;
+fieldType: BuiltInFieldType | string;
 ```

docs/search-core.fieldvaluedirectanswer.md

@@ -9,9 +9,9 @@ A direct answer where the answer came from a field from the knowledge graph.
 <b>Signature:</b>
 
 ```typescript
-export interface FieldValueDirectAnswer extends DirectAnswer 
+export interface FieldValueDirectAnswer<T = unknown> extends DirectAnswer<T> 
 ```
-<b>Extends:</b> [DirectAnswer](./search-core.directanswer.md)
+<b>Extends:</b> [DirectAnswer](./search-core.directanswer.md)<!-- -->&lt;T&gt;
 
 ## Properties
 
@@ -20,9 +20,9 @@ export interface FieldValueDirectAnswer extends DirectAnswer
 |  [entityName](./search-core.fieldvaluedirectanswer.entityname.md) | string | The name of the entity that direct answer came from. |
 |  [fieldApiName](./search-core.fieldvaluedirectanswer.fieldapiname.md) | string | The field api name of the direct answer. |
 |  [fieldName](./search-core.fieldvaluedirectanswer.fieldname.md) | string | The field name of the direct answer. |
-|  [fieldType](./search-core.fieldvaluedirectanswer.fieldtype.md) | string | The field type of the direct answer. |
+|  [fieldType](./search-core.fieldvaluedirectanswer.fieldtype.md) | [BuiltInFieldType](./search-core.builtinfieldtype.md) \| string | The field type of the direct answer. |
 |  [relatedResult](./search-core.fieldvaluedirectanswer.relatedresult.md) | [Result](./search-core.result.md) | The entity associated with the direct answer. |
 |  [type](./search-core.fieldvaluedirectanswer.type.md) | [DirectAnswerType.FieldValue](./search-core.directanswertype.md) | [DirectAnswerType](./search-core.directanswertype.md)<!-- -->.FieldValue. |
-|  [value](./search-core.fieldvaluedirectanswer.value.md) | string | The result of the direct answer. |
+|  [value](./search-core.fieldvaluedirectanswer.value.md) | T | The result of the direct answer. |
 |  [verticalKey](./search-core.fieldvaluedirectanswer.verticalkey.md) | string | The vertical key of the direct answer. |
 

docs/search-core.fieldvaluedirectanswer.value.md

@@ -9,7 +9,7 @@ The result of the direct answer.
 <b>Signature:</b>
 
 ```typescript
-value: string;
+value: T;
 ```
 
 ## Remarks

docs/search-core.filter.fieldid.md → docs/search-core.fieldvaluefilter.fieldid.md

@@ -1,8 +1,8 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-[Home](./index.md) &gt; [@yext/search-core](./search-core.md) &gt; [Filter](./search-core.filter.md) &gt; [fieldId](./search-core.filter.fieldid.md)
+[Home](./index.md) &gt; [@yext/search-core](./search-core.md) &gt; [FieldValueFilter](./search-core.fieldvaluefilter.md) &gt; [fieldId](./search-core.fieldvaluefilter.fieldid.md)
 
-## Filter.fieldId property
+## FieldValueFilter.fieldId property
 
 The fieldId to apply the filter against.
 

docs/search-core.facetoption.matcher.md → docs/search-core.fieldvaluefilter.matcher.md

@@ -1,8 +1,8 @@
 <!-- Do not edit this file. It is automatically generated by API Documenter. -->
 
-[Home](./index.md) &gt; [@yext/search-core](./search-core.md) &gt; [FacetOption](./search-core.facetoption.md) &gt; [matcher](./search-core.facetoption.matcher.md)
+[Home](./index.md) &gt; [@yext/search-core](./search-core.md) &gt; [FieldValueFilter](./search-core.fieldvaluefilter.md) &gt; [matcher](./search-core.fieldvaluefilter.matcher.md)
 
-## FacetOption.matcher property
+## FieldValueFilter.matcher property
 
 A Matcher is a filtering operation.
 

docs/search-core.fieldvaluefilter.md

@@ -0,0 +1,22 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@yext/search-core](./search-core.md) &gt; [FieldValueFilter](./search-core.fieldvaluefilter.md)
+
+## FieldValueFilter interface
+
+Represents a filter which compares values to a single field.
+
+<b>Signature:</b>
+
+```typescript
+export interface FieldValueFilter 
+```
+
+## Properties
+
+|  Property | Type | Description |
+|  --- | --- | --- |
+|  [fieldId](./search-core.fieldvaluefilter.fieldid.md) | string | The fieldId to apply the filter against. |
+|  [matcher](./search-core.fieldvaluefilter.matcher.md) | [Matcher](./search-core.matcher.md) | A Matcher is a filtering operation. |
+|  [value](./search-core.fieldvaluefilter.value.md) | string \| number \| boolean \| [NearFilterValue](./search-core.nearfiltervalue.md) \| [NumberRangeValue](./search-core.numberrangevalue.md) | The value to compare. |
+