replace AnswersRequest with SearchRequest

yext · Jul 5, 2022 · 737c7b0 · 737c7b0
1 parent b630524
commit 737c7b0
Show file tree

Hide file tree

Showing 7 changed files with 22 additions and 14 deletions.
diff --git a/src/models/autocompleteservice/AutocompleteRequest.ts b/src/models/autocompleteservice/AutocompleteRequest.ts
@@ -1,12 +1,12 @@
-import { AnswersRequest } from '../core/AnswersRequest';
+import { SearchRequest } from '../core/SearchRequest';
 import { Filter } from '../searchservice/request/Filter';
 
 /**
  * Options for a universal autocomplete request.
  *
  * @public
  */
-export interface UniversalAutocompleteRequest extends AnswersRequest {
+export interface UniversalAutocompleteRequest extends SearchRequest {
   /** The input string for autocomplete. */
   input: string,
   /** Enables session tracking. */
@@ -18,7 +18,7 @@ export interface UniversalAutocompleteRequest extends AnswersRequest {
  *
  * @public
  */
-export interface VerticalAutocompleteRequest extends AnswersRequest {
+export interface VerticalAutocompleteRequest extends SearchRequest {
   /** {@inheritDoc UniversalAutocompleteRequest.input} */
   input: string,
   /** {@inheritDoc UniversalAutocompleteRequest.sessionTrackingEnabled} */
@@ -32,7 +32,7 @@ export interface VerticalAutocompleteRequest extends AnswersRequest {
  *
  * @public
  */
-export interface FilterSearchRequest extends AnswersRequest {
+export interface FilterSearchRequest extends SearchRequest {
   /** {@inheritDoc UniversalAutocompleteRequest.input} */
   input: string,
   /** {@inheritDoc UniversalAutocompleteRequest.sessionTrackingEnabled} */

diff --git a/src/models/core/AnswersRequest.ts → src/models/core/SearchRequest.ts b/src/models/core/AnswersRequest.ts → src/models/core/SearchRequest.ts
@@ -1,11 +1,11 @@
 import { AdditionalHttpHeaders } from './AdditionalHttpHeaders';
 
 /**
- * Options for an Answers API request.
+ * Options for an Search API request.
  *
  * @public
  */
-export interface AnswersRequest {
+export interface SearchRequest {
   /** {@inheritDoc AdditionalHttpHeaders} */
   additionalHttpHeaders?: AdditionalHttpHeaders
 }
diff --git a/src/models/deprecated.ts b/src/models/deprecated.ts
@@ -1,7 +1,14 @@
 import { SearchError } from './answersapi/SearchError';
+import { SearchRequest } from './core/SearchRequest';
 
 /**
  * @deprecated AnswersError is deprecated and has been replaced by SearchError
  * @public
  */
-export type AnswersError = SearchError;
+export type AnswersError = SearchError;
+
+/**
+* @deprecated AnswersRequest is deprecated and has been replaced by SearchRequest
+* @public
+*/
+export type AnswersRequest = SearchRequest;
diff --git a/src/models/index.ts b/src/models/index.ts
@@ -1,5 +1,6 @@
 // deprecated symbols
 export { AnswersError } from './deprecated';
+export { AnswersRequest } from './deprecated';
 
 // Answers API models
 export { SearchError } from './answersapi/SearchError';
@@ -11,7 +12,7 @@ export {
   AnswersConfigWithApiKey,
   AnswersConfigWithToken
 } from './core/AnswersConfig';
-export { AnswersRequest } from './core/AnswersRequest';
+export { SearchRequest } from './core/SearchRequest';
 export { Endpoints } from './core/Endpoints';
 export { Visitor } from './core/Visitor';
 export {

diff --git a/src/models/questionsubmission/QuestionSubmissionRequest.ts b/src/models/questionsubmission/QuestionSubmissionRequest.ts
@@ -1,11 +1,11 @@
-import { AnswersRequest } from '../core/AnswersRequest';
+import { SearchRequest } from '../core/SearchRequest';
 
 /**
  * Options for a QuestionSubmission request.
  *
  * @public
  */
-export interface QuestionSubmissionRequest extends AnswersRequest {
+export interface QuestionSubmissionRequest extends SearchRequest {
   /** The email of the user that is submitting the question. */
   email: string,
   /** The ID of the entity to associate with the question. */

diff --git a/src/models/searchservice/request/UniversalSearchRequest.ts b/src/models/searchservice/request/UniversalSearchRequest.ts
@@ -3,14 +3,14 @@ import { LatLong } from './LatLong';
 import { QueryTrigger } from './QueryTrigger';
 import { QuerySource } from './QuerySource';
 import { UniversalLimit } from './UniversalLimit';
-import { AnswersRequest } from '../../core/AnswersRequest';
+import { SearchRequest } from '../../core/SearchRequest';
 
 /**
  * Options which can be specified for a universal search.
  *
  * @public
  */
-export interface UniversalSearchRequest extends AnswersRequest {
+export interface UniversalSearchRequest extends SearchRequest {
   /** The search query. */
   query: string,
   /** {@inheritDoc QueryTrigger} */

diff --git a/src/models/searchservice/request/VerticalSearchRequest.ts b/src/models/searchservice/request/VerticalSearchRequest.ts
@@ -6,14 +6,14 @@ import { QueryTrigger } from './QueryTrigger';
 import { SortBy } from './SortBy';
 import { QuerySource } from './QuerySource';
 import { Facet } from './Facet';
-import { AnswersRequest } from '../../core/AnswersRequest';
+import { SearchRequest } from '../../core/SearchRequest';
 
 /**
  * Options which can be specified for a vertical search.
  *
  * @public
  */
-export interface VerticalSearchRequest extends AnswersRequest {
+export interface VerticalSearchRequest extends SearchRequest {
   /** The search query. */
   query: string,
   /** The key associated with the vertical. */