export, union, and switch

yext · Aug 16, 2022 · 9314368 · 9314368
1 parent 125941b
commit 9314368
Show file tree

Hide file tree

Showing 10 changed files with 30 additions and 24 deletions.
diff --git a/docs/search-core.fieldvaluedirectanswer.md b/docs/search-core.fieldvaluedirectanswer.md
@@ -9,7 +9,7 @@ Possible built-in and custom [BaseFieldValueDirectAnswer](./search-core.basefiel
 <b>Signature:</b>
 
 ```typescript
-export declare type FieldValueDirectAnswer = UnknownFieldValueDirectAnswer | TextDirectAnswer | UrlDirectAnswer | RichTextDirectAnswer | DecimalDirectAnswer | FacebookUrlDirectAnswer | InstagramHandleDirectAnswer | TwitterHandleDirectAnswer | IosAppUrlDirectAnswer | AndroidAppUrlDirectAnswer | ComplexUrlDirectAnswer | IntegerDirectAnswer;
+export declare type FieldValueDirectAnswer = UnknownFieldValueDirectAnswer | TextDirectAnswer | UrlDirectAnswer | RichTextDirectAnswer | DecimalDirectAnswer | FacebookUrlDirectAnswer | InstagramHandleDirectAnswer | TwitterHandleDirectAnswer | IosAppUrlDirectAnswer | AndroidAppUrlDirectAnswer | ComplexUrlDirectAnswer | IntegerDirectAnswer | PhoneDirectAnswer;
 ```
-<b>References:</b> [UnknownFieldValueDirectAnswer](./search-core.unknownfieldvaluedirectanswer.md)<!-- -->, [TextDirectAnswer](./search-core.textdirectanswer.md)<!-- -->, [UrlDirectAnswer](./search-core.urldirectanswer.md)<!-- -->, [RichTextDirectAnswer](./search-core.richtextdirectanswer.md)<!-- -->, [DecimalDirectAnswer](./search-core.decimaldirectanswer.md)<!-- -->, [FacebookUrlDirectAnswer](./search-core.facebookurldirectanswer.md)<!-- -->, [InstagramHandleDirectAnswer](./search-core.instagramhandledirectanswer.md)<!-- -->, [TwitterHandleDirectAnswer](./search-core.twitterhandledirectanswer.md)<!-- -->, [IosAppUrlDirectAnswer](./search-core.iosappurldirectanswer.md)<!-- -->, [AndroidAppUrlDirectAnswer](./search-core.androidappurldirectanswer.md)<!-- -->, [ComplexUrlDirectAnswer](./search-core.complexurldirectanswer.md)<!-- -->, [IntegerDirectAnswer](./search-core.integerdirectanswer.md)
+<b>References:</b> [UnknownFieldValueDirectAnswer](./search-core.unknownfieldvaluedirectanswer.md)<!-- -->, [TextDirectAnswer](./search-core.textdirectanswer.md)<!-- -->, [UrlDirectAnswer](./search-core.urldirectanswer.md)<!-- -->, [RichTextDirectAnswer](./search-core.richtextdirectanswer.md)<!-- -->, [DecimalDirectAnswer](./search-core.decimaldirectanswer.md)<!-- -->, [FacebookUrlDirectAnswer](./search-core.facebookurldirectanswer.md)<!-- -->, [InstagramHandleDirectAnswer](./search-core.instagramhandledirectanswer.md)<!-- -->, [TwitterHandleDirectAnswer](./search-core.twitterhandledirectanswer.md)<!-- -->, [IosAppUrlDirectAnswer](./search-core.iosappurldirectanswer.md)<!-- -->, [AndroidAppUrlDirectAnswer](./search-core.androidappurldirectanswer.md)<!-- -->, [ComplexUrlDirectAnswer](./search-core.complexurldirectanswer.md)<!-- -->, [IntegerDirectAnswer](./search-core.integerdirectanswer.md)<!-- -->, [PhoneDirectAnswer](./search-core.phonedirectanswer.md)
 
diff --git a/docs/search-core.md b/docs/search-core.md
@@ -85,7 +85,7 @@
 |  [MultiLineTextSnippetDirectAnswer](./search-core.multilinetextsnippetdirectanswer.md) | A [BaseFeaturedSnippetDirectAnswer](./search-core.basefeaturedsnippetdirectanswer.md) with 'multi\_line\_text' field type. |
 |  [NearFilterValue](./search-core.nearfiltervalue.md) | A filter value for a filter with a $near [Matcher](./search-core.matcher.md)<!-- -->. |
 |  [NumberRangeValue](./search-core.numberrangevalue.md) | A filter value for a filter with a $between [Matcher](./search-core.matcher.md)<!-- -->. |
-|  [PhoneFieldValueDirectAnswer](./search-core.phonefieldvaluedirectanswer.md) | A [BaseFieldValueDirectAnswer](./search-core.basefieldvaluedirectanswer.md) interface with phone value. |
+|  [PhoneDirectAnswer](./search-core.phonedirectanswer.md) | A [BaseFieldValueDirectAnswer](./search-core.basefieldvaluedirectanswer.md) interface with phone value. |
 |  [QueryRulesActionsData](./search-core.queryrulesactionsdata.md) | Data returned from the Search query rules system. |
 |  [QuestionSubmissionRequest](./search-core.questionsubmissionrequest.md) | Options for a QuestionSubmission request. |
 |  [QuestionSubmissionResponse](./search-core.questionsubmissionresponse.md) | A representation of a question submission response. |

diff --git a/....phonefieldvaluedirectanswer.fieldtype.md → ...earch-core.phonedirectanswer.fieldtype.md b/....phonefieldvaluedirectanswer.fieldtype.md → ...earch-core.phonedirectanswer.fieldtype.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; [PhoneFieldValueDirectAnswer](./search-core.phonefieldvaluedirectanswer.md) &gt; [fieldType](./search-core.phonefieldvaluedirectanswer.fieldtype.md)
+[Home](./index.md) &gt; [@yext/search-core](./search-core.md) &gt; [PhoneDirectAnswer](./search-core.phonedirectanswer.md) &gt; [fieldType](./search-core.phonedirectanswer.fieldtype.md)
 
-## PhoneFieldValueDirectAnswer.fieldType property
+## PhoneDirectAnswer.fieldType property
 
 <b>Signature:</b>
 

diff --git a/...earch-core.phonefieldvaluedirectanswer.md → docs/search-core.phonedirectanswer.md b/...earch-core.phonefieldvaluedirectanswer.md → docs/search-core.phonedirectanswer.md
@@ -1,21 +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; [PhoneFieldValueDirectAnswer](./search-core.phonefieldvaluedirectanswer.md)
+[Home](./index.md) &gt; [@yext/search-core](./search-core.md) &gt; [PhoneDirectAnswer](./search-core.phonedirectanswer.md)
 
-## PhoneFieldValueDirectAnswer interface
+## PhoneDirectAnswer interface
 
 A [BaseFieldValueDirectAnswer](./search-core.basefieldvaluedirectanswer.md) interface with phone value.
 
 <b>Signature:</b>
 
 ```typescript
-export interface PhoneFieldValueDirectAnswer extends BaseFieldValueDirectAnswer<string> 
+export interface PhoneDirectAnswer extends BaseFieldValueDirectAnswer<string> 
 ```
 <b>Extends:</b> [BaseFieldValueDirectAnswer](./search-core.basefieldvaluedirectanswer.md)<!-- -->&lt;string&gt;
 
 ## Properties
 
 |  Property | Type | Description |
 |  --- | --- | --- |
-|  [fieldType](./search-core.phonefieldvaluedirectanswer.fieldtype.md) | [BuiltInFieldType.Phone](./search-core.builtinfieldtype.md) |  |
+|  [fieldType](./search-core.phonedirectanswer.fieldtype.md) | [BuiltInFieldType.Phone](./search-core.builtinfieldtype.md) |  |
 
diff --git a/etc/search-core.api.md b/etc/search-core.api.md
@@ -285,7 +285,7 @@ export interface FailedVertical {
 export type FeaturedSnippetDirectAnswer = MultiLineTextSnippetDirectAnswer | RichTextSnippetDirectAnswer;
 
 // @public
-export type FieldValueDirectAnswer = UnknownFieldValueDirectAnswer | TextDirectAnswer | UrlDirectAnswer | RichTextDirectAnswer | DecimalDirectAnswer | FacebookUrlDirectAnswer | InstagramHandleDirectAnswer | TwitterHandleDirectAnswer | IosAppUrlDirectAnswer | AndroidAppUrlDirectAnswer | ComplexUrlDirectAnswer | IntegerDirectAnswer;
+export type FieldValueDirectAnswer = UnknownFieldValueDirectAnswer | TextDirectAnswer | UrlDirectAnswer | RichTextDirectAnswer | DecimalDirectAnswer | FacebookUrlDirectAnswer | InstagramHandleDirectAnswer | TwitterHandleDirectAnswer | IosAppUrlDirectAnswer | AndroidAppUrlDirectAnswer | ComplexUrlDirectAnswer | IntegerDirectAnswer | PhoneDirectAnswer;
 
 // @public
 export interface FieldValueFilter {
@@ -434,7 +434,7 @@ export interface NumberRangeValue {
 }
 
 // @public
-export interface PhoneFieldValueDirectAnswer extends BaseFieldValueDirectAnswer<string> {
+export interface PhoneDirectAnswer extends BaseFieldValueDirectAnswer<string> {
     // (undocumented)
     fieldType: BuiltInFieldType.Phone;
 }

diff --git a/src/models/searchservice/response/PhoneFieldValueDirectAnswer.ts b/src/models/searchservice/response/PhoneFieldValueDirectAnswer.ts
diff --git a/src/models/searchservice/response/directanswer/FieldValueDirectAnswer.ts b/src/models/searchservice/response/directanswer/FieldValueDirectAnswer.ts
@@ -10,7 +10,8 @@ import {
   UrlDirectAnswer,
   TextDirectAnswer,
   ComplexUrlDirectAnswer,
-  IntegerDirectAnswer
+  IntegerDirectAnswer,
+  PhoneDirectAnswer
 } from './fieldvaluedirectanswers';
 
 /**
@@ -30,4 +31,5 @@ export type FieldValueDirectAnswer =
   IosAppUrlDirectAnswer |
   AndroidAppUrlDirectAnswer |
   ComplexUrlDirectAnswer |
-  IntegerDirectAnswer;
+  IntegerDirectAnswer |
+  PhoneDirectAnswer;
diff --git a/src/models/searchservice/response/directanswer/fieldvaluedirectanswers/PhoneDirectAnswer.ts b/src/models/searchservice/response/directanswer/fieldvaluedirectanswers/PhoneDirectAnswer.ts
@@ -0,0 +1,11 @@
+import { BuiltInFieldType } from '../BuiltInFieldType';
+import { BaseFieldValueDirectAnswer } from '../BaseFieldValueDirectAnswer';
+
+/**
+ * A {@link BaseFieldValueDirectAnswer} interface with phone value.
+ *
+ * @public
+ */
+export interface PhoneDirectAnswer extends BaseFieldValueDirectAnswer<string> {
+  fieldType: BuiltInFieldType.Phone
+}
diff --git a/src/models/searchservice/response/directanswer/fieldvaluedirectanswers/index.ts b/src/models/searchservice/response/directanswer/fieldvaluedirectanswers/index.ts
@@ -10,3 +10,4 @@ export { UrlDirectAnswer } from './UrlDirectAnswer';
 export { TextDirectAnswer } from './TextDirectAnswer';
 export { ComplexUrlDirectAnswer, ComplexURL } from './ComplexUrlDirectAnswer';
 export { IntegerDirectAnswer } from './IntegerDirectAnswer';
+export { PhoneDirectAnswer } from './PhoneDirectAnswer';
diff --git a/test-site/src/ts/initDirectAnswers.ts b/test-site/src/ts/initDirectAnswers.ts
@@ -124,6 +124,9 @@ function ensureFieldValueSwitchability(da: FieldValueDirectAnswer) {
     case BuiltInFieldType.Integer:
       console.log(da.value);
       break;
+    case BuiltInFieldType.Phone:
+      console.log(da.value);
+      break;
   }
 }