Skip to content

Commit

Permalink
resolve merge conflicts
Browse files Browse the repository at this point in the history
  • Loading branch information
juliannzhou committed Aug 15, 2022
2 parents ae2e26c + 6d666eb commit 512e37b
Show file tree
Hide file tree
Showing 62 changed files with 662 additions and 314 deletions.
2 changes: 1 addition & 1 deletion docs/search-core.address.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

## Address interface

A type interface with address fields to use in [FieldValueDirectAnswer.value](./search-core.fieldvaluedirectanswer.value.md)<!-- -->.
A type interface with address fields to use in [DirectAnswer.value](./search-core.directanswer.value.md)<!-- -->.

<b>Signature:</b>

Expand Down
6 changes: 3 additions & 3 deletions docs/search-core.addressdirectanswer.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,14 @@

## AddressDirectAnswer interface

An interface for direct answers for a [FieldValueDirectAnswer](./search-core.fieldvaluedirectanswer.md) with address values.
An interface for direct answers for a [DirectAnswer](./search-core.directanswer.md) with address values.

<b>Signature:</b>

```typescript
export interface AddressDirectAnswer extends FieldValueDirectAnswer<Address>
export interface AddressDirectAnswer extends DirectAnswer<Address>
```
<b>Extends:</b> [FieldValueDirectAnswer](./search-core.fieldvaluedirectanswer.md)<!-- -->&lt;[Address](./search-core.address.md)<!-- -->&gt;
<b>Extends:</b> [DirectAnswer](./search-core.directanswer.md)<!-- -->&lt;[Address](./search-core.address.md)<!-- -->&gt;
## Properties
Expand Down
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; [FieldValueDirectAnswer](./search-core.fieldvaluedirectanswer.md) &gt; [entityName](./search-core.fieldvaluedirectanswer.entityname.md)
[Home](./index.md) &gt; [@yext/search-core](./search-core.md) &gt; [BaseFieldValueDirectAnswer](./search-core.basefieldvaluedirectanswer.md) &gt; [entityName](./search-core.basefieldvaluedirectanswer.entityname.md)

## FieldValueDirectAnswer.entityName property
## BaseFieldValueDirectAnswer.entityName property

The name of the entity that direct answer came from.

Expand Down
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; [FieldValueDirectAnswer](./search-core.fieldvaluedirectanswer.md) &gt; [fieldApiName](./search-core.fieldvaluedirectanswer.fieldapiname.md)
[Home](./index.md) &gt; [@yext/search-core](./search-core.md) &gt; [BaseFieldValueDirectAnswer](./search-core.basefieldvaluedirectanswer.md) &gt; [fieldApiName](./search-core.basefieldvaluedirectanswer.fieldapiname.md)

## FieldValueDirectAnswer.fieldApiName property
## BaseFieldValueDirectAnswer.fieldApiName property

The field api name of the direct answer.

Expand Down
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; [FieldValueDirectAnswer](./search-core.fieldvaluedirectanswer.md) &gt; [fieldName](./search-core.fieldvaluedirectanswer.fieldname.md)
[Home](./index.md) &gt; [@yext/search-core](./search-core.md) &gt; [BaseFieldValueDirectAnswer](./search-core.basefieldvaluedirectanswer.md) &gt; [fieldName](./search-core.basefieldvaluedirectanswer.fieldname.md)

## FieldValueDirectAnswer.fieldName property
## BaseFieldValueDirectAnswer.fieldName property

The field name of the direct answer.

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

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

## BaseFieldValueDirectAnswer interface

A direct answer where the answer came from a field from the knowledge graph.

<b>Signature:</b>

```typescript
export interface BaseFieldValueDirectAnswer<T = unknown> extends DirectAnswer<T>
```
<b>Extends:</b> [DirectAnswer](./search-core.directanswer.md)<!-- -->&lt;T&gt;
## Properties
| Property | Type | Description |
| --- | --- | --- |
| [entityName](./search-core.basefieldvaluedirectanswer.entityname.md) | string | The name of the entity that direct answer came from. |
| [fieldApiName](./search-core.basefieldvaluedirectanswer.fieldapiname.md) | string | The field api name of the direct answer. |
| [fieldName](./search-core.basefieldvaluedirectanswer.fieldname.md) | string | The field name of the direct answer. |
| [type](./search-core.basefieldvaluedirectanswer.type.md) | [DirectAnswerType.FieldValue](./search-core.directanswertype.md) | [DirectAnswerType](./search-core.directanswertype.md)<!-- -->.FieldValue. |
| [value](./search-core.basefieldvaluedirectanswer.value.md) | T | The result of the direct answer. |
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; [FieldValueDirectAnswer](./search-core.fieldvaluedirectanswer.md) &gt; [type](./search-core.fieldvaluedirectanswer.type.md)
[Home](./index.md) &gt; [@yext/search-core](./search-core.md) &gt; [BaseFieldValueDirectAnswer](./search-core.basefieldvaluedirectanswer.md) &gt; [type](./search-core.basefieldvaluedirectanswer.type.md)

## FieldValueDirectAnswer.type property
## BaseFieldValueDirectAnswer.type property

[DirectAnswerType](./search-core.directanswertype.md)<!-- -->.FieldValue.

Expand Down
13 changes: 13 additions & 0 deletions docs/search-core.basefieldvaluedirectanswer.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; [BaseFieldValueDirectAnswer](./search-core.basefieldvaluedirectanswer.md) &gt; [value](./search-core.basefieldvaluedirectanswer.value.md)

## BaseFieldValueDirectAnswer.value property

The result of the direct answer.

<b>Signature:</b>

```typescript
value: T;
```
3 changes: 3 additions & 0 deletions docs/search-core.builtinfieldtype.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,4 +17,7 @@ export declare enum BuiltInFieldType
| Member | Value | Description |
| --- | --- | --- |
| Address | <code>&quot;address&quot;</code> | |
| MultiLineText | <code>&quot;multi_line_text&quot;</code> | |
| Phone | <code>&quot;phone&quot;</code> | |
| RichText | <code>&quot;rich_text&quot;</code> | |

13 changes: 13 additions & 0 deletions docs/search-core.conjunctionstaticfilter.combinator.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; [ConjunctionStaticFilter](./search-core.conjunctionstaticfilter.md) &gt; [combinator](./search-core.conjunctionstaticfilter.combinator.md)

## ConjunctionStaticFilter.combinator property

Indicates that filters should be combined with a logical AND.

<b>Signature:</b>

```typescript
combinator: FilterCombinator.AND;
```
13 changes: 13 additions & 0 deletions docs/search-core.conjunctionstaticfilter.filters.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; [ConjunctionStaticFilter](./search-core.conjunctionstaticfilter.md) &gt; [filters](./search-core.conjunctionstaticfilter.filters.md)

## ConjunctionStaticFilter.filters property

The filters to combine together.

<b>Signature:</b>

```typescript
filters: StaticFilter[];
```
13 changes: 13 additions & 0 deletions docs/search-core.conjunctionstaticfilter.kind.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; [ConjunctionStaticFilter](./search-core.conjunctionstaticfilter.md) &gt; [kind](./search-core.conjunctionstaticfilter.kind.md)

## ConjunctionStaticFilter.kind property

The kind of static filter.

<b>Signature:</b>

```typescript
kind: 'conjunction';
```
22 changes: 22 additions & 0 deletions docs/search-core.conjunctionstaticfilter.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; [ConjunctionStaticFilter](./search-core.conjunctionstaticfilter.md)

## ConjunctionStaticFilter interface

A static filter composed by combining other static filters with the logical AND operator.

<b>Signature:</b>

```typescript
export interface ConjunctionStaticFilter
```

## Properties

| Property | Type | Description |
| --- | --- | --- |
| [combinator](./search-core.conjunctionstaticfilter.combinator.md) | [FilterCombinator.AND](./search-core.filtercombinator.md) | Indicates that filters should be combined with a logical AND. |
| [filters](./search-core.conjunctionstaticfilter.filters.md) | [StaticFilter](./search-core.staticfilter.md)<!-- -->\[\] | The filters to combine together. |
| [kind](./search-core.conjunctionstaticfilter.kind.md) | 'conjunction' | The kind of static filter. |

2 changes: 1 addition & 1 deletion docs/search-core.directanswer.fieldtype.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,5 +9,5 @@ The field type of the direct answer.
<b>Signature:</b>

```typescript
fieldType: BuiltInFieldType | string;
fieldType: EnumOrLiteral<BuiltInFieldType> | 'unknown';
```
4 changes: 2 additions & 2 deletions docs/search-core.directanswer.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,9 @@ export interface DirectAnswer<T = unknown>

| Property | Type | Description |
| --- | --- | --- |
| [fieldType](./search-core.directanswer.fieldtype.md) | [BuiltInFieldType](./search-core.builtinfieldtype.md) \| string | The field type of the direct answer. |
| [fieldType](./search-core.directanswer.fieldtype.md) | [EnumOrLiteral](./search-core.enumorliteral.md)<!-- -->&lt;[BuiltInFieldType](./search-core.builtinfieldtype.md)<!-- -->&gt; \| 'unknown' | 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) | T | <i>(Optional)</i> The result of the direct answer. |
| [value?](./search-core.directanswer.value.md) | T | <i>(Optional)</i> The value of the direct answer. |
| [verticalKey](./search-core.directanswer.verticalkey.md) | string | The vertical key of the direct answer. |

4 changes: 2 additions & 2 deletions docs/search-core.directanswer.value.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

## DirectAnswer.value property

The result of the direct answer.
The value of the direct answer.

<b>Signature:</b>

Expand All @@ -14,5 +14,5 @@ value?: T;

## Remarks

A value will not be present if the [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'.

13 changes: 13 additions & 0 deletions docs/search-core.disjunctionstaticfilter.combinator.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; [DisjunctionStaticFilter](./search-core.disjunctionstaticfilter.md) &gt; [combinator](./search-core.disjunctionstaticfilter.combinator.md)

## DisjunctionStaticFilter.combinator property

Indicates that filters should be combined with a logical OR.

<b>Signature:</b>

```typescript
combinator: FilterCombinator.OR;
```
13 changes: 13 additions & 0 deletions docs/search-core.disjunctionstaticfilter.filters.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; [DisjunctionStaticFilter](./search-core.disjunctionstaticfilter.md) &gt; [filters](./search-core.disjunctionstaticfilter.filters.md)

## DisjunctionStaticFilter.filters property

The filters to combine together.

<b>Signature:</b>

```typescript
filters: (DisjunctionStaticFilter | FieldValueStaticFilter)[];
```
13 changes: 13 additions & 0 deletions docs/search-core.disjunctionstaticfilter.kind.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; [DisjunctionStaticFilter](./search-core.disjunctionstaticfilter.md) &gt; [kind](./search-core.disjunctionstaticfilter.kind.md)

## DisjunctionStaticFilter.kind property

The kind of static filter.

<b>Signature:</b>

```typescript
kind: 'disjunction';
```
22 changes: 22 additions & 0 deletions docs/search-core.disjunctionstaticfilter.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; [DisjunctionStaticFilter](./search-core.disjunctionstaticfilter.md)

## DisjunctionStaticFilter interface

A static filter composed by combining filters with the logical OR operator. The combined filters can either be field value filters or other disjunction filters.

<b>Signature:</b>

```typescript
export interface DisjunctionStaticFilter
```

## Properties

| Property | Type | Description |
| --- | --- | --- |
| [combinator](./search-core.disjunctionstaticfilter.combinator.md) | [FilterCombinator.OR](./search-core.filtercombinator.md) | Indicates that filters should be combined with a logical OR. |
| [filters](./search-core.disjunctionstaticfilter.filters.md) | ([DisjunctionStaticFilter](./search-core.disjunctionstaticfilter.md) \| [FieldValueStaticFilter](./search-core.fieldvaluestaticfilter.md)<!-- -->)\[\] | The filters to combine together. |
| [kind](./search-core.disjunctionstaticfilter.kind.md) | 'disjunction' | The kind of static filter. |

13 changes: 13 additions & 0 deletions docs/search-core.enumorliteral.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; [EnumOrLiteral](./search-core.enumorliteral.md)

## EnumOrLiteral type

Produces a union type from the enum passed as a generic which consists of the enum values and the string literals of the enum.

<b>Signature:</b>

```typescript
export declare type EnumOrLiteral<T extends string> = T | `${T}`;
```
2 changes: 1 addition & 1 deletion docs/search-core.featuredsnippetdirectanswer.fieldtype.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,5 +9,5 @@ The field type of the direct answer.
<b>Signature:</b>

```typescript
fieldType: BuiltInFieldType | string;
fieldType: BuiltInFieldType.MultiLineText | BuiltInFieldType.RichText;
```
7 changes: 2 additions & 5 deletions docs/search-core.featuredsnippetdirectanswer.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,10 +17,7 @@ export interface FeaturedSnippetDirectAnswer<T = unknown> extends DirectAnswer<T
| Property | Type | Description |
| --- | --- | --- |
| [fieldType](./search-core.featuredsnippetdirectanswer.fieldtype.md) | [BuiltInFieldType](./search-core.builtinfieldtype.md) \| string | The field type of the direct answer. |
| [relatedResult](./search-core.featuredsnippetdirectanswer.relatedresult.md) | [Result](./search-core.result.md) | The entity associated with the direct answer. |
| [fieldType](./search-core.featuredsnippetdirectanswer.fieldtype.md) | [BuiltInFieldType.MultiLineText](./search-core.builtinfieldtype.md) \| [BuiltInFieldType.RichText](./search-core.builtinfieldtype.md) | The field type of the direct answer. |
| [snippet](./search-core.featuredsnippetdirectanswer.snippet.md) | [Snippet](./search-core.snippet.md) | The snippet where the direct answer was found. |
| [type](./search-core.featuredsnippetdirectanswer.type.md) | [DirectAnswerType.FeaturedSnippet](./search-core.directanswertype.md) | [DirectAnswerType](./search-core.directanswertype.md)<!-- -->.FeaturedSnippet. |
| [value?](./search-core.featuredsnippetdirectanswer.value.md) | T | <i>(Optional)</i> The result of the direct answer. |
| [verticalKey](./search-core.featuredsnippetdirectanswer.verticalkey.md) | string | The vertical key of the direct answer. |
| [type](./search-core.featuredsnippetdirectanswer.type.md) | [DirectAnswerType.FeaturedSnippet](./search-core.directanswertype.md) | [DirectAnswerType](./search-core.directanswertype.md)<!-- -->.FeaturedSnippet |
13 changes: 0 additions & 13 deletions docs/search-core.featuredsnippetdirectanswer.relatedresult.md

This file was deleted.

2 changes: 1 addition & 1 deletion docs/search-core.featuredsnippetdirectanswer.type.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

## FeaturedSnippetDirectAnswer.type property

[DirectAnswerType](./search-core.directanswertype.md)<!-- -->.FeaturedSnippet.
[DirectAnswerType](./search-core.directanswertype.md)<!-- -->.FeaturedSnippet

<b>Signature:</b>

Expand Down
18 changes: 0 additions & 18 deletions docs/search-core.featuredsnippetdirectanswer.value.md

This file was deleted.

13 changes: 0 additions & 13 deletions docs/search-core.featuredsnippetdirectanswer.verticalkey.md

This file was deleted.

13 changes: 0 additions & 13 deletions docs/search-core.fieldvaluedirectanswer.fieldtype.md

This file was deleted.

Loading

0 comments on commit 512e37b

Please sign in to comment.