Automated update to repo's documentation from github action

yext · Jun 14, 2023 · 5de49aa · 5de49aa
1 parent fee65a6
commit 5de49aa
Show file tree

Hide file tree

Showing 15 changed files with 138 additions and 9 deletions.
diff --git a/docs/search-core.basefeaturedsnippetdirectanswer.fieldtype.md b/docs/search-core.basefeaturedsnippetdirectanswer.fieldtype.md
@@ -9,5 +9,5 @@ The field type of the direct answer.
 <b>Signature:</b>
 
 ```typescript
-fieldType: EnumOrLiteral<BuiltInFieldType.MultiLineText | BuiltInFieldType.RichText>;
+fieldType: EnumOrLiteral<BuiltInFieldType.MultiLineText | BuiltInFieldType.RichText | BuiltInFieldType.RichText_v2 | BuiltInFieldType.Html | BuiltInFieldType.Markdown>;
 ```
diff --git a/docs/search-core.basefeaturedsnippetdirectanswer.md b/docs/search-core.basefeaturedsnippetdirectanswer.md
@@ -17,7 +17,7 @@ export interface BaseFeaturedSnippetDirectAnswer<T = unknown> extends DirectAnsw
 
 |  Property | Type | Description |
 |  --- | --- | --- |
-|  [fieldType](./search-core.basefeaturedsnippetdirectanswer.fieldtype.md) | [EnumOrLiteral](./search-core.enumorliteral.md)<!-- -->&lt;[BuiltInFieldType.MultiLineText](./search-core.builtinfieldtype.md) \| [BuiltInFieldType.RichText](./search-core.builtinfieldtype.md)<!-- -->&gt; | The field type of the direct answer. |
+|  [fieldType](./search-core.basefeaturedsnippetdirectanswer.fieldtype.md) | [EnumOrLiteral](./search-core.enumorliteral.md)<!-- -->&lt;[BuiltInFieldType.MultiLineText](./search-core.builtinfieldtype.md) \| [BuiltInFieldType.RichText](./search-core.builtinfieldtype.md) \| [BuiltInFieldType.RichText\_v2](./search-core.builtinfieldtype.md) \| [BuiltInFieldType.Html](./search-core.builtinfieldtype.md) \| [BuiltInFieldType.Markdown](./search-core.builtinfieldtype.md)<!-- -->&gt; | The field type of the direct answer. |
 |  [snippet](./search-core.basefeaturedsnippetdirectanswer.snippet.md) | [Snippet](./search-core.snippet.md) | The snippet where the direct answer was found. |
 |  [type](./search-core.basefeaturedsnippetdirectanswer.type.md) | [DirectAnswerType.FeaturedSnippet](./search-core.directanswertype.md) | Indicates that the DirectAnswer is a [FeaturedSnippetDirectAnswer](./search-core.featuredsnippetdirectanswer.md)<!-- -->. |
 
diff --git a/docs/search-core.builtinfieldtype.md b/docs/search-core.builtinfieldtype.md
@@ -23,12 +23,15 @@ export declare enum BuiltInFieldType
 |  Email | <code>&quot;email&quot;</code> |  |
 |  FacebookURL | <code>&quot;facebook_url&quot;</code> |  |
 |  Hours | <code>&quot;hours&quot;</code> |  |
+|  Html | <code>&quot;html&quot;</code> |  |
 |  InstagramHandle | <code>&quot;instagram_handle&quot;</code> |  |
 |  Integer | <code>&quot;integer&quot;</code> |  |
 |  IOSAppURL | <code>&quot;ios_app_url&quot;</code> |  |
+|  Markdown | <code>&quot;markdown&quot;</code> |  |
 |  MultiLineText | <code>&quot;multi_line_text&quot;</code> |  |
 |  Phone | <code>&quot;phone&quot;</code> |  |
 |  RichText | <code>&quot;rich_text&quot;</code> |  |
+|  RichText\_v2 | <code>&quot;rich_text_v2&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.directanswer.value.md b/docs/search-core.directanswer.value.md
@@ -14,5 +14,5 @@ value?: T;
 
 ## Remarks
 
-A value will not be present if the [DirectAnswer.type](./search-core.directanswer.type.md) is 'FEATURED\_SNIPPET' and [DirectAnswer.fieldType](./search-core.directanswer.fieldtype.md) is 'rich\_text'.
+A value will not be present if the [DirectAnswer.type](./search-core.directanswer.type.md) is 'FEATURED\_SNIPPET' and [DirectAnswer.fieldType](./search-core.directanswer.fieldtype.md) is 'rich\_text', 'markdown', 'html' or 'rich\_text\_v2'.
 
diff --git a/docs/search-core.featuredsnippetdirectanswer.md b/docs/search-core.featuredsnippetdirectanswer.md
@@ -9,7 +9,7 @@ All possible built-in [BaseFeaturedSnippetDirectAnswer](./search-core.basefeatur
 <b>Signature:</b>
 
 ```typescript
-export declare type FeaturedSnippetDirectAnswer = MultiLineTextSnippetDirectAnswer | RichTextSnippetDirectAnswer;
+export declare type FeaturedSnippetDirectAnswer = MultiLineTextSnippetDirectAnswer | RichTextSnippetDirectAnswer | RichTextV2SnippetDirectAnswer | HTMLSnippetDirectAnswer | MarkdownSnippetDirectAnswer;
 ```
-<b>References:</b> [MultiLineTextSnippetDirectAnswer](./search-core.multilinetextsnippetdirectanswer.md)<!-- -->, [RichTextSnippetDirectAnswer](./search-core.richtextsnippetdirectanswer.md)
+<b>References:</b> [MultiLineTextSnippetDirectAnswer](./search-core.multilinetextsnippetdirectanswer.md)<!-- -->, [RichTextSnippetDirectAnswer](./search-core.richtextsnippetdirectanswer.md)<!-- -->, [RichTextV2SnippetDirectAnswer](./search-core.richtextv2snippetdirectanswer.md)<!-- -->, [HTMLSnippetDirectAnswer](./search-core.htmlsnippetdirectanswer.md)<!-- -->, [MarkdownSnippetDirectAnswer](./search-core.markdownsnippetdirectanswer.md)
 
diff --git a/docs/search-core.htmlsnippetdirectanswer.fieldtype.md b/docs/search-core.htmlsnippetdirectanswer.fieldtype.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; [HTMLSnippetDirectAnswer](./search-core.htmlsnippetdirectanswer.md) &gt; [fieldType](./search-core.htmlsnippetdirectanswer.fieldtype.md)
+
+## HTMLSnippetDirectAnswer.fieldType property
+
+The field type of the direct answer.
+
+<b>Signature:</b>
+
+```typescript
+fieldType: EnumOrLiteral<BuiltInFieldType.Html>;
+```
diff --git a/docs/search-core.htmlsnippetdirectanswer.md b/docs/search-core.htmlsnippetdirectanswer.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; [HTMLSnippetDirectAnswer](./search-core.htmlsnippetdirectanswer.md)
+
+## HTMLSnippetDirectAnswer interface
+
+A [BaseFeaturedSnippetDirectAnswer](./search-core.basefeaturedsnippetdirectanswer.md) with 'html' field type. "value" field is omitted for featured snippet direct answer of this field type.
+
+<b>Signature:</b>
+
+```typescript
+export interface HTMLSnippetDirectAnswer extends Omit<BaseFeaturedSnippetDirectAnswer<string>, 'value'> 
+```
+<b>Extends:</b> Omit&lt;[BaseFeaturedSnippetDirectAnswer](./search-core.basefeaturedsnippetdirectanswer.md)<!-- -->&lt;string&gt;, 'value'&gt;
+
+## Properties
+
+|  Property | Type | Description |
+|  --- | --- | --- |
+|  [fieldType](./search-core.htmlsnippetdirectanswer.fieldtype.md) | [EnumOrLiteral](./search-core.enumorliteral.md)<!-- -->&lt;[BuiltInFieldType.Html](./search-core.builtinfieldtype.md)<!-- -->&gt; | The field type of the direct answer. |
+
diff --git a/docs/search-core.markdownsnippetdirectanswer.fieldtype.md b/docs/search-core.markdownsnippetdirectanswer.fieldtype.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; [MarkdownSnippetDirectAnswer](./search-core.markdownsnippetdirectanswer.md) &gt; [fieldType](./search-core.markdownsnippetdirectanswer.fieldtype.md)
+
+## MarkdownSnippetDirectAnswer.fieldType property
+
+The field type of the direct answer.
+
+<b>Signature:</b>
+
+```typescript
+fieldType: EnumOrLiteral<BuiltInFieldType.Markdown>;
+```
diff --git a/docs/search-core.markdownsnippetdirectanswer.md b/docs/search-core.markdownsnippetdirectanswer.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; [MarkdownSnippetDirectAnswer](./search-core.markdownsnippetdirectanswer.md)
+
+## MarkdownSnippetDirectAnswer interface
+
+A [BaseFeaturedSnippetDirectAnswer](./search-core.basefeaturedsnippetdirectanswer.md) with 'markdown' field type. "value" field is omitted for featured snippet direct answer of this field type.
+
+<b>Signature:</b>
+
+```typescript
+export interface MarkdownSnippetDirectAnswer extends Omit<BaseFeaturedSnippetDirectAnswer<string>, 'value'> 
+```
+<b>Extends:</b> Omit&lt;[BaseFeaturedSnippetDirectAnswer](./search-core.basefeaturedsnippetdirectanswer.md)<!-- -->&lt;string&gt;, 'value'&gt;
+
+## Properties
+
+|  Property | Type | Description |
+|  --- | --- | --- |
+|  [fieldType](./search-core.markdownsnippetdirectanswer.fieldtype.md) | [EnumOrLiteral](./search-core.enumorliteral.md)<!-- -->&lt;[BuiltInFieldType.Markdown](./search-core.builtinfieldtype.md)<!-- -->&gt; | The field type of the direct answer. |
+
diff --git a/docs/search-core.md b/docs/search-core.md
@@ -77,6 +77,7 @@
 |  [HolidayHours](./search-core.holidayhours.md) | An interface for holiday hours to use in [BaseFieldValueDirectAnswer.value](./search-core.basefieldvaluedirectanswer.value.md)<!-- -->. |
 |  [Hours](./search-core.hours.md) | An interface for hours fields to use in [BaseFieldValueDirectAnswer.value](./search-core.basefieldvaluedirectanswer.value.md)<!-- -->. |
 |  [HoursDirectAnswer](./search-core.hoursdirectanswer.md) | A [BaseFieldValueDirectAnswer](./search-core.basefieldvaluedirectanswer.md) interface with 'hours' field type. |
+|  [HTMLSnippetDirectAnswer](./search-core.htmlsnippetdirectanswer.md) | A [BaseFeaturedSnippetDirectAnswer](./search-core.basefeaturedsnippetdirectanswer.md) with 'html' field type. "value" field is omitted for featured snippet direct answer of this field type. |
 |  [InstagramHandleDirectAnswer](./search-core.instagramhandledirectanswer.md) | A direct answer for an instagram handle field. |
 |  [IntegerDirectAnswer](./search-core.integerdirectanswer.md) | A direct answer for an integer field. |
 |  [Interval](./search-core.interval.md) | An interface for a time interval to use in [BaseFieldValueDirectAnswer.value](./search-core.basefieldvaluedirectanswer.value.md)<!-- -->. |
@@ -86,6 +87,7 @@
 |  [LocationBoundingBox](./search-core.locationboundingbox.md) | Location boundaries for a filter with "Place" for its [AppliedQueryFilterType](./search-core.appliedqueryfiltertype.md)<!-- -->. (e.g. boundary for a locality or region specific location filter) |
 |  [LocationFilterDetails](./search-core.locationfilterdetails.md) | Additional details relevant to the filter with "PLACE" for its [AppliedQueryFilterType](./search-core.appliedqueryfiltertype.md)<!-- -->. |
 |  [LowerNumberRangeLimit](./search-core.lowernumberrangelimit.md) | The start limit of [NumberRangeValue](./search-core.numberrangevalue.md)<!-- -->. |
+|  [MarkdownSnippetDirectAnswer](./search-core.markdownsnippetdirectanswer.md) | A [BaseFeaturedSnippetDirectAnswer](./search-core.basefeaturedsnippetdirectanswer.md) with 'markdown' field type. "value" field is omitted for featured snippet direct answer of this field type. |
 |  [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)<!-- -->. |
@@ -97,6 +99,7 @@
 |  [Result](./search-core.result.md) | An individual search result. |
 |  [RichTextDirectAnswer](./search-core.richtextdirectanswer.md) | A direct answer for a rich text field. |
 |  [RichTextSnippetDirectAnswer](./search-core.richtextsnippetdirectanswer.md) | A [BaseFeaturedSnippetDirectAnswer](./search-core.basefeaturedsnippetdirectanswer.md) with 'rich\_text' field type. "value" field is omitted for featured snippet direct answer of this field type. |
+|  [RichTextV2SnippetDirectAnswer](./search-core.richtextv2snippetdirectanswer.md) | A [BaseFeaturedSnippetDirectAnswer](./search-core.basefeaturedsnippetdirectanswer.md) with 'rich\_text\_v2' field type. "value" field is omitted for featured snippet direct answer of this field type. |
 |  [SearchConfigWithApiKey](./search-core.searchconfigwithapikey.md) | Configuration options for [SearchCore](./search-core.searchcore.md)<!-- -->, which includes the options from [BaseSearchConfig](./search-core.basesearchconfig.md)<!-- -->, but requires apiKey. |
 |  [SearchConfigWithToken](./search-core.searchconfigwithtoken.md) | Configuration options for [SearchCore](./search-core.searchcore.md)<!-- -->, which includes the options from [BaseSearchConfig](./search-core.basesearchconfig.md)<!-- -->, but requires token. |
 |  [SearchParameterField](./search-core.searchparameterfield.md) | Indicates which entity field to perform the autocomplete request on. |

diff --git a/docs/search-core.richtextv2snippetdirectanswer.fieldtype.md b/docs/search-core.richtextv2snippetdirectanswer.fieldtype.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; [RichTextV2SnippetDirectAnswer](./search-core.richtextv2snippetdirectanswer.md) &gt; [fieldType](./search-core.richtextv2snippetdirectanswer.fieldtype.md)
+
+## RichTextV2SnippetDirectAnswer.fieldType property
+
+The field type of the direct answer.
+
+<b>Signature:</b>
+
+```typescript
+fieldType: EnumOrLiteral<BuiltInFieldType.RichText_v2>;
+```
diff --git a/docs/search-core.richtextv2snippetdirectanswer.md b/docs/search-core.richtextv2snippetdirectanswer.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; [RichTextV2SnippetDirectAnswer](./search-core.richtextv2snippetdirectanswer.md)
+
+## RichTextV2SnippetDirectAnswer interface
+
+A [BaseFeaturedSnippetDirectAnswer](./search-core.basefeaturedsnippetdirectanswer.md) with 'rich\_text\_v2' field type. "value" field is omitted for featured snippet direct answer of this field type.
+
+<b>Signature:</b>
+
+```typescript
+export interface RichTextV2SnippetDirectAnswer extends Omit<BaseFeaturedSnippetDirectAnswer<string>, 'value'> 
+```
+<b>Extends:</b> Omit&lt;[BaseFeaturedSnippetDirectAnswer](./search-core.basefeaturedsnippetdirectanswer.md)<!-- -->&lt;string&gt;, 'value'&gt;
+
+## Properties
+
+|  Property | Type | Description |
+|  --- | --- | --- |
+|  [fieldType](./search-core.richtextv2snippetdirectanswer.fieldtype.md) | [EnumOrLiteral](./search-core.enumorliteral.md)<!-- -->&lt;[BuiltInFieldType.RichText\_v2](./search-core.builtinfieldtype.md)<!-- -->&gt; | The field type of the direct answer. |
+
diff --git a/docs/search-core.snippet.md b/docs/search-core.snippet.md
@@ -17,5 +17,5 @@ export interface Snippet
 |  Property | Type | Description |
 |  --- | --- | --- |
 |  [matchedSubstrings](./search-core.snippet.matchedsubstrings.md) | { offset: number; length: number; }\[\] | The locations in the document text of the [DirectAnswer.value](./search-core.directanswer.value.md) |
-|  [value](./search-core.snippet.value.md) | string | The snippet's body of text |
+|  [value](./search-core.snippet.value.md) | string | The raw snippet value, or HTML if - entity is of type HTML - the conversion to HTML is enabled in search configuration |
 
diff --git a/docs/search-core.snippet.value.md b/docs/search-core.snippet.value.md
@@ -4,7 +4,7 @@
 
 ## Snippet.value property
 
-The snippet's body of text
+The raw snippet value, or HTML if - entity is of type HTML - the conversion to HTML is enabled in search configuration
 
 <b>Signature:</b>
 

diff --git a/etc/search-core.api.md b/etc/search-core.api.md
@@ -90,7 +90,7 @@ export interface AutocompleteService {
 
 // @public
 export interface BaseFeaturedSnippetDirectAnswer<T = unknown> extends DirectAnswer<T> {
-    fieldType: EnumOrLiteral<BuiltInFieldType.MultiLineText | BuiltInFieldType.RichText>;
+    fieldType: EnumOrLiteral<BuiltInFieldType.MultiLineText | BuiltInFieldType.RichText | BuiltInFieldType.RichText_v2 | BuiltInFieldType.Html | BuiltInFieldType.Markdown>;
     snippet: Snippet;
     type: DirectAnswerType.FeaturedSnippet;
 }
@@ -135,18 +135,24 @@ export enum BuiltInFieldType {
     // (undocumented)
     Hours = "hours",
     // (undocumented)
+    Html = "html",
+    // (undocumented)
     InstagramHandle = "instagram_handle",
     // (undocumented)
     Integer = "integer",
     // (undocumented)
     IOSAppURL = "ios_app_url",
     // (undocumented)
+    Markdown = "markdown",
+    // (undocumented)
     MultiLineText = "multi_line_text",
     // (undocumented)
     Phone = "phone",
     // (undocumented)
     RichText = "rich_text",
     // (undocumented)
+    RichText_v2 = "rich_text_v2",
+    // (undocumented)
     SingleLineText = "single_line_text",
     // (undocumented)
     TwitterHandle = "twitter_handle",
@@ -321,7 +327,7 @@ export interface FailedVertical {
 }
 
 // @public
-export type FeaturedSnippetDirectAnswer = MultiLineTextSnippetDirectAnswer | RichTextSnippetDirectAnswer;
+export type FeaturedSnippetDirectAnswer = MultiLineTextSnippetDirectAnswer | RichTextSnippetDirectAnswer | RichTextV2SnippetDirectAnswer | HTMLSnippetDirectAnswer | MarkdownSnippetDirectAnswer;
 
 // @public
 export type FieldValueDirectAnswer = UnknownFieldValueDirectAnswer | TextDirectAnswer | UrlDirectAnswer | RichTextDirectAnswer | DecimalDirectAnswer | FacebookUrlDirectAnswer | InstagramHandleDirectAnswer | TwitterHandleDirectAnswer | IosAppUrlDirectAnswer | AndroidAppUrlDirectAnswer | ComplexUrlDirectAnswer | IntegerDirectAnswer | PhoneDirectAnswer | EmailDirectAnswer | AddressDirectAnswer | HoursDirectAnswer;
@@ -419,6 +425,11 @@ export interface HoursDirectAnswer extends BaseFieldValueDirectAnswer<Hours | Ho
     fieldType: EnumOrLiteral<BuiltInFieldType.Hours>;
 }
 
+// @public
+export interface HTMLSnippetDirectAnswer extends Omit<BaseFeaturedSnippetDirectAnswer<string>, 'value'> {
+    fieldType: EnumOrLiteral<BuiltInFieldType.Html>;
+}
+
 // @public
 export interface InstagramHandleDirectAnswer extends BaseFieldValueDirectAnswer<string> {
     // (undocumented)
@@ -489,6 +500,11 @@ export interface LowerNumberRangeLimit {
     value: number;
 }
 
+// @public
+export interface MarkdownSnippetDirectAnswer extends Omit<BaseFeaturedSnippetDirectAnswer<string>, 'value'> {
+    fieldType: EnumOrLiteral<BuiltInFieldType.Markdown>;
+}
+
 // @public
 export enum Matcher {
     Between = "$between",
@@ -599,6 +615,11 @@ export interface RichTextSnippetDirectAnswer extends Omit<BaseFeaturedSnippetDir
     fieldType: EnumOrLiteral<BuiltInFieldType.RichText>;
 }
 
+// @public
+export interface RichTextV2SnippetDirectAnswer extends Omit<BaseFeaturedSnippetDirectAnswer<string>, 'value'> {
+    fieldType: EnumOrLiteral<BuiltInFieldType.RichText_v2>;
+}
+
 // @public @deprecated
 export const SandboxEndpoints: Required<Endpoints>;