Automated update to repo's documentation from github action

yext · Aug 21, 2024 · ad42b9f · ad42b9f
1 parent 51d8d5f
commit ad42b9f
Show file tree

Hide file tree

Showing 539 changed files with 15,010 additions and 1,704 deletions.
diff --git a/docs/index.md b/docs/index.md
@@ -6,7 +6,24 @@
 
 ## Packages
 
-|  Package | Description |
-|  --- | --- |
-|  [@yext/search-headless](./search-headless.md) |  |
+<table><thead><tr><th>
 
+Package
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[@yext/search-headless](./search-headless.md)
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>
diff --git a/docs/search-headless.additionalhttpheaders._client-sdk_.md b/docs/search-headless.additionalhttpheaders._client-sdk_.md
@@ -6,7 +6,7 @@
 
 Additional agents and their versions used to create the Search experience. The information for these agents is added to the Client-SDK HTTP header along with that of the ANSWERS\_CORE agent.
 
-<b>Signature:</b>
+**Signature:**
 
 ```typescript
 'Client-SDK'?: ClientSDKHeaderValues;

diff --git a/docs/search-headless.additionalhttpheaders.md b/docs/search-headless.additionalhttpheaders.md
@@ -6,15 +6,52 @@
 
 AdditionalHttpHeaders allows users to specify additional values for specific HTTP headers.
 
-<b>Signature:</b>
+**Signature:**
 
 ```typescript
 export declare interface AdditionalHttpHeaders 
 ```
 
 ## Properties
 
-|  Property | Type | Description |
-|  --- | --- | --- |
-|  ["Client-SDK"?](./search-headless.additionalhttpheaders._client-sdk_.md) | [ClientSDKHeaderValues](./search-headless.clientsdkheadervalues.md) | <i>(Optional)</i> Additional agents and their versions used to create the Search experience. The information for these agents is added to the Client-SDK HTTP header along with that of the ANSWERS\_CORE agent. |
+<table><thead><tr><th>
 
+Property
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+["Client-SDK"?](./search-headless.additionalhttpheaders._client-sdk_.md)
+
+
+</td><td>
+
+
+</td><td>
+
+[ClientSDKHeaderValues](./search-headless.clientsdkheadervalues.md)
+
+
+</td><td>
+
+_(Optional)_ Additional agents and their versions used to create the Search experience. The information for these agents is added to the Client-SDK HTTP header along with that of the ANSWERS\_CORE agent.
+
+
+</td></tr>
+</tbody></table>
diff --git a/docs/search-headless.address.city.md b/docs/search-headless.address.city.md
@@ -4,7 +4,7 @@
 
 ## Address.city property
 
-<b>Signature:</b>
+**Signature:**
 
 ```typescript
 city?: string;

diff --git a/docs/search-headless.address.countrycode.md b/docs/search-headless.address.countrycode.md
@@ -4,7 +4,7 @@
 
 ## Address.countryCode property
 
-<b>Signature:</b>
+**Signature:**
 
 ```typescript
 countryCode: string;

diff --git a/docs/search-headless.address.extradescription.md b/docs/search-headless.address.extradescription.md
@@ -4,7 +4,7 @@
 
 ## Address.extraDescription property
 
-<b>Signature:</b>
+**Signature:**
 
 ```typescript
 extraDescription?: string;

diff --git a/docs/search-headless.address.line1.md b/docs/search-headless.address.line1.md
@@ -4,7 +4,7 @@
 
 ## Address.line1 property
 
-<b>Signature:</b>
+**Signature:**
 
 ```typescript
 line1?: string;

diff --git a/docs/search-headless.address.line2.md b/docs/search-headless.address.line2.md
@@ -4,7 +4,7 @@
 
 ## Address.line2 property
 
-<b>Signature:</b>
+**Signature:**
 
 ```typescript
 line2?: string;

diff --git a/docs/search-headless.address.line3.md b/docs/search-headless.address.line3.md
@@ -4,7 +4,7 @@
 
 ## Address.line3 property
 
-<b>Signature:</b>
+**Signature:**
 
 ```typescript
 line3?: string;

diff --git a/docs/search-headless.address.md b/docs/search-headless.address.md
@@ -6,23 +6,202 @@
 
 An interface with address fields to use in [BaseFieldValueDirectAnswer.value](./search-headless.basefieldvaluedirectanswer.value.md)<!-- -->.
 
-<b>Signature:</b>
+**Signature:**
 
 ```typescript
 export declare interface Address 
 ```
 
 ## Properties
 
-|  Property | Type | Description |
-|  --- | --- | --- |
-|  [city?](./search-headless.address.city.md) | string | <i>(Optional)</i> |
-|  [countryCode](./search-headless.address.countrycode.md) | string |  |
-|  [extraDescription?](./search-headless.address.extradescription.md) | string | <i>(Optional)</i> |
-|  [line1?](./search-headless.address.line1.md) | string | <i>(Optional)</i> |
-|  [line2?](./search-headless.address.line2.md) | string | <i>(Optional)</i> |
-|  [line3?](./search-headless.address.line3.md) | string | <i>(Optional)</i> |
-|  [postalCode?](./search-headless.address.postalcode.md) | string | <i>(Optional)</i> |
-|  [region?](./search-headless.address.region.md) | string | <i>(Optional)</i> |
-|  [sublocality?](./search-headless.address.sublocality.md) | string | <i>(Optional)</i> |
+<table><thead><tr><th>
 
+Property
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[city?](./search-headless.address.city.md)
+
+
+</td><td>
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+_(Optional)_
+
+
+</td></tr>
+<tr><td>
+
+[countryCode](./search-headless.address.countrycode.md)
+
+
+</td><td>
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[extraDescription?](./search-headless.address.extradescription.md)
+
+
+</td><td>
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+_(Optional)_
+
+
+</td></tr>
+<tr><td>
+
+[line1?](./search-headless.address.line1.md)
+
+
+</td><td>
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+_(Optional)_
+
+
+</td></tr>
+<tr><td>
+
+[line2?](./search-headless.address.line2.md)
+
+
+</td><td>
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+_(Optional)_
+
+
+</td></tr>
+<tr><td>
+
+[line3?](./search-headless.address.line3.md)
+
+
+</td><td>
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+_(Optional)_
+
+
+</td></tr>
+<tr><td>
+
+[postalCode?](./search-headless.address.postalcode.md)
+
+
+</td><td>
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+_(Optional)_
+
+
+</td></tr>
+<tr><td>
+
+[region?](./search-headless.address.region.md)
+
+
+</td><td>
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+_(Optional)_
+
+
+</td></tr>
+<tr><td>
+
+[sublocality?](./search-headless.address.sublocality.md)
+
+
+</td><td>
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+_(Optional)_
+
+
+</td></tr>
+</tbody></table>
diff --git a/docs/search-headless.address.postalcode.md b/docs/search-headless.address.postalcode.md
@@ -4,7 +4,7 @@
 
 ## Address.postalCode property
 
-<b>Signature:</b>
+**Signature:**
 
 ```typescript
 postalCode?: string;

diff --git a/docs/search-headless.address.region.md b/docs/search-headless.address.region.md
@@ -4,7 +4,7 @@
 
 ## Address.region property
 
-<b>Signature:</b>
+**Signature:**
 
 ```typescript
 region?: string;

diff --git a/docs/search-headless.address.sublocality.md b/docs/search-headless.address.sublocality.md
@@ -4,7 +4,7 @@
 
 ## Address.sublocality property
 
-<b>Signature:</b>
+**Signature:**
 
 ```typescript
 sublocality?: string;

diff --git a/docs/search-headless.addressdirectanswer.fieldtype.md b/docs/search-headless.addressdirectanswer.fieldtype.md
@@ -4,7 +4,7 @@
 
 ## AddressDirectAnswer.fieldType property
 
-<b>Signature:</b>
+**Signature:**
 
 ```typescript
 fieldType: EnumOrLiteral<BuiltInFieldType.Address>;