Merge 6331033 into 6d666eb

yext · Aug 15, 2022 · eb4d022 · eb4d022
2 parents 6d666eb + 6331033
commit eb4d022
Show file tree

Hide file tree

Showing 8 changed files with 55 additions and 1 deletion.
diff --git a/docs/search-core.builtinfieldtype.md b/docs/search-core.builtinfieldtype.md
@@ -16,6 +16,7 @@ export declare enum BuiltInFieldType
 
 |  Member | Value | Description |
 |  --- | --- | --- |
+|  Email | <code>&quot;email&quot;</code> |  |
 |  MultiLineText | <code>&quot;multi_line_text&quot;</code> |  |
 |  Phone | <code>&quot;phone&quot;</code> |  |
 |  RichText | <code>&quot;rich_text&quot;</code> |  |

diff --git a/docs/search-core.emaildirectanswer.fieldtype.md b/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;
+```
diff --git a/docs/search-core.emaildirectanswer.md b/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
+
+An interface for direct answers [DirectAnswer](./search-core.directanswer.md) with email values.
+
+<b>Signature:</b>
+
+```typescript
+export interface EmailDirectAnswer extends DirectAnswer<string[]> 
+```
+<b>Extends:</b> [DirectAnswer](./search-core.directanswer.md)<!-- -->&lt;string\[\]&gt;
+
+## Properties
+
+|  Property | Type | Description |
+|  --- | --- | --- |
+|  [fieldType](./search-core.emaildirectanswer.fieldtype.md) | [BuiltInFieldType.Email](./search-core.builtinfieldtype.md) |  |
+
diff --git a/docs/search-core.md b/docs/search-core.md
@@ -59,6 +59,7 @@
 |  [DisjunctionStaticFilter](./search-core.disjunctionstaticfilter.md) | A static filter composed by combining filters with the logical OR operator. The combined filters can either be field value filters or other disjunction filters. |
 |  [DisplayableFacet](./search-core.displayablefacet.md) | A [Facet](./search-core.facet.md) which contains extra fields meant to be displayed to the end user. |
 |  [DisplayableFacetOption](./search-core.displayablefacetoption.md) | A [FacetOption](./search-core.facetoption.md) with extra data meant to be displayed to the end user. |
+|  [EmailDirectAnswer](./search-core.emaildirectanswer.md) | An interface for direct answers [DirectAnswer](./search-core.directanswer.md) with email values. |
 |  [Endpoints](./search-core.endpoints.md) | Overrides for the URLs which are used when making requests to the Search API. |
 |  [Facet](./search-core.facet.md) | Represents dynamic filter options for the Search API. |
 |  [FacetOption](./search-core.facetoption.md) | A filter associated with the facet. |

diff --git a/etc/search-core.api.md b/etc/search-core.api.md
@@ -104,6 +104,8 @@ export interface BaseSearchConfig {
 
 // @public
 export enum BuiltInFieldType {
+    // (undocumented)
+    Email = "email",
     // (undocumented)
     MultiLineText = "multi_line_text",
     // (undocumented)
@@ -169,6 +171,12 @@ export interface DisplayableFacetOption extends FacetOption {
     selected: boolean;
 }
 
+// @public
+export interface EmailDirectAnswer extends DirectAnswer<string[]> {
+    // (undocumented)
+    fieldType: BuiltInFieldType.Email;
+}
+
 // @public
 export interface Endpoints {
     // (undocumented)

diff --git a/src/models/index.ts b/src/models/index.ts
@@ -79,6 +79,7 @@ export { VerticalSearchResponse } from './searchservice/response/VerticalSearchR
 export { Snippet } from './searchservice/response/Snippet';
 export { ErrorType } from './searchservice/response/ErrorType';
 export { FailedVertical } from './searchservice/response/FailedVertical';
+export { EmailDirectAnswer } from './searchservice/response/EmailDirectAnswer';
 
 // Search service common models
 export { Matcher } from './searchservice/common/Matcher';

diff --git a/src/models/searchservice/response/EmailDirectAnswer.ts b/src/models/searchservice/response/EmailDirectAnswer.ts
@@ -0,0 +1,11 @@
+import { BuiltInFieldType } from './directanswer/BuiltInFieldType';
+import { DirectAnswer } from './directanswer/DirectAnswer';
+
+/**
+ * An interface for direct answers {@link DirectAnswer} with email values.
+ *
+ * @public
+ */
+export interface EmailDirectAnswer extends DirectAnswer<string[]> {
+  fieldType: BuiltInFieldType.Email
+}
diff --git a/src/models/searchservice/response/directanswer/BuiltInFieldType.ts b/src/models/searchservice/response/directanswer/BuiltInFieldType.ts
@@ -8,7 +8,7 @@ export enum BuiltInFieldType {
   // IOSAppURL = 'ios_app_url',
   // AndroidAppURL = 'android_app_url',
   // FacebookURL = 'facebook_url',
-  // Email = 'email',
+  Email = 'email',
   // InstagramHandle = 'instagram_handle',
   // TwitterHandle = 'twitter_handle',
   Phone = 'phone',