Skip to content

Commit

Permalink
Merge 857ecb6 into f4066f2
Browse files Browse the repository at this point in the history
  • Loading branch information
oshi97 committed Aug 16, 2022
2 parents f4066f2 + 857ecb6 commit 6597b2c
Show file tree
Hide file tree
Showing 14 changed files with 57 additions and 57 deletions.
4 changes: 2 additions & 2 deletions docs/search-core.featuredsnippetdirectanswer.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ All possible built-in [BaseFeaturedSnippetDirectAnswer](./search-core.basefeatur
<b>Signature:</b>

```typescript
export declare type FeaturedSnippetDirectAnswer = MultiLineTextFeaturedSnippetDirectAnswer | RichTextFeaturedSnippetDirectAnswer;
export declare type FeaturedSnippetDirectAnswer = MultiLineTextSnippetDirectAnswer | RichTextSnippetDirectAnswer;
```
<b>References:</b> [MultiLineTextFeaturedSnippetDirectAnswer](./search-core.multilinetextfeaturedsnippetdirectanswer.md)<!-- -->, [RichTextFeaturedSnippetDirectAnswer](./search-core.richtextfeaturedsnippetdirectanswer.md)
<b>References:</b> [MultiLineTextSnippetDirectAnswer](./search-core.multilinetextsnippetdirectanswer.md)<!-- -->, [RichTextSnippetDirectAnswer](./search-core.richtextsnippetdirectanswer.md)

4 changes: 2 additions & 2 deletions docs/search-core.md
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,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)<!-- -->. |
| [MultiLineTextFeaturedSnippetDirectAnswer](./search-core.multilinetextfeaturedsnippetdirectanswer.md) | A [BaseFeaturedSnippetDirectAnswer](./search-core.basefeaturedsnippetdirectanswer.md) with 'multi\_line\_text' 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)<!-- -->. |
| [QueryRulesActionsData](./search-core.queryrulesactionsdata.md) | Data returned from the Search query rules system. |
Expand All @@ -88,7 +88,7 @@
| [QuestionSubmissionService](./search-core.questionsubmissionservice.md) | Submits a custom question to the Search API. |
| [Result](./search-core.result.md) | An individual search result. |
| [RichTextDirectAnswer](./search-core.richtextdirectanswer.md) | A direct answer for a rich text field. |
| [RichTextFeaturedSnippetDirectAnswer](./search-core.richtextfeaturedsnippetdirectanswer.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. |
| [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. |
| [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. |
Expand Down
22 changes: 0 additions & 22 deletions docs/search-core.multilinetextfeaturedsnippetdirectanswer.md

This file was deleted.

13 changes: 0 additions & 13 deletions docs/search-core.multilinetextfeaturedsnippetdirectanswer.value.md

This file was deleted.

Original file line number Diff line number Diff line change
@@ -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; [MultiLineTextFeaturedSnippetDirectAnswer](./search-core.multilinetextfeaturedsnippetdirectanswer.md) &gt; [fieldType](./search-core.multilinetextfeaturedsnippetdirectanswer.fieldtype.md)
[Home](./index.md) &gt; [@yext/search-core](./search-core.md) &gt; [MultiLineTextSnippetDirectAnswer](./search-core.multilinetextsnippetdirectanswer.md) &gt; [fieldType](./search-core.multilinetextsnippetdirectanswer.fieldtype.md)

## MultiLineTextFeaturedSnippetDirectAnswer.fieldType property
## MultiLineTextSnippetDirectAnswer.fieldType property

The field type of the direct answer.

Expand Down
22 changes: 22 additions & 0 deletions docs/search-core.multilinetextsnippetdirectanswer.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@yext/search-core](./search-core.md) &gt; [MultiLineTextSnippetDirectAnswer](./search-core.multilinetextsnippetdirectanswer.md)

## MultiLineTextSnippetDirectAnswer interface

A [BaseFeaturedSnippetDirectAnswer](./search-core.basefeaturedsnippetdirectanswer.md) with 'multi\_line\_text' field type.

<b>Signature:</b>

```typescript
export interface MultiLineTextSnippetDirectAnswer extends BaseFeaturedSnippetDirectAnswer<string>
```
<b>Extends:</b> [BaseFeaturedSnippetDirectAnswer](./search-core.basefeaturedsnippetdirectanswer.md)<!-- -->&lt;string&gt;
## Properties
| Property | Type | Description |
| --- | --- | --- |
| [fieldType](./search-core.multilinetextsnippetdirectanswer.fieldtype.md) | [EnumOrLiteral](./search-core.enumorliteral.md)<!-- -->&lt;[BuiltInFieldType.MultiLineText](./search-core.builtinfieldtype.md)<!-- -->&gt; | The field type of the direct answer. |
| [value](./search-core.multilinetextsnippetdirectanswer.value.md) | string | The value of the direct answer. |
13 changes: 13 additions & 0 deletions docs/search-core.multilinetextsnippetdirectanswer.value.md
Original file line number Diff line number Diff line change
@@ -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; [MultiLineTextSnippetDirectAnswer](./search-core.multilinetextsnippetdirectanswer.md) &gt; [value](./search-core.multilinetextsnippetdirectanswer.value.md)

## MultiLineTextSnippetDirectAnswer.value property

The value of the direct answer.

<b>Signature:</b>

```typescript
value: string;
```
Original file line number Diff line number Diff line change
@@ -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; [RichTextFeaturedSnippetDirectAnswer](./search-core.richtextfeaturedsnippetdirectanswer.md) &gt; [fieldType](./search-core.richtextfeaturedsnippetdirectanswer.fieldtype.md)
[Home](./index.md) &gt; [@yext/search-core](./search-core.md) &gt; [RichTextSnippetDirectAnswer](./search-core.richtextsnippetdirectanswer.md) &gt; [fieldType](./search-core.richtextsnippetdirectanswer.fieldtype.md)

## RichTextFeaturedSnippetDirectAnswer.fieldType property
## RichTextSnippetDirectAnswer.fieldType property

The field type of the direct answer.

Expand Down
Original file line number Diff line number Diff line change
@@ -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; [RichTextFeaturedSnippetDirectAnswer](./search-core.richtextfeaturedsnippetdirectanswer.md)
[Home](./index.md) &gt; [@yext/search-core](./search-core.md) &gt; [RichTextSnippetDirectAnswer](./search-core.richtextsnippetdirectanswer.md)

## RichTextFeaturedSnippetDirectAnswer interface
## RichTextSnippetDirectAnswer interface

A [BaseFeaturedSnippetDirectAnswer](./search-core.basefeaturedsnippetdirectanswer.md) with 'rich\_text' field type. "value" field is omitted for featured snippet direct answer of this field type.

<b>Signature:</b>

```typescript
export interface RichTextFeaturedSnippetDirectAnswer extends Omit<BaseFeaturedSnippetDirectAnswer<string>, 'value'>
export interface RichTextSnippetDirectAnswer 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.richtextfeaturedsnippetdirectanswer.fieldtype.md) | [EnumOrLiteral](./search-core.enumorliteral.md)<!-- -->&lt;[BuiltInFieldType.RichText](./search-core.builtinfieldtype.md)<!-- -->&gt; | The field type of the direct answer. |
| [fieldType](./search-core.richtextsnippetdirectanswer.fieldtype.md) | [EnumOrLiteral](./search-core.enumorliteral.md)<!-- -->&lt;[BuiltInFieldType.RichText](./search-core.builtinfieldtype.md)<!-- -->&gt; | The field type of the direct answer. |
6 changes: 3 additions & 3 deletions etc/search-core.api.md
Original file line number Diff line number Diff line change
Expand Up @@ -262,7 +262,7 @@ export interface FailedVertical {
}

// @public
export type FeaturedSnippetDirectAnswer = MultiLineTextFeaturedSnippetDirectAnswer | RichTextFeaturedSnippetDirectAnswer;
export type FeaturedSnippetDirectAnswer = MultiLineTextSnippetDirectAnswer | RichTextSnippetDirectAnswer;

// @public
export type FieldValueDirectAnswer = UnknownFieldValueDirectAnswer | TextDirectAnswer | UrlDirectAnswer | RichTextDirectAnswer | DecimalDirectAnswer | FacebookUrlDirectAnswer | InstagramHandleDirectAnswer | TwitterHandleDirectAnswer | IosAppUrlDirectAnswer | AndroidAppUrlDirectAnswer;
Expand Down Expand Up @@ -389,7 +389,7 @@ export enum Matcher {
}

// @public
export interface MultiLineTextFeaturedSnippetDirectAnswer extends BaseFeaturedSnippetDirectAnswer<string> {
export interface MultiLineTextSnippetDirectAnswer extends BaseFeaturedSnippetDirectAnswer<string> {
fieldType: EnumOrLiteral<BuiltInFieldType.MultiLineText>;
value: string;
}
Expand Down Expand Up @@ -476,7 +476,7 @@ export interface RichTextDirectAnswer extends BaseFieldValueDirectAnswer<string
}

// @public
export interface RichTextFeaturedSnippetDirectAnswer extends Omit<BaseFeaturedSnippetDirectAnswer<string>, 'value'> {
export interface RichTextSnippetDirectAnswer extends Omit<BaseFeaturedSnippetDirectAnswer<string>, 'value'> {
fieldType: EnumOrLiteral<BuiltInFieldType.RichText>;
}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@ import { Snippet } from '../Snippet';
import { BuiltInFieldType } from './BuiltInFieldType';
import { EnumOrLiteral } from '../../../utils/EnumOrLiteral';
import {
MultiLineTextFeaturedSnippetDirectAnswer,
RichTextFeaturedSnippetDirectAnswer
MultiLineTextSnippetDirectAnswer,
RichTextSnippetDirectAnswer
} from './featuredsnippetdirectanswers';

/**
Expand All @@ -28,4 +28,4 @@ export interface BaseFeaturedSnippetDirectAnswer<T = unknown> extends DirectAnsw
* @public
*/
export type FeaturedSnippetDirectAnswer =
MultiLineTextFeaturedSnippetDirectAnswer | RichTextFeaturedSnippetDirectAnswer;
MultiLineTextSnippetDirectAnswer | RichTextSnippetDirectAnswer;
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ import { BaseFeaturedSnippetDirectAnswer } from '../FeaturedSnippetDirectAnswer'
*
* @public
*/
export interface MultiLineTextFeaturedSnippetDirectAnswer extends BaseFeaturedSnippetDirectAnswer<string> {
export interface MultiLineTextSnippetDirectAnswer extends BaseFeaturedSnippetDirectAnswer<string> {
/** The value of the direct answer. */
value: string,
/** {@inheritDoc DirectAnswer.fieldType} */
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ import { BaseFeaturedSnippetDirectAnswer } from '../FeaturedSnippetDirectAnswer'
*
* @public
*/
export interface RichTextFeaturedSnippetDirectAnswer extends Omit<BaseFeaturedSnippetDirectAnswer<string>, 'value'> {
export interface RichTextSnippetDirectAnswer extends Omit<BaseFeaturedSnippetDirectAnswer<string>, 'value'> {
/** {@inheritDoc DirectAnswer.fieldType} */
fieldType: EnumOrLiteral<BuiltInFieldType.RichText>
}
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
export { RichTextFeaturedSnippetDirectAnswer } from './RichTextFeaturedSnippetDirectAnswer';
export { MultiLineTextFeaturedSnippetDirectAnswer } from './MultiLineTextFeaturedSnippetDirectAnswer';
export { RichTextSnippetDirectAnswer } from './RichTextSnippetDirectAnswer';
export { MultiLineTextSnippetDirectAnswer } from './MultiLineTextSnippetDirectAnswer';

0 comments on commit 6597b2c

Please sign in to comment.