update doc and make required

yext · Aug 15, 2022 · 206b455 · 206b455
1 parent 512e37b
commit 206b455
Show file tree

Hide file tree

Showing 9 changed files with 22 additions and 22 deletions.
diff --git a/docs/search-core.address.city.md b/docs/search-core.address.city.md
@@ -7,5 +7,5 @@
 <b>Signature:</b>
 
 ```typescript
-city?: string;
+city: string;
 ```
diff --git a/docs/search-core.address.line1.md b/docs/search-core.address.line1.md
@@ -7,5 +7,5 @@
 <b>Signature:</b>
 
 ```typescript
-line1?: string;
+line1: string;
 ```
diff --git a/docs/search-core.address.md b/docs/search-core.address.md
@@ -4,7 +4,7 @@
 
 ## Address interface
 
-A type interface with address fields to use in [DirectAnswer.value](./search-core.directanswer.value.md)<!-- -->.
+An interface with address fields to use in [DirectAnswer.value](./search-core.directanswer.value.md)<!-- -->.
 
 <b>Signature:</b>
 
@@ -16,13 +16,13 @@ export interface Address
 
 |  Property | Type | Description |
 |  --- | --- | --- |
-|  [city?](./search-core.address.city.md) | string | <i>(Optional)</i> |
+|  [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 | <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 | <i>(Optional)</i> |
-|  [region?](./search-core.address.region.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> |
 
diff --git a/docs/search-core.address.postalcode.md b/docs/search-core.address.postalcode.md
@@ -7,5 +7,5 @@
 <b>Signature:</b>
 
 ```typescript
-postalCode?: string;
+postalCode: string;
 ```
diff --git a/docs/search-core.address.region.md b/docs/search-core.address.region.md
@@ -7,5 +7,5 @@
 <b>Signature:</b>
 
 ```typescript
-region?: string;
+region: string;
 ```
diff --git a/docs/search-core.addressdirectanswer.md b/docs/search-core.addressdirectanswer.md
@@ -4,7 +4,7 @@
 
 ## AddressDirectAnswer interface
 
-An interface for direct answers for a [DirectAnswer](./search-core.directanswer.md) with address values.
+A direct answer [DirectAnswer](./search-core.directanswer.md) interface with address value.
 
 <b>Signature:</b>
 

diff --git a/docs/search-core.md b/docs/search-core.md
@@ -42,8 +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 [DirectAnswer.value](./search-core.directanswer.value.md)<!-- -->. |
-|  [AddressDirectAnswer](./search-core.addressdirectanswer.md) | An interface for direct answers for a [DirectAnswer](./search-core.directanswer.md) with address values. |
+|  [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 direct answer [DirectAnswer](./search-core.directanswer.md) interface with address value. |
 |  [AnswersConfigWithApiKey](./search-core.answersconfigwithapikey.md) |  |
 |  [AnswersConfigWithToken](./search-core.answersconfigwithtoken.md) |  |
 |  [AnswersError](./search-core.answerserror.md) |  |

diff --git a/etc/search-core.api.md b/etc/search-core.api.md
@@ -12,21 +12,21 @@ export interface AdditionalHttpHeaders {
 // @public
 export interface Address {
     // (undocumented)
-    city?: string;
+    city: string;
     // (undocumented)
     countryCode?: string;
     // (undocumented)
     extraDescription?: string;
     // (undocumented)
-    line1?: string;
+    line1: string;
     // (undocumented)
     line2?: string;
     // (undocumented)
     line3?: string;
     // (undocumented)
-    postalCode?: string;
+    postalCode: string;
     // (undocumented)
-    region?: string;
+    region: string;
     // (undocumented)
     sublocality?: string;
 }

diff --git a/src/models/searchservice/response/AddressDirectAnswer.ts b/src/models/searchservice/response/AddressDirectAnswer.ts
@@ -2,7 +2,7 @@ import { BuiltInFieldType } from './directanswer/BuiltInFieldType';
 import { DirectAnswer } from './directanswer/DirectAnswer';
 
 /**
- * An interface for direct answers for a {@link DirectAnswer} with address values.
+ * A direct answer {@link DirectAnswer} interface with address value.
  *
  * @public
  */
@@ -11,18 +11,18 @@ export interface AddressDirectAnswer extends DirectAnswer<Address> {
 }
 
 /**
- * A type interface with address fields to use in {@link DirectAnswer.value}.
+ * An interface with address fields to use in {@link DirectAnswer.value}.
  *
  * @public
  */
 export interface Address {
-  line1?: string,
+  line1: string,
   line2?: string,
   line3?: string,
   sublocality?: string,
-  city?: string,
-  region?: string,
-  postalCode?: string,
+  city: string,
+  region: string,
+  postalCode: string,
   extraDescription?: string,
   countryCode?: string
 }