Skip to content

Commit

Permalink
Merge 411127b into 75a2d99
Browse files Browse the repository at this point in the history
  • Loading branch information
juliannzhou committed Aug 12, 2022
2 parents 75a2d99 + 411127b commit 7df7078
Show file tree
Hide file tree
Showing 16 changed files with 218 additions and 0 deletions.
11 changes: 11 additions & 0 deletions docs/search-core.address.city.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@yext/search-core](./search-core.md) &gt; [Address](./search-core.address.md) &gt; [city](./search-core.address.city.md)

## Address.city property

<b>Signature:</b>

```typescript
city?: string;
```
11 changes: 11 additions & 0 deletions docs/search-core.address.countrycode.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@yext/search-core](./search-core.md) &gt; [Address](./search-core.address.md) &gt; [countryCode](./search-core.address.countrycode.md)

## Address.countryCode property

<b>Signature:</b>

```typescript
countryCode?: string;
```
11 changes: 11 additions & 0 deletions docs/search-core.address.extradescription.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@yext/search-core](./search-core.md) &gt; [Address](./search-core.address.md) &gt; [extraDescription](./search-core.address.extradescription.md)

## Address.extraDescription property

<b>Signature:</b>

```typescript
extraDescription?: string;
```
11 changes: 11 additions & 0 deletions docs/search-core.address.line1.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@yext/search-core](./search-core.md) &gt; [Address](./search-core.address.md) &gt; [line1](./search-core.address.line1.md)

## Address.line1 property

<b>Signature:</b>

```typescript
line1?: string;
```
11 changes: 11 additions & 0 deletions docs/search-core.address.line2.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@yext/search-core](./search-core.md) &gt; [Address](./search-core.address.md) &gt; [line2](./search-core.address.line2.md)

## Address.line2 property

<b>Signature:</b>

```typescript
line2?: string;
```
11 changes: 11 additions & 0 deletions docs/search-core.address.line3.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@yext/search-core](./search-core.md) &gt; [Address](./search-core.address.md) &gt; [line3](./search-core.address.line3.md)

## Address.line3 property

<b>Signature:</b>

```typescript
line3?: string;
```
28 changes: 28 additions & 0 deletions docs/search-core.address.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

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

## Address interface

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

<b>Signature:</b>

```typescript
export interface Address
```

## Properties

| Property | Type | Description |
| --- | --- | --- |
| [city?](./search-core.address.city.md) | string | <i>(Optional)</i> |
| [countryCode?](./search-core.address.countrycode.md) | string | <i>(Optional)</i> |
| [extraDescription?](./search-core.address.extradescription.md) | string | <i>(Optional)</i> |
| [line1?](./search-core.address.line1.md) | string | <i>(Optional)</i> |
| [line2?](./search-core.address.line2.md) | string | <i>(Optional)</i> |
| [line3?](./search-core.address.line3.md) | string | <i>(Optional)</i> |
| [postalCode?](./search-core.address.postalcode.md) | string | <i>(Optional)</i> |
| [region?](./search-core.address.region.md) | string | <i>(Optional)</i> |
| [sublocality?](./search-core.address.sublocality.md) | string | <i>(Optional)</i> |

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

[Home](./index.md) &gt; [@yext/search-core](./search-core.md) &gt; [Address](./search-core.address.md) &gt; [postalCode](./search-core.address.postalcode.md)

## Address.postalCode property

<b>Signature:</b>

```typescript
postalCode?: string;
```
11 changes: 11 additions & 0 deletions docs/search-core.address.region.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@yext/search-core](./search-core.md) &gt; [Address](./search-core.address.md) &gt; [region](./search-core.address.region.md)

## Address.region property

<b>Signature:</b>

```typescript
region?: string;
```
11 changes: 11 additions & 0 deletions docs/search-core.address.sublocality.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@yext/search-core](./search-core.md) &gt; [Address](./search-core.address.md) &gt; [sublocality](./search-core.address.sublocality.md)

## Address.sublocality property

<b>Signature:</b>

```typescript
sublocality?: string;
```
11 changes: 11 additions & 0 deletions docs/search-core.addressdirectanswer.fieldtype.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@yext/search-core](./search-core.md) &gt; [AddressDirectAnswer](./search-core.addressdirectanswer.md) &gt; [fieldType](./search-core.addressdirectanswer.fieldtype.md)

## AddressDirectAnswer.fieldType property

<b>Signature:</b>

```typescript
fieldType: BuiltInFieldType.Address;
```
21 changes: 21 additions & 0 deletions docs/search-core.addressdirectanswer.md
Original file line number Diff line number Diff line change
@@ -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; [AddressDirectAnswer](./search-core.addressdirectanswer.md)

## AddressDirectAnswer interface

A interface for direct answers [FieldValueDirectAnswer](./search-core.fieldvaluedirectanswer.md) with address values.

<b>Signature:</b>

```typescript
export interface AddressDirectAnswer extends FieldValueDirectAnswer<Address>
```
<b>Extends:</b> [FieldValueDirectAnswer](./search-core.fieldvaluedirectanswer.md)<!-- -->&lt;[Address](./search-core.address.md)<!-- -->&gt;
## Properties
| Property | Type | Description |
| --- | --- | --- |
| [fieldType](./search-core.addressdirectanswer.fieldtype.md) | [BuiltInFieldType.Address](./search-core.builtinfieldtype.md) | |
2 changes: 2 additions & 0 deletions docs/search-core.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,8 @@
| Interface | Description |
| --- | --- |
| [AdditionalHttpHeaders](./search-core.additionalhttpheaders.md) | AdditionalHttpHeaders allows users to specify additional values for specific HTTP headers. |
| [Address](./search-core.address.md) | A type interface with address fields to use in [FieldValueDirectAnswer.value](./search-core.fieldvaluedirectanswer.value.md)<!-- -->. |
| [AddressDirectAnswer](./search-core.addressdirectanswer.md) | A interface for direct answers [FieldValueDirectAnswer](./search-core.fieldvaluedirectanswer.md) with address values. |
| [AnswersConfigWithApiKey](./search-core.answersconfigwithapikey.md) | |
| [AnswersConfigWithToken](./search-core.answersconfigwithtoken.md) | |
| [AnswersError](./search-core.answerserror.md) | |
Expand Down
28 changes: 28 additions & 0 deletions etc/search-core.api.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,34 @@ export interface AdditionalHttpHeaders {
'Client-SDK'?: ClientSDKHeaderValues;
}

// @public
export interface Address {
// (undocumented)
city?: string;
// (undocumented)
countryCode?: string;
// (undocumented)
extraDescription?: string;
// (undocumented)
line1?: string;
// (undocumented)
line2?: string;
// (undocumented)
line3?: string;
// (undocumented)
postalCode?: string;
// (undocumented)
region?: string;
// (undocumented)
sublocality?: string;
}

// @public
export interface AddressDirectAnswer extends FieldValueDirectAnswer<Address> {
// (undocumented)
fieldType: BuiltInFieldType.Address;
}

// @public @deprecated (undocumented)
export type AnswersConfig = SearchConfig;

Expand Down
1 change: 1 addition & 0 deletions src/models/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,7 @@ export { Snippet } from './searchservice/response/Snippet';
export { ErrorType } from './searchservice/response/ErrorType';
export { FailedVertical } from './searchservice/response/FailedVertical';
export { BuiltInFieldType } from './searchservice/response/BuiltInFieldType';
export { AddressDirectAnswer, Address } from './searchservice/response/AddressDirectAnswer';

// Search service common models
export { Matcher } from './searchservice/common/Matcher';
Expand Down
28 changes: 28 additions & 0 deletions src/models/searchservice/response/AddressDirectAnswer.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
import { FieldValueDirectAnswer } from './FieldValueDirectAnswer';
import { BuiltInFieldType } from './BuiltInFieldType';

/**
* A interface for direct answers {@link FieldValueDirectAnswer} with address values.
*
* @public
*/
export interface AddressDirectAnswer extends FieldValueDirectAnswer<Address> {
fieldType: BuiltInFieldType.Address
}

/**
* A type interface with address fields to use in {@link FieldValueDirectAnswer.value}.
*
* @public
*/
export interface Address {
line1?: string,
line2?: string,
line3?: string,
sublocality?: string,
city?: string,
region?: string,
postalCode?: string,
extraDescription?: string,
countryCode?: string
}

0 comments on commit 7df7078

Please sign in to comment.