@yext/search-core/dist/esm/src/provideEndpoints.d.ts

Typescript Networking Library for the Yext Search API

import { Endpoints } from './models/core/Endpoints';
import { ServingConfig } from './models/core/SearchConfig';
export declare const defaultApiVersion = 20220511;
/**
 * Provides methods for getting various endpoints.
 *
 * @internal
 */
export declare class EndpointsFactory {
    private readonly environment;
    private readonly cloudRegion;
    private readonly cloudChoice;
    constructor(config?: ServingConfig);
    /** Provides the domain based on environment and cloud region. */
    getDomain(): string;
    /** Provides the cached domain based on environment and cloud region. */
    getCachedDomain(): string;
    /** Provides all endpoints based on environment and cloud region. */
    getEndpoints(): {
        universalSearch: string;
        verticalSearch: string;
        questionSubmission: string;
        status: string;
        universalAutocomplete: string;
        verticalAutocomplete: string;
        filterSearch: string;
        generativeDirectAnswer: string;
    };
    private isInternalTestEnvironment;
}
/**
 * The endpoints to use for sandbox experiences.
 *
 * @deprecated Set the appropriate environment and cloud region in {@link ServingConfig} instead.
 *
 * @public
 */
export declare const SandboxEndpoints: Required<Endpoints>;