Merge 2f43546 into 3183412

docs/search-core.endpointsprovider._constructor_.md

@@ -0,0 +1,22 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@yext/search-core](./search-core.md) &gt; [EndpointsProvider](./search-core.endpointsprovider.md) &gt; [(constructor)](./search-core.endpointsprovider._constructor_.md)
+
+## EndpointsProvider.(constructor)
+
+Constructs a new instance of the `EndpointsProvider` class
+
+<b>Signature:</b>
+
+```typescript
+constructor(environment?: Environment, cloudRegion?: CloudRegion, overrideEndpoints?: Endpoints);
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  environment | Environment |  |
+|  cloudRegion | CloudRegion |  |
+|  overrideEndpoints | [Endpoints](./search-core.endpoints.md) |  |
+

docs/search-core.endpointsprovider.getendpoints.md

@@ -0,0 +1,29 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@yext/search-core](./search-core.md) &gt; [EndpointsProvider](./search-core.endpointsprovider.md) &gt; [getEndpoints](./search-core.endpointsprovider.getendpoints.md)
+
+## EndpointsProvider.getEndpoints() method
+
+Provides all endpoints based on environment and cloud region. Include any custom overrides in overrideEndpoints.
+
+<b>Signature:</b>
+
+```typescript
+getEndpoints(): {
+        universalSearch: string;
+        verticalSearch: string;
+        questionSubmission: string;
+        status: string;
+        universalAutocomplete: string;
+        verticalAutocomplete: string;
+        filterSearch: string;
+    };
+```
+<b>Returns:</b>
+
+{ universalSearch: string; verticalSearch: string; questionSubmission: string; status: string; universalAutocomplete: string; verticalAutocomplete: string; filterSearch: string; }
+
+## Remarks
+
+Returns an [Endpoints](./search-core.endpoints.md) instance.
+

docs/search-core.endpointsprovider.getfiltersearchendpoint.md

@@ -0,0 +1,17 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@yext/search-core](./search-core.md) &gt; [EndpointsProvider](./search-core.endpointsprovider.md) &gt; [getFilterSearchEndpoint](./search-core.endpointsprovider.getfiltersearchendpoint.md)
+
+## EndpointsProvider.getFilterSearchEndpoint() method
+
+Returns the endpoint for filter search.
+
+<b>Signature:</b>
+
+```typescript
+getFilterSearchEndpoint(): string;
+```
+<b>Returns:</b>
+
+string
+

docs/search-core.endpointsprovider.getquestionsubmissionendpoint.md

@@ -0,0 +1,17 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@yext/search-core](./search-core.md) &gt; [EndpointsProvider](./search-core.endpointsprovider.md) &gt; [getQuestionSubmissionEndpoint](./search-core.endpointsprovider.getquestionsubmissionendpoint.md)
+
+## EndpointsProvider.getQuestionSubmissionEndpoint() method
+
+Returns the endpoint for question submission.
+
+<b>Signature:</b>
+
+```typescript
+getQuestionSubmissionEndpoint(): string;
+```
+<b>Returns:</b>
+
+string
+

docs/search-core.endpointsprovider.getstatusendpoint.md

@@ -0,0 +1,17 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@yext/search-core](./search-core.md) &gt; [EndpointsProvider](./search-core.endpointsprovider.md) &gt; [getStatusEndpoint](./search-core.endpointsprovider.getstatusendpoint.md)
+
+## EndpointsProvider.getStatusEndpoint() method
+
+Returns the endpoint for status.
+
+<b>Signature:</b>
+
+```typescript
+getStatusEndpoint(): string;
+```
+<b>Returns:</b>
+
+string
+

docs/search-core.endpointsprovider.getuniversalautocomplete.md

@@ -0,0 +1,17 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@yext/search-core](./search-core.md) &gt; [EndpointsProvider](./search-core.endpointsprovider.md) &gt; [getUniversalAutocomplete](./search-core.endpointsprovider.getuniversalautocomplete.md)
+
+## EndpointsProvider.getUniversalAutocomplete() method
+
+Returns the endpoint for universal autocomplete.
+
+<b>Signature:</b>
+
+```typescript
+getUniversalAutocomplete(): string;
+```
+<b>Returns:</b>
+
+string
+

docs/search-core.endpointsprovider.getuniversalsearchendpoint.md

@@ -0,0 +1,17 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@yext/search-core](./search-core.md) &gt; [EndpointsProvider](./search-core.endpointsprovider.md) &gt; [getUniversalSearchEndpoint](./search-core.endpointsprovider.getuniversalsearchendpoint.md)
+
+## EndpointsProvider.getUniversalSearchEndpoint() method
+
+Returns the endpoint for universal search.
+
+<b>Signature:</b>
+
+```typescript
+getUniversalSearchEndpoint(): string;
+```
+<b>Returns:</b>
+
+string
+

docs/search-core.endpointsprovider.getverticalautocomplete.md

@@ -0,0 +1,17 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@yext/search-core](./search-core.md) &gt; [EndpointsProvider](./search-core.endpointsprovider.md) &gt; [getVerticalAutocomplete](./search-core.endpointsprovider.getverticalautocomplete.md)
+
+## EndpointsProvider.getVerticalAutocomplete() method
+
+Returns the endpoint for vertical autocomplete.
+
+<b>Signature:</b>
+
+```typescript
+getVerticalAutocomplete(): string;
+```
+<b>Returns:</b>
+
+string
+

docs/search-core.endpointsprovider.getverticalsearchendpoint.md

@@ -0,0 +1,17 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@yext/search-core](./search-core.md) &gt; [EndpointsProvider](./search-core.endpointsprovider.md) &gt; [getVerticalSearchEndpoint](./search-core.endpointsprovider.getverticalsearchendpoint.md)
+
+## EndpointsProvider.getVerticalSearchEndpoint() method
+
+Returns the endpoint for vertical search.
+
+<b>Signature:</b>
+
+```typescript
+getVerticalSearchEndpoint(): string;
+```
+<b>Returns:</b>
+
+string
+

docs/search-core.endpointsprovider.md

@@ -0,0 +1,33 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@yext/search-core](./search-core.md) &gt; [EndpointsProvider](./search-core.endpointsprovider.md)
+
+## EndpointsProvider class
+
+Provides methods for getting various endpoints.
+
+<b>Signature:</b>
+
+```typescript
+export declare class EndpointsProvider 
+```
+
+## Constructors
+
+|  Constructor | Modifiers | Description |
+|  --- | --- | --- |
+|  [(constructor)(environment, cloudRegion, overrideEndpoints)](./search-core.endpointsprovider._constructor_.md) |  | Constructs a new instance of the <code>EndpointsProvider</code> class |
+
+## Methods
+
+|  Method | Modifiers | Description |
+|  --- | --- | --- |
+|  [getEndpoints()](./search-core.endpointsprovider.getendpoints.md) |  | Provides all endpoints based on environment and cloud region. Include any custom overrides in overrideEndpoints. |
+|  [getFilterSearchEndpoint()](./search-core.endpointsprovider.getfiltersearchendpoint.md) |  | Returns the endpoint for filter search. |
+|  [getQuestionSubmissionEndpoint()](./search-core.endpointsprovider.getquestionsubmissionendpoint.md) |  | Returns the endpoint for question submission. |
+|  [getStatusEndpoint()](./search-core.endpointsprovider.getstatusendpoint.md) |  | Returns the endpoint for status. |
+|  [getUniversalAutocomplete()](./search-core.endpointsprovider.getuniversalautocomplete.md) |  | Returns the endpoint for universal autocomplete. |
+|  [getUniversalSearchEndpoint()](./search-core.endpointsprovider.getuniversalsearchendpoint.md) |  | Returns the endpoint for universal search. |
+|  [getVerticalAutocomplete()](./search-core.endpointsprovider.getverticalautocomplete.md) |  | Returns the endpoint for vertical autocomplete. |
+|  [getVerticalSearchEndpoint()](./search-core.endpointsprovider.getverticalsearchendpoint.md) |  | Returns the endpoint for vertical search. |
+

docs/search-core.md

@@ -8,6 +8,7 @@
 
 |  Class | Description |
 |  --- | --- |
+|  [EndpointsProvider](./search-core.endpointsprovider.md) | Provides methods for getting various endpoints. |
 |  [SearchCore](./search-core.searchcore.md) | Provides methods for executing searches, submitting questions, and performing autocompletes. |
 |  [SearchError](./search-core.searcherror.md) | Represents an error |
 

docs/search-core.sandboxendpoints.md

@@ -4,6 +4,11 @@
 
 ## SandboxEndpoints variable
 
+> Warning: This API is now obsolete.
+> 
+> Use [EndpointsProvider](./search-core.endpointsprovider.md) instead
+> 
+
 The endpoints to use for sandbox experiences.
 
 <b>Signature:</b>

etc/search-core.api.md

@@ -263,6 +263,31 @@ export interface Endpoints {
     verticalSearch?: string;
 }
 
+// @public
+export class EndpointsProvider {
+    // Warning: (ae-forgotten-export) The symbol "Environment" needs to be exported by the entry point index.d.ts
+    // Warning: (ae-forgotten-export) The symbol "CloudRegion" needs to be exported by the entry point index.d.ts
+    constructor(environment?: Environment, cloudRegion?: CloudRegion, overrideEndpoints?: Endpoints);
+    // @internal (undocumented)
+    getDomain(): string;
+    getEndpoints(): {
+        universalSearch: string;
+        verticalSearch: string;
+        questionSubmission: string;
+        status: string;
+        universalAutocomplete: string;
+        verticalAutocomplete: string;
+        filterSearch: string;
+    };
+    getFilterSearchEndpoint(): string;
+    getQuestionSubmissionEndpoint(): string;
+    getStatusEndpoint(): string;
+    getUniversalAutocomplete(): string;
+    getUniversalSearchEndpoint(): string;
+    getVerticalAutocomplete(): string;
+    getVerticalSearchEndpoint(): string;
+}
+
 // @public
 export type EnumOrLiteral<T extends string> = T | `${T}`;
 
@@ -581,7 +606,7 @@ export interface RichTextSnippetDirectAnswer extends Omit<BaseFeaturedSnippetDir
     fieldType: EnumOrLiteral<BuiltInFieldType.RichText>;
 }
 
-// @public
+// @public @deprecated
 export const SandboxEndpoints: Required<Endpoints>;
 
 // @public