Version 1.7.0 (#169)

## Version 1.7.0 ### Features - Added support for `failedVerticals` in universal search responses (#164) - Export LiveApi Sandbox endpoints (#165) - Added support for the `excluded` param in filter search requests (#166)
yext · Jun 16, 2022 · 930f0a7 · 930f0a7
2 parents 1e5b3fe + dc83672
commit 930f0a7
Show file tree

Hide file tree

Showing 38 changed files with 14,944 additions and 10,382 deletions.
diff --git a/docs/answers-core.errortype.md b/docs/answers-core.errortype.md
@@ -0,0 +1,23 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@yext/answers-core](./answers-core.md) &gt; [ErrorType](./answers-core.errortype.md)
+
+## ErrorType enum
+
+Identifier for the type of error causing the failure.
+
+<b>Signature:</b>
+
+```typescript
+export declare enum ErrorType 
+```
+
+## Enumeration Members
+
+|  Member | Value | Description |
+|  --- | --- | --- |
+|  BackendError | <code>&quot;BACKEND_ERROR&quot;</code> | An internal error from the API backend. |
+|  InvalidConfig | <code>&quot;INVALID_CONFIG&quot;</code> | An invalid config from the request. |
+|  InvalidQuery | <code>&quot;INVALID_QUERY&quot;</code> | An invalid query from the request. |
+|  Timeout | <code>&quot;TIMEOUT&quot;</code> | A timeout error from the server. |
+
diff --git a/docs/answers-core.failedvertical.details.md b/docs/answers-core.failedvertical.details.md
@@ -0,0 +1,16 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@yext/answers-core](./answers-core.md) &gt; [FailedVertical](./answers-core.failedvertical.md) &gt; [details](./answers-core.failedvertical.details.md)
+
+## FailedVertical.details property
+
+Detailed information about the error.
+
+<b>Signature:</b>
+
+```typescript
+details: {
+        responseCode: number;
+        description: string;
+    };
+```
diff --git a/docs/answers-core.failedvertical.errortype.md b/docs/answers-core.failedvertical.errortype.md
@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@yext/answers-core](./answers-core.md) &gt; [FailedVertical](./answers-core.failedvertical.md) &gt; [errorType](./answers-core.failedvertical.errortype.md)
+
+## FailedVertical.errorType property
+
+Identifier for the type of error causing the failure.
+
+<b>Signature:</b>
+
+```typescript
+errorType: ErrorType;
+```
diff --git a/docs/answers-core.failedvertical.md b/docs/answers-core.failedvertical.md
@@ -0,0 +1,23 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@yext/answers-core](./answers-core.md) &gt; [FailedVertical](./answers-core.failedvertical.md)
+
+## FailedVertical interface
+
+Error information from when a vertical fails to return results.
+
+<b>Signature:</b>
+
+```typescript
+export interface FailedVertical 
+```
+
+## Properties
+
+|  Property | Type | Description |
+|  --- | --- | --- |
+|  [details](./answers-core.failedvertical.details.md) | { responseCode: number; description: string; } | Detailed information about the error. |
+|  [errorType](./answers-core.failedvertical.errortype.md) | [ErrorType](./answers-core.errortype.md) | Identifier for the type of error causing the failure. |
+|  [queryDurationMillis](./answers-core.failedvertical.querydurationmillis.md) | number | The duration of the query in milliseconds. |
+|  [verticalKey](./answers-core.failedvertical.verticalkey.md) | string | The vertical key associated with the failed vertical. |
+
diff --git a/docs/answers-core.failedvertical.querydurationmillis.md b/docs/answers-core.failedvertical.querydurationmillis.md
@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@yext/answers-core](./answers-core.md) &gt; [FailedVertical](./answers-core.failedvertical.md) &gt; [queryDurationMillis](./answers-core.failedvertical.querydurationmillis.md)
+
+## FailedVertical.queryDurationMillis property
+
+The duration of the query in milliseconds.
+
+<b>Signature:</b>
+
+```typescript
+queryDurationMillis: number;
+```
diff --git a/docs/answers-core.failedvertical.verticalkey.md b/docs/answers-core.failedvertical.verticalkey.md
@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@yext/answers-core](./answers-core.md) &gt; [FailedVertical](./answers-core.failedvertical.md) &gt; [verticalKey](./answers-core.failedvertical.verticalkey.md)
+
+## FailedVertical.verticalKey property
+
+The vertical key associated with the failed vertical.
+
+<b>Signature:</b>
+
+```typescript
+verticalKey: string;
+```
diff --git a/docs/answers-core.filtersearchrequest.excluded.md b/docs/answers-core.filtersearchrequest.excluded.md
@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@yext/answers-core](./answers-core.md) &gt; [FilterSearchRequest](./answers-core.filtersearchrequest.md) &gt; [excluded](./answers-core.filtersearchrequest.excluded.md)
+
+## FilterSearchRequest.excluded property
+
+an array of filters that should be excluded from filter search results.
+
+<b>Signature:</b>
+
+```typescript
+excluded?: Filter[];
+```
diff --git a/docs/answers-core.filtersearchrequest.md b/docs/answers-core.filtersearchrequest.md
@@ -17,6 +17,7 @@ export interface FilterSearchRequest extends AnswersRequest
 
 |  Property | Type | Description |
 |  --- | --- | --- |
+|  [excluded?](./answers-core.filtersearchrequest.excluded.md) | [Filter](./answers-core.filter.md)<!-- -->\[\] | <i>(Optional)</i> an array of filters that should be excluded from filter search results. |
 |  [fields](./answers-core.filtersearchrequest.fields.md) | [SearchParameterField](./answers-core.searchparameterfield.md)<!-- -->\[\] | An array of [SearchParameterField](./answers-core.searchparameterfield.md) |
 |  [input](./answers-core.filtersearchrequest.input.md) | string | The input string for autocomplete. |
 |  [sectioned](./answers-core.filtersearchrequest.sectioned.md) | boolean | Determines whether or not the results of the [FilterSearchResponse](./answers-core.filtersearchresponse.md) are separated by field. |

diff --git a/docs/answers-core.md b/docs/answers-core.md
@@ -18,6 +18,7 @@
 |  [AppliedQueryFilterType](./answers-core.appliedqueryfiltertype.md) | Represents the type of [AppliedQueryFilter](./answers-core.appliedqueryfilter.md) applied to a search. |
 |  [DirectAnswerType](./answers-core.directanswertype.md) | Represents the type of direct answer. |
 |  [Direction](./answers-core.direction.md) | The direction of a sort. |
+|  [ErrorType](./answers-core.errortype.md) | Identifier for the type of error causing the failure. |
 |  [FilterCombinator](./answers-core.filtercombinator.md) | Indicates how the filters in a [CombinedFilter](./answers-core.combinedfilter.md) should be combined. |
 |  [LocationBiasMethod](./answers-core.locationbiasmethod.md) | The method used to determine the location. |
 |  [Matcher](./answers-core.matcher.md) | A Matcher is a filtering operation. |
@@ -55,6 +56,7 @@
 |  [Endpoints](./answers-core.endpoints.md) | Overrides for the URLs which are used when making requests to the Answers API. |
 |  [Facet](./answers-core.facet.md) | Represents dynamic filter options for the Answers API. |
 |  [FacetOption](./answers-core.facetoption.md) | A filter associated with the facet. |
+|  [FailedVertical](./answers-core.failedvertical.md) | Error information from when a vertical fails to return results. |
 |  [FeaturedSnippetDirectAnswer](./answers-core.featuredsnippetdirectanswer.md) | A direct answer which was found within a document. |
 |  [FieldValueDirectAnswer](./answers-core.fieldvaluedirectanswer.md) | A direct answer where the answer came from a field from the knowledge graph. |
 |  [Filter](./answers-core.filter.md) | Represents a filter which compares values to a single field. |
@@ -89,6 +91,12 @@
 |  [VerticalSearchResponse](./answers-core.verticalsearchresponse.md) | A representation of a response from a vertical search. |
 |  [Visitor](./answers-core.visitor.md) | Information used to associate requests with a particular user. |
 
+## Variables
+
+|  Variable | Description |
+|  --- | --- |
+|  [SandboxEndpoints](./answers-core.sandboxendpoints.md) | The endpoints to use for sandbox experiences. |
+
 ## Type Aliases
 
 |  Type Alias | Description |

diff --git a/docs/answers-core.sandboxendpoints.md b/docs/answers-core.sandboxendpoints.md
@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@yext/answers-core](./answers-core.md) &gt; [SandboxEndpoints](./answers-core.sandboxendpoints.md)
+
+## SandboxEndpoints variable
+
+The endpoints to use for sandbox experiences.
+
+<b>Signature:</b>
+
+```typescript
+SandboxEndpoints: Required<Endpoints>
+```
diff --git a/docs/answers-core.universalsearchresponse.failedverticals.md b/docs/answers-core.universalsearchresponse.failedverticals.md
@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@yext/answers-core](./answers-core.md) &gt; [UniversalSearchResponse](./answers-core.universalsearchresponse.md) &gt; [failedVerticals](./answers-core.universalsearchresponse.failedverticals.md)
+
+## UniversalSearchResponse.failedVerticals property
+
+Error information from when a vertical fails to return results.
+
+<b>Signature:</b>
+
+```typescript
+failedVerticals?: FailedVertical[];
+```
diff --git a/docs/answers-core.universalsearchresponse.md b/docs/answers-core.universalsearchresponse.md
@@ -17,6 +17,7 @@ export interface UniversalSearchResponse
 |  Property | Type | Description |
 |  --- | --- | --- |
 |  [directAnswer?](./answers-core.universalsearchresponse.directanswer.md) | [FeaturedSnippetDirectAnswer](./answers-core.featuredsnippetdirectanswer.md) \| [FieldValueDirectAnswer](./answers-core.fieldvaluedirectanswer.md) | <i>(Optional)</i> A direct answer to a search. |
+|  [failedVerticals?](./answers-core.universalsearchresponse.failedverticals.md) | [FailedVertical](./answers-core.failedvertical.md)<!-- -->\[\] | <i>(Optional)</i> Error information from when a vertical fails to return results. |
 |  [locationBias?](./answers-core.universalsearchresponse.locationbias.md) | [LocationBias](./answers-core.locationbias.md) | <i>(Optional)</i> Information about the user's location. |
 |  [queryId?](./answers-core.universalsearchresponse.queryid.md) | string | <i>(Optional)</i> The ID of the search query. |
 |  [queryRulesActionsData?](./answers-core.universalsearchresponse.queryrulesactionsdata.md) | [QueryRulesActionsData](./answers-core.queryrulesactionsdata.md)<!-- -->\[\] | <i>(Optional)</i> Data returned from the Answers query rules system. |

diff --git a/etc/answers-core.api.md b/etc/answers-core.api.md
@@ -176,6 +176,14 @@ export interface Endpoints {
     verticalSearch?: string;
 }
 
+// @public
+export enum ErrorType {
+    BackendError = "BACKEND_ERROR",
+    InvalidConfig = "INVALID_CONFIG",
+    InvalidQuery = "INVALID_QUERY",
+    Timeout = "TIMEOUT"
+}
+
 // @public
 export interface Facet {
     fieldId: string;
@@ -188,6 +196,17 @@ export interface FacetOption {
     value: string | number | boolean | NumberRangeValue;
 }
 
+// @public
+export interface FailedVertical {
+    details: {
+        responseCode: number;
+        description: string;
+    };
+    errorType: ErrorType;
+    queryDurationMillis: number;
+    verticalKey: string;
+}
+
 // @public
 export interface FeaturedSnippetDirectAnswer extends DirectAnswer {
     fieldType: string;
@@ -225,6 +244,7 @@ export enum FilterCombinator {
 
 // @public
 export interface FilterSearchRequest extends AnswersRequest {
+    excluded?: Filter[];
     fields: SearchParameterField[];
     input: string;
     sectioned: boolean;
@@ -388,6 +408,9 @@ export interface Result {
     source: Source;
 }
 
+// @public
+export const SandboxEndpoints: Required<Endpoints>;
+
 // @public
 export enum SearchIntent {
     NearMe = "NEAR_ME"
@@ -483,6 +506,7 @@ export interface UniversalSearchRequest extends AnswersRequest {
 // @public
 export interface UniversalSearchResponse {
     directAnswer?: FeaturedSnippetDirectAnswer | FieldValueDirectAnswer;
+    failedVerticals?: FailedVertical[];
     locationBias?: LocationBias;
     queryId?: string;
     queryRulesActionsData?: QueryRulesActionsData[];