build

yext · Aug 16, 2022 · e67beea · e67beea
1 parent 4a08672
commit e67beea
Show file tree

Hide file tree

Showing 15 changed files with 106 additions and 175 deletions.
diff --git a/docs/search-core.address.city.md b/docs/search-core.address.city.md
diff --git a/docs/search-core.address.countrycode.md b/docs/search-core.address.countrycode.md
diff --git a/docs/search-core.address.extradescription.md b/docs/search-core.address.extradescription.md
diff --git a/docs/search-core.address.line1.md b/docs/search-core.address.line1.md
diff --git a/docs/search-core.address.line2.md b/docs/search-core.address.line2.md
diff --git a/docs/search-core.address.line3.md b/docs/search-core.address.line3.md
diff --git a/docs/search-core.address.md b/docs/search-core.address.md
diff --git a/docs/search-core.address.postalcode.md b/docs/search-core.address.postalcode.md
diff --git a/docs/search-core.address.region.md b/docs/search-core.address.region.md
diff --git a/docs/search-core.address.sublocality.md b/docs/search-core.address.sublocality.md
diff --git a/docs/search-core.addressfieldvaluedirectanswer.fieldtype.md b/docs/search-core.addressfieldvaluedirectanswer.fieldtype.md
diff --git a/docs/search-core.addressfieldvaluedirectanswer.md b/docs/search-core.addressfieldvaluedirectanswer.md
diff --git a/docs/search-core.builtinfieldtype.md b/docs/search-core.builtinfieldtype.md
@@ -17,5 +17,15 @@ export declare enum BuiltInFieldType
 |  Member | Value | Description |
 |  --- | --- | --- |
 |  Address | <code>&quot;address&quot;</code> |  |
-|  Email | <code>&quot;email&quot;</code> |  |
+|  AndroidAppURL | <code>&quot;android_app_url&quot;</code> |  |
+|  Decimal | <code>&quot;decimal&quot;</code> |  |
+|  FacebookURL | <code>&quot;facebook_url&quot;</code> |  |
+|  InstagramHandle | <code>&quot;instagram_handle&quot;</code> |  |
+|  IOSAppURL | <code>&quot;ios_app_url&quot;</code> |  |
+|  MultiLineText | <code>&quot;multi_line_text&quot;</code> |  |
+|  Phone | <code>&quot;phone&quot;</code> |  |
+|  RichText | <code>&quot;rich_text&quot;</code> |  |
+|  SingleLineText | <code>&quot;single_line_text&quot;</code> |  |
+|  TwitterHandle | <code>&quot;twitter_handle&quot;</code> |  |
+|  URL | <code>&quot;url&quot;</code> |  |
 
diff --git a/docs/search-core.md b/docs/search-core.md
@@ -42,8 +42,6 @@
 |  Interface | Description |
 |  --- | --- |
 |  [AdditionalHttpHeaders](./search-core.additionalhttpheaders.md) | AdditionalHttpHeaders allows users to specify additional values for specific HTTP headers. |
-|  [Address](./search-core.address.md) | An interface with address fields to use in [BaseFieldValueDirectAnswer.value](./search-core.basefieldvaluedirectanswer.value.md)<!-- -->. |
-|  [AddressFieldValueDirectAnswer](./search-core.addressfieldvaluedirectanswer.md) | A [BaseFieldValueDirectAnswer](./search-core.basefieldvaluedirectanswer.md) interface with 'address' field type. |
 |  [AndroidAppUrlDirectAnswer](./search-core.androidappurldirectanswer.md) | A direct answer for an android app url field. |
 |  [AnswersConfigWithApiKey](./search-core.answersconfigwithapikey.md) |  |
 |  [AnswersConfigWithToken](./search-core.answersconfigwithtoken.md) |  |

diff --git a/etc/search-core.api.md b/etc/search-core.api.md
@@ -9,6 +9,12 @@ export interface AdditionalHttpHeaders {
     'Client-SDK'?: ClientSDKHeaderValues;
 }
 
+// @public
+export interface AndroidAppUrlDirectAnswer extends BaseFieldValueDirectAnswer<string> {
+    // (undocumented)
+    fieldType: EnumOrLiteral<BuiltInFieldType.AndroidAppURL>;
+}
+
 // @public @deprecated (undocumented)
 export type AnswersConfig = SearchConfig;
 
@@ -80,6 +86,13 @@ export interface AutocompleteService {
 export interface BaseAnswersConfig extends BaseSearchConfig {
 }
 
+// @public
+export interface BaseFeaturedSnippetDirectAnswer<T = unknown> extends DirectAnswer<T> {
+    fieldType: EnumOrLiteral<BuiltInFieldType.MultiLineText | BuiltInFieldType.RichText>;
+    snippet: Snippet;
+    type: DirectAnswerType.FeaturedSnippet;
+}
+
 // @public
 export interface BaseFieldValueDirectAnswer<T = unknown> extends DirectAnswer<T> {
     entityName: string;
@@ -107,7 +120,27 @@ export enum BuiltInFieldType {
     // (undocumented)
     Address = "address",
     // (undocumented)
-    Email = "email"
+    AndroidAppURL = "android_app_url",
+    // (undocumented)
+    Decimal = "decimal",
+    // (undocumented)
+    FacebookURL = "facebook_url",
+    // (undocumented)
+    InstagramHandle = "instagram_handle",
+    // (undocumented)
+    IOSAppURL = "ios_app_url",
+    // (undocumented)
+    MultiLineText = "multi_line_text",
+    // (undocumented)
+    Phone = "phone",
+    // (undocumented)
+    RichText = "rich_text",
+    // (undocumented)
+    SingleLineText = "single_line_text",
+    // (undocumented)
+    TwitterHandle = "twitter_handle",
+    // (undocumented)
+    URL = "url"
 }
 
 // @public
@@ -126,6 +159,12 @@ export interface ConjunctionStaticFilter {
 // @public
 export type Context = any;
 
+// @public
+export interface DecimalDirectAnswer extends BaseFieldValueDirectAnswer<string | string[]> {
+    // (undocumented)
+    fieldType: EnumOrLiteral<BuiltInFieldType.Decimal>;
+}
+
 // @public
 export interface DirectAnswer<T = unknown> {
     fieldType: EnumOrLiteral<BuiltInFieldType> | 'unknown';
@@ -167,12 +206,6 @@ export interface DisplayableFacetOption extends FacetOption {
     selected: boolean;
 }
 
-// @public
-export interface EmailDirectAnswer extends FieldValueDirectAnswer<string[]> {
-    // (undocumented)
-    fieldType: BuiltInFieldType.Email;
-}
-
 // @public
 export interface Endpoints {
     // (undocumented)
@@ -202,6 +235,12 @@ export enum ErrorType {
     Timeout = "TIMEOUT"
 }
 
+// @public
+export interface FacebookUrlDirectAnswer extends BaseFieldValueDirectAnswer<string> {
+    // (undocumented)
+    fieldType: EnumOrLiteral<BuiltInFieldType.FacebookURL>;
+}
+
 // @public
 export interface Facet {
     fieldId: string;
@@ -225,14 +264,10 @@ export interface FailedVertical {
 }
 
 // @public
-export interface FeaturedSnippetDirectAnswer<T = unknown> extends DirectAnswer<T> {
-    fieldType: BuiltInFieldType.MultiLineText | BuiltInFieldType.RichText;
-    snippet: Snippet;
-    type: DirectAnswerType.FeaturedSnippet;
-}
+export type FeaturedSnippetDirectAnswer = MultiLineTextFeaturedSnippetDirectAnswer | RichTextFeaturedSnippetDirectAnswer;
 
 // @public
-export type FieldValueDirectAnswer = UnknownFieldValueDirectAnswer;
+export type FieldValueDirectAnswer = UnknownFieldValueDirectAnswer | TextDirectAnswer | UrlDirectAnswer | RichTextDirectAnswer | DecimalDirectAnswer | FacebookUrlDirectAnswer | InstagramHandleDirectAnswer | TwitterHandleDirectAnswer | IosAppUrlDirectAnswer | AndroidAppUrlDirectAnswer;
 
 // @public
 export interface FieldValueFilter {
@@ -287,6 +322,18 @@ export interface HighlightedValue {
     value: string;
 }
 
+// @public
+export interface InstagramHandleDirectAnswer extends BaseFieldValueDirectAnswer<string> {
+    // (undocumented)
+    fieldType: EnumOrLiteral<BuiltInFieldType.InstagramHandle>;
+}
+
+// @public
+export interface IosAppUrlDirectAnswer extends BaseFieldValueDirectAnswer<string> {
+    // (undocumented)
+    fieldType: EnumOrLiteral<BuiltInFieldType.IOSAppURL>;
+}
+
 // @public
 export interface LatLong {
     latitude: number;
@@ -343,6 +390,12 @@ export enum Matcher {
     NotEquals = "!$eq"
 }
 
+// @public
+export interface MultiLineTextFeaturedSnippetDirectAnswer extends BaseFeaturedSnippetDirectAnswer<string> {
+    fieldType: EnumOrLiteral<BuiltInFieldType.MultiLineText>;
+    value: string;
+}
+
 // @public
 export interface NearFilterValue {
     lat: number;
@@ -418,6 +471,17 @@ export interface Result<T = Record<string, unknown>> {
     source: Source;
 }
 
+// @public
+export interface RichTextDirectAnswer extends BaseFieldValueDirectAnswer<string | string[]> {
+    // (undocumented)
+    fieldType: EnumOrLiteral<BuiltInFieldType.RichText>;
+}
+
+// @public
+export interface RichTextFeaturedSnippetDirectAnswer extends Omit<BaseFeaturedSnippetDirectAnswer<string>, 'value'> {
+    fieldType: EnumOrLiteral<BuiltInFieldType.RichText>;
+}
+
 // @public
 export const SandboxEndpoints: Required<Endpoints>;
 
@@ -533,6 +597,18 @@ export enum SpellCheckType {
 // @public
 export type StaticFilter = FieldValueStaticFilter | DisjunctionStaticFilter | ConjunctionStaticFilter;
 
+// @public
+export interface TextDirectAnswer extends BaseFieldValueDirectAnswer<string | string[]> {
+    // (undocumented)
+    fieldType: EnumOrLiteral<BuiltInFieldType.SingleLineText | BuiltInFieldType.MultiLineText>;
+}
+
+// @public
+export interface TwitterHandleDirectAnswer extends BaseFieldValueDirectAnswer<string> {
+    // (undocumented)
+    fieldType: EnumOrLiteral<BuiltInFieldType.TwitterHandle>;
+}
+
 // @public
 export interface UniversalAutocompleteRequest extends SearchRequest {
     input: string;
@@ -584,6 +660,12 @@ export interface UpperNumberRangeLimit {
     value: number;
 }
 
+// @public
+export interface UrlDirectAnswer extends BaseFieldValueDirectAnswer<string | string[]> {
+    // (undocumented)
+    fieldType: EnumOrLiteral<BuiltInFieldType.URL>;
+}
+
 // @public
 export interface VerticalAutocompleteRequest extends SearchRequest {
     input: string;