Merge a564336 into edc1689

yext · Aug 10, 2022 · 4424bd2 · 4424bd2
2 parents edc1689 + a564336
commit 4424bd2
Show file tree

Hide file tree

Showing 10 changed files with 41 additions and 19 deletions.
diff --git a/docs/search-core.directanswer.md b/docs/search-core.directanswer.md
@@ -9,7 +9,7 @@ A direct answer to a search.
 <b>Signature:</b>
 
 ```typescript
-export interface DirectAnswer 
+export interface DirectAnswer<T = unknown> 
 ```
 
 ## Properties
@@ -19,6 +19,6 @@ export interface DirectAnswer
 |  [fieldType](./search-core.directanswer.fieldtype.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. |
 
diff --git a/docs/search-core.directanswer.value.md b/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

diff --git a/docs/search-core.featuredsnippetdirectanswer.md b/docs/search-core.featuredsnippetdirectanswer.md
@@ -9,9 +9,9 @@ A direct answer which was found within a document.
 <b>Signature:</b>
 
 ```typescript
-export interface FeaturedSnippetDirectAnswer extends DirectAnswer 
+export interface FeaturedSnippetDirectAnswer extends DirectAnswer<string> 
 ```
-<b>Extends:</b> [DirectAnswer](./search-core.directanswer.md)
+<b>Extends:</b> [DirectAnswer](./search-core.directanswer.md)<!-- -->&lt;string&gt;
 
 ## Properties
 

diff --git a/docs/search-core.fieldvaluedirectanswer.md b/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
 
@@ -23,6 +23,6 @@ export interface FieldValueDirectAnswer extends DirectAnswer
 |  [fieldType](./search-core.fieldvaluedirectanswer.fieldtype.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. |
 
diff --git a/docs/search-core.fieldvaluedirectanswer.value.md b/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

diff --git a/etc/search-core.api.md b/etc/search-core.api.md
@@ -109,11 +109,11 @@ export interface CombinedFilter {
 export type Context = any;
 
 // @public
-export interface DirectAnswer {
+export interface DirectAnswer<T = unknown> {
     fieldType: string;
     relatedResult: Result;
     type: DirectAnswerType;
-    value?: string;
+    value?: T;
     verticalKey: string;
 }
 
@@ -195,7 +195,7 @@ export interface FailedVertical {
 }
 
 // @public
-export interface FeaturedSnippetDirectAnswer extends DirectAnswer {
+export interface FeaturedSnippetDirectAnswer extends DirectAnswer<string> {
     fieldType: string;
     relatedResult: Result;
     snippet: Snippet;
@@ -205,14 +205,14 @@ export interface FeaturedSnippetDirectAnswer extends DirectAnswer {
 }
 
 // @public
-export interface FieldValueDirectAnswer extends DirectAnswer {
+export interface FieldValueDirectAnswer<T = unknown> extends DirectAnswer<T> {
     entityName: string;
     fieldApiName: string;
     fieldName: string;
     fieldType: string;
     relatedResult: Result;
     type: DirectAnswerType.FieldValue;
-    value: string;
+    value: T;
     verticalKey: string;
 }
 

diff --git a/src/models/searchservice/response/DirectAnswer.ts b/src/models/searchservice/response/DirectAnswer.ts
@@ -6,7 +6,7 @@ import { DirectAnswerType } from './DirectAnswerType';
  *
  * @public
  */
-export interface DirectAnswer {
+export interface DirectAnswer<T = unknown> {
   /** The {@link DirectAnswerType}. */
   type: DirectAnswerType,
   /**
@@ -15,7 +15,7 @@ export interface DirectAnswer {
    * @remarks
    * A value will not be present if the {@link DirectAnswer.fieldType} is 'rich_text'.
    */
-  value?: string,
+  value?: T,
   /** The entity associated with the direct answer. */
   relatedResult: Result,
   /** The vertical key of the direct answer. */

diff --git a/src/models/searchservice/response/DirectAnswerFieldType.ts b/src/models/searchservice/response/DirectAnswerFieldType.ts
@@ -0,0 +1,22 @@
+/**
+ * Type for value of DirectAnswer.
+ *
+ * @public
+ */
+export enum DirectAnswerFieldType {
+  Url = 'url',
+  ComplexUrl = 'complex_url',
+  IOSAppUrl = 'ios_app_url',
+  AndroidAppUrl = 'android_app_url',
+  FacebookUrl = 'facebook_url',
+  Email = 'email',
+  InstagramHandle = 'instagram_handle',
+  TwitterHandle = 'twitter_handle',
+  Phone = 'phone',
+  Address = 'address',
+  Hours = 'hours',
+  Decimal = 'decimal',
+  RichText = 'rich_text',
+  SingleLineText = 'single_line_text',
+  MultiLineText = 'multi_line_text'
+}
diff --git a/src/models/searchservice/response/FeaturedSnippetDirectAnswer.ts b/src/models/searchservice/response/FeaturedSnippetDirectAnswer.ts
@@ -8,7 +8,7 @@ import { Snippet } from './Snippet';
  *
  * @public
  */
-export interface FeaturedSnippetDirectAnswer extends DirectAnswer {
+export interface FeaturedSnippetDirectAnswer extends DirectAnswer<string> {
   /** {@link DirectAnswerType}.FeaturedSnippet. */
   type: DirectAnswerType.FeaturedSnippet,
   /** {@inheritDoc DirectAnswer.value} */

diff --git a/src/models/searchservice/response/FieldValueDirectAnswer.ts b/src/models/searchservice/response/FieldValueDirectAnswer.ts
@@ -7,11 +7,11 @@ import { Result } from './Result';
  *
  * @public
  */
-export interface FieldValueDirectAnswer extends DirectAnswer {
+export interface FieldValueDirectAnswer<T = unknown> extends DirectAnswer<T> {
   /** {@link DirectAnswerType}.FieldValue. */
   type: DirectAnswerType.FieldValue,
   /** {@inheritDoc DirectAnswer.value} */
-  value: string,
+  value: T,
   /** {@inheritDoc DirectAnswer.relatedResult} */
   relatedResult: Result,
   /** {@inheritDoc DirectAnswer.verticalKey} */