Merge f28d265 into 6d666eb

docs/search-core.address.city.md

@@ -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;
+```

docs/search-core.address.countrycode.md

@@ -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;
+```

docs/search-core.address.extradescription.md

@@ -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;
+```

docs/search-core.address.line1.md

@@ -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;
+```

docs/search-core.address.line2.md

@@ -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;
+```

docs/search-core.address.line3.md

@@ -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;
+```

docs/search-core.address.md

@@ -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
+
+An interface with address fields to use in [DirectAnswer.value](./search-core.directanswer.value.md)<!-- -->.
+
+<b>Signature:</b>
+
+```typescript
+export interface Address 
+```
+
+## Properties
+
+|  Property | Type | Description |
+|  --- | --- | --- |
+|  [city](./search-core.address.city.md) | string |  |
+|  [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 |  |
+|  [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 |  |
+|  [region](./search-core.address.region.md) | string |  |
+|  [sublocality?](./search-core.address.sublocality.md) | string | <i>(Optional)</i> |
+

docs/search-core.address.postalcode.md

@@ -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;
+```

docs/search-core.address.region.md

@@ -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;
+```

docs/search-core.address.sublocality.md

@@ -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;
+```

docs/search-core.addressdirectanswer.fieldtype.md

@@ -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;
+```

docs/search-core.addressdirectanswer.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; [AddressDirectAnswer](./search-core.addressdirectanswer.md)
+
+## AddressDirectAnswer interface
+
+A [DirectAnswer](./search-core.directanswer.md) interface with address value.
+
+<b>Signature:</b>
+
+```typescript
+export interface AddressDirectAnswer extends DirectAnswer<Address> 
+```
+<b>Extends:</b> [DirectAnswer](./search-core.directanswer.md)<!-- -->&lt;[Address](./search-core.address.md)<!-- -->&gt;
+
+## Properties
+
+|  Property | Type | Description |
+|  --- | --- | --- |
+|  [fieldType](./search-core.addressdirectanswer.fieldtype.md) | [BuiltInFieldType.Address](./search-core.builtinfieldtype.md) |  |
+

docs/search-core.builtinfieldtype.md

@@ -16,6 +16,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> |  |

docs/search-core.md

@@ -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) | An interface with address fields to use in [DirectAnswer.value](./search-core.directanswer.value.md)<!-- -->. |
+|  [AddressDirectAnswer](./search-core.addressdirectanswer.md) | A [DirectAnswer](./search-core.directanswer.md) interface with address value. |
 |  [AnswersConfigWithApiKey](./search-core.answersconfigwithapikey.md) |  |
 |  [AnswersConfigWithToken](./search-core.answersconfigwithtoken.md) |  |
 |  [AnswersError](./search-core.answerserror.md) |  |

etc/search-core.api.md

@@ -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 DirectAnswer<Address> {
+    // (undocumented)
+    fieldType: BuiltInFieldType.Address;
+}
+
 // @public @deprecated (undocumented)
 export type AnswersConfig = SearchConfig;
 
@@ -104,6 +132,8 @@ export interface BaseSearchConfig {
 
 // @public
 export enum BuiltInFieldType {
+    // (undocumented)
+    Address = "address",
     // (undocumented)
     MultiLineText = "multi_line_text",
     // (undocumented)

src/models/index.ts

@@ -79,6 +79,7 @@ export { VerticalSearchResponse } from './searchservice/response/VerticalSearchR
 export { Snippet } from './searchservice/response/Snippet';
 export { ErrorType } from './searchservice/response/ErrorType';
 export { FailedVertical } from './searchservice/response/FailedVertical';
+export { AddressDirectAnswer, Address } from './searchservice/response/AddressDirectAnswer';
 
 // Search service common models
 export { Matcher } from './searchservice/common/Matcher';

src/models/searchservice/response/AddressDirectAnswer.ts

@@ -0,0 +1,28 @@
+import { BuiltInFieldType } from './directanswer/BuiltInFieldType';
+import { DirectAnswer } from './directanswer/DirectAnswer';
+
+/**
+ * A {@link DirectAnswer} interface with address value.
+ *
+ * @public
+ */
+export interface AddressDirectAnswer extends DirectAnswer<Address> {
+  fieldType: BuiltInFieldType.Address
+}
+
+/**
+ * An interface with address fields to use in {@link DirectAnswer.value}.
+ *
+ * @public
+ */
+export interface Address {
+  line1: string,
+  line2?: string,
+  line3?: string,
+  sublocality?: string,
+  city: string,
+  region: string,
+  postalCode: string,
+  extraDescription?: string,
+  countryCode?: string
+}

src/models/searchservice/response/directanswer/BuiltInFieldType.ts

@@ -12,7 +12,7 @@ export enum BuiltInFieldType {
   // InstagramHandle = 'instagram_handle',
   // TwitterHandle = 'twitter_handle',
   Phone = 'phone',
-  // Address = 'address',
+  Address = 'address',
   // Hours = 'hours',
   // Decimal = 'decimal',
   RichText = 'rich_text',