From ef60f29639886c4e139b12007dc1ddb31b31ca90 Mon Sep 17 00:00:00 2001 From: Cindy Yang Date: Tue, 5 Jul 2022 14:23:00 -0400 Subject: [PATCH 01/22] Customer facing renaming --- README.md | 8 +-- package-lock.json | 4 +- package.json | 4 +- src/constants.ts | 2 +- src/headless-reducer-manager.ts | 2 +- src/http-manager.ts | 2 +- src/index.ts | 57 ++++++++++++------- src/models/state-manager.ts | 2 +- src/models/state.ts | 6 +- ...answers-headless.ts => search-headless.ts} | 6 +- ...swers-utilities.ts => search-utilities.ts} | 0 test-site-node/index.js | 4 +- tests/acceptance/multiple-instances.ts | 14 ++--- ...rsHeadless.ts => provideSearchHeadless.ts} | 6 +- tests/integration/query.ts | 4 +- tests/integration/redux-state-manager.ts | 12 ++-- tests/mocks/createMockedAnswersHeadless.ts | 6 +- tests/unit/answers-headless.ts | 4 +- tests/unit/index.ts | 16 +++--- 19 files changed, 89 insertions(+), 70 deletions(-) rename src/{answers-headless.ts => search-headless.ts} (99%) rename src/{answers-utilities.ts => search-utilities.ts} (100%) rename tests/acceptance/{provideAnswersHeadless.ts => provideSearchHeadless.ts} (79%) diff --git a/README.md b/README.md index 7e4f9638..2aecde82 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,8 @@ -# answers-headless -A library for powering UI components for Yext Answers integrations. +# search-headless +A library for powering UI components for Yext Search integrations. [Full Documentation](./docs/answers-headless.md) - - Coverage Status + + Coverage Status diff --git a/package-lock.json b/package-lock.json index 352178c2..935ddbaa 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,11 +1,11 @@ { - "name": "@yext/answers-headless", + "name": "@yext/search-headless", "version": "1.2.0", "lockfileVersion": 2, "requires": true, "packages": { "": { - "name": "@yext/answers-headless", + "name": "@yext/search-headless", "version": "1.2.0", "license": "ISC", "dependencies": { diff --git a/package.json b/package.json index 8bf8cd50..54aec867 100644 --- a/package.json +++ b/package.json @@ -1,5 +1,5 @@ { - "name": "@yext/answers-headless", + "name": "@yext/search-headless", "version": "1.2.0", "description": "", "author": "slapshot@yext.com", @@ -75,6 +75,6 @@ }, "repository": { "type": "git", - "url": "https://github.com/yext/answers-headless.git" + "url": "https://github.com/yext/search-headless.git" } } diff --git a/src/constants.ts b/src/constants.ts index 383569b7..25490d9a 100644 --- a/src/constants.ts +++ b/src/constants.ts @@ -1,5 +1,5 @@ /** - * The headlessId automatically given to the first AnswersHeadless instance created. + * The headlessId automatically given to the first SearchHeadless instance created. * * @public */ diff --git a/src/headless-reducer-manager.ts b/src/headless-reducer-manager.ts index 9962806e..7ad5ebde 100644 --- a/src/headless-reducer-manager.ts +++ b/src/headless-reducer-manager.ts @@ -25,7 +25,7 @@ export default class HeadlessReducerManager { } getParentReducer(): Reducer { - // set-state should only update the state tree for the AnswersHeadless instance + // set-state should only update the state tree for the SearchHeadless instance // that dispatched it const coreReducer = combineReducers(this.headlessIdToReducer); return (state, action) => { diff --git a/src/http-manager.ts b/src/http-manager.ts index 5023f618..1594081f 100644 --- a/src/http-manager.ts +++ b/src/http-manager.ts @@ -7,7 +7,7 @@ type ServiceIds = { /** * Assigns numeric IDs to every http request and the corresponding response * through {@link AnswersCore}. This helps track the received order of requests - * and responses. {@link AnswersHeadless} uses it to ensure dispatch events for + * and responses. {@link SearchHeadless} uses it to ensure dispatch events for * state updates are triggered with up-to-date responses (e.g. if the newly received * response has a higher ID number than the recorded received response). */ diff --git a/src/index.ts b/src/index.ts index f758814f..843d5e85 100644 --- a/src/index.ts +++ b/src/index.ts @@ -1,12 +1,12 @@ import { provideCore, AnswersConfig, AdditionalHttpHeaders } from '@yext/answers-core'; import HttpManager from './http-manager'; import ReduxStateManager from './redux-state-manager'; -import AnswersHeadless from './answers-headless'; +import SearchHeadless from './search-headless'; import { createBaseStore } from './store'; import HeadlessReducerManager from './headless-reducer-manager'; import { DEFAULT_HEADLESS_ID } from './constants'; import { SessionTrackingState } from './models/slices/sessiontracking'; -import * as answersUtilities from './answers-utilities'; +import * as searchUtilities from './search-utilities'; import { getHttpHeaders } from './utils/client-sdk-utils'; export * from './answers-core-re-exports'; @@ -14,16 +14,16 @@ export * from './models'; export * from './constants'; export * from './utils/filter-creators'; export * from './utils/types'; -export { answersUtilities }; +export { searchUtilities }; /** - * The configuration for an AnswersHeadless instance. + * The configuration for an SearchHeadless instance. * * @public */ export type HeadlessConfig = AnswersConfig & { /** - * The ID of the AnswersHeadless instance. + * The ID of the SearchHeadless instance. * * @remarks * Must be different from {@link DEFAULT_HEADLESS_ID}. @@ -36,50 +36,50 @@ export type HeadlessConfig = AnswersConfig & { verticalKey?: string }; -let firstHeadlessInstance: AnswersHeadless; +let firstHeadlessInstance: SearchHeadless; const store = createBaseStore(); const headlessReducerManager = new HeadlessReducerManager(); /** - * Supplies a new instance of {@link AnswersHeadless}, using the provided configuration. + * Supplies a new instance of {@link SearchHeadless}, using the provided configuration. * * @param config - The apiKey, experienceKey, etc. needed to set up a front-end Answers * experience. - * @returns The newly created instance of {@link AnswersHeadless} + * @returns The newly created instance of {@link SearchHeadless} * * @public */ -export function provideAnswersHeadless(config: HeadlessConfig): AnswersHeadless; +export function provideSearchHeadless(config: HeadlessConfig): SearchHeadless; /** - * Supplies a new instance of {@link AnswersHeadless}, using the provided configuration, + * Supplies a new instance of {@link SearchHeadless}, using the provided configuration, * and accepts additional HTTP headers to pass with API requests. * * @param config - The apiKey, experienceKey, etc. needed to set up a front-end Answers * experience * @param additionalHttpHeaders - Additional value for specific HTTP headers - * @returns The newly created instance of {@link AnswersHeadless} + * @returns The newly created instance of {@link SearchHeadless} * * @internal */ // eslint-disable-next-line @yext/export-star/no-duplicate-exports -export function provideAnswersHeadless( +export function provideSearchHeadless( config: HeadlessConfig, additionalHttpHeaders: AdditionalHttpHeaders -): AnswersHeadless; +): SearchHeadless; // eslint-disable-next-line @yext/export-star/no-duplicate-exports -export function provideAnswersHeadless( +export function provideSearchHeadless( config: HeadlessConfig, additionalHttpHeaders?: AdditionalHttpHeaders -): AnswersHeadless { +): SearchHeadless { const { verticalKey, headlessId, ...answersConfig } = config; if (headlessId === DEFAULT_HEADLESS_ID) { - throw new Error(`Cannot instantiate an AnswersHeadless using the default headlessId "${headlessId}". ` + throw new Error(`Cannot instantiate an SearchHeadless using the default headlessId "${headlessId}". ` + 'Specify a different headlessId.'); } const answersCore = provideCore(answersConfig); @@ -88,7 +88,7 @@ export function provideAnswersHeadless( const httpManager = new HttpManager(); const httpHeaders = getHttpHeaders(additionalHttpHeaders); - const headless = new AnswersHeadless(answersCore, stateManager, httpManager, httpHeaders); + const headless = new SearchHeadless(answersCore, stateManager, httpManager, httpHeaders); verticalKey ? headless.setVertical(verticalKey) : headless.setUniversal(); @@ -108,7 +108,7 @@ export function provideAnswersHeadless( * Links the secondHeadless instance to sessionTracking updates made to the firstHeadless * instance. */ -function linkSessionTracking(firstHeadless: AnswersHeadless, secondHeadless: AnswersHeadless) { +function linkSessionTracking(firstHeadless: SearchHeadless, secondHeadless: SearchHeadless) { firstHeadless.addListener({ valueAccessor: state => state.sessionTracking, callback: sessionTracking => { @@ -120,4 +120,23 @@ function linkSessionTracking(firstHeadless: AnswersHeadless, secondHeadless: Ans }); } -export { AnswersHeadless }; +export { SearchHeadless }; + +/** @deprecated answersUtilities has been deprecated and renamed to searchUtilities */ +export const answersUtilities = searchUtilities; + +/** + * Supplies a new instance of {@link SearchHeadless}, using the provided configuration. + * + * @param config - The apiKey, experienceKey, etc. needed to set up a front-end Answers + * experience. + * @returns The newly created instance of {@link SearchHeadless} + * + * @public + * + * @deprecated provideAnswersHeadless has been deprecated and renamed to provideSearchHeadless + */ +export const provideAnswersHeadless = provideSearchHeadless; + +/** @deprecated AnswersHeadless has been deprecated and renamed to SearchHeadless */ +export const AnswersHeadless = SearchHeadless; \ No newline at end of file diff --git a/src/models/state-manager.ts b/src/models/state-manager.ts index 99322870..c9676bc3 100644 --- a/src/models/state-manager.ts +++ b/src/models/state-manager.ts @@ -3,7 +3,7 @@ import { State } from './state'; import StateListener from './state-listener'; /** - * Manages the information contained in the state for an AnswersHeadless instance. + * Manages the information contained in the state for an SearchHeadless instance. * * @remarks * The {@link State} is immutable, and can only be updated by dispatched events. diff --git a/src/models/state.ts b/src/models/state.ts index 9a5a3ba9..e1d3fb2b 100644 --- a/src/models/state.ts +++ b/src/models/state.ts @@ -12,19 +12,19 @@ import { QueryRulesState } from './slices/queryrules'; /** * The overall shape of the redux state tree, with each key value pair of - * headlessId to {@link State} representing a single AnswersHeadless instance. + * headlessId to {@link State} representing a single SearchHeadless instance. * * @public */ export interface ParentState { /** - * A mapping of the ID of an AnswersHeadless instance to its {@link State}. + * A mapping of the ID of a SearchHeadless instance to its {@link State}. */ [headlessId: string]: State } /** - * The state representing an AnswersHeadless instance. + * The state representing a SearchHeadless instance. * * @public */ diff --git a/src/answers-headless.ts b/src/search-headless.ts similarity index 99% rename from src/answers-headless.ts rename to src/search-headless.ts index 7de3d686..d3d70f19 100644 --- a/src/answers-headless.ts +++ b/src/search-headless.ts @@ -24,7 +24,7 @@ import { State } from './models/state'; import StateManager from './models/state-manager'; import { Unsubscribe } from '@reduxjs/toolkit'; import HttpManager from './http-manager'; -import * as answersUtilities from './answers-utilities'; +import * as answersUtilities from './search-utilities'; import { SelectableFilter } from './models/utils/selectableFilter'; import { transformFiltersToCoreFormat } from './utils/transform-filters'; import { SearchTypeEnum } from './models/utils/searchType'; @@ -40,7 +40,7 @@ import { initialState as initialSearchStatusState } from './slices/searchstatus' * * @public */ -export default class AnswersHeadless { +export default class SearchHeadless { /** * Common utility functions for manipulating Answers-related data. */ @@ -262,7 +262,7 @@ export default class AnswersHeadless { } /** - * Gets the current state of the AnswersHeadless instance. + * Gets the current state of the SearchHeadless instance. */ get state(): State { return this.stateManager.getState(); diff --git a/src/answers-utilities.ts b/src/search-utilities.ts similarity index 100% rename from src/answers-utilities.ts rename to src/search-utilities.ts diff --git a/test-site-node/index.js b/test-site-node/index.js index a397c7d7..4760dc1c 100644 --- a/test-site-node/index.js +++ b/test-site-node/index.js @@ -1,6 +1,6 @@ -const { provideAnswersHeadless } = require('@yext/answers-headless'); +const { provideSearchHeadless } = require('@yext/search-headless'); -const answers = provideAnswersHeadless({ +const answers = provideSearchHeadless({ apiKey: '2d8c550071a64ea23e263118a2b0680b', experienceKey: 'slanswers', locale: 'en' diff --git a/tests/acceptance/multiple-instances.ts b/tests/acceptance/multiple-instances.ts index 2eed3529..e6be6d83 100644 --- a/tests/acceptance/multiple-instances.ts +++ b/tests/acceptance/multiple-instances.ts @@ -1,4 +1,4 @@ -import { provideAnswersHeadless } from '../../src'; +import { provideSearchHeadless } from '../../src'; import { DEFAULT_HEADLESS_ID } from '../../src/constants'; import { expectedInitialState } from '../mocks/expectedInitialState'; @@ -8,13 +8,13 @@ const config = { locale: 'en' }; -it('multiple AnswersHeadless instances link SessionTrackingState together', () => { - const firstHeadless = provideAnswersHeadless(config); - const secondHeadless = provideAnswersHeadless({ +it('multiple SearchHeadless instances link SessionTrackingState together', () => { + const firstHeadless = provideSearchHeadless(config); + const secondHeadless = provideSearchHeadless({ ...config, headlessId: 'second' }); - const thirdHeadless = provideAnswersHeadless({ + const thirdHeadless = provideSearchHeadless({ ...config, headlessId: 'third' }); @@ -49,9 +49,9 @@ it('multiple AnswersHeadless instances link SessionTrackingState together', () = it('an error is thrown if you manually specify a headlessId equal to the default id', () => { expect(() => { - provideAnswersHeadless({ + provideSearchHeadless({ ...config, headlessId: DEFAULT_HEADLESS_ID }); - }).toThrow('Cannot instantiate an AnswersHeadless using the default headlessId'); + }).toThrow('Cannot instantiate an SearchHeadless using the default headlessId'); }); \ No newline at end of file diff --git a/tests/acceptance/provideAnswersHeadless.ts b/tests/acceptance/provideSearchHeadless.ts similarity index 79% rename from tests/acceptance/provideAnswersHeadless.ts rename to tests/acceptance/provideSearchHeadless.ts index 1f136769..3cc2ca18 100644 --- a/tests/acceptance/provideAnswersHeadless.ts +++ b/tests/acceptance/provideSearchHeadless.ts @@ -1,4 +1,4 @@ -import { provideAnswersHeadless } from '../../src'; +import { provideSearchHeadless } from '../../src'; const baseConfig = { apiKey: 'api-key', @@ -7,7 +7,7 @@ const baseConfig = { }; it('if apiKey is passed into the headless config, the searchType is set to \'vertical\'', () => { - const headless = provideAnswersHeadless({ + const headless = provideSearchHeadless({ ...baseConfig, verticalKey: 'test' }); @@ -17,7 +17,7 @@ it('if apiKey is passed into the headless config, the searchType is set to \'ver }); it('if no apiKey is passed into the headless config, the searchType is \'universal\'', () => { - const headless = provideAnswersHeadless(baseConfig); + const headless = provideSearchHeadless(baseConfig); expect(headless.state.vertical.verticalKey).toBeUndefined(); expect(headless.state.meta.searchType).toEqual('universal'); diff --git a/tests/integration/query.ts b/tests/integration/query.ts index 9ce485b9..190eebdb 100644 --- a/tests/integration/query.ts +++ b/tests/integration/query.ts @@ -5,7 +5,7 @@ import { } from '@yext/answers-core'; import HttpManager from '../../src/http-manager'; import ReduxStateManager from '../../src/redux-state-manager'; -import AnswersHeadless from '../../src/answers-headless'; +import SearchHeadless from '../../src/search-headless'; import { createMockedAnswersHeadless } from '../mocks/createMockedAnswersHeadless'; import { createBaseStore } from '../../src/store'; import { DEFAULT_HEADLESS_ID } from '../../src/constants'; @@ -164,5 +164,5 @@ function getAnswersHeadless(requestsTime: { [x: string]: number }) { const stateManager = new ReduxStateManager( createBaseStore(), DEFAULT_HEADLESS_ID, new HeadlessReducerManager()); const httpManager = new HttpManager(); - return new AnswersHeadless(mockedCore, stateManager, httpManager); + return new SearchHeadless(mockedCore, stateManager, httpManager); } diff --git a/tests/integration/redux-state-manager.ts b/tests/integration/redux-state-manager.ts index 0f74b0dd..351ce0ca 100644 --- a/tests/integration/redux-state-manager.ts +++ b/tests/integration/redux-state-manager.ts @@ -1,7 +1,7 @@ import ReduxStateManager from '../../src/redux-state-manager'; import { createBaseStore } from '../../src/store'; import HeadlessReducerManager from '../../src/headless-reducer-manager'; -import AnswersHeadless from '../../src/answers-headless'; +import SearchHeadless from '../../src/search-headless'; import { expectedInitialState } from '../mocks/expectedInitialState'; import HttpManager from '../../src/http-manager'; import { AnswersCore } from '@yext/answers-core'; @@ -53,11 +53,11 @@ it('set-state actions are scoped to State subtrees respective to their ReduxStat }); }); -it('dispatching answers actions through AnswersHeadless', () => { +it('dispatching answers actions through SearchHeadless', () => { const store = createBaseStore(); const headlessReducerManager = new HeadlessReducerManager(); const stateManager = new ReduxStateManager(store, 'anId', headlessReducerManager); - const headless = new AnswersHeadless({} as AnswersCore, stateManager, new HttpManager()); + const headless = new SearchHeadless({} as AnswersCore, stateManager, new HttpManager()); headless.setQuery('yo'); expect(store.getState()).toEqual({ anId: { @@ -73,7 +73,7 @@ it('addListener works with multiple headless instances', () => { const store = createBaseStore(); const headlessReducerManager = new HeadlessReducerManager(); const stateManager = new ReduxStateManager(store, 'anId', headlessReducerManager); - const headless = new AnswersHeadless({} as AnswersCore, stateManager, new HttpManager()); + const headless = new SearchHeadless({} as AnswersCore, stateManager, new HttpManager()); const callback = jest.fn(); headless.addListener({ valueAccessor: state => state.query.input, @@ -92,12 +92,12 @@ it('addListener works with multiple headless instances', () => { it('addListener can be used to link together different headless instances', () => { const store = createBaseStore(); const headlessReducerManager = new HeadlessReducerManager(); - const firstHeadless = new AnswersHeadless( + const firstHeadless = new SearchHeadless( {} as AnswersCore, new ReduxStateManager(store, 'first', headlessReducerManager), new HttpManager() ); - const secondHeadless = new AnswersHeadless( + const secondHeadless = new SearchHeadless( {} as AnswersCore, new ReduxStateManager(store, 'second', headlessReducerManager), new HttpManager() diff --git a/tests/mocks/createMockedAnswersHeadless.ts b/tests/mocks/createMockedAnswersHeadless.ts index 829a777f..865e3d31 100644 --- a/tests/mocks/createMockedAnswersHeadless.ts +++ b/tests/mocks/createMockedAnswersHeadless.ts @@ -1,7 +1,7 @@ import HttpManager from '../../src/http-manager'; import { State } from '../../src/models/state'; import ReduxStateManager from '../../src/redux-state-manager'; -import AnswersHeadless from '../../src/answers-headless'; +import SearchHeadless from '../../src/search-headless'; import { createBaseStore, HeadlessEnhancedStore } from '../../src/store'; import { DEFAULT_HEADLESS_ID } from '../../src/constants'; import HeadlessReducerManager from '../../src/headless-reducer-manager'; @@ -20,11 +20,11 @@ export function createMockedAnswersHeadless( store?: HeadlessEnhancedStore, headlessReducerManager?: HeadlessReducerManager, httpManager?: HttpManager -): AnswersHeadless { +): SearchHeadless { const reduxStateManager = new ReduxStateManager( store || createBaseStore(), DEFAULT_HEADLESS_ID, headlessReducerManager || new HeadlessReducerManager()); const headlessHttpManager = httpManager || new HttpManager(); - const answers = new AnswersHeadless( + const answers = new SearchHeadless( mockedAnswersCore, reduxStateManager, headlessHttpManager, getHttpHeaders()); answers.setState({ ...answers.state, diff --git a/tests/unit/answers-headless.ts b/tests/unit/answers-headless.ts index 68fdf5e8..fabeb965 100644 --- a/tests/unit/answers-headless.ts +++ b/tests/unit/answers-headless.ts @@ -1,7 +1,7 @@ import { Matcher, QuerySource, QueryTrigger } from '@yext/answers-core'; import HttpManager from '../../src/http-manager'; import StateManager from '../../src/models/state-manager'; -import AnswersHeadless from '../../src/answers-headless'; +import SearchHeadless from '../../src/search-headless'; import { SelectableFilter } from '../../src/models/utils/selectableFilter'; import { State } from '../../src/models/state'; import { SearchTypeEnum } from '../../src/models/utils/searchType'; @@ -66,7 +66,7 @@ const mockedCore: any = { filterSearch: jest.fn(() => Promise.resolve({})) }; -const answers = new AnswersHeadless(mockedCore, mockedStateManager, new HttpManager()); +const answers = new SearchHeadless(mockedCore, mockedStateManager, new HttpManager()); describe('setters work as expected', () => { beforeEach(() => { diff --git a/tests/unit/index.ts b/tests/unit/index.ts index 697c10b0..9943d46b 100644 --- a/tests/unit/index.ts +++ b/tests/unit/index.ts @@ -1,7 +1,7 @@ -import { AnswersHeadless, provideAnswersHeadless } from '../../src'; +import { SearchHeadless, provideSearchHeadless } from '../../src'; import { getHttpHeaders } from '../../src/utils/client-sdk-utils'; -jest.mock('../../src/answers-headless.ts'); +jest.mock('../../src/search-headless.ts'); const baseConfig = { apiKey: 'api-key', @@ -11,22 +11,22 @@ const baseConfig = { const headlessVersionHeader = getHttpHeaders(); -it('provideAnswersHeadless passes Headless agent to AnswersHeadless', () => { - provideAnswersHeadless(baseConfig); +it('provideSearchHeadless passes Headless agent to SearchHeadless', () => { + provideSearchHeadless(baseConfig); - expect(AnswersHeadless).toHaveBeenLastCalledWith( + expect(SearchHeadless).toHaveBeenLastCalledWith( expect.anything(), expect.anything(), expect.anything(), headlessVersionHeader); }); -it('provideAnswersHeadless passes additional HTTP headers to AnswersHeadless', () => { +it('provideSearchHeadless passes additional HTTP headers to SearchHeadless', () => { const additionalHttpHeaders = { 'Client-SDK': { CUSTOM_TEST_SITE: 'test' } }; - provideAnswersHeadless(baseConfig, additionalHttpHeaders); + provideSearchHeadless(baseConfig, additionalHttpHeaders); - expect(AnswersHeadless).toHaveBeenLastCalledWith(expect.anything(), expect.anything(), expect.anything(), { + expect(SearchHeadless).toHaveBeenLastCalledWith(expect.anything(), expect.anything(), expect.anything(), { 'Client-SDK': { ...additionalHttpHeaders['Client-SDK'], ...headlessVersionHeader['Client-SDK'] From 62ab52d4de0bfd7ad6428d8d79872477a71b376c Mon Sep 17 00:00:00 2001 From: Cindy Yang Date: Wed, 6 Jul 2022 09:35:24 -0400 Subject: [PATCH 02/22] API extracted --- .../answers-headless.additionalhttpheaders.md | 20 - .../answers-headless.allresultsforvertical.md | 22 - ...-headless.allresultsforvertical.results.md | 13 - docs/answers-headless.answersconfig.md | 15 - ...nswers-headless.answersconfigwithapikey.md | 22 - ...-headless.answersconfigwithapikey.token.md | 13 - ...answers-headless.answersconfigwithtoken.md | 22 - ...wers-headless.answerscore._constructor_.md | 22 - docs/answers-headless.answerscore.md | 31 - ...ers-headless.answerscore.submitquestion.md | 28 - ...dless.answerscore.universalautocomplete.md | 28 - ...rs-headless.answerscore.universalsearch.md | 28 - ...adless.answerscore.verticalautocomplete.md | 28 - ...ers-headless.answerscore.verticalsearch.md | 28 - docs/answers-headless.answerserror.code.md | 13 - docs/answers-headless.answerserror.md | 27 - docs/answers-headless.answerserror.message.md | 13 - docs/answers-headless.answerserror.type.md | 13 - ...-headless.answersheadless._constructor_.md | 23 - ...ess.answersheadless.executefiltersearch.md | 28 - ...rsheadless.executeuniversalautocomplete.md | 19 - ...s.answersheadless.executeuniversalquery.md | 19 - ...ersheadless.executeverticalautocomplete.md | 19 - ...ss.answersheadless.executeverticalquery.md | 19 - docs/answers-headless.answersheadless.md | 62 -- ...rs-headless.answersheadless.resetfacets.md | 17 - ...answersheadless.setalternativeverticals.md | 24 - ...ers-headless.answersheadless.setcontext.md | 24 - ...wers-headless.answersheadless.setfacets.md | 24 - ...eadless.answersheadless.setfilteroption.md | 24 - ...wers-headless.answersheadless.setoffset.md | 24 - ...swers-headless.answersheadless.setquery.md | 24 - ...headless.answersheadless.setquerysource.md | 24 - ...eadless.answersheadless.setquerytrigger.md | 24 - ...less.answersheadless.setreferrerpageurl.md | 24 - ...ss.answersheadless.setrestrictverticals.md | 24 - ...s-headless.answersheadless.setsessionid.md | 24 - ...swersheadless.setsessiontrackingenabled.md | 24 - ...ers-headless.answersheadless.setsortbys.md | 24 - ...ss.answersheadless.setspellcheckenabled.md | 24 - ...swers-headless.answersheadless.setstate.md | 24 - ...adless.answersheadless.setstaticfilters.md | 24 - ...s-headless.answersheadless.setuniversal.md | 17 - ...dless.answersheadless.setuniversallimit.md | 24 - ...eadless.answersheadless.setuserlocation.md | 24 - ...adless.answersheadless.setverticallimit.md | 24 - .../answers-headless.answersheadless.state.md | 13 - ...headless.answersheadless.submitquestion.md | 26 - ...wers-headless.answersheadless.utilities.md | 13 - docs/answers-headless.answersrequest.md | 20 - docs/answers-headless.answersutilities.md | 13 - ...ers-headless.appliedqueryfilter.details.md | 13 - docs/answers-headless.appliedqueryfilter.md | 24 - ...nswers-headless.appliedqueryfilter.type.md | 13 - docs/answers-headless.autocompleteresponse.md | 23 - ...s-headless.autocompleteresponse.queryid.md | 13 - ...s-headless.autocompleteresponse.results.md | 13 - docs/answers-headless.autocompleteresult.md | 25 - ...headless.autocompleteresult.relateditem.md | 18 - ...adless.autocompleteservice.filtersearch.md | 24 - docs/answers-headless.autocompleteservice.md | 22 - ...tocompleteservice.universalautocomplete.md | 24 - ...utocompleteservice.verticalautocomplete.md | 24 - docs/answers-headless.baseanswersconfig.md | 24 - docs/answers-headless.boundedrange.md | 21 - docs/answers-headless.combinedfilter.md | 21 - docs/answers-headless.combinefilters.md | 28 - .../answers-headless.createdaterangefilter.md | 27 - docs/answers-headless.createnearmefilter.md | 26 - ...nswers-headless.createnumberrangefilter.md | 27 - docs/answers-headless.default_headless_id.md | 13 - docs/answers-headless.directanswer.md | 24 - docs/answers-headless.directanswer.type.md | 13 - docs/answers-headless.directanswer.value.md | 18 - docs/answers-headless.directanswerstate.md | 20 - ...swers-headless.displayablefacet.fieldid.md | 13 - docs/answers-headless.displayablefacet.md | 23 - ...swers-headless.displayablefacet.options.md | 13 - ...headless.displayablefacetoption.matcher.md | 13 - ...answers-headless.displayablefacetoption.md | 25 - ...answers-headless.endpoints.filtersearch.md | 11 - docs/answers-headless.endpoints.md | 26 - ...s-headless.endpoints.questionsubmission.md | 11 - docs/answers-headless.endpoints.status.md | 11 - ...eadless.endpoints.universalautocomplete.md | 11 - ...wers-headless.endpoints.universalsearch.md | 11 - ...headless.endpoints.verticalautocomplete.md | 11 - ...swers-headless.endpoints.verticalsearch.md | 11 - docs/answers-headless.facet.md | 21 - docs/answers-headless.facetoption.md | 21 - docs/answers-headless.failedvertical.md | 23 - ...s.featuredsnippetdirectanswer.fieldtype.md | 13 - ...rs-headless.featuredsnippetdirectanswer.md | 26 - ...aturedsnippetdirectanswer.relatedresult.md | 13 - ...ess.featuredsnippetdirectanswer.snippet.md | 13 - ...adless.featuredsnippetdirectanswer.type.md | 13 - ...dless.featuredsnippetdirectanswer.value.md | 18 - ...featuredsnippetdirectanswer.verticalkey.md | 13 - ...ess.fieldvaluedirectanswer.fieldapiname.md | 13 - ...adless.fieldvaluedirectanswer.fieldname.md | 13 - ...adless.fieldvaluedirectanswer.fieldtype.md | 13 - ...answers-headless.fieldvaluedirectanswer.md | 28 - ...ss.fieldvaluedirectanswer.relatedresult.md | 13 - ...rs-headless.fieldvaluedirectanswer.type.md | 13 - ...s-headless.fieldvaluedirectanswer.value.md | 18 - ...less.fieldvaluedirectanswer.verticalkey.md | 13 - docs/answers-headless.filter.md | 22 - ...ers-headless.filtersearchrequest.fields.md | 13 - ...wers-headless.filtersearchrequest.input.md | 13 - docs/answers-headless.filtersearchrequest.md | 26 - ...-headless.filtersearchrequest.sectioned.md | 13 - ...tersearchrequest.sessiontrackingenabled.md | 13 - docs/answers-headless.filtersearchresponse.md | 23 - ...s-headless.filtersearchresponse.queryid.md | 13 - docs/answers-headless.filtersstate.md | 21 - docs/answers-headless.filtertypes.md | 15 - docs/answers-headless.headlessconfig.md | 18 - docs/answers-headless.highlightedvalue.md | 21 - .../answers-headless.locationbias.latitude.md | 13 - ...answers-headless.locationbias.longitude.md | 13 - docs/answers-headless.locationbias.md | 23 - ...eadless.locationboundingbox.maxlatitude.md | 13 - ...adless.locationboundingbox.maxlongitude.md | 13 - docs/answers-headless.locationboundingbox.md | 23 - ...eadless.locationboundingbox.minlatitude.md | 13 - ...adless.locationboundingbox.minlongitude.md | 13 - ...headless.locationfilterdetails.latitude.md | 13 - ...eadless.locationfilterdetails.longitude.md | 13 - .../answers-headless.locationfilterdetails.md | 24 - ...eadless.locationfilterdetails.placename.md | 13 - docs/answers-headless.locationstate.md | 21 - ...-headless.lowernumberrangelimit.matcher.md | 13 - .../answers-headless.lowernumberrangelimit.md | 21 - ...rs-headless.lowernumberrangelimit.value.md | 13 - docs/answers-headless.md | 144 --- docs/answers-headless.metastate.md | 23 - docs/answers-headless.nearfiltervalue.lat.md | 13 - docs/answers-headless.nearfiltervalue.lng.md | 13 - docs/answers-headless.nearfiltervalue.md | 22 - docs/answers-headless.numberrangevalue.md | 21 - docs/answers-headless.parentstate.md | 13 - ...answers-headless.provideanswersheadless.md | 26 - ...wers-headless.queryrulesactionsdata.key.md | 13 - .../answers-headless.queryrulesactionsdata.md | 22 - docs/answers-headless.queryrulesstate.md | 20 - docs/answers-headless.querystate.md | 25 - ...less.questionsubmissionrequest.entityid.md | 13 - ...wers-headless.questionsubmissionrequest.md | 26 - ...headless.questionsubmissionrequest.name.md | 13 - ...onsubmissionrequest.questiondescription.md | 13 - ....questionsubmissionrequest.questiontext.md | 13 - ...ubmissionrequest.sessiontrackingenabled.md | 13 - ...eadless.questionsubmissionresponse.uuid.md | 13 - ...uestionsubmissionservice.submitquestion.md | 24 - docs/answers-headless.rangeboundary.md | 21 - docs/answers-headless.rangeboundary.value.md | 13 - ...swers-headless.result.highlightedfields.md | 13 - docs/answers-headless.result.md | 30 - docs/answers-headless.result.source.md | 13 - ...less.searchparameterfield.fetchentities.md | 13 - docs/answers-headless.searchparameterfield.md | 22 - docs/answers-headless.searchservice.md | 21 - ...s-headless.searchservice.verticalsearch.md | 24 - docs/answers-headless.searchstatusstate.md | 20 - ...s-headless.selectablefilter.displayname.md | 13 - docs/answers-headless.selectablefilter.md | 22 - docs/answers-headless.sessiontrackingstate.md | 21 - docs/answers-headless.snippet.md | 21 - docs/answers-headless.sortby.field.md | 13 - docs/answers-headless.sortby.md | 26 - docs/answers-headless.spellcheck.md | 22 - docs/answers-headless.state.md | 30 - docs/answers-headless.statelistener.md | 21 - .../answers-headless.statemanager.getstate.md | 17 - docs/answers-headless.statemanager.md | 26 - ...less.universalautocompleterequest.input.md | 13 - ...s-headless.universalautocompleterequest.md | 22 - ...ocompleterequest.sessiontrackingenabled.md | 13 - ...answers-headless.universalsearchrequest.md | 31 - ...s-headless.universalsearchrequest.query.md | 13 - ...salsearchrequest.sessiontrackingenabled.md | 13 - ...s.universalsearchrequest.skipspellcheck.md | 13 - ...ss.universalsearchresponse.locationbias.md | 13 - ...nswers-headless.universalsearchresponse.md | 28 - ...eadless.universalsearchresponse.queryid.md | 13 - ...s.universalsearchresponse.searchintents.md | 13 - ...less.universalsearchresponse.spellcheck.md | 13 - ...s-headless.universalsearchresponse.uuid.md | 13 - ...universalsearchresponse.verticalresults.md | 13 - docs/answers-headless.universalsearchstate.md | 22 - ...-headless.uppernumberrangelimit.matcher.md | 13 - .../answers-headless.uppernumberrangelimit.md | 21 - ...rs-headless.uppernumberrangelimit.value.md | 13 - ...dless.verticalautocompleterequest.input.md | 13 - ...rs-headless.verticalautocompleterequest.md | 23 - ...ocompleterequest.sessiontrackingenabled.md | 13 - ...ess.verticalresults.appliedqueryfilters.md | 13 - docs/answers-headless.verticalresults.md | 25 - ...nswers-headless.verticalresults.results.md | 13 - ...answers-headless.verticalresults.source.md | 13 - ...s-headless.verticalsearchrequest.facets.md | 13 - .../answers-headless.verticalsearchrequest.md | 38 - ...rs-headless.verticalsearchrequest.query.md | 13 - ...ss.verticalsearchrequest.retrievefacets.md | 13 - ...calsearchrequest.sessiontrackingenabled.md | 13 - ...ss.verticalsearchrequest.skipspellcheck.md | 13 - ...-headless.verticalsearchrequest.sortbys.md | 13 - ...dless.verticalsearchrequest.verticalkey.md | 13 - ...icalsearchresponse.alternativeverticals.md | 13 - ...-headless.verticalsearchresponse.facets.md | 13 - ...ess.verticalsearchresponse.locationbias.md | 13 - ...answers-headless.verticalsearchresponse.md | 30 - ...headless.verticalsearchresponse.queryid.md | 13 - ...ss.verticalsearchresponse.searchintents.md | 13 - ...rs-headless.verticalsearchresponse.uuid.md | 13 - ...eadless.verticalsearchstate.displayname.md | 13 - docs/answers-headless.verticalsearchstate.md | 30 - ...rs-headless.verticalsearchstate.results.md | 13 - ...eadless.verticalsearchstate.verticalkey.md | 13 - docs/index.md | 2 +- ...ess.additionalhttpheaders._client-sdk_.md} | 2 +- docs/search-headless.additionalhttpheaders.md | 20 + ...-headless.allresultsforvertical.facets.md} | 2 +- docs/search-headless.allresultsforvertical.md | 22 + ...-headless.allresultsforvertical.results.md | 13 + ...ess.allresultsforvertical.resultscount.md} | 2 +- docs/search-headless.answersconfig.md | 15 + ...eadless.answersconfigwithapikey.apikey.md} | 2 +- ...search-headless.answersconfigwithapikey.md | 22 + ...-headless.answersconfigwithapikey.token.md | 13 + ...headless.answersconfigwithtoken.apikey.md} | 2 +- .../search-headless.answersconfigwithtoken.md | 22 + ...-headless.answersconfigwithtoken.token.md} | 2 +- ...arch-headless.answerscore._constructor_.md | 22 + ...arch-headless.answerscore.filtersearch.md} | 8 +- docs/search-headless.answerscore.md | 31 + ...rch-headless.answerscore.submitquestion.md | 28 + ...dless.answerscore.universalautocomplete.md | 28 + ...ch-headless.answerscore.universalsearch.md | 28 + ...adless.answerscore.verticalautocomplete.md | 28 + ...rch-headless.answerscore.verticalsearch.md | 28 + docs/search-headless.answerserror.code.md | 13 + docs/search-headless.answerserror.md | 27 + docs/search-headless.answerserror.message.md | 13 + docs/search-headless.answerserror.type.md | 13 + docs/search-headless.answersheadless.md | 16 + ...s.answersrequest.additionalhttpheaders.md} | 2 +- docs/search-headless.answersrequest.md | 20 + docs/search-headless.answersutilities.md | 16 + ...rch-headless.appliedqueryfilter.details.md | 13 + ...headless.appliedqueryfilter.displaykey.md} | 2 +- ...adless.appliedqueryfilter.displayvalue.md} | 2 +- ...rch-headless.appliedqueryfilter.filter.md} | 2 +- docs/search-headless.appliedqueryfilter.md | 24 + ...search-headless.appliedqueryfilter.type.md | 13 + ...search-headless.appliedqueryfiltertype.md} | 4 +- ...less.autocompleteresponse.inputintents.md} | 2 +- docs/search-headless.autocompleteresponse.md | 23 + ...h-headless.autocompleteresponse.queryid.md | 13 + ...h-headless.autocompleteresponse.results.md | 13 + ...rch-headless.autocompleteresponse.uuid.md} | 2 +- ...rch-headless.autocompleteresult.filter.md} | 2 +- ...search-headless.autocompleteresult.key.md} | 2 +- ...s.autocompleteresult.matchedsubstrings.md} | 2 +- docs/search-headless.autocompleteresult.md | 25 + ...headless.autocompleteresult.relateditem.md | 18 + ...arch-headless.autocompleteresult.value.md} | 2 +- ...adless.autocompleteresult.verticalkeys.md} | 2 +- ...adless.autocompleteservice.filtersearch.md | 24 + docs/search-headless.autocompleteservice.md | 22 + ...tocompleteservice.universalautocomplete.md | 24 + ...utocompleteservice.verticalautocomplete.md | 24 + ...h-headless.baseanswersconfig.endpoints.md} | 2 +- ...adless.baseanswersconfig.experiencekey.md} | 2 +- ...ss.baseanswersconfig.experienceversion.md} | 2 +- ...arch-headless.baseanswersconfig.locale.md} | 2 +- docs/search-headless.baseanswersconfig.md | 24 + ...rch-headless.baseanswersconfig.visitor.md} | 2 +- ...md => search-headless.boundedrange.max.md} | 2 +- docs/search-headless.boundedrange.md | 21 + ...md => search-headless.boundedrange.min.md} | 2 +- ...ess.clientsdkheadervalues.answers_core.md} | 2 +- ... search-headless.clientsdkheadervalues.md} | 4 +- ...rch-headless.combinedfilter.combinator.md} | 2 +- ...search-headless.combinedfilter.filters.md} | 2 +- docs/search-headless.combinedfilter.md | 21 + docs/search-headless.combinefilters.md | 28 + ....context.md => search-headless.context.md} | 2 +- docs/search-headless.createdaterangefilter.md | 27 + ... => search-headless.createequalsfilter.md} | 8 +- docs/search-headless.createnearmefilter.md | 26 + ...search-headless.createnumberrangefilter.md | 27 + docs/search-headless.default_headless_id.md | 13 + ...search-headless.directanswer.fieldtype.md} | 2 +- docs/search-headless.directanswer.md | 24 + ...ch-headless.directanswer.relatedresult.md} | 2 +- docs/search-headless.directanswer.type.md | 13 + docs/search-headless.directanswer.value.md | 18 + ...arch-headless.directanswer.verticalkey.md} | 2 +- docs/search-headless.directanswerstate.md | 20 + ...arch-headless.directanswerstate.result.md} | 2 +- ...md => search-headless.directanswertype.md} | 6 +- ...ection.md => search-headless.direction.md} | 2 +- ...-headless.displayablefacet.displayname.md} | 2 +- ...earch-headless.displayablefacet.fieldid.md | 13 + docs/search-headless.displayablefacet.md | 23 + ...earch-headless.displayablefacet.options.md | 13 + ...-headless.displayablefacetoption.count.md} | 2 +- ...ess.displayablefacetoption.displayname.md} | 2 +- ...headless.displayablefacetoption.matcher.md | 13 + .../search-headless.displayablefacetoption.md | 25 + ...adless.displayablefacetoption.selected.md} | 2 +- ...-headless.displayablefacetoption.value.md} | 2 +- .../search-headless.endpoints.filtersearch.md | 11 + docs/search-headless.endpoints.md | 26 + ...h-headless.endpoints.questionsubmission.md | 11 + docs/search-headless.endpoints.status.md | 11 + ...eadless.endpoints.universalautocomplete.md | 11 + ...arch-headless.endpoints.universalsearch.md | 11 + ...headless.endpoints.verticalautocomplete.md | 11 + ...earch-headless.endpoints.verticalsearch.md | 11 + ...al.md => search-headless.enumorliteral.md} | 2 +- ...ortype.md => search-headless.errortype.md} | 2 +- ...id.md => search-headless.facet.fieldid.md} | 2 +- docs/search-headless.facet.md | 21 + ...ns.md => search-headless.facet.options.md} | 4 +- ...=> search-headless.facetoption.matcher.md} | 2 +- docs/search-headless.facetoption.md | 21 + ...d => search-headless.facetoption.value.md} | 2 +- ...search-headless.failedvertical.details.md} | 2 +- ...arch-headless.failedvertical.errortype.md} | 2 +- docs/search-headless.failedvertical.md | 23 + ...ess.failedvertical.querydurationmillis.md} | 2 +- ...ch-headless.failedvertical.verticalkey.md} | 2 +- ...s.featuredsnippetdirectanswer.fieldtype.md | 13 + ...ch-headless.featuredsnippetdirectanswer.md | 26 + ...aturedsnippetdirectanswer.relatedresult.md | 13 + ...ess.featuredsnippetdirectanswer.snippet.md | 13 + ...adless.featuredsnippetdirectanswer.type.md | 13 + ...dless.featuredsnippetdirectanswer.value.md | 18 + ...featuredsnippetdirectanswer.verticalkey.md | 13 + ...less.fieldvaluedirectanswer.entityname.md} | 2 +- ...ess.fieldvaluedirectanswer.fieldapiname.md | 13 + ...adless.fieldvaluedirectanswer.fieldname.md | 13 + ...adless.fieldvaluedirectanswer.fieldtype.md | 13 + .../search-headless.fieldvaluedirectanswer.md | 28 + ...ss.fieldvaluedirectanswer.relatedresult.md | 13 + ...ch-headless.fieldvaluedirectanswer.type.md | 13 + ...h-headless.fieldvaluedirectanswer.value.md | 18 + ...less.fieldvaluedirectanswer.verticalkey.md | 13 + ...d.md => search-headless.filter.fieldid.md} | 2 +- ...r.md => search-headless.filter.matcher.md} | 2 +- docs/search-headless.filter.md | 22 + ...lue.md => search-headless.filter.value.md} | 2 +- ...md => search-headless.filtercombinator.md} | 4 +- ...-headless.filtersearchrequest.excluded.md} | 2 +- ...rch-headless.filtersearchrequest.fields.md | 13 + ...arch-headless.filtersearchrequest.input.md | 13 + docs/search-headless.filtersearchrequest.md | 26 + ...-headless.filtersearchrequest.sectioned.md | 13 + ...tersearchrequest.sessiontrackingenabled.md | 13 + ...adless.filtersearchrequest.verticalkey.md} | 2 +- ...adless.filtersearchresponse.businessid.md} | 2 +- docs/search-headless.filtersearchresponse.md | 23 + ...h-headless.filtersearchresponse.queryid.md | 13 + ...headless.filtersearchresponse.sections.md} | 2 +- ...rch-headless.filtersearchresponse.uuid.md} | 2 +- ...=> search-headless.filtersstate.facets.md} | 2 +- docs/search-headless.filtersstate.md | 21 + ...=> search-headless.filtersstate.static.md} | 2 +- docs/search-headless.filtertypes.md | 15 + docs/search-headless.headlessconfig.md | 18 + ...d => search-headless.highlightedfields.md} | 6 +- ...ess.highlightedvalue.matchedsubstrings.md} | 2 +- docs/search-headless.highlightedvalue.md | 21 + ...search-headless.highlightedvalue.value.md} | 2 +- ...md => search-headless.latlong.latitude.md} | 2 +- ...d => search-headless.latlong.longitude.md} | 2 +- ....latlong.md => search-headless.latlong.md} | 6 +- ...arch-headless.locationbias.displayname.md} | 2 +- docs/search-headless.locationbias.latitude.md | 13 + .../search-headless.locationbias.longitude.md | 13 + docs/search-headless.locationbias.md | 23 + ...=> search-headless.locationbias.method.md} | 2 +- ... => search-headless.locationbiasmethod.md} | 2 +- ...eadless.locationboundingbox.maxlatitude.md | 13 + ...adless.locationboundingbox.maxlongitude.md | 13 + docs/search-headless.locationboundingbox.md | 23 + ...eadless.locationboundingbox.minlatitude.md | 13 + ...adless.locationboundingbox.minlongitude.md | 13 + ...less.locationfilterdetails.boundingbox.md} | 2 +- ...ess.locationfilterdetails.featuretypes.md} | 2 +- ...headless.locationfilterdetails.latitude.md | 13 + ...eadless.locationfilterdetails.longitude.md | 13 + docs/search-headless.locationfilterdetails.md | 24 + ...eadless.locationfilterdetails.placename.md | 13 + ...ch-headless.locationstate.locationbias.md} | 2 +- docs/search-headless.locationstate.md | 21 + ...ch-headless.locationstate.userlocation.md} | 2 +- ...-headless.lowernumberrangelimit.matcher.md | 13 + docs/search-headless.lowernumberrangelimit.md | 21 + ...ch-headless.lowernumberrangelimit.value.md | 13 + ....matcher.md => search-headless.matcher.md} | 2 +- docs/search-headless.md | 147 ++++ ...d => search-headless.metastate.context.md} | 2 +- docs/search-headless.metastate.md | 23 + ...rch-headless.metastate.referrerpageurl.md} | 2 +- ...> search-headless.metastate.searchtype.md} | 2 +- ...d.md => search-headless.metastate.uuid.md} | 2 +- docs/search-headless.nearfiltervalue.lat.md | 13 + docs/search-headless.nearfiltervalue.lng.md | 13 + docs/search-headless.nearfiltervalue.md | 22 + ...search-headless.nearfiltervalue.radius.md} | 2 +- ...> search-headless.numberrangevalue.end.md} | 2 +- docs/search-headless.numberrangevalue.md | 21 + ...search-headless.numberrangevalue.start.md} | 2 +- docs/search-headless.parentstate.md | 13 + .../search-headless.provideanswersheadless.md | 18 + docs/search-headless.providesearchheadless.md | 26 + ...ch-headless.queryrulesactionsdata.data.md} | 2 +- ...-headless.queryrulesactionsdata.errors.md} | 2 +- ...arch-headless.queryrulesactionsdata.key.md | 13 + docs/search-headless.queryrulesactionsdata.md | 22 + ...earch-headless.queryrulesstate.actions.md} | 2 +- docs/search-headless.queryrulesstate.md | 20 + ...urce.md => search-headless.querysource.md} | 2 +- ...md => search-headless.querystate.input.md} | 2 +- docs/search-headless.querystate.md | 25 + ...h-headless.querystate.mostrecentsearch.md} | 2 +- ... => search-headless.querystate.queryid.md} | 2 +- ...search-headless.querystate.querysource.md} | 2 +- ...earch-headless.querystate.querytrigger.md} | 2 +- ...arch-headless.querystate.searchintents.md} | 2 +- ...ger.md => search-headless.querytrigger.md} | 4 +- ...adless.questionsubmissionrequest.email.md} | 2 +- ...less.questionsubmissionrequest.entityid.md | 13 + ...arch-headless.questionsubmissionrequest.md | 26 + ...headless.questionsubmissionrequest.name.md | 13 + ...onsubmissionrequest.questiondescription.md | 13 + ....questionsubmissionrequest.questiontext.md | 13 + ...ubmissionrequest.sessiontrackingenabled.md | 13 + ...ch-headless.questionsubmissionresponse.md} | 4 +- ...eadless.questionsubmissionresponse.uuid.md | 13 + ...rch-headless.questionsubmissionservice.md} | 4 +- ...uestionsubmissionservice.submitquestion.md | 24 + ...earch-headless.rangeboundary.inclusive.md} | 2 +- docs/search-headless.rangeboundary.md | 21 + docs/search-headless.rangeboundary.value.md | 13 + ... => search-headless.result.description.md} | 2 +- ....md => search-headless.result.distance.md} | 2 +- ...rch-headless.result.distancefromfilter.md} | 6 +- ...d => search-headless.result.entitytype.md} | 2 +- ...earch-headless.result.highlightedfields.md | 13 + ...ult.id.md => search-headless.result.id.md} | 2 +- ...dex.md => search-headless.result.index.md} | 2 +- ...link.md => search-headless.result.link.md} | 2 +- docs/search-headless.result.md | 30 + ...name.md => search-headless.result.name.md} | 2 +- ...a.md => search-headless.result.rawdata.md} | 2 +- docs/search-headless.result.source.md | 13 + ...md => search-headless.sandboxendpoints.md} | 2 +- ...h-headless.searchheadless._constructor_.md | 23 + ...ch-headless.searchheadless.addlistener.md} | 4 +- ...less.searchheadless.executefiltersearch.md | 28 + ...chheadless.executeuniversalautocomplete.md | 19 + ...ss.searchheadless.executeuniversalquery.md | 19 + ...rchheadless.executeverticalautocomplete.md | 19 + ...ess.searchheadless.executeverticalquery.md | 19 + docs/search-headless.searchheadless.md | 62 ++ ...rch-headless.searchheadless.resetfacets.md | 17 + ....searchheadless.setalternativeverticals.md | 24 + ...arch-headless.searchheadless.setcontext.md | 24 + ...headless.searchheadless.setfacetoption.md} | 6 +- ...earch-headless.searchheadless.setfacets.md | 24 + ...headless.searchheadless.setfilteroption.md | 24 + ...earch-headless.searchheadless.setoffset.md | 24 + ...search-headless.searchheadless.setquery.md | 24 + ...-headless.searchheadless.setquerysource.md | 24 + ...headless.searchheadless.setquerytrigger.md | 24 + ...dless.searchheadless.setreferrerpageurl.md | 24 + ...ess.searchheadless.setrestrictverticals.md | 24 + ...ch-headless.searchheadless.setsessionid.md | 24 + ...earchheadless.setsessiontrackingenabled.md | 24 + ...arch-headless.searchheadless.setsortbys.md | 24 + ...ess.searchheadless.setspellcheckenabled.md | 24 + ...search-headless.searchheadless.setstate.md | 24 + ...eadless.searchheadless.setstaticfilters.md | 24 + ...ch-headless.searchheadless.setuniversal.md | 17 + ...adless.searchheadless.setuniversallimit.md | 24 + ...headless.searchheadless.setuserlocation.md | 24 + ...ch-headless.searchheadless.setvertical.md} | 4 +- ...eadless.searchheadless.setverticallimit.md | 24 + docs/search-headless.searchheadless.state.md | 13 + ...-headless.searchheadless.submitquestion.md | 26 + ...earch-headless.searchheadless.utilities.md | 13 + ...ent.md => search-headless.searchintent.md} | 2 +- ...adless.searchparameterfield.entitytype.md} | 2 +- ...less.searchparameterfield.fetchentities.md | 13 + ...less.searchparameterfield.fieldapiname.md} | 2 +- docs/search-headless.searchparameterfield.md | 22 + docs/search-headless.searchservice.md | 21 + ...headless.searchservice.universalsearch.md} | 6 +- ...h-headless.searchservice.verticalsearch.md | 24 + ...h-headless.searchstatusstate.isloading.md} | 2 +- docs/search-headless.searchstatusstate.md | 20 + ...htype.md => search-headless.searchtype.md} | 4 +- ...m.md => search-headless.searchtypeenum.md} | 2 +- ...-headless.searchutilities.isclosematch.md} | 4 +- docs/search-headless.searchutilities.md | 13 + ...ess.searchutilities.searchthroughfacet.md} | 8 +- ...h-headless.selectablefilter.displayname.md | 13 + docs/search-headless.selectablefilter.md | 22 + ...rch-headless.selectablefilter.selected.md} | 2 +- ...-headless.sessiontrackingstate.enabled.md} | 2 +- docs/search-headless.sessiontrackingstate.md | 21 + ...eadless.sessiontrackingstate.sessionid.md} | 2 +- ...rch-headless.snippet.matchedsubstrings.md} | 4 +- docs/search-headless.snippet.md | 21 + ...ue.md => search-headless.snippet.value.md} | 2 +- ...md => search-headless.sortby.direction.md} | 4 +- docs/search-headless.sortby.field.md | 13 + docs/search-headless.sortby.md | 26 + ...type.md => search-headless.sortby.type.md} | 2 +- ...orttype.md => search-headless.sorttype.md} | 2 +- ...ss.source.md => search-headless.source.md} | 4 +- ...rch-headless.spellcheck.correctedquery.md} | 2 +- docs/search-headless.spellcheck.md | 22 + ...arch-headless.spellcheck.originalquery.md} | 2 +- ....md => search-headless.spellcheck.type.md} | 2 +- ...earch-headless.spellcheckstate.enabled.md} | 2 +- ....md => search-headless.spellcheckstate.md} | 6 +- ...e.md => search-headless.spellchecktype.md} | 2 +- ... => search-headless.state.directanswer.md} | 2 +- ...rs.md => search-headless.state.filters.md} | 2 +- ...n.md => search-headless.state.location.md} | 2 +- docs/search-headless.state.md | 30 + ....meta.md => search-headless.state.meta.md} | 2 +- ...uery.md => search-headless.state.query.md} | 2 +- ...md => search-headless.state.queryrules.md} | 2 +- ... => search-headless.state.searchstatus.md} | 2 +- ... search-headless.state.sessiontracking.md} | 2 +- ...md => search-headless.state.spellcheck.md} | 2 +- ....md => search-headless.state.universal.md} | 2 +- ...l.md => search-headless.state.vertical.md} | 2 +- ...search-headless.statelistener.callback.md} | 2 +- docs/search-headless.statelistener.md | 21 + ...h-headless.statelistener.valueaccessor.md} | 4 +- ...arch-headless.statemanager.addlistener.md} | 2 +- ...ch-headless.statemanager.dispatchevent.md} | 4 +- docs/search-headless.statemanager.getstate.md | 17 + docs/search-headless.statemanager.md | 26 + ...less.universalautocompleterequest.input.md | 13 + ...h-headless.universalautocompleterequest.md | 22 + ...ocompleterequest.sessiontrackingenabled.md | 13 + ...t.md => search-headless.universallimit.md} | 2 +- ...eadless.universalsearchrequest.context.md} | 2 +- ...-headless.universalsearchrequest.limit.md} | 2 +- ...adless.universalsearchrequest.location.md} | 2 +- .../search-headless.universalsearchrequest.md | 31 + ...h-headless.universalsearchrequest.query.md | 13 + ...ess.universalsearchrequest.querysource.md} | 2 +- ...ss.universalsearchrequest.querytrigger.md} | 2 +- ...universalsearchrequest.referrerpageurl.md} | 2 +- ...iversalsearchrequest.restrictverticals.md} | 2 +- ...dless.universalsearchrequest.sessionid.md} | 2 +- ...salsearchrequest.sessiontrackingenabled.md | 13 + ...s.universalsearchrequest.skipspellcheck.md | 13 + ...s.universalsearchresponse.directanswer.md} | 2 +- ...niversalsearchresponse.failedverticals.md} | 2 +- ...ss.universalsearchresponse.locationbias.md | 13 + ...search-headless.universalsearchresponse.md | 28 + ...eadless.universalsearchresponse.queryid.md | 13 + ...alsearchresponse.queryrulesactionsdata.md} | 2 +- ...s.universalsearchresponse.searchintents.md | 13 + ...less.universalsearchresponse.spellcheck.md | 13 + ...h-headless.universalsearchresponse.uuid.md | 13 + ...universalsearchresponse.verticalresults.md | 13 + ...ch-headless.universalsearchstate.limit.md} | 2 +- docs/search-headless.universalsearchstate.md | 22 + ...universalsearchstate.restrictverticals.md} | 2 +- ...eadless.universalsearchstate.verticals.md} | 2 +- ...-headless.uppernumberrangelimit.matcher.md | 13 + docs/search-headless.uppernumberrangelimit.md | 21 + ...ch-headless.uppernumberrangelimit.value.md | 13 + ...dless.verticalautocompleterequest.input.md | 13 + ...ch-headless.verticalautocompleterequest.md | 23 + ...ocompleterequest.sessiontrackingenabled.md | 13 + ...erticalautocompleterequest.verticalkey.md} | 2 +- ...ess.verticalresults.appliedqueryfilters.md | 13 + docs/search-headless.verticalresults.md | 25 + ...ss.verticalresults.querydurationmillis.md} | 2 +- ...search-headless.verticalresults.results.md | 13 + ...-headless.verticalresults.resultscount.md} | 2 +- .../search-headless.verticalresults.source.md | 13 + ...h-headless.verticalresults.verticalkey.md} | 2 +- ...headless.verticalsearchrequest.context.md} | 2 +- ...h-headless.verticalsearchrequest.facets.md | 13 + ...h-headless.verticalsearchrequest.limit.md} | 2 +- ...eadless.verticalsearchrequest.location.md} | 2 +- ...s.verticalsearchrequest.locationradius.md} | 2 +- docs/search-headless.verticalsearchrequest.md | 38 + ...-headless.verticalsearchrequest.offset.md} | 2 +- ...ch-headless.verticalsearchrequest.query.md | 13 + ...headless.verticalsearchrequest.queryid.md} | 2 +- ...less.verticalsearchrequest.querysource.md} | 2 +- ...ess.verticalsearchrequest.querytrigger.md} | 2 +- ....verticalsearchrequest.referrerpageurl.md} | 2 +- ...ss.verticalsearchrequest.retrievefacets.md | 13 + ...adless.verticalsearchrequest.sessionid.md} | 2 +- ...calsearchrequest.sessiontrackingenabled.md | 13 + ...ss.verticalsearchrequest.skipspellcheck.md | 13 + ...-headless.verticalsearchrequest.sortbys.md | 13 + ...ss.verticalsearchrequest.staticfilters.md} | 2 +- ...dless.verticalsearchrequest.verticalkey.md | 13 + ...alsearchresponse.allresultsforvertical.md} | 2 +- ...icalsearchresponse.alternativeverticals.md | 13 + ...ss.verticalsearchresponse.directanswer.md} | 2 +- ...-headless.verticalsearchresponse.facets.md | 13 + ...ess.verticalsearchresponse.locationbias.md | 13 + .../search-headless.verticalsearchresponse.md | 30 + ...headless.verticalsearchresponse.queryid.md | 13 + ...alsearchresponse.queryrulesactionsdata.md} | 2 +- ...ss.verticalsearchresponse.searchintents.md | 13 + ...less.verticalsearchresponse.spellcheck.md} | 2 +- ...ch-headless.verticalsearchresponse.uuid.md | 13 + ...verticalsearchresponse.verticalresults.md} | 2 +- ...erticalsearchstate.appliedqueryfilters.md} | 2 +- ...eadless.verticalsearchstate.displayname.md | 13 + ...rch-headless.verticalsearchstate.limit.md} | 2 +- docs/search-headless.verticalsearchstate.md | 30 + ...headless.verticalsearchstate.noresults.md} | 2 +- ...ch-headless.verticalsearchstate.offset.md} | 2 +- ...erticalsearchstate.querydurationmillis.md} | 2 +- ...ch-headless.verticalsearchstate.results.md | 13 + ...dless.verticalsearchstate.resultscount.md} | 2 +- ...h-headless.verticalsearchstate.sortbys.md} | 2 +- ...ch-headless.verticalsearchstate.source.md} | 2 +- ...eadless.verticalsearchstate.verticalkey.md | 13 + ...or.id.md => search-headless.visitor.id.md} | 2 +- ...md => search-headless.visitor.idmethod.md} | 2 +- ....visitor.md => search-headless.visitor.md} | 6 +- etc/search-headless.api.md | 829 ++++++++++++++++++ src/index.ts | 12 +- 643 files changed, 5352 insertions(+), 4462 deletions(-) delete mode 100644 docs/answers-headless.additionalhttpheaders.md delete mode 100644 docs/answers-headless.allresultsforvertical.md delete mode 100644 docs/answers-headless.allresultsforvertical.results.md delete mode 100644 docs/answers-headless.answersconfig.md delete mode 100644 docs/answers-headless.answersconfigwithapikey.md delete mode 100644 docs/answers-headless.answersconfigwithapikey.token.md delete mode 100644 docs/answers-headless.answersconfigwithtoken.md delete mode 100644 docs/answers-headless.answerscore._constructor_.md delete mode 100644 docs/answers-headless.answerscore.md delete mode 100644 docs/answers-headless.answerscore.submitquestion.md delete mode 100644 docs/answers-headless.answerscore.universalautocomplete.md delete mode 100644 docs/answers-headless.answerscore.universalsearch.md delete mode 100644 docs/answers-headless.answerscore.verticalautocomplete.md delete mode 100644 docs/answers-headless.answerscore.verticalsearch.md delete mode 100644 docs/answers-headless.answerserror.code.md delete mode 100644 docs/answers-headless.answerserror.md delete mode 100644 docs/answers-headless.answerserror.message.md delete mode 100644 docs/answers-headless.answerserror.type.md delete mode 100644 docs/answers-headless.answersheadless._constructor_.md delete mode 100644 docs/answers-headless.answersheadless.executefiltersearch.md delete mode 100644 docs/answers-headless.answersheadless.executeuniversalautocomplete.md delete mode 100644 docs/answers-headless.answersheadless.executeuniversalquery.md delete mode 100644 docs/answers-headless.answersheadless.executeverticalautocomplete.md delete mode 100644 docs/answers-headless.answersheadless.executeverticalquery.md delete mode 100644 docs/answers-headless.answersheadless.md delete mode 100644 docs/answers-headless.answersheadless.resetfacets.md delete mode 100644 docs/answers-headless.answersheadless.setalternativeverticals.md delete mode 100644 docs/answers-headless.answersheadless.setcontext.md delete mode 100644 docs/answers-headless.answersheadless.setfacets.md delete mode 100644 docs/answers-headless.answersheadless.setfilteroption.md delete mode 100644 docs/answers-headless.answersheadless.setoffset.md delete mode 100644 docs/answers-headless.answersheadless.setquery.md delete mode 100644 docs/answers-headless.answersheadless.setquerysource.md delete mode 100644 docs/answers-headless.answersheadless.setquerytrigger.md delete mode 100644 docs/answers-headless.answersheadless.setreferrerpageurl.md delete mode 100644 docs/answers-headless.answersheadless.setrestrictverticals.md delete mode 100644 docs/answers-headless.answersheadless.setsessionid.md delete mode 100644 docs/answers-headless.answersheadless.setsessiontrackingenabled.md delete mode 100644 docs/answers-headless.answersheadless.setsortbys.md delete mode 100644 docs/answers-headless.answersheadless.setspellcheckenabled.md delete mode 100644 docs/answers-headless.answersheadless.setstate.md delete mode 100644 docs/answers-headless.answersheadless.setstaticfilters.md delete mode 100644 docs/answers-headless.answersheadless.setuniversal.md delete mode 100644 docs/answers-headless.answersheadless.setuniversallimit.md delete mode 100644 docs/answers-headless.answersheadless.setuserlocation.md delete mode 100644 docs/answers-headless.answersheadless.setverticallimit.md delete mode 100644 docs/answers-headless.answersheadless.state.md delete mode 100644 docs/answers-headless.answersheadless.submitquestion.md delete mode 100644 docs/answers-headless.answersheadless.utilities.md delete mode 100644 docs/answers-headless.answersrequest.md delete mode 100644 docs/answers-headless.answersutilities.md delete mode 100644 docs/answers-headless.appliedqueryfilter.details.md delete mode 100644 docs/answers-headless.appliedqueryfilter.md delete mode 100644 docs/answers-headless.appliedqueryfilter.type.md delete mode 100644 docs/answers-headless.autocompleteresponse.md delete mode 100644 docs/answers-headless.autocompleteresponse.queryid.md delete mode 100644 docs/answers-headless.autocompleteresponse.results.md delete mode 100644 docs/answers-headless.autocompleteresult.md delete mode 100644 docs/answers-headless.autocompleteresult.relateditem.md delete mode 100644 docs/answers-headless.autocompleteservice.filtersearch.md delete mode 100644 docs/answers-headless.autocompleteservice.md delete mode 100644 docs/answers-headless.autocompleteservice.universalautocomplete.md delete mode 100644 docs/answers-headless.autocompleteservice.verticalautocomplete.md delete mode 100644 docs/answers-headless.baseanswersconfig.md delete mode 100644 docs/answers-headless.boundedrange.md delete mode 100644 docs/answers-headless.combinedfilter.md delete mode 100644 docs/answers-headless.combinefilters.md delete mode 100644 docs/answers-headless.createdaterangefilter.md delete mode 100644 docs/answers-headless.createnearmefilter.md delete mode 100644 docs/answers-headless.createnumberrangefilter.md delete mode 100644 docs/answers-headless.default_headless_id.md delete mode 100644 docs/answers-headless.directanswer.md delete mode 100644 docs/answers-headless.directanswer.type.md delete mode 100644 docs/answers-headless.directanswer.value.md delete mode 100644 docs/answers-headless.directanswerstate.md delete mode 100644 docs/answers-headless.displayablefacet.fieldid.md delete mode 100644 docs/answers-headless.displayablefacet.md delete mode 100644 docs/answers-headless.displayablefacet.options.md delete mode 100644 docs/answers-headless.displayablefacetoption.matcher.md delete mode 100644 docs/answers-headless.displayablefacetoption.md delete mode 100644 docs/answers-headless.endpoints.filtersearch.md delete mode 100644 docs/answers-headless.endpoints.md delete mode 100644 docs/answers-headless.endpoints.questionsubmission.md delete mode 100644 docs/answers-headless.endpoints.status.md delete mode 100644 docs/answers-headless.endpoints.universalautocomplete.md delete mode 100644 docs/answers-headless.endpoints.universalsearch.md delete mode 100644 docs/answers-headless.endpoints.verticalautocomplete.md delete mode 100644 docs/answers-headless.endpoints.verticalsearch.md delete mode 100644 docs/answers-headless.facet.md delete mode 100644 docs/answers-headless.facetoption.md delete mode 100644 docs/answers-headless.failedvertical.md delete mode 100644 docs/answers-headless.featuredsnippetdirectanswer.fieldtype.md delete mode 100644 docs/answers-headless.featuredsnippetdirectanswer.md delete mode 100644 docs/answers-headless.featuredsnippetdirectanswer.relatedresult.md delete mode 100644 docs/answers-headless.featuredsnippetdirectanswer.snippet.md delete mode 100644 docs/answers-headless.featuredsnippetdirectanswer.type.md delete mode 100644 docs/answers-headless.featuredsnippetdirectanswer.value.md delete mode 100644 docs/answers-headless.featuredsnippetdirectanswer.verticalkey.md delete mode 100644 docs/answers-headless.fieldvaluedirectanswer.fieldapiname.md delete mode 100644 docs/answers-headless.fieldvaluedirectanswer.fieldname.md delete mode 100644 docs/answers-headless.fieldvaluedirectanswer.fieldtype.md delete mode 100644 docs/answers-headless.fieldvaluedirectanswer.md delete mode 100644 docs/answers-headless.fieldvaluedirectanswer.relatedresult.md delete mode 100644 docs/answers-headless.fieldvaluedirectanswer.type.md delete mode 100644 docs/answers-headless.fieldvaluedirectanswer.value.md delete mode 100644 docs/answers-headless.fieldvaluedirectanswer.verticalkey.md delete mode 100644 docs/answers-headless.filter.md delete mode 100644 docs/answers-headless.filtersearchrequest.fields.md delete mode 100644 docs/answers-headless.filtersearchrequest.input.md delete mode 100644 docs/answers-headless.filtersearchrequest.md delete mode 100644 docs/answers-headless.filtersearchrequest.sectioned.md delete mode 100644 docs/answers-headless.filtersearchrequest.sessiontrackingenabled.md delete mode 100644 docs/answers-headless.filtersearchresponse.md delete mode 100644 docs/answers-headless.filtersearchresponse.queryid.md delete mode 100644 docs/answers-headless.filtersstate.md delete mode 100644 docs/answers-headless.filtertypes.md delete mode 100644 docs/answers-headless.headlessconfig.md delete mode 100644 docs/answers-headless.highlightedvalue.md delete mode 100644 docs/answers-headless.locationbias.latitude.md delete mode 100644 docs/answers-headless.locationbias.longitude.md delete mode 100644 docs/answers-headless.locationbias.md delete mode 100644 docs/answers-headless.locationboundingbox.maxlatitude.md delete mode 100644 docs/answers-headless.locationboundingbox.maxlongitude.md delete mode 100644 docs/answers-headless.locationboundingbox.md delete mode 100644 docs/answers-headless.locationboundingbox.minlatitude.md delete mode 100644 docs/answers-headless.locationboundingbox.minlongitude.md delete mode 100644 docs/answers-headless.locationfilterdetails.latitude.md delete mode 100644 docs/answers-headless.locationfilterdetails.longitude.md delete mode 100644 docs/answers-headless.locationfilterdetails.md delete mode 100644 docs/answers-headless.locationfilterdetails.placename.md delete mode 100644 docs/answers-headless.locationstate.md delete mode 100644 docs/answers-headless.lowernumberrangelimit.matcher.md delete mode 100644 docs/answers-headless.lowernumberrangelimit.md delete mode 100644 docs/answers-headless.lowernumberrangelimit.value.md delete mode 100644 docs/answers-headless.md delete mode 100644 docs/answers-headless.metastate.md delete mode 100644 docs/answers-headless.nearfiltervalue.lat.md delete mode 100644 docs/answers-headless.nearfiltervalue.lng.md delete mode 100644 docs/answers-headless.nearfiltervalue.md delete mode 100644 docs/answers-headless.numberrangevalue.md delete mode 100644 docs/answers-headless.parentstate.md delete mode 100644 docs/answers-headless.provideanswersheadless.md delete mode 100644 docs/answers-headless.queryrulesactionsdata.key.md delete mode 100644 docs/answers-headless.queryrulesactionsdata.md delete mode 100644 docs/answers-headless.queryrulesstate.md delete mode 100644 docs/answers-headless.querystate.md delete mode 100644 docs/answers-headless.questionsubmissionrequest.entityid.md delete mode 100644 docs/answers-headless.questionsubmissionrequest.md delete mode 100644 docs/answers-headless.questionsubmissionrequest.name.md delete mode 100644 docs/answers-headless.questionsubmissionrequest.questiondescription.md delete mode 100644 docs/answers-headless.questionsubmissionrequest.questiontext.md delete mode 100644 docs/answers-headless.questionsubmissionrequest.sessiontrackingenabled.md delete mode 100644 docs/answers-headless.questionsubmissionresponse.uuid.md delete mode 100644 docs/answers-headless.questionsubmissionservice.submitquestion.md delete mode 100644 docs/answers-headless.rangeboundary.md delete mode 100644 docs/answers-headless.rangeboundary.value.md delete mode 100644 docs/answers-headless.result.highlightedfields.md delete mode 100644 docs/answers-headless.result.md delete mode 100644 docs/answers-headless.result.source.md delete mode 100644 docs/answers-headless.searchparameterfield.fetchentities.md delete mode 100644 docs/answers-headless.searchparameterfield.md delete mode 100644 docs/answers-headless.searchservice.md delete mode 100644 docs/answers-headless.searchservice.verticalsearch.md delete mode 100644 docs/answers-headless.searchstatusstate.md delete mode 100644 docs/answers-headless.selectablefilter.displayname.md delete mode 100644 docs/answers-headless.selectablefilter.md delete mode 100644 docs/answers-headless.sessiontrackingstate.md delete mode 100644 docs/answers-headless.snippet.md delete mode 100644 docs/answers-headless.sortby.field.md delete mode 100644 docs/answers-headless.sortby.md delete mode 100644 docs/answers-headless.spellcheck.md delete mode 100644 docs/answers-headless.state.md delete mode 100644 docs/answers-headless.statelistener.md delete mode 100644 docs/answers-headless.statemanager.getstate.md delete mode 100644 docs/answers-headless.statemanager.md delete mode 100644 docs/answers-headless.universalautocompleterequest.input.md delete mode 100644 docs/answers-headless.universalautocompleterequest.md delete mode 100644 docs/answers-headless.universalautocompleterequest.sessiontrackingenabled.md delete mode 100644 docs/answers-headless.universalsearchrequest.md delete mode 100644 docs/answers-headless.universalsearchrequest.query.md delete mode 100644 docs/answers-headless.universalsearchrequest.sessiontrackingenabled.md delete mode 100644 docs/answers-headless.universalsearchrequest.skipspellcheck.md delete mode 100644 docs/answers-headless.universalsearchresponse.locationbias.md delete mode 100644 docs/answers-headless.universalsearchresponse.md delete mode 100644 docs/answers-headless.universalsearchresponse.queryid.md delete mode 100644 docs/answers-headless.universalsearchresponse.searchintents.md delete mode 100644 docs/answers-headless.universalsearchresponse.spellcheck.md delete mode 100644 docs/answers-headless.universalsearchresponse.uuid.md delete mode 100644 docs/answers-headless.universalsearchresponse.verticalresults.md delete mode 100644 docs/answers-headless.universalsearchstate.md delete mode 100644 docs/answers-headless.uppernumberrangelimit.matcher.md delete mode 100644 docs/answers-headless.uppernumberrangelimit.md delete mode 100644 docs/answers-headless.uppernumberrangelimit.value.md delete mode 100644 docs/answers-headless.verticalautocompleterequest.input.md delete mode 100644 docs/answers-headless.verticalautocompleterequest.md delete mode 100644 docs/answers-headless.verticalautocompleterequest.sessiontrackingenabled.md delete mode 100644 docs/answers-headless.verticalresults.appliedqueryfilters.md delete mode 100644 docs/answers-headless.verticalresults.md delete mode 100644 docs/answers-headless.verticalresults.results.md delete mode 100644 docs/answers-headless.verticalresults.source.md delete mode 100644 docs/answers-headless.verticalsearchrequest.facets.md delete mode 100644 docs/answers-headless.verticalsearchrequest.md delete mode 100644 docs/answers-headless.verticalsearchrequest.query.md delete mode 100644 docs/answers-headless.verticalsearchrequest.retrievefacets.md delete mode 100644 docs/answers-headless.verticalsearchrequest.sessiontrackingenabled.md delete mode 100644 docs/answers-headless.verticalsearchrequest.skipspellcheck.md delete mode 100644 docs/answers-headless.verticalsearchrequest.sortbys.md delete mode 100644 docs/answers-headless.verticalsearchrequest.verticalkey.md delete mode 100644 docs/answers-headless.verticalsearchresponse.alternativeverticals.md delete mode 100644 docs/answers-headless.verticalsearchresponse.facets.md delete mode 100644 docs/answers-headless.verticalsearchresponse.locationbias.md delete mode 100644 docs/answers-headless.verticalsearchresponse.md delete mode 100644 docs/answers-headless.verticalsearchresponse.queryid.md delete mode 100644 docs/answers-headless.verticalsearchresponse.searchintents.md delete mode 100644 docs/answers-headless.verticalsearchresponse.uuid.md delete mode 100644 docs/answers-headless.verticalsearchstate.displayname.md delete mode 100644 docs/answers-headless.verticalsearchstate.md delete mode 100644 docs/answers-headless.verticalsearchstate.results.md delete mode 100644 docs/answers-headless.verticalsearchstate.verticalkey.md rename docs/{answers-headless.additionalhttpheaders._client-sdk_.md => search-headless.additionalhttpheaders._client-sdk_.md} (62%) create mode 100644 docs/search-headless.additionalhttpheaders.md rename docs/{answers-headless.allresultsforvertical.facets.md => search-headless.allresultsforvertical.facets.md} (58%) create mode 100644 docs/search-headless.allresultsforvertical.md create mode 100644 docs/search-headless.allresultsforvertical.results.md rename docs/{answers-headless.allresultsforvertical.resultscount.md => search-headless.allresultsforvertical.resultscount.md} (50%) create mode 100644 docs/search-headless.answersconfig.md rename docs/{answers-headless.answersconfigwithapikey.apikey.md => search-headless.answersconfigwithapikey.apikey.md} (52%) create mode 100644 docs/search-headless.answersconfigwithapikey.md create mode 100644 docs/search-headless.answersconfigwithapikey.token.md rename docs/{answers-headless.answersconfigwithtoken.apikey.md => search-headless.answersconfigwithtoken.apikey.md} (50%) create mode 100644 docs/search-headless.answersconfigwithtoken.md rename docs/{answers-headless.answersconfigwithtoken.token.md => search-headless.answersconfigwithtoken.token.md} (56%) create mode 100644 docs/search-headless.answerscore._constructor_.md rename docs/{answers-headless.answerscore.filtersearch.md => search-headless.answerscore.filtersearch.md} (63%) create mode 100644 docs/search-headless.answerscore.md create mode 100644 docs/search-headless.answerscore.submitquestion.md create mode 100644 docs/search-headless.answerscore.universalautocomplete.md create mode 100644 docs/search-headless.answerscore.universalsearch.md create mode 100644 docs/search-headless.answerscore.verticalautocomplete.md create mode 100644 docs/search-headless.answerscore.verticalsearch.md create mode 100644 docs/search-headless.answerserror.code.md create mode 100644 docs/search-headless.answerserror.md create mode 100644 docs/search-headless.answerserror.message.md create mode 100644 docs/search-headless.answerserror.type.md create mode 100644 docs/search-headless.answersheadless.md rename docs/{answers-headless.answersrequest.additionalhttpheaders.md => search-headless.answersrequest.additionalhttpheaders.md} (56%) create mode 100644 docs/search-headless.answersrequest.md create mode 100644 docs/search-headless.answersutilities.md create mode 100644 docs/search-headless.appliedqueryfilter.details.md rename docs/{answers-headless.appliedqueryfilter.displaykey.md => search-headless.appliedqueryfilter.displaykey.md} (52%) rename docs/{answers-headless.appliedqueryfilter.displayvalue.md => search-headless.appliedqueryfilter.displayvalue.md} (50%) rename docs/{answers-headless.appliedqueryfilter.filter.md => search-headless.appliedqueryfilter.filter.md} (50%) create mode 100644 docs/search-headless.appliedqueryfilter.md create mode 100644 docs/search-headless.appliedqueryfilter.type.md rename docs/{answers-headless.appliedqueryfiltertype.md => search-headless.appliedqueryfiltertype.md} (69%) rename docs/{answers-headless.autocompleteresponse.inputintents.md => search-headless.autocompleteresponse.inputintents.md} (50%) create mode 100644 docs/search-headless.autocompleteresponse.md create mode 100644 docs/search-headless.autocompleteresponse.queryid.md create mode 100644 docs/search-headless.autocompleteresponse.results.md rename docs/{answers-headless.autocompleteresponse.uuid.md => search-headless.autocompleteresponse.uuid.md} (50%) rename docs/{answers-headless.autocompleteresult.filter.md => search-headless.autocompleteresult.filter.md} (56%) rename docs/{answers-headless.autocompleteresult.key.md => search-headless.autocompleteresult.key.md} (57%) rename docs/{answers-headless.autocompleteresult.matchedsubstrings.md => search-headless.autocompleteresult.matchedsubstrings.md} (63%) create mode 100644 docs/search-headless.autocompleteresult.md create mode 100644 docs/search-headless.autocompleteresult.relateditem.md rename docs/{answers-headless.autocompleteresult.value.md => search-headless.autocompleteresult.value.md} (50%) rename docs/{answers-headless.autocompleteresult.verticalkeys.md => search-headless.autocompleteresult.verticalkeys.md} (55%) create mode 100644 docs/search-headless.autocompleteservice.filtersearch.md create mode 100644 docs/search-headless.autocompleteservice.md create mode 100644 docs/search-headless.autocompleteservice.universalautocomplete.md create mode 100644 docs/search-headless.autocompleteservice.verticalautocomplete.md rename docs/{answers-headless.baseanswersconfig.endpoints.md => search-headless.baseanswersconfig.endpoints.md} (54%) rename docs/{answers-headless.baseanswersconfig.experiencekey.md => search-headless.baseanswersconfig.experiencekey.md} (50%) rename docs/{answers-headless.baseanswersconfig.experienceversion.md => search-headless.baseanswersconfig.experienceversion.md} (63%) rename docs/{answers-headless.baseanswersconfig.locale.md => search-headless.baseanswersconfig.locale.md} (50%) create mode 100644 docs/search-headless.baseanswersconfig.md rename docs/{answers-headless.baseanswersconfig.visitor.md => search-headless.baseanswersconfig.visitor.md} (62%) rename docs/{answers-headless.boundedrange.max.md => search-headless.boundedrange.max.md} (52%) create mode 100644 docs/search-headless.boundedrange.md rename docs/{answers-headless.boundedrange.min.md => search-headless.boundedrange.min.md} (52%) rename docs/{answers-headless.clientsdkheadervalues.answers_core.md => search-headless.clientsdkheadervalues.answers_core.md} (59%) rename docs/{answers-headless.clientsdkheadervalues.md => search-headless.clientsdkheadervalues.md} (51%) rename docs/{answers-headless.combinedfilter.combinator.md => search-headless.combinedfilter.combinator.md} (53%) rename docs/{answers-headless.combinedfilter.filters.md => search-headless.combinedfilter.filters.md} (53%) create mode 100644 docs/search-headless.combinedfilter.md create mode 100644 docs/search-headless.combinefilters.md rename docs/{answers-headless.context.md => search-headless.context.md} (71%) create mode 100644 docs/search-headless.createdaterangefilter.md rename docs/{answers-headless.createequalsfilter.md => search-headless.createequalsfilter.md} (54%) create mode 100644 docs/search-headless.createnearmefilter.md create mode 100644 docs/search-headless.createnumberrangefilter.md create mode 100644 docs/search-headless.default_headless_id.md rename docs/{answers-headless.directanswer.fieldtype.md => search-headless.directanswer.fieldtype.md} (51%) create mode 100644 docs/search-headless.directanswer.md rename docs/{answers-headless.directanswer.relatedresult.md => search-headless.directanswer.relatedresult.md} (52%) create mode 100644 docs/search-headless.directanswer.type.md create mode 100644 docs/search-headless.directanswer.value.md rename docs/{answers-headless.directanswer.verticalkey.md => search-headless.directanswer.verticalkey.md} (51%) create mode 100644 docs/search-headless.directanswerstate.md rename docs/{answers-headless.directanswerstate.result.md => search-headless.directanswerstate.result.md} (65%) rename docs/{answers-headless.directanswertype.md => search-headless.directanswertype.md} (59%) rename docs/{answers-headless.direction.md => search-headless.direction.md} (74%) rename docs/{answers-headless.displayablefacet.displayname.md => search-headless.displayablefacet.displayname.md} (53%) create mode 100644 docs/search-headless.displayablefacet.fieldid.md create mode 100644 docs/search-headless.displayablefacet.md create mode 100644 docs/search-headless.displayablefacet.options.md rename docs/{answers-headless.displayablefacetoption.count.md => search-headless.displayablefacetoption.count.md} (50%) rename docs/{answers-headless.displayablefacetoption.displayname.md => search-headless.displayablefacetoption.displayname.md} (52%) create mode 100644 docs/search-headless.displayablefacetoption.matcher.md create mode 100644 docs/search-headless.displayablefacetoption.md rename docs/{answers-headless.displayablefacetoption.selected.md => search-headless.displayablefacetoption.selected.md} (51%) rename docs/{answers-headless.displayablefacetoption.value.md => search-headless.displayablefacetoption.value.md} (51%) create mode 100644 docs/search-headless.endpoints.filtersearch.md create mode 100644 docs/search-headless.endpoints.md create mode 100644 docs/search-headless.endpoints.questionsubmission.md create mode 100644 docs/search-headless.endpoints.status.md create mode 100644 docs/search-headless.endpoints.universalautocomplete.md create mode 100644 docs/search-headless.endpoints.universalsearch.md create mode 100644 docs/search-headless.endpoints.verticalautocomplete.md create mode 100644 docs/search-headless.endpoints.verticalsearch.md rename docs/{answers-headless.enumorliteral.md => search-headless.enumorliteral.md} (70%) rename docs/{answers-headless.errortype.md => search-headless.errortype.md} (82%) rename docs/{answers-headless.facet.fieldid.md => search-headless.facet.fieldid.md} (51%) create mode 100644 docs/search-headless.facet.md rename docs/{answers-headless.facet.options.md => search-headless.facet.options.md} (50%) rename docs/{answers-headless.facetoption.matcher.md => search-headless.facetoption.matcher.md} (51%) create mode 100644 docs/search-headless.facetoption.md rename docs/{answers-headless.facetoption.value.md => search-headless.facetoption.value.md} (55%) rename docs/{answers-headless.failedvertical.details.md => search-headless.failedvertical.details.md} (56%) rename docs/{answers-headless.failedvertical.errortype.md => search-headless.failedvertical.errortype.md} (52%) create mode 100644 docs/search-headless.failedvertical.md rename docs/{answers-headless.failedvertical.querydurationmillis.md => search-headless.failedvertical.querydurationmillis.md} (51%) rename docs/{answers-headless.failedvertical.verticalkey.md => search-headless.failedvertical.verticalkey.md} (52%) create mode 100644 docs/search-headless.featuredsnippetdirectanswer.fieldtype.md create mode 100644 docs/search-headless.featuredsnippetdirectanswer.md create mode 100644 docs/search-headless.featuredsnippetdirectanswer.relatedresult.md create mode 100644 docs/search-headless.featuredsnippetdirectanswer.snippet.md create mode 100644 docs/search-headless.featuredsnippetdirectanswer.type.md create mode 100644 docs/search-headless.featuredsnippetdirectanswer.value.md create mode 100644 docs/search-headless.featuredsnippetdirectanswer.verticalkey.md rename docs/{answers-headless.fieldvaluedirectanswer.entityname.md => search-headless.fieldvaluedirectanswer.entityname.md} (50%) create mode 100644 docs/search-headless.fieldvaluedirectanswer.fieldapiname.md create mode 100644 docs/search-headless.fieldvaluedirectanswer.fieldname.md create mode 100644 docs/search-headless.fieldvaluedirectanswer.fieldtype.md create mode 100644 docs/search-headless.fieldvaluedirectanswer.md create mode 100644 docs/search-headless.fieldvaluedirectanswer.relatedresult.md create mode 100644 docs/search-headless.fieldvaluedirectanswer.type.md create mode 100644 docs/search-headless.fieldvaluedirectanswer.value.md create mode 100644 docs/search-headless.fieldvaluedirectanswer.verticalkey.md rename docs/{answers-headless.filter.fieldid.md => search-headless.filter.fieldid.md} (56%) rename docs/{answers-headless.filter.matcher.md => search-headless.filter.matcher.md} (52%) create mode 100644 docs/search-headless.filter.md rename docs/{answers-headless.filter.value.md => search-headless.filter.value.md} (58%) rename docs/{answers-headless.filtercombinator.md => search-headless.filtercombinator.md} (64%) rename docs/{answers-headless.filtersearchrequest.excluded.md => search-headless.filtersearchrequest.excluded.md} (53%) create mode 100644 docs/search-headless.filtersearchrequest.fields.md create mode 100644 docs/search-headless.filtersearchrequest.input.md create mode 100644 docs/search-headless.filtersearchrequest.md create mode 100644 docs/search-headless.filtersearchrequest.sectioned.md create mode 100644 docs/search-headless.filtersearchrequest.sessiontrackingenabled.md rename docs/{answers-headless.filtersearchrequest.verticalkey.md => search-headless.filtersearchrequest.verticalkey.md} (52%) rename docs/{answers-headless.filtersearchresponse.businessid.md => search-headless.filtersearchresponse.businessid.md} (51%) create mode 100644 docs/search-headless.filtersearchresponse.md create mode 100644 docs/search-headless.filtersearchresponse.queryid.md rename docs/{answers-headless.filtersearchresponse.sections.md => search-headless.filtersearchresponse.sections.md} (66%) rename docs/{answers-headless.filtersearchresponse.uuid.md => search-headless.filtersearchresponse.uuid.md} (50%) rename docs/{answers-headless.filtersstate.facets.md => search-headless.filtersstate.facets.md} (61%) create mode 100644 docs/search-headless.filtersstate.md rename docs/{answers-headless.filtersstate.static.md => search-headless.filtersstate.static.md} (61%) create mode 100644 docs/search-headless.filtertypes.md create mode 100644 docs/search-headless.headlessconfig.md rename docs/{answers-headless.highlightedfields.md => search-headless.highlightedfields.md} (67%) rename docs/{answers-headless.highlightedvalue.matchedsubstrings.md => search-headless.highlightedvalue.matchedsubstrings.md} (73%) create mode 100644 docs/search-headless.highlightedvalue.md rename docs/{answers-headless.highlightedvalue.value.md => search-headless.highlightedvalue.value.md} (62%) rename docs/{answers-headless.latlong.latitude.md => search-headless.latlong.latitude.md} (55%) rename docs/{answers-headless.latlong.longitude.md => search-headless.latlong.longitude.md} (55%) rename docs/{answers-headless.latlong.md => search-headless.latlong.md} (52%) rename docs/{answers-headless.locationbias.displayname.md => search-headless.locationbias.displayname.md} (53%) create mode 100644 docs/search-headless.locationbias.latitude.md create mode 100644 docs/search-headless.locationbias.longitude.md create mode 100644 docs/search-headless.locationbias.md rename docs/{answers-headless.locationbias.method.md => search-headless.locationbias.method.md} (53%) rename docs/{answers-headless.locationbiasmethod.md => search-headless.locationbiasmethod.md} (77%) create mode 100644 docs/search-headless.locationboundingbox.maxlatitude.md create mode 100644 docs/search-headless.locationboundingbox.maxlongitude.md create mode 100644 docs/search-headless.locationboundingbox.md create mode 100644 docs/search-headless.locationboundingbox.minlatitude.md create mode 100644 docs/search-headless.locationboundingbox.minlongitude.md rename docs/{answers-headless.locationfilterdetails.boundingbox.md => search-headless.locationfilterdetails.boundingbox.md} (50%) rename docs/{answers-headless.locationfilterdetails.featuretypes.md => search-headless.locationfilterdetails.featuretypes.md} (52%) create mode 100644 docs/search-headless.locationfilterdetails.latitude.md create mode 100644 docs/search-headless.locationfilterdetails.longitude.md create mode 100644 docs/search-headless.locationfilterdetails.md create mode 100644 docs/search-headless.locationfilterdetails.placename.md rename docs/{answers-headless.locationstate.locationbias.md => search-headless.locationstate.locationbias.md} (56%) create mode 100644 docs/search-headless.locationstate.md rename docs/{answers-headless.locationstate.userlocation.md => search-headless.locationstate.userlocation.md} (55%) create mode 100644 docs/search-headless.lowernumberrangelimit.matcher.md create mode 100644 docs/search-headless.lowernumberrangelimit.md create mode 100644 docs/search-headless.lowernumberrangelimit.value.md rename docs/{answers-headless.matcher.md => search-headless.matcher.md} (87%) create mode 100644 docs/search-headless.md rename docs/{answers-headless.metastate.context.md => search-headless.metastate.context.md} (63%) create mode 100644 docs/search-headless.metastate.md rename docs/{answers-headless.metastate.referrerpageurl.md => search-headless.metastate.referrerpageurl.md} (58%) rename docs/{answers-headless.metastate.searchtype.md => search-headless.metastate.searchtype.md} (55%) rename docs/{answers-headless.metastate.uuid.md => search-headless.metastate.uuid.md} (54%) create mode 100644 docs/search-headless.nearfiltervalue.lat.md create mode 100644 docs/search-headless.nearfiltervalue.lng.md create mode 100644 docs/search-headless.nearfiltervalue.md rename docs/{answers-headless.nearfiltervalue.radius.md => search-headless.nearfiltervalue.radius.md} (52%) rename docs/{answers-headless.numberrangevalue.end.md => search-headless.numberrangevalue.end.md} (52%) create mode 100644 docs/search-headless.numberrangevalue.md rename docs/{answers-headless.numberrangevalue.start.md => search-headless.numberrangevalue.start.md} (52%) create mode 100644 docs/search-headless.parentstate.md create mode 100644 docs/search-headless.provideanswersheadless.md create mode 100644 docs/search-headless.providesearchheadless.md rename docs/{answers-headless.queryrulesactionsdata.data.md => search-headless.queryrulesactionsdata.data.md} (51%) rename docs/{answers-headless.queryrulesactionsdata.errors.md => search-headless.queryrulesactionsdata.errors.md} (56%) create mode 100644 docs/search-headless.queryrulesactionsdata.key.md create mode 100644 docs/search-headless.queryrulesactionsdata.md rename docs/{answers-headless.queryrulesstate.actions.md => search-headless.queryrulesstate.actions.md} (54%) create mode 100644 docs/search-headless.queryrulesstate.md rename docs/{answers-headless.querysource.md => search-headless.querysource.md} (81%) rename docs/{answers-headless.querystate.input.md => search-headless.querystate.input.md} (52%) create mode 100644 docs/search-headless.querystate.md rename docs/{answers-headless.querystate.mostrecentsearch.md => search-headless.querystate.mostrecentsearch.md} (51%) rename docs/{answers-headless.querystate.queryid.md => search-headless.querystate.queryid.md} (52%) rename docs/{answers-headless.querystate.querysource.md => search-headless.querystate.querysource.md} (59%) rename docs/{answers-headless.querystate.querytrigger.md => search-headless.querystate.querytrigger.md} (53%) rename docs/{answers-headless.querystate.searchintents.md => search-headless.querystate.searchintents.md} (56%) rename docs/{answers-headless.querytrigger.md => search-headless.querytrigger.md} (78%) rename docs/{answers-headless.questionsubmissionrequest.email.md => search-headless.questionsubmissionrequest.email.md} (50%) create mode 100644 docs/search-headless.questionsubmissionrequest.entityid.md create mode 100644 docs/search-headless.questionsubmissionrequest.md create mode 100644 docs/search-headless.questionsubmissionrequest.name.md create mode 100644 docs/search-headless.questionsubmissionrequest.questiondescription.md create mode 100644 docs/search-headless.questionsubmissionrequest.questiontext.md create mode 100644 docs/search-headless.questionsubmissionrequest.sessiontrackingenabled.md rename docs/{answers-headless.questionsubmissionresponse.md => search-headless.questionsubmissionresponse.md} (53%) create mode 100644 docs/search-headless.questionsubmissionresponse.uuid.md rename docs/{answers-headless.questionsubmissionservice.md => search-headless.questionsubmissionservice.md} (50%) create mode 100644 docs/search-headless.questionsubmissionservice.submitquestion.md rename docs/{answers-headless.rangeboundary.inclusive.md => search-headless.rangeboundary.inclusive.md} (52%) create mode 100644 docs/search-headless.rangeboundary.md create mode 100644 docs/search-headless.rangeboundary.value.md rename docs/{answers-headless.result.description.md => search-headless.result.description.md} (51%) rename docs/{answers-headless.result.distance.md => search-headless.result.distance.md} (54%) rename docs/{answers-headless.result.distancefromfilter.md => search-headless.result.distancefromfilter.md} (56%) rename docs/{answers-headless.result.entitytype.md => search-headless.result.entitytype.md} (51%) create mode 100644 docs/search-headless.result.highlightedfields.md rename docs/{answers-headless.result.id.md => search-headless.result.id.md} (54%) rename docs/{answers-headless.result.index.md => search-headless.result.index.md} (55%) rename docs/{answers-headless.result.link.md => search-headless.result.link.md} (53%) create mode 100644 docs/search-headless.result.md rename docs/{answers-headless.result.name.md => search-headless.result.name.md} (51%) rename docs/{answers-headless.result.rawdata.md => search-headless.result.rawdata.md} (56%) create mode 100644 docs/search-headless.result.source.md rename docs/{answers-headless.sandboxendpoints.md => search-headless.sandboxendpoints.md} (61%) create mode 100644 docs/search-headless.searchheadless._constructor_.md rename docs/{answers-headless.answersheadless.addlistener.md => search-headless.searchheadless.addlistener.md} (62%) create mode 100644 docs/search-headless.searchheadless.executefiltersearch.md create mode 100644 docs/search-headless.searchheadless.executeuniversalautocomplete.md create mode 100644 docs/search-headless.searchheadless.executeuniversalquery.md create mode 100644 docs/search-headless.searchheadless.executeverticalautocomplete.md create mode 100644 docs/search-headless.searchheadless.executeverticalquery.md create mode 100644 docs/search-headless.searchheadless.md create mode 100644 docs/search-headless.searchheadless.resetfacets.md create mode 100644 docs/search-headless.searchheadless.setalternativeverticals.md create mode 100644 docs/search-headless.searchheadless.setcontext.md rename docs/{answers-headless.answersheadless.setfacetoption.md => search-headless.searchheadless.setfacetoption.md} (56%) create mode 100644 docs/search-headless.searchheadless.setfacets.md create mode 100644 docs/search-headless.searchheadless.setfilteroption.md create mode 100644 docs/search-headless.searchheadless.setoffset.md create mode 100644 docs/search-headless.searchheadless.setquery.md create mode 100644 docs/search-headless.searchheadless.setquerysource.md create mode 100644 docs/search-headless.searchheadless.setquerytrigger.md create mode 100644 docs/search-headless.searchheadless.setreferrerpageurl.md create mode 100644 docs/search-headless.searchheadless.setrestrictverticals.md create mode 100644 docs/search-headless.searchheadless.setsessionid.md create mode 100644 docs/search-headless.searchheadless.setsessiontrackingenabled.md create mode 100644 docs/search-headless.searchheadless.setsortbys.md create mode 100644 docs/search-headless.searchheadless.setspellcheckenabled.md create mode 100644 docs/search-headless.searchheadless.setstate.md create mode 100644 docs/search-headless.searchheadless.setstaticfilters.md create mode 100644 docs/search-headless.searchheadless.setuniversal.md create mode 100644 docs/search-headless.searchheadless.setuniversallimit.md create mode 100644 docs/search-headless.searchheadless.setuserlocation.md rename docs/{answers-headless.answersheadless.setvertical.md => search-headless.searchheadless.setvertical.md} (58%) create mode 100644 docs/search-headless.searchheadless.setverticallimit.md create mode 100644 docs/search-headless.searchheadless.state.md create mode 100644 docs/search-headless.searchheadless.submitquestion.md create mode 100644 docs/search-headless.searchheadless.utilities.md rename docs/{answers-headless.searchintent.md => search-headless.searchintent.md} (73%) rename docs/{answers-headless.searchparameterfield.entitytype.md => search-headless.searchparameterfield.entitytype.md} (50%) create mode 100644 docs/search-headless.searchparameterfield.fetchentities.md rename docs/{answers-headless.searchparameterfield.fieldapiname.md => search-headless.searchparameterfield.fieldapiname.md} (50%) create mode 100644 docs/search-headless.searchparameterfield.md create mode 100644 docs/search-headless.searchservice.md rename docs/{answers-headless.searchservice.universalsearch.md => search-headless.searchservice.universalsearch.md} (53%) create mode 100644 docs/search-headless.searchservice.verticalsearch.md rename docs/{answers-headless.searchstatusstate.isloading.md => search-headless.searchstatusstate.isloading.md} (52%) create mode 100644 docs/search-headless.searchstatusstate.md rename docs/{answers-headless.searchtype.md => search-headless.searchtype.md} (53%) rename docs/{answers-headless.searchtypeenum.md => search-headless.searchtypeenum.md} (78%) rename docs/{answers-headless.answersutilities.isclosematch.md => search-headless.searchutilities.isclosematch.md} (67%) create mode 100644 docs/search-headless.searchutilities.md rename docs/{answers-headless.answersutilities.searchthroughfacet.md => search-headless.searchutilities.searchthroughfacet.md} (56%) create mode 100644 docs/search-headless.selectablefilter.displayname.md create mode 100644 docs/search-headless.selectablefilter.md rename docs/{answers-headless.selectablefilter.selected.md => search-headless.selectablefilter.selected.md} (50%) rename docs/{answers-headless.sessiontrackingstate.enabled.md => search-headless.sessiontrackingstate.enabled.md} (50%) create mode 100644 docs/search-headless.sessiontrackingstate.md rename docs/{answers-headless.sessiontrackingstate.sessionid.md => search-headless.sessiontrackingstate.sessionid.md} (54%) rename docs/{answers-headless.snippet.matchedsubstrings.md => search-headless.snippet.matchedsubstrings.md} (51%) create mode 100644 docs/search-headless.snippet.md rename docs/{answers-headless.snippet.value.md => search-headless.snippet.value.md} (51%) rename docs/{answers-headless.sortby.direction.md => search-headless.sortby.direction.md} (50%) create mode 100644 docs/search-headless.sortby.field.md create mode 100644 docs/search-headless.sortby.md rename docs/{answers-headless.sortby.type.md => search-headless.sortby.type.md} (51%) rename docs/{answers-headless.sorttype.md => search-headless.sorttype.md} (81%) rename docs/{answers-headless.source.md => search-headless.source.md} (78%) rename docs/{answers-headless.spellcheck.correctedquery.md => search-headless.spellcheck.correctedquery.md} (52%) create mode 100644 docs/search-headless.spellcheck.md rename docs/{answers-headless.spellcheck.originalquery.md => search-headless.spellcheck.originalquery.md} (52%) rename docs/{answers-headless.spellcheck.type.md => search-headless.spellcheck.type.md} (51%) rename docs/{answers-headless.spellcheckstate.enabled.md => search-headless.spellcheckstate.enabled.md} (50%) rename docs/{answers-headless.spellcheckstate.md => search-headless.spellcheckstate.md} (51%) rename docs/{answers-headless.spellchecktype.md => search-headless.spellchecktype.md} (80%) rename docs/{answers-headless.state.directanswer.md => search-headless.state.directanswer.md} (56%) rename docs/{answers-headless.state.filters.md => search-headless.state.filters.md} (57%) rename docs/{answers-headless.state.location.md => search-headless.state.location.md} (60%) create mode 100644 docs/search-headless.state.md rename docs/{answers-headless.state.meta.md => search-headless.state.meta.md} (54%) rename docs/{answers-headless.state.query.md => search-headless.state.query.md} (55%) rename docs/{answers-headless.state.queryrules.md => search-headless.state.queryrules.md} (55%) rename docs/{answers-headless.state.searchstatus.md => search-headless.state.searchstatus.md} (54%) rename docs/{answers-headless.state.sessiontracking.md => search-headless.state.sessiontracking.md} (59%) rename docs/{answers-headless.state.spellcheck.md => search-headless.state.spellcheck.md} (59%) rename docs/{answers-headless.state.universal.md => search-headless.state.universal.md} (56%) rename docs/{answers-headless.state.vertical.md => search-headless.state.vertical.md} (56%) rename docs/{answers-headless.statelistener.callback.md => search-headless.statelistener.callback.md} (64%) create mode 100644 docs/search-headless.statelistener.md rename docs/{answers-headless.statelistener.valueaccessor.md => search-headless.statelistener.valueaccessor.md} (55%) rename docs/{answers-headless.statemanager.addlistener.md => search-headless.statemanager.addlistener.md} (68%) rename docs/{answers-headless.statemanager.dispatchevent.md => search-headless.statemanager.dispatchevent.md} (57%) create mode 100644 docs/search-headless.statemanager.getstate.md create mode 100644 docs/search-headless.statemanager.md create mode 100644 docs/search-headless.universalautocompleterequest.input.md create mode 100644 docs/search-headless.universalautocompleterequest.md create mode 100644 docs/search-headless.universalautocompleterequest.sessiontrackingenabled.md rename docs/{answers-headless.universallimit.md => search-headless.universallimit.md} (68%) rename docs/{answers-headless.universalsearchrequest.context.md => search-headless.universalsearchrequest.context.md} (59%) rename docs/{answers-headless.universalsearchrequest.limit.md => search-headless.universalsearchrequest.limit.md} (54%) rename docs/{answers-headless.universalsearchrequest.location.md => search-headless.universalsearchrequest.location.md} (60%) create mode 100644 docs/search-headless.universalsearchrequest.md create mode 100644 docs/search-headless.universalsearchrequest.query.md rename docs/{answers-headless.universalsearchrequest.querysource.md => search-headless.universalsearchrequest.querysource.md} (50%) rename docs/{answers-headless.universalsearchrequest.querytrigger.md => search-headless.universalsearchrequest.querytrigger.md} (60%) rename docs/{answers-headless.universalsearchrequest.referrerpageurl.md => search-headless.universalsearchrequest.referrerpageurl.md} (63%) rename docs/{answers-headless.universalsearchrequest.restrictverticals.md => search-headless.universalsearchrequest.restrictverticals.md} (51%) rename docs/{answers-headless.universalsearchrequest.sessionid.md => search-headless.universalsearchrequest.sessionid.md} (50%) create mode 100644 docs/search-headless.universalsearchrequest.sessiontrackingenabled.md create mode 100644 docs/search-headless.universalsearchrequest.skipspellcheck.md rename docs/{answers-headless.universalsearchresponse.directanswer.md => search-headless.universalsearchresponse.directanswer.md} (52%) rename docs/{answers-headless.universalsearchresponse.failedverticals.md => search-headless.universalsearchresponse.failedverticals.md} (52%) create mode 100644 docs/search-headless.universalsearchresponse.locationbias.md create mode 100644 docs/search-headless.universalsearchresponse.md create mode 100644 docs/search-headless.universalsearchresponse.queryid.md rename docs/{answers-headless.universalsearchresponse.queryrulesactionsdata.md => search-headless.universalsearchresponse.queryrulesactionsdata.md} (51%) create mode 100644 docs/search-headless.universalsearchresponse.searchintents.md create mode 100644 docs/search-headless.universalsearchresponse.spellcheck.md create mode 100644 docs/search-headless.universalsearchresponse.uuid.md create mode 100644 docs/search-headless.universalsearchresponse.verticalresults.md rename docs/{answers-headless.universalsearchstate.limit.md => search-headless.universalsearchstate.limit.md} (55%) create mode 100644 docs/search-headless.universalsearchstate.md rename docs/{answers-headless.universalsearchstate.restrictverticals.md => search-headless.universalsearchstate.restrictverticals.md} (53%) rename docs/{answers-headless.universalsearchstate.verticals.md => search-headless.universalsearchstate.verticals.md} (53%) create mode 100644 docs/search-headless.uppernumberrangelimit.matcher.md create mode 100644 docs/search-headless.uppernumberrangelimit.md create mode 100644 docs/search-headless.uppernumberrangelimit.value.md create mode 100644 docs/search-headless.verticalautocompleterequest.input.md create mode 100644 docs/search-headless.verticalautocompleterequest.md create mode 100644 docs/search-headless.verticalautocompleterequest.sessiontrackingenabled.md rename docs/{answers-headless.verticalautocompleterequest.verticalkey.md => search-headless.verticalautocompleterequest.verticalkey.md} (50%) create mode 100644 docs/search-headless.verticalresults.appliedqueryfilters.md create mode 100644 docs/search-headless.verticalresults.md rename docs/{answers-headless.verticalresults.querydurationmillis.md => search-headless.verticalresults.querydurationmillis.md} (50%) create mode 100644 docs/search-headless.verticalresults.results.md rename docs/{answers-headless.verticalresults.resultscount.md => search-headless.verticalresults.resultscount.md} (63%) create mode 100644 docs/search-headless.verticalresults.source.md rename docs/{answers-headless.verticalresults.verticalkey.md => search-headless.verticalresults.verticalkey.md} (52%) rename docs/{answers-headless.verticalsearchrequest.context.md => search-headless.verticalsearchrequest.context.md} (59%) create mode 100644 docs/search-headless.verticalsearchrequest.facets.md rename docs/{answers-headless.verticalsearchrequest.limit.md => search-headless.verticalsearchrequest.limit.md} (51%) rename docs/{answers-headless.verticalsearchrequest.location.md => search-headless.verticalsearchrequest.location.md} (60%) rename docs/{answers-headless.verticalsearchrequest.locationradius.md => search-headless.verticalsearchrequest.locationradius.md} (51%) create mode 100644 docs/search-headless.verticalsearchrequest.md rename docs/{answers-headless.verticalsearchrequest.offset.md => search-headless.verticalsearchrequest.offset.md} (53%) create mode 100644 docs/search-headless.verticalsearchrequest.query.md rename docs/{answers-headless.verticalsearchrequest.queryid.md => search-headless.verticalsearchrequest.queryid.md} (50%) rename docs/{answers-headless.verticalsearchrequest.querysource.md => search-headless.verticalsearchrequest.querysource.md} (50%) rename docs/{answers-headless.verticalsearchrequest.querytrigger.md => search-headless.verticalsearchrequest.querytrigger.md} (60%) rename docs/{answers-headless.verticalsearchrequest.referrerpageurl.md => search-headless.verticalsearchrequest.referrerpageurl.md} (51%) create mode 100644 docs/search-headless.verticalsearchrequest.retrievefacets.md rename docs/{answers-headless.verticalsearchrequest.sessionid.md => search-headless.verticalsearchrequest.sessionid.md} (50%) create mode 100644 docs/search-headless.verticalsearchrequest.sessiontrackingenabled.md create mode 100644 docs/search-headless.verticalsearchrequest.skipspellcheck.md create mode 100644 docs/search-headless.verticalsearchrequest.sortbys.md rename docs/{answers-headless.verticalsearchrequest.staticfilters.md => search-headless.verticalsearchrequest.staticfilters.md} (51%) create mode 100644 docs/search-headless.verticalsearchrequest.verticalkey.md rename docs/{answers-headless.verticalsearchresponse.allresultsforvertical.md => search-headless.verticalsearchresponse.allresultsforvertical.md} (52%) create mode 100644 docs/search-headless.verticalsearchresponse.alternativeverticals.md rename docs/{answers-headless.verticalsearchresponse.directanswer.md => search-headless.verticalsearchresponse.directanswer.md} (52%) create mode 100644 docs/search-headless.verticalsearchresponse.facets.md create mode 100644 docs/search-headless.verticalsearchresponse.locationbias.md create mode 100644 docs/search-headless.verticalsearchresponse.md create mode 100644 docs/search-headless.verticalsearchresponse.queryid.md rename docs/{answers-headless.verticalsearchresponse.queryrulesactionsdata.md => search-headless.verticalsearchresponse.queryrulesactionsdata.md} (51%) create mode 100644 docs/search-headless.verticalsearchresponse.searchintents.md rename docs/{answers-headless.verticalsearchresponse.spellcheck.md => search-headless.verticalsearchresponse.spellcheck.md} (50%) create mode 100644 docs/search-headless.verticalsearchresponse.uuid.md rename docs/{answers-headless.verticalsearchresponse.verticalresults.md => search-headless.verticalsearchresponse.verticalresults.md} (50%) rename docs/{answers-headless.verticalsearchstate.appliedqueryfilters.md => search-headless.verticalsearchstate.appliedqueryfilters.md} (54%) create mode 100644 docs/search-headless.verticalsearchstate.displayname.md rename docs/{answers-headless.verticalsearchstate.limit.md => search-headless.verticalsearchstate.limit.md} (52%) create mode 100644 docs/search-headless.verticalsearchstate.md rename docs/{answers-headless.verticalsearchstate.noresults.md => search-headless.verticalsearchstate.noresults.md} (60%) rename docs/{answers-headless.verticalsearchstate.offset.md => search-headless.verticalsearchstate.offset.md} (59%) rename docs/{answers-headless.verticalsearchstate.querydurationmillis.md => search-headless.verticalsearchstate.querydurationmillis.md} (50%) create mode 100644 docs/search-headless.verticalsearchstate.results.md rename docs/{answers-headless.verticalsearchstate.resultscount.md => search-headless.verticalsearchstate.resultscount.md} (50%) rename docs/{answers-headless.verticalsearchstate.sortbys.md => search-headless.verticalsearchstate.sortbys.md} (55%) rename docs/{answers-headless.verticalsearchstate.source.md => search-headless.verticalsearchstate.source.md} (50%) create mode 100644 docs/search-headless.verticalsearchstate.verticalkey.md rename docs/{answers-headless.visitor.id.md => search-headless.visitor.id.md} (51%) rename docs/{answers-headless.visitor.idmethod.md => search-headless.visitor.idmethod.md} (54%) rename docs/{answers-headless.visitor.md => search-headless.visitor.md} (56%) create mode 100644 etc/search-headless.api.md diff --git a/docs/answers-headless.additionalhttpheaders.md b/docs/answers-headless.additionalhttpheaders.md deleted file mode 100644 index 8c898c15..00000000 --- a/docs/answers-headless.additionalhttpheaders.md +++ /dev/null @@ -1,20 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [AdditionalHttpHeaders](./answers-headless.additionalhttpheaders.md) - -## AdditionalHttpHeaders interface - -AdditionalHttpHeaders allows users to specify additional values for specific HTTP headers. - -Signature: - -```typescript -export declare interface AdditionalHttpHeaders -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| ["Client-SDK"?](./answers-headless.additionalhttpheaders._client-sdk_.md) | [ClientSDKHeaderValues](./answers-headless.clientsdkheadervalues.md) | (Optional) Additional agents and their versions used to create the Answers experience. The information for these agents is added to the Client-SDK HTTP header along with that of the ANSWERS\_CORE agent. | - diff --git a/docs/answers-headless.allresultsforvertical.md b/docs/answers-headless.allresultsforvertical.md deleted file mode 100644 index a59a2b83..00000000 --- a/docs/answers-headless.allresultsforvertical.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [AllResultsForVertical](./answers-headless.allresultsforvertical.md) - -## AllResultsForVertical interface - -Represents all results for the current vertical. - -Signature: - -```typescript -export interface AllResultsForVertical -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [facets](./answers-headless.allresultsforvertical.facets.md) | [DisplayableFacet](./answers-headless.displayablefacet.md)\[\] | The dynamic collection of facets that can be applied to filter the search results and whether each of them is currently selected. | -| [results](./answers-headless.allresultsforvertical.results.md) | [Result](./answers-headless.result.md)\[\] | The array of all results for the vertical. | -| [resultsCount](./answers-headless.allresultsforvertical.resultscount.md) | number | The total number of results for the vertical. | - diff --git a/docs/answers-headless.allresultsforvertical.results.md b/docs/answers-headless.allresultsforvertical.results.md deleted file mode 100644 index d36d8ddd..00000000 --- a/docs/answers-headless.allresultsforvertical.results.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [AllResultsForVertical](./answers-headless.allresultsforvertical.md) > [results](./answers-headless.allresultsforvertical.results.md) - -## AllResultsForVertical.results property - -The array of all results for the vertical. - -Signature: - -```typescript -results: Result[]; -``` diff --git a/docs/answers-headless.answersconfig.md b/docs/answers-headless.answersconfig.md deleted file mode 100644 index f8a256ac..00000000 --- a/docs/answers-headless.answersconfig.md +++ /dev/null @@ -1,15 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [AnswersConfig](./answers-headless.answersconfig.md) - -## AnswersConfig type - -The main configuration options for [AnswersCore](./answers-headless.answerscore.md). For a full description of the options, see [BaseAnswersConfig](./answers-headless.baseanswersconfig.md). The config requires either an apiKey or a token. - -Signature: - -```typescript -export declare type AnswersConfig = AnswersConfigWithApiKey | AnswersConfigWithToken; -``` -References: [AnswersConfigWithApiKey](./answers-headless.answersconfigwithapikey.md), [AnswersConfigWithToken](./answers-headless.answersconfigwithtoken.md) - diff --git a/docs/answers-headless.answersconfigwithapikey.md b/docs/answers-headless.answersconfigwithapikey.md deleted file mode 100644 index f2914303..00000000 --- a/docs/answers-headless.answersconfigwithapikey.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [AnswersConfigWithApiKey](./answers-headless.answersconfigwithapikey.md) - -## AnswersConfigWithApiKey interface - -Configuration options for [AnswersCore](./answers-headless.answerscore.md), which includes the options from [BaseAnswersConfig](./answers-headless.baseanswersconfig.md), but requires apiKey. - -Signature: - -```typescript -export declare interface AnswersConfigWithApiKey extends BaseAnswersConfig -``` -Extends: [BaseAnswersConfig](./answers-headless.baseanswersconfig.md) - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [apiKey](./answers-headless.answersconfigwithapikey.apikey.md) | string | The api key of the answers experience which will be sent as a query param. | -| [token?](./answers-headless.answersconfigwithapikey.token.md) | never | (Optional) token should NOT be provided along with apiKey. | - diff --git a/docs/answers-headless.answersconfigwithapikey.token.md b/docs/answers-headless.answersconfigwithapikey.token.md deleted file mode 100644 index 4a81c995..00000000 --- a/docs/answers-headless.answersconfigwithapikey.token.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [AnswersConfigWithApiKey](./answers-headless.answersconfigwithapikey.md) > [token](./answers-headless.answersconfigwithapikey.token.md) - -## AnswersConfigWithApiKey.token property - -token should NOT be provided along with apiKey. - -Signature: - -```typescript -token?: never; -``` diff --git a/docs/answers-headless.answersconfigwithtoken.md b/docs/answers-headless.answersconfigwithtoken.md deleted file mode 100644 index cfa95c49..00000000 --- a/docs/answers-headless.answersconfigwithtoken.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [AnswersConfigWithToken](./answers-headless.answersconfigwithtoken.md) - -## AnswersConfigWithToken interface - -Configuration options for [AnswersCore](./answers-headless.answerscore.md), which includes the options from [BaseAnswersConfig](./answers-headless.baseanswersconfig.md), but requires token. - -Signature: - -```typescript -export declare interface AnswersConfigWithToken extends BaseAnswersConfig -``` -Extends: [BaseAnswersConfig](./answers-headless.baseanswersconfig.md) - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [apiKey?](./answers-headless.answersconfigwithtoken.apikey.md) | never | (Optional) apiKey should NOT be provided along with token. | -| [token](./answers-headless.answersconfigwithtoken.token.md) | string | The authentication token of the answers experience which will be passed in the Auth header as a Bearer token. | - diff --git a/docs/answers-headless.answerscore._constructor_.md b/docs/answers-headless.answerscore._constructor_.md deleted file mode 100644 index 2fba92a2..00000000 --- a/docs/answers-headless.answerscore._constructor_.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [AnswersCore](./answers-headless.answerscore.md) > [(constructor)](./answers-headless.answerscore._constructor_.md) - -## AnswersCore.(constructor) - -Constructs a new instance of the `AnswersCore` class - -Signature: - -```typescript -constructor(searchService: SearchService, questionSubmissionService: QuestionSubmissionService, autoCompleteService: AutocompleteService); -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| searchService | [SearchService](./answers-headless.searchservice.md) | | -| questionSubmissionService | [QuestionSubmissionService](./answers-headless.questionsubmissionservice.md) | | -| autoCompleteService | [AutocompleteService](./answers-headless.autocompleteservice.md) | | - diff --git a/docs/answers-headless.answerscore.md b/docs/answers-headless.answerscore.md deleted file mode 100644 index 281084da..00000000 --- a/docs/answers-headless.answerscore.md +++ /dev/null @@ -1,31 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [AnswersCore](./answers-headless.answerscore.md) - -## AnswersCore class - -Provides methods for executing searches, submitting questions, and performing autocompletes. - -Signature: - -```typescript -export declare class AnswersCore -``` - -## Constructors - -| Constructor | Modifiers | Description | -| --- | --- | --- | -| [(constructor)(searchService, questionSubmissionService, autoCompleteService)](./answers-headless.answerscore._constructor_.md) | | Constructs a new instance of the AnswersCore class | - -## Methods - -| Method | Modifiers | Description | -| --- | --- | --- | -| [filterSearch(request)](./answers-headless.answerscore.filtersearch.md) | | Performs a filtersearch request against specified fields within a single vertical. | -| [submitQuestion(request)](./answers-headless.answerscore.submitquestion.md) | | Submits a custom question to the Answers API. | -| [universalAutocomplete(request)](./answers-headless.answerscore.universalautocomplete.md) | | Performs an autocomplete request across all verticals. | -| [universalSearch(request)](./answers-headless.answerscore.universalsearch.md) | | Performs an Answers search across all verticals. | -| [verticalAutocomplete(request)](./answers-headless.answerscore.verticalautocomplete.md) | | Performs an autocomplete request for a single vertical. | -| [verticalSearch(request)](./answers-headless.answerscore.verticalsearch.md) | | Performs an Answers search for a single vertical. | - diff --git a/docs/answers-headless.answerscore.submitquestion.md b/docs/answers-headless.answerscore.submitquestion.md deleted file mode 100644 index 123b2bd5..00000000 --- a/docs/answers-headless.answerscore.submitquestion.md +++ /dev/null @@ -1,28 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [AnswersCore](./answers-headless.answerscore.md) > [submitQuestion](./answers-headless.answerscore.submitquestion.md) - -## AnswersCore.submitQuestion() method - -Submits a custom question to the Answers API. - -Signature: - -```typescript -submitQuestion(request: QuestionSubmissionRequest): Promise; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| request | [QuestionSubmissionRequest](./answers-headless.questionsubmissionrequest.md) | Question submission request options | - -Returns: - -Promise<[QuestionSubmissionResponse](./answers-headless.questionsubmissionresponse.md)> - -## Remarks - -If rejected, the reason will be an [AnswersError](./answers-headless.answerserror.md). - diff --git a/docs/answers-headless.answerscore.universalautocomplete.md b/docs/answers-headless.answerscore.universalautocomplete.md deleted file mode 100644 index e359028b..00000000 --- a/docs/answers-headless.answerscore.universalautocomplete.md +++ /dev/null @@ -1,28 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [AnswersCore](./answers-headless.answerscore.md) > [universalAutocomplete](./answers-headless.answerscore.universalautocomplete.md) - -## AnswersCore.universalAutocomplete() method - -Performs an autocomplete request across all verticals. - -Signature: - -```typescript -universalAutocomplete(request: UniversalAutocompleteRequest): Promise; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| request | [UniversalAutocompleteRequest](./answers-headless.universalautocompleterequest.md) | Universal autocomplete request options | - -Returns: - -Promise<[AutocompleteResponse](./answers-headless.autocompleteresponse.md)> - -## Remarks - -If rejected, the reason will be an [AnswersError](./answers-headless.answerserror.md). - diff --git a/docs/answers-headless.answerscore.universalsearch.md b/docs/answers-headless.answerscore.universalsearch.md deleted file mode 100644 index 77d6d200..00000000 --- a/docs/answers-headless.answerscore.universalsearch.md +++ /dev/null @@ -1,28 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [AnswersCore](./answers-headless.answerscore.md) > [universalSearch](./answers-headless.answerscore.universalsearch.md) - -## AnswersCore.universalSearch() method - -Performs an Answers search across all verticals. - -Signature: - -```typescript -universalSearch(request: UniversalSearchRequest): Promise; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| request | [UniversalSearchRequest](./answers-headless.universalsearchrequest.md) | Universal search request options | - -Returns: - -Promise<[UniversalSearchResponse](./answers-headless.universalsearchresponse.md)> - -## Remarks - -If rejected, the reason will be an [AnswersError](./answers-headless.answerserror.md). - diff --git a/docs/answers-headless.answerscore.verticalautocomplete.md b/docs/answers-headless.answerscore.verticalautocomplete.md deleted file mode 100644 index 8c259f05..00000000 --- a/docs/answers-headless.answerscore.verticalautocomplete.md +++ /dev/null @@ -1,28 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [AnswersCore](./answers-headless.answerscore.md) > [verticalAutocomplete](./answers-headless.answerscore.verticalautocomplete.md) - -## AnswersCore.verticalAutocomplete() method - -Performs an autocomplete request for a single vertical. - -Signature: - -```typescript -verticalAutocomplete(request: VerticalAutocompleteRequest): Promise; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| request | [VerticalAutocompleteRequest](./answers-headless.verticalautocompleterequest.md) | Vertical autocomplete request options | - -Returns: - -Promise<[AutocompleteResponse](./answers-headless.autocompleteresponse.md)> - -## Remarks - -If rejected, the reason will be an [AnswersError](./answers-headless.answerserror.md). - diff --git a/docs/answers-headless.answerscore.verticalsearch.md b/docs/answers-headless.answerscore.verticalsearch.md deleted file mode 100644 index abc10b9e..00000000 --- a/docs/answers-headless.answerscore.verticalsearch.md +++ /dev/null @@ -1,28 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [AnswersCore](./answers-headless.answerscore.md) > [verticalSearch](./answers-headless.answerscore.verticalsearch.md) - -## AnswersCore.verticalSearch() method - -Performs an Answers search for a single vertical. - -Signature: - -```typescript -verticalSearch(request: VerticalSearchRequest): Promise; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| request | [VerticalSearchRequest](./answers-headless.verticalsearchrequest.md) | Vertical search request options | - -Returns: - -Promise<[VerticalSearchResponse](./answers-headless.verticalsearchresponse.md)> - -## Remarks - -If rejected, the reason will be an [AnswersError](./answers-headless.answerserror.md). - diff --git a/docs/answers-headless.answerserror.code.md b/docs/answers-headless.answerserror.code.md deleted file mode 100644 index 9be1c0e4..00000000 --- a/docs/answers-headless.answerserror.code.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [AnswersError](./answers-headless.answerserror.md) > [code](./answers-headless.answerserror.code.md) - -## AnswersError.code property - -Answers API error code. - -Signature: - -```typescript -code?: number; -``` diff --git a/docs/answers-headless.answerserror.md b/docs/answers-headless.answerserror.md deleted file mode 100644 index 0afa3a29..00000000 --- a/docs/answers-headless.answerserror.md +++ /dev/null @@ -1,27 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [AnswersError](./answers-headless.answerserror.md) - -## AnswersError class - -Represents an error - -Signature: - -```typescript -export declare class AnswersError extends Error -``` -Extends: Error - -## Remarks - -If the error originates from the Answer API, the code and type property will be present. - -## Properties - -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [code?](./answers-headless.answerserror.code.md) | | number | (Optional) Answers API error code. | -| [message](./answers-headless.answerserror.message.md) | | string | The error message. | -| [type?](./answers-headless.answerserror.type.md) | | string | (Optional) Answers API error type. | - diff --git a/docs/answers-headless.answerserror.message.md b/docs/answers-headless.answerserror.message.md deleted file mode 100644 index 026c35e7..00000000 --- a/docs/answers-headless.answerserror.message.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [AnswersError](./answers-headless.answerserror.md) > [message](./answers-headless.answerserror.message.md) - -## AnswersError.message property - -The error message. - -Signature: - -```typescript -message: string; -``` diff --git a/docs/answers-headless.answerserror.type.md b/docs/answers-headless.answerserror.type.md deleted file mode 100644 index 3feb968e..00000000 --- a/docs/answers-headless.answerserror.type.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [AnswersError](./answers-headless.answerserror.md) > [type](./answers-headless.answerserror.type.md) - -## AnswersError.type property - -Answers API error type. - -Signature: - -```typescript -type?: string; -``` diff --git a/docs/answers-headless.answersheadless._constructor_.md b/docs/answers-headless.answersheadless._constructor_.md deleted file mode 100644 index 5767c758..00000000 --- a/docs/answers-headless.answersheadless._constructor_.md +++ /dev/null @@ -1,23 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [AnswersHeadless](./answers-headless.answersheadless.md) > [(constructor)](./answers-headless.answersheadless._constructor_.md) - -## AnswersHeadless.(constructor) - -Constructs a new instance of the `AnswersHeadless` class - -Signature: - -```typescript -constructor(core: AnswersCore, stateManager: StateManager, httpManager: HttpManager, additionalHttpHeaders?: AdditionalHttpHeaders | undefined); -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| core | [AnswersCore](./answers-headless.answerscore.md) | | -| stateManager | StateManager | | -| httpManager | HttpManager | | -| additionalHttpHeaders | [AdditionalHttpHeaders](./answers-headless.additionalhttpheaders.md) \| undefined | | - diff --git a/docs/answers-headless.answersheadless.executefiltersearch.md b/docs/answers-headless.answersheadless.executefiltersearch.md deleted file mode 100644 index 932ace36..00000000 --- a/docs/answers-headless.answersheadless.executefiltersearch.md +++ /dev/null @@ -1,28 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [AnswersHeadless](./answers-headless.answersheadless.md) > [executeFilterSearch](./answers-headless.answersheadless.executefiltersearch.md) - -## AnswersHeadless.executeFilterSearch() method - -Performs a filtersearch request against specified fields within a single vertical using the vertical key stored in state. - -Signature: - -```typescript -executeFilterSearch(query: string, sectioned: boolean, fields: SearchParameterField[]): Promise; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| query | string | The query for which to search | -| sectioned | boolean | Whether or not the results should be sectioned by field | -| fields | [SearchParameterField](./answers-headless.searchparameterfield.md)\[\] | The entity fields to search | - -Returns: - -Promise<[FilterSearchResponse](./answers-headless.filtersearchresponse.md) \| undefined> - -A Promise of a [FilterSearchResponse](./answers-headless.filtersearchresponse.md) from the Answers API or of undefined if there is no verticalKey defined in state - diff --git a/docs/answers-headless.answersheadless.executeuniversalautocomplete.md b/docs/answers-headless.answersheadless.executeuniversalautocomplete.md deleted file mode 100644 index e7552018..00000000 --- a/docs/answers-headless.answersheadless.executeuniversalautocomplete.md +++ /dev/null @@ -1,19 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [AnswersHeadless](./answers-headless.answersheadless.md) > [executeUniversalAutocomplete](./answers-headless.answersheadless.executeuniversalautocomplete.md) - -## AnswersHeadless.executeUniversalAutocomplete() method - -Performs an autocomplete request across all verticals using the query input stored in state. - -Signature: - -```typescript -executeUniversalAutocomplete(): Promise; -``` -Returns: - -Promise<[AutocompleteResponse](./answers-headless.autocompleteresponse.md)> - -A Promise of an [AutocompleteResponse](./answers-headless.autocompleteresponse.md) from the Answers API - diff --git a/docs/answers-headless.answersheadless.executeuniversalquery.md b/docs/answers-headless.answersheadless.executeuniversalquery.md deleted file mode 100644 index ae0e60d0..00000000 --- a/docs/answers-headless.answersheadless.executeuniversalquery.md +++ /dev/null @@ -1,19 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [AnswersHeadless](./answers-headless.answersheadless.md) > [executeUniversalQuery](./answers-headless.answersheadless.executeuniversalquery.md) - -## AnswersHeadless.executeUniversalQuery() method - -Performs an Answers search across all verticals with relevant parts of the state used as input to the search. Updates the state with the response data. - -Signature: - -```typescript -executeUniversalQuery(): Promise; -``` -Returns: - -Promise<[UniversalSearchResponse](./answers-headless.universalsearchresponse.md) \| undefined> - -A Promise of a [UniversalSearchResponse](./answers-headless.universalsearchresponse.md) from the Answers API - diff --git a/docs/answers-headless.answersheadless.executeverticalautocomplete.md b/docs/answers-headless.answersheadless.executeverticalautocomplete.md deleted file mode 100644 index 86244f9a..00000000 --- a/docs/answers-headless.answersheadless.executeverticalautocomplete.md +++ /dev/null @@ -1,19 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [AnswersHeadless](./answers-headless.answersheadless.md) > [executeVerticalAutocomplete](./answers-headless.answersheadless.executeverticalautocomplete.md) - -## AnswersHeadless.executeVerticalAutocomplete() method - -Performs an autocomplete request for a single vertical using the query input and vertical key stored in state. - -Signature: - -```typescript -executeVerticalAutocomplete(): Promise; -``` -Returns: - -Promise<[AutocompleteResponse](./answers-headless.autocompleteresponse.md) \| undefined> - -A Promise of an [AutocompleteResponse](./answers-headless.autocompleteresponse.md) from the Answers API or of undefined if there is no verticalKey defined in state - diff --git a/docs/answers-headless.answersheadless.executeverticalquery.md b/docs/answers-headless.answersheadless.executeverticalquery.md deleted file mode 100644 index afaf26c5..00000000 --- a/docs/answers-headless.answersheadless.executeverticalquery.md +++ /dev/null @@ -1,19 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [AnswersHeadless](./answers-headless.answersheadless.md) > [executeVerticalQuery](./answers-headless.answersheadless.executeverticalquery.md) - -## AnswersHeadless.executeVerticalQuery() method - -Perform an Answers search for a single vertical with relevant parts of the state used as input to the search. Updates the state with the response data. - -Signature: - -```typescript -executeVerticalQuery(): Promise; -``` -Returns: - -Promise<[VerticalSearchResponse](./answers-headless.verticalsearchresponse.md) \| undefined> - -A Promise of a [VerticalSearchResponse](./answers-headless.verticalsearchresponse.md) from the Answers API or of undefined if there is no verticalKey defined in state - diff --git a/docs/answers-headless.answersheadless.md b/docs/answers-headless.answersheadless.md deleted file mode 100644 index 6a9412ad..00000000 --- a/docs/answers-headless.answersheadless.md +++ /dev/null @@ -1,62 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [AnswersHeadless](./answers-headless.answersheadless.md) - -## AnswersHeadless class - -Provides the functionality for interacting with an Answers Search experience. - -Signature: - -```typescript -export default class AnswersHeadless -``` - -## Constructors - -| Constructor | Modifiers | Description | -| --- | --- | --- | -| [(constructor)(core, stateManager, httpManager, additionalHttpHeaders)](./answers-headless.answersheadless._constructor_.md) | | Constructs a new instance of the AnswersHeadless class | - -## Properties - -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [state](./answers-headless.answersheadless.state.md) | | [State](./answers-headless.state.md) | Gets the current state of the AnswersHeadless instance. | -| [utilities](./answers-headless.answersheadless.utilities.md) | | typeof answersUtilities | Common utility functions for manipulating Answers-related data. | - -## Methods - -| Method | Modifiers | Description | -| --- | --- | --- | -| [addListener(listener)](./answers-headless.answersheadless.addlistener.md) | | Adds a listener for a specific state value of type T. | -| [executeFilterSearch(query, sectioned, fields)](./answers-headless.answersheadless.executefiltersearch.md) | | Performs a filtersearch request against specified fields within a single vertical using the vertical key stored in state. | -| [executeUniversalAutocomplete()](./answers-headless.answersheadless.executeuniversalautocomplete.md) | | Performs an autocomplete request across all verticals using the query input stored in state. | -| [executeUniversalQuery()](./answers-headless.answersheadless.executeuniversalquery.md) | | Performs an Answers search across all verticals with relevant parts of the state used as input to the search. Updates the state with the response data. | -| [executeVerticalAutocomplete()](./answers-headless.answersheadless.executeverticalautocomplete.md) | | Performs an autocomplete request for a single vertical using the query input and vertical key stored in state. | -| [executeVerticalQuery()](./answers-headless.answersheadless.executeverticalquery.md) | | Perform an Answers search for a single vertical with relevant parts of the state used as input to the search. Updates the state with the response data. | -| [resetFacets()](./answers-headless.answersheadless.resetfacets.md) | | Unselects all [facets](./answers-headless.filtersstate.facets.md). | -| [setAlternativeVerticals(alternativeVerticals)](./answers-headless.answersheadless.setalternativeverticals.md) | | Sets the alternativeVerticals for [VerticalSearchState.noResults](./answers-headless.verticalsearchstate.noresults.md) to the specified verticals. | -| [setContext(context)](./answers-headless.answersheadless.setcontext.md) | | Sets [MetaState.context](./answers-headless.metastate.context.md) to the specified context. | -| [setFacetOption(fieldId, facetOption, selected)](./answers-headless.answersheadless.setfacetoption.md) | | Sets a specified facet option to be selected or unselected. | -| [setFacets(facets)](./answers-headless.answersheadless.setfacets.md) | | Sets [FiltersState.facets](./answers-headless.filtersstate.facets.md) to the specified facets. | -| [setFilterOption(filter)](./answers-headless.answersheadless.setfilteroption.md) | | Sets a static filter option and whether or not it is selected in state. | -| [setOffset(offset)](./answers-headless.answersheadless.setoffset.md) | | Sets [VerticalSearchState.offset](./answers-headless.verticalsearchstate.offset.md) to the specified offset. | -| [setQuery(input)](./answers-headless.answersheadless.setquery.md) | | Sets [QueryState.input](./answers-headless.querystate.input.md) to the specified input. | -| [setQuerySource(source)](./answers-headless.answersheadless.setquerysource.md) | | Sets [QueryState.querySource](./answers-headless.querystate.querysource.md) to the specified source. | -| [setQueryTrigger(trigger)](./answers-headless.answersheadless.setquerytrigger.md) | | Sets [QueryState.queryTrigger](./answers-headless.querystate.querytrigger.md) to the specified trigger. | -| [setReferrerPageUrl(referrerPageUrl)](./answers-headless.answersheadless.setreferrerpageurl.md) | | Sets [MetaState.referrerPageUrl](./answers-headless.metastate.referrerpageurl.md) to the specified URL. | -| [setRestrictVerticals(restrictVerticals)](./answers-headless.answersheadless.setrestrictverticals.md) | | Sets [UniversalSearchState.restrictVerticals](./answers-headless.universalsearchstate.restrictverticals.md) to the specified vertical keys. | -| [setSessionId(sessionId)](./answers-headless.answersheadless.setsessionid.md) | | Sets [SessionTrackingState.sessionId](./answers-headless.sessiontrackingstate.sessionid.md) to the specified ID. | -| [setSessionTrackingEnabled(enabled)](./answers-headless.answersheadless.setsessiontrackingenabled.md) | | Sets [SessionTrackingState.enabled](./answers-headless.sessiontrackingstate.enabled.md) to the specified boolean value. | -| [setSortBys(sortBys)](./answers-headless.answersheadless.setsortbys.md) | | Sets [VerticalSearchState.sortBys](./answers-headless.verticalsearchstate.sortbys.md) to the specified sortBys. | -| [setSpellCheckEnabled(enabled)](./answers-headless.answersheadless.setspellcheckenabled.md) | | Sets [SpellCheckState.enabled](./answers-headless.spellcheckstate.enabled.md) to the specified boolean value. | -| [setState(state)](./answers-headless.answersheadless.setstate.md) | | Sets the [State](./answers-headless.state.md) to the specified state. | -| [setStaticFilters(filters)](./answers-headless.answersheadless.setstaticfilters.md) | | Sets [FiltersState.static](./answers-headless.filtersstate.static.md) to the specified filters. | -| [setUniversal()](./answers-headless.answersheadless.setuniversal.md) | | Sets up Headless to manage universal searches. | -| [setUniversalLimit(limit)](./answers-headless.answersheadless.setuniversallimit.md) | | Sets [UniversalSearchState.limit](./answers-headless.universalsearchstate.limit.md) to the specified limit. | -| [setUserLocation(latLong)](./answers-headless.answersheadless.setuserlocation.md) | | Sets [LocationState.userLocation](./answers-headless.locationstate.userlocation.md) to the specified latitude and longitude. | -| [setVertical(verticalKey)](./answers-headless.answersheadless.setvertical.md) | | Sets up Headless to manage the vertical indicated by the verticalKey. | -| [setVerticalLimit(limit)](./answers-headless.answersheadless.setverticallimit.md) | | Sets [VerticalSearchState.limit](./answers-headless.verticalsearchstate.limit.md) to the specified limit. | -| [submitQuestion(request)](./answers-headless.answersheadless.submitquestion.md) | | Submits a question to the Answers API with the specified request data. | - diff --git a/docs/answers-headless.answersheadless.resetfacets.md b/docs/answers-headless.answersheadless.resetfacets.md deleted file mode 100644 index 5f343649..00000000 --- a/docs/answers-headless.answersheadless.resetfacets.md +++ /dev/null @@ -1,17 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [AnswersHeadless](./answers-headless.answersheadless.md) > [resetFacets](./answers-headless.answersheadless.resetfacets.md) - -## AnswersHeadless.resetFacets() method - -Unselects all [facets](./answers-headless.filtersstate.facets.md). - -Signature: - -```typescript -resetFacets(): void; -``` -Returns: - -void - diff --git a/docs/answers-headless.answersheadless.setalternativeverticals.md b/docs/answers-headless.answersheadless.setalternativeverticals.md deleted file mode 100644 index fd3ac88b..00000000 --- a/docs/answers-headless.answersheadless.setalternativeverticals.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [AnswersHeadless](./answers-headless.answersheadless.md) > [setAlternativeVerticals](./answers-headless.answersheadless.setalternativeverticals.md) - -## AnswersHeadless.setAlternativeVerticals() method - -Sets the alternativeVerticals for [VerticalSearchState.noResults](./answers-headless.verticalsearchstate.noresults.md) to the specified verticals. - -Signature: - -```typescript -setAlternativeVerticals(alternativeVerticals: VerticalResults[]): void; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| alternativeVerticals | [VerticalResults](./answers-headless.verticalresults.md)\[\] | The alternative verticals to set | - -Returns: - -void - diff --git a/docs/answers-headless.answersheadless.setcontext.md b/docs/answers-headless.answersheadless.setcontext.md deleted file mode 100644 index 163775d3..00000000 --- a/docs/answers-headless.answersheadless.setcontext.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [AnswersHeadless](./answers-headless.answersheadless.md) > [setContext](./answers-headless.answersheadless.setcontext.md) - -## AnswersHeadless.setContext() method - -Sets [MetaState.context](./answers-headless.metastate.context.md) to the specified context. - -Signature: - -```typescript -setContext(context: Context): void; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| context | [Context](./answers-headless.context.md) | The context to set | - -Returns: - -void - diff --git a/docs/answers-headless.answersheadless.setfacets.md b/docs/answers-headless.answersheadless.setfacets.md deleted file mode 100644 index aa965ded..00000000 --- a/docs/answers-headless.answersheadless.setfacets.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [AnswersHeadless](./answers-headless.answersheadless.md) > [setFacets](./answers-headless.answersheadless.setfacets.md) - -## AnswersHeadless.setFacets() method - -Sets [FiltersState.facets](./answers-headless.filtersstate.facets.md) to the specified facets. - -Signature: - -```typescript -setFacets(facets: DisplayableFacet[]): void; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| facets | [DisplayableFacet](./answers-headless.displayablefacet.md)\[\] | The facets to set | - -Returns: - -void - diff --git a/docs/answers-headless.answersheadless.setfilteroption.md b/docs/answers-headless.answersheadless.setfilteroption.md deleted file mode 100644 index c6b6fa52..00000000 --- a/docs/answers-headless.answersheadless.setfilteroption.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [AnswersHeadless](./answers-headless.answersheadless.md) > [setFilterOption](./answers-headless.answersheadless.setfilteroption.md) - -## AnswersHeadless.setFilterOption() method - -Sets a static filter option and whether or not it is selected in state. - -Signature: - -```typescript -setFilterOption(filter: SelectableFilter): void; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| filter | [SelectableFilter](./answers-headless.selectablefilter.md) | The static filter and whether it is selected | - -Returns: - -void - diff --git a/docs/answers-headless.answersheadless.setoffset.md b/docs/answers-headless.answersheadless.setoffset.md deleted file mode 100644 index 1ce881d7..00000000 --- a/docs/answers-headless.answersheadless.setoffset.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [AnswersHeadless](./answers-headless.answersheadless.md) > [setOffset](./answers-headless.answersheadless.setoffset.md) - -## AnswersHeadless.setOffset() method - -Sets [VerticalSearchState.offset](./answers-headless.verticalsearchstate.offset.md) to the specified offset. - -Signature: - -```typescript -setOffset(offset: number): void; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| offset | number | The vertical offset to set | - -Returns: - -void - diff --git a/docs/answers-headless.answersheadless.setquery.md b/docs/answers-headless.answersheadless.setquery.md deleted file mode 100644 index 886df033..00000000 --- a/docs/answers-headless.answersheadless.setquery.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [AnswersHeadless](./answers-headless.answersheadless.md) > [setQuery](./answers-headless.answersheadless.setquery.md) - -## AnswersHeadless.setQuery() method - -Sets [QueryState.input](./answers-headless.querystate.input.md) to the specified input. - -Signature: - -```typescript -setQuery(input: string): void; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| input | string | The input to set | - -Returns: - -void - diff --git a/docs/answers-headless.answersheadless.setquerysource.md b/docs/answers-headless.answersheadless.setquerysource.md deleted file mode 100644 index f252919e..00000000 --- a/docs/answers-headless.answersheadless.setquerysource.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [AnswersHeadless](./answers-headless.answersheadless.md) > [setQuerySource](./answers-headless.answersheadless.setquerysource.md) - -## AnswersHeadless.setQuerySource() method - -Sets [QueryState.querySource](./answers-headless.querystate.querysource.md) to the specified source. - -Signature: - -```typescript -setQuerySource(source: QuerySource): void; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| source | [QuerySource](./answers-headless.querysource.md) | The query source to set | - -Returns: - -void - diff --git a/docs/answers-headless.answersheadless.setquerytrigger.md b/docs/answers-headless.answersheadless.setquerytrigger.md deleted file mode 100644 index 369b9e69..00000000 --- a/docs/answers-headless.answersheadless.setquerytrigger.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [AnswersHeadless](./answers-headless.answersheadless.md) > [setQueryTrigger](./answers-headless.answersheadless.setquerytrigger.md) - -## AnswersHeadless.setQueryTrigger() method - -Sets [QueryState.queryTrigger](./answers-headless.querystate.querytrigger.md) to the specified trigger. - -Signature: - -```typescript -setQueryTrigger(trigger: QueryTrigger): void; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| trigger | [QueryTrigger](./answers-headless.querytrigger.md) | The query trigger to set | - -Returns: - -void - diff --git a/docs/answers-headless.answersheadless.setreferrerpageurl.md b/docs/answers-headless.answersheadless.setreferrerpageurl.md deleted file mode 100644 index c3030fd2..00000000 --- a/docs/answers-headless.answersheadless.setreferrerpageurl.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [AnswersHeadless](./answers-headless.answersheadless.md) > [setReferrerPageUrl](./answers-headless.answersheadless.setreferrerpageurl.md) - -## AnswersHeadless.setReferrerPageUrl() method - -Sets [MetaState.referrerPageUrl](./answers-headless.metastate.referrerpageurl.md) to the specified URL. - -Signature: - -```typescript -setReferrerPageUrl(referrerPageUrl: string): void; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| referrerPageUrl | string | The referring page URL to set | - -Returns: - -void - diff --git a/docs/answers-headless.answersheadless.setrestrictverticals.md b/docs/answers-headless.answersheadless.setrestrictverticals.md deleted file mode 100644 index 3a3c26e1..00000000 --- a/docs/answers-headless.answersheadless.setrestrictverticals.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [AnswersHeadless](./answers-headless.answersheadless.md) > [setRestrictVerticals](./answers-headless.answersheadless.setrestrictverticals.md) - -## AnswersHeadless.setRestrictVerticals() method - -Sets [UniversalSearchState.restrictVerticals](./answers-headless.universalsearchstate.restrictverticals.md) to the specified vertical keys. - -Signature: - -```typescript -setRestrictVerticals(restrictVerticals: string[]): void; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| restrictVerticals | string\[\] | The new verticals to restrict a universal search | - -Returns: - -void - diff --git a/docs/answers-headless.answersheadless.setsessionid.md b/docs/answers-headless.answersheadless.setsessionid.md deleted file mode 100644 index 1cb3ea00..00000000 --- a/docs/answers-headless.answersheadless.setsessionid.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [AnswersHeadless](./answers-headless.answersheadless.md) > [setSessionId](./answers-headless.answersheadless.setsessionid.md) - -## AnswersHeadless.setSessionId() method - -Sets [SessionTrackingState.sessionId](./answers-headless.sessiontrackingstate.sessionid.md) to the specified ID. - -Signature: - -```typescript -setSessionId(sessionId: string): void; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| sessionId | string | The session ID to set | - -Returns: - -void - diff --git a/docs/answers-headless.answersheadless.setsessiontrackingenabled.md b/docs/answers-headless.answersheadless.setsessiontrackingenabled.md deleted file mode 100644 index e060e3ff..00000000 --- a/docs/answers-headless.answersheadless.setsessiontrackingenabled.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [AnswersHeadless](./answers-headless.answersheadless.md) > [setSessionTrackingEnabled](./answers-headless.answersheadless.setsessiontrackingenabled.md) - -## AnswersHeadless.setSessionTrackingEnabled() method - -Sets [SessionTrackingState.enabled](./answers-headless.sessiontrackingstate.enabled.md) to the specified boolean value. - -Signature: - -```typescript -setSessionTrackingEnabled(enabled: boolean): void; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| enabled | boolean | Whether or not session tracking should be set to enabled | - -Returns: - -void - diff --git a/docs/answers-headless.answersheadless.setsortbys.md b/docs/answers-headless.answersheadless.setsortbys.md deleted file mode 100644 index d3ba1c0f..00000000 --- a/docs/answers-headless.answersheadless.setsortbys.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [AnswersHeadless](./answers-headless.answersheadless.md) > [setSortBys](./answers-headless.answersheadless.setsortbys.md) - -## AnswersHeadless.setSortBys() method - -Sets [VerticalSearchState.sortBys](./answers-headless.verticalsearchstate.sortbys.md) to the specified sortBys. - -Signature: - -```typescript -setSortBys(sortBys: SortBy[]): void; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| sortBys | [SortBy](./answers-headless.sortby.md)\[\] | The sortBys to set | - -Returns: - -void - diff --git a/docs/answers-headless.answersheadless.setspellcheckenabled.md b/docs/answers-headless.answersheadless.setspellcheckenabled.md deleted file mode 100644 index 826a397d..00000000 --- a/docs/answers-headless.answersheadless.setspellcheckenabled.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [AnswersHeadless](./answers-headless.answersheadless.md) > [setSpellCheckEnabled](./answers-headless.answersheadless.setspellcheckenabled.md) - -## AnswersHeadless.setSpellCheckEnabled() method - -Sets [SpellCheckState.enabled](./answers-headless.spellcheckstate.enabled.md) to the specified boolean value. - -Signature: - -```typescript -setSpellCheckEnabled(enabled: boolean): void; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| enabled | boolean | Whether or not spellcheck should be set to enabled | - -Returns: - -void - diff --git a/docs/answers-headless.answersheadless.setstate.md b/docs/answers-headless.answersheadless.setstate.md deleted file mode 100644 index 0448da9c..00000000 --- a/docs/answers-headless.answersheadless.setstate.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [AnswersHeadless](./answers-headless.answersheadless.md) > [setState](./answers-headless.answersheadless.setstate.md) - -## AnswersHeadless.setState() method - -Sets the [State](./answers-headless.state.md) to the specified state. - -Signature: - -```typescript -setState(state: State): void; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| state | [State](./answers-headless.state.md) | The state to set | - -Returns: - -void - diff --git a/docs/answers-headless.answersheadless.setstaticfilters.md b/docs/answers-headless.answersheadless.setstaticfilters.md deleted file mode 100644 index 1f9a7509..00000000 --- a/docs/answers-headless.answersheadless.setstaticfilters.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [AnswersHeadless](./answers-headless.answersheadless.md) > [setStaticFilters](./answers-headless.answersheadless.setstaticfilters.md) - -## AnswersHeadless.setStaticFilters() method - -Sets [FiltersState.static](./answers-headless.filtersstate.static.md) to the specified filters. - -Signature: - -```typescript -setStaticFilters(filters: SelectableFilter[]): void; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| filters | [SelectableFilter](./answers-headless.selectablefilter.md)\[\] | The static filters to set | - -Returns: - -void - diff --git a/docs/answers-headless.answersheadless.setuniversal.md b/docs/answers-headless.answersheadless.setuniversal.md deleted file mode 100644 index c39e1e55..00000000 --- a/docs/answers-headless.answersheadless.setuniversal.md +++ /dev/null @@ -1,17 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [AnswersHeadless](./answers-headless.answersheadless.md) > [setUniversal](./answers-headless.answersheadless.setuniversal.md) - -## AnswersHeadless.setUniversal() method - -Sets up Headless to manage universal searches. - -Signature: - -```typescript -setUniversal(): void; -``` -Returns: - -void - diff --git a/docs/answers-headless.answersheadless.setuniversallimit.md b/docs/answers-headless.answersheadless.setuniversallimit.md deleted file mode 100644 index 5ebd9326..00000000 --- a/docs/answers-headless.answersheadless.setuniversallimit.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [AnswersHeadless](./answers-headless.answersheadless.md) > [setUniversalLimit](./answers-headless.answersheadless.setuniversallimit.md) - -## AnswersHeadless.setUniversalLimit() method - -Sets [UniversalSearchState.limit](./answers-headless.universalsearchstate.limit.md) to the specified limit. - -Signature: - -```typescript -setUniversalLimit(limit: UniversalLimit): void; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| limit | [UniversalLimit](./answers-headless.universallimit.md) | The universal limit to set | - -Returns: - -void - diff --git a/docs/answers-headless.answersheadless.setuserlocation.md b/docs/answers-headless.answersheadless.setuserlocation.md deleted file mode 100644 index 60af107f..00000000 --- a/docs/answers-headless.answersheadless.setuserlocation.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [AnswersHeadless](./answers-headless.answersheadless.md) > [setUserLocation](./answers-headless.answersheadless.setuserlocation.md) - -## AnswersHeadless.setUserLocation() method - -Sets [LocationState.userLocation](./answers-headless.locationstate.userlocation.md) to the specified latitude and longitude. - -Signature: - -```typescript -setUserLocation(latLong: LatLong): void; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| latLong | [LatLong](./answers-headless.latlong.md) | The user location to set | - -Returns: - -void - diff --git a/docs/answers-headless.answersheadless.setverticallimit.md b/docs/answers-headless.answersheadless.setverticallimit.md deleted file mode 100644 index 7f523bbf..00000000 --- a/docs/answers-headless.answersheadless.setverticallimit.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [AnswersHeadless](./answers-headless.answersheadless.md) > [setVerticalLimit](./answers-headless.answersheadless.setverticallimit.md) - -## AnswersHeadless.setVerticalLimit() method - -Sets [VerticalSearchState.limit](./answers-headless.verticalsearchstate.limit.md) to the specified limit. - -Signature: - -```typescript -setVerticalLimit(limit: number): void; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| limit | number | The vertical limit to set | - -Returns: - -void - diff --git a/docs/answers-headless.answersheadless.state.md b/docs/answers-headless.answersheadless.state.md deleted file mode 100644 index 6e27b136..00000000 --- a/docs/answers-headless.answersheadless.state.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [AnswersHeadless](./answers-headless.answersheadless.md) > [state](./answers-headless.answersheadless.state.md) - -## AnswersHeadless.state property - -Gets the current state of the AnswersHeadless instance. - -Signature: - -```typescript -get state(): State; -``` diff --git a/docs/answers-headless.answersheadless.submitquestion.md b/docs/answers-headless.answersheadless.submitquestion.md deleted file mode 100644 index a7244afc..00000000 --- a/docs/answers-headless.answersheadless.submitquestion.md +++ /dev/null @@ -1,26 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [AnswersHeadless](./answers-headless.answersheadless.md) > [submitQuestion](./answers-headless.answersheadless.submitquestion.md) - -## AnswersHeadless.submitQuestion() method - -Submits a question to the Answers API with the specified request data. - -Signature: - -```typescript -submitQuestion(request: Omit): Promise; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| request | Omit<[QuestionSubmissionRequest](./answers-headless.questionsubmissionrequest.md), 'additionalHttpHeaders'> | The data for the network request | - -Returns: - -Promise<[QuestionSubmissionResponse](./answers-headless.questionsubmissionresponse.md)> - -A Promise of a [QuestionSubmissionResponse](./answers-headless.questionsubmissionresponse.md) from the Answers API - diff --git a/docs/answers-headless.answersheadless.utilities.md b/docs/answers-headless.answersheadless.utilities.md deleted file mode 100644 index 6e8e1d23..00000000 --- a/docs/answers-headless.answersheadless.utilities.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [AnswersHeadless](./answers-headless.answersheadless.md) > [utilities](./answers-headless.answersheadless.utilities.md) - -## AnswersHeadless.utilities property - -Common utility functions for manipulating Answers-related data. - -Signature: - -```typescript -readonly utilities: typeof answersUtilities; -``` diff --git a/docs/answers-headless.answersrequest.md b/docs/answers-headless.answersrequest.md deleted file mode 100644 index ff4a3856..00000000 --- a/docs/answers-headless.answersrequest.md +++ /dev/null @@ -1,20 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [AnswersRequest](./answers-headless.answersrequest.md) - -## AnswersRequest interface - -Options for an Answers API request. - -Signature: - -```typescript -export declare interface AnswersRequest -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [additionalHttpHeaders?](./answers-headless.answersrequest.additionalhttpheaders.md) | [AdditionalHttpHeaders](./answers-headless.additionalhttpheaders.md) | (Optional) AdditionalHttpHeaders allows users to specify additional values for specific HTTP headers. | - diff --git a/docs/answers-headless.answersutilities.md b/docs/answers-headless.answersutilities.md deleted file mode 100644 index e949d7d1..00000000 --- a/docs/answers-headless.answersutilities.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [answersUtilities](./answers-headless.answersutilities.md) - -## answersUtilities namespace - -## Functions - -| Function | Description | -| --- | --- | -| [isCloseMatch(value, searchTerm)](./answers-headless.answersutilities.isclosematch.md) | Checks if the searchTerm is a case-insensitive, Levenshtein match for the value. | -| [searchThroughFacet(facet, searchTerm)](./answers-headless.answersutilities.searchthroughfacet.md) | Searches through the specified facet and filters out the options that aren't a close match for the given searchTerm. The comparison is case insensitive. | - diff --git a/docs/answers-headless.appliedqueryfilter.details.md b/docs/answers-headless.appliedqueryfilter.details.md deleted file mode 100644 index ab8f53cb..00000000 --- a/docs/answers-headless.appliedqueryfilter.details.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [AppliedQueryFilter](./answers-headless.appliedqueryfilter.md) > [details](./answers-headless.appliedqueryfilter.details.md) - -## AppliedQueryFilter.details property - -Additional details relevant to the filter with "PLACE" for its [AppliedQueryFilterType](./answers-headless.appliedqueryfiltertype.md). - -Signature: - -```typescript -details?: LocationFilterDetails; -``` diff --git a/docs/answers-headless.appliedqueryfilter.md b/docs/answers-headless.appliedqueryfilter.md deleted file mode 100644 index b9e0d03f..00000000 --- a/docs/answers-headless.appliedqueryfilter.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [AppliedQueryFilter](./answers-headless.appliedqueryfilter.md) - -## AppliedQueryFilter interface - -A filter that the Answers API applied to the search. - -Signature: - -```typescript -export declare interface AppliedQueryFilter -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [details?](./answers-headless.appliedqueryfilter.details.md) | [LocationFilterDetails](./answers-headless.locationfilterdetails.md) | (Optional) Additional details relevant to the filter with "PLACE" for its [AppliedQueryFilterType](./answers-headless.appliedqueryfiltertype.md). | -| [displayKey](./answers-headless.appliedqueryfilter.displaykey.md) | string | The display name of the filter key. | -| [displayValue](./answers-headless.appliedqueryfilter.displayvalue.md) | string | The value used in the filter. | -| [filter](./answers-headless.appliedqueryfilter.filter.md) | [Filter](./answers-headless.filter.md) | The filter applied to the query results. | -| [type](./answers-headless.appliedqueryfilter.type.md) | [AppliedQueryFilterType](./answers-headless.appliedqueryfiltertype.md) | Represents the type of [AppliedQueryFilter](./answers-headless.appliedqueryfilter.md) applied to a search. | - diff --git a/docs/answers-headless.appliedqueryfilter.type.md b/docs/answers-headless.appliedqueryfilter.type.md deleted file mode 100644 index 92f29bb0..00000000 --- a/docs/answers-headless.appliedqueryfilter.type.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [AppliedQueryFilter](./answers-headless.appliedqueryfilter.md) > [type](./answers-headless.appliedqueryfilter.type.md) - -## AppliedQueryFilter.type property - -Represents the type of [AppliedQueryFilter](./answers-headless.appliedqueryfilter.md) applied to a search. - -Signature: - -```typescript -type: AppliedQueryFilterType; -``` diff --git a/docs/answers-headless.autocompleteresponse.md b/docs/answers-headless.autocompleteresponse.md deleted file mode 100644 index 431579ea..00000000 --- a/docs/answers-headless.autocompleteresponse.md +++ /dev/null @@ -1,23 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [AutocompleteResponse](./answers-headless.autocompleteresponse.md) - -## AutocompleteResponse interface - -The response of a universal or vertical autocomplete request. - -Signature: - -```typescript -export declare interface AutocompleteResponse -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [inputIntents](./answers-headless.autocompleteresponse.inputintents.md) | [SearchIntent](./answers-headless.searchintent.md)\[\] | Represents intents from the Answers API. | -| [queryId?](./answers-headless.autocompleteresponse.queryid.md) | string | (Optional) The ID of the search query. | -| [results](./answers-headless.autocompleteresponse.results.md) | [AutocompleteResult](./answers-headless.autocompleteresult.md)\[\] | An array of [AutocompleteResult](./answers-headless.autocompleteresult.md)s. | -| [uuid](./answers-headless.autocompleteresponse.uuid.md) | string | A unique id which corresponds to the request. | - diff --git a/docs/answers-headless.autocompleteresponse.queryid.md b/docs/answers-headless.autocompleteresponse.queryid.md deleted file mode 100644 index f8ed4a91..00000000 --- a/docs/answers-headless.autocompleteresponse.queryid.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [AutocompleteResponse](./answers-headless.autocompleteresponse.md) > [queryId](./answers-headless.autocompleteresponse.queryid.md) - -## AutocompleteResponse.queryId property - -The ID of the search query. - -Signature: - -```typescript -queryId?: string; -``` diff --git a/docs/answers-headless.autocompleteresponse.results.md b/docs/answers-headless.autocompleteresponse.results.md deleted file mode 100644 index 4adc0ee7..00000000 --- a/docs/answers-headless.autocompleteresponse.results.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [AutocompleteResponse](./answers-headless.autocompleteresponse.md) > [results](./answers-headless.autocompleteresponse.results.md) - -## AutocompleteResponse.results property - -An array of [AutocompleteResult](./answers-headless.autocompleteresult.md)s. - -Signature: - -```typescript -results: AutocompleteResult[]; -``` diff --git a/docs/answers-headless.autocompleteresult.md b/docs/answers-headless.autocompleteresult.md deleted file mode 100644 index b698b8da..00000000 --- a/docs/answers-headless.autocompleteresult.md +++ /dev/null @@ -1,25 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [AutocompleteResult](./answers-headless.autocompleteresult.md) - -## AutocompleteResult interface - -An autocomplete suggestion. - -Signature: - -```typescript -export declare interface AutocompleteResult -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [filter?](./answers-headless.autocompleteresult.filter.md) | [Filter](./answers-headless.filter.md) | (Optional) A filter applied to the autocomplete response. | -| [key?](./answers-headless.autocompleteresult.key.md) | string | (Optional) The fieldId which corresponds to the AutocompleteResult value. | -| [matchedSubstrings?](./answers-headless.autocompleteresult.matchedsubstrings.md) | { length: number; offset: number; }\[\] | (Optional) An array of substrings which overlap with the autocomplete input. | -| [relatedItem?](./answers-headless.autocompleteresult.relateditem.md) | [Result](./answers-headless.result.md) | (Optional) An entity that corresponds to the autocomplete result. | -| [value](./answers-headless.autocompleteresult.value.md) | string | The value of an autocomplete suggestion. | -| [verticalKeys?](./answers-headless.autocompleteresult.verticalkeys.md) | string\[\] | (Optional) Any vertical keys associated with a prompt. This only shows up on universal autocomplete requests. | - diff --git a/docs/answers-headless.autocompleteresult.relateditem.md b/docs/answers-headless.autocompleteresult.relateditem.md deleted file mode 100644 index 7ba34401..00000000 --- a/docs/answers-headless.autocompleteresult.relateditem.md +++ /dev/null @@ -1,18 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [AutocompleteResult](./answers-headless.autocompleteresult.md) > [relatedItem](./answers-headless.autocompleteresult.relateditem.md) - -## AutocompleteResult.relatedItem property - -An entity that corresponds to the autocomplete result. - -Signature: - -```typescript -relatedItem?: Result; -``` - -## Remarks - -This property is only defined if the corresponding [SearchParameterField.fetchEntities](./answers-headless.searchparameterfield.fetchentities.md) field is true. - diff --git a/docs/answers-headless.autocompleteservice.filtersearch.md b/docs/answers-headless.autocompleteservice.filtersearch.md deleted file mode 100644 index 0fe5e67c..00000000 --- a/docs/answers-headless.autocompleteservice.filtersearch.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [AutocompleteService](./answers-headless.autocompleteservice.md) > [filterSearch](./answers-headless.autocompleteservice.filtersearch.md) - -## AutocompleteService.filterSearch() method - -Retrieves query suggestions for filter search. - -Signature: - -```typescript -filterSearch(request: FilterSearchRequest): Promise; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| request | [FilterSearchRequest](./answers-headless.filtersearchrequest.md) | | - -Returns: - -Promise<[FilterSearchResponse](./answers-headless.filtersearchresponse.md)> - diff --git a/docs/answers-headless.autocompleteservice.md b/docs/answers-headless.autocompleteservice.md deleted file mode 100644 index 3eab6629..00000000 --- a/docs/answers-headless.autocompleteservice.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [AutocompleteService](./answers-headless.autocompleteservice.md) - -## AutocompleteService interface - -A service for autocomplete requests. - -Signature: - -```typescript -export declare interface AutocompleteService -``` - -## Methods - -| Method | Description | -| --- | --- | -| [filterSearch(request)](./answers-headless.autocompleteservice.filtersearch.md) | Retrieves query suggestions for filter search. | -| [universalAutocomplete(request)](./answers-headless.autocompleteservice.universalautocomplete.md) | Retrieves query suggestions for universal. | -| [verticalAutocomplete(request)](./answers-headless.autocompleteservice.verticalautocomplete.md) | Retrieves query suggestions for a vertical. | - diff --git a/docs/answers-headless.autocompleteservice.universalautocomplete.md b/docs/answers-headless.autocompleteservice.universalautocomplete.md deleted file mode 100644 index bc76dd2e..00000000 --- a/docs/answers-headless.autocompleteservice.universalautocomplete.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [AutocompleteService](./answers-headless.autocompleteservice.md) > [universalAutocomplete](./answers-headless.autocompleteservice.universalautocomplete.md) - -## AutocompleteService.universalAutocomplete() method - -Retrieves query suggestions for universal. - -Signature: - -```typescript -universalAutocomplete(request: UniversalAutocompleteRequest): Promise; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| request | [UniversalAutocompleteRequest](./answers-headless.universalautocompleterequest.md) | | - -Returns: - -Promise<[AutocompleteResponse](./answers-headless.autocompleteresponse.md)> - diff --git a/docs/answers-headless.autocompleteservice.verticalautocomplete.md b/docs/answers-headless.autocompleteservice.verticalautocomplete.md deleted file mode 100644 index 1c5d24e3..00000000 --- a/docs/answers-headless.autocompleteservice.verticalautocomplete.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [AutocompleteService](./answers-headless.autocompleteservice.md) > [verticalAutocomplete](./answers-headless.autocompleteservice.verticalautocomplete.md) - -## AutocompleteService.verticalAutocomplete() method - -Retrieves query suggestions for a vertical. - -Signature: - -```typescript -verticalAutocomplete(request: VerticalAutocompleteRequest): Promise; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| request | [VerticalAutocompleteRequest](./answers-headless.verticalautocompleterequest.md) | | - -Returns: - -Promise<[AutocompleteResponse](./answers-headless.autocompleteresponse.md)> - diff --git a/docs/answers-headless.baseanswersconfig.md b/docs/answers-headless.baseanswersconfig.md deleted file mode 100644 index 72e0751e..00000000 --- a/docs/answers-headless.baseanswersconfig.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [BaseAnswersConfig](./answers-headless.baseanswersconfig.md) - -## BaseAnswersConfig interface - -The base configuration options for [AnswersCore](./answers-headless.answerscore.md). - -Signature: - -```typescript -export declare interface BaseAnswersConfig -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [endpoints?](./answers-headless.baseanswersconfig.endpoints.md) | [Endpoints](./answers-headless.endpoints.md) | (Optional) Overrides for the URLs which are used when making requests to the Answers API. | -| [experienceKey](./answers-headless.baseanswersconfig.experiencekey.md) | string | The experience key of the answers experience. | -| [experienceVersion?](./answers-headless.baseanswersconfig.experienceversion.md) | 'STAGING' \| 'PRODUCTION' \| string \| number | (Optional) The version of the answers experience configuration. | -| [locale](./answers-headless.baseanswersconfig.locale.md) | string | The locale of the answers experience. | -| [visitor?](./answers-headless.baseanswersconfig.visitor.md) | [Visitor](./answers-headless.visitor.md) | (Optional) Information used to associate requests with a particular user. | - diff --git a/docs/answers-headless.boundedrange.md b/docs/answers-headless.boundedrange.md deleted file mode 100644 index 81aabd98..00000000 --- a/docs/answers-headless.boundedrange.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [BoundedRange](./answers-headless.boundedrange.md) - -## BoundedRange interface - -An interface representing a range of values of type T. - -Signature: - -```typescript -export interface BoundedRange -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [max?](./answers-headless.boundedrange.max.md) | [RangeBoundary](./answers-headless.rangeboundary.md)<T> | (Optional) The maximum value bounding the range. | -| [min?](./answers-headless.boundedrange.min.md) | [RangeBoundary](./answers-headless.rangeboundary.md)<T> | (Optional) The minimum value bounding the range. | - diff --git a/docs/answers-headless.combinedfilter.md b/docs/answers-headless.combinedfilter.md deleted file mode 100644 index b3ab072e..00000000 --- a/docs/answers-headless.combinedfilter.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [CombinedFilter](./answers-headless.combinedfilter.md) - -## CombinedFilter interface - -Represents multiple filters that will be combined to refine results. - -Signature: - -```typescript -export declare interface CombinedFilter -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [combinator](./answers-headless.combinedfilter.combinator.md) | [FilterCombinator](./answers-headless.filtercombinator.md) | The logical operator used to combine the filters. | -| [filters](./answers-headless.combinedfilter.filters.md) | ([Filter](./answers-headless.filter.md) \| [CombinedFilter](./answers-headless.combinedfilter.md))\[\] | An array of filters applied to the search. | - diff --git a/docs/answers-headless.combinefilters.md b/docs/answers-headless.combinefilters.md deleted file mode 100644 index 4090b145..00000000 --- a/docs/answers-headless.combinefilters.md +++ /dev/null @@ -1,28 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [combineFilters](./answers-headless.combinefilters.md) - -## combineFilters() function - -Creates a [CombinedFilter](./answers-headless.combinedfilter.md) by applying the specified [FilterCombinator](./answers-headless.filtercombinator.md) to the two filters. - -Signature: - -```typescript -export declare function combineFilters(filterA: FilterTypes, filterB: FilterTypes, combinator: FilterCombinator): CombinedFilter; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| filterA | [FilterTypes](./answers-headless.filtertypes.md) | The first filter to be combined | -| filterB | [FilterTypes](./answers-headless.filtertypes.md) | The second filter to be combined | -| combinator | [FilterCombinator](./answers-headless.filtercombinator.md) | Specifies how the two filters should be joined | - -Returns: - -[CombinedFilter](./answers-headless.combinedfilter.md) - -The newly created [CombinedFilter](./answers-headless.combinedfilter.md) - diff --git a/docs/answers-headless.createdaterangefilter.md b/docs/answers-headless.createdaterangefilter.md deleted file mode 100644 index 51568552..00000000 --- a/docs/answers-headless.createdaterangefilter.md +++ /dev/null @@ -1,27 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [createDateRangeFilter](./answers-headless.createdaterangefilter.md) - -## createDateRangeFilter() function - -Creates a [Filter](./answers-headless.filter.md) or [CombinedFilter](./answers-headless.combinedfilter.md) that matches all results where the given field value falls in a specific Date [BoundedRange](./answers-headless.boundedrange.md). - -Signature: - -```typescript -export declare function createDateRangeFilter(fieldId: string, range: BoundedRange): FilterTypes; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| fieldId | string | The comparison field's identifier | -| range | [BoundedRange](./answers-headless.boundedrange.md)<Date> | The acceptable date range | - -Returns: - -[FilterTypes](./answers-headless.filtertypes.md) - -The newly created filter for the field value range - diff --git a/docs/answers-headless.createnearmefilter.md b/docs/answers-headless.createnearmefilter.md deleted file mode 100644 index 48763955..00000000 --- a/docs/answers-headless.createnearmefilter.md +++ /dev/null @@ -1,26 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [createNearMeFilter](./answers-headless.createnearmefilter.md) - -## createNearMeFilter() function - -Creates a [Filter](./answers-headless.filter.md) that matches all results within a certain radius of the given position. - -Signature: - -```typescript -export declare function createNearMeFilter(position: NearFilterValue): Filter; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| position | [NearFilterValue](./answers-headless.nearfiltervalue.md) | The position and radius | - -Returns: - -[Filter](./answers-headless.filter.md) - -The newly created [Filter](./answers-headless.filter.md) for the radius of the position - diff --git a/docs/answers-headless.createnumberrangefilter.md b/docs/answers-headless.createnumberrangefilter.md deleted file mode 100644 index a39204a0..00000000 --- a/docs/answers-headless.createnumberrangefilter.md +++ /dev/null @@ -1,27 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [createNumberRangeFilter](./answers-headless.createnumberrangefilter.md) - -## createNumberRangeFilter() function - -Creates a [Filter](./answers-headless.filter.md) or [CombinedFilter](./answers-headless.combinedfilter.md) that matches all results where the given field value falls in a specific number [BoundedRange](./answers-headless.boundedrange.md). - -Signature: - -```typescript -export declare function createNumberRangeFilter(fieldId: string, range: BoundedRange): FilterTypes; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| fieldId | string | The comparison field's identifier | -| range | [BoundedRange](./answers-headless.boundedrange.md)<number> | The acceptable number range | - -Returns: - -[FilterTypes](./answers-headless.filtertypes.md) - -The newly created filter for the field value range - diff --git a/docs/answers-headless.default_headless_id.md b/docs/answers-headless.default_headless_id.md deleted file mode 100644 index 0c00ae7a..00000000 --- a/docs/answers-headless.default_headless_id.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [DEFAULT\_HEADLESS\_ID](./answers-headless.default_headless_id.md) - -## DEFAULT\_HEADLESS\_ID variable - -The headlessId automatically given to the first AnswersHeadless instance created. - -Signature: - -```typescript -DEFAULT_HEADLESS_ID = "main" -``` diff --git a/docs/answers-headless.directanswer.md b/docs/answers-headless.directanswer.md deleted file mode 100644 index bbeccf20..00000000 --- a/docs/answers-headless.directanswer.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [DirectAnswer](./answers-headless.directanswer.md) - -## DirectAnswer interface - -A direct answer to a search. - -Signature: - -```typescript -export declare interface DirectAnswer -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [fieldType](./answers-headless.directanswer.fieldtype.md) | string | The field type of the direct answer. | -| [relatedResult](./answers-headless.directanswer.relatedresult.md) | [Result](./answers-headless.result.md) | The entity associated with the direct answer. | -| [type](./answers-headless.directanswer.type.md) | [DirectAnswerType](./answers-headless.directanswertype.md) | The [DirectAnswerType](./answers-headless.directanswertype.md). | -| [value?](./answers-headless.directanswer.value.md) | string | (Optional) The result of the direct answer. | -| [verticalKey](./answers-headless.directanswer.verticalkey.md) | string | The vertical key of the direct answer. | - diff --git a/docs/answers-headless.directanswer.type.md b/docs/answers-headless.directanswer.type.md deleted file mode 100644 index 317e1cef..00000000 --- a/docs/answers-headless.directanswer.type.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [DirectAnswer](./answers-headless.directanswer.md) > [type](./answers-headless.directanswer.type.md) - -## DirectAnswer.type property - -The [DirectAnswerType](./answers-headless.directanswertype.md). - -Signature: - -```typescript -type: DirectAnswerType; -``` diff --git a/docs/answers-headless.directanswer.value.md b/docs/answers-headless.directanswer.value.md deleted file mode 100644 index 33da78d8..00000000 --- a/docs/answers-headless.directanswer.value.md +++ /dev/null @@ -1,18 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [DirectAnswer](./answers-headless.directanswer.md) > [value](./answers-headless.directanswer.value.md) - -## DirectAnswer.value property - -The result of the direct answer. - -Signature: - -```typescript -value?: string; -``` - -## Remarks - -A value will not be present if the [DirectAnswer.fieldType](./answers-headless.directanswer.fieldtype.md) is 'rich\_text'. - diff --git a/docs/answers-headless.directanswerstate.md b/docs/answers-headless.directanswerstate.md deleted file mode 100644 index 59e94ca8..00000000 --- a/docs/answers-headless.directanswerstate.md +++ /dev/null @@ -1,20 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [DirectAnswerState](./answers-headless.directanswerstate.md) - -## DirectAnswerState interface - -Maintains the direct answer associated with the latest search. - -Signature: - -```typescript -export interface DirectAnswerState -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [result?](./answers-headless.directanswerstate.result.md) | [FeaturedSnippetDirectAnswer](./answers-headless.featuredsnippetdirectanswer.md) \| [FieldValueDirectAnswer](./answers-headless.fieldvaluedirectanswer.md) | (Optional) The data for the direct answer. The type of the data is determined by the Answers API based on whether the answer was found within a document or was a field value in the knowledge graph. | - diff --git a/docs/answers-headless.displayablefacet.fieldid.md b/docs/answers-headless.displayablefacet.fieldid.md deleted file mode 100644 index d29bd97d..00000000 --- a/docs/answers-headless.displayablefacet.fieldid.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [DisplayableFacet](./answers-headless.displayablefacet.md) > [fieldId](./answers-headless.displayablefacet.fieldid.md) - -## DisplayableFacet.fieldId property - -The associated fieldId. - -Signature: - -```typescript -fieldId: string; -``` diff --git a/docs/answers-headless.displayablefacet.md b/docs/answers-headless.displayablefacet.md deleted file mode 100644 index d31896b1..00000000 --- a/docs/answers-headless.displayablefacet.md +++ /dev/null @@ -1,23 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [DisplayableFacet](./answers-headless.displayablefacet.md) - -## DisplayableFacet interface - -A [Facet](./answers-headless.facet.md) which contains extra fields meant to be displayed to the end user. - -Signature: - -```typescript -export declare interface DisplayableFacet extends Facet -``` -Extends: [Facet](./answers-headless.facet.md) - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [displayName](./answers-headless.displayablefacet.displayname.md) | string | The name of the facet which is meant to be displayed to the user. | -| [fieldId](./answers-headless.displayablefacet.fieldid.md) | string | The associated fieldId. | -| [options](./answers-headless.displayablefacet.options.md) | [DisplayableFacetOption](./answers-headless.displayablefacetoption.md)\[\] | An array of [DisplayableFacetOption](./answers-headless.displayablefacetoption.md) | - diff --git a/docs/answers-headless.displayablefacet.options.md b/docs/answers-headless.displayablefacet.options.md deleted file mode 100644 index b335b9a5..00000000 --- a/docs/answers-headless.displayablefacet.options.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [DisplayableFacet](./answers-headless.displayablefacet.md) > [options](./answers-headless.displayablefacet.options.md) - -## DisplayableFacet.options property - -An array of [DisplayableFacetOption](./answers-headless.displayablefacetoption.md) - -Signature: - -```typescript -options: DisplayableFacetOption[]; -``` diff --git a/docs/answers-headless.displayablefacetoption.matcher.md b/docs/answers-headless.displayablefacetoption.matcher.md deleted file mode 100644 index dfb5105a..00000000 --- a/docs/answers-headless.displayablefacetoption.matcher.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [DisplayableFacetOption](./answers-headless.displayablefacetoption.md) > [matcher](./answers-headless.displayablefacetoption.matcher.md) - -## DisplayableFacetOption.matcher property - -A Matcher is a filtering operation. - -Signature: - -```typescript -matcher: Matcher; -``` diff --git a/docs/answers-headless.displayablefacetoption.md b/docs/answers-headless.displayablefacetoption.md deleted file mode 100644 index b64e252a..00000000 --- a/docs/answers-headless.displayablefacetoption.md +++ /dev/null @@ -1,25 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [DisplayableFacetOption](./answers-headless.displayablefacetoption.md) - -## DisplayableFacetOption interface - -A [FacetOption](./answers-headless.facetoption.md) with extra data meant to be displayed to the end user. - -Signature: - -```typescript -export declare interface DisplayableFacetOption extends FacetOption -``` -Extends: [FacetOption](./answers-headless.facetoption.md) - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [count](./answers-headless.displayablefacetoption.count.md) | number | The number of results associated with this facet option. | -| [displayName](./answers-headless.displayablefacetoption.displayname.md) | string | The name of the facet option which is meant to be displayed to the end user. | -| [matcher](./answers-headless.displayablefacetoption.matcher.md) | [Matcher](./answers-headless.matcher.md) | A Matcher is a filtering operation. | -| [selected](./answers-headless.displayablefacetoption.selected.md) | boolean | Whether or not the filter is selected in the search results. | -| [value](./answers-headless.displayablefacetoption.value.md) | string \| number \| boolean \| [NumberRangeValue](./answers-headless.numberrangevalue.md) | The value to compare. | - diff --git a/docs/answers-headless.endpoints.filtersearch.md b/docs/answers-headless.endpoints.filtersearch.md deleted file mode 100644 index 0563635e..00000000 --- a/docs/answers-headless.endpoints.filtersearch.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [Endpoints](./answers-headless.endpoints.md) > [filterSearch](./answers-headless.endpoints.filtersearch.md) - -## Endpoints.filterSearch property - -Signature: - -```typescript -filterSearch?: string; -``` diff --git a/docs/answers-headless.endpoints.md b/docs/answers-headless.endpoints.md deleted file mode 100644 index 47e5682f..00000000 --- a/docs/answers-headless.endpoints.md +++ /dev/null @@ -1,26 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [Endpoints](./answers-headless.endpoints.md) - -## Endpoints interface - -Overrides for the URLs which are used when making requests to the Answers API. - -Signature: - -```typescript -export declare interface Endpoints -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [filterSearch?](./answers-headless.endpoints.filtersearch.md) | string | (Optional) | -| [questionSubmission?](./answers-headless.endpoints.questionsubmission.md) | string | (Optional) | -| [status?](./answers-headless.endpoints.status.md) | string | (Optional) | -| [universalAutocomplete?](./answers-headless.endpoints.universalautocomplete.md) | string | (Optional) | -| [universalSearch?](./answers-headless.endpoints.universalsearch.md) | string | (Optional) | -| [verticalAutocomplete?](./answers-headless.endpoints.verticalautocomplete.md) | string | (Optional) | -| [verticalSearch?](./answers-headless.endpoints.verticalsearch.md) | string | (Optional) | - diff --git a/docs/answers-headless.endpoints.questionsubmission.md b/docs/answers-headless.endpoints.questionsubmission.md deleted file mode 100644 index 7c89636b..00000000 --- a/docs/answers-headless.endpoints.questionsubmission.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [Endpoints](./answers-headless.endpoints.md) > [questionSubmission](./answers-headless.endpoints.questionsubmission.md) - -## Endpoints.questionSubmission property - -Signature: - -```typescript -questionSubmission?: string; -``` diff --git a/docs/answers-headless.endpoints.status.md b/docs/answers-headless.endpoints.status.md deleted file mode 100644 index 42ea57f1..00000000 --- a/docs/answers-headless.endpoints.status.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [Endpoints](./answers-headless.endpoints.md) > [status](./answers-headless.endpoints.status.md) - -## Endpoints.status property - -Signature: - -```typescript -status?: string; -``` diff --git a/docs/answers-headless.endpoints.universalautocomplete.md b/docs/answers-headless.endpoints.universalautocomplete.md deleted file mode 100644 index 08792316..00000000 --- a/docs/answers-headless.endpoints.universalautocomplete.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [Endpoints](./answers-headless.endpoints.md) > [universalAutocomplete](./answers-headless.endpoints.universalautocomplete.md) - -## Endpoints.universalAutocomplete property - -Signature: - -```typescript -universalAutocomplete?: string; -``` diff --git a/docs/answers-headless.endpoints.universalsearch.md b/docs/answers-headless.endpoints.universalsearch.md deleted file mode 100644 index 10ab8001..00000000 --- a/docs/answers-headless.endpoints.universalsearch.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [Endpoints](./answers-headless.endpoints.md) > [universalSearch](./answers-headless.endpoints.universalsearch.md) - -## Endpoints.universalSearch property - -Signature: - -```typescript -universalSearch?: string; -``` diff --git a/docs/answers-headless.endpoints.verticalautocomplete.md b/docs/answers-headless.endpoints.verticalautocomplete.md deleted file mode 100644 index 71003898..00000000 --- a/docs/answers-headless.endpoints.verticalautocomplete.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [Endpoints](./answers-headless.endpoints.md) > [verticalAutocomplete](./answers-headless.endpoints.verticalautocomplete.md) - -## Endpoints.verticalAutocomplete property - -Signature: - -```typescript -verticalAutocomplete?: string; -``` diff --git a/docs/answers-headless.endpoints.verticalsearch.md b/docs/answers-headless.endpoints.verticalsearch.md deleted file mode 100644 index c828c325..00000000 --- a/docs/answers-headless.endpoints.verticalsearch.md +++ /dev/null @@ -1,11 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [Endpoints](./answers-headless.endpoints.md) > [verticalSearch](./answers-headless.endpoints.verticalsearch.md) - -## Endpoints.verticalSearch property - -Signature: - -```typescript -verticalSearch?: string; -``` diff --git a/docs/answers-headless.facet.md b/docs/answers-headless.facet.md deleted file mode 100644 index 0b69369d..00000000 --- a/docs/answers-headless.facet.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [Facet](./answers-headless.facet.md) - -## Facet interface - -Represents dynamic filter options for the Answers API. - -Signature: - -```typescript -export declare interface Facet -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [fieldId](./answers-headless.facet.fieldid.md) | string | The associated fieldId. | -| [options](./answers-headless.facet.options.md) | [FacetOption](./answers-headless.facetoption.md)\[\] | An array of [FacetOption](./answers-headless.facetoption.md) | - diff --git a/docs/answers-headless.facetoption.md b/docs/answers-headless.facetoption.md deleted file mode 100644 index d0069206..00000000 --- a/docs/answers-headless.facetoption.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [FacetOption](./answers-headless.facetoption.md) - -## FacetOption interface - -A filter associated with the facet. - -Signature: - -```typescript -export declare interface FacetOption -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [matcher](./answers-headless.facetoption.matcher.md) | [Matcher](./answers-headless.matcher.md) | A Matcher is a filtering operation. | -| [value](./answers-headless.facetoption.value.md) | string \| number \| boolean \| [NumberRangeValue](./answers-headless.numberrangevalue.md) | The value to compare. | - diff --git a/docs/answers-headless.failedvertical.md b/docs/answers-headless.failedvertical.md deleted file mode 100644 index dc7e957c..00000000 --- a/docs/answers-headless.failedvertical.md +++ /dev/null @@ -1,23 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [FailedVertical](./answers-headless.failedvertical.md) - -## FailedVertical interface - -Error information from when a vertical fails to return results. - -Signature: - -```typescript -export declare interface FailedVertical -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [details](./answers-headless.failedvertical.details.md) | { responseCode: number; description: string; } | Detailed information about the error. | -| [errorType](./answers-headless.failedvertical.errortype.md) | [ErrorType](./answers-headless.errortype.md) | Identifier for the type of error causing the failure. | -| [queryDurationMillis](./answers-headless.failedvertical.querydurationmillis.md) | number | The duration of the query in milliseconds. | -| [verticalKey](./answers-headless.failedvertical.verticalkey.md) | string | The vertical key associated with the failed vertical. | - diff --git a/docs/answers-headless.featuredsnippetdirectanswer.fieldtype.md b/docs/answers-headless.featuredsnippetdirectanswer.fieldtype.md deleted file mode 100644 index f689d264..00000000 --- a/docs/answers-headless.featuredsnippetdirectanswer.fieldtype.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [FeaturedSnippetDirectAnswer](./answers-headless.featuredsnippetdirectanswer.md) > [fieldType](./answers-headless.featuredsnippetdirectanswer.fieldtype.md) - -## FeaturedSnippetDirectAnswer.fieldType property - -The field type of the direct answer. - -Signature: - -```typescript -fieldType: string; -``` diff --git a/docs/answers-headless.featuredsnippetdirectanswer.md b/docs/answers-headless.featuredsnippetdirectanswer.md deleted file mode 100644 index 7c60b4ba..00000000 --- a/docs/answers-headless.featuredsnippetdirectanswer.md +++ /dev/null @@ -1,26 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [FeaturedSnippetDirectAnswer](./answers-headless.featuredsnippetdirectanswer.md) - -## FeaturedSnippetDirectAnswer interface - -A direct answer which was found within a document. - -Signature: - -```typescript -export declare interface FeaturedSnippetDirectAnswer extends DirectAnswer -``` -Extends: [DirectAnswer](./answers-headless.directanswer.md) - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [fieldType](./answers-headless.featuredsnippetdirectanswer.fieldtype.md) | string | The field type of the direct answer. | -| [relatedResult](./answers-headless.featuredsnippetdirectanswer.relatedresult.md) | [Result](./answers-headless.result.md) | The entity associated with the direct answer. | -| [snippet](./answers-headless.featuredsnippetdirectanswer.snippet.md) | [Snippet](./answers-headless.snippet.md) | The snippet where the direct answer was found. | -| [type](./answers-headless.featuredsnippetdirectanswer.type.md) | [DirectAnswerType.FeaturedSnippet](./answers-headless.directanswertype.md) | [DirectAnswerType](./answers-headless.directanswertype.md).FeaturedSnippet. | -| [value?](./answers-headless.featuredsnippetdirectanswer.value.md) | string | (Optional) The result of the direct answer. | -| [verticalKey](./answers-headless.featuredsnippetdirectanswer.verticalkey.md) | string | The vertical key of the direct answer. | - diff --git a/docs/answers-headless.featuredsnippetdirectanswer.relatedresult.md b/docs/answers-headless.featuredsnippetdirectanswer.relatedresult.md deleted file mode 100644 index a33c91c8..00000000 --- a/docs/answers-headless.featuredsnippetdirectanswer.relatedresult.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [FeaturedSnippetDirectAnswer](./answers-headless.featuredsnippetdirectanswer.md) > [relatedResult](./answers-headless.featuredsnippetdirectanswer.relatedresult.md) - -## FeaturedSnippetDirectAnswer.relatedResult property - -The entity associated with the direct answer. - -Signature: - -```typescript -relatedResult: Result; -``` diff --git a/docs/answers-headless.featuredsnippetdirectanswer.snippet.md b/docs/answers-headless.featuredsnippetdirectanswer.snippet.md deleted file mode 100644 index 0cba1248..00000000 --- a/docs/answers-headless.featuredsnippetdirectanswer.snippet.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [FeaturedSnippetDirectAnswer](./answers-headless.featuredsnippetdirectanswer.md) > [snippet](./answers-headless.featuredsnippetdirectanswer.snippet.md) - -## FeaturedSnippetDirectAnswer.snippet property - -The snippet where the direct answer was found. - -Signature: - -```typescript -snippet: Snippet; -``` diff --git a/docs/answers-headless.featuredsnippetdirectanswer.type.md b/docs/answers-headless.featuredsnippetdirectanswer.type.md deleted file mode 100644 index 20629c74..00000000 --- a/docs/answers-headless.featuredsnippetdirectanswer.type.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [FeaturedSnippetDirectAnswer](./answers-headless.featuredsnippetdirectanswer.md) > [type](./answers-headless.featuredsnippetdirectanswer.type.md) - -## FeaturedSnippetDirectAnswer.type property - -[DirectAnswerType](./answers-headless.directanswertype.md).FeaturedSnippet. - -Signature: - -```typescript -type: DirectAnswerType.FeaturedSnippet; -``` diff --git a/docs/answers-headless.featuredsnippetdirectanswer.value.md b/docs/answers-headless.featuredsnippetdirectanswer.value.md deleted file mode 100644 index 7983b1cc..00000000 --- a/docs/answers-headless.featuredsnippetdirectanswer.value.md +++ /dev/null @@ -1,18 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [FeaturedSnippetDirectAnswer](./answers-headless.featuredsnippetdirectanswer.md) > [value](./answers-headless.featuredsnippetdirectanswer.value.md) - -## FeaturedSnippetDirectAnswer.value property - -The result of the direct answer. - -Signature: - -```typescript -value?: string; -``` - -## Remarks - -A value will not be present if the [DirectAnswer.fieldType](./answers-headless.directanswer.fieldtype.md) is 'rich\_text'. - diff --git a/docs/answers-headless.featuredsnippetdirectanswer.verticalkey.md b/docs/answers-headless.featuredsnippetdirectanswer.verticalkey.md deleted file mode 100644 index 9561b40e..00000000 --- a/docs/answers-headless.featuredsnippetdirectanswer.verticalkey.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [FeaturedSnippetDirectAnswer](./answers-headless.featuredsnippetdirectanswer.md) > [verticalKey](./answers-headless.featuredsnippetdirectanswer.verticalkey.md) - -## FeaturedSnippetDirectAnswer.verticalKey property - -The vertical key of the direct answer. - -Signature: - -```typescript -verticalKey: string; -``` diff --git a/docs/answers-headless.fieldvaluedirectanswer.fieldapiname.md b/docs/answers-headless.fieldvaluedirectanswer.fieldapiname.md deleted file mode 100644 index 46ed803a..00000000 --- a/docs/answers-headless.fieldvaluedirectanswer.fieldapiname.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [FieldValueDirectAnswer](./answers-headless.fieldvaluedirectanswer.md) > [fieldApiName](./answers-headless.fieldvaluedirectanswer.fieldapiname.md) - -## FieldValueDirectAnswer.fieldApiName property - -The field api name of the direct answer. - -Signature: - -```typescript -fieldApiName: string; -``` diff --git a/docs/answers-headless.fieldvaluedirectanswer.fieldname.md b/docs/answers-headless.fieldvaluedirectanswer.fieldname.md deleted file mode 100644 index d3bd4933..00000000 --- a/docs/answers-headless.fieldvaluedirectanswer.fieldname.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [FieldValueDirectAnswer](./answers-headless.fieldvaluedirectanswer.md) > [fieldName](./answers-headless.fieldvaluedirectanswer.fieldname.md) - -## FieldValueDirectAnswer.fieldName property - -The field name of the direct answer. - -Signature: - -```typescript -fieldName: string; -``` diff --git a/docs/answers-headless.fieldvaluedirectanswer.fieldtype.md b/docs/answers-headless.fieldvaluedirectanswer.fieldtype.md deleted file mode 100644 index 50926465..00000000 --- a/docs/answers-headless.fieldvaluedirectanswer.fieldtype.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [FieldValueDirectAnswer](./answers-headless.fieldvaluedirectanswer.md) > [fieldType](./answers-headless.fieldvaluedirectanswer.fieldtype.md) - -## FieldValueDirectAnswer.fieldType property - -The field type of the direct answer. - -Signature: - -```typescript -fieldType: string; -``` diff --git a/docs/answers-headless.fieldvaluedirectanswer.md b/docs/answers-headless.fieldvaluedirectanswer.md deleted file mode 100644 index 121433a4..00000000 --- a/docs/answers-headless.fieldvaluedirectanswer.md +++ /dev/null @@ -1,28 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [FieldValueDirectAnswer](./answers-headless.fieldvaluedirectanswer.md) - -## FieldValueDirectAnswer interface - -A direct answer where the answer came from a field from the knowledge graph. - -Signature: - -```typescript -export declare interface FieldValueDirectAnswer extends DirectAnswer -``` -Extends: [DirectAnswer](./answers-headless.directanswer.md) - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [entityName](./answers-headless.fieldvaluedirectanswer.entityname.md) | string | The name of the entity that direct answer came from. | -| [fieldApiName](./answers-headless.fieldvaluedirectanswer.fieldapiname.md) | string | The field api name of the direct answer. | -| [fieldName](./answers-headless.fieldvaluedirectanswer.fieldname.md) | string | The field name of the direct answer. | -| [fieldType](./answers-headless.fieldvaluedirectanswer.fieldtype.md) | string | The field type of the direct answer. | -| [relatedResult](./answers-headless.fieldvaluedirectanswer.relatedresult.md) | [Result](./answers-headless.result.md) | The entity associated with the direct answer. | -| [type](./answers-headless.fieldvaluedirectanswer.type.md) | [DirectAnswerType.FieldValue](./answers-headless.directanswertype.md) | [DirectAnswerType](./answers-headless.directanswertype.md).FieldValue. | -| [value](./answers-headless.fieldvaluedirectanswer.value.md) | string | The result of the direct answer. | -| [verticalKey](./answers-headless.fieldvaluedirectanswer.verticalkey.md) | string | The vertical key of the direct answer. | - diff --git a/docs/answers-headless.fieldvaluedirectanswer.relatedresult.md b/docs/answers-headless.fieldvaluedirectanswer.relatedresult.md deleted file mode 100644 index 11ed516e..00000000 --- a/docs/answers-headless.fieldvaluedirectanswer.relatedresult.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [FieldValueDirectAnswer](./answers-headless.fieldvaluedirectanswer.md) > [relatedResult](./answers-headless.fieldvaluedirectanswer.relatedresult.md) - -## FieldValueDirectAnswer.relatedResult property - -The entity associated with the direct answer. - -Signature: - -```typescript -relatedResult: Result; -``` diff --git a/docs/answers-headless.fieldvaluedirectanswer.type.md b/docs/answers-headless.fieldvaluedirectanswer.type.md deleted file mode 100644 index 158a4157..00000000 --- a/docs/answers-headless.fieldvaluedirectanswer.type.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [FieldValueDirectAnswer](./answers-headless.fieldvaluedirectanswer.md) > [type](./answers-headless.fieldvaluedirectanswer.type.md) - -## FieldValueDirectAnswer.type property - -[DirectAnswerType](./answers-headless.directanswertype.md).FieldValue. - -Signature: - -```typescript -type: DirectAnswerType.FieldValue; -``` diff --git a/docs/answers-headless.fieldvaluedirectanswer.value.md b/docs/answers-headless.fieldvaluedirectanswer.value.md deleted file mode 100644 index 139c41c3..00000000 --- a/docs/answers-headless.fieldvaluedirectanswer.value.md +++ /dev/null @@ -1,18 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [FieldValueDirectAnswer](./answers-headless.fieldvaluedirectanswer.md) > [value](./answers-headless.fieldvaluedirectanswer.value.md) - -## FieldValueDirectAnswer.value property - -The result of the direct answer. - -Signature: - -```typescript -value: string; -``` - -## Remarks - -A value will not be present if the [DirectAnswer.fieldType](./answers-headless.directanswer.fieldtype.md) is 'rich\_text'. - diff --git a/docs/answers-headless.fieldvaluedirectanswer.verticalkey.md b/docs/answers-headless.fieldvaluedirectanswer.verticalkey.md deleted file mode 100644 index ccab1549..00000000 --- a/docs/answers-headless.fieldvaluedirectanswer.verticalkey.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [FieldValueDirectAnswer](./answers-headless.fieldvaluedirectanswer.md) > [verticalKey](./answers-headless.fieldvaluedirectanswer.verticalkey.md) - -## FieldValueDirectAnswer.verticalKey property - -The vertical key of the direct answer. - -Signature: - -```typescript -verticalKey: string; -``` diff --git a/docs/answers-headless.filter.md b/docs/answers-headless.filter.md deleted file mode 100644 index 05b69429..00000000 --- a/docs/answers-headless.filter.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [Filter](./answers-headless.filter.md) - -## Filter interface - -Represents a filter which compares values to a single field. - -Signature: - -```typescript -export declare interface Filter -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [fieldId](./answers-headless.filter.fieldid.md) | string | The fieldId to apply the filter against. | -| [matcher](./answers-headless.filter.matcher.md) | [Matcher](./answers-headless.matcher.md) | A Matcher is a filtering operation. | -| [value](./answers-headless.filter.value.md) | string \| number \| boolean \| [NearFilterValue](./answers-headless.nearfiltervalue.md) \| [NumberRangeValue](./answers-headless.numberrangevalue.md) | The value to compare. | - diff --git a/docs/answers-headless.filtersearchrequest.fields.md b/docs/answers-headless.filtersearchrequest.fields.md deleted file mode 100644 index 46247072..00000000 --- a/docs/answers-headless.filtersearchrequest.fields.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [FilterSearchRequest](./answers-headless.filtersearchrequest.md) > [fields](./answers-headless.filtersearchrequest.fields.md) - -## FilterSearchRequest.fields property - -An array of [SearchParameterField](./answers-headless.searchparameterfield.md) - -Signature: - -```typescript -fields: SearchParameterField[]; -``` diff --git a/docs/answers-headless.filtersearchrequest.input.md b/docs/answers-headless.filtersearchrequest.input.md deleted file mode 100644 index d2b125a0..00000000 --- a/docs/answers-headless.filtersearchrequest.input.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [FilterSearchRequest](./answers-headless.filtersearchrequest.md) > [input](./answers-headless.filtersearchrequest.input.md) - -## FilterSearchRequest.input property - -The input string for autocomplete. - -Signature: - -```typescript -input: string; -``` diff --git a/docs/answers-headless.filtersearchrequest.md b/docs/answers-headless.filtersearchrequest.md deleted file mode 100644 index 17c2b18e..00000000 --- a/docs/answers-headless.filtersearchrequest.md +++ /dev/null @@ -1,26 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [FilterSearchRequest](./answers-headless.filtersearchrequest.md) - -## FilterSearchRequest interface - -Options for a filtersearch request. - -Signature: - -```typescript -export declare interface FilterSearchRequest extends AnswersRequest -``` -Extends: [AnswersRequest](./answers-headless.answersrequest.md) - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [excluded?](./answers-headless.filtersearchrequest.excluded.md) | [Filter](./answers-headless.filter.md)\[\] | (Optional) an array of filters that should be excluded from filter search results. | -| [fields](./answers-headless.filtersearchrequest.fields.md) | [SearchParameterField](./answers-headless.searchparameterfield.md)\[\] | An array of [SearchParameterField](./answers-headless.searchparameterfield.md) | -| [input](./answers-headless.filtersearchrequest.input.md) | string | The input string for autocomplete. | -| [sectioned](./answers-headless.filtersearchrequest.sectioned.md) | boolean | Determines whether or not the results of the [FilterSearchResponse](./answers-headless.filtersearchresponse.md) are separated by field. | -| [sessionTrackingEnabled?](./answers-headless.filtersearchrequest.sessiontrackingenabled.md) | boolean | (Optional) Enables session tracking. | -| [verticalKey](./answers-headless.filtersearchrequest.verticalkey.md) | string | The key for the vertical to get autocomplete suggestions from. | - diff --git a/docs/answers-headless.filtersearchrequest.sectioned.md b/docs/answers-headless.filtersearchrequest.sectioned.md deleted file mode 100644 index 46697a05..00000000 --- a/docs/answers-headless.filtersearchrequest.sectioned.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [FilterSearchRequest](./answers-headless.filtersearchrequest.md) > [sectioned](./answers-headless.filtersearchrequest.sectioned.md) - -## FilterSearchRequest.sectioned property - -Determines whether or not the results of the [FilterSearchResponse](./answers-headless.filtersearchresponse.md) are separated by field. - -Signature: - -```typescript -sectioned: boolean; -``` diff --git a/docs/answers-headless.filtersearchrequest.sessiontrackingenabled.md b/docs/answers-headless.filtersearchrequest.sessiontrackingenabled.md deleted file mode 100644 index 15e96b44..00000000 --- a/docs/answers-headless.filtersearchrequest.sessiontrackingenabled.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [FilterSearchRequest](./answers-headless.filtersearchrequest.md) > [sessionTrackingEnabled](./answers-headless.filtersearchrequest.sessiontrackingenabled.md) - -## FilterSearchRequest.sessionTrackingEnabled property - -Enables session tracking. - -Signature: - -```typescript -sessionTrackingEnabled?: boolean; -``` diff --git a/docs/answers-headless.filtersearchresponse.md b/docs/answers-headless.filtersearchresponse.md deleted file mode 100644 index f46ca79e..00000000 --- a/docs/answers-headless.filtersearchresponse.md +++ /dev/null @@ -1,23 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [FilterSearchResponse](./answers-headless.filtersearchresponse.md) - -## FilterSearchResponse interface - -The response of a filtersearch request. - -Signature: - -```typescript -export declare interface FilterSearchResponse -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [businessId?](./answers-headless.filtersearchresponse.businessid.md) | string | (Optional) ID of the account associated with this Answers experience | -| [queryId?](./answers-headless.filtersearchresponse.queryid.md) | string | (Optional) The ID of the search query. | -| [sections](./answers-headless.filtersearchresponse.sections.md) | { label?: string; results: [AutocompleteResult](./answers-headless.autocompleteresult.md)\[\]; }\[\] | Represents autocomplete results separated by field. | -| [uuid](./answers-headless.filtersearchresponse.uuid.md) | string | A unique id which corresponds to the request. | - diff --git a/docs/answers-headless.filtersearchresponse.queryid.md b/docs/answers-headless.filtersearchresponse.queryid.md deleted file mode 100644 index a82ec541..00000000 --- a/docs/answers-headless.filtersearchresponse.queryid.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [FilterSearchResponse](./answers-headless.filtersearchresponse.md) > [queryId](./answers-headless.filtersearchresponse.queryid.md) - -## FilterSearchResponse.queryId property - -The ID of the search query. - -Signature: - -```typescript -queryId?: string; -``` diff --git a/docs/answers-headless.filtersstate.md b/docs/answers-headless.filtersstate.md deleted file mode 100644 index b7a39431..00000000 --- a/docs/answers-headless.filtersstate.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [FiltersState](./answers-headless.filtersstate.md) - -## FiltersState interface - -Maintains the current state of facets and filters in the application. - -Signature: - -```typescript -export interface FiltersState -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [facets?](./answers-headless.filtersstate.facets.md) | [DisplayableFacet](./answers-headless.displayablefacet.md)\[\] | (Optional) The dynamic collection of facets that can be applied to filter the search results and whether each of them is currently selected. | -| [static?](./answers-headless.filtersstate.static.md) | [SelectableFilter](./answers-headless.selectablefilter.md)\[\] | (Optional) The collection of possible static filters that can be applied to the search results and whether each of them is currently selected. | - diff --git a/docs/answers-headless.filtertypes.md b/docs/answers-headless.filtertypes.md deleted file mode 100644 index 0e8244fb..00000000 --- a/docs/answers-headless.filtertypes.md +++ /dev/null @@ -1,15 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [FilterTypes](./answers-headless.filtertypes.md) - -## FilterTypes type - -A union type for the different kinds of filter. - -Signature: - -```typescript -export declare type FilterTypes = Filter | CombinedFilter; -``` -References: [Filter](./answers-headless.filter.md), [CombinedFilter](./answers-headless.combinedfilter.md) - diff --git a/docs/answers-headless.headlessconfig.md b/docs/answers-headless.headlessconfig.md deleted file mode 100644 index 0d1b32a3..00000000 --- a/docs/answers-headless.headlessconfig.md +++ /dev/null @@ -1,18 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [HeadlessConfig](./answers-headless.headlessconfig.md) - -## HeadlessConfig type - -The configuration for an AnswersHeadless instance. - -Signature: - -```typescript -export declare type HeadlessConfig = AnswersConfig & { - headlessId?: string; - verticalKey?: string; -}; -``` -References: [AnswersConfig](./answers-headless.answersconfig.md) - diff --git a/docs/answers-headless.highlightedvalue.md b/docs/answers-headless.highlightedvalue.md deleted file mode 100644 index ebb7213f..00000000 --- a/docs/answers-headless.highlightedvalue.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [HighlightedValue](./answers-headless.highlightedvalue.md) - -## HighlightedValue interface - -A field value and its substring matches as emphasized by the Answers API. - -Signature: - -```typescript -export declare interface HighlightedValue -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [matchedSubstrings](./answers-headless.highlightedvalue.matchedsubstrings.md) | { length: number; offset: number; }\[\] | An array of substring matches which correspond to the highlighting. | -| [value](./answers-headless.highlightedvalue.value.md) | string | The value of the field which should be highlighted. | - diff --git a/docs/answers-headless.locationbias.latitude.md b/docs/answers-headless.locationbias.latitude.md deleted file mode 100644 index 39993425..00000000 --- a/docs/answers-headless.locationbias.latitude.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [LocationBias](./answers-headless.locationbias.md) > [latitude](./answers-headless.locationbias.latitude.md) - -## LocationBias.latitude property - -The location's latitude. - -Signature: - -```typescript -latitude: number; -``` diff --git a/docs/answers-headless.locationbias.longitude.md b/docs/answers-headless.locationbias.longitude.md deleted file mode 100644 index 9501e34a..00000000 --- a/docs/answers-headless.locationbias.longitude.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [LocationBias](./answers-headless.locationbias.md) > [longitude](./answers-headless.locationbias.longitude.md) - -## LocationBias.longitude property - -The location's longitude. - -Signature: - -```typescript -longitude: number; -``` diff --git a/docs/answers-headless.locationbias.md b/docs/answers-headless.locationbias.md deleted file mode 100644 index 0d417cf8..00000000 --- a/docs/answers-headless.locationbias.md +++ /dev/null @@ -1,23 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [LocationBias](./answers-headless.locationbias.md) - -## LocationBias interface - -Information about the user's location. - -Signature: - -```typescript -export declare interface LocationBias -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [displayName](./answers-headless.locationbias.displayname.md) | string | The name of the location. | -| [latitude](./answers-headless.locationbias.latitude.md) | number | The location's latitude. | -| [longitude](./answers-headless.locationbias.longitude.md) | number | The location's longitude. | -| [method](./answers-headless.locationbias.method.md) | [LocationBiasMethod](./answers-headless.locationbiasmethod.md) | The method used to determine the location. | - diff --git a/docs/answers-headless.locationboundingbox.maxlatitude.md b/docs/answers-headless.locationboundingbox.maxlatitude.md deleted file mode 100644 index e76a3762..00000000 --- a/docs/answers-headless.locationboundingbox.maxlatitude.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [LocationBoundingBox](./answers-headless.locationboundingbox.md) > [maxLatitude](./answers-headless.locationboundingbox.maxlatitude.md) - -## LocationBoundingBox.maxLatitude property - -The location's highest latitude degree. - -Signature: - -```typescript -maxLatitude: number; -``` diff --git a/docs/answers-headless.locationboundingbox.maxlongitude.md b/docs/answers-headless.locationboundingbox.maxlongitude.md deleted file mode 100644 index 1cd784d3..00000000 --- a/docs/answers-headless.locationboundingbox.maxlongitude.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [LocationBoundingBox](./answers-headless.locationboundingbox.md) > [maxLongitude](./answers-headless.locationboundingbox.maxlongitude.md) - -## LocationBoundingBox.maxLongitude property - -The location's highest longitude degree. - -Signature: - -```typescript -maxLongitude: number; -``` diff --git a/docs/answers-headless.locationboundingbox.md b/docs/answers-headless.locationboundingbox.md deleted file mode 100644 index 0c44ad6c..00000000 --- a/docs/answers-headless.locationboundingbox.md +++ /dev/null @@ -1,23 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [LocationBoundingBox](./answers-headless.locationboundingbox.md) - -## LocationBoundingBox interface - -Location boundaries for a filter with "Place" for its [AppliedQueryFilterType](./answers-headless.appliedqueryfiltertype.md). (e.g. boundary for a locality or region specific location filter) - -Signature: - -```typescript -export declare interface LocationBoundingBox -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [maxLatitude](./answers-headless.locationboundingbox.maxlatitude.md) | number | The location's highest latitude degree. | -| [maxLongitude](./answers-headless.locationboundingbox.maxlongitude.md) | number | The location's highest longitude degree. | -| [minLatitude](./answers-headless.locationboundingbox.minlatitude.md) | number | The location's lowest latitude degree. | -| [minLongitude](./answers-headless.locationboundingbox.minlongitude.md) | number | The location's lowest longitude degree. | - diff --git a/docs/answers-headless.locationboundingbox.minlatitude.md b/docs/answers-headless.locationboundingbox.minlatitude.md deleted file mode 100644 index 0065c247..00000000 --- a/docs/answers-headless.locationboundingbox.minlatitude.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [LocationBoundingBox](./answers-headless.locationboundingbox.md) > [minLatitude](./answers-headless.locationboundingbox.minlatitude.md) - -## LocationBoundingBox.minLatitude property - -The location's lowest latitude degree. - -Signature: - -```typescript -minLatitude: number; -``` diff --git a/docs/answers-headless.locationboundingbox.minlongitude.md b/docs/answers-headless.locationboundingbox.minlongitude.md deleted file mode 100644 index 5484e1fe..00000000 --- a/docs/answers-headless.locationboundingbox.minlongitude.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [LocationBoundingBox](./answers-headless.locationboundingbox.md) > [minLongitude](./answers-headless.locationboundingbox.minlongitude.md) - -## LocationBoundingBox.minLongitude property - -The location's lowest longitude degree. - -Signature: - -```typescript -minLongitude: number; -``` diff --git a/docs/answers-headless.locationfilterdetails.latitude.md b/docs/answers-headless.locationfilterdetails.latitude.md deleted file mode 100644 index decb0185..00000000 --- a/docs/answers-headless.locationfilterdetails.latitude.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [LocationFilterDetails](./answers-headless.locationfilterdetails.md) > [latitude](./answers-headless.locationfilterdetails.latitude.md) - -## LocationFilterDetails.latitude property - -The location's latitude. - -Signature: - -```typescript -latitude: number; -``` diff --git a/docs/answers-headless.locationfilterdetails.longitude.md b/docs/answers-headless.locationfilterdetails.longitude.md deleted file mode 100644 index b418ca74..00000000 --- a/docs/answers-headless.locationfilterdetails.longitude.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [LocationFilterDetails](./answers-headless.locationfilterdetails.md) > [longitude](./answers-headless.locationfilterdetails.longitude.md) - -## LocationFilterDetails.longitude property - -The location's longitude. - -Signature: - -```typescript -longitude: number; -``` diff --git a/docs/answers-headless.locationfilterdetails.md b/docs/answers-headless.locationfilterdetails.md deleted file mode 100644 index 24bf3899..00000000 --- a/docs/answers-headless.locationfilterdetails.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [LocationFilterDetails](./answers-headless.locationfilterdetails.md) - -## LocationFilterDetails interface - -Additional details relevant to the filter with "PLACE" for its [AppliedQueryFilterType](./answers-headless.appliedqueryfiltertype.md). - -Signature: - -```typescript -export declare interface LocationFilterDetails -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [boundingBox?](./answers-headless.locationfilterdetails.boundingbox.md) | [LocationBoundingBox](./answers-headless.locationboundingbox.md) | (Optional) The location's coordinate boundaries. | -| [featureTypes](./answers-headless.locationfilterdetails.featuretypes.md) | string\[\] | The location's classification (e.g. locality, region, address). | -| [latitude](./answers-headless.locationfilterdetails.latitude.md) | number | The location's latitude. | -| [longitude](./answers-headless.locationfilterdetails.longitude.md) | number | The location's longitude. | -| [placeName](./answers-headless.locationfilterdetails.placename.md) | string | The location's name. | - diff --git a/docs/answers-headless.locationfilterdetails.placename.md b/docs/answers-headless.locationfilterdetails.placename.md deleted file mode 100644 index f9de9966..00000000 --- a/docs/answers-headless.locationfilterdetails.placename.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [LocationFilterDetails](./answers-headless.locationfilterdetails.md) > [placeName](./answers-headless.locationfilterdetails.placename.md) - -## LocationFilterDetails.placeName property - -The location's name. - -Signature: - -```typescript -placeName: string; -``` diff --git a/docs/answers-headless.locationstate.md b/docs/answers-headless.locationstate.md deleted file mode 100644 index 96002981..00000000 --- a/docs/answers-headless.locationstate.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [LocationState](./answers-headless.locationstate.md) - -## LocationState interface - -Maintains the user's location, if given, or the inferred location, that is used to bias search results. - -Signature: - -```typescript -export interface LocationState -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [locationBias?](./answers-headless.locationstate.locationbias.md) | [LocationBias](./answers-headless.locationbias.md) | (Optional) The geographical location bias used in the search, returned from the Answers API. | -| [userLocation?](./answers-headless.locationstate.userlocation.md) | [LatLong](./answers-headless.latlong.md) | (Optional) The latitude and longitude of the user making the request. Used to bias the results. | - diff --git a/docs/answers-headless.lowernumberrangelimit.matcher.md b/docs/answers-headless.lowernumberrangelimit.matcher.md deleted file mode 100644 index 2b8138f0..00000000 --- a/docs/answers-headless.lowernumberrangelimit.matcher.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [LowerNumberRangeLimit](./answers-headless.lowernumberrangelimit.md) > [matcher](./answers-headless.lowernumberrangelimit.matcher.md) - -## LowerNumberRangeLimit.matcher property - -[Matcher](./answers-headless.matcher.md) for the start limit - -Signature: - -```typescript -matcher: Matcher.GreaterThan | Matcher.GreaterThanOrEqualTo; -``` diff --git a/docs/answers-headless.lowernumberrangelimit.md b/docs/answers-headless.lowernumberrangelimit.md deleted file mode 100644 index 92e432c7..00000000 --- a/docs/answers-headless.lowernumberrangelimit.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [LowerNumberRangeLimit](./answers-headless.lowernumberrangelimit.md) - -## LowerNumberRangeLimit interface - -The start limit of [NumberRangeValue](./answers-headless.numberrangevalue.md). - -Signature: - -```typescript -export declare interface LowerNumberRangeLimit -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [matcher](./answers-headless.lowernumberrangelimit.matcher.md) | [Matcher.GreaterThan](./answers-headless.matcher.md) \| [Matcher.GreaterThanOrEqualTo](./answers-headless.matcher.md) | [Matcher](./answers-headless.matcher.md) for the start limit | -| [value](./answers-headless.lowernumberrangelimit.value.md) | number | Value of the limit. | - diff --git a/docs/answers-headless.lowernumberrangelimit.value.md b/docs/answers-headless.lowernumberrangelimit.value.md deleted file mode 100644 index c93a5c10..00000000 --- a/docs/answers-headless.lowernumberrangelimit.value.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [LowerNumberRangeLimit](./answers-headless.lowernumberrangelimit.md) > [value](./answers-headless.lowernumberrangelimit.value.md) - -## LowerNumberRangeLimit.value property - -Value of the limit. - -Signature: - -```typescript -value: number; -``` diff --git a/docs/answers-headless.md b/docs/answers-headless.md deleted file mode 100644 index a41ed6cf..00000000 --- a/docs/answers-headless.md +++ /dev/null @@ -1,144 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) - -## answers-headless package - -## Classes - -| Class | Description | -| --- | --- | -| [AnswersCore](./answers-headless.answerscore.md) | Provides methods for executing searches, submitting questions, and performing autocompletes. | -| [AnswersError](./answers-headless.answerserror.md) | Represents an error | -| [AnswersHeadless](./answers-headless.answersheadless.md) | Provides the functionality for interacting with an Answers Search experience. | - -## Enumerations - -| Enumeration | Description | -| --- | --- | -| [AppliedQueryFilterType](./answers-headless.appliedqueryfiltertype.md) | Represents the type of [AppliedQueryFilter](./answers-headless.appliedqueryfilter.md) applied to a search. | -| [DirectAnswerType](./answers-headless.directanswertype.md) | Represents the type of direct answer. | -| [Direction](./answers-headless.direction.md) | The direction of a sort. | -| [ErrorType](./answers-headless.errortype.md) | Identifier for the type of error causing the failure. | -| [FilterCombinator](./answers-headless.filtercombinator.md) | Indicates how the filters in a [CombinedFilter](./answers-headless.combinedfilter.md) should be combined. | -| [LocationBiasMethod](./answers-headless.locationbiasmethod.md) | The method used to determine the location. | -| [Matcher](./answers-headless.matcher.md) | A Matcher is a filtering operation. | -| [QuerySource](./answers-headless.querysource.md) | The source of the search request. | -| [QueryTrigger](./answers-headless.querytrigger.md) | Describes the ways a search can be executed besides user input. | -| [SearchIntent](./answers-headless.searchintent.md) | Represents intents from the Answers API. | -| [SearchTypeEnum](./answers-headless.searchtypeenum.md) | An enum which indicates the type of search that Headless is managing. | -| [SortType](./answers-headless.sorttype.md) | The method of sorting. | -| [Source](./answers-headless.source.md) | Represents the source of a [Result](./answers-headless.result.md). | -| [SpellCheckType](./answers-headless.spellchecktype.md) | Represents the type of spell check performed. | - -## Functions - -| Function | Description | -| --- | --- | -| [combineFilters(filterA, filterB, combinator)](./answers-headless.combinefilters.md) | Creates a [CombinedFilter](./answers-headless.combinedfilter.md) by applying the specified [FilterCombinator](./answers-headless.filtercombinator.md) to the two filters. | -| [createDateRangeFilter(fieldId, range)](./answers-headless.createdaterangefilter.md) | Creates a [Filter](./answers-headless.filter.md) or [CombinedFilter](./answers-headless.combinedfilter.md) that matches all results where the given field value falls in a specific Date [BoundedRange](./answers-headless.boundedrange.md). | -| [createEqualsFilter(fieldId, value)](./answers-headless.createequalsfilter.md) | Creates a simple [Filter](./answers-headless.filter.md) that ensures all results will match a specific field value. | -| [createNearMeFilter(position)](./answers-headless.createnearmefilter.md) | Creates a [Filter](./answers-headless.filter.md) that matches all results within a certain radius of the given position. | -| [createNumberRangeFilter(fieldId, range)](./answers-headless.createnumberrangefilter.md) | Creates a [Filter](./answers-headless.filter.md) or [CombinedFilter](./answers-headless.combinedfilter.md) that matches all results where the given field value falls in a specific number [BoundedRange](./answers-headless.boundedrange.md). | -| [provideAnswersHeadless(config)](./answers-headless.provideanswersheadless.md) | Supplies a new instance of [AnswersHeadless](./answers-headless.answersheadless.md), using the provided configuration. | - -## Interfaces - -| Interface | Description | -| --- | --- | -| [AdditionalHttpHeaders](./answers-headless.additionalhttpheaders.md) | AdditionalHttpHeaders allows users to specify additional values for specific HTTP headers. | -| [AllResultsForVertical](./answers-headless.allresultsforvertical.md) | Represents all results for the current vertical. | -| [AnswersConfigWithApiKey](./answers-headless.answersconfigwithapikey.md) | Configuration options for [AnswersCore](./answers-headless.answerscore.md), which includes the options from [BaseAnswersConfig](./answers-headless.baseanswersconfig.md), but requires apiKey. | -| [AnswersConfigWithToken](./answers-headless.answersconfigwithtoken.md) | Configuration options for [AnswersCore](./answers-headless.answerscore.md), which includes the options from [BaseAnswersConfig](./answers-headless.baseanswersconfig.md), but requires token. | -| [AnswersRequest](./answers-headless.answersrequest.md) | Options for an Answers API request. | -| [AppliedQueryFilter](./answers-headless.appliedqueryfilter.md) | A filter that the Answers API applied to the search. | -| [AutocompleteResponse](./answers-headless.autocompleteresponse.md) | The response of a universal or vertical autocomplete request. | -| [AutocompleteResult](./answers-headless.autocompleteresult.md) | An autocomplete suggestion. | -| [AutocompleteService](./answers-headless.autocompleteservice.md) | A service for autocomplete requests. | -| [BaseAnswersConfig](./answers-headless.baseanswersconfig.md) | The base configuration options for [AnswersCore](./answers-headless.answerscore.md). | -| [BoundedRange](./answers-headless.boundedrange.md) | An interface representing a range of values of type T. | -| [ClientSDKHeaderValues](./answers-headless.clientsdkheadervalues.md) | Additional agents and their versions used to create the Answers experience. The information for these agents is added to the Client-SDK HTTP header along with that of the ANSWERS\_CORE agent. | -| [CombinedFilter](./answers-headless.combinedfilter.md) | Represents multiple filters that will be combined to refine results. | -| [DirectAnswer](./answers-headless.directanswer.md) | A direct answer to a search. | -| [DirectAnswerState](./answers-headless.directanswerstate.md) | Maintains the direct answer associated with the latest search. | -| [DisplayableFacet](./answers-headless.displayablefacet.md) | A [Facet](./answers-headless.facet.md) which contains extra fields meant to be displayed to the end user. | -| [DisplayableFacetOption](./answers-headless.displayablefacetoption.md) | A [FacetOption](./answers-headless.facetoption.md) with extra data meant to be displayed to the end user. | -| [Endpoints](./answers-headless.endpoints.md) | Overrides for the URLs which are used when making requests to the Answers API. | -| [Facet](./answers-headless.facet.md) | Represents dynamic filter options for the Answers API. | -| [FacetOption](./answers-headless.facetoption.md) | A filter associated with the facet. | -| [FailedVertical](./answers-headless.failedvertical.md) | Error information from when a vertical fails to return results. | -| [FeaturedSnippetDirectAnswer](./answers-headless.featuredsnippetdirectanswer.md) | A direct answer which was found within a document. | -| [FieldValueDirectAnswer](./answers-headless.fieldvaluedirectanswer.md) | A direct answer where the answer came from a field from the knowledge graph. | -| [Filter](./answers-headless.filter.md) | Represents a filter which compares values to a single field. | -| [FilterSearchRequest](./answers-headless.filtersearchrequest.md) | Options for a filtersearch request. | -| [FilterSearchResponse](./answers-headless.filtersearchresponse.md) | The response of a filtersearch request. | -| [FiltersState](./answers-headless.filtersstate.md) | Maintains the current state of facets and filters in the application. | -| [HighlightedValue](./answers-headless.highlightedvalue.md) | A field value and its substring matches as emphasized by the Answers API. | -| [LatLong](./answers-headless.latlong.md) | The latitude and longitude of the user making the request. Used to bias the results. | -| [LocationBias](./answers-headless.locationbias.md) | Information about the user's location. | -| [LocationBoundingBox](./answers-headless.locationboundingbox.md) | Location boundaries for a filter with "Place" for its [AppliedQueryFilterType](./answers-headless.appliedqueryfiltertype.md). (e.g. boundary for a locality or region specific location filter) | -| [LocationFilterDetails](./answers-headless.locationfilterdetails.md) | Additional details relevant to the filter with "PLACE" for its [AppliedQueryFilterType](./answers-headless.appliedqueryfiltertype.md). | -| [LocationState](./answers-headless.locationstate.md) | Maintains the user's location, if given, or the inferred location, that is used to bias search results. | -| [LowerNumberRangeLimit](./answers-headless.lowernumberrangelimit.md) | The start limit of [NumberRangeValue](./answers-headless.numberrangevalue.md). | -| [MetaState](./answers-headless.metastate.md) | Maintains the metadata for Answers Headless. | -| [NearFilterValue](./answers-headless.nearfiltervalue.md) | A filter value for a filter with a $near [Matcher](./answers-headless.matcher.md). | -| [NumberRangeValue](./answers-headless.numberrangevalue.md) | A filter value for a filter with a $between [Matcher](./answers-headless.matcher.md). | -| [ParentState](./answers-headless.parentstate.md) | The overall shape of the redux state tree, with each key value pair of headlessId to [State](./answers-headless.state.md) representing a single AnswersHeadless instance. | -| [QueryRulesActionsData](./answers-headless.queryrulesactionsdata.md) | Data returned from the Answers query rules system. | -| [QueryRulesState](./answers-headless.queryrulesstate.md) | Maintains the data from the triggered query rules. | -| [QueryState](./answers-headless.querystate.md) | Maintains the latest query and its associated data. | -| [QuestionSubmissionRequest](./answers-headless.questionsubmissionrequest.md) | Options for a QuestionSubmission request. | -| [QuestionSubmissionResponse](./answers-headless.questionsubmissionresponse.md) | A representation of a question submission response. | -| [QuestionSubmissionService](./answers-headless.questionsubmissionservice.md) | Submits a custom question to the Answers API. | -| [RangeBoundary](./answers-headless.rangeboundary.md) | A boundary for a [BoundedRange](./answers-headless.boundedrange.md) of type T. | -| [Result](./answers-headless.result.md) | An individual search result. | -| [SearchParameterField](./answers-headless.searchparameterfield.md) | Indicates which entity field to perform the autocomplete request on. | -| [SearchService](./answers-headless.searchservice.md) | A service which performs Yext Answers searches | -| [SearchStatusState](./answers-headless.searchstatusstate.md) | Maintains the status of the latest search. | -| [SelectableFilter](./answers-headless.selectablefilter.md) | A [Filter](./answers-headless.filter.md) with additional information, such as an optional display name and whether or not it is selected. | -| [SessionTrackingState](./answers-headless.sessiontrackingstate.md) | Maintains whether the user session should be tracked and, if so, the session information. | -| [Snippet](./answers-headless.snippet.md) | The section of text where a [FeaturedSnippetDirectAnswer](./answers-headless.featuredsnippetdirectanswer.md) was found. | -| [SortBy](./answers-headless.sortby.md) | Represents a criterion that can be used to sort results. | -| [SpellCheck](./answers-headless.spellcheck.md) | A spellcheck response from a search query. | -| [SpellCheckState](./answers-headless.spellcheckstate.md) | Maintains whether spellcheck is enabled and the spellcheck response from the latest search. | -| [State](./answers-headless.state.md) | The state representing an AnswersHeadless instance. | -| [StateListener](./answers-headless.statelistener.md) | Represents a listener for a specific value of type T in the state. | -| [StateManager](./answers-headless.statemanager.md) | Manages the information contained in the state for an AnswersHeadless instance. | -| [UniversalAutocompleteRequest](./answers-headless.universalautocompleterequest.md) | Options for a universal autocomplete request. | -| [UniversalLimit](./answers-headless.universallimit.md) | The maximum limit of results per vertical. Each limit can be set from 1-50, inclusive. | -| [UniversalSearchRequest](./answers-headless.universalsearchrequest.md) | Options which can be specified for a universal search. | -| [UniversalSearchResponse](./answers-headless.universalsearchresponse.md) | A representation of a response from a universal search. | -| [UniversalSearchState](./answers-headless.universalsearchstate.md) | Maintains the data for the latest universal search. | -| [UpperNumberRangeLimit](./answers-headless.uppernumberrangelimit.md) | The end limit of [NumberRangeValue](./answers-headless.numberrangevalue.md). | -| [VerticalAutocompleteRequest](./answers-headless.verticalautocompleterequest.md) | Options for a vertial autocomplete request. | -| [VerticalResults](./answers-headless.verticalresults.md) | Represents results from a search vertical. | -| [VerticalSearchRequest](./answers-headless.verticalsearchrequest.md) | Options which can be specified for a vertical search. | -| [VerticalSearchResponse](./answers-headless.verticalsearchresponse.md) | A representation of a response from a vertical search. | -| [VerticalSearchState](./answers-headless.verticalsearchstate.md) | Maintains the data for the latest vertical search. | -| [Visitor](./answers-headless.visitor.md) | Information used to associate requests with a particular user. | - -## Namespaces - -| Namespace | Description | -| --- | --- | -| [answersUtilities](./answers-headless.answersutilities.md) | | - -## Variables - -| Variable | Description | -| --- | --- | -| [DEFAULT\_HEADLESS\_ID](./answers-headless.default_headless_id.md) | The headlessId automatically given to the first AnswersHeadless instance created. | -| [SandboxEndpoints](./answers-headless.sandboxendpoints.md) | The endpoints to use for sandbox experiences. | - -## Type Aliases - -| Type Alias | Description | -| --- | --- | -| [AnswersConfig](./answers-headless.answersconfig.md) | The main configuration options for [AnswersCore](./answers-headless.answerscore.md). For a full description of the options, see [BaseAnswersConfig](./answers-headless.baseanswersconfig.md). The config requires either an apiKey or a token. | -| [Context](./answers-headless.context.md) | Used to trigger Answers [Query Rules](https://hitchhikers.yext.com/tracks/answers-advanced/ans302-query-rules/). | -| [EnumOrLiteral](./answers-headless.enumorliteral.md) | Produces a union type from the enum passed as a generic which consists of the enum values and the string literals of the enum. | -| [FilterTypes](./answers-headless.filtertypes.md) | A union type for the different kinds of filter. | -| [HeadlessConfig](./answers-headless.headlessconfig.md) | The configuration for an AnswersHeadless instance. | -| [HighlightedFields](./answers-headless.highlightedfields.md) | A mapping of fields to the values emphasized by the Answers API | -| [SearchType](./answers-headless.searchtype.md) | An enum and its corresponding string literals which indicate the type of search that Headless is managing. | - diff --git a/docs/answers-headless.metastate.md b/docs/answers-headless.metastate.md deleted file mode 100644 index e260711f..00000000 --- a/docs/answers-headless.metastate.md +++ /dev/null @@ -1,23 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [MetaState](./answers-headless.metastate.md) - -## MetaState interface - -Maintains the metadata for Answers Headless. - -Signature: - -```typescript -export interface MetaState -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [context?](./answers-headless.metastate.context.md) | [Context](./answers-headless.context.md) | (Optional) A JSON object used for passing data to and triggering Answers [Query Rules](https://hitchhikers.yext.com/tracks/answers-advanced/ans302-query-rules/). | -| [referrerPageUrl?](./answers-headless.metastate.referrerpageurl.md) | string | (Optional) The URL of the referring page (the page that directed to the current page from which the request was made). | -| [searchType](./answers-headless.metastate.searchtype.md) | [SearchType](./answers-headless.searchtype.md) | Indicates the type of search that Answers Headless is managing. | -| [uuid?](./answers-headless.metastate.uuid.md) | string | (Optional) A unique id which corresponds to the latest request/response. | - diff --git a/docs/answers-headless.nearfiltervalue.lat.md b/docs/answers-headless.nearfiltervalue.lat.md deleted file mode 100644 index e633858c..00000000 --- a/docs/answers-headless.nearfiltervalue.lat.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [NearFilterValue](./answers-headless.nearfiltervalue.md) > [lat](./answers-headless.nearfiltervalue.lat.md) - -## NearFilterValue.lat property - -The latitude of the location. - -Signature: - -```typescript -lat: number; -``` diff --git a/docs/answers-headless.nearfiltervalue.lng.md b/docs/answers-headless.nearfiltervalue.lng.md deleted file mode 100644 index 41a00c51..00000000 --- a/docs/answers-headless.nearfiltervalue.lng.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [NearFilterValue](./answers-headless.nearfiltervalue.md) > [lng](./answers-headless.nearfiltervalue.lng.md) - -## NearFilterValue.lng property - -The longitude of the location. - -Signature: - -```typescript -lng: number; -``` diff --git a/docs/answers-headless.nearfiltervalue.md b/docs/answers-headless.nearfiltervalue.md deleted file mode 100644 index 9a48074a..00000000 --- a/docs/answers-headless.nearfiltervalue.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [NearFilterValue](./answers-headless.nearfiltervalue.md) - -## NearFilterValue interface - -A filter value for a filter with a $near [Matcher](./answers-headless.matcher.md). - -Signature: - -```typescript -export declare interface NearFilterValue -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [lat](./answers-headless.nearfiltervalue.lat.md) | number | The latitude of the location. | -| [lng](./answers-headless.nearfiltervalue.lng.md) | number | The longitude of the location. | -| [radius](./answers-headless.nearfiltervalue.radius.md) | number | The radius (in meters) around the latitude and longitude. | - diff --git a/docs/answers-headless.numberrangevalue.md b/docs/answers-headless.numberrangevalue.md deleted file mode 100644 index 942183fd..00000000 --- a/docs/answers-headless.numberrangevalue.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [NumberRangeValue](./answers-headless.numberrangevalue.md) - -## NumberRangeValue interface - -A filter value for a filter with a $between [Matcher](./answers-headless.matcher.md). - -Signature: - -```typescript -export declare interface NumberRangeValue -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [end?](./answers-headless.numberrangevalue.end.md) | [UpperNumberRangeLimit](./answers-headless.uppernumberrangelimit.md) | (Optional) End limit of the number range value. | -| [start?](./answers-headless.numberrangevalue.start.md) | [LowerNumberRangeLimit](./answers-headless.lowernumberrangelimit.md) | (Optional) Start limit of the number range value. | - diff --git a/docs/answers-headless.parentstate.md b/docs/answers-headless.parentstate.md deleted file mode 100644 index fd92c30f..00000000 --- a/docs/answers-headless.parentstate.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [ParentState](./answers-headless.parentstate.md) - -## ParentState interface - -The overall shape of the redux state tree, with each key value pair of headlessId to [State](./answers-headless.state.md) representing a single AnswersHeadless instance. - -Signature: - -```typescript -export interface ParentState -``` diff --git a/docs/answers-headless.provideanswersheadless.md b/docs/answers-headless.provideanswersheadless.md deleted file mode 100644 index dd5f40a6..00000000 --- a/docs/answers-headless.provideanswersheadless.md +++ /dev/null @@ -1,26 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [provideAnswersHeadless](./answers-headless.provideanswersheadless.md) - -## provideAnswersHeadless() function - -Supplies a new instance of [AnswersHeadless](./answers-headless.answersheadless.md), using the provided configuration. - -Signature: - -```typescript -export declare function provideAnswersHeadless(config: HeadlessConfig): AnswersHeadless; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| config | [HeadlessConfig](./answers-headless.headlessconfig.md) | The apiKey, experienceKey, etc. needed to set up a front-end Answers experience. | - -Returns: - -AnswersHeadless - -The newly created instance of [AnswersHeadless](./answers-headless.answersheadless.md) - diff --git a/docs/answers-headless.queryrulesactionsdata.key.md b/docs/answers-headless.queryrulesactionsdata.key.md deleted file mode 100644 index 20e4a8d9..00000000 --- a/docs/answers-headless.queryrulesactionsdata.key.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [QueryRulesActionsData](./answers-headless.queryrulesactionsdata.md) > [key](./answers-headless.queryrulesactionsdata.key.md) - -## QueryRulesActionsData.key property - -The unique identifier for this query rule. - -Signature: - -```typescript -key: string; -``` diff --git a/docs/answers-headless.queryrulesactionsdata.md b/docs/answers-headless.queryrulesactionsdata.md deleted file mode 100644 index 1feab1c9..00000000 --- a/docs/answers-headless.queryrulesactionsdata.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [QueryRulesActionsData](./answers-headless.queryrulesactionsdata.md) - -## QueryRulesActionsData interface - -Data returned from the Answers query rules system. - -Signature: - -```typescript -export declare interface QueryRulesActionsData -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [data?](./answers-headless.queryrulesactionsdata.data.md) | Record<string, unknown> | (Optional) The data returned from the query rule. | -| [errors?](./answers-headless.queryrulesactionsdata.errors.md) | { uuid: string; type: string; message?: string; }\[\] | (Optional) Any errors returned from the query rule. | -| [key](./answers-headless.queryrulesactionsdata.key.md) | string | The unique identifier for this query rule. | - diff --git a/docs/answers-headless.queryrulesstate.md b/docs/answers-headless.queryrulesstate.md deleted file mode 100644 index d2d08708..00000000 --- a/docs/answers-headless.queryrulesstate.md +++ /dev/null @@ -1,20 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [QueryRulesState](./answers-headless.queryrulesstate.md) - -## QueryRulesState interface - -Maintains the data from the triggered query rules. - -Signature: - -```typescript -export interface QueryRulesState -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [actions](./answers-headless.queryrulesstate.actions.md) | [QueryRulesActionsData](./answers-headless.queryrulesactionsdata.md)\[\] | Any actions triggered by meeting criteria for query rules. | - diff --git a/docs/answers-headless.querystate.md b/docs/answers-headless.querystate.md deleted file mode 100644 index f40ccf3e..00000000 --- a/docs/answers-headless.querystate.md +++ /dev/null @@ -1,25 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [QueryState](./answers-headless.querystate.md) - -## QueryState interface - -Maintains the latest query and its associated data. - -Signature: - -```typescript -export interface QueryState -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [input?](./answers-headless.querystate.input.md) | string | (Optional) The user input used for the next search query. | -| [mostRecentSearch?](./answers-headless.querystate.mostrecentsearch.md) | string | (Optional) The query of the most recent search. | -| [queryId?](./answers-headless.querystate.queryid.md) | string | (Optional) The ID of the query from the latest search. | -| [querySource?](./answers-headless.querystate.querysource.md) | [QuerySource](./answers-headless.querysource.md) | (Optional) The source of the query (from a standard Answers integration, an Answers overlay, or from visual autocomplete). | -| [queryTrigger?](./answers-headless.querystate.querytrigger.md) | [QueryTrigger](./answers-headless.querytrigger.md) | (Optional) How the query was triggered (besides user input). | -| [searchIntents?](./answers-headless.querystate.searchintents.md) | [SearchIntent](./answers-headless.searchintent.md)\[\] | (Optional) The computed intents of the mostRecentSearch, as returned by the Answers API. | - diff --git a/docs/answers-headless.questionsubmissionrequest.entityid.md b/docs/answers-headless.questionsubmissionrequest.entityid.md deleted file mode 100644 index 95767e0e..00000000 --- a/docs/answers-headless.questionsubmissionrequest.entityid.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [QuestionSubmissionRequest](./answers-headless.questionsubmissionrequest.md) > [entityId](./answers-headless.questionsubmissionrequest.entityid.md) - -## QuestionSubmissionRequest.entityId property - -The ID of the entity to associate with the question. - -Signature: - -```typescript -entityId: string; -``` diff --git a/docs/answers-headless.questionsubmissionrequest.md b/docs/answers-headless.questionsubmissionrequest.md deleted file mode 100644 index 4f712ddd..00000000 --- a/docs/answers-headless.questionsubmissionrequest.md +++ /dev/null @@ -1,26 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [QuestionSubmissionRequest](./answers-headless.questionsubmissionrequest.md) - -## QuestionSubmissionRequest interface - -Options for a QuestionSubmission request. - -Signature: - -```typescript -export declare interface QuestionSubmissionRequest extends AnswersRequest -``` -Extends: [AnswersRequest](./answers-headless.answersrequest.md) - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [email](./answers-headless.questionsubmissionrequest.email.md) | string | The email of the user that is submitting the question. | -| [entityId](./answers-headless.questionsubmissionrequest.entityid.md) | string | The ID of the entity to associate with the question. | -| [name](./answers-headless.questionsubmissionrequest.name.md) | string | The name of the user. | -| [questionDescription?](./answers-headless.questionsubmissionrequest.questiondescription.md) | string | (Optional) Additional information about the question. | -| [questionText](./answers-headless.questionsubmissionrequest.questiontext.md) | string | The question. | -| [sessionTrackingEnabled?](./answers-headless.questionsubmissionrequest.sessiontrackingenabled.md) | boolean | (Optional) Enables session tracking. | - diff --git a/docs/answers-headless.questionsubmissionrequest.name.md b/docs/answers-headless.questionsubmissionrequest.name.md deleted file mode 100644 index 3295b038..00000000 --- a/docs/answers-headless.questionsubmissionrequest.name.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [QuestionSubmissionRequest](./answers-headless.questionsubmissionrequest.md) > [name](./answers-headless.questionsubmissionrequest.name.md) - -## QuestionSubmissionRequest.name property - -The name of the user. - -Signature: - -```typescript -name: string; -``` diff --git a/docs/answers-headless.questionsubmissionrequest.questiondescription.md b/docs/answers-headless.questionsubmissionrequest.questiondescription.md deleted file mode 100644 index 377270eb..00000000 --- a/docs/answers-headless.questionsubmissionrequest.questiondescription.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [QuestionSubmissionRequest](./answers-headless.questionsubmissionrequest.md) > [questionDescription](./answers-headless.questionsubmissionrequest.questiondescription.md) - -## QuestionSubmissionRequest.questionDescription property - -Additional information about the question. - -Signature: - -```typescript -questionDescription?: string; -``` diff --git a/docs/answers-headless.questionsubmissionrequest.questiontext.md b/docs/answers-headless.questionsubmissionrequest.questiontext.md deleted file mode 100644 index b8aca4a6..00000000 --- a/docs/answers-headless.questionsubmissionrequest.questiontext.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [QuestionSubmissionRequest](./answers-headless.questionsubmissionrequest.md) > [questionText](./answers-headless.questionsubmissionrequest.questiontext.md) - -## QuestionSubmissionRequest.questionText property - -The question. - -Signature: - -```typescript -questionText: string; -``` diff --git a/docs/answers-headless.questionsubmissionrequest.sessiontrackingenabled.md b/docs/answers-headless.questionsubmissionrequest.sessiontrackingenabled.md deleted file mode 100644 index 9e81ed79..00000000 --- a/docs/answers-headless.questionsubmissionrequest.sessiontrackingenabled.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [QuestionSubmissionRequest](./answers-headless.questionsubmissionrequest.md) > [sessionTrackingEnabled](./answers-headless.questionsubmissionrequest.sessiontrackingenabled.md) - -## QuestionSubmissionRequest.sessionTrackingEnabled property - -Enables session tracking. - -Signature: - -```typescript -sessionTrackingEnabled?: boolean; -``` diff --git a/docs/answers-headless.questionsubmissionresponse.uuid.md b/docs/answers-headless.questionsubmissionresponse.uuid.md deleted file mode 100644 index 04f3e233..00000000 --- a/docs/answers-headless.questionsubmissionresponse.uuid.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [QuestionSubmissionResponse](./answers-headless.questionsubmissionresponse.md) > [uuid](./answers-headless.questionsubmissionresponse.uuid.md) - -## QuestionSubmissionResponse.uuid property - -A unique id which corresponds to the request. - -Signature: - -```typescript -uuid: string; -``` diff --git a/docs/answers-headless.questionsubmissionservice.submitquestion.md b/docs/answers-headless.questionsubmissionservice.submitquestion.md deleted file mode 100644 index b3afc10b..00000000 --- a/docs/answers-headless.questionsubmissionservice.submitquestion.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [QuestionSubmissionService](./answers-headless.questionsubmissionservice.md) > [submitQuestion](./answers-headless.questionsubmissionservice.submitquestion.md) - -## QuestionSubmissionService.submitQuestion() method - -Submits a question to be answered. - -Signature: - -```typescript -submitQuestion(request: QuestionSubmissionRequest): Promise; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| request | [QuestionSubmissionRequest](./answers-headless.questionsubmissionrequest.md) | The question, as well as the contact info of the submitter. | - -Returns: - -Promise<[QuestionSubmissionResponse](./answers-headless.questionsubmissionresponse.md)> - diff --git a/docs/answers-headless.rangeboundary.md b/docs/answers-headless.rangeboundary.md deleted file mode 100644 index e92e2966..00000000 --- a/docs/answers-headless.rangeboundary.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [RangeBoundary](./answers-headless.rangeboundary.md) - -## RangeBoundary interface - -A boundary for a [BoundedRange](./answers-headless.boundedrange.md) of type T. - -Signature: - -```typescript -export interface RangeBoundary -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [inclusive](./answers-headless.rangeboundary.inclusive.md) | boolean | Whether or not the range includes the boundary value. | -| [value](./answers-headless.rangeboundary.value.md) | T | The value of the boundary. | - diff --git a/docs/answers-headless.rangeboundary.value.md b/docs/answers-headless.rangeboundary.value.md deleted file mode 100644 index 2e855012..00000000 --- a/docs/answers-headless.rangeboundary.value.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [RangeBoundary](./answers-headless.rangeboundary.md) > [value](./answers-headless.rangeboundary.value.md) - -## RangeBoundary.value property - -The value of the boundary. - -Signature: - -```typescript -value: T; -``` diff --git a/docs/answers-headless.result.highlightedfields.md b/docs/answers-headless.result.highlightedfields.md deleted file mode 100644 index 55604cb8..00000000 --- a/docs/answers-headless.result.highlightedfields.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [Result](./answers-headless.result.md) > [highlightedFields](./answers-headless.result.highlightedfields.md) - -## Result.highlightedFields property - -The [highlighted fields](./answers-headless.highlightedfields.md) emphasized by the api. - -Signature: - -```typescript -highlightedFields?: HighlightedFields; -``` diff --git a/docs/answers-headless.result.md b/docs/answers-headless.result.md deleted file mode 100644 index 2f1c064a..00000000 --- a/docs/answers-headless.result.md +++ /dev/null @@ -1,30 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [Result](./answers-headless.result.md) - -## Result interface - -An individual search result. - -Signature: - -```typescript -export declare interface Result -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [description?](./answers-headless.result.description.md) | string | (Optional) A description of the result. | -| [distance?](./answers-headless.result.distance.md) | number | (Optional) The distance from the user to the result in meters. | -| [distanceFromFilter?](./answers-headless.result.distancefromfilter.md) | number | (Optional) The distance from a [AppliedQueryFilter](./answers-headless.appliedqueryfilter.md) location to the result in meters. | -| [entityType?](./answers-headless.result.entitytype.md) | string | (Optional) The entity type of the result | -| [highlightedFields?](./answers-headless.result.highlightedfields.md) | [HighlightedFields](./answers-headless.highlightedfields.md) | (Optional) The [highlighted fields](./answers-headless.highlightedfields.md) emphasized by the api. | -| [id?](./answers-headless.result.id.md) | string | (Optional) The result ID which depends on the Result Source. | -| [index?](./answers-headless.result.index.md) | number | (Optional) The index of the result among the other results in the search. | -| [link?](./answers-headless.result.link.md) | string | (Optional) A hyperlink associated with the result. | -| [name?](./answers-headless.result.name.md) | string | (Optional) The name of the result. | -| [rawData](./answers-headless.result.rawdata.md) | Record<string, unknown> | Raw entity profile data in the shape of key-value pairs. | -| [source](./answers-headless.result.source.md) | [Source](./answers-headless.source.md) | Represents the source of a [Result](./answers-headless.result.md). | - diff --git a/docs/answers-headless.result.source.md b/docs/answers-headless.result.source.md deleted file mode 100644 index 1246be88..00000000 --- a/docs/answers-headless.result.source.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [Result](./answers-headless.result.md) > [source](./answers-headless.result.source.md) - -## Result.source property - -Represents the source of a [Result](./answers-headless.result.md). - -Signature: - -```typescript -source: Source; -``` diff --git a/docs/answers-headless.searchparameterfield.fetchentities.md b/docs/answers-headless.searchparameterfield.fetchentities.md deleted file mode 100644 index 3d2c8139..00000000 --- a/docs/answers-headless.searchparameterfield.fetchentities.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [SearchParameterField](./answers-headless.searchparameterfield.md) > [fetchEntities](./answers-headless.searchparameterfield.fetchentities.md) - -## SearchParameterField.fetchEntities property - -Indicates whether or not to return the [AutocompleteResult.relatedItem](./answers-headless.autocompleteresult.relateditem.md) associated with the autocomplete result. - -Signature: - -```typescript -fetchEntities: boolean; -``` diff --git a/docs/answers-headless.searchparameterfield.md b/docs/answers-headless.searchparameterfield.md deleted file mode 100644 index 6570bc36..00000000 --- a/docs/answers-headless.searchparameterfield.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [SearchParameterField](./answers-headless.searchparameterfield.md) - -## SearchParameterField interface - -Indicates which entity field to perform the autocomplete request on. - -Signature: - -```typescript -export declare interface SearchParameterField -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [entityType](./answers-headless.searchparameterfield.entitytype.md) | string | The entityType to perform the autocomplete on. | -| [fetchEntities](./answers-headless.searchparameterfield.fetchentities.md) | boolean | Indicates whether or not to return the [AutocompleteResult.relatedItem](./answers-headless.autocompleteresult.relateditem.md) associated with the autocomplete result. | -| [fieldApiName](./answers-headless.searchparameterfield.fieldapiname.md) | string | The fieldApiName to perform the autocomplete on. | - diff --git a/docs/answers-headless.searchservice.md b/docs/answers-headless.searchservice.md deleted file mode 100644 index 9c318abb..00000000 --- a/docs/answers-headless.searchservice.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [SearchService](./answers-headless.searchservice.md) - -## SearchService interface - -A service which performs Yext Answers searches - -Signature: - -```typescript -export declare interface SearchService -``` - -## Methods - -| Method | Description | -| --- | --- | -| [universalSearch(request)](./answers-headless.searchservice.universalsearch.md) | Performs a Universal search across all verticals. | -| [verticalSearch(request)](./answers-headless.searchservice.verticalsearch.md) | Performs a search across a particular Vertical. | - diff --git a/docs/answers-headless.searchservice.verticalsearch.md b/docs/answers-headless.searchservice.verticalsearch.md deleted file mode 100644 index 8c9324ca..00000000 --- a/docs/answers-headless.searchservice.verticalsearch.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [SearchService](./answers-headless.searchservice.md) > [verticalSearch](./answers-headless.searchservice.verticalsearch.md) - -## SearchService.verticalSearch() method - -Performs a search across a particular Vertical. - -Signature: - -```typescript -verticalSearch(request: VerticalSearchRequest): Promise; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| request | [VerticalSearchRequest](./answers-headless.verticalsearchrequest.md) | The details of the Vertical search request. | - -Returns: - -Promise<[VerticalSearchResponse](./answers-headless.verticalsearchresponse.md)> - diff --git a/docs/answers-headless.searchstatusstate.md b/docs/answers-headless.searchstatusstate.md deleted file mode 100644 index abd0819c..00000000 --- a/docs/answers-headless.searchstatusstate.md +++ /dev/null @@ -1,20 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [SearchStatusState](./answers-headless.searchstatusstate.md) - -## SearchStatusState interface - -Maintains the status of the latest search. - -Signature: - -```typescript -export interface SearchStatusState -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [isLoading?](./answers-headless.searchstatusstate.isloading.md) | boolean | (Optional) Whether a search is currently loading or has finished loading. | - diff --git a/docs/answers-headless.selectablefilter.displayname.md b/docs/answers-headless.selectablefilter.displayname.md deleted file mode 100644 index 40462580..00000000 --- a/docs/answers-headless.selectablefilter.displayname.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [SelectableFilter](./answers-headless.selectablefilter.md) > [displayName](./answers-headless.selectablefilter.displayname.md) - -## SelectableFilter.displayName property - -The filter's display name. - -Signature: - -```typescript -displayName?: string; -``` diff --git a/docs/answers-headless.selectablefilter.md b/docs/answers-headless.selectablefilter.md deleted file mode 100644 index d4457093..00000000 --- a/docs/answers-headless.selectablefilter.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [SelectableFilter](./answers-headless.selectablefilter.md) - -## SelectableFilter interface - -A [Filter](./answers-headless.filter.md) with additional information, such as an optional display name and whether or not it is selected. - -Signature: - -```typescript -export interface SelectableFilter extends Filter -``` -Extends: [Filter](./answers-headless.filter.md) - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [displayName?](./answers-headless.selectablefilter.displayname.md) | string | (Optional) The filter's display name. | -| [selected](./answers-headless.selectablefilter.selected.md) | boolean | Whether or not the filter is selected. | - diff --git a/docs/answers-headless.sessiontrackingstate.md b/docs/answers-headless.sessiontrackingstate.md deleted file mode 100644 index 9638f245..00000000 --- a/docs/answers-headless.sessiontrackingstate.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [SessionTrackingState](./answers-headless.sessiontrackingstate.md) - -## SessionTrackingState interface - -Maintains whether the user session should be tracked and, if so, the session information. - -Signature: - -```typescript -export interface SessionTrackingState -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [enabled?](./answers-headless.sessiontrackingstate.enabled.md) | boolean | (Optional) Whether or not session tracking is enabled. | -| [sessionId?](./answers-headless.sessiontrackingstate.sessionid.md) | string | (Optional) The ID of the current session. Used to track session state when cookies are blocked. | - diff --git a/docs/answers-headless.snippet.md b/docs/answers-headless.snippet.md deleted file mode 100644 index 6d03ccb1..00000000 --- a/docs/answers-headless.snippet.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [Snippet](./answers-headless.snippet.md) - -## Snippet interface - -The section of text where a [FeaturedSnippetDirectAnswer](./answers-headless.featuredsnippetdirectanswer.md) was found. - -Signature: - -```typescript -export declare interface Snippet -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [matchedSubstrings](./answers-headless.snippet.matchedsubstrings.md) | { offset: number; length: number; }\[\] | The locations in the document text of the [FeaturedSnippetDirectAnswer.value](./answers-headless.featuredsnippetdirectanswer.value.md) | -| [value](./answers-headless.snippet.value.md) | string | The snippet's body of text | - diff --git a/docs/answers-headless.sortby.field.md b/docs/answers-headless.sortby.field.md deleted file mode 100644 index 9b2aff2a..00000000 --- a/docs/answers-headless.sortby.field.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [SortBy](./answers-headless.sortby.md) > [field](./answers-headless.sortby.field.md) - -## SortBy.field property - -The field name to sort by. Required if the SortBy type is [SortType.Field](./answers-headless.sorttype.md). - -Signature: - -```typescript -field?: string; -``` diff --git a/docs/answers-headless.sortby.md b/docs/answers-headless.sortby.md deleted file mode 100644 index 8e1121c4..00000000 --- a/docs/answers-headless.sortby.md +++ /dev/null @@ -1,26 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [SortBy](./answers-headless.sortby.md) - -## SortBy interface - -Represents a criterion that can be used to sort results. - -Signature: - -```typescript -export declare interface SortBy -``` - -## Remarks - -Overrides the sort options that are configured on the experience configuration. - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [direction?](./answers-headless.sortby.direction.md) | [Direction](./answers-headless.direction.md) | (Optional) The direction of the sort. Required if the SortBy type is [SortType.Field](./answers-headless.sorttype.md). | -| [field?](./answers-headless.sortby.field.md) | string | (Optional) The field name to sort by. Required if the SortBy type is [SortType.Field](./answers-headless.sorttype.md). | -| [type](./answers-headless.sortby.type.md) | [SortType](./answers-headless.sorttype.md) | The method of sorting. | - diff --git a/docs/answers-headless.spellcheck.md b/docs/answers-headless.spellcheck.md deleted file mode 100644 index 17d807ef..00000000 --- a/docs/answers-headless.spellcheck.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [SpellCheck](./answers-headless.spellcheck.md) - -## SpellCheck interface - -A spellcheck response from a search query. - -Signature: - -```typescript -export declare interface SpellCheck -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [correctedQuery](./answers-headless.spellcheck.correctedquery.md) | string | The corrected version of the originalQuery. | -| [originalQuery](./answers-headless.spellcheck.originalquery.md) | string | The query that was input into the spell checker. | -| [type](./answers-headless.spellcheck.type.md) | [SpellCheckType](./answers-headless.spellchecktype.md) | The type of spell check. | - diff --git a/docs/answers-headless.state.md b/docs/answers-headless.state.md deleted file mode 100644 index 10ce19bc..00000000 --- a/docs/answers-headless.state.md +++ /dev/null @@ -1,30 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [State](./answers-headless.state.md) - -## State interface - -The state representing an AnswersHeadless instance. - -Signature: - -```typescript -export interface State -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [directAnswer](./answers-headless.state.directanswer.md) | [DirectAnswerState](./answers-headless.directanswerstate.md) | Maintains the direct answer associated with the latest search. | -| [filters](./answers-headless.state.filters.md) | [FiltersState](./answers-headless.filtersstate.md) | Maintains the current state of facets and filters in the application. | -| [location](./answers-headless.state.location.md) | [LocationState](./answers-headless.locationstate.md) | Maintains the user's location, if given, or the inferred location, that is used to bias search results. | -| [meta](./answers-headless.state.meta.md) | [MetaState](./answers-headless.metastate.md) | Maintains the metadata for Answers Headless. | -| [query](./answers-headless.state.query.md) | [QueryState](./answers-headless.querystate.md) | Maintains the latest query and its associated data. | -| [queryRules](./answers-headless.state.queryrules.md) | [QueryRulesState](./answers-headless.queryrulesstate.md) | Maintains the data from the triggered query rules. | -| [searchStatus](./answers-headless.state.searchstatus.md) | [SearchStatusState](./answers-headless.searchstatusstate.md) | Maintains the status of the latest search. | -| [sessionTracking](./answers-headless.state.sessiontracking.md) | [SessionTrackingState](./answers-headless.sessiontrackingstate.md) | Maintains whether the user session should be tracked and, if so, the session information. | -| [spellCheck](./answers-headless.state.spellcheck.md) | [SpellCheckState](./answers-headless.spellcheckstate.md) | Maintains whether spellcheck is enabled and the spellcheck response from the latest search. | -| [universal](./answers-headless.state.universal.md) | [UniversalSearchState](./answers-headless.universalsearchstate.md) | Maintains the data for the latest universal search. | -| [vertical](./answers-headless.state.vertical.md) | [VerticalSearchState](./answers-headless.verticalsearchstate.md) | Maintains the data for the latest vertical search. | - diff --git a/docs/answers-headless.statelistener.md b/docs/answers-headless.statelistener.md deleted file mode 100644 index 56f28a9b..00000000 --- a/docs/answers-headless.statelistener.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [StateListener](./answers-headless.statelistener.md) - -## StateListener interface - -Represents a listener for a specific value of type T in the state. - -Signature: - -```typescript -export default interface StateListener -``` - -## Methods - -| Method | Description | -| --- | --- | -| [callback(currentValue)](./answers-headless.statelistener.callback.md) | The function to call when the state value updates. | -| [valueAccessor(state)](./answers-headless.statelistener.valueaccessor.md) | Accesses a value of type T in the state. | - diff --git a/docs/answers-headless.statemanager.getstate.md b/docs/answers-headless.statemanager.getstate.md deleted file mode 100644 index 8e4b8be0..00000000 --- a/docs/answers-headless.statemanager.getstate.md +++ /dev/null @@ -1,17 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [StateManager](./answers-headless.statemanager.md) > [getState](./answers-headless.statemanager.getstate.md) - -## StateManager.getState() method - -Returns the current state. - -Signature: - -```typescript -getState(): State; -``` -Returns: - -[State](./answers-headless.state.md) - diff --git a/docs/answers-headless.statemanager.md b/docs/answers-headless.statemanager.md deleted file mode 100644 index b053615c..00000000 --- a/docs/answers-headless.statemanager.md +++ /dev/null @@ -1,26 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [StateManager](./answers-headless.statemanager.md) - -## StateManager interface - -Manages the information contained in the state for an AnswersHeadless instance. - -Signature: - -```typescript -export default interface StateManager -``` - -## Remarks - -The [State](./answers-headless.state.md) is immutable, and can only be updated by dispatched events. - -## Methods - -| Method | Description | -| --- | --- | -| [addListener(listener)](./answers-headless.statemanager.addlistener.md) | Adds a listener for a specific state value of type T. | -| [dispatchEvent(type, payload)](./answers-headless.statemanager.dispatchevent.md) | Dispatches an event. This can update the [State](./answers-headless.state.md). | -| [getState()](./answers-headless.statemanager.getstate.md) | Returns the current state. | - diff --git a/docs/answers-headless.universalautocompleterequest.input.md b/docs/answers-headless.universalautocompleterequest.input.md deleted file mode 100644 index 4f0d70f9..00000000 --- a/docs/answers-headless.universalautocompleterequest.input.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [UniversalAutocompleteRequest](./answers-headless.universalautocompleterequest.md) > [input](./answers-headless.universalautocompleterequest.input.md) - -## UniversalAutocompleteRequest.input property - -The input string for autocomplete. - -Signature: - -```typescript -input: string; -``` diff --git a/docs/answers-headless.universalautocompleterequest.md b/docs/answers-headless.universalautocompleterequest.md deleted file mode 100644 index 8d353754..00000000 --- a/docs/answers-headless.universalautocompleterequest.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [UniversalAutocompleteRequest](./answers-headless.universalautocompleterequest.md) - -## UniversalAutocompleteRequest interface - -Options for a universal autocomplete request. - -Signature: - -```typescript -export declare interface UniversalAutocompleteRequest extends AnswersRequest -``` -Extends: [AnswersRequest](./answers-headless.answersrequest.md) - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [input](./answers-headless.universalautocompleterequest.input.md) | string | The input string for autocomplete. | -| [sessionTrackingEnabled?](./answers-headless.universalautocompleterequest.sessiontrackingenabled.md) | boolean | (Optional) Enables session tracking. | - diff --git a/docs/answers-headless.universalautocompleterequest.sessiontrackingenabled.md b/docs/answers-headless.universalautocompleterequest.sessiontrackingenabled.md deleted file mode 100644 index b548109f..00000000 --- a/docs/answers-headless.universalautocompleterequest.sessiontrackingenabled.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [UniversalAutocompleteRequest](./answers-headless.universalautocompleterequest.md) > [sessionTrackingEnabled](./answers-headless.universalautocompleterequest.sessiontrackingenabled.md) - -## UniversalAutocompleteRequest.sessionTrackingEnabled property - -Enables session tracking. - -Signature: - -```typescript -sessionTrackingEnabled?: boolean; -``` diff --git a/docs/answers-headless.universalsearchrequest.md b/docs/answers-headless.universalsearchrequest.md deleted file mode 100644 index 1b53a936..00000000 --- a/docs/answers-headless.universalsearchrequest.md +++ /dev/null @@ -1,31 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [UniversalSearchRequest](./answers-headless.universalsearchrequest.md) - -## UniversalSearchRequest interface - -Options which can be specified for a universal search. - -Signature: - -```typescript -export declare interface UniversalSearchRequest extends AnswersRequest -``` -Extends: [AnswersRequest](./answers-headless.answersrequest.md) - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [context?](./answers-headless.universalsearchrequest.context.md) | [Context](./answers-headless.context.md) | (Optional) Used to trigger Answers [Query Rules](https://hitchhikers.yext.com/tracks/answers-advanced/ans302-query-rules/). | -| [limit?](./answers-headless.universalsearchrequest.limit.md) | [UniversalLimit](./answers-headless.universallimit.md) | (Optional) The maximum limit of results per vertical. Each limit can be set from 1-50, inclusive. | -| [location?](./answers-headless.universalsearchrequest.location.md) | [LatLong](./answers-headless.latlong.md) | (Optional) The latitude and longitude of the user making the request. Used to bias the results. | -| [query](./answers-headless.universalsearchrequest.query.md) | string | The search query. | -| [querySource?](./answers-headless.universalsearchrequest.querysource.md) | [QuerySource](./answers-headless.querysource.md) \| string | (Optional) The source of the search request. | -| [queryTrigger?](./answers-headless.universalsearchrequest.querytrigger.md) | [QueryTrigger](./answers-headless.querytrigger.md) | (Optional) Describes the ways a search can be executed besides user input. | -| [referrerPageUrl?](./answers-headless.universalsearchrequest.referrerpageurl.md) | string | (Optional) The URl of the page which referred the user to the current page. | -| [restrictVerticals?](./answers-headless.universalsearchrequest.restrictverticals.md) | string\[\] | (Optional) If included, the response will only include these verticals. | -| [sessionId?](./answers-headless.universalsearchrequest.sessionid.md) | string | (Optional) Used to track session state when cookies are blocked. | -| [sessionTrackingEnabled?](./answers-headless.universalsearchrequest.sessiontrackingenabled.md) | boolean | (Optional) Enables session tracking. | -| [skipSpellCheck?](./answers-headless.universalsearchrequest.skipspellcheck.md) | boolean | (Optional) Disables spellcheck if true. | - diff --git a/docs/answers-headless.universalsearchrequest.query.md b/docs/answers-headless.universalsearchrequest.query.md deleted file mode 100644 index f28c3d8f..00000000 --- a/docs/answers-headless.universalsearchrequest.query.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [UniversalSearchRequest](./answers-headless.universalsearchrequest.md) > [query](./answers-headless.universalsearchrequest.query.md) - -## UniversalSearchRequest.query property - -The search query. - -Signature: - -```typescript -query: string; -``` diff --git a/docs/answers-headless.universalsearchrequest.sessiontrackingenabled.md b/docs/answers-headless.universalsearchrequest.sessiontrackingenabled.md deleted file mode 100644 index bd28e5e9..00000000 --- a/docs/answers-headless.universalsearchrequest.sessiontrackingenabled.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [UniversalSearchRequest](./answers-headless.universalsearchrequest.md) > [sessionTrackingEnabled](./answers-headless.universalsearchrequest.sessiontrackingenabled.md) - -## UniversalSearchRequest.sessionTrackingEnabled property - -Enables session tracking. - -Signature: - -```typescript -sessionTrackingEnabled?: boolean; -``` diff --git a/docs/answers-headless.universalsearchrequest.skipspellcheck.md b/docs/answers-headless.universalsearchrequest.skipspellcheck.md deleted file mode 100644 index 756f2aca..00000000 --- a/docs/answers-headless.universalsearchrequest.skipspellcheck.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [UniversalSearchRequest](./answers-headless.universalsearchrequest.md) > [skipSpellCheck](./answers-headless.universalsearchrequest.skipspellcheck.md) - -## UniversalSearchRequest.skipSpellCheck property - -Disables spellcheck if true. - -Signature: - -```typescript -skipSpellCheck?: boolean; -``` diff --git a/docs/answers-headless.universalsearchresponse.locationbias.md b/docs/answers-headless.universalsearchresponse.locationbias.md deleted file mode 100644 index aeaa17d3..00000000 --- a/docs/answers-headless.universalsearchresponse.locationbias.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [UniversalSearchResponse](./answers-headless.universalsearchresponse.md) > [locationBias](./answers-headless.universalsearchresponse.locationbias.md) - -## UniversalSearchResponse.locationBias property - -Information about the user's location. - -Signature: - -```typescript -locationBias?: LocationBias; -``` diff --git a/docs/answers-headless.universalsearchresponse.md b/docs/answers-headless.universalsearchresponse.md deleted file mode 100644 index 06a0cd80..00000000 --- a/docs/answers-headless.universalsearchresponse.md +++ /dev/null @@ -1,28 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [UniversalSearchResponse](./answers-headless.universalsearchresponse.md) - -## UniversalSearchResponse interface - -A representation of a response from a universal search. - -Signature: - -```typescript -export declare interface UniversalSearchResponse -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [directAnswer?](./answers-headless.universalsearchresponse.directanswer.md) | [FeaturedSnippetDirectAnswer](./answers-headless.featuredsnippetdirectanswer.md) \| [FieldValueDirectAnswer](./answers-headless.fieldvaluedirectanswer.md) | (Optional) A direct answer to a search. | -| [failedVerticals?](./answers-headless.universalsearchresponse.failedverticals.md) | [FailedVertical](./answers-headless.failedvertical.md)\[\] | (Optional) Error information from when a vertical fails to return results. | -| [locationBias?](./answers-headless.universalsearchresponse.locationbias.md) | [LocationBias](./answers-headless.locationbias.md) | (Optional) Information about the user's location. | -| [queryId?](./answers-headless.universalsearchresponse.queryid.md) | string | (Optional) The ID of the search query. | -| [queryRulesActionsData?](./answers-headless.universalsearchresponse.queryrulesactionsdata.md) | [QueryRulesActionsData](./answers-headless.queryrulesactionsdata.md)\[\] | (Optional) Data returned from the Answers query rules system. | -| [searchIntents?](./answers-headless.universalsearchresponse.searchintents.md) | [SearchIntent](./answers-headless.searchintent.md)\[\] | (Optional) An array of [SearchIntent](./answers-headless.searchintent.md)s which represents requests from the API. | -| [spellCheck?](./answers-headless.universalsearchresponse.spellcheck.md) | [SpellCheck](./answers-headless.spellcheck.md) | (Optional) A spellcheck response from a search query. | -| [uuid](./answers-headless.universalsearchresponse.uuid.md) | string | A unique id which corresponds to the request. | -| [verticalResults](./answers-headless.universalsearchresponse.verticalresults.md) | [VerticalResults](./answers-headless.verticalresults.md)\[\] | An array of [VerticalResults](./answers-headless.verticalresults.md) which represent the results for each vertical. | - diff --git a/docs/answers-headless.universalsearchresponse.queryid.md b/docs/answers-headless.universalsearchresponse.queryid.md deleted file mode 100644 index 4ee2bdda..00000000 --- a/docs/answers-headless.universalsearchresponse.queryid.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [UniversalSearchResponse](./answers-headless.universalsearchresponse.md) > [queryId](./answers-headless.universalsearchresponse.queryid.md) - -## UniversalSearchResponse.queryId property - -The ID of the search query. - -Signature: - -```typescript -queryId?: string; -``` diff --git a/docs/answers-headless.universalsearchresponse.searchintents.md b/docs/answers-headless.universalsearchresponse.searchintents.md deleted file mode 100644 index 00159ccf..00000000 --- a/docs/answers-headless.universalsearchresponse.searchintents.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [UniversalSearchResponse](./answers-headless.universalsearchresponse.md) > [searchIntents](./answers-headless.universalsearchresponse.searchintents.md) - -## UniversalSearchResponse.searchIntents property - -An array of [SearchIntent](./answers-headless.searchintent.md)s which represents requests from the API. - -Signature: - -```typescript -searchIntents?: SearchIntent[]; -``` diff --git a/docs/answers-headless.universalsearchresponse.spellcheck.md b/docs/answers-headless.universalsearchresponse.spellcheck.md deleted file mode 100644 index 36cf4820..00000000 --- a/docs/answers-headless.universalsearchresponse.spellcheck.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [UniversalSearchResponse](./answers-headless.universalsearchresponse.md) > [spellCheck](./answers-headless.universalsearchresponse.spellcheck.md) - -## UniversalSearchResponse.spellCheck property - -A spellcheck response from a search query. - -Signature: - -```typescript -spellCheck?: SpellCheck; -``` diff --git a/docs/answers-headless.universalsearchresponse.uuid.md b/docs/answers-headless.universalsearchresponse.uuid.md deleted file mode 100644 index b22f1d6b..00000000 --- a/docs/answers-headless.universalsearchresponse.uuid.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [UniversalSearchResponse](./answers-headless.universalsearchresponse.md) > [uuid](./answers-headless.universalsearchresponse.uuid.md) - -## UniversalSearchResponse.uuid property - -A unique id which corresponds to the request. - -Signature: - -```typescript -uuid: string; -``` diff --git a/docs/answers-headless.universalsearchresponse.verticalresults.md b/docs/answers-headless.universalsearchresponse.verticalresults.md deleted file mode 100644 index 6992a8a1..00000000 --- a/docs/answers-headless.universalsearchresponse.verticalresults.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [UniversalSearchResponse](./answers-headless.universalsearchresponse.md) > [verticalResults](./answers-headless.universalsearchresponse.verticalresults.md) - -## UniversalSearchResponse.verticalResults property - -An array of [VerticalResults](./answers-headless.verticalresults.md) which represent the results for each vertical. - -Signature: - -```typescript -verticalResults: VerticalResults[]; -``` diff --git a/docs/answers-headless.universalsearchstate.md b/docs/answers-headless.universalsearchstate.md deleted file mode 100644 index 3bdc43b2..00000000 --- a/docs/answers-headless.universalsearchstate.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [UniversalSearchState](./answers-headless.universalsearchstate.md) - -## UniversalSearchState interface - -Maintains the data for the latest universal search. - -Signature: - -```typescript -export interface UniversalSearchState -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [limit?](./answers-headless.universalsearchstate.limit.md) | [UniversalLimit](./answers-headless.universallimit.md) | (Optional) An object defining the limit (up to how many results should be returned) for each vertical. | -| [restrictVerticals?](./answers-headless.universalsearchstate.restrictverticals.md) | string\[\] | (Optional) If included, the verticals to which the universal search should be restricted. | -| [verticals?](./answers-headless.universalsearchstate.verticals.md) | [VerticalResults](./answers-headless.verticalresults.md)\[\] | (Optional) The results from each vertical included in the universal search. | - diff --git a/docs/answers-headless.uppernumberrangelimit.matcher.md b/docs/answers-headless.uppernumberrangelimit.matcher.md deleted file mode 100644 index 549cd01b..00000000 --- a/docs/answers-headless.uppernumberrangelimit.matcher.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [UpperNumberRangeLimit](./answers-headless.uppernumberrangelimit.md) > [matcher](./answers-headless.uppernumberrangelimit.matcher.md) - -## UpperNumberRangeLimit.matcher property - -[Matcher](./answers-headless.matcher.md) for the end limit - -Signature: - -```typescript -matcher: Matcher.LessThan | Matcher.LessThanOrEqualTo; -``` diff --git a/docs/answers-headless.uppernumberrangelimit.md b/docs/answers-headless.uppernumberrangelimit.md deleted file mode 100644 index 4f987149..00000000 --- a/docs/answers-headless.uppernumberrangelimit.md +++ /dev/null @@ -1,21 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [UpperNumberRangeLimit](./answers-headless.uppernumberrangelimit.md) - -## UpperNumberRangeLimit interface - -The end limit of [NumberRangeValue](./answers-headless.numberrangevalue.md). - -Signature: - -```typescript -export declare interface UpperNumberRangeLimit -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [matcher](./answers-headless.uppernumberrangelimit.matcher.md) | [Matcher.LessThan](./answers-headless.matcher.md) \| [Matcher.LessThanOrEqualTo](./answers-headless.matcher.md) | [Matcher](./answers-headless.matcher.md) for the end limit | -| [value](./answers-headless.uppernumberrangelimit.value.md) | number | Value of the limit. | - diff --git a/docs/answers-headless.uppernumberrangelimit.value.md b/docs/answers-headless.uppernumberrangelimit.value.md deleted file mode 100644 index b996eeb1..00000000 --- a/docs/answers-headless.uppernumberrangelimit.value.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [UpperNumberRangeLimit](./answers-headless.uppernumberrangelimit.md) > [value](./answers-headless.uppernumberrangelimit.value.md) - -## UpperNumberRangeLimit.value property - -Value of the limit. - -Signature: - -```typescript -value: number; -``` diff --git a/docs/answers-headless.verticalautocompleterequest.input.md b/docs/answers-headless.verticalautocompleterequest.input.md deleted file mode 100644 index 09200d43..00000000 --- a/docs/answers-headless.verticalautocompleterequest.input.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [VerticalAutocompleteRequest](./answers-headless.verticalautocompleterequest.md) > [input](./answers-headless.verticalautocompleterequest.input.md) - -## VerticalAutocompleteRequest.input property - -The input string for autocomplete. - -Signature: - -```typescript -input: string; -``` diff --git a/docs/answers-headless.verticalautocompleterequest.md b/docs/answers-headless.verticalautocompleterequest.md deleted file mode 100644 index 0e432f3f..00000000 --- a/docs/answers-headless.verticalautocompleterequest.md +++ /dev/null @@ -1,23 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [VerticalAutocompleteRequest](./answers-headless.verticalautocompleterequest.md) - -## VerticalAutocompleteRequest interface - -Options for a vertial autocomplete request. - -Signature: - -```typescript -export declare interface VerticalAutocompleteRequest extends AnswersRequest -``` -Extends: [AnswersRequest](./answers-headless.answersrequest.md) - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [input](./answers-headless.verticalautocompleterequest.input.md) | string | The input string for autocomplete. | -| [sessionTrackingEnabled?](./answers-headless.verticalautocompleterequest.sessiontrackingenabled.md) | boolean | (Optional) Enables session tracking. | -| [verticalKey](./answers-headless.verticalautocompleterequest.verticalkey.md) | string | The key for the vertical to get autocomplete suggestions from. | - diff --git a/docs/answers-headless.verticalautocompleterequest.sessiontrackingenabled.md b/docs/answers-headless.verticalautocompleterequest.sessiontrackingenabled.md deleted file mode 100644 index fb2043de..00000000 --- a/docs/answers-headless.verticalautocompleterequest.sessiontrackingenabled.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [VerticalAutocompleteRequest](./answers-headless.verticalautocompleterequest.md) > [sessionTrackingEnabled](./answers-headless.verticalautocompleterequest.sessiontrackingenabled.md) - -## VerticalAutocompleteRequest.sessionTrackingEnabled property - -Enables session tracking. - -Signature: - -```typescript -sessionTrackingEnabled?: boolean; -``` diff --git a/docs/answers-headless.verticalresults.appliedqueryfilters.md b/docs/answers-headless.verticalresults.appliedqueryfilters.md deleted file mode 100644 index 1bf65885..00000000 --- a/docs/answers-headless.verticalresults.appliedqueryfilters.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [VerticalResults](./answers-headless.verticalresults.md) > [appliedQueryFilters](./answers-headless.verticalresults.appliedqueryfilters.md) - -## VerticalResults.appliedQueryFilters property - -A array of [AppliedQueryFilter](./answers-headless.appliedqueryfilter.md)s which were applied to the vertical results. - -Signature: - -```typescript -appliedQueryFilters: AppliedQueryFilter[]; -``` diff --git a/docs/answers-headless.verticalresults.md b/docs/answers-headless.verticalresults.md deleted file mode 100644 index 3f7c86f4..00000000 --- a/docs/answers-headless.verticalresults.md +++ /dev/null @@ -1,25 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [VerticalResults](./answers-headless.verticalresults.md) - -## VerticalResults interface - -Represents results from a search vertical. - -Signature: - -```typescript -export declare interface VerticalResults -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [appliedQueryFilters](./answers-headless.verticalresults.appliedqueryfilters.md) | [AppliedQueryFilter](./answers-headless.appliedqueryfilter.md)\[\] | A array of [AppliedQueryFilter](./answers-headless.appliedqueryfilter.md)s which were applied to the vertical results. | -| [queryDurationMillis](./answers-headless.verticalresults.querydurationmillis.md) | number | The duration of the query in milliseconds. | -| [results](./answers-headless.verticalresults.results.md) | [Result](./answers-headless.result.md)\[\] | An array of search [Result](./answers-headless.result.md)s for the vertical. | -| [resultsCount](./answers-headless.verticalresults.resultscount.md) | number | The total number of results within the vertical. | -| [source](./answers-headless.verticalresults.source.md) | [Source](./answers-headless.source.md) | Represents the source of a [Result](./answers-headless.result.md). | -| [verticalKey](./answers-headless.verticalresults.verticalkey.md) | string | The vertical key associated with the vertical results. | - diff --git a/docs/answers-headless.verticalresults.results.md b/docs/answers-headless.verticalresults.results.md deleted file mode 100644 index 97b02b71..00000000 --- a/docs/answers-headless.verticalresults.results.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [VerticalResults](./answers-headless.verticalresults.md) > [results](./answers-headless.verticalresults.results.md) - -## VerticalResults.results property - -An array of search [Result](./answers-headless.result.md)s for the vertical. - -Signature: - -```typescript -results: Result[]; -``` diff --git a/docs/answers-headless.verticalresults.source.md b/docs/answers-headless.verticalresults.source.md deleted file mode 100644 index 4720336b..00000000 --- a/docs/answers-headless.verticalresults.source.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [VerticalResults](./answers-headless.verticalresults.md) > [source](./answers-headless.verticalresults.source.md) - -## VerticalResults.source property - -Represents the source of a [Result](./answers-headless.result.md). - -Signature: - -```typescript -source: Source; -``` diff --git a/docs/answers-headless.verticalsearchrequest.facets.md b/docs/answers-headless.verticalsearchrequest.facets.md deleted file mode 100644 index 211a5756..00000000 --- a/docs/answers-headless.verticalsearchrequest.facets.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [VerticalSearchRequest](./answers-headless.verticalsearchrequest.md) > [facets](./answers-headless.verticalsearchrequest.facets.md) - -## VerticalSearchRequest.facets property - -The facet filters to apply to the search. - -Signature: - -```typescript -facets?: Facet[]; -``` diff --git a/docs/answers-headless.verticalsearchrequest.md b/docs/answers-headless.verticalsearchrequest.md deleted file mode 100644 index be75e114..00000000 --- a/docs/answers-headless.verticalsearchrequest.md +++ /dev/null @@ -1,38 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [VerticalSearchRequest](./answers-headless.verticalsearchrequest.md) - -## VerticalSearchRequest interface - -Options which can be specified for a vertical search. - -Signature: - -```typescript -export declare interface VerticalSearchRequest extends AnswersRequest -``` -Extends: [AnswersRequest](./answers-headless.answersrequest.md) - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [context?](./answers-headless.verticalsearchrequest.context.md) | [Context](./answers-headless.context.md) | (Optional) Used to trigger Answers [Query Rules](https://hitchhikers.yext.com/tracks/answers-advanced/ans302-query-rules/). | -| [facets?](./answers-headless.verticalsearchrequest.facets.md) | [Facet](./answers-headless.facet.md)\[\] | (Optional) The facet filters to apply to the search. | -| [limit?](./answers-headless.verticalsearchrequest.limit.md) | number | (Optional) The maximum number of results to include with a max of 50. | -| [location?](./answers-headless.verticalsearchrequest.location.md) | [LatLong](./answers-headless.latlong.md) | (Optional) The latitude and longitude of the user making the request. Used to bias the results. | -| [locationRadius?](./answers-headless.verticalsearchrequest.locationradius.md) | number | (Optional) The radius (in meters) to filter the vertical search by. | -| [offset?](./answers-headless.verticalsearchrequest.offset.md) | number | (Optional) The result offset which allows for fetching more results with the same query. | -| [query](./answers-headless.verticalsearchrequest.query.md) | string | The search query. | -| [queryId?](./answers-headless.verticalsearchrequest.queryid.md) | string | (Optional) The queryId for the query, if this is a repeat query. | -| [querySource?](./answers-headless.verticalsearchrequest.querysource.md) | [QuerySource](./answers-headless.querysource.md) \| string | (Optional) The source of the search request. | -| [queryTrigger?](./answers-headless.verticalsearchrequest.querytrigger.md) | [QueryTrigger](./answers-headless.querytrigger.md) | (Optional) Describes the ways a search can be executed besides user input. | -| [referrerPageUrl?](./answers-headless.verticalsearchrequest.referrerpageurl.md) | string | (Optional) The URl of the page which referred the user to the current page. | -| [retrieveFacets?](./answers-headless.verticalsearchrequest.retrievefacets.md) | boolean | (Optional) Indicates that facets should be retrieved. | -| [sessionId?](./answers-headless.verticalsearchrequest.sessionid.md) | string | (Optional) Used to track session state when cookies are blocked. | -| [sessionTrackingEnabled?](./answers-headless.verticalsearchrequest.sessiontrackingenabled.md) | boolean | (Optional) Enables session tracking. | -| [skipSpellCheck?](./answers-headless.verticalsearchrequest.skipspellcheck.md) | boolean | (Optional) Skips spell checking if true. | -| [sortBys?](./answers-headless.verticalsearchrequest.sortbys.md) | [SortBy](./answers-headless.sortby.md)\[\] | (Optional) Determines how results are sorted. \* | -| [staticFilters?](./answers-headless.verticalsearchrequest.staticfilters.md) | [CombinedFilter](./answers-headless.combinedfilter.md) \| [Filter](./answers-headless.filter.md) | (Optional) The static filters to apply to the search. | -| [verticalKey](./answers-headless.verticalsearchrequest.verticalkey.md) | string | The key associated with the vertical. | - diff --git a/docs/answers-headless.verticalsearchrequest.query.md b/docs/answers-headless.verticalsearchrequest.query.md deleted file mode 100644 index 8fea85cb..00000000 --- a/docs/answers-headless.verticalsearchrequest.query.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [VerticalSearchRequest](./answers-headless.verticalsearchrequest.md) > [query](./answers-headless.verticalsearchrequest.query.md) - -## VerticalSearchRequest.query property - -The search query. - -Signature: - -```typescript -query: string; -``` diff --git a/docs/answers-headless.verticalsearchrequest.retrievefacets.md b/docs/answers-headless.verticalsearchrequest.retrievefacets.md deleted file mode 100644 index 42fb1028..00000000 --- a/docs/answers-headless.verticalsearchrequest.retrievefacets.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [VerticalSearchRequest](./answers-headless.verticalsearchrequest.md) > [retrieveFacets](./answers-headless.verticalsearchrequest.retrievefacets.md) - -## VerticalSearchRequest.retrieveFacets property - -Indicates that facets should be retrieved. - -Signature: - -```typescript -retrieveFacets?: boolean; -``` diff --git a/docs/answers-headless.verticalsearchrequest.sessiontrackingenabled.md b/docs/answers-headless.verticalsearchrequest.sessiontrackingenabled.md deleted file mode 100644 index 57641117..00000000 --- a/docs/answers-headless.verticalsearchrequest.sessiontrackingenabled.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [VerticalSearchRequest](./answers-headless.verticalsearchrequest.md) > [sessionTrackingEnabled](./answers-headless.verticalsearchrequest.sessiontrackingenabled.md) - -## VerticalSearchRequest.sessionTrackingEnabled property - -Enables session tracking. - -Signature: - -```typescript -sessionTrackingEnabled?: boolean; -``` diff --git a/docs/answers-headless.verticalsearchrequest.skipspellcheck.md b/docs/answers-headless.verticalsearchrequest.skipspellcheck.md deleted file mode 100644 index 6663a1d7..00000000 --- a/docs/answers-headless.verticalsearchrequest.skipspellcheck.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [VerticalSearchRequest](./answers-headless.verticalsearchrequest.md) > [skipSpellCheck](./answers-headless.verticalsearchrequest.skipspellcheck.md) - -## VerticalSearchRequest.skipSpellCheck property - -Skips spell checking if true. - -Signature: - -```typescript -skipSpellCheck?: boolean; -``` diff --git a/docs/answers-headless.verticalsearchrequest.sortbys.md b/docs/answers-headless.verticalsearchrequest.sortbys.md deleted file mode 100644 index abff6e68..00000000 --- a/docs/answers-headless.verticalsearchrequest.sortbys.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [VerticalSearchRequest](./answers-headless.verticalsearchrequest.md) > [sortBys](./answers-headless.verticalsearchrequest.sortbys.md) - -## VerticalSearchRequest.sortBys property - -Determines how results are sorted. \* - -Signature: - -```typescript -sortBys?: SortBy[]; -``` diff --git a/docs/answers-headless.verticalsearchrequest.verticalkey.md b/docs/answers-headless.verticalsearchrequest.verticalkey.md deleted file mode 100644 index 97bd720a..00000000 --- a/docs/answers-headless.verticalsearchrequest.verticalkey.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [VerticalSearchRequest](./answers-headless.verticalsearchrequest.md) > [verticalKey](./answers-headless.verticalsearchrequest.verticalkey.md) - -## VerticalSearchRequest.verticalKey property - -The key associated with the vertical. - -Signature: - -```typescript -verticalKey: string; -``` diff --git a/docs/answers-headless.verticalsearchresponse.alternativeverticals.md b/docs/answers-headless.verticalsearchresponse.alternativeverticals.md deleted file mode 100644 index 11f4d655..00000000 --- a/docs/answers-headless.verticalsearchresponse.alternativeverticals.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [VerticalSearchResponse](./answers-headless.verticalsearchresponse.md) > [alternativeVerticals](./answers-headless.verticalsearchresponse.alternativeverticals.md) - -## VerticalSearchResponse.alternativeVerticals property - -The [VerticalResults](./answers-headless.verticalresults.md) for each search vertical. - -Signature: - -```typescript -alternativeVerticals?: VerticalResults[]; -``` diff --git a/docs/answers-headless.verticalsearchresponse.facets.md b/docs/answers-headless.verticalsearchresponse.facets.md deleted file mode 100644 index fe8a2ae5..00000000 --- a/docs/answers-headless.verticalsearchresponse.facets.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [VerticalSearchResponse](./answers-headless.verticalsearchresponse.md) > [facets](./answers-headless.verticalsearchresponse.facets.md) - -## VerticalSearchResponse.facets property - -An array of [Facet](./answers-headless.facet.md)s associated with the search results. - -Signature: - -```typescript -facets?: DisplayableFacet[]; -``` diff --git a/docs/answers-headless.verticalsearchresponse.locationbias.md b/docs/answers-headless.verticalsearchresponse.locationbias.md deleted file mode 100644 index 3f0bc2aa..00000000 --- a/docs/answers-headless.verticalsearchresponse.locationbias.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [VerticalSearchResponse](./answers-headless.verticalsearchresponse.md) > [locationBias](./answers-headless.verticalsearchresponse.locationbias.md) - -## VerticalSearchResponse.locationBias property - -Information about the user's location. - -Signature: - -```typescript -locationBias?: LocationBias; -``` diff --git a/docs/answers-headless.verticalsearchresponse.md b/docs/answers-headless.verticalsearchresponse.md deleted file mode 100644 index 4c3b0c10..00000000 --- a/docs/answers-headless.verticalsearchresponse.md +++ /dev/null @@ -1,30 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [VerticalSearchResponse](./answers-headless.verticalsearchresponse.md) - -## VerticalSearchResponse interface - -A representation of a response from a vertical search. - -Signature: - -```typescript -export declare interface VerticalSearchResponse -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [allResultsForVertical?](./answers-headless.verticalsearchresponse.allresultsforvertical.md) | [VerticalSearchResponse](./answers-headless.verticalsearchresponse.md) | (Optional) A representation of a response from a vertical search. | -| [alternativeVerticals?](./answers-headless.verticalsearchresponse.alternativeverticals.md) | [VerticalResults](./answers-headless.verticalresults.md)\[\] | (Optional) The [VerticalResults](./answers-headless.verticalresults.md) for each search vertical. | -| [directAnswer?](./answers-headless.verticalsearchresponse.directanswer.md) | [FeaturedSnippetDirectAnswer](./answers-headless.featuredsnippetdirectanswer.md) \| [FieldValueDirectAnswer](./answers-headless.fieldvaluedirectanswer.md) | (Optional) A direct answer to a search. | -| [facets?](./answers-headless.verticalsearchresponse.facets.md) | [DisplayableFacet](./answers-headless.displayablefacet.md)\[\] | (Optional) An array of [Facet](./answers-headless.facet.md)s associated with the search results. | -| [locationBias?](./answers-headless.verticalsearchresponse.locationbias.md) | [LocationBias](./answers-headless.locationbias.md) | (Optional) Information about the user's location. | -| [queryId](./answers-headless.verticalsearchresponse.queryid.md) | string | The ID of the query. | -| [queryRulesActionsData?](./answers-headless.verticalsearchresponse.queryrulesactionsdata.md) | [QueryRulesActionsData](./answers-headless.queryrulesactionsdata.md)\[\] | (Optional) Data returned from the Answers query rules system. | -| [searchIntents?](./answers-headless.verticalsearchresponse.searchintents.md) | [SearchIntent](./answers-headless.searchintent.md)\[\] | (Optional) An array of [SearchIntent](./answers-headless.searchintent.md)s. | -| [spellCheck?](./answers-headless.verticalsearchresponse.spellcheck.md) | [SpellCheck](./answers-headless.spellcheck.md) | (Optional) A spellcheck response from a search query. | -| [uuid](./answers-headless.verticalsearchresponse.uuid.md) | string | A unique id which corresponds to the request. | -| [verticalResults](./answers-headless.verticalsearchresponse.verticalresults.md) | [VerticalResults](./answers-headless.verticalresults.md) | Represents results from a search vertical. | - diff --git a/docs/answers-headless.verticalsearchresponse.queryid.md b/docs/answers-headless.verticalsearchresponse.queryid.md deleted file mode 100644 index b4ca610e..00000000 --- a/docs/answers-headless.verticalsearchresponse.queryid.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [VerticalSearchResponse](./answers-headless.verticalsearchresponse.md) > [queryId](./answers-headless.verticalsearchresponse.queryid.md) - -## VerticalSearchResponse.queryId property - -The ID of the query. - -Signature: - -```typescript -queryId: string; -``` diff --git a/docs/answers-headless.verticalsearchresponse.searchintents.md b/docs/answers-headless.verticalsearchresponse.searchintents.md deleted file mode 100644 index f0b3c4ba..00000000 --- a/docs/answers-headless.verticalsearchresponse.searchintents.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [VerticalSearchResponse](./answers-headless.verticalsearchresponse.md) > [searchIntents](./answers-headless.verticalsearchresponse.searchintents.md) - -## VerticalSearchResponse.searchIntents property - -An array of [SearchIntent](./answers-headless.searchintent.md)s. - -Signature: - -```typescript -searchIntents?: SearchIntent[]; -``` diff --git a/docs/answers-headless.verticalsearchresponse.uuid.md b/docs/answers-headless.verticalsearchresponse.uuid.md deleted file mode 100644 index 1c6184e9..00000000 --- a/docs/answers-headless.verticalsearchresponse.uuid.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [VerticalSearchResponse](./answers-headless.verticalsearchresponse.md) > [uuid](./answers-headless.verticalsearchresponse.uuid.md) - -## VerticalSearchResponse.uuid property - -A unique id which corresponds to the request. - -Signature: - -```typescript -uuid: string; -``` diff --git a/docs/answers-headless.verticalsearchstate.displayname.md b/docs/answers-headless.verticalsearchstate.displayname.md deleted file mode 100644 index efdba5b5..00000000 --- a/docs/answers-headless.verticalsearchstate.displayname.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [VerticalSearchState](./answers-headless.verticalsearchstate.md) > [displayName](./answers-headless.verticalsearchstate.displayname.md) - -## VerticalSearchState.displayName property - -Name to be displayed for the vertical. - -Signature: - -```typescript -displayName?: string; -``` diff --git a/docs/answers-headless.verticalsearchstate.md b/docs/answers-headless.verticalsearchstate.md deleted file mode 100644 index 508db714..00000000 --- a/docs/answers-headless.verticalsearchstate.md +++ /dev/null @@ -1,30 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [VerticalSearchState](./answers-headless.verticalsearchstate.md) - -## VerticalSearchState interface - -Maintains the data for the latest vertical search. - -Signature: - -```typescript -export interface VerticalSearchState -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [appliedQueryFilters?](./answers-headless.verticalsearchstate.appliedqueryfilters.md) | [AppliedQueryFilter](./answers-headless.appliedqueryfilter.md)\[\] | (Optional) The array of filters inferred from the query and applied to the search. | -| [displayName?](./answers-headless.verticalsearchstate.displayname.md) | string | (Optional) Name to be displayed for the vertical. | -| [limit?](./answers-headless.verticalsearchstate.limit.md) | number | (Optional) The maximum number of results to include for the vertical search. | -| [noResults?](./answers-headless.verticalsearchstate.noresults.md) | { allResultsForVertical: [AllResultsForVertical](./answers-headless.allresultsforvertical.md); alternativeVerticals: [VerticalResults](./answers-headless.verticalresults.md)\[\]; } | (Optional) The data for when no results are returned in the vertical search. | -| [offset?](./answers-headless.verticalsearchstate.offset.md) | number | (Optional) The number of results that should be skipped when fetching results for the response. Allows for fetching more results with the same query. | -| [queryDurationMillis?](./answers-headless.verticalsearchstate.querydurationmillis.md) | number | (Optional) The duration of the query in milliseconds. | -| [results?](./answers-headless.verticalsearchstate.results.md) | [Result](./answers-headless.result.md)\[\] | (Optional) The results from the vertical search. | -| [resultsCount?](./answers-headless.verticalsearchstate.resultscount.md) | number | (Optional) The number of results for the vertical search. | -| [sortBys?](./answers-headless.verticalsearchstate.sortbys.md) | [SortBy](./answers-headless.sortby.md)\[\] | (Optional) The criteria by which the results should be sorted, in the order in which they should be applied. | -| [source?](./answers-headless.verticalsearchstate.source.md) | [Source](./answers-headless.source.md) | (Optional) The source of the vertical search results. | -| [verticalKey?](./answers-headless.verticalsearchstate.verticalkey.md) | string | (Optional) The key associated with the vertical. | - diff --git a/docs/answers-headless.verticalsearchstate.results.md b/docs/answers-headless.verticalsearchstate.results.md deleted file mode 100644 index 0e80025c..00000000 --- a/docs/answers-headless.verticalsearchstate.results.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [VerticalSearchState](./answers-headless.verticalsearchstate.md) > [results](./answers-headless.verticalsearchstate.results.md) - -## VerticalSearchState.results property - -The results from the vertical search. - -Signature: - -```typescript -results?: Result[]; -``` diff --git a/docs/answers-headless.verticalsearchstate.verticalkey.md b/docs/answers-headless.verticalsearchstate.verticalkey.md deleted file mode 100644 index 913c06b0..00000000 --- a/docs/answers-headless.verticalsearchstate.verticalkey.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [VerticalSearchState](./answers-headless.verticalsearchstate.md) > [verticalKey](./answers-headless.verticalsearchstate.verticalkey.md) - -## VerticalSearchState.verticalKey property - -The key associated with the vertical. - -Signature: - -```typescript -verticalKey?: string; -``` diff --git a/docs/index.md b/docs/index.md index 5670bcd2..e642a4b0 100644 --- a/docs/index.md +++ b/docs/index.md @@ -8,5 +8,5 @@ | Package | Description | | --- | --- | -| [@yext/answers-headless](./answers-headless.md) | | +| [@yext/search-headless](./search-headless.md) | | diff --git a/docs/answers-headless.additionalhttpheaders._client-sdk_.md b/docs/search-headless.additionalhttpheaders._client-sdk_.md similarity index 62% rename from docs/answers-headless.additionalhttpheaders._client-sdk_.md rename to docs/search-headless.additionalhttpheaders._client-sdk_.md index fa9f8955..65685d74 100644 --- a/docs/answers-headless.additionalhttpheaders._client-sdk_.md +++ b/docs/search-headless.additionalhttpheaders._client-sdk_.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [AdditionalHttpHeaders](./answers-headless.additionalhttpheaders.md) > ["Client-SDK"](./answers-headless.additionalhttpheaders._client-sdk_.md) +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [AdditionalHttpHeaders](./search-headless.additionalhttpheaders.md) > ["Client-SDK"](./search-headless.additionalhttpheaders._client-sdk_.md) ## AdditionalHttpHeaders."Client-SDK" property diff --git a/docs/search-headless.additionalhttpheaders.md b/docs/search-headless.additionalhttpheaders.md new file mode 100644 index 00000000..6cd3d732 --- /dev/null +++ b/docs/search-headless.additionalhttpheaders.md @@ -0,0 +1,20 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [AdditionalHttpHeaders](./search-headless.additionalhttpheaders.md) + +## AdditionalHttpHeaders interface + +AdditionalHttpHeaders allows users to specify additional values for specific HTTP headers. + +Signature: + +```typescript +export declare interface AdditionalHttpHeaders +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| ["Client-SDK"?](./search-headless.additionalhttpheaders._client-sdk_.md) | [ClientSDKHeaderValues](./search-headless.clientsdkheadervalues.md) | (Optional) Additional agents and their versions used to create the Answers experience. The information for these agents is added to the Client-SDK HTTP header along with that of the ANSWERS\_CORE agent. | + diff --git a/docs/answers-headless.allresultsforvertical.facets.md b/docs/search-headless.allresultsforvertical.facets.md similarity index 58% rename from docs/answers-headless.allresultsforvertical.facets.md rename to docs/search-headless.allresultsforvertical.facets.md index a739bee9..005308fc 100644 --- a/docs/answers-headless.allresultsforvertical.facets.md +++ b/docs/search-headless.allresultsforvertical.facets.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [AllResultsForVertical](./answers-headless.allresultsforvertical.md) > [facets](./answers-headless.allresultsforvertical.facets.md) +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [AllResultsForVertical](./search-headless.allresultsforvertical.md) > [facets](./search-headless.allresultsforvertical.facets.md) ## AllResultsForVertical.facets property diff --git a/docs/search-headless.allresultsforvertical.md b/docs/search-headless.allresultsforvertical.md new file mode 100644 index 00000000..f220a456 --- /dev/null +++ b/docs/search-headless.allresultsforvertical.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [AllResultsForVertical](./search-headless.allresultsforvertical.md) + +## AllResultsForVertical interface + +Represents all results for the current vertical. + +Signature: + +```typescript +export interface AllResultsForVertical +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [facets](./search-headless.allresultsforvertical.facets.md) | [DisplayableFacet](./search-headless.displayablefacet.md)\[\] | The dynamic collection of facets that can be applied to filter the search results and whether each of them is currently selected. | +| [results](./search-headless.allresultsforvertical.results.md) | [Result](./search-headless.result.md)\[\] | The array of all results for the vertical. | +| [resultsCount](./search-headless.allresultsforvertical.resultscount.md) | number | The total number of results for the vertical. | + diff --git a/docs/search-headless.allresultsforvertical.results.md b/docs/search-headless.allresultsforvertical.results.md new file mode 100644 index 00000000..58cd6a31 --- /dev/null +++ b/docs/search-headless.allresultsforvertical.results.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [AllResultsForVertical](./search-headless.allresultsforvertical.md) > [results](./search-headless.allresultsforvertical.results.md) + +## AllResultsForVertical.results property + +The array of all results for the vertical. + +Signature: + +```typescript +results: Result[]; +``` diff --git a/docs/answers-headless.allresultsforvertical.resultscount.md b/docs/search-headless.allresultsforvertical.resultscount.md similarity index 50% rename from docs/answers-headless.allresultsforvertical.resultscount.md rename to docs/search-headless.allresultsforvertical.resultscount.md index dacefcbc..2e38c244 100644 --- a/docs/answers-headless.allresultsforvertical.resultscount.md +++ b/docs/search-headless.allresultsforvertical.resultscount.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [AllResultsForVertical](./answers-headless.allresultsforvertical.md) > [resultsCount](./answers-headless.allresultsforvertical.resultscount.md) +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [AllResultsForVertical](./search-headless.allresultsforvertical.md) > [resultsCount](./search-headless.allresultsforvertical.resultscount.md) ## AllResultsForVertical.resultsCount property diff --git a/docs/search-headless.answersconfig.md b/docs/search-headless.answersconfig.md new file mode 100644 index 00000000..3bfb92f3 --- /dev/null +++ b/docs/search-headless.answersconfig.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [AnswersConfig](./search-headless.answersconfig.md) + +## AnswersConfig type + +The main configuration options for [AnswersCore](./search-headless.answerscore.md). For a full description of the options, see [BaseAnswersConfig](./search-headless.baseanswersconfig.md). The config requires either an apiKey or a token. + +Signature: + +```typescript +export declare type AnswersConfig = AnswersConfigWithApiKey | AnswersConfigWithToken; +``` +References: [AnswersConfigWithApiKey](./search-headless.answersconfigwithapikey.md), [AnswersConfigWithToken](./search-headless.answersconfigwithtoken.md) + diff --git a/docs/answers-headless.answersconfigwithapikey.apikey.md b/docs/search-headless.answersconfigwithapikey.apikey.md similarity index 52% rename from docs/answers-headless.answersconfigwithapikey.apikey.md rename to docs/search-headless.answersconfigwithapikey.apikey.md index cf4cc6e9..72c66e34 100644 --- a/docs/answers-headless.answersconfigwithapikey.apikey.md +++ b/docs/search-headless.answersconfigwithapikey.apikey.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [AnswersConfigWithApiKey](./answers-headless.answersconfigwithapikey.md) > [apiKey](./answers-headless.answersconfigwithapikey.apikey.md) +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [AnswersConfigWithApiKey](./search-headless.answersconfigwithapikey.md) > [apiKey](./search-headless.answersconfigwithapikey.apikey.md) ## AnswersConfigWithApiKey.apiKey property diff --git a/docs/search-headless.answersconfigwithapikey.md b/docs/search-headless.answersconfigwithapikey.md new file mode 100644 index 00000000..43cdeb09 --- /dev/null +++ b/docs/search-headless.answersconfigwithapikey.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [AnswersConfigWithApiKey](./search-headless.answersconfigwithapikey.md) + +## AnswersConfigWithApiKey interface + +Configuration options for [AnswersCore](./search-headless.answerscore.md), which includes the options from [BaseAnswersConfig](./search-headless.baseanswersconfig.md), but requires apiKey. + +Signature: + +```typescript +export declare interface AnswersConfigWithApiKey extends BaseAnswersConfig +``` +Extends: [BaseAnswersConfig](./search-headless.baseanswersconfig.md) + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [apiKey](./search-headless.answersconfigwithapikey.apikey.md) | string | The api key of the answers experience which will be sent as a query param. | +| [token?](./search-headless.answersconfigwithapikey.token.md) | never | (Optional) token should NOT be provided along with apiKey. | + diff --git a/docs/search-headless.answersconfigwithapikey.token.md b/docs/search-headless.answersconfigwithapikey.token.md new file mode 100644 index 00000000..ae39b2d4 --- /dev/null +++ b/docs/search-headless.answersconfigwithapikey.token.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [AnswersConfigWithApiKey](./search-headless.answersconfigwithapikey.md) > [token](./search-headless.answersconfigwithapikey.token.md) + +## AnswersConfigWithApiKey.token property + +token should NOT be provided along with apiKey. + +Signature: + +```typescript +token?: never; +``` diff --git a/docs/answers-headless.answersconfigwithtoken.apikey.md b/docs/search-headless.answersconfigwithtoken.apikey.md similarity index 50% rename from docs/answers-headless.answersconfigwithtoken.apikey.md rename to docs/search-headless.answersconfigwithtoken.apikey.md index 87a1cbdf..52ffa271 100644 --- a/docs/answers-headless.answersconfigwithtoken.apikey.md +++ b/docs/search-headless.answersconfigwithtoken.apikey.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [AnswersConfigWithToken](./answers-headless.answersconfigwithtoken.md) > [apiKey](./answers-headless.answersconfigwithtoken.apikey.md) +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [AnswersConfigWithToken](./search-headless.answersconfigwithtoken.md) > [apiKey](./search-headless.answersconfigwithtoken.apikey.md) ## AnswersConfigWithToken.apiKey property diff --git a/docs/search-headless.answersconfigwithtoken.md b/docs/search-headless.answersconfigwithtoken.md new file mode 100644 index 00000000..9aad9d5e --- /dev/null +++ b/docs/search-headless.answersconfigwithtoken.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [AnswersConfigWithToken](./search-headless.answersconfigwithtoken.md) + +## AnswersConfigWithToken interface + +Configuration options for [AnswersCore](./search-headless.answerscore.md), which includes the options from [BaseAnswersConfig](./search-headless.baseanswersconfig.md), but requires token. + +Signature: + +```typescript +export declare interface AnswersConfigWithToken extends BaseAnswersConfig +``` +Extends: [BaseAnswersConfig](./search-headless.baseanswersconfig.md) + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [apiKey?](./search-headless.answersconfigwithtoken.apikey.md) | never | (Optional) apiKey should NOT be provided along with token. | +| [token](./search-headless.answersconfigwithtoken.token.md) | string | The authentication token of the answers experience which will be passed in the Auth header as a Bearer token. | + diff --git a/docs/answers-headless.answersconfigwithtoken.token.md b/docs/search-headless.answersconfigwithtoken.token.md similarity index 56% rename from docs/answers-headless.answersconfigwithtoken.token.md rename to docs/search-headless.answersconfigwithtoken.token.md index 6e320f4a..50f34915 100644 --- a/docs/answers-headless.answersconfigwithtoken.token.md +++ b/docs/search-headless.answersconfigwithtoken.token.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [AnswersConfigWithToken](./answers-headless.answersconfigwithtoken.md) > [token](./answers-headless.answersconfigwithtoken.token.md) +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [AnswersConfigWithToken](./search-headless.answersconfigwithtoken.md) > [token](./search-headless.answersconfigwithtoken.token.md) ## AnswersConfigWithToken.token property diff --git a/docs/search-headless.answerscore._constructor_.md b/docs/search-headless.answerscore._constructor_.md new file mode 100644 index 00000000..29e9942a --- /dev/null +++ b/docs/search-headless.answerscore._constructor_.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [AnswersCore](./search-headless.answerscore.md) > [(constructor)](./search-headless.answerscore._constructor_.md) + +## AnswersCore.(constructor) + +Constructs a new instance of the `AnswersCore` class + +Signature: + +```typescript +constructor(searchService: SearchService, questionSubmissionService: QuestionSubmissionService, autoCompleteService: AutocompleteService); +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| searchService | [SearchService](./search-headless.searchservice.md) | | +| questionSubmissionService | [QuestionSubmissionService](./search-headless.questionsubmissionservice.md) | | +| autoCompleteService | [AutocompleteService](./search-headless.autocompleteservice.md) | | + diff --git a/docs/answers-headless.answerscore.filtersearch.md b/docs/search-headless.answerscore.filtersearch.md similarity index 63% rename from docs/answers-headless.answerscore.filtersearch.md rename to docs/search-headless.answerscore.filtersearch.md index 198a1c57..698ca48b 100644 --- a/docs/answers-headless.answerscore.filtersearch.md +++ b/docs/search-headless.answerscore.filtersearch.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [AnswersCore](./answers-headless.answerscore.md) > [filterSearch](./answers-headless.answerscore.filtersearch.md) +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [AnswersCore](./search-headless.answerscore.md) > [filterSearch](./search-headless.answerscore.filtersearch.md) ## AnswersCore.filterSearch() method @@ -16,15 +16,15 @@ filterSearch(request: FilterSearchRequest): Promise; | Parameter | Type | Description | | --- | --- | --- | -| request | [FilterSearchRequest](./answers-headless.filtersearchrequest.md) | filtersearch request options | +| request | [FilterSearchRequest](./search-headless.filtersearchrequest.md) | filtersearch request options | Returns: -Promise<[FilterSearchResponse](./answers-headless.filtersearchresponse.md)> +Promise<[FilterSearchResponse](./search-headless.filtersearchresponse.md)> ## Remarks -This differs from the vertical autocomplete because the vertical autocomplete operates on all entity fields whereas filtersearch operates only on specified fields. If rejected, the reason will be an [AnswersError](./answers-headless.answerserror.md). +This differs from the vertical autocomplete because the vertical autocomplete operates on all entity fields whereas filtersearch operates only on specified fields. If rejected, the reason will be an [AnswersError](./search-headless.answerserror.md). ## Example diff --git a/docs/search-headless.answerscore.md b/docs/search-headless.answerscore.md new file mode 100644 index 00000000..2ce43d0c --- /dev/null +++ b/docs/search-headless.answerscore.md @@ -0,0 +1,31 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [AnswersCore](./search-headless.answerscore.md) + +## AnswersCore class + +Provides methods for executing searches, submitting questions, and performing autocompletes. + +Signature: + +```typescript +export declare class AnswersCore +``` + +## Constructors + +| Constructor | Modifiers | Description | +| --- | --- | --- | +| [(constructor)(searchService, questionSubmissionService, autoCompleteService)](./search-headless.answerscore._constructor_.md) | | Constructs a new instance of the AnswersCore class | + +## Methods + +| Method | Modifiers | Description | +| --- | --- | --- | +| [filterSearch(request)](./search-headless.answerscore.filtersearch.md) | | Performs a filtersearch request against specified fields within a single vertical. | +| [submitQuestion(request)](./search-headless.answerscore.submitquestion.md) | | Submits a custom question to the Answers API. | +| [universalAutocomplete(request)](./search-headless.answerscore.universalautocomplete.md) | | Performs an autocomplete request across all verticals. | +| [universalSearch(request)](./search-headless.answerscore.universalsearch.md) | | Performs an Answers search across all verticals. | +| [verticalAutocomplete(request)](./search-headless.answerscore.verticalautocomplete.md) | | Performs an autocomplete request for a single vertical. | +| [verticalSearch(request)](./search-headless.answerscore.verticalsearch.md) | | Performs an Answers search for a single vertical. | + diff --git a/docs/search-headless.answerscore.submitquestion.md b/docs/search-headless.answerscore.submitquestion.md new file mode 100644 index 00000000..18baac8d --- /dev/null +++ b/docs/search-headless.answerscore.submitquestion.md @@ -0,0 +1,28 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [AnswersCore](./search-headless.answerscore.md) > [submitQuestion](./search-headless.answerscore.submitquestion.md) + +## AnswersCore.submitQuestion() method + +Submits a custom question to the Answers API. + +Signature: + +```typescript +submitQuestion(request: QuestionSubmissionRequest): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| request | [QuestionSubmissionRequest](./search-headless.questionsubmissionrequest.md) | Question submission request options | + +Returns: + +Promise<[QuestionSubmissionResponse](./search-headless.questionsubmissionresponse.md)> + +## Remarks + +If rejected, the reason will be an [AnswersError](./search-headless.answerserror.md). + diff --git a/docs/search-headless.answerscore.universalautocomplete.md b/docs/search-headless.answerscore.universalautocomplete.md new file mode 100644 index 00000000..b6bc7b82 --- /dev/null +++ b/docs/search-headless.answerscore.universalautocomplete.md @@ -0,0 +1,28 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [AnswersCore](./search-headless.answerscore.md) > [universalAutocomplete](./search-headless.answerscore.universalautocomplete.md) + +## AnswersCore.universalAutocomplete() method + +Performs an autocomplete request across all verticals. + +Signature: + +```typescript +universalAutocomplete(request: UniversalAutocompleteRequest): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| request | [UniversalAutocompleteRequest](./search-headless.universalautocompleterequest.md) | Universal autocomplete request options | + +Returns: + +Promise<[AutocompleteResponse](./search-headless.autocompleteresponse.md)> + +## Remarks + +If rejected, the reason will be an [AnswersError](./search-headless.answerserror.md). + diff --git a/docs/search-headless.answerscore.universalsearch.md b/docs/search-headless.answerscore.universalsearch.md new file mode 100644 index 00000000..5d5462f0 --- /dev/null +++ b/docs/search-headless.answerscore.universalsearch.md @@ -0,0 +1,28 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [AnswersCore](./search-headless.answerscore.md) > [universalSearch](./search-headless.answerscore.universalsearch.md) + +## AnswersCore.universalSearch() method + +Performs an Answers search across all verticals. + +Signature: + +```typescript +universalSearch(request: UniversalSearchRequest): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| request | [UniversalSearchRequest](./search-headless.universalsearchrequest.md) | Universal search request options | + +Returns: + +Promise<[UniversalSearchResponse](./search-headless.universalsearchresponse.md)> + +## Remarks + +If rejected, the reason will be an [AnswersError](./search-headless.answerserror.md). + diff --git a/docs/search-headless.answerscore.verticalautocomplete.md b/docs/search-headless.answerscore.verticalautocomplete.md new file mode 100644 index 00000000..987e3b1c --- /dev/null +++ b/docs/search-headless.answerscore.verticalautocomplete.md @@ -0,0 +1,28 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [AnswersCore](./search-headless.answerscore.md) > [verticalAutocomplete](./search-headless.answerscore.verticalautocomplete.md) + +## AnswersCore.verticalAutocomplete() method + +Performs an autocomplete request for a single vertical. + +Signature: + +```typescript +verticalAutocomplete(request: VerticalAutocompleteRequest): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| request | [VerticalAutocompleteRequest](./search-headless.verticalautocompleterequest.md) | Vertical autocomplete request options | + +Returns: + +Promise<[AutocompleteResponse](./search-headless.autocompleteresponse.md)> + +## Remarks + +If rejected, the reason will be an [AnswersError](./search-headless.answerserror.md). + diff --git a/docs/search-headless.answerscore.verticalsearch.md b/docs/search-headless.answerscore.verticalsearch.md new file mode 100644 index 00000000..b427cb82 --- /dev/null +++ b/docs/search-headless.answerscore.verticalsearch.md @@ -0,0 +1,28 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [AnswersCore](./search-headless.answerscore.md) > [verticalSearch](./search-headless.answerscore.verticalsearch.md) + +## AnswersCore.verticalSearch() method + +Performs an Answers search for a single vertical. + +Signature: + +```typescript +verticalSearch(request: VerticalSearchRequest): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| request | [VerticalSearchRequest](./search-headless.verticalsearchrequest.md) | Vertical search request options | + +Returns: + +Promise<[VerticalSearchResponse](./search-headless.verticalsearchresponse.md)> + +## Remarks + +If rejected, the reason will be an [AnswersError](./search-headless.answerserror.md). + diff --git a/docs/search-headless.answerserror.code.md b/docs/search-headless.answerserror.code.md new file mode 100644 index 00000000..27bee863 --- /dev/null +++ b/docs/search-headless.answerserror.code.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [AnswersError](./search-headless.answerserror.md) > [code](./search-headless.answerserror.code.md) + +## AnswersError.code property + +Answers API error code. + +Signature: + +```typescript +code?: number; +``` diff --git a/docs/search-headless.answerserror.md b/docs/search-headless.answerserror.md new file mode 100644 index 00000000..7f847a46 --- /dev/null +++ b/docs/search-headless.answerserror.md @@ -0,0 +1,27 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [AnswersError](./search-headless.answerserror.md) + +## AnswersError class + +Represents an error + +Signature: + +```typescript +export declare class AnswersError extends Error +``` +Extends: Error + +## Remarks + +If the error originates from the Answer API, the code and type property will be present. + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [code?](./search-headless.answerserror.code.md) | | number | (Optional) Answers API error code. | +| [message](./search-headless.answerserror.message.md) | | string | The error message. | +| [type?](./search-headless.answerserror.type.md) | | string | (Optional) Answers API error type. | + diff --git a/docs/search-headless.answerserror.message.md b/docs/search-headless.answerserror.message.md new file mode 100644 index 00000000..7e29f286 --- /dev/null +++ b/docs/search-headless.answerserror.message.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [AnswersError](./search-headless.answerserror.md) > [message](./search-headless.answerserror.message.md) + +## AnswersError.message property + +The error message. + +Signature: + +```typescript +message: string; +``` diff --git a/docs/search-headless.answerserror.type.md b/docs/search-headless.answerserror.type.md new file mode 100644 index 00000000..d1d03584 --- /dev/null +++ b/docs/search-headless.answerserror.type.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [AnswersError](./search-headless.answerserror.md) > [type](./search-headless.answerserror.type.md) + +## AnswersError.type property + +Answers API error type. + +Signature: + +```typescript +type?: string; +``` diff --git a/docs/search-headless.answersheadless.md b/docs/search-headless.answersheadless.md new file mode 100644 index 00000000..69138d78 --- /dev/null +++ b/docs/search-headless.answersheadless.md @@ -0,0 +1,16 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [AnswersHeadless](./search-headless.answersheadless.md) + +## AnswersHeadless variable + +> Warning: This API is now obsolete. +> +> AnswersHeadless has been deprecated and renamed to SearchHeadless +> + +Signature: + +```typescript +AnswersHeadless: typeof SearchHeadless +``` diff --git a/docs/answers-headless.answersrequest.additionalhttpheaders.md b/docs/search-headless.answersrequest.additionalhttpheaders.md similarity index 56% rename from docs/answers-headless.answersrequest.additionalhttpheaders.md rename to docs/search-headless.answersrequest.additionalhttpheaders.md index 22b47f37..7b57cc90 100644 --- a/docs/answers-headless.answersrequest.additionalhttpheaders.md +++ b/docs/search-headless.answersrequest.additionalhttpheaders.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [AnswersRequest](./answers-headless.answersrequest.md) > [additionalHttpHeaders](./answers-headless.answersrequest.additionalhttpheaders.md) +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [AnswersRequest](./search-headless.answersrequest.md) > [additionalHttpHeaders](./search-headless.answersrequest.additionalhttpheaders.md) ## AnswersRequest.additionalHttpHeaders property diff --git a/docs/search-headless.answersrequest.md b/docs/search-headless.answersrequest.md new file mode 100644 index 00000000..45cfc5d3 --- /dev/null +++ b/docs/search-headless.answersrequest.md @@ -0,0 +1,20 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [AnswersRequest](./search-headless.answersrequest.md) + +## AnswersRequest interface + +Options for an Answers API request. + +Signature: + +```typescript +export declare interface AnswersRequest +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [additionalHttpHeaders?](./search-headless.answersrequest.additionalhttpheaders.md) | [AdditionalHttpHeaders](./search-headless.additionalhttpheaders.md) | (Optional) AdditionalHttpHeaders allows users to specify additional values for specific HTTP headers. | + diff --git a/docs/search-headless.answersutilities.md b/docs/search-headless.answersutilities.md new file mode 100644 index 00000000..3042e331 --- /dev/null +++ b/docs/search-headless.answersutilities.md @@ -0,0 +1,16 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [answersUtilities](./search-headless.answersutilities.md) + +## answersUtilities variable + +> Warning: This API is now obsolete. +> +> answersUtilities has been deprecated and renamed to searchUtilities +> + +Signature: + +```typescript +answersUtilities: typeof searchUtilities +``` diff --git a/docs/search-headless.appliedqueryfilter.details.md b/docs/search-headless.appliedqueryfilter.details.md new file mode 100644 index 00000000..67a43fa2 --- /dev/null +++ b/docs/search-headless.appliedqueryfilter.details.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [AppliedQueryFilter](./search-headless.appliedqueryfilter.md) > [details](./search-headless.appliedqueryfilter.details.md) + +## AppliedQueryFilter.details property + +Additional details relevant to the filter with "PLACE" for its [AppliedQueryFilterType](./search-headless.appliedqueryfiltertype.md). + +Signature: + +```typescript +details?: LocationFilterDetails; +``` diff --git a/docs/answers-headless.appliedqueryfilter.displaykey.md b/docs/search-headless.appliedqueryfilter.displaykey.md similarity index 52% rename from docs/answers-headless.appliedqueryfilter.displaykey.md rename to docs/search-headless.appliedqueryfilter.displaykey.md index ff75341e..120db803 100644 --- a/docs/answers-headless.appliedqueryfilter.displaykey.md +++ b/docs/search-headless.appliedqueryfilter.displaykey.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [AppliedQueryFilter](./answers-headless.appliedqueryfilter.md) > [displayKey](./answers-headless.appliedqueryfilter.displaykey.md) +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [AppliedQueryFilter](./search-headless.appliedqueryfilter.md) > [displayKey](./search-headless.appliedqueryfilter.displaykey.md) ## AppliedQueryFilter.displayKey property diff --git a/docs/answers-headless.appliedqueryfilter.displayvalue.md b/docs/search-headless.appliedqueryfilter.displayvalue.md similarity index 50% rename from docs/answers-headless.appliedqueryfilter.displayvalue.md rename to docs/search-headless.appliedqueryfilter.displayvalue.md index 31532c2e..c1d50b90 100644 --- a/docs/answers-headless.appliedqueryfilter.displayvalue.md +++ b/docs/search-headless.appliedqueryfilter.displayvalue.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [AppliedQueryFilter](./answers-headless.appliedqueryfilter.md) > [displayValue](./answers-headless.appliedqueryfilter.displayvalue.md) +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [AppliedQueryFilter](./search-headless.appliedqueryfilter.md) > [displayValue](./search-headless.appliedqueryfilter.displayvalue.md) ## AppliedQueryFilter.displayValue property diff --git a/docs/answers-headless.appliedqueryfilter.filter.md b/docs/search-headless.appliedqueryfilter.filter.md similarity index 50% rename from docs/answers-headless.appliedqueryfilter.filter.md rename to docs/search-headless.appliedqueryfilter.filter.md index e77a07c4..a0d7476f 100644 --- a/docs/answers-headless.appliedqueryfilter.filter.md +++ b/docs/search-headless.appliedqueryfilter.filter.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [AppliedQueryFilter](./answers-headless.appliedqueryfilter.md) > [filter](./answers-headless.appliedqueryfilter.filter.md) +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [AppliedQueryFilter](./search-headless.appliedqueryfilter.md) > [filter](./search-headless.appliedqueryfilter.filter.md) ## AppliedQueryFilter.filter property diff --git a/docs/search-headless.appliedqueryfilter.md b/docs/search-headless.appliedqueryfilter.md new file mode 100644 index 00000000..0f30bd66 --- /dev/null +++ b/docs/search-headless.appliedqueryfilter.md @@ -0,0 +1,24 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [AppliedQueryFilter](./search-headless.appliedqueryfilter.md) + +## AppliedQueryFilter interface + +A filter that the Answers API applied to the search. + +Signature: + +```typescript +export declare interface AppliedQueryFilter +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [details?](./search-headless.appliedqueryfilter.details.md) | [LocationFilterDetails](./search-headless.locationfilterdetails.md) | (Optional) Additional details relevant to the filter with "PLACE" for its [AppliedQueryFilterType](./search-headless.appliedqueryfiltertype.md). | +| [displayKey](./search-headless.appliedqueryfilter.displaykey.md) | string | The display name of the filter key. | +| [displayValue](./search-headless.appliedqueryfilter.displayvalue.md) | string | The value used in the filter. | +| [filter](./search-headless.appliedqueryfilter.filter.md) | [Filter](./search-headless.filter.md) | The filter applied to the query results. | +| [type](./search-headless.appliedqueryfilter.type.md) | [AppliedQueryFilterType](./search-headless.appliedqueryfiltertype.md) | Represents the type of [AppliedQueryFilter](./search-headless.appliedqueryfilter.md) applied to a search. | + diff --git a/docs/search-headless.appliedqueryfilter.type.md b/docs/search-headless.appliedqueryfilter.type.md new file mode 100644 index 00000000..f02a68ba --- /dev/null +++ b/docs/search-headless.appliedqueryfilter.type.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [AppliedQueryFilter](./search-headless.appliedqueryfilter.md) > [type](./search-headless.appliedqueryfilter.type.md) + +## AppliedQueryFilter.type property + +Represents the type of [AppliedQueryFilter](./search-headless.appliedqueryfilter.md) applied to a search. + +Signature: + +```typescript +type: AppliedQueryFilterType; +``` diff --git a/docs/answers-headless.appliedqueryfiltertype.md b/docs/search-headless.appliedqueryfiltertype.md similarity index 69% rename from docs/answers-headless.appliedqueryfiltertype.md rename to docs/search-headless.appliedqueryfiltertype.md index 84431f55..828ec099 100644 --- a/docs/answers-headless.appliedqueryfiltertype.md +++ b/docs/search-headless.appliedqueryfiltertype.md @@ -1,10 +1,10 @@ -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [AppliedQueryFilterType](./answers-headless.appliedqueryfiltertype.md) +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [AppliedQueryFilterType](./search-headless.appliedqueryfiltertype.md) ## AppliedQueryFilterType enum -Represents the type of [AppliedQueryFilter](./answers-headless.appliedqueryfilter.md) applied to a search. +Represents the type of [AppliedQueryFilter](./search-headless.appliedqueryfilter.md) applied to a search. Signature: diff --git a/docs/answers-headless.autocompleteresponse.inputintents.md b/docs/search-headless.autocompleteresponse.inputintents.md similarity index 50% rename from docs/answers-headless.autocompleteresponse.inputintents.md rename to docs/search-headless.autocompleteresponse.inputintents.md index a0f52aa7..ebb3cca2 100644 --- a/docs/answers-headless.autocompleteresponse.inputintents.md +++ b/docs/search-headless.autocompleteresponse.inputintents.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [AutocompleteResponse](./answers-headless.autocompleteresponse.md) > [inputIntents](./answers-headless.autocompleteresponse.inputintents.md) +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [AutocompleteResponse](./search-headless.autocompleteresponse.md) > [inputIntents](./search-headless.autocompleteresponse.inputintents.md) ## AutocompleteResponse.inputIntents property diff --git a/docs/search-headless.autocompleteresponse.md b/docs/search-headless.autocompleteresponse.md new file mode 100644 index 00000000..60ee61e5 --- /dev/null +++ b/docs/search-headless.autocompleteresponse.md @@ -0,0 +1,23 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [AutocompleteResponse](./search-headless.autocompleteresponse.md) + +## AutocompleteResponse interface + +The response of a universal or vertical autocomplete request. + +Signature: + +```typescript +export declare interface AutocompleteResponse +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [inputIntents](./search-headless.autocompleteresponse.inputintents.md) | [SearchIntent](./search-headless.searchintent.md)\[\] | Represents intents from the Answers API. | +| [queryId?](./search-headless.autocompleteresponse.queryid.md) | string | (Optional) The ID of the search query. | +| [results](./search-headless.autocompleteresponse.results.md) | [AutocompleteResult](./search-headless.autocompleteresult.md)\[\] | An array of [AutocompleteResult](./search-headless.autocompleteresult.md)s. | +| [uuid](./search-headless.autocompleteresponse.uuid.md) | string | A unique id which corresponds to the request. | + diff --git a/docs/search-headless.autocompleteresponse.queryid.md b/docs/search-headless.autocompleteresponse.queryid.md new file mode 100644 index 00000000..d795df76 --- /dev/null +++ b/docs/search-headless.autocompleteresponse.queryid.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [AutocompleteResponse](./search-headless.autocompleteresponse.md) > [queryId](./search-headless.autocompleteresponse.queryid.md) + +## AutocompleteResponse.queryId property + +The ID of the search query. + +Signature: + +```typescript +queryId?: string; +``` diff --git a/docs/search-headless.autocompleteresponse.results.md b/docs/search-headless.autocompleteresponse.results.md new file mode 100644 index 00000000..49f86279 --- /dev/null +++ b/docs/search-headless.autocompleteresponse.results.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [AutocompleteResponse](./search-headless.autocompleteresponse.md) > [results](./search-headless.autocompleteresponse.results.md) + +## AutocompleteResponse.results property + +An array of [AutocompleteResult](./search-headless.autocompleteresult.md)s. + +Signature: + +```typescript +results: AutocompleteResult[]; +``` diff --git a/docs/answers-headless.autocompleteresponse.uuid.md b/docs/search-headless.autocompleteresponse.uuid.md similarity index 50% rename from docs/answers-headless.autocompleteresponse.uuid.md rename to docs/search-headless.autocompleteresponse.uuid.md index c8ac8c6d..8a827108 100644 --- a/docs/answers-headless.autocompleteresponse.uuid.md +++ b/docs/search-headless.autocompleteresponse.uuid.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [AutocompleteResponse](./answers-headless.autocompleteresponse.md) > [uuid](./answers-headless.autocompleteresponse.uuid.md) +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [AutocompleteResponse](./search-headless.autocompleteresponse.md) > [uuid](./search-headless.autocompleteresponse.uuid.md) ## AutocompleteResponse.uuid property diff --git a/docs/answers-headless.autocompleteresult.filter.md b/docs/search-headless.autocompleteresult.filter.md similarity index 56% rename from docs/answers-headless.autocompleteresult.filter.md rename to docs/search-headless.autocompleteresult.filter.md index bf7bb5bc..aecad50b 100644 --- a/docs/answers-headless.autocompleteresult.filter.md +++ b/docs/search-headless.autocompleteresult.filter.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [AutocompleteResult](./answers-headless.autocompleteresult.md) > [filter](./answers-headless.autocompleteresult.filter.md) +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [AutocompleteResult](./search-headless.autocompleteresult.md) > [filter](./search-headless.autocompleteresult.filter.md) ## AutocompleteResult.filter property diff --git a/docs/answers-headless.autocompleteresult.key.md b/docs/search-headless.autocompleteresult.key.md similarity index 57% rename from docs/answers-headless.autocompleteresult.key.md rename to docs/search-headless.autocompleteresult.key.md index 7c56892a..c566260b 100644 --- a/docs/answers-headless.autocompleteresult.key.md +++ b/docs/search-headless.autocompleteresult.key.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [AutocompleteResult](./answers-headless.autocompleteresult.md) > [key](./answers-headless.autocompleteresult.key.md) +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [AutocompleteResult](./search-headless.autocompleteresult.md) > [key](./search-headless.autocompleteresult.key.md) ## AutocompleteResult.key property diff --git a/docs/answers-headless.autocompleteresult.matchedsubstrings.md b/docs/search-headless.autocompleteresult.matchedsubstrings.md similarity index 63% rename from docs/answers-headless.autocompleteresult.matchedsubstrings.md rename to docs/search-headless.autocompleteresult.matchedsubstrings.md index 9e829a67..18d22f60 100644 --- a/docs/answers-headless.autocompleteresult.matchedsubstrings.md +++ b/docs/search-headless.autocompleteresult.matchedsubstrings.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [AutocompleteResult](./answers-headless.autocompleteresult.md) > [matchedSubstrings](./answers-headless.autocompleteresult.matchedsubstrings.md) +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [AutocompleteResult](./search-headless.autocompleteresult.md) > [matchedSubstrings](./search-headless.autocompleteresult.matchedsubstrings.md) ## AutocompleteResult.matchedSubstrings property diff --git a/docs/search-headless.autocompleteresult.md b/docs/search-headless.autocompleteresult.md new file mode 100644 index 00000000..1ed9bde0 --- /dev/null +++ b/docs/search-headless.autocompleteresult.md @@ -0,0 +1,25 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [AutocompleteResult](./search-headless.autocompleteresult.md) + +## AutocompleteResult interface + +An autocomplete suggestion. + +Signature: + +```typescript +export declare interface AutocompleteResult +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [filter?](./search-headless.autocompleteresult.filter.md) | [Filter](./search-headless.filter.md) | (Optional) A filter applied to the autocomplete response. | +| [key?](./search-headless.autocompleteresult.key.md) | string | (Optional) The fieldId which corresponds to the AutocompleteResult value. | +| [matchedSubstrings?](./search-headless.autocompleteresult.matchedsubstrings.md) | { length: number; offset: number; }\[\] | (Optional) An array of substrings which overlap with the autocomplete input. | +| [relatedItem?](./search-headless.autocompleteresult.relateditem.md) | [Result](./search-headless.result.md) | (Optional) An entity that corresponds to the autocomplete result. | +| [value](./search-headless.autocompleteresult.value.md) | string | The value of an autocomplete suggestion. | +| [verticalKeys?](./search-headless.autocompleteresult.verticalkeys.md) | string\[\] | (Optional) Any vertical keys associated with a prompt. This only shows up on universal autocomplete requests. | + diff --git a/docs/search-headless.autocompleteresult.relateditem.md b/docs/search-headless.autocompleteresult.relateditem.md new file mode 100644 index 00000000..223129fd --- /dev/null +++ b/docs/search-headless.autocompleteresult.relateditem.md @@ -0,0 +1,18 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [AutocompleteResult](./search-headless.autocompleteresult.md) > [relatedItem](./search-headless.autocompleteresult.relateditem.md) + +## AutocompleteResult.relatedItem property + +An entity that corresponds to the autocomplete result. + +Signature: + +```typescript +relatedItem?: Result; +``` + +## Remarks + +This property is only defined if the corresponding [SearchParameterField.fetchEntities](./search-headless.searchparameterfield.fetchentities.md) field is true. + diff --git a/docs/answers-headless.autocompleteresult.value.md b/docs/search-headless.autocompleteresult.value.md similarity index 50% rename from docs/answers-headless.autocompleteresult.value.md rename to docs/search-headless.autocompleteresult.value.md index d8fc49bc..0843df77 100644 --- a/docs/answers-headless.autocompleteresult.value.md +++ b/docs/search-headless.autocompleteresult.value.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [AutocompleteResult](./answers-headless.autocompleteresult.md) > [value](./answers-headless.autocompleteresult.value.md) +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [AutocompleteResult](./search-headless.autocompleteresult.md) > [value](./search-headless.autocompleteresult.value.md) ## AutocompleteResult.value property diff --git a/docs/answers-headless.autocompleteresult.verticalkeys.md b/docs/search-headless.autocompleteresult.verticalkeys.md similarity index 55% rename from docs/answers-headless.autocompleteresult.verticalkeys.md rename to docs/search-headless.autocompleteresult.verticalkeys.md index 9f89cb1f..c6d967a6 100644 --- a/docs/answers-headless.autocompleteresult.verticalkeys.md +++ b/docs/search-headless.autocompleteresult.verticalkeys.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [AutocompleteResult](./answers-headless.autocompleteresult.md) > [verticalKeys](./answers-headless.autocompleteresult.verticalkeys.md) +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [AutocompleteResult](./search-headless.autocompleteresult.md) > [verticalKeys](./search-headless.autocompleteresult.verticalkeys.md) ## AutocompleteResult.verticalKeys property diff --git a/docs/search-headless.autocompleteservice.filtersearch.md b/docs/search-headless.autocompleteservice.filtersearch.md new file mode 100644 index 00000000..4dc72345 --- /dev/null +++ b/docs/search-headless.autocompleteservice.filtersearch.md @@ -0,0 +1,24 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [AutocompleteService](./search-headless.autocompleteservice.md) > [filterSearch](./search-headless.autocompleteservice.filtersearch.md) + +## AutocompleteService.filterSearch() method + +Retrieves query suggestions for filter search. + +Signature: + +```typescript +filterSearch(request: FilterSearchRequest): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| request | [FilterSearchRequest](./search-headless.filtersearchrequest.md) | | + +Returns: + +Promise<[FilterSearchResponse](./search-headless.filtersearchresponse.md)> + diff --git a/docs/search-headless.autocompleteservice.md b/docs/search-headless.autocompleteservice.md new file mode 100644 index 00000000..6c5825ed --- /dev/null +++ b/docs/search-headless.autocompleteservice.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [AutocompleteService](./search-headless.autocompleteservice.md) + +## AutocompleteService interface + +A service for autocomplete requests. + +Signature: + +```typescript +export declare interface AutocompleteService +``` + +## Methods + +| Method | Description | +| --- | --- | +| [filterSearch(request)](./search-headless.autocompleteservice.filtersearch.md) | Retrieves query suggestions for filter search. | +| [universalAutocomplete(request)](./search-headless.autocompleteservice.universalautocomplete.md) | Retrieves query suggestions for universal. | +| [verticalAutocomplete(request)](./search-headless.autocompleteservice.verticalautocomplete.md) | Retrieves query suggestions for a vertical. | + diff --git a/docs/search-headless.autocompleteservice.universalautocomplete.md b/docs/search-headless.autocompleteservice.universalautocomplete.md new file mode 100644 index 00000000..44e0fcc6 --- /dev/null +++ b/docs/search-headless.autocompleteservice.universalautocomplete.md @@ -0,0 +1,24 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [AutocompleteService](./search-headless.autocompleteservice.md) > [universalAutocomplete](./search-headless.autocompleteservice.universalautocomplete.md) + +## AutocompleteService.universalAutocomplete() method + +Retrieves query suggestions for universal. + +Signature: + +```typescript +universalAutocomplete(request: UniversalAutocompleteRequest): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| request | [UniversalAutocompleteRequest](./search-headless.universalautocompleterequest.md) | | + +Returns: + +Promise<[AutocompleteResponse](./search-headless.autocompleteresponse.md)> + diff --git a/docs/search-headless.autocompleteservice.verticalautocomplete.md b/docs/search-headless.autocompleteservice.verticalautocomplete.md new file mode 100644 index 00000000..21f1b115 --- /dev/null +++ b/docs/search-headless.autocompleteservice.verticalautocomplete.md @@ -0,0 +1,24 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [AutocompleteService](./search-headless.autocompleteservice.md) > [verticalAutocomplete](./search-headless.autocompleteservice.verticalautocomplete.md) + +## AutocompleteService.verticalAutocomplete() method + +Retrieves query suggestions for a vertical. + +Signature: + +```typescript +verticalAutocomplete(request: VerticalAutocompleteRequest): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| request | [VerticalAutocompleteRequest](./search-headless.verticalautocompleterequest.md) | | + +Returns: + +Promise<[AutocompleteResponse](./search-headless.autocompleteresponse.md)> + diff --git a/docs/answers-headless.baseanswersconfig.endpoints.md b/docs/search-headless.baseanswersconfig.endpoints.md similarity index 54% rename from docs/answers-headless.baseanswersconfig.endpoints.md rename to docs/search-headless.baseanswersconfig.endpoints.md index 49f1c895..be9ad45d 100644 --- a/docs/answers-headless.baseanswersconfig.endpoints.md +++ b/docs/search-headless.baseanswersconfig.endpoints.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [BaseAnswersConfig](./answers-headless.baseanswersconfig.md) > [endpoints](./answers-headless.baseanswersconfig.endpoints.md) +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [BaseAnswersConfig](./search-headless.baseanswersconfig.md) > [endpoints](./search-headless.baseanswersconfig.endpoints.md) ## BaseAnswersConfig.endpoints property diff --git a/docs/answers-headless.baseanswersconfig.experiencekey.md b/docs/search-headless.baseanswersconfig.experiencekey.md similarity index 50% rename from docs/answers-headless.baseanswersconfig.experiencekey.md rename to docs/search-headless.baseanswersconfig.experiencekey.md index 4085b1e9..5ef58900 100644 --- a/docs/answers-headless.baseanswersconfig.experiencekey.md +++ b/docs/search-headless.baseanswersconfig.experiencekey.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [BaseAnswersConfig](./answers-headless.baseanswersconfig.md) > [experienceKey](./answers-headless.baseanswersconfig.experiencekey.md) +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [BaseAnswersConfig](./search-headless.baseanswersconfig.md) > [experienceKey](./search-headless.baseanswersconfig.experiencekey.md) ## BaseAnswersConfig.experienceKey property diff --git a/docs/answers-headless.baseanswersconfig.experienceversion.md b/docs/search-headless.baseanswersconfig.experienceversion.md similarity index 63% rename from docs/answers-headless.baseanswersconfig.experienceversion.md rename to docs/search-headless.baseanswersconfig.experienceversion.md index 0b7abf9a..8e4f294c 100644 --- a/docs/answers-headless.baseanswersconfig.experienceversion.md +++ b/docs/search-headless.baseanswersconfig.experienceversion.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [BaseAnswersConfig](./answers-headless.baseanswersconfig.md) > [experienceVersion](./answers-headless.baseanswersconfig.experienceversion.md) +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [BaseAnswersConfig](./search-headless.baseanswersconfig.md) > [experienceVersion](./search-headless.baseanswersconfig.experienceversion.md) ## BaseAnswersConfig.experienceVersion property diff --git a/docs/answers-headless.baseanswersconfig.locale.md b/docs/search-headless.baseanswersconfig.locale.md similarity index 50% rename from docs/answers-headless.baseanswersconfig.locale.md rename to docs/search-headless.baseanswersconfig.locale.md index 568549b1..4078a994 100644 --- a/docs/answers-headless.baseanswersconfig.locale.md +++ b/docs/search-headless.baseanswersconfig.locale.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [BaseAnswersConfig](./answers-headless.baseanswersconfig.md) > [locale](./answers-headless.baseanswersconfig.locale.md) +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [BaseAnswersConfig](./search-headless.baseanswersconfig.md) > [locale](./search-headless.baseanswersconfig.locale.md) ## BaseAnswersConfig.locale property diff --git a/docs/search-headless.baseanswersconfig.md b/docs/search-headless.baseanswersconfig.md new file mode 100644 index 00000000..febb96a9 --- /dev/null +++ b/docs/search-headless.baseanswersconfig.md @@ -0,0 +1,24 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [BaseAnswersConfig](./search-headless.baseanswersconfig.md) + +## BaseAnswersConfig interface + +The base configuration options for [AnswersCore](./search-headless.answerscore.md). + +Signature: + +```typescript +export declare interface BaseAnswersConfig +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [endpoints?](./search-headless.baseanswersconfig.endpoints.md) | [Endpoints](./search-headless.endpoints.md) | (Optional) Overrides for the URLs which are used when making requests to the Answers API. | +| [experienceKey](./search-headless.baseanswersconfig.experiencekey.md) | string | The experience key of the answers experience. | +| [experienceVersion?](./search-headless.baseanswersconfig.experienceversion.md) | 'STAGING' \| 'PRODUCTION' \| string \| number | (Optional) The version of the answers experience configuration. | +| [locale](./search-headless.baseanswersconfig.locale.md) | string | The locale of the answers experience. | +| [visitor?](./search-headless.baseanswersconfig.visitor.md) | [Visitor](./search-headless.visitor.md) | (Optional) Information used to associate requests with a particular user. | + diff --git a/docs/answers-headless.baseanswersconfig.visitor.md b/docs/search-headless.baseanswersconfig.visitor.md similarity index 62% rename from docs/answers-headless.baseanswersconfig.visitor.md rename to docs/search-headless.baseanswersconfig.visitor.md index 949695ba..055b50ff 100644 --- a/docs/answers-headless.baseanswersconfig.visitor.md +++ b/docs/search-headless.baseanswersconfig.visitor.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [BaseAnswersConfig](./answers-headless.baseanswersconfig.md) > [visitor](./answers-headless.baseanswersconfig.visitor.md) +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [BaseAnswersConfig](./search-headless.baseanswersconfig.md) > [visitor](./search-headless.baseanswersconfig.visitor.md) ## BaseAnswersConfig.visitor property diff --git a/docs/answers-headless.boundedrange.max.md b/docs/search-headless.boundedrange.max.md similarity index 52% rename from docs/answers-headless.boundedrange.max.md rename to docs/search-headless.boundedrange.max.md index d3378c23..55ad5f25 100644 --- a/docs/answers-headless.boundedrange.max.md +++ b/docs/search-headless.boundedrange.max.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [BoundedRange](./answers-headless.boundedrange.md) > [max](./answers-headless.boundedrange.max.md) +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [BoundedRange](./search-headless.boundedrange.md) > [max](./search-headless.boundedrange.max.md) ## BoundedRange.max property diff --git a/docs/search-headless.boundedrange.md b/docs/search-headless.boundedrange.md new file mode 100644 index 00000000..1217df6b --- /dev/null +++ b/docs/search-headless.boundedrange.md @@ -0,0 +1,21 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [BoundedRange](./search-headless.boundedrange.md) + +## BoundedRange interface + +An interface representing a range of values of type T. + +Signature: + +```typescript +export interface BoundedRange +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [max?](./search-headless.boundedrange.max.md) | [RangeBoundary](./search-headless.rangeboundary.md)<T> | (Optional) The maximum value bounding the range. | +| [min?](./search-headless.boundedrange.min.md) | [RangeBoundary](./search-headless.rangeboundary.md)<T> | (Optional) The minimum value bounding the range. | + diff --git a/docs/answers-headless.boundedrange.min.md b/docs/search-headless.boundedrange.min.md similarity index 52% rename from docs/answers-headless.boundedrange.min.md rename to docs/search-headless.boundedrange.min.md index f8f46563..7acd0cc8 100644 --- a/docs/answers-headless.boundedrange.min.md +++ b/docs/search-headless.boundedrange.min.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [BoundedRange](./answers-headless.boundedrange.md) > [min](./answers-headless.boundedrange.min.md) +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [BoundedRange](./search-headless.boundedrange.md) > [min](./search-headless.boundedrange.min.md) ## BoundedRange.min property diff --git a/docs/answers-headless.clientsdkheadervalues.answers_core.md b/docs/search-headless.clientsdkheadervalues.answers_core.md similarity index 59% rename from docs/answers-headless.clientsdkheadervalues.answers_core.md rename to docs/search-headless.clientsdkheadervalues.answers_core.md index 34ff64d0..27564cea 100644 --- a/docs/answers-headless.clientsdkheadervalues.answers_core.md +++ b/docs/search-headless.clientsdkheadervalues.answers_core.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [ClientSDKHeaderValues](./answers-headless.clientsdkheadervalues.md) > [ANSWERS\_CORE](./answers-headless.clientsdkheadervalues.answers_core.md) +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [ClientSDKHeaderValues](./search-headless.clientsdkheadervalues.md) > [ANSWERS\_CORE](./search-headless.clientsdkheadervalues.answers_core.md) ## ClientSDKHeaderValues.ANSWERS\_CORE property diff --git a/docs/answers-headless.clientsdkheadervalues.md b/docs/search-headless.clientsdkheadervalues.md similarity index 51% rename from docs/answers-headless.clientsdkheadervalues.md rename to docs/search-headless.clientsdkheadervalues.md index 456b085f..f9471afb 100644 --- a/docs/answers-headless.clientsdkheadervalues.md +++ b/docs/search-headless.clientsdkheadervalues.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [ClientSDKHeaderValues](./answers-headless.clientsdkheadervalues.md) +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [ClientSDKHeaderValues](./search-headless.clientsdkheadervalues.md) ## ClientSDKHeaderValues interface @@ -16,5 +16,5 @@ export declare interface ClientSDKHeaderValues | Property | Type | Description | | --- | --- | --- | -| [ANSWERS\_CORE?](./answers-headless.clientsdkheadervalues.answers_core.md) | never | (Optional) The ANSWERS\_CORE agent should not be supplied. Instead, it will be automatically added to the header and populated with the version of Answers Core being used. | +| [ANSWERS\_CORE?](./search-headless.clientsdkheadervalues.answers_core.md) | never | (Optional) The ANSWERS\_CORE agent should not be supplied. Instead, it will be automatically added to the header and populated with the version of Answers Core being used. | diff --git a/docs/answers-headless.combinedfilter.combinator.md b/docs/search-headless.combinedfilter.combinator.md similarity index 53% rename from docs/answers-headless.combinedfilter.combinator.md rename to docs/search-headless.combinedfilter.combinator.md index 33107e37..94b506c9 100644 --- a/docs/answers-headless.combinedfilter.combinator.md +++ b/docs/search-headless.combinedfilter.combinator.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [CombinedFilter](./answers-headless.combinedfilter.md) > [combinator](./answers-headless.combinedfilter.combinator.md) +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [CombinedFilter](./search-headless.combinedfilter.md) > [combinator](./search-headless.combinedfilter.combinator.md) ## CombinedFilter.combinator property diff --git a/docs/answers-headless.combinedfilter.filters.md b/docs/search-headless.combinedfilter.filters.md similarity index 53% rename from docs/answers-headless.combinedfilter.filters.md rename to docs/search-headless.combinedfilter.filters.md index 355467b9..4c5137de 100644 --- a/docs/answers-headless.combinedfilter.filters.md +++ b/docs/search-headless.combinedfilter.filters.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [CombinedFilter](./answers-headless.combinedfilter.md) > [filters](./answers-headless.combinedfilter.filters.md) +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [CombinedFilter](./search-headless.combinedfilter.md) > [filters](./search-headless.combinedfilter.filters.md) ## CombinedFilter.filters property diff --git a/docs/search-headless.combinedfilter.md b/docs/search-headless.combinedfilter.md new file mode 100644 index 00000000..9c770544 --- /dev/null +++ b/docs/search-headless.combinedfilter.md @@ -0,0 +1,21 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [CombinedFilter](./search-headless.combinedfilter.md) + +## CombinedFilter interface + +Represents multiple filters that will be combined to refine results. + +Signature: + +```typescript +export declare interface CombinedFilter +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [combinator](./search-headless.combinedfilter.combinator.md) | [FilterCombinator](./search-headless.filtercombinator.md) | The logical operator used to combine the filters. | +| [filters](./search-headless.combinedfilter.filters.md) | ([Filter](./search-headless.filter.md) \| [CombinedFilter](./search-headless.combinedfilter.md))\[\] | An array of filters applied to the search. | + diff --git a/docs/search-headless.combinefilters.md b/docs/search-headless.combinefilters.md new file mode 100644 index 00000000..b2d2d3e8 --- /dev/null +++ b/docs/search-headless.combinefilters.md @@ -0,0 +1,28 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [combineFilters](./search-headless.combinefilters.md) + +## combineFilters() function + +Creates a [CombinedFilter](./search-headless.combinedfilter.md) by applying the specified [FilterCombinator](./search-headless.filtercombinator.md) to the two filters. + +Signature: + +```typescript +export declare function combineFilters(filterA: FilterTypes, filterB: FilterTypes, combinator: FilterCombinator): CombinedFilter; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| filterA | [FilterTypes](./search-headless.filtertypes.md) | The first filter to be combined | +| filterB | [FilterTypes](./search-headless.filtertypes.md) | The second filter to be combined | +| combinator | [FilterCombinator](./search-headless.filtercombinator.md) | Specifies how the two filters should be joined | + +Returns: + +[CombinedFilter](./search-headless.combinedfilter.md) + +The newly created [CombinedFilter](./search-headless.combinedfilter.md) + diff --git a/docs/answers-headless.context.md b/docs/search-headless.context.md similarity index 71% rename from docs/answers-headless.context.md rename to docs/search-headless.context.md index f4a53990..fddc047f 100644 --- a/docs/answers-headless.context.md +++ b/docs/search-headless.context.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [Context](./answers-headless.context.md) +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [Context](./search-headless.context.md) ## Context type diff --git a/docs/search-headless.createdaterangefilter.md b/docs/search-headless.createdaterangefilter.md new file mode 100644 index 00000000..3cc32560 --- /dev/null +++ b/docs/search-headless.createdaterangefilter.md @@ -0,0 +1,27 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [createDateRangeFilter](./search-headless.createdaterangefilter.md) + +## createDateRangeFilter() function + +Creates a [Filter](./search-headless.filter.md) or [CombinedFilter](./search-headless.combinedfilter.md) that matches all results where the given field value falls in a specific Date [BoundedRange](./search-headless.boundedrange.md). + +Signature: + +```typescript +export declare function createDateRangeFilter(fieldId: string, range: BoundedRange): FilterTypes; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| fieldId | string | The comparison field's identifier | +| range | [BoundedRange](./search-headless.boundedrange.md)<Date> | The acceptable date range | + +Returns: + +[FilterTypes](./search-headless.filtertypes.md) + +The newly created filter for the field value range + diff --git a/docs/answers-headless.createequalsfilter.md b/docs/search-headless.createequalsfilter.md similarity index 54% rename from docs/answers-headless.createequalsfilter.md rename to docs/search-headless.createequalsfilter.md index c73282cc..1e20146a 100644 --- a/docs/answers-headless.createequalsfilter.md +++ b/docs/search-headless.createequalsfilter.md @@ -1,10 +1,10 @@ -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [createEqualsFilter](./answers-headless.createequalsfilter.md) +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [createEqualsFilter](./search-headless.createequalsfilter.md) ## createEqualsFilter() function -Creates a simple [Filter](./answers-headless.filter.md) that ensures all results will match a specific field value. +Creates a simple [Filter](./search-headless.filter.md) that ensures all results will match a specific field value. Signature: @@ -21,7 +21,7 @@ export declare function createEqualsFilter(fieldId: string, value: string | numb Returns: -[Filter](./answers-headless.filter.md) +[Filter](./search-headless.filter.md) -The newly created [Filter](./answers-headless.filter.md) for the field value +The newly created [Filter](./search-headless.filter.md) for the field value diff --git a/docs/search-headless.createnearmefilter.md b/docs/search-headless.createnearmefilter.md new file mode 100644 index 00000000..7ee5bab9 --- /dev/null +++ b/docs/search-headless.createnearmefilter.md @@ -0,0 +1,26 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [createNearMeFilter](./search-headless.createnearmefilter.md) + +## createNearMeFilter() function + +Creates a [Filter](./search-headless.filter.md) that matches all results within a certain radius of the given position. + +Signature: + +```typescript +export declare function createNearMeFilter(position: NearFilterValue): Filter; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| position | [NearFilterValue](./search-headless.nearfiltervalue.md) | The position and radius | + +Returns: + +[Filter](./search-headless.filter.md) + +The newly created [Filter](./search-headless.filter.md) for the radius of the position + diff --git a/docs/search-headless.createnumberrangefilter.md b/docs/search-headless.createnumberrangefilter.md new file mode 100644 index 00000000..634e4a87 --- /dev/null +++ b/docs/search-headless.createnumberrangefilter.md @@ -0,0 +1,27 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [createNumberRangeFilter](./search-headless.createnumberrangefilter.md) + +## createNumberRangeFilter() function + +Creates a [Filter](./search-headless.filter.md) or [CombinedFilter](./search-headless.combinedfilter.md) that matches all results where the given field value falls in a specific number [BoundedRange](./search-headless.boundedrange.md). + +Signature: + +```typescript +export declare function createNumberRangeFilter(fieldId: string, range: BoundedRange): FilterTypes; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| fieldId | string | The comparison field's identifier | +| range | [BoundedRange](./search-headless.boundedrange.md)<number> | The acceptable number range | + +Returns: + +[FilterTypes](./search-headless.filtertypes.md) + +The newly created filter for the field value range + diff --git a/docs/search-headless.default_headless_id.md b/docs/search-headless.default_headless_id.md new file mode 100644 index 00000000..7b19658e --- /dev/null +++ b/docs/search-headless.default_headless_id.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [DEFAULT\_HEADLESS\_ID](./search-headless.default_headless_id.md) + +## DEFAULT\_HEADLESS\_ID variable + +The headlessId automatically given to the first SearchHeadless instance created. + +Signature: + +```typescript +DEFAULT_HEADLESS_ID = "main" +``` diff --git a/docs/answers-headless.directanswer.fieldtype.md b/docs/search-headless.directanswer.fieldtype.md similarity index 51% rename from docs/answers-headless.directanswer.fieldtype.md rename to docs/search-headless.directanswer.fieldtype.md index f1a3bbf9..d9a211cd 100644 --- a/docs/answers-headless.directanswer.fieldtype.md +++ b/docs/search-headless.directanswer.fieldtype.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [DirectAnswer](./answers-headless.directanswer.md) > [fieldType](./answers-headless.directanswer.fieldtype.md) +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [DirectAnswer](./search-headless.directanswer.md) > [fieldType](./search-headless.directanswer.fieldtype.md) ## DirectAnswer.fieldType property diff --git a/docs/search-headless.directanswer.md b/docs/search-headless.directanswer.md new file mode 100644 index 00000000..5f966c5d --- /dev/null +++ b/docs/search-headless.directanswer.md @@ -0,0 +1,24 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [DirectAnswer](./search-headless.directanswer.md) + +## DirectAnswer interface + +A direct answer to a search. + +Signature: + +```typescript +export declare interface DirectAnswer +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [fieldType](./search-headless.directanswer.fieldtype.md) | string | The field type of the direct answer. | +| [relatedResult](./search-headless.directanswer.relatedresult.md) | [Result](./search-headless.result.md) | The entity associated with the direct answer. | +| [type](./search-headless.directanswer.type.md) | [DirectAnswerType](./search-headless.directanswertype.md) | The [DirectAnswerType](./search-headless.directanswertype.md). | +| [value?](./search-headless.directanswer.value.md) | string | (Optional) The result of the direct answer. | +| [verticalKey](./search-headless.directanswer.verticalkey.md) | string | The vertical key of the direct answer. | + diff --git a/docs/answers-headless.directanswer.relatedresult.md b/docs/search-headless.directanswer.relatedresult.md similarity index 52% rename from docs/answers-headless.directanswer.relatedresult.md rename to docs/search-headless.directanswer.relatedresult.md index 9c6f7658..c59a2966 100644 --- a/docs/answers-headless.directanswer.relatedresult.md +++ b/docs/search-headless.directanswer.relatedresult.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [DirectAnswer](./answers-headless.directanswer.md) > [relatedResult](./answers-headless.directanswer.relatedresult.md) +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [DirectAnswer](./search-headless.directanswer.md) > [relatedResult](./search-headless.directanswer.relatedresult.md) ## DirectAnswer.relatedResult property diff --git a/docs/search-headless.directanswer.type.md b/docs/search-headless.directanswer.type.md new file mode 100644 index 00000000..4dbb4eeb --- /dev/null +++ b/docs/search-headless.directanswer.type.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [DirectAnswer](./search-headless.directanswer.md) > [type](./search-headless.directanswer.type.md) + +## DirectAnswer.type property + +The [DirectAnswerType](./search-headless.directanswertype.md). + +Signature: + +```typescript +type: DirectAnswerType; +``` diff --git a/docs/search-headless.directanswer.value.md b/docs/search-headless.directanswer.value.md new file mode 100644 index 00000000..56eca1b9 --- /dev/null +++ b/docs/search-headless.directanswer.value.md @@ -0,0 +1,18 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [DirectAnswer](./search-headless.directanswer.md) > [value](./search-headless.directanswer.value.md) + +## DirectAnswer.value property + +The result of the direct answer. + +Signature: + +```typescript +value?: string; +``` + +## Remarks + +A value will not be present if the [DirectAnswer.fieldType](./search-headless.directanswer.fieldtype.md) is 'rich\_text'. + diff --git a/docs/answers-headless.directanswer.verticalkey.md b/docs/search-headless.directanswer.verticalkey.md similarity index 51% rename from docs/answers-headless.directanswer.verticalkey.md rename to docs/search-headless.directanswer.verticalkey.md index 03507c8f..43d36e66 100644 --- a/docs/answers-headless.directanswer.verticalkey.md +++ b/docs/search-headless.directanswer.verticalkey.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [DirectAnswer](./answers-headless.directanswer.md) > [verticalKey](./answers-headless.directanswer.verticalkey.md) +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [DirectAnswer](./search-headless.directanswer.md) > [verticalKey](./search-headless.directanswer.verticalkey.md) ## DirectAnswer.verticalKey property diff --git a/docs/search-headless.directanswerstate.md b/docs/search-headless.directanswerstate.md new file mode 100644 index 00000000..5f9a0848 --- /dev/null +++ b/docs/search-headless.directanswerstate.md @@ -0,0 +1,20 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [DirectAnswerState](./search-headless.directanswerstate.md) + +## DirectAnswerState interface + +Maintains the direct answer associated with the latest search. + +Signature: + +```typescript +export interface DirectAnswerState +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [result?](./search-headless.directanswerstate.result.md) | [FeaturedSnippetDirectAnswer](./search-headless.featuredsnippetdirectanswer.md) \| [FieldValueDirectAnswer](./search-headless.fieldvaluedirectanswer.md) | (Optional) The data for the direct answer. The type of the data is determined by the Answers API based on whether the answer was found within a document or was a field value in the knowledge graph. | + diff --git a/docs/answers-headless.directanswerstate.result.md b/docs/search-headless.directanswerstate.result.md similarity index 65% rename from docs/answers-headless.directanswerstate.result.md rename to docs/search-headless.directanswerstate.result.md index 3a450317..d9d42f1a 100644 --- a/docs/answers-headless.directanswerstate.result.md +++ b/docs/search-headless.directanswerstate.result.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [DirectAnswerState](./answers-headless.directanswerstate.md) > [result](./answers-headless.directanswerstate.result.md) +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [DirectAnswerState](./search-headless.directanswerstate.md) > [result](./search-headless.directanswerstate.result.md) ## DirectAnswerState.result property diff --git a/docs/answers-headless.directanswertype.md b/docs/search-headless.directanswertype.md similarity index 59% rename from docs/answers-headless.directanswertype.md rename to docs/search-headless.directanswertype.md index dc057d40..622a85f5 100644 --- a/docs/answers-headless.directanswertype.md +++ b/docs/search-headless.directanswertype.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [DirectAnswerType](./answers-headless.directanswertype.md) +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [DirectAnswerType](./search-headless.directanswertype.md) ## DirectAnswerType enum @@ -16,6 +16,6 @@ export declare enum DirectAnswerType | Member | Value | Description | | --- | --- | --- | -| FeaturedSnippet | "FEATURED_SNIPPET" | Indicates that the DirectAnswer is a [FeaturedSnippetDirectAnswer](./answers-headless.featuredsnippetdirectanswer.md). | -| FieldValue | "FIELD_VALUE" | Indicates that the DirectAnswer is a [FieldValueDirectAnswer](./answers-headless.fieldvaluedirectanswer.md). | +| FeaturedSnippet | "FEATURED_SNIPPET" | Indicates that the DirectAnswer is a [FeaturedSnippetDirectAnswer](./search-headless.featuredsnippetdirectanswer.md). | +| FieldValue | "FIELD_VALUE" | Indicates that the DirectAnswer is a [FieldValueDirectAnswer](./search-headless.fieldvaluedirectanswer.md). | diff --git a/docs/answers-headless.direction.md b/docs/search-headless.direction.md similarity index 74% rename from docs/answers-headless.direction.md rename to docs/search-headless.direction.md index 536a3212..831c711b 100644 --- a/docs/answers-headless.direction.md +++ b/docs/search-headless.direction.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [Direction](./answers-headless.direction.md) +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [Direction](./search-headless.direction.md) ## Direction enum diff --git a/docs/answers-headless.displayablefacet.displayname.md b/docs/search-headless.displayablefacet.displayname.md similarity index 53% rename from docs/answers-headless.displayablefacet.displayname.md rename to docs/search-headless.displayablefacet.displayname.md index fd255fa6..f2a29f17 100644 --- a/docs/answers-headless.displayablefacet.displayname.md +++ b/docs/search-headless.displayablefacet.displayname.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [DisplayableFacet](./answers-headless.displayablefacet.md) > [displayName](./answers-headless.displayablefacet.displayname.md) +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [DisplayableFacet](./search-headless.displayablefacet.md) > [displayName](./search-headless.displayablefacet.displayname.md) ## DisplayableFacet.displayName property diff --git a/docs/search-headless.displayablefacet.fieldid.md b/docs/search-headless.displayablefacet.fieldid.md new file mode 100644 index 00000000..e79ef2ad --- /dev/null +++ b/docs/search-headless.displayablefacet.fieldid.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [DisplayableFacet](./search-headless.displayablefacet.md) > [fieldId](./search-headless.displayablefacet.fieldid.md) + +## DisplayableFacet.fieldId property + +The associated fieldId. + +Signature: + +```typescript +fieldId: string; +``` diff --git a/docs/search-headless.displayablefacet.md b/docs/search-headless.displayablefacet.md new file mode 100644 index 00000000..c0fa48db --- /dev/null +++ b/docs/search-headless.displayablefacet.md @@ -0,0 +1,23 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [DisplayableFacet](./search-headless.displayablefacet.md) + +## DisplayableFacet interface + +A [Facet](./search-headless.facet.md) which contains extra fields meant to be displayed to the end user. + +Signature: + +```typescript +export declare interface DisplayableFacet extends Facet +``` +Extends: [Facet](./search-headless.facet.md) + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [displayName](./search-headless.displayablefacet.displayname.md) | string | The name of the facet which is meant to be displayed to the user. | +| [fieldId](./search-headless.displayablefacet.fieldid.md) | string | The associated fieldId. | +| [options](./search-headless.displayablefacet.options.md) | [DisplayableFacetOption](./search-headless.displayablefacetoption.md)\[\] | An array of [DisplayableFacetOption](./search-headless.displayablefacetoption.md) | + diff --git a/docs/search-headless.displayablefacet.options.md b/docs/search-headless.displayablefacet.options.md new file mode 100644 index 00000000..7e536e58 --- /dev/null +++ b/docs/search-headless.displayablefacet.options.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [DisplayableFacet](./search-headless.displayablefacet.md) > [options](./search-headless.displayablefacet.options.md) + +## DisplayableFacet.options property + +An array of [DisplayableFacetOption](./search-headless.displayablefacetoption.md) + +Signature: + +```typescript +options: DisplayableFacetOption[]; +``` diff --git a/docs/answers-headless.displayablefacetoption.count.md b/docs/search-headless.displayablefacetoption.count.md similarity index 50% rename from docs/answers-headless.displayablefacetoption.count.md rename to docs/search-headless.displayablefacetoption.count.md index 406e3fd3..c9d90e2c 100644 --- a/docs/answers-headless.displayablefacetoption.count.md +++ b/docs/search-headless.displayablefacetoption.count.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [DisplayableFacetOption](./answers-headless.displayablefacetoption.md) > [count](./answers-headless.displayablefacetoption.count.md) +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [DisplayableFacetOption](./search-headless.displayablefacetoption.md) > [count](./search-headless.displayablefacetoption.count.md) ## DisplayableFacetOption.count property diff --git a/docs/answers-headless.displayablefacetoption.displayname.md b/docs/search-headless.displayablefacetoption.displayname.md similarity index 52% rename from docs/answers-headless.displayablefacetoption.displayname.md rename to docs/search-headless.displayablefacetoption.displayname.md index 30f62cc4..85d5cb5d 100644 --- a/docs/answers-headless.displayablefacetoption.displayname.md +++ b/docs/search-headless.displayablefacetoption.displayname.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [DisplayableFacetOption](./answers-headless.displayablefacetoption.md) > [displayName](./answers-headless.displayablefacetoption.displayname.md) +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [DisplayableFacetOption](./search-headless.displayablefacetoption.md) > [displayName](./search-headless.displayablefacetoption.displayname.md) ## DisplayableFacetOption.displayName property diff --git a/docs/search-headless.displayablefacetoption.matcher.md b/docs/search-headless.displayablefacetoption.matcher.md new file mode 100644 index 00000000..54ed72ee --- /dev/null +++ b/docs/search-headless.displayablefacetoption.matcher.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [DisplayableFacetOption](./search-headless.displayablefacetoption.md) > [matcher](./search-headless.displayablefacetoption.matcher.md) + +## DisplayableFacetOption.matcher property + +A Matcher is a filtering operation. + +Signature: + +```typescript +matcher: Matcher; +``` diff --git a/docs/search-headless.displayablefacetoption.md b/docs/search-headless.displayablefacetoption.md new file mode 100644 index 00000000..4330cd73 --- /dev/null +++ b/docs/search-headless.displayablefacetoption.md @@ -0,0 +1,25 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [DisplayableFacetOption](./search-headless.displayablefacetoption.md) + +## DisplayableFacetOption interface + +A [FacetOption](./search-headless.facetoption.md) with extra data meant to be displayed to the end user. + +Signature: + +```typescript +export declare interface DisplayableFacetOption extends FacetOption +``` +Extends: [FacetOption](./search-headless.facetoption.md) + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [count](./search-headless.displayablefacetoption.count.md) | number | The number of results associated with this facet option. | +| [displayName](./search-headless.displayablefacetoption.displayname.md) | string | The name of the facet option which is meant to be displayed to the end user. | +| [matcher](./search-headless.displayablefacetoption.matcher.md) | [Matcher](./search-headless.matcher.md) | A Matcher is a filtering operation. | +| [selected](./search-headless.displayablefacetoption.selected.md) | boolean | Whether or not the filter is selected in the search results. | +| [value](./search-headless.displayablefacetoption.value.md) | string \| number \| boolean \| [NumberRangeValue](./search-headless.numberrangevalue.md) | The value to compare. | + diff --git a/docs/answers-headless.displayablefacetoption.selected.md b/docs/search-headless.displayablefacetoption.selected.md similarity index 51% rename from docs/answers-headless.displayablefacetoption.selected.md rename to docs/search-headless.displayablefacetoption.selected.md index b751d631..4017d975 100644 --- a/docs/answers-headless.displayablefacetoption.selected.md +++ b/docs/search-headless.displayablefacetoption.selected.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [DisplayableFacetOption](./answers-headless.displayablefacetoption.md) > [selected](./answers-headless.displayablefacetoption.selected.md) +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [DisplayableFacetOption](./search-headless.displayablefacetoption.md) > [selected](./search-headless.displayablefacetoption.selected.md) ## DisplayableFacetOption.selected property diff --git a/docs/answers-headless.displayablefacetoption.value.md b/docs/search-headless.displayablefacetoption.value.md similarity index 51% rename from docs/answers-headless.displayablefacetoption.value.md rename to docs/search-headless.displayablefacetoption.value.md index 62150733..4a189c4c 100644 --- a/docs/answers-headless.displayablefacetoption.value.md +++ b/docs/search-headless.displayablefacetoption.value.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [DisplayableFacetOption](./answers-headless.displayablefacetoption.md) > [value](./answers-headless.displayablefacetoption.value.md) +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [DisplayableFacetOption](./search-headless.displayablefacetoption.md) > [value](./search-headless.displayablefacetoption.value.md) ## DisplayableFacetOption.value property diff --git a/docs/search-headless.endpoints.filtersearch.md b/docs/search-headless.endpoints.filtersearch.md new file mode 100644 index 00000000..614ecffe --- /dev/null +++ b/docs/search-headless.endpoints.filtersearch.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [Endpoints](./search-headless.endpoints.md) > [filterSearch](./search-headless.endpoints.filtersearch.md) + +## Endpoints.filterSearch property + +Signature: + +```typescript +filterSearch?: string; +``` diff --git a/docs/search-headless.endpoints.md b/docs/search-headless.endpoints.md new file mode 100644 index 00000000..4cebfe5e --- /dev/null +++ b/docs/search-headless.endpoints.md @@ -0,0 +1,26 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [Endpoints](./search-headless.endpoints.md) + +## Endpoints interface + +Overrides for the URLs which are used when making requests to the Answers API. + +Signature: + +```typescript +export declare interface Endpoints +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [filterSearch?](./search-headless.endpoints.filtersearch.md) | string | (Optional) | +| [questionSubmission?](./search-headless.endpoints.questionsubmission.md) | string | (Optional) | +| [status?](./search-headless.endpoints.status.md) | string | (Optional) | +| [universalAutocomplete?](./search-headless.endpoints.universalautocomplete.md) | string | (Optional) | +| [universalSearch?](./search-headless.endpoints.universalsearch.md) | string | (Optional) | +| [verticalAutocomplete?](./search-headless.endpoints.verticalautocomplete.md) | string | (Optional) | +| [verticalSearch?](./search-headless.endpoints.verticalsearch.md) | string | (Optional) | + diff --git a/docs/search-headless.endpoints.questionsubmission.md b/docs/search-headless.endpoints.questionsubmission.md new file mode 100644 index 00000000..d7f23449 --- /dev/null +++ b/docs/search-headless.endpoints.questionsubmission.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [Endpoints](./search-headless.endpoints.md) > [questionSubmission](./search-headless.endpoints.questionsubmission.md) + +## Endpoints.questionSubmission property + +Signature: + +```typescript +questionSubmission?: string; +``` diff --git a/docs/search-headless.endpoints.status.md b/docs/search-headless.endpoints.status.md new file mode 100644 index 00000000..ea39e264 --- /dev/null +++ b/docs/search-headless.endpoints.status.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [Endpoints](./search-headless.endpoints.md) > [status](./search-headless.endpoints.status.md) + +## Endpoints.status property + +Signature: + +```typescript +status?: string; +``` diff --git a/docs/search-headless.endpoints.universalautocomplete.md b/docs/search-headless.endpoints.universalautocomplete.md new file mode 100644 index 00000000..5dd1c39a --- /dev/null +++ b/docs/search-headless.endpoints.universalautocomplete.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [Endpoints](./search-headless.endpoints.md) > [universalAutocomplete](./search-headless.endpoints.universalautocomplete.md) + +## Endpoints.universalAutocomplete property + +Signature: + +```typescript +universalAutocomplete?: string; +``` diff --git a/docs/search-headless.endpoints.universalsearch.md b/docs/search-headless.endpoints.universalsearch.md new file mode 100644 index 00000000..dd4fd105 --- /dev/null +++ b/docs/search-headless.endpoints.universalsearch.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [Endpoints](./search-headless.endpoints.md) > [universalSearch](./search-headless.endpoints.universalsearch.md) + +## Endpoints.universalSearch property + +Signature: + +```typescript +universalSearch?: string; +``` diff --git a/docs/search-headless.endpoints.verticalautocomplete.md b/docs/search-headless.endpoints.verticalautocomplete.md new file mode 100644 index 00000000..229dcf20 --- /dev/null +++ b/docs/search-headless.endpoints.verticalautocomplete.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [Endpoints](./search-headless.endpoints.md) > [verticalAutocomplete](./search-headless.endpoints.verticalautocomplete.md) + +## Endpoints.verticalAutocomplete property + +Signature: + +```typescript +verticalAutocomplete?: string; +``` diff --git a/docs/search-headless.endpoints.verticalsearch.md b/docs/search-headless.endpoints.verticalsearch.md new file mode 100644 index 00000000..8220d0d7 --- /dev/null +++ b/docs/search-headless.endpoints.verticalsearch.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [Endpoints](./search-headless.endpoints.md) > [verticalSearch](./search-headless.endpoints.verticalsearch.md) + +## Endpoints.verticalSearch property + +Signature: + +```typescript +verticalSearch?: string; +``` diff --git a/docs/answers-headless.enumorliteral.md b/docs/search-headless.enumorliteral.md similarity index 70% rename from docs/answers-headless.enumorliteral.md rename to docs/search-headless.enumorliteral.md index 7e18c023..3a3f8b8f 100644 --- a/docs/answers-headless.enumorliteral.md +++ b/docs/search-headless.enumorliteral.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [EnumOrLiteral](./answers-headless.enumorliteral.md) +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [EnumOrLiteral](./search-headless.enumorliteral.md) ## EnumOrLiteral type diff --git a/docs/answers-headless.errortype.md b/docs/search-headless.errortype.md similarity index 82% rename from docs/answers-headless.errortype.md rename to docs/search-headless.errortype.md index 46622f05..bd717ba9 100644 --- a/docs/answers-headless.errortype.md +++ b/docs/search-headless.errortype.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [ErrorType](./answers-headless.errortype.md) +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [ErrorType](./search-headless.errortype.md) ## ErrorType enum diff --git a/docs/answers-headless.facet.fieldid.md b/docs/search-headless.facet.fieldid.md similarity index 51% rename from docs/answers-headless.facet.fieldid.md rename to docs/search-headless.facet.fieldid.md index 2dd8309a..993b7dea 100644 --- a/docs/answers-headless.facet.fieldid.md +++ b/docs/search-headless.facet.fieldid.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [Facet](./answers-headless.facet.md) > [fieldId](./answers-headless.facet.fieldid.md) +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [Facet](./search-headless.facet.md) > [fieldId](./search-headless.facet.fieldid.md) ## Facet.fieldId property diff --git a/docs/search-headless.facet.md b/docs/search-headless.facet.md new file mode 100644 index 00000000..6249ab14 --- /dev/null +++ b/docs/search-headless.facet.md @@ -0,0 +1,21 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [Facet](./search-headless.facet.md) + +## Facet interface + +Represents dynamic filter options for the Answers API. + +Signature: + +```typescript +export declare interface Facet +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [fieldId](./search-headless.facet.fieldid.md) | string | The associated fieldId. | +| [options](./search-headless.facet.options.md) | [FacetOption](./search-headless.facetoption.md)\[\] | An array of [FacetOption](./search-headless.facetoption.md) | + diff --git a/docs/answers-headless.facet.options.md b/docs/search-headless.facet.options.md similarity index 50% rename from docs/answers-headless.facet.options.md rename to docs/search-headless.facet.options.md index 090a0489..7810bb19 100644 --- a/docs/answers-headless.facet.options.md +++ b/docs/search-headless.facet.options.md @@ -1,10 +1,10 @@ -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [Facet](./answers-headless.facet.md) > [options](./answers-headless.facet.options.md) +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [Facet](./search-headless.facet.md) > [options](./search-headless.facet.options.md) ## Facet.options property -An array of [FacetOption](./answers-headless.facetoption.md) +An array of [FacetOption](./search-headless.facetoption.md) Signature: diff --git a/docs/answers-headless.facetoption.matcher.md b/docs/search-headless.facetoption.matcher.md similarity index 51% rename from docs/answers-headless.facetoption.matcher.md rename to docs/search-headless.facetoption.matcher.md index 8cef020c..1d94c67c 100644 --- a/docs/answers-headless.facetoption.matcher.md +++ b/docs/search-headless.facetoption.matcher.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [FacetOption](./answers-headless.facetoption.md) > [matcher](./answers-headless.facetoption.matcher.md) +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [FacetOption](./search-headless.facetoption.md) > [matcher](./search-headless.facetoption.matcher.md) ## FacetOption.matcher property diff --git a/docs/search-headless.facetoption.md b/docs/search-headless.facetoption.md new file mode 100644 index 00000000..76797af6 --- /dev/null +++ b/docs/search-headless.facetoption.md @@ -0,0 +1,21 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [FacetOption](./search-headless.facetoption.md) + +## FacetOption interface + +A filter associated with the facet. + +Signature: + +```typescript +export declare interface FacetOption +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [matcher](./search-headless.facetoption.matcher.md) | [Matcher](./search-headless.matcher.md) | A Matcher is a filtering operation. | +| [value](./search-headless.facetoption.value.md) | string \| number \| boolean \| [NumberRangeValue](./search-headless.numberrangevalue.md) | The value to compare. | + diff --git a/docs/answers-headless.facetoption.value.md b/docs/search-headless.facetoption.value.md similarity index 55% rename from docs/answers-headless.facetoption.value.md rename to docs/search-headless.facetoption.value.md index e168d9f0..ccc2bdc0 100644 --- a/docs/answers-headless.facetoption.value.md +++ b/docs/search-headless.facetoption.value.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [FacetOption](./answers-headless.facetoption.md) > [value](./answers-headless.facetoption.value.md) +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [FacetOption](./search-headless.facetoption.md) > [value](./search-headless.facetoption.value.md) ## FacetOption.value property diff --git a/docs/answers-headless.failedvertical.details.md b/docs/search-headless.failedvertical.details.md similarity index 56% rename from docs/answers-headless.failedvertical.details.md rename to docs/search-headless.failedvertical.details.md index f1662742..de50b8c3 100644 --- a/docs/answers-headless.failedvertical.details.md +++ b/docs/search-headless.failedvertical.details.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [FailedVertical](./answers-headless.failedvertical.md) > [details](./answers-headless.failedvertical.details.md) +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [FailedVertical](./search-headless.failedvertical.md) > [details](./search-headless.failedvertical.details.md) ## FailedVertical.details property diff --git a/docs/answers-headless.failedvertical.errortype.md b/docs/search-headless.failedvertical.errortype.md similarity index 52% rename from docs/answers-headless.failedvertical.errortype.md rename to docs/search-headless.failedvertical.errortype.md index 8395cb3e..4c1f91b2 100644 --- a/docs/answers-headless.failedvertical.errortype.md +++ b/docs/search-headless.failedvertical.errortype.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [FailedVertical](./answers-headless.failedvertical.md) > [errorType](./answers-headless.failedvertical.errortype.md) +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [FailedVertical](./search-headless.failedvertical.md) > [errorType](./search-headless.failedvertical.errortype.md) ## FailedVertical.errorType property diff --git a/docs/search-headless.failedvertical.md b/docs/search-headless.failedvertical.md new file mode 100644 index 00000000..87ac536a --- /dev/null +++ b/docs/search-headless.failedvertical.md @@ -0,0 +1,23 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [FailedVertical](./search-headless.failedvertical.md) + +## FailedVertical interface + +Error information from when a vertical fails to return results. + +Signature: + +```typescript +export declare interface FailedVertical +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [details](./search-headless.failedvertical.details.md) | { responseCode: number; description: string; } | Detailed information about the error. | +| [errorType](./search-headless.failedvertical.errortype.md) | [ErrorType](./search-headless.errortype.md) | Identifier for the type of error causing the failure. | +| [queryDurationMillis](./search-headless.failedvertical.querydurationmillis.md) | number | The duration of the query in milliseconds. | +| [verticalKey](./search-headless.failedvertical.verticalkey.md) | string | The vertical key associated with the failed vertical. | + diff --git a/docs/answers-headless.failedvertical.querydurationmillis.md b/docs/search-headless.failedvertical.querydurationmillis.md similarity index 51% rename from docs/answers-headless.failedvertical.querydurationmillis.md rename to docs/search-headless.failedvertical.querydurationmillis.md index d9b42c39..8eb221de 100644 --- a/docs/answers-headless.failedvertical.querydurationmillis.md +++ b/docs/search-headless.failedvertical.querydurationmillis.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [FailedVertical](./answers-headless.failedvertical.md) > [queryDurationMillis](./answers-headless.failedvertical.querydurationmillis.md) +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [FailedVertical](./search-headless.failedvertical.md) > [queryDurationMillis](./search-headless.failedvertical.querydurationmillis.md) ## FailedVertical.queryDurationMillis property diff --git a/docs/answers-headless.failedvertical.verticalkey.md b/docs/search-headless.failedvertical.verticalkey.md similarity index 52% rename from docs/answers-headless.failedvertical.verticalkey.md rename to docs/search-headless.failedvertical.verticalkey.md index 6ba5cf29..30d56ef6 100644 --- a/docs/answers-headless.failedvertical.verticalkey.md +++ b/docs/search-headless.failedvertical.verticalkey.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [FailedVertical](./answers-headless.failedvertical.md) > [verticalKey](./answers-headless.failedvertical.verticalkey.md) +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [FailedVertical](./search-headless.failedvertical.md) > [verticalKey](./search-headless.failedvertical.verticalkey.md) ## FailedVertical.verticalKey property diff --git a/docs/search-headless.featuredsnippetdirectanswer.fieldtype.md b/docs/search-headless.featuredsnippetdirectanswer.fieldtype.md new file mode 100644 index 00000000..f3054bf3 --- /dev/null +++ b/docs/search-headless.featuredsnippetdirectanswer.fieldtype.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [FeaturedSnippetDirectAnswer](./search-headless.featuredsnippetdirectanswer.md) > [fieldType](./search-headless.featuredsnippetdirectanswer.fieldtype.md) + +## FeaturedSnippetDirectAnswer.fieldType property + +The field type of the direct answer. + +Signature: + +```typescript +fieldType: string; +``` diff --git a/docs/search-headless.featuredsnippetdirectanswer.md b/docs/search-headless.featuredsnippetdirectanswer.md new file mode 100644 index 00000000..48ba8589 --- /dev/null +++ b/docs/search-headless.featuredsnippetdirectanswer.md @@ -0,0 +1,26 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [FeaturedSnippetDirectAnswer](./search-headless.featuredsnippetdirectanswer.md) + +## FeaturedSnippetDirectAnswer interface + +A direct answer which was found within a document. + +Signature: + +```typescript +export declare interface FeaturedSnippetDirectAnswer extends DirectAnswer +``` +Extends: [DirectAnswer](./search-headless.directanswer.md) + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [fieldType](./search-headless.featuredsnippetdirectanswer.fieldtype.md) | string | The field type of the direct answer. | +| [relatedResult](./search-headless.featuredsnippetdirectanswer.relatedresult.md) | [Result](./search-headless.result.md) | The entity associated with the direct answer. | +| [snippet](./search-headless.featuredsnippetdirectanswer.snippet.md) | [Snippet](./search-headless.snippet.md) | The snippet where the direct answer was found. | +| [type](./search-headless.featuredsnippetdirectanswer.type.md) | [DirectAnswerType.FeaturedSnippet](./search-headless.directanswertype.md) | [DirectAnswerType](./search-headless.directanswertype.md).FeaturedSnippet. | +| [value?](./search-headless.featuredsnippetdirectanswer.value.md) | string | (Optional) The result of the direct answer. | +| [verticalKey](./search-headless.featuredsnippetdirectanswer.verticalkey.md) | string | The vertical key of the direct answer. | + diff --git a/docs/search-headless.featuredsnippetdirectanswer.relatedresult.md b/docs/search-headless.featuredsnippetdirectanswer.relatedresult.md new file mode 100644 index 00000000..6828d3f8 --- /dev/null +++ b/docs/search-headless.featuredsnippetdirectanswer.relatedresult.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [FeaturedSnippetDirectAnswer](./search-headless.featuredsnippetdirectanswer.md) > [relatedResult](./search-headless.featuredsnippetdirectanswer.relatedresult.md) + +## FeaturedSnippetDirectAnswer.relatedResult property + +The entity associated with the direct answer. + +Signature: + +```typescript +relatedResult: Result; +``` diff --git a/docs/search-headless.featuredsnippetdirectanswer.snippet.md b/docs/search-headless.featuredsnippetdirectanswer.snippet.md new file mode 100644 index 00000000..747c6ab6 --- /dev/null +++ b/docs/search-headless.featuredsnippetdirectanswer.snippet.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [FeaturedSnippetDirectAnswer](./search-headless.featuredsnippetdirectanswer.md) > [snippet](./search-headless.featuredsnippetdirectanswer.snippet.md) + +## FeaturedSnippetDirectAnswer.snippet property + +The snippet where the direct answer was found. + +Signature: + +```typescript +snippet: Snippet; +``` diff --git a/docs/search-headless.featuredsnippetdirectanswer.type.md b/docs/search-headless.featuredsnippetdirectanswer.type.md new file mode 100644 index 00000000..0e970332 --- /dev/null +++ b/docs/search-headless.featuredsnippetdirectanswer.type.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [FeaturedSnippetDirectAnswer](./search-headless.featuredsnippetdirectanswer.md) > [type](./search-headless.featuredsnippetdirectanswer.type.md) + +## FeaturedSnippetDirectAnswer.type property + +[DirectAnswerType](./search-headless.directanswertype.md).FeaturedSnippet. + +Signature: + +```typescript +type: DirectAnswerType.FeaturedSnippet; +``` diff --git a/docs/search-headless.featuredsnippetdirectanswer.value.md b/docs/search-headless.featuredsnippetdirectanswer.value.md new file mode 100644 index 00000000..08070060 --- /dev/null +++ b/docs/search-headless.featuredsnippetdirectanswer.value.md @@ -0,0 +1,18 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [FeaturedSnippetDirectAnswer](./search-headless.featuredsnippetdirectanswer.md) > [value](./search-headless.featuredsnippetdirectanswer.value.md) + +## FeaturedSnippetDirectAnswer.value property + +The result of the direct answer. + +Signature: + +```typescript +value?: string; +``` + +## Remarks + +A value will not be present if the [DirectAnswer.fieldType](./search-headless.directanswer.fieldtype.md) is 'rich\_text'. + diff --git a/docs/search-headless.featuredsnippetdirectanswer.verticalkey.md b/docs/search-headless.featuredsnippetdirectanswer.verticalkey.md new file mode 100644 index 00000000..c88299da --- /dev/null +++ b/docs/search-headless.featuredsnippetdirectanswer.verticalkey.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [FeaturedSnippetDirectAnswer](./search-headless.featuredsnippetdirectanswer.md) > [verticalKey](./search-headless.featuredsnippetdirectanswer.verticalkey.md) + +## FeaturedSnippetDirectAnswer.verticalKey property + +The vertical key of the direct answer. + +Signature: + +```typescript +verticalKey: string; +``` diff --git a/docs/answers-headless.fieldvaluedirectanswer.entityname.md b/docs/search-headless.fieldvaluedirectanswer.entityname.md similarity index 50% rename from docs/answers-headless.fieldvaluedirectanswer.entityname.md rename to docs/search-headless.fieldvaluedirectanswer.entityname.md index 6671420b..bdafa039 100644 --- a/docs/answers-headless.fieldvaluedirectanswer.entityname.md +++ b/docs/search-headless.fieldvaluedirectanswer.entityname.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [FieldValueDirectAnswer](./answers-headless.fieldvaluedirectanswer.md) > [entityName](./answers-headless.fieldvaluedirectanswer.entityname.md) +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [FieldValueDirectAnswer](./search-headless.fieldvaluedirectanswer.md) > [entityName](./search-headless.fieldvaluedirectanswer.entityname.md) ## FieldValueDirectAnswer.entityName property diff --git a/docs/search-headless.fieldvaluedirectanswer.fieldapiname.md b/docs/search-headless.fieldvaluedirectanswer.fieldapiname.md new file mode 100644 index 00000000..1455cd0a --- /dev/null +++ b/docs/search-headless.fieldvaluedirectanswer.fieldapiname.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [FieldValueDirectAnswer](./search-headless.fieldvaluedirectanswer.md) > [fieldApiName](./search-headless.fieldvaluedirectanswer.fieldapiname.md) + +## FieldValueDirectAnswer.fieldApiName property + +The field api name of the direct answer. + +Signature: + +```typescript +fieldApiName: string; +``` diff --git a/docs/search-headless.fieldvaluedirectanswer.fieldname.md b/docs/search-headless.fieldvaluedirectanswer.fieldname.md new file mode 100644 index 00000000..eb88a940 --- /dev/null +++ b/docs/search-headless.fieldvaluedirectanswer.fieldname.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [FieldValueDirectAnswer](./search-headless.fieldvaluedirectanswer.md) > [fieldName](./search-headless.fieldvaluedirectanswer.fieldname.md) + +## FieldValueDirectAnswer.fieldName property + +The field name of the direct answer. + +Signature: + +```typescript +fieldName: string; +``` diff --git a/docs/search-headless.fieldvaluedirectanswer.fieldtype.md b/docs/search-headless.fieldvaluedirectanswer.fieldtype.md new file mode 100644 index 00000000..564f4385 --- /dev/null +++ b/docs/search-headless.fieldvaluedirectanswer.fieldtype.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [FieldValueDirectAnswer](./search-headless.fieldvaluedirectanswer.md) > [fieldType](./search-headless.fieldvaluedirectanswer.fieldtype.md) + +## FieldValueDirectAnswer.fieldType property + +The field type of the direct answer. + +Signature: + +```typescript +fieldType: string; +``` diff --git a/docs/search-headless.fieldvaluedirectanswer.md b/docs/search-headless.fieldvaluedirectanswer.md new file mode 100644 index 00000000..ce0ee473 --- /dev/null +++ b/docs/search-headless.fieldvaluedirectanswer.md @@ -0,0 +1,28 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [FieldValueDirectAnswer](./search-headless.fieldvaluedirectanswer.md) + +## FieldValueDirectAnswer interface + +A direct answer where the answer came from a field from the knowledge graph. + +Signature: + +```typescript +export declare interface FieldValueDirectAnswer extends DirectAnswer +``` +Extends: [DirectAnswer](./search-headless.directanswer.md) + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [entityName](./search-headless.fieldvaluedirectanswer.entityname.md) | string | The name of the entity that direct answer came from. | +| [fieldApiName](./search-headless.fieldvaluedirectanswer.fieldapiname.md) | string | The field api name of the direct answer. | +| [fieldName](./search-headless.fieldvaluedirectanswer.fieldname.md) | string | The field name of the direct answer. | +| [fieldType](./search-headless.fieldvaluedirectanswer.fieldtype.md) | string | The field type of the direct answer. | +| [relatedResult](./search-headless.fieldvaluedirectanswer.relatedresult.md) | [Result](./search-headless.result.md) | The entity associated with the direct answer. | +| [type](./search-headless.fieldvaluedirectanswer.type.md) | [DirectAnswerType.FieldValue](./search-headless.directanswertype.md) | [DirectAnswerType](./search-headless.directanswertype.md).FieldValue. | +| [value](./search-headless.fieldvaluedirectanswer.value.md) | string | The result of the direct answer. | +| [verticalKey](./search-headless.fieldvaluedirectanswer.verticalkey.md) | string | The vertical key of the direct answer. | + diff --git a/docs/search-headless.fieldvaluedirectanswer.relatedresult.md b/docs/search-headless.fieldvaluedirectanswer.relatedresult.md new file mode 100644 index 00000000..73967639 --- /dev/null +++ b/docs/search-headless.fieldvaluedirectanswer.relatedresult.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [FieldValueDirectAnswer](./search-headless.fieldvaluedirectanswer.md) > [relatedResult](./search-headless.fieldvaluedirectanswer.relatedresult.md) + +## FieldValueDirectAnswer.relatedResult property + +The entity associated with the direct answer. + +Signature: + +```typescript +relatedResult: Result; +``` diff --git a/docs/search-headless.fieldvaluedirectanswer.type.md b/docs/search-headless.fieldvaluedirectanswer.type.md new file mode 100644 index 00000000..f4725c4d --- /dev/null +++ b/docs/search-headless.fieldvaluedirectanswer.type.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [FieldValueDirectAnswer](./search-headless.fieldvaluedirectanswer.md) > [type](./search-headless.fieldvaluedirectanswer.type.md) + +## FieldValueDirectAnswer.type property + +[DirectAnswerType](./search-headless.directanswertype.md).FieldValue. + +Signature: + +```typescript +type: DirectAnswerType.FieldValue; +``` diff --git a/docs/search-headless.fieldvaluedirectanswer.value.md b/docs/search-headless.fieldvaluedirectanswer.value.md new file mode 100644 index 00000000..3e5acd13 --- /dev/null +++ b/docs/search-headless.fieldvaluedirectanswer.value.md @@ -0,0 +1,18 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [FieldValueDirectAnswer](./search-headless.fieldvaluedirectanswer.md) > [value](./search-headless.fieldvaluedirectanswer.value.md) + +## FieldValueDirectAnswer.value property + +The result of the direct answer. + +Signature: + +```typescript +value: string; +``` + +## Remarks + +A value will not be present if the [DirectAnswer.fieldType](./search-headless.directanswer.fieldtype.md) is 'rich\_text'. + diff --git a/docs/search-headless.fieldvaluedirectanswer.verticalkey.md b/docs/search-headless.fieldvaluedirectanswer.verticalkey.md new file mode 100644 index 00000000..f57ba1b1 --- /dev/null +++ b/docs/search-headless.fieldvaluedirectanswer.verticalkey.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [FieldValueDirectAnswer](./search-headless.fieldvaluedirectanswer.md) > [verticalKey](./search-headless.fieldvaluedirectanswer.verticalkey.md) + +## FieldValueDirectAnswer.verticalKey property + +The vertical key of the direct answer. + +Signature: + +```typescript +verticalKey: string; +``` diff --git a/docs/answers-headless.filter.fieldid.md b/docs/search-headless.filter.fieldid.md similarity index 56% rename from docs/answers-headless.filter.fieldid.md rename to docs/search-headless.filter.fieldid.md index c862f432..387cfa80 100644 --- a/docs/answers-headless.filter.fieldid.md +++ b/docs/search-headless.filter.fieldid.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [Filter](./answers-headless.filter.md) > [fieldId](./answers-headless.filter.fieldid.md) +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [Filter](./search-headless.filter.md) > [fieldId](./search-headless.filter.fieldid.md) ## Filter.fieldId property diff --git a/docs/answers-headless.filter.matcher.md b/docs/search-headless.filter.matcher.md similarity index 52% rename from docs/answers-headless.filter.matcher.md rename to docs/search-headless.filter.matcher.md index a08f3bb9..3e8cc03b 100644 --- a/docs/answers-headless.filter.matcher.md +++ b/docs/search-headless.filter.matcher.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [Filter](./answers-headless.filter.md) > [matcher](./answers-headless.filter.matcher.md) +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [Filter](./search-headless.filter.md) > [matcher](./search-headless.filter.matcher.md) ## Filter.matcher property diff --git a/docs/search-headless.filter.md b/docs/search-headless.filter.md new file mode 100644 index 00000000..c3a4f6a4 --- /dev/null +++ b/docs/search-headless.filter.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [Filter](./search-headless.filter.md) + +## Filter interface + +Represents a filter which compares values to a single field. + +Signature: + +```typescript +export declare interface Filter +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [fieldId](./search-headless.filter.fieldid.md) | string | The fieldId to apply the filter against. | +| [matcher](./search-headless.filter.matcher.md) | [Matcher](./search-headless.matcher.md) | A Matcher is a filtering operation. | +| [value](./search-headless.filter.value.md) | string \| number \| boolean \| [NearFilterValue](./search-headless.nearfiltervalue.md) \| [NumberRangeValue](./search-headless.numberrangevalue.md) | The value to compare. | + diff --git a/docs/answers-headless.filter.value.md b/docs/search-headless.filter.value.md similarity index 58% rename from docs/answers-headless.filter.value.md rename to docs/search-headless.filter.value.md index bbbaad49..704e796b 100644 --- a/docs/answers-headless.filter.value.md +++ b/docs/search-headless.filter.value.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [Filter](./answers-headless.filter.md) > [value](./answers-headless.filter.value.md) +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [Filter](./search-headless.filter.md) > [value](./search-headless.filter.value.md) ## Filter.value property diff --git a/docs/answers-headless.filtercombinator.md b/docs/search-headless.filtercombinator.md similarity index 64% rename from docs/answers-headless.filtercombinator.md rename to docs/search-headless.filtercombinator.md index 7173d811..402802ea 100644 --- a/docs/answers-headless.filtercombinator.md +++ b/docs/search-headless.filtercombinator.md @@ -1,10 +1,10 @@ -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [FilterCombinator](./answers-headless.filtercombinator.md) +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [FilterCombinator](./search-headless.filtercombinator.md) ## FilterCombinator enum -Indicates how the filters in a [CombinedFilter](./answers-headless.combinedfilter.md) should be combined. +Indicates how the filters in a [CombinedFilter](./search-headless.combinedfilter.md) should be combined. Signature: diff --git a/docs/answers-headless.filtersearchrequest.excluded.md b/docs/search-headless.filtersearchrequest.excluded.md similarity index 53% rename from docs/answers-headless.filtersearchrequest.excluded.md rename to docs/search-headless.filtersearchrequest.excluded.md index 4f4c14af..4de747f9 100644 --- a/docs/answers-headless.filtersearchrequest.excluded.md +++ b/docs/search-headless.filtersearchrequest.excluded.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [FilterSearchRequest](./answers-headless.filtersearchrequest.md) > [excluded](./answers-headless.filtersearchrequest.excluded.md) +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [FilterSearchRequest](./search-headless.filtersearchrequest.md) > [excluded](./search-headless.filtersearchrequest.excluded.md) ## FilterSearchRequest.excluded property diff --git a/docs/search-headless.filtersearchrequest.fields.md b/docs/search-headless.filtersearchrequest.fields.md new file mode 100644 index 00000000..808d6291 --- /dev/null +++ b/docs/search-headless.filtersearchrequest.fields.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [FilterSearchRequest](./search-headless.filtersearchrequest.md) > [fields](./search-headless.filtersearchrequest.fields.md) + +## FilterSearchRequest.fields property + +An array of [SearchParameterField](./search-headless.searchparameterfield.md) + +Signature: + +```typescript +fields: SearchParameterField[]; +``` diff --git a/docs/search-headless.filtersearchrequest.input.md b/docs/search-headless.filtersearchrequest.input.md new file mode 100644 index 00000000..16bf112f --- /dev/null +++ b/docs/search-headless.filtersearchrequest.input.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [FilterSearchRequest](./search-headless.filtersearchrequest.md) > [input](./search-headless.filtersearchrequest.input.md) + +## FilterSearchRequest.input property + +The input string for autocomplete. + +Signature: + +```typescript +input: string; +``` diff --git a/docs/search-headless.filtersearchrequest.md b/docs/search-headless.filtersearchrequest.md new file mode 100644 index 00000000..4d78f6c0 --- /dev/null +++ b/docs/search-headless.filtersearchrequest.md @@ -0,0 +1,26 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [FilterSearchRequest](./search-headless.filtersearchrequest.md) + +## FilterSearchRequest interface + +Options for a filtersearch request. + +Signature: + +```typescript +export declare interface FilterSearchRequest extends AnswersRequest +``` +Extends: [AnswersRequest](./search-headless.answersrequest.md) + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [excluded?](./search-headless.filtersearchrequest.excluded.md) | [Filter](./search-headless.filter.md)\[\] | (Optional) an array of filters that should be excluded from filter search results. | +| [fields](./search-headless.filtersearchrequest.fields.md) | [SearchParameterField](./search-headless.searchparameterfield.md)\[\] | An array of [SearchParameterField](./search-headless.searchparameterfield.md) | +| [input](./search-headless.filtersearchrequest.input.md) | string | The input string for autocomplete. | +| [sectioned](./search-headless.filtersearchrequest.sectioned.md) | boolean | Determines whether or not the results of the [FilterSearchResponse](./search-headless.filtersearchresponse.md) are separated by field. | +| [sessionTrackingEnabled?](./search-headless.filtersearchrequest.sessiontrackingenabled.md) | boolean | (Optional) Enables session tracking. | +| [verticalKey](./search-headless.filtersearchrequest.verticalkey.md) | string | The key for the vertical to get autocomplete suggestions from. | + diff --git a/docs/search-headless.filtersearchrequest.sectioned.md b/docs/search-headless.filtersearchrequest.sectioned.md new file mode 100644 index 00000000..3a65515e --- /dev/null +++ b/docs/search-headless.filtersearchrequest.sectioned.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [FilterSearchRequest](./search-headless.filtersearchrequest.md) > [sectioned](./search-headless.filtersearchrequest.sectioned.md) + +## FilterSearchRequest.sectioned property + +Determines whether or not the results of the [FilterSearchResponse](./search-headless.filtersearchresponse.md) are separated by field. + +Signature: + +```typescript +sectioned: boolean; +``` diff --git a/docs/search-headless.filtersearchrequest.sessiontrackingenabled.md b/docs/search-headless.filtersearchrequest.sessiontrackingenabled.md new file mode 100644 index 00000000..c1e042f8 --- /dev/null +++ b/docs/search-headless.filtersearchrequest.sessiontrackingenabled.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [FilterSearchRequest](./search-headless.filtersearchrequest.md) > [sessionTrackingEnabled](./search-headless.filtersearchrequest.sessiontrackingenabled.md) + +## FilterSearchRequest.sessionTrackingEnabled property + +Enables session tracking. + +Signature: + +```typescript +sessionTrackingEnabled?: boolean; +``` diff --git a/docs/answers-headless.filtersearchrequest.verticalkey.md b/docs/search-headless.filtersearchrequest.verticalkey.md similarity index 52% rename from docs/answers-headless.filtersearchrequest.verticalkey.md rename to docs/search-headless.filtersearchrequest.verticalkey.md index 8590277d..a6f7e4ec 100644 --- a/docs/answers-headless.filtersearchrequest.verticalkey.md +++ b/docs/search-headless.filtersearchrequest.verticalkey.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [FilterSearchRequest](./answers-headless.filtersearchrequest.md) > [verticalKey](./answers-headless.filtersearchrequest.verticalkey.md) +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [FilterSearchRequest](./search-headless.filtersearchrequest.md) > [verticalKey](./search-headless.filtersearchrequest.verticalkey.md) ## FilterSearchRequest.verticalKey property diff --git a/docs/answers-headless.filtersearchresponse.businessid.md b/docs/search-headless.filtersearchresponse.businessid.md similarity index 51% rename from docs/answers-headless.filtersearchresponse.businessid.md rename to docs/search-headless.filtersearchresponse.businessid.md index 3d477b45..0bc5fbd4 100644 --- a/docs/answers-headless.filtersearchresponse.businessid.md +++ b/docs/search-headless.filtersearchresponse.businessid.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [FilterSearchResponse](./answers-headless.filtersearchresponse.md) > [businessId](./answers-headless.filtersearchresponse.businessid.md) +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [FilterSearchResponse](./search-headless.filtersearchresponse.md) > [businessId](./search-headless.filtersearchresponse.businessid.md) ## FilterSearchResponse.businessId property diff --git a/docs/search-headless.filtersearchresponse.md b/docs/search-headless.filtersearchresponse.md new file mode 100644 index 00000000..bb83b6c4 --- /dev/null +++ b/docs/search-headless.filtersearchresponse.md @@ -0,0 +1,23 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [FilterSearchResponse](./search-headless.filtersearchresponse.md) + +## FilterSearchResponse interface + +The response of a filtersearch request. + +Signature: + +```typescript +export declare interface FilterSearchResponse +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [businessId?](./search-headless.filtersearchresponse.businessid.md) | string | (Optional) ID of the account associated with this Answers experience | +| [queryId?](./search-headless.filtersearchresponse.queryid.md) | string | (Optional) The ID of the search query. | +| [sections](./search-headless.filtersearchresponse.sections.md) | { label?: string; results: [AutocompleteResult](./search-headless.autocompleteresult.md)\[\]; }\[\] | Represents autocomplete results separated by field. | +| [uuid](./search-headless.filtersearchresponse.uuid.md) | string | A unique id which corresponds to the request. | + diff --git a/docs/search-headless.filtersearchresponse.queryid.md b/docs/search-headless.filtersearchresponse.queryid.md new file mode 100644 index 00000000..89f97858 --- /dev/null +++ b/docs/search-headless.filtersearchresponse.queryid.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [FilterSearchResponse](./search-headless.filtersearchresponse.md) > [queryId](./search-headless.filtersearchresponse.queryid.md) + +## FilterSearchResponse.queryId property + +The ID of the search query. + +Signature: + +```typescript +queryId?: string; +``` diff --git a/docs/answers-headless.filtersearchresponse.sections.md b/docs/search-headless.filtersearchresponse.sections.md similarity index 66% rename from docs/answers-headless.filtersearchresponse.sections.md rename to docs/search-headless.filtersearchresponse.sections.md index 08b3cdbb..cac12c14 100644 --- a/docs/answers-headless.filtersearchresponse.sections.md +++ b/docs/search-headless.filtersearchresponse.sections.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [FilterSearchResponse](./answers-headless.filtersearchresponse.md) > [sections](./answers-headless.filtersearchresponse.sections.md) +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [FilterSearchResponse](./search-headless.filtersearchresponse.md) > [sections](./search-headless.filtersearchresponse.sections.md) ## FilterSearchResponse.sections property diff --git a/docs/answers-headless.filtersearchresponse.uuid.md b/docs/search-headless.filtersearchresponse.uuid.md similarity index 50% rename from docs/answers-headless.filtersearchresponse.uuid.md rename to docs/search-headless.filtersearchresponse.uuid.md index 7e764df3..77f5c48e 100644 --- a/docs/answers-headless.filtersearchresponse.uuid.md +++ b/docs/search-headless.filtersearchresponse.uuid.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [FilterSearchResponse](./answers-headless.filtersearchresponse.md) > [uuid](./answers-headless.filtersearchresponse.uuid.md) +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [FilterSearchResponse](./search-headless.filtersearchresponse.md) > [uuid](./search-headless.filtersearchresponse.uuid.md) ## FilterSearchResponse.uuid property diff --git a/docs/answers-headless.filtersstate.facets.md b/docs/search-headless.filtersstate.facets.md similarity index 61% rename from docs/answers-headless.filtersstate.facets.md rename to docs/search-headless.filtersstate.facets.md index a4b5bf00..624a3933 100644 --- a/docs/answers-headless.filtersstate.facets.md +++ b/docs/search-headless.filtersstate.facets.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [FiltersState](./answers-headless.filtersstate.md) > [facets](./answers-headless.filtersstate.facets.md) +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [FiltersState](./search-headless.filtersstate.md) > [facets](./search-headless.filtersstate.facets.md) ## FiltersState.facets property diff --git a/docs/search-headless.filtersstate.md b/docs/search-headless.filtersstate.md new file mode 100644 index 00000000..c2733640 --- /dev/null +++ b/docs/search-headless.filtersstate.md @@ -0,0 +1,21 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [FiltersState](./search-headless.filtersstate.md) + +## FiltersState interface + +Maintains the current state of facets and filters in the application. + +Signature: + +```typescript +export interface FiltersState +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [facets?](./search-headless.filtersstate.facets.md) | [DisplayableFacet](./search-headless.displayablefacet.md)\[\] | (Optional) The dynamic collection of facets that can be applied to filter the search results and whether each of them is currently selected. | +| [static?](./search-headless.filtersstate.static.md) | [SelectableFilter](./search-headless.selectablefilter.md)\[\] | (Optional) The collection of possible static filters that can be applied to the search results and whether each of them is currently selected. | + diff --git a/docs/answers-headless.filtersstate.static.md b/docs/search-headless.filtersstate.static.md similarity index 61% rename from docs/answers-headless.filtersstate.static.md rename to docs/search-headless.filtersstate.static.md index e6719a6b..3539effb 100644 --- a/docs/answers-headless.filtersstate.static.md +++ b/docs/search-headless.filtersstate.static.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [FiltersState](./answers-headless.filtersstate.md) > [static](./answers-headless.filtersstate.static.md) +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [FiltersState](./search-headless.filtersstate.md) > [static](./search-headless.filtersstate.static.md) ## FiltersState.static property diff --git a/docs/search-headless.filtertypes.md b/docs/search-headless.filtertypes.md new file mode 100644 index 00000000..cae75c84 --- /dev/null +++ b/docs/search-headless.filtertypes.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [FilterTypes](./search-headless.filtertypes.md) + +## FilterTypes type + +A union type for the different kinds of filter. + +Signature: + +```typescript +export declare type FilterTypes = Filter | CombinedFilter; +``` +References: [Filter](./search-headless.filter.md), [CombinedFilter](./search-headless.combinedfilter.md) + diff --git a/docs/search-headless.headlessconfig.md b/docs/search-headless.headlessconfig.md new file mode 100644 index 00000000..5b497be7 --- /dev/null +++ b/docs/search-headless.headlessconfig.md @@ -0,0 +1,18 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [HeadlessConfig](./search-headless.headlessconfig.md) + +## HeadlessConfig type + +The configuration for an SearchHeadless instance. + +Signature: + +```typescript +export declare type HeadlessConfig = AnswersConfig & { + headlessId?: string; + verticalKey?: string; +}; +``` +References: [AnswersConfig](./search-headless.answersconfig.md) + diff --git a/docs/answers-headless.highlightedfields.md b/docs/search-headless.highlightedfields.md similarity index 67% rename from docs/answers-headless.highlightedfields.md rename to docs/search-headless.highlightedfields.md index 751270b0..7c523832 100644 --- a/docs/answers-headless.highlightedfields.md +++ b/docs/search-headless.highlightedfields.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [HighlightedFields](./answers-headless.highlightedfields.md) +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [HighlightedFields](./search-headless.highlightedfields.md) ## HighlightedFields type @@ -13,11 +13,11 @@ export declare type HighlightedFields = { [fieldId: string]: HighlightedValue | HighlightedValue[] | HighlightedFields | HighlightedFields[]; }; ``` -References: [HighlightedValue](./answers-headless.highlightedvalue.md), [HighlightedFields](./answers-headless.highlightedfields.md) +References: [HighlightedValue](./search-headless.highlightedvalue.md), [HighlightedFields](./search-headless.highlightedfields.md) ## Remarks -Only fields that have been marked as highlighted will be present - which may not be all fields of the corresponding [Result](./answers-headless.result.md)'s rawData. Fields that are present will match the rawData's structure and order. +Only fields that have been marked as highlighted will be present - which may not be all fields of the corresponding [Result](./search-headless.result.md)'s rawData. Fields that are present will match the rawData's structure and order. ## Example diff --git a/docs/answers-headless.highlightedvalue.matchedsubstrings.md b/docs/search-headless.highlightedvalue.matchedsubstrings.md similarity index 73% rename from docs/answers-headless.highlightedvalue.matchedsubstrings.md rename to docs/search-headless.highlightedvalue.matchedsubstrings.md index c9968d9c..6e53d31d 100644 --- a/docs/answers-headless.highlightedvalue.matchedsubstrings.md +++ b/docs/search-headless.highlightedvalue.matchedsubstrings.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [HighlightedValue](./answers-headless.highlightedvalue.md) > [matchedSubstrings](./answers-headless.highlightedvalue.matchedsubstrings.md) +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [HighlightedValue](./search-headless.highlightedvalue.md) > [matchedSubstrings](./search-headless.highlightedvalue.matchedsubstrings.md) ## HighlightedValue.matchedSubstrings property diff --git a/docs/search-headless.highlightedvalue.md b/docs/search-headless.highlightedvalue.md new file mode 100644 index 00000000..7a3103ad --- /dev/null +++ b/docs/search-headless.highlightedvalue.md @@ -0,0 +1,21 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [HighlightedValue](./search-headless.highlightedvalue.md) + +## HighlightedValue interface + +A field value and its substring matches as emphasized by the Answers API. + +Signature: + +```typescript +export declare interface HighlightedValue +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [matchedSubstrings](./search-headless.highlightedvalue.matchedsubstrings.md) | { length: number; offset: number; }\[\] | An array of substring matches which correspond to the highlighting. | +| [value](./search-headless.highlightedvalue.value.md) | string | The value of the field which should be highlighted. | + diff --git a/docs/answers-headless.highlightedvalue.value.md b/docs/search-headless.highlightedvalue.value.md similarity index 62% rename from docs/answers-headless.highlightedvalue.value.md rename to docs/search-headless.highlightedvalue.value.md index 385cfb61..efe8cef6 100644 --- a/docs/answers-headless.highlightedvalue.value.md +++ b/docs/search-headless.highlightedvalue.value.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [HighlightedValue](./answers-headless.highlightedvalue.md) > [value](./answers-headless.highlightedvalue.value.md) +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [HighlightedValue](./search-headless.highlightedvalue.md) > [value](./search-headless.highlightedvalue.value.md) ## HighlightedValue.value property diff --git a/docs/answers-headless.latlong.latitude.md b/docs/search-headless.latlong.latitude.md similarity index 55% rename from docs/answers-headless.latlong.latitude.md rename to docs/search-headless.latlong.latitude.md index b5033e72..82cda7b1 100644 --- a/docs/answers-headless.latlong.latitude.md +++ b/docs/search-headless.latlong.latitude.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [LatLong](./answers-headless.latlong.md) > [latitude](./answers-headless.latlong.latitude.md) +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [LatLong](./search-headless.latlong.md) > [latitude](./search-headless.latlong.latitude.md) ## LatLong.latitude property diff --git a/docs/answers-headless.latlong.longitude.md b/docs/search-headless.latlong.longitude.md similarity index 55% rename from docs/answers-headless.latlong.longitude.md rename to docs/search-headless.latlong.longitude.md index 3171862c..5532bc2e 100644 --- a/docs/answers-headless.latlong.longitude.md +++ b/docs/search-headless.latlong.longitude.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [LatLong](./answers-headless.latlong.md) > [longitude](./answers-headless.latlong.longitude.md) +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [LatLong](./search-headless.latlong.md) > [longitude](./search-headless.latlong.longitude.md) ## LatLong.longitude property diff --git a/docs/answers-headless.latlong.md b/docs/search-headless.latlong.md similarity index 52% rename from docs/answers-headless.latlong.md rename to docs/search-headless.latlong.md index 0b890049..a2d102c7 100644 --- a/docs/answers-headless.latlong.md +++ b/docs/search-headless.latlong.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [LatLong](./answers-headless.latlong.md) +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [LatLong](./search-headless.latlong.md) ## LatLong interface @@ -20,6 +20,6 @@ If omitted from a request, Yext will attempt to determine the location. | Property | Type | Description | | --- | --- | --- | -| [latitude](./answers-headless.latlong.latitude.md) | number | Latitude formatted as a decimal degree number. | -| [longitude](./answers-headless.latlong.longitude.md) | number | Longitude formatted as a decimal degree number. | +| [latitude](./search-headless.latlong.latitude.md) | number | Latitude formatted as a decimal degree number. | +| [longitude](./search-headless.latlong.longitude.md) | number | Longitude formatted as a decimal degree number. | diff --git a/docs/answers-headless.locationbias.displayname.md b/docs/search-headless.locationbias.displayname.md similarity index 53% rename from docs/answers-headless.locationbias.displayname.md rename to docs/search-headless.locationbias.displayname.md index 529eb959..89fcf509 100644 --- a/docs/answers-headless.locationbias.displayname.md +++ b/docs/search-headless.locationbias.displayname.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [LocationBias](./answers-headless.locationbias.md) > [displayName](./answers-headless.locationbias.displayname.md) +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [LocationBias](./search-headless.locationbias.md) > [displayName](./search-headless.locationbias.displayname.md) ## LocationBias.displayName property diff --git a/docs/search-headless.locationbias.latitude.md b/docs/search-headless.locationbias.latitude.md new file mode 100644 index 00000000..299cbf14 --- /dev/null +++ b/docs/search-headless.locationbias.latitude.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [LocationBias](./search-headless.locationbias.md) > [latitude](./search-headless.locationbias.latitude.md) + +## LocationBias.latitude property + +The location's latitude. + +Signature: + +```typescript +latitude: number; +``` diff --git a/docs/search-headless.locationbias.longitude.md b/docs/search-headless.locationbias.longitude.md new file mode 100644 index 00000000..8fac6da3 --- /dev/null +++ b/docs/search-headless.locationbias.longitude.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [LocationBias](./search-headless.locationbias.md) > [longitude](./search-headless.locationbias.longitude.md) + +## LocationBias.longitude property + +The location's longitude. + +Signature: + +```typescript +longitude: number; +``` diff --git a/docs/search-headless.locationbias.md b/docs/search-headless.locationbias.md new file mode 100644 index 00000000..dd29c7f7 --- /dev/null +++ b/docs/search-headless.locationbias.md @@ -0,0 +1,23 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [LocationBias](./search-headless.locationbias.md) + +## LocationBias interface + +Information about the user's location. + +Signature: + +```typescript +export declare interface LocationBias +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [displayName](./search-headless.locationbias.displayname.md) | string | The name of the location. | +| [latitude](./search-headless.locationbias.latitude.md) | number | The location's latitude. | +| [longitude](./search-headless.locationbias.longitude.md) | number | The location's longitude. | +| [method](./search-headless.locationbias.method.md) | [LocationBiasMethod](./search-headless.locationbiasmethod.md) | The method used to determine the location. | + diff --git a/docs/answers-headless.locationbias.method.md b/docs/search-headless.locationbias.method.md similarity index 53% rename from docs/answers-headless.locationbias.method.md rename to docs/search-headless.locationbias.method.md index 071a1916..a3e4b61c 100644 --- a/docs/answers-headless.locationbias.method.md +++ b/docs/search-headless.locationbias.method.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [LocationBias](./answers-headless.locationbias.md) > [method](./answers-headless.locationbias.method.md) +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [LocationBias](./search-headless.locationbias.md) > [method](./search-headless.locationbias.method.md) ## LocationBias.method property diff --git a/docs/answers-headless.locationbiasmethod.md b/docs/search-headless.locationbiasmethod.md similarity index 77% rename from docs/answers-headless.locationbiasmethod.md rename to docs/search-headless.locationbiasmethod.md index 9265fb33..c2e75d33 100644 --- a/docs/answers-headless.locationbiasmethod.md +++ b/docs/search-headless.locationbiasmethod.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [LocationBiasMethod](./answers-headless.locationbiasmethod.md) +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [LocationBiasMethod](./search-headless.locationbiasmethod.md) ## LocationBiasMethod enum diff --git a/docs/search-headless.locationboundingbox.maxlatitude.md b/docs/search-headless.locationboundingbox.maxlatitude.md new file mode 100644 index 00000000..8c87ab32 --- /dev/null +++ b/docs/search-headless.locationboundingbox.maxlatitude.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [LocationBoundingBox](./search-headless.locationboundingbox.md) > [maxLatitude](./search-headless.locationboundingbox.maxlatitude.md) + +## LocationBoundingBox.maxLatitude property + +The location's highest latitude degree. + +Signature: + +```typescript +maxLatitude: number; +``` diff --git a/docs/search-headless.locationboundingbox.maxlongitude.md b/docs/search-headless.locationboundingbox.maxlongitude.md new file mode 100644 index 00000000..8d40f53d --- /dev/null +++ b/docs/search-headless.locationboundingbox.maxlongitude.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [LocationBoundingBox](./search-headless.locationboundingbox.md) > [maxLongitude](./search-headless.locationboundingbox.maxlongitude.md) + +## LocationBoundingBox.maxLongitude property + +The location's highest longitude degree. + +Signature: + +```typescript +maxLongitude: number; +``` diff --git a/docs/search-headless.locationboundingbox.md b/docs/search-headless.locationboundingbox.md new file mode 100644 index 00000000..e9b15648 --- /dev/null +++ b/docs/search-headless.locationboundingbox.md @@ -0,0 +1,23 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [LocationBoundingBox](./search-headless.locationboundingbox.md) + +## LocationBoundingBox interface + +Location boundaries for a filter with "Place" for its [AppliedQueryFilterType](./search-headless.appliedqueryfiltertype.md). (e.g. boundary for a locality or region specific location filter) + +Signature: + +```typescript +export declare interface LocationBoundingBox +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [maxLatitude](./search-headless.locationboundingbox.maxlatitude.md) | number | The location's highest latitude degree. | +| [maxLongitude](./search-headless.locationboundingbox.maxlongitude.md) | number | The location's highest longitude degree. | +| [minLatitude](./search-headless.locationboundingbox.minlatitude.md) | number | The location's lowest latitude degree. | +| [minLongitude](./search-headless.locationboundingbox.minlongitude.md) | number | The location's lowest longitude degree. | + diff --git a/docs/search-headless.locationboundingbox.minlatitude.md b/docs/search-headless.locationboundingbox.minlatitude.md new file mode 100644 index 00000000..a27c94bb --- /dev/null +++ b/docs/search-headless.locationboundingbox.minlatitude.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [LocationBoundingBox](./search-headless.locationboundingbox.md) > [minLatitude](./search-headless.locationboundingbox.minlatitude.md) + +## LocationBoundingBox.minLatitude property + +The location's lowest latitude degree. + +Signature: + +```typescript +minLatitude: number; +``` diff --git a/docs/search-headless.locationboundingbox.minlongitude.md b/docs/search-headless.locationboundingbox.minlongitude.md new file mode 100644 index 00000000..156f2d3d --- /dev/null +++ b/docs/search-headless.locationboundingbox.minlongitude.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [LocationBoundingBox](./search-headless.locationboundingbox.md) > [minLongitude](./search-headless.locationboundingbox.minlongitude.md) + +## LocationBoundingBox.minLongitude property + +The location's lowest longitude degree. + +Signature: + +```typescript +minLongitude: number; +``` diff --git a/docs/answers-headless.locationfilterdetails.boundingbox.md b/docs/search-headless.locationfilterdetails.boundingbox.md similarity index 50% rename from docs/answers-headless.locationfilterdetails.boundingbox.md rename to docs/search-headless.locationfilterdetails.boundingbox.md index 11c6d17c..e375f26b 100644 --- a/docs/answers-headless.locationfilterdetails.boundingbox.md +++ b/docs/search-headless.locationfilterdetails.boundingbox.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [LocationFilterDetails](./answers-headless.locationfilterdetails.md) > [boundingBox](./answers-headless.locationfilterdetails.boundingbox.md) +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [LocationFilterDetails](./search-headless.locationfilterdetails.md) > [boundingBox](./search-headless.locationfilterdetails.boundingbox.md) ## LocationFilterDetails.boundingBox property diff --git a/docs/answers-headless.locationfilterdetails.featuretypes.md b/docs/search-headless.locationfilterdetails.featuretypes.md similarity index 52% rename from docs/answers-headless.locationfilterdetails.featuretypes.md rename to docs/search-headless.locationfilterdetails.featuretypes.md index 0c2c38f4..ee1396a0 100644 --- a/docs/answers-headless.locationfilterdetails.featuretypes.md +++ b/docs/search-headless.locationfilterdetails.featuretypes.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [LocationFilterDetails](./answers-headless.locationfilterdetails.md) > [featureTypes](./answers-headless.locationfilterdetails.featuretypes.md) +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [LocationFilterDetails](./search-headless.locationfilterdetails.md) > [featureTypes](./search-headless.locationfilterdetails.featuretypes.md) ## LocationFilterDetails.featureTypes property diff --git a/docs/search-headless.locationfilterdetails.latitude.md b/docs/search-headless.locationfilterdetails.latitude.md new file mode 100644 index 00000000..ee73ebf9 --- /dev/null +++ b/docs/search-headless.locationfilterdetails.latitude.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [LocationFilterDetails](./search-headless.locationfilterdetails.md) > [latitude](./search-headless.locationfilterdetails.latitude.md) + +## LocationFilterDetails.latitude property + +The location's latitude. + +Signature: + +```typescript +latitude: number; +``` diff --git a/docs/search-headless.locationfilterdetails.longitude.md b/docs/search-headless.locationfilterdetails.longitude.md new file mode 100644 index 00000000..e8c0647a --- /dev/null +++ b/docs/search-headless.locationfilterdetails.longitude.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [LocationFilterDetails](./search-headless.locationfilterdetails.md) > [longitude](./search-headless.locationfilterdetails.longitude.md) + +## LocationFilterDetails.longitude property + +The location's longitude. + +Signature: + +```typescript +longitude: number; +``` diff --git a/docs/search-headless.locationfilterdetails.md b/docs/search-headless.locationfilterdetails.md new file mode 100644 index 00000000..d4a49e57 --- /dev/null +++ b/docs/search-headless.locationfilterdetails.md @@ -0,0 +1,24 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [LocationFilterDetails](./search-headless.locationfilterdetails.md) + +## LocationFilterDetails interface + +Additional details relevant to the filter with "PLACE" for its [AppliedQueryFilterType](./search-headless.appliedqueryfiltertype.md). + +Signature: + +```typescript +export declare interface LocationFilterDetails +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [boundingBox?](./search-headless.locationfilterdetails.boundingbox.md) | [LocationBoundingBox](./search-headless.locationboundingbox.md) | (Optional) The location's coordinate boundaries. | +| [featureTypes](./search-headless.locationfilterdetails.featuretypes.md) | string\[\] | The location's classification (e.g. locality, region, address). | +| [latitude](./search-headless.locationfilterdetails.latitude.md) | number | The location's latitude. | +| [longitude](./search-headless.locationfilterdetails.longitude.md) | number | The location's longitude. | +| [placeName](./search-headless.locationfilterdetails.placename.md) | string | The location's name. | + diff --git a/docs/search-headless.locationfilterdetails.placename.md b/docs/search-headless.locationfilterdetails.placename.md new file mode 100644 index 00000000..aee3f883 --- /dev/null +++ b/docs/search-headless.locationfilterdetails.placename.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [LocationFilterDetails](./search-headless.locationfilterdetails.md) > [placeName](./search-headless.locationfilterdetails.placename.md) + +## LocationFilterDetails.placeName property + +The location's name. + +Signature: + +```typescript +placeName: string; +``` diff --git a/docs/answers-headless.locationstate.locationbias.md b/docs/search-headless.locationstate.locationbias.md similarity index 56% rename from docs/answers-headless.locationstate.locationbias.md rename to docs/search-headless.locationstate.locationbias.md index 5487450b..bcabbf02 100644 --- a/docs/answers-headless.locationstate.locationbias.md +++ b/docs/search-headless.locationstate.locationbias.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [LocationState](./answers-headless.locationstate.md) > [locationBias](./answers-headless.locationstate.locationbias.md) +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [LocationState](./search-headless.locationstate.md) > [locationBias](./search-headless.locationstate.locationbias.md) ## LocationState.locationBias property diff --git a/docs/search-headless.locationstate.md b/docs/search-headless.locationstate.md new file mode 100644 index 00000000..aa922ad1 --- /dev/null +++ b/docs/search-headless.locationstate.md @@ -0,0 +1,21 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [LocationState](./search-headless.locationstate.md) + +## LocationState interface + +Maintains the user's location, if given, or the inferred location, that is used to bias search results. + +Signature: + +```typescript +export interface LocationState +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [locationBias?](./search-headless.locationstate.locationbias.md) | [LocationBias](./search-headless.locationbias.md) | (Optional) The geographical location bias used in the search, returned from the Answers API. | +| [userLocation?](./search-headless.locationstate.userlocation.md) | [LatLong](./search-headless.latlong.md) | (Optional) The latitude and longitude of the user making the request. Used to bias the results. | + diff --git a/docs/answers-headless.locationstate.userlocation.md b/docs/search-headless.locationstate.userlocation.md similarity index 55% rename from docs/answers-headless.locationstate.userlocation.md rename to docs/search-headless.locationstate.userlocation.md index 5bf25b8a..be8bcf40 100644 --- a/docs/answers-headless.locationstate.userlocation.md +++ b/docs/search-headless.locationstate.userlocation.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [LocationState](./answers-headless.locationstate.md) > [userLocation](./answers-headless.locationstate.userlocation.md) +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [LocationState](./search-headless.locationstate.md) > [userLocation](./search-headless.locationstate.userlocation.md) ## LocationState.userLocation property diff --git a/docs/search-headless.lowernumberrangelimit.matcher.md b/docs/search-headless.lowernumberrangelimit.matcher.md new file mode 100644 index 00000000..ef93e61d --- /dev/null +++ b/docs/search-headless.lowernumberrangelimit.matcher.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [LowerNumberRangeLimit](./search-headless.lowernumberrangelimit.md) > [matcher](./search-headless.lowernumberrangelimit.matcher.md) + +## LowerNumberRangeLimit.matcher property + +[Matcher](./search-headless.matcher.md) for the start limit + +Signature: + +```typescript +matcher: Matcher.GreaterThan | Matcher.GreaterThanOrEqualTo; +``` diff --git a/docs/search-headless.lowernumberrangelimit.md b/docs/search-headless.lowernumberrangelimit.md new file mode 100644 index 00000000..7dce155f --- /dev/null +++ b/docs/search-headless.lowernumberrangelimit.md @@ -0,0 +1,21 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [LowerNumberRangeLimit](./search-headless.lowernumberrangelimit.md) + +## LowerNumberRangeLimit interface + +The start limit of [NumberRangeValue](./search-headless.numberrangevalue.md). + +Signature: + +```typescript +export declare interface LowerNumberRangeLimit +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [matcher](./search-headless.lowernumberrangelimit.matcher.md) | [Matcher.GreaterThan](./search-headless.matcher.md) \| [Matcher.GreaterThanOrEqualTo](./search-headless.matcher.md) | [Matcher](./search-headless.matcher.md) for the start limit | +| [value](./search-headless.lowernumberrangelimit.value.md) | number | Value of the limit. | + diff --git a/docs/search-headless.lowernumberrangelimit.value.md b/docs/search-headless.lowernumberrangelimit.value.md new file mode 100644 index 00000000..1966fdfc --- /dev/null +++ b/docs/search-headless.lowernumberrangelimit.value.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [LowerNumberRangeLimit](./search-headless.lowernumberrangelimit.md) > [value](./search-headless.lowernumberrangelimit.value.md) + +## LowerNumberRangeLimit.value property + +Value of the limit. + +Signature: + +```typescript +value: number; +``` diff --git a/docs/answers-headless.matcher.md b/docs/search-headless.matcher.md similarity index 87% rename from docs/answers-headless.matcher.md rename to docs/search-headless.matcher.md index df98ca16..452cc346 100644 --- a/docs/answers-headless.matcher.md +++ b/docs/search-headless.matcher.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [Matcher](./answers-headless.matcher.md) +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [Matcher](./search-headless.matcher.md) ## Matcher enum diff --git a/docs/search-headless.md b/docs/search-headless.md new file mode 100644 index 00000000..256a0f3f --- /dev/null +++ b/docs/search-headless.md @@ -0,0 +1,147 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) + +## search-headless package + +## Classes + +| Class | Description | +| --- | --- | +| [AnswersCore](./search-headless.answerscore.md) | Provides methods for executing searches, submitting questions, and performing autocompletes. | +| [AnswersError](./search-headless.answerserror.md) | Represents an error | +| [SearchHeadless](./search-headless.searchheadless.md) | Provides the functionality for interacting with an Answers Search experience. | + +## Enumerations + +| Enumeration | Description | +| --- | --- | +| [AppliedQueryFilterType](./search-headless.appliedqueryfiltertype.md) | Represents the type of [AppliedQueryFilter](./search-headless.appliedqueryfilter.md) applied to a search. | +| [DirectAnswerType](./search-headless.directanswertype.md) | Represents the type of direct answer. | +| [Direction](./search-headless.direction.md) | The direction of a sort. | +| [ErrorType](./search-headless.errortype.md) | Identifier for the type of error causing the failure. | +| [FilterCombinator](./search-headless.filtercombinator.md) | Indicates how the filters in a [CombinedFilter](./search-headless.combinedfilter.md) should be combined. | +| [LocationBiasMethod](./search-headless.locationbiasmethod.md) | The method used to determine the location. | +| [Matcher](./search-headless.matcher.md) | A Matcher is a filtering operation. | +| [QuerySource](./search-headless.querysource.md) | The source of the search request. | +| [QueryTrigger](./search-headless.querytrigger.md) | Describes the ways a search can be executed besides user input. | +| [SearchIntent](./search-headless.searchintent.md) | Represents intents from the Answers API. | +| [SearchTypeEnum](./search-headless.searchtypeenum.md) | An enum which indicates the type of search that Headless is managing. | +| [SortType](./search-headless.sorttype.md) | The method of sorting. | +| [Source](./search-headless.source.md) | Represents the source of a [Result](./search-headless.result.md). | +| [SpellCheckType](./search-headless.spellchecktype.md) | Represents the type of spell check performed. | + +## Functions + +| Function | Description | +| --- | --- | +| [combineFilters(filterA, filterB, combinator)](./search-headless.combinefilters.md) | Creates a [CombinedFilter](./search-headless.combinedfilter.md) by applying the specified [FilterCombinator](./search-headless.filtercombinator.md) to the two filters. | +| [createDateRangeFilter(fieldId, range)](./search-headless.createdaterangefilter.md) | Creates a [Filter](./search-headless.filter.md) or [CombinedFilter](./search-headless.combinedfilter.md) that matches all results where the given field value falls in a specific Date [BoundedRange](./search-headless.boundedrange.md). | +| [createEqualsFilter(fieldId, value)](./search-headless.createequalsfilter.md) | Creates a simple [Filter](./search-headless.filter.md) that ensures all results will match a specific field value. | +| [createNearMeFilter(position)](./search-headless.createnearmefilter.md) | Creates a [Filter](./search-headless.filter.md) that matches all results within a certain radius of the given position. | +| [createNumberRangeFilter(fieldId, range)](./search-headless.createnumberrangefilter.md) | Creates a [Filter](./search-headless.filter.md) or [CombinedFilter](./search-headless.combinedfilter.md) that matches all results where the given field value falls in a specific number [BoundedRange](./search-headless.boundedrange.md). | +| [provideSearchHeadless(config)](./search-headless.providesearchheadless.md) | Supplies a new instance of [SearchHeadless](./search-headless.searchheadless.md), using the provided configuration. | + +## Interfaces + +| Interface | Description | +| --- | --- | +| [AdditionalHttpHeaders](./search-headless.additionalhttpheaders.md) | AdditionalHttpHeaders allows users to specify additional values for specific HTTP headers. | +| [AllResultsForVertical](./search-headless.allresultsforvertical.md) | Represents all results for the current vertical. | +| [AnswersConfigWithApiKey](./search-headless.answersconfigwithapikey.md) | Configuration options for [AnswersCore](./search-headless.answerscore.md), which includes the options from [BaseAnswersConfig](./search-headless.baseanswersconfig.md), but requires apiKey. | +| [AnswersConfigWithToken](./search-headless.answersconfigwithtoken.md) | Configuration options for [AnswersCore](./search-headless.answerscore.md), which includes the options from [BaseAnswersConfig](./search-headless.baseanswersconfig.md), but requires token. | +| [AnswersRequest](./search-headless.answersrequest.md) | Options for an Answers API request. | +| [AppliedQueryFilter](./search-headless.appliedqueryfilter.md) | A filter that the Answers API applied to the search. | +| [AutocompleteResponse](./search-headless.autocompleteresponse.md) | The response of a universal or vertical autocomplete request. | +| [AutocompleteResult](./search-headless.autocompleteresult.md) | An autocomplete suggestion. | +| [AutocompleteService](./search-headless.autocompleteservice.md) | A service for autocomplete requests. | +| [BaseAnswersConfig](./search-headless.baseanswersconfig.md) | The base configuration options for [AnswersCore](./search-headless.answerscore.md). | +| [BoundedRange](./search-headless.boundedrange.md) | An interface representing a range of values of type T. | +| [ClientSDKHeaderValues](./search-headless.clientsdkheadervalues.md) | Additional agents and their versions used to create the Answers experience. The information for these agents is added to the Client-SDK HTTP header along with that of the ANSWERS\_CORE agent. | +| [CombinedFilter](./search-headless.combinedfilter.md) | Represents multiple filters that will be combined to refine results. | +| [DirectAnswer](./search-headless.directanswer.md) | A direct answer to a search. | +| [DirectAnswerState](./search-headless.directanswerstate.md) | Maintains the direct answer associated with the latest search. | +| [DisplayableFacet](./search-headless.displayablefacet.md) | A [Facet](./search-headless.facet.md) which contains extra fields meant to be displayed to the end user. | +| [DisplayableFacetOption](./search-headless.displayablefacetoption.md) | A [FacetOption](./search-headless.facetoption.md) with extra data meant to be displayed to the end user. | +| [Endpoints](./search-headless.endpoints.md) | Overrides for the URLs which are used when making requests to the Answers API. | +| [Facet](./search-headless.facet.md) | Represents dynamic filter options for the Answers API. | +| [FacetOption](./search-headless.facetoption.md) | A filter associated with the facet. | +| [FailedVertical](./search-headless.failedvertical.md) | Error information from when a vertical fails to return results. | +| [FeaturedSnippetDirectAnswer](./search-headless.featuredsnippetdirectanswer.md) | A direct answer which was found within a document. | +| [FieldValueDirectAnswer](./search-headless.fieldvaluedirectanswer.md) | A direct answer where the answer came from a field from the knowledge graph. | +| [Filter](./search-headless.filter.md) | Represents a filter which compares values to a single field. | +| [FilterSearchRequest](./search-headless.filtersearchrequest.md) | Options for a filtersearch request. | +| [FilterSearchResponse](./search-headless.filtersearchresponse.md) | The response of a filtersearch request. | +| [FiltersState](./search-headless.filtersstate.md) | Maintains the current state of facets and filters in the application. | +| [HighlightedValue](./search-headless.highlightedvalue.md) | A field value and its substring matches as emphasized by the Answers API. | +| [LatLong](./search-headless.latlong.md) | The latitude and longitude of the user making the request. Used to bias the results. | +| [LocationBias](./search-headless.locationbias.md) | Information about the user's location. | +| [LocationBoundingBox](./search-headless.locationboundingbox.md) | Location boundaries for a filter with "Place" for its [AppliedQueryFilterType](./search-headless.appliedqueryfiltertype.md). (e.g. boundary for a locality or region specific location filter) | +| [LocationFilterDetails](./search-headless.locationfilterdetails.md) | Additional details relevant to the filter with "PLACE" for its [AppliedQueryFilterType](./search-headless.appliedqueryfiltertype.md). | +| [LocationState](./search-headless.locationstate.md) | Maintains the user's location, if given, or the inferred location, that is used to bias search results. | +| [LowerNumberRangeLimit](./search-headless.lowernumberrangelimit.md) | The start limit of [NumberRangeValue](./search-headless.numberrangevalue.md). | +| [MetaState](./search-headless.metastate.md) | Maintains the metadata for Answers Headless. | +| [NearFilterValue](./search-headless.nearfiltervalue.md) | A filter value for a filter with a $near [Matcher](./search-headless.matcher.md). | +| [NumberRangeValue](./search-headless.numberrangevalue.md) | A filter value for a filter with a $between [Matcher](./search-headless.matcher.md). | +| [ParentState](./search-headless.parentstate.md) | The overall shape of the redux state tree, with each key value pair of headlessId to [State](./search-headless.state.md) representing a single SearchHeadless instance. | +| [QueryRulesActionsData](./search-headless.queryrulesactionsdata.md) | Data returned from the Answers query rules system. | +| [QueryRulesState](./search-headless.queryrulesstate.md) | Maintains the data from the triggered query rules. | +| [QueryState](./search-headless.querystate.md) | Maintains the latest query and its associated data. | +| [QuestionSubmissionRequest](./search-headless.questionsubmissionrequest.md) | Options for a QuestionSubmission request. | +| [QuestionSubmissionResponse](./search-headless.questionsubmissionresponse.md) | A representation of a question submission response. | +| [QuestionSubmissionService](./search-headless.questionsubmissionservice.md) | Submits a custom question to the Answers API. | +| [RangeBoundary](./search-headless.rangeboundary.md) | A boundary for a [BoundedRange](./search-headless.boundedrange.md) of type T. | +| [Result](./search-headless.result.md) | An individual search result. | +| [SearchParameterField](./search-headless.searchparameterfield.md) | Indicates which entity field to perform the autocomplete request on. | +| [SearchService](./search-headless.searchservice.md) | A service which performs Yext Answers searches | +| [SearchStatusState](./search-headless.searchstatusstate.md) | Maintains the status of the latest search. | +| [SelectableFilter](./search-headless.selectablefilter.md) | A [Filter](./search-headless.filter.md) with additional information, such as an optional display name and whether or not it is selected. | +| [SessionTrackingState](./search-headless.sessiontrackingstate.md) | Maintains whether the user session should be tracked and, if so, the session information. | +| [Snippet](./search-headless.snippet.md) | The section of text where a [FeaturedSnippetDirectAnswer](./search-headless.featuredsnippetdirectanswer.md) was found. | +| [SortBy](./search-headless.sortby.md) | Represents a criterion that can be used to sort results. | +| [SpellCheck](./search-headless.spellcheck.md) | A spellcheck response from a search query. | +| [SpellCheckState](./search-headless.spellcheckstate.md) | Maintains whether spellcheck is enabled and the spellcheck response from the latest search. | +| [State](./search-headless.state.md) | The state representing a SearchHeadless instance. | +| [StateListener](./search-headless.statelistener.md) | Represents a listener for a specific value of type T in the state. | +| [StateManager](./search-headless.statemanager.md) | Manages the information contained in the state for an SearchHeadless instance. | +| [UniversalAutocompleteRequest](./search-headless.universalautocompleterequest.md) | Options for a universal autocomplete request. | +| [UniversalLimit](./search-headless.universallimit.md) | The maximum limit of results per vertical. Each limit can be set from 1-50, inclusive. | +| [UniversalSearchRequest](./search-headless.universalsearchrequest.md) | Options which can be specified for a universal search. | +| [UniversalSearchResponse](./search-headless.universalsearchresponse.md) | A representation of a response from a universal search. | +| [UniversalSearchState](./search-headless.universalsearchstate.md) | Maintains the data for the latest universal search. | +| [UpperNumberRangeLimit](./search-headless.uppernumberrangelimit.md) | The end limit of [NumberRangeValue](./search-headless.numberrangevalue.md). | +| [VerticalAutocompleteRequest](./search-headless.verticalautocompleterequest.md) | Options for a vertial autocomplete request. | +| [VerticalResults](./search-headless.verticalresults.md) | Represents results from a search vertical. | +| [VerticalSearchRequest](./search-headless.verticalsearchrequest.md) | Options which can be specified for a vertical search. | +| [VerticalSearchResponse](./search-headless.verticalsearchresponse.md) | A representation of a response from a vertical search. | +| [VerticalSearchState](./search-headless.verticalsearchstate.md) | Maintains the data for the latest vertical search. | +| [Visitor](./search-headless.visitor.md) | Information used to associate requests with a particular user. | + +## Namespaces + +| Namespace | Description | +| --- | --- | +| [searchUtilities](./search-headless.searchutilities.md) | | + +## Variables + +| Variable | Description | +| --- | --- | +| [AnswersHeadless](./search-headless.answersheadless.md) | | +| [answersUtilities](./search-headless.answersutilities.md) | | +| [DEFAULT\_HEADLESS\_ID](./search-headless.default_headless_id.md) | The headlessId automatically given to the first SearchHeadless instance created. | +| [provideAnswersHeadless](./search-headless.provideanswersheadless.md) | Supplies a new instance of [SearchHeadless](./search-headless.searchheadless.md), using the provided configuration. | +| [SandboxEndpoints](./search-headless.sandboxendpoints.md) | The endpoints to use for sandbox experiences. | + +## Type Aliases + +| Type Alias | Description | +| --- | --- | +| [AnswersConfig](./search-headless.answersconfig.md) | The main configuration options for [AnswersCore](./search-headless.answerscore.md). For a full description of the options, see [BaseAnswersConfig](./search-headless.baseanswersconfig.md). The config requires either an apiKey or a token. | +| [Context](./search-headless.context.md) | Used to trigger Answers [Query Rules](https://hitchhikers.yext.com/tracks/answers-advanced/ans302-query-rules/). | +| [EnumOrLiteral](./search-headless.enumorliteral.md) | Produces a union type from the enum passed as a generic which consists of the enum values and the string literals of the enum. | +| [FilterTypes](./search-headless.filtertypes.md) | A union type for the different kinds of filter. | +| [HeadlessConfig](./search-headless.headlessconfig.md) | The configuration for an SearchHeadless instance. | +| [HighlightedFields](./search-headless.highlightedfields.md) | A mapping of fields to the values emphasized by the Answers API | +| [SearchType](./search-headless.searchtype.md) | An enum and its corresponding string literals which indicate the type of search that Headless is managing. | + diff --git a/docs/answers-headless.metastate.context.md b/docs/search-headless.metastate.context.md similarity index 63% rename from docs/answers-headless.metastate.context.md rename to docs/search-headless.metastate.context.md index 32e7e2d2..b6f2b755 100644 --- a/docs/answers-headless.metastate.context.md +++ b/docs/search-headless.metastate.context.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [MetaState](./answers-headless.metastate.md) > [context](./answers-headless.metastate.context.md) +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [MetaState](./search-headless.metastate.md) > [context](./search-headless.metastate.context.md) ## MetaState.context property diff --git a/docs/search-headless.metastate.md b/docs/search-headless.metastate.md new file mode 100644 index 00000000..1d19d501 --- /dev/null +++ b/docs/search-headless.metastate.md @@ -0,0 +1,23 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [MetaState](./search-headless.metastate.md) + +## MetaState interface + +Maintains the metadata for Answers Headless. + +Signature: + +```typescript +export interface MetaState +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [context?](./search-headless.metastate.context.md) | [Context](./search-headless.context.md) | (Optional) A JSON object used for passing data to and triggering Answers [Query Rules](https://hitchhikers.yext.com/tracks/answers-advanced/ans302-query-rules/). | +| [referrerPageUrl?](./search-headless.metastate.referrerpageurl.md) | string | (Optional) The URL of the referring page (the page that directed to the current page from which the request was made). | +| [searchType](./search-headless.metastate.searchtype.md) | [SearchType](./search-headless.searchtype.md) | Indicates the type of search that Answers Headless is managing. | +| [uuid?](./search-headless.metastate.uuid.md) | string | (Optional) A unique id which corresponds to the latest request/response. | + diff --git a/docs/answers-headless.metastate.referrerpageurl.md b/docs/search-headless.metastate.referrerpageurl.md similarity index 58% rename from docs/answers-headless.metastate.referrerpageurl.md rename to docs/search-headless.metastate.referrerpageurl.md index e0eb2696..df2de080 100644 --- a/docs/answers-headless.metastate.referrerpageurl.md +++ b/docs/search-headless.metastate.referrerpageurl.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [MetaState](./answers-headless.metastate.md) > [referrerPageUrl](./answers-headless.metastate.referrerpageurl.md) +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [MetaState](./search-headless.metastate.md) > [referrerPageUrl](./search-headless.metastate.referrerpageurl.md) ## MetaState.referrerPageUrl property diff --git a/docs/answers-headless.metastate.searchtype.md b/docs/search-headless.metastate.searchtype.md similarity index 55% rename from docs/answers-headless.metastate.searchtype.md rename to docs/search-headless.metastate.searchtype.md index ffcf4d30..4433a40b 100644 --- a/docs/answers-headless.metastate.searchtype.md +++ b/docs/search-headless.metastate.searchtype.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [MetaState](./answers-headless.metastate.md) > [searchType](./answers-headless.metastate.searchtype.md) +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [MetaState](./search-headless.metastate.md) > [searchType](./search-headless.metastate.searchtype.md) ## MetaState.searchType property diff --git a/docs/answers-headless.metastate.uuid.md b/docs/search-headless.metastate.uuid.md similarity index 54% rename from docs/answers-headless.metastate.uuid.md rename to docs/search-headless.metastate.uuid.md index 392d355f..223096b5 100644 --- a/docs/answers-headless.metastate.uuid.md +++ b/docs/search-headless.metastate.uuid.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [MetaState](./answers-headless.metastate.md) > [uuid](./answers-headless.metastate.uuid.md) +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [MetaState](./search-headless.metastate.md) > [uuid](./search-headless.metastate.uuid.md) ## MetaState.uuid property diff --git a/docs/search-headless.nearfiltervalue.lat.md b/docs/search-headless.nearfiltervalue.lat.md new file mode 100644 index 00000000..c7143101 --- /dev/null +++ b/docs/search-headless.nearfiltervalue.lat.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [NearFilterValue](./search-headless.nearfiltervalue.md) > [lat](./search-headless.nearfiltervalue.lat.md) + +## NearFilterValue.lat property + +The latitude of the location. + +Signature: + +```typescript +lat: number; +``` diff --git a/docs/search-headless.nearfiltervalue.lng.md b/docs/search-headless.nearfiltervalue.lng.md new file mode 100644 index 00000000..312efee0 --- /dev/null +++ b/docs/search-headless.nearfiltervalue.lng.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [NearFilterValue](./search-headless.nearfiltervalue.md) > [lng](./search-headless.nearfiltervalue.lng.md) + +## NearFilterValue.lng property + +The longitude of the location. + +Signature: + +```typescript +lng: number; +``` diff --git a/docs/search-headless.nearfiltervalue.md b/docs/search-headless.nearfiltervalue.md new file mode 100644 index 00000000..3c98a009 --- /dev/null +++ b/docs/search-headless.nearfiltervalue.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [NearFilterValue](./search-headless.nearfiltervalue.md) + +## NearFilterValue interface + +A filter value for a filter with a $near [Matcher](./search-headless.matcher.md). + +Signature: + +```typescript +export declare interface NearFilterValue +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [lat](./search-headless.nearfiltervalue.lat.md) | number | The latitude of the location. | +| [lng](./search-headless.nearfiltervalue.lng.md) | number | The longitude of the location. | +| [radius](./search-headless.nearfiltervalue.radius.md) | number | The radius (in meters) around the latitude and longitude. | + diff --git a/docs/answers-headless.nearfiltervalue.radius.md b/docs/search-headless.nearfiltervalue.radius.md similarity index 52% rename from docs/answers-headless.nearfiltervalue.radius.md rename to docs/search-headless.nearfiltervalue.radius.md index 71c9b851..22f8b811 100644 --- a/docs/answers-headless.nearfiltervalue.radius.md +++ b/docs/search-headless.nearfiltervalue.radius.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [NearFilterValue](./answers-headless.nearfiltervalue.md) > [radius](./answers-headless.nearfiltervalue.radius.md) +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [NearFilterValue](./search-headless.nearfiltervalue.md) > [radius](./search-headless.nearfiltervalue.radius.md) ## NearFilterValue.radius property diff --git a/docs/answers-headless.numberrangevalue.end.md b/docs/search-headless.numberrangevalue.end.md similarity index 52% rename from docs/answers-headless.numberrangevalue.end.md rename to docs/search-headless.numberrangevalue.end.md index 5833ef9a..16d5a668 100644 --- a/docs/answers-headless.numberrangevalue.end.md +++ b/docs/search-headless.numberrangevalue.end.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [NumberRangeValue](./answers-headless.numberrangevalue.md) > [end](./answers-headless.numberrangevalue.end.md) +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [NumberRangeValue](./search-headless.numberrangevalue.md) > [end](./search-headless.numberrangevalue.end.md) ## NumberRangeValue.end property diff --git a/docs/search-headless.numberrangevalue.md b/docs/search-headless.numberrangevalue.md new file mode 100644 index 00000000..ae974a5e --- /dev/null +++ b/docs/search-headless.numberrangevalue.md @@ -0,0 +1,21 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [NumberRangeValue](./search-headless.numberrangevalue.md) + +## NumberRangeValue interface + +A filter value for a filter with a $between [Matcher](./search-headless.matcher.md). + +Signature: + +```typescript +export declare interface NumberRangeValue +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [end?](./search-headless.numberrangevalue.end.md) | [UpperNumberRangeLimit](./search-headless.uppernumberrangelimit.md) | (Optional) End limit of the number range value. | +| [start?](./search-headless.numberrangevalue.start.md) | [LowerNumberRangeLimit](./search-headless.lowernumberrangelimit.md) | (Optional) Start limit of the number range value. | + diff --git a/docs/answers-headless.numberrangevalue.start.md b/docs/search-headless.numberrangevalue.start.md similarity index 52% rename from docs/answers-headless.numberrangevalue.start.md rename to docs/search-headless.numberrangevalue.start.md index 4446757c..a116629c 100644 --- a/docs/answers-headless.numberrangevalue.start.md +++ b/docs/search-headless.numberrangevalue.start.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [NumberRangeValue](./answers-headless.numberrangevalue.md) > [start](./answers-headless.numberrangevalue.start.md) +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [NumberRangeValue](./search-headless.numberrangevalue.md) > [start](./search-headless.numberrangevalue.start.md) ## NumberRangeValue.start property diff --git a/docs/search-headless.parentstate.md b/docs/search-headless.parentstate.md new file mode 100644 index 00000000..1596a139 --- /dev/null +++ b/docs/search-headless.parentstate.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [ParentState](./search-headless.parentstate.md) + +## ParentState interface + +The overall shape of the redux state tree, with each key value pair of headlessId to [State](./search-headless.state.md) representing a single SearchHeadless instance. + +Signature: + +```typescript +export interface ParentState +``` diff --git a/docs/search-headless.provideanswersheadless.md b/docs/search-headless.provideanswersheadless.md new file mode 100644 index 00000000..4f11d485 --- /dev/null +++ b/docs/search-headless.provideanswersheadless.md @@ -0,0 +1,18 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [provideAnswersHeadless](./search-headless.provideanswersheadless.md) + +## provideAnswersHeadless variable + +> Warning: This API is now obsolete. +> +> provideAnswersHeadless has been deprecated and renamed to provideSearchHeadless +> + +Supplies a new instance of [SearchHeadless](./search-headless.searchheadless.md), using the provided configuration. + +Signature: + +```typescript +provideAnswersHeadless: typeof provideSearchHeadless +``` diff --git a/docs/search-headless.providesearchheadless.md b/docs/search-headless.providesearchheadless.md new file mode 100644 index 00000000..12209bb7 --- /dev/null +++ b/docs/search-headless.providesearchheadless.md @@ -0,0 +1,26 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [provideSearchHeadless](./search-headless.providesearchheadless.md) + +## provideSearchHeadless() function + +Supplies a new instance of [SearchHeadless](./search-headless.searchheadless.md), using the provided configuration. + +Signature: + +```typescript +export declare function provideSearchHeadless(config: HeadlessConfig): SearchHeadless; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| config | [HeadlessConfig](./search-headless.headlessconfig.md) | The apiKey, experienceKey, etc. needed to set up a front-end Answers experience. | + +Returns: + +SearchHeadless + +The newly created instance of [SearchHeadless](./search-headless.searchheadless.md) + diff --git a/docs/answers-headless.queryrulesactionsdata.data.md b/docs/search-headless.queryrulesactionsdata.data.md similarity index 51% rename from docs/answers-headless.queryrulesactionsdata.data.md rename to docs/search-headless.queryrulesactionsdata.data.md index a205fc69..ecf3a7e3 100644 --- a/docs/answers-headless.queryrulesactionsdata.data.md +++ b/docs/search-headless.queryrulesactionsdata.data.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [QueryRulesActionsData](./answers-headless.queryrulesactionsdata.md) > [data](./answers-headless.queryrulesactionsdata.data.md) +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [QueryRulesActionsData](./search-headless.queryrulesactionsdata.md) > [data](./search-headless.queryrulesactionsdata.data.md) ## QueryRulesActionsData.data property diff --git a/docs/answers-headless.queryrulesactionsdata.errors.md b/docs/search-headless.queryrulesactionsdata.errors.md similarity index 56% rename from docs/answers-headless.queryrulesactionsdata.errors.md rename to docs/search-headless.queryrulesactionsdata.errors.md index f551edf2..0e8385ac 100644 --- a/docs/answers-headless.queryrulesactionsdata.errors.md +++ b/docs/search-headless.queryrulesactionsdata.errors.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [QueryRulesActionsData](./answers-headless.queryrulesactionsdata.md) > [errors](./answers-headless.queryrulesactionsdata.errors.md) +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [QueryRulesActionsData](./search-headless.queryrulesactionsdata.md) > [errors](./search-headless.queryrulesactionsdata.errors.md) ## QueryRulesActionsData.errors property diff --git a/docs/search-headless.queryrulesactionsdata.key.md b/docs/search-headless.queryrulesactionsdata.key.md new file mode 100644 index 00000000..f2b740a0 --- /dev/null +++ b/docs/search-headless.queryrulesactionsdata.key.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [QueryRulesActionsData](./search-headless.queryrulesactionsdata.md) > [key](./search-headless.queryrulesactionsdata.key.md) + +## QueryRulesActionsData.key property + +The unique identifier for this query rule. + +Signature: + +```typescript +key: string; +``` diff --git a/docs/search-headless.queryrulesactionsdata.md b/docs/search-headless.queryrulesactionsdata.md new file mode 100644 index 00000000..9733adc1 --- /dev/null +++ b/docs/search-headless.queryrulesactionsdata.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [QueryRulesActionsData](./search-headless.queryrulesactionsdata.md) + +## QueryRulesActionsData interface + +Data returned from the Answers query rules system. + +Signature: + +```typescript +export declare interface QueryRulesActionsData +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [data?](./search-headless.queryrulesactionsdata.data.md) | Record<string, unknown> | (Optional) The data returned from the query rule. | +| [errors?](./search-headless.queryrulesactionsdata.errors.md) | { uuid: string; type: string; message?: string; }\[\] | (Optional) Any errors returned from the query rule. | +| [key](./search-headless.queryrulesactionsdata.key.md) | string | The unique identifier for this query rule. | + diff --git a/docs/answers-headless.queryrulesstate.actions.md b/docs/search-headless.queryrulesstate.actions.md similarity index 54% rename from docs/answers-headless.queryrulesstate.actions.md rename to docs/search-headless.queryrulesstate.actions.md index e277bd90..3c1597ab 100644 --- a/docs/answers-headless.queryrulesstate.actions.md +++ b/docs/search-headless.queryrulesstate.actions.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [QueryRulesState](./answers-headless.queryrulesstate.md) > [actions](./answers-headless.queryrulesstate.actions.md) +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [QueryRulesState](./search-headless.queryrulesstate.md) > [actions](./search-headless.queryrulesstate.actions.md) ## QueryRulesState.actions property diff --git a/docs/search-headless.queryrulesstate.md b/docs/search-headless.queryrulesstate.md new file mode 100644 index 00000000..5b2557bc --- /dev/null +++ b/docs/search-headless.queryrulesstate.md @@ -0,0 +1,20 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [QueryRulesState](./search-headless.queryrulesstate.md) + +## QueryRulesState interface + +Maintains the data from the triggered query rules. + +Signature: + +```typescript +export interface QueryRulesState +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [actions](./search-headless.queryrulesstate.actions.md) | [QueryRulesActionsData](./search-headless.queryrulesactionsdata.md)\[\] | Any actions triggered by meeting criteria for query rules. | + diff --git a/docs/answers-headless.querysource.md b/docs/search-headless.querysource.md similarity index 81% rename from docs/answers-headless.querysource.md rename to docs/search-headless.querysource.md index 3ea8b97c..191cffe1 100644 --- a/docs/answers-headless.querysource.md +++ b/docs/search-headless.querysource.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [QuerySource](./answers-headless.querysource.md) +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [QuerySource](./search-headless.querysource.md) ## QuerySource enum diff --git a/docs/answers-headless.querystate.input.md b/docs/search-headless.querystate.input.md similarity index 52% rename from docs/answers-headless.querystate.input.md rename to docs/search-headless.querystate.input.md index ce446bbe..b9328b12 100644 --- a/docs/answers-headless.querystate.input.md +++ b/docs/search-headless.querystate.input.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [QueryState](./answers-headless.querystate.md) > [input](./answers-headless.querystate.input.md) +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [QueryState](./search-headless.querystate.md) > [input](./search-headless.querystate.input.md) ## QueryState.input property diff --git a/docs/search-headless.querystate.md b/docs/search-headless.querystate.md new file mode 100644 index 00000000..a723d431 --- /dev/null +++ b/docs/search-headless.querystate.md @@ -0,0 +1,25 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [QueryState](./search-headless.querystate.md) + +## QueryState interface + +Maintains the latest query and its associated data. + +Signature: + +```typescript +export interface QueryState +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [input?](./search-headless.querystate.input.md) | string | (Optional) The user input used for the next search query. | +| [mostRecentSearch?](./search-headless.querystate.mostrecentsearch.md) | string | (Optional) The query of the most recent search. | +| [queryId?](./search-headless.querystate.queryid.md) | string | (Optional) The ID of the query from the latest search. | +| [querySource?](./search-headless.querystate.querysource.md) | [QuerySource](./search-headless.querysource.md) | (Optional) The source of the query (from a standard Answers integration, an Answers overlay, or from visual autocomplete). | +| [queryTrigger?](./search-headless.querystate.querytrigger.md) | [QueryTrigger](./search-headless.querytrigger.md) | (Optional) How the query was triggered (besides user input). | +| [searchIntents?](./search-headless.querystate.searchintents.md) | [SearchIntent](./search-headless.searchintent.md)\[\] | (Optional) The computed intents of the mostRecentSearch, as returned by the Answers API. | + diff --git a/docs/answers-headless.querystate.mostrecentsearch.md b/docs/search-headless.querystate.mostrecentsearch.md similarity index 51% rename from docs/answers-headless.querystate.mostrecentsearch.md rename to docs/search-headless.querystate.mostrecentsearch.md index c22c05b0..d91add13 100644 --- a/docs/answers-headless.querystate.mostrecentsearch.md +++ b/docs/search-headless.querystate.mostrecentsearch.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [QueryState](./answers-headless.querystate.md) > [mostRecentSearch](./answers-headless.querystate.mostrecentsearch.md) +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [QueryState](./search-headless.querystate.md) > [mostRecentSearch](./search-headless.querystate.mostrecentsearch.md) ## QueryState.mostRecentSearch property diff --git a/docs/answers-headless.querystate.queryid.md b/docs/search-headless.querystate.queryid.md similarity index 52% rename from docs/answers-headless.querystate.queryid.md rename to docs/search-headless.querystate.queryid.md index 83463416..33670e75 100644 --- a/docs/answers-headless.querystate.queryid.md +++ b/docs/search-headless.querystate.queryid.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [QueryState](./answers-headless.querystate.md) > [queryId](./answers-headless.querystate.queryid.md) +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [QueryState](./search-headless.querystate.md) > [queryId](./search-headless.querystate.queryid.md) ## QueryState.queryId property diff --git a/docs/answers-headless.querystate.querysource.md b/docs/search-headless.querystate.querysource.md similarity index 59% rename from docs/answers-headless.querystate.querysource.md rename to docs/search-headless.querystate.querysource.md index 6326709c..9abba4a6 100644 --- a/docs/answers-headless.querystate.querysource.md +++ b/docs/search-headless.querystate.querysource.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [QueryState](./answers-headless.querystate.md) > [querySource](./answers-headless.querystate.querysource.md) +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [QueryState](./search-headless.querystate.md) > [querySource](./search-headless.querystate.querysource.md) ## QueryState.querySource property diff --git a/docs/answers-headless.querystate.querytrigger.md b/docs/search-headless.querystate.querytrigger.md similarity index 53% rename from docs/answers-headless.querystate.querytrigger.md rename to docs/search-headless.querystate.querytrigger.md index 61be624c..ddcdcdd7 100644 --- a/docs/answers-headless.querystate.querytrigger.md +++ b/docs/search-headless.querystate.querytrigger.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [QueryState](./answers-headless.querystate.md) > [queryTrigger](./answers-headless.querystate.querytrigger.md) +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [QueryState](./search-headless.querystate.md) > [queryTrigger](./search-headless.querystate.querytrigger.md) ## QueryState.queryTrigger property diff --git a/docs/answers-headless.querystate.searchintents.md b/docs/search-headless.querystate.searchintents.md similarity index 56% rename from docs/answers-headless.querystate.searchintents.md rename to docs/search-headless.querystate.searchintents.md index c942dc9e..f9a16a79 100644 --- a/docs/answers-headless.querystate.searchintents.md +++ b/docs/search-headless.querystate.searchintents.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [QueryState](./answers-headless.querystate.md) > [searchIntents](./answers-headless.querystate.searchintents.md) +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [QueryState](./search-headless.querystate.md) > [searchIntents](./search-headless.querystate.searchintents.md) ## QueryState.searchIntents property diff --git a/docs/answers-headless.querytrigger.md b/docs/search-headless.querytrigger.md similarity index 78% rename from docs/answers-headless.querytrigger.md rename to docs/search-headless.querytrigger.md index fe8cc59e..9c67cce2 100644 --- a/docs/answers-headless.querytrigger.md +++ b/docs/search-headless.querytrigger.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [QueryTrigger](./answers-headless.querytrigger.md) +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [QueryTrigger](./search-headless.querytrigger.md) ## QueryTrigger enum @@ -17,7 +17,7 @@ export declare enum QueryTrigger | Member | Value | Description | | --- | --- | --- | | Initialize | "initialize" | Indicates that the query was triggered by a default initial search. | -| Suggest | "suggest" | Indicates that the query was suggested by a [SpellCheck](./answers-headless.spellcheck.md) response. | +| Suggest | "suggest" | Indicates that the query was suggested by a [SpellCheck](./search-headless.spellcheck.md) response. | ## Remarks diff --git a/docs/answers-headless.questionsubmissionrequest.email.md b/docs/search-headless.questionsubmissionrequest.email.md similarity index 50% rename from docs/answers-headless.questionsubmissionrequest.email.md rename to docs/search-headless.questionsubmissionrequest.email.md index 760f5f50..e78ec495 100644 --- a/docs/answers-headless.questionsubmissionrequest.email.md +++ b/docs/search-headless.questionsubmissionrequest.email.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [QuestionSubmissionRequest](./answers-headless.questionsubmissionrequest.md) > [email](./answers-headless.questionsubmissionrequest.email.md) +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [QuestionSubmissionRequest](./search-headless.questionsubmissionrequest.md) > [email](./search-headless.questionsubmissionrequest.email.md) ## QuestionSubmissionRequest.email property diff --git a/docs/search-headless.questionsubmissionrequest.entityid.md b/docs/search-headless.questionsubmissionrequest.entityid.md new file mode 100644 index 00000000..2dc93da8 --- /dev/null +++ b/docs/search-headless.questionsubmissionrequest.entityid.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [QuestionSubmissionRequest](./search-headless.questionsubmissionrequest.md) > [entityId](./search-headless.questionsubmissionrequest.entityid.md) + +## QuestionSubmissionRequest.entityId property + +The ID of the entity to associate with the question. + +Signature: + +```typescript +entityId: string; +``` diff --git a/docs/search-headless.questionsubmissionrequest.md b/docs/search-headless.questionsubmissionrequest.md new file mode 100644 index 00000000..0c6cbc9b --- /dev/null +++ b/docs/search-headless.questionsubmissionrequest.md @@ -0,0 +1,26 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [QuestionSubmissionRequest](./search-headless.questionsubmissionrequest.md) + +## QuestionSubmissionRequest interface + +Options for a QuestionSubmission request. + +Signature: + +```typescript +export declare interface QuestionSubmissionRequest extends AnswersRequest +``` +Extends: [AnswersRequest](./search-headless.answersrequest.md) + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [email](./search-headless.questionsubmissionrequest.email.md) | string | The email of the user that is submitting the question. | +| [entityId](./search-headless.questionsubmissionrequest.entityid.md) | string | The ID of the entity to associate with the question. | +| [name](./search-headless.questionsubmissionrequest.name.md) | string | The name of the user. | +| [questionDescription?](./search-headless.questionsubmissionrequest.questiondescription.md) | string | (Optional) Additional information about the question. | +| [questionText](./search-headless.questionsubmissionrequest.questiontext.md) | string | The question. | +| [sessionTrackingEnabled?](./search-headless.questionsubmissionrequest.sessiontrackingenabled.md) | boolean | (Optional) Enables session tracking. | + diff --git a/docs/search-headless.questionsubmissionrequest.name.md b/docs/search-headless.questionsubmissionrequest.name.md new file mode 100644 index 00000000..1884d4f4 --- /dev/null +++ b/docs/search-headless.questionsubmissionrequest.name.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [QuestionSubmissionRequest](./search-headless.questionsubmissionrequest.md) > [name](./search-headless.questionsubmissionrequest.name.md) + +## QuestionSubmissionRequest.name property + +The name of the user. + +Signature: + +```typescript +name: string; +``` diff --git a/docs/search-headless.questionsubmissionrequest.questiondescription.md b/docs/search-headless.questionsubmissionrequest.questiondescription.md new file mode 100644 index 00000000..fc983169 --- /dev/null +++ b/docs/search-headless.questionsubmissionrequest.questiondescription.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [QuestionSubmissionRequest](./search-headless.questionsubmissionrequest.md) > [questionDescription](./search-headless.questionsubmissionrequest.questiondescription.md) + +## QuestionSubmissionRequest.questionDescription property + +Additional information about the question. + +Signature: + +```typescript +questionDescription?: string; +``` diff --git a/docs/search-headless.questionsubmissionrequest.questiontext.md b/docs/search-headless.questionsubmissionrequest.questiontext.md new file mode 100644 index 00000000..a5ce036c --- /dev/null +++ b/docs/search-headless.questionsubmissionrequest.questiontext.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [QuestionSubmissionRequest](./search-headless.questionsubmissionrequest.md) > [questionText](./search-headless.questionsubmissionrequest.questiontext.md) + +## QuestionSubmissionRequest.questionText property + +The question. + +Signature: + +```typescript +questionText: string; +``` diff --git a/docs/search-headless.questionsubmissionrequest.sessiontrackingenabled.md b/docs/search-headless.questionsubmissionrequest.sessiontrackingenabled.md new file mode 100644 index 00000000..e79cb012 --- /dev/null +++ b/docs/search-headless.questionsubmissionrequest.sessiontrackingenabled.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [QuestionSubmissionRequest](./search-headless.questionsubmissionrequest.md) > [sessionTrackingEnabled](./search-headless.questionsubmissionrequest.sessiontrackingenabled.md) + +## QuestionSubmissionRequest.sessionTrackingEnabled property + +Enables session tracking. + +Signature: + +```typescript +sessionTrackingEnabled?: boolean; +``` diff --git a/docs/answers-headless.questionsubmissionresponse.md b/docs/search-headless.questionsubmissionresponse.md similarity index 53% rename from docs/answers-headless.questionsubmissionresponse.md rename to docs/search-headless.questionsubmissionresponse.md index ca850f35..15214369 100644 --- a/docs/answers-headless.questionsubmissionresponse.md +++ b/docs/search-headless.questionsubmissionresponse.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [QuestionSubmissionResponse](./answers-headless.questionsubmissionresponse.md) +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [QuestionSubmissionResponse](./search-headless.questionsubmissionresponse.md) ## QuestionSubmissionResponse interface @@ -16,5 +16,5 @@ export declare interface QuestionSubmissionResponse | Property | Type | Description | | --- | --- | --- | -| [uuid](./answers-headless.questionsubmissionresponse.uuid.md) | string | A unique id which corresponds to the request. | +| [uuid](./search-headless.questionsubmissionresponse.uuid.md) | string | A unique id which corresponds to the request. | diff --git a/docs/search-headless.questionsubmissionresponse.uuid.md b/docs/search-headless.questionsubmissionresponse.uuid.md new file mode 100644 index 00000000..c66db142 --- /dev/null +++ b/docs/search-headless.questionsubmissionresponse.uuid.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [QuestionSubmissionResponse](./search-headless.questionsubmissionresponse.md) > [uuid](./search-headless.questionsubmissionresponse.uuid.md) + +## QuestionSubmissionResponse.uuid property + +A unique id which corresponds to the request. + +Signature: + +```typescript +uuid: string; +``` diff --git a/docs/answers-headless.questionsubmissionservice.md b/docs/search-headless.questionsubmissionservice.md similarity index 50% rename from docs/answers-headless.questionsubmissionservice.md rename to docs/search-headless.questionsubmissionservice.md index 4e73d78a..0e7cf4d0 100644 --- a/docs/answers-headless.questionsubmissionservice.md +++ b/docs/search-headless.questionsubmissionservice.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [QuestionSubmissionService](./answers-headless.questionsubmissionservice.md) +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [QuestionSubmissionService](./search-headless.questionsubmissionservice.md) ## QuestionSubmissionService interface @@ -16,5 +16,5 @@ export declare interface QuestionSubmissionService | Method | Description | | --- | --- | -| [submitQuestion(request)](./answers-headless.questionsubmissionservice.submitquestion.md) | Submits a question to be answered. | +| [submitQuestion(request)](./search-headless.questionsubmissionservice.submitquestion.md) | Submits a question to be answered. | diff --git a/docs/search-headless.questionsubmissionservice.submitquestion.md b/docs/search-headless.questionsubmissionservice.submitquestion.md new file mode 100644 index 00000000..5348f0f1 --- /dev/null +++ b/docs/search-headless.questionsubmissionservice.submitquestion.md @@ -0,0 +1,24 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [QuestionSubmissionService](./search-headless.questionsubmissionservice.md) > [submitQuestion](./search-headless.questionsubmissionservice.submitquestion.md) + +## QuestionSubmissionService.submitQuestion() method + +Submits a question to be answered. + +Signature: + +```typescript +submitQuestion(request: QuestionSubmissionRequest): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| request | [QuestionSubmissionRequest](./search-headless.questionsubmissionrequest.md) | The question, as well as the contact info of the submitter. | + +Returns: + +Promise<[QuestionSubmissionResponse](./search-headless.questionsubmissionresponse.md)> + diff --git a/docs/answers-headless.rangeboundary.inclusive.md b/docs/search-headless.rangeboundary.inclusive.md similarity index 52% rename from docs/answers-headless.rangeboundary.inclusive.md rename to docs/search-headless.rangeboundary.inclusive.md index d36b8037..0658fb35 100644 --- a/docs/answers-headless.rangeboundary.inclusive.md +++ b/docs/search-headless.rangeboundary.inclusive.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [RangeBoundary](./answers-headless.rangeboundary.md) > [inclusive](./answers-headless.rangeboundary.inclusive.md) +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [RangeBoundary](./search-headless.rangeboundary.md) > [inclusive](./search-headless.rangeboundary.inclusive.md) ## RangeBoundary.inclusive property diff --git a/docs/search-headless.rangeboundary.md b/docs/search-headless.rangeboundary.md new file mode 100644 index 00000000..bcf15e17 --- /dev/null +++ b/docs/search-headless.rangeboundary.md @@ -0,0 +1,21 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [RangeBoundary](./search-headless.rangeboundary.md) + +## RangeBoundary interface + +A boundary for a [BoundedRange](./search-headless.boundedrange.md) of type T. + +Signature: + +```typescript +export interface RangeBoundary +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [inclusive](./search-headless.rangeboundary.inclusive.md) | boolean | Whether or not the range includes the boundary value. | +| [value](./search-headless.rangeboundary.value.md) | T | The value of the boundary. | + diff --git a/docs/search-headless.rangeboundary.value.md b/docs/search-headless.rangeboundary.value.md new file mode 100644 index 00000000..e0c8867c --- /dev/null +++ b/docs/search-headless.rangeboundary.value.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [RangeBoundary](./search-headless.rangeboundary.md) > [value](./search-headless.rangeboundary.value.md) + +## RangeBoundary.value property + +The value of the boundary. + +Signature: + +```typescript +value: T; +``` diff --git a/docs/answers-headless.result.description.md b/docs/search-headless.result.description.md similarity index 51% rename from docs/answers-headless.result.description.md rename to docs/search-headless.result.description.md index 352335fc..975f7000 100644 --- a/docs/answers-headless.result.description.md +++ b/docs/search-headless.result.description.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [Result](./answers-headless.result.md) > [description](./answers-headless.result.description.md) +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [Result](./search-headless.result.md) > [description](./search-headless.result.description.md) ## Result.description property diff --git a/docs/answers-headless.result.distance.md b/docs/search-headless.result.distance.md similarity index 54% rename from docs/answers-headless.result.distance.md rename to docs/search-headless.result.distance.md index 7d7b5ba5..13e26fc1 100644 --- a/docs/answers-headless.result.distance.md +++ b/docs/search-headless.result.distance.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [Result](./answers-headless.result.md) > [distance](./answers-headless.result.distance.md) +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [Result](./search-headless.result.md) > [distance](./search-headless.result.distance.md) ## Result.distance property diff --git a/docs/answers-headless.result.distancefromfilter.md b/docs/search-headless.result.distancefromfilter.md similarity index 56% rename from docs/answers-headless.result.distancefromfilter.md rename to docs/search-headless.result.distancefromfilter.md index b9406eff..5ae84ecd 100644 --- a/docs/answers-headless.result.distancefromfilter.md +++ b/docs/search-headless.result.distancefromfilter.md @@ -1,10 +1,10 @@ -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [Result](./answers-headless.result.md) > [distanceFromFilter](./answers-headless.result.distancefromfilter.md) +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [Result](./search-headless.result.md) > [distanceFromFilter](./search-headless.result.distancefromfilter.md) ## Result.distanceFromFilter property -The distance from a [AppliedQueryFilter](./answers-headless.appliedqueryfilter.md) location to the result in meters. +The distance from a [AppliedQueryFilter](./search-headless.appliedqueryfilter.md) location to the result in meters. Signature: @@ -14,7 +14,7 @@ distanceFromFilter?: number; ## Remarks -The filter may be an inferred from the search query, or it may be specified explicitly through a facet or static filter on a [VerticalSearchRequest](./answers-headless.verticalsearchrequest.md). +The filter may be an inferred from the search query, or it may be specified explicitly through a facet or static filter on a [VerticalSearchRequest](./search-headless.verticalsearchrequest.md). ## Example diff --git a/docs/answers-headless.result.entitytype.md b/docs/search-headless.result.entitytype.md similarity index 51% rename from docs/answers-headless.result.entitytype.md rename to docs/search-headless.result.entitytype.md index 38084a1d..26c8978a 100644 --- a/docs/answers-headless.result.entitytype.md +++ b/docs/search-headless.result.entitytype.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [Result](./answers-headless.result.md) > [entityType](./answers-headless.result.entitytype.md) +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [Result](./search-headless.result.md) > [entityType](./search-headless.result.entitytype.md) ## Result.entityType property diff --git a/docs/search-headless.result.highlightedfields.md b/docs/search-headless.result.highlightedfields.md new file mode 100644 index 00000000..5865f830 --- /dev/null +++ b/docs/search-headless.result.highlightedfields.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [Result](./search-headless.result.md) > [highlightedFields](./search-headless.result.highlightedfields.md) + +## Result.highlightedFields property + +The [highlighted fields](./search-headless.highlightedfields.md) emphasized by the api. + +Signature: + +```typescript +highlightedFields?: HighlightedFields; +``` diff --git a/docs/answers-headless.result.id.md b/docs/search-headless.result.id.md similarity index 54% rename from docs/answers-headless.result.id.md rename to docs/search-headless.result.id.md index 9a04aa76..c8121580 100644 --- a/docs/answers-headless.result.id.md +++ b/docs/search-headless.result.id.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [Result](./answers-headless.result.md) > [id](./answers-headless.result.id.md) +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [Result](./search-headless.result.md) > [id](./search-headless.result.id.md) ## Result.id property diff --git a/docs/answers-headless.result.index.md b/docs/search-headless.result.index.md similarity index 55% rename from docs/answers-headless.result.index.md rename to docs/search-headless.result.index.md index f46f9488..3162f407 100644 --- a/docs/answers-headless.result.index.md +++ b/docs/search-headless.result.index.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [Result](./answers-headless.result.md) > [index](./answers-headless.result.index.md) +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [Result](./search-headless.result.md) > [index](./search-headless.result.index.md) ## Result.index property diff --git a/docs/answers-headless.result.link.md b/docs/search-headless.result.link.md similarity index 53% rename from docs/answers-headless.result.link.md rename to docs/search-headless.result.link.md index 7bdfaad8..c8ae6147 100644 --- a/docs/answers-headless.result.link.md +++ b/docs/search-headless.result.link.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [Result](./answers-headless.result.md) > [link](./answers-headless.result.link.md) +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [Result](./search-headless.result.md) > [link](./search-headless.result.link.md) ## Result.link property diff --git a/docs/search-headless.result.md b/docs/search-headless.result.md new file mode 100644 index 00000000..5a9a7853 --- /dev/null +++ b/docs/search-headless.result.md @@ -0,0 +1,30 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [Result](./search-headless.result.md) + +## Result interface + +An individual search result. + +Signature: + +```typescript +export declare interface Result +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [description?](./search-headless.result.description.md) | string | (Optional) A description of the result. | +| [distance?](./search-headless.result.distance.md) | number | (Optional) The distance from the user to the result in meters. | +| [distanceFromFilter?](./search-headless.result.distancefromfilter.md) | number | (Optional) The distance from a [AppliedQueryFilter](./search-headless.appliedqueryfilter.md) location to the result in meters. | +| [entityType?](./search-headless.result.entitytype.md) | string | (Optional) The entity type of the result | +| [highlightedFields?](./search-headless.result.highlightedfields.md) | [HighlightedFields](./search-headless.highlightedfields.md) | (Optional) The [highlighted fields](./search-headless.highlightedfields.md) emphasized by the api. | +| [id?](./search-headless.result.id.md) | string | (Optional) The result ID which depends on the Result Source. | +| [index?](./search-headless.result.index.md) | number | (Optional) The index of the result among the other results in the search. | +| [link?](./search-headless.result.link.md) | string | (Optional) A hyperlink associated with the result. | +| [name?](./search-headless.result.name.md) | string | (Optional) The name of the result. | +| [rawData](./search-headless.result.rawdata.md) | Record<string, unknown> | Raw entity profile data in the shape of key-value pairs. | +| [source](./search-headless.result.source.md) | [Source](./search-headless.source.md) | Represents the source of a [Result](./search-headless.result.md). | + diff --git a/docs/answers-headless.result.name.md b/docs/search-headless.result.name.md similarity index 51% rename from docs/answers-headless.result.name.md rename to docs/search-headless.result.name.md index 9c89d05e..42bf53ce 100644 --- a/docs/answers-headless.result.name.md +++ b/docs/search-headless.result.name.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [Result](./answers-headless.result.md) > [name](./answers-headless.result.name.md) +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [Result](./search-headless.result.md) > [name](./search-headless.result.name.md) ## Result.name property diff --git a/docs/answers-headless.result.rawdata.md b/docs/search-headless.result.rawdata.md similarity index 56% rename from docs/answers-headless.result.rawdata.md rename to docs/search-headless.result.rawdata.md index 14d32fa4..d01e62df 100644 --- a/docs/answers-headless.result.rawdata.md +++ b/docs/search-headless.result.rawdata.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [Result](./answers-headless.result.md) > [rawData](./answers-headless.result.rawdata.md) +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [Result](./search-headless.result.md) > [rawData](./search-headless.result.rawdata.md) ## Result.rawData property diff --git a/docs/search-headless.result.source.md b/docs/search-headless.result.source.md new file mode 100644 index 00000000..cab84a46 --- /dev/null +++ b/docs/search-headless.result.source.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [Result](./search-headless.result.md) > [source](./search-headless.result.source.md) + +## Result.source property + +Represents the source of a [Result](./search-headless.result.md). + +Signature: + +```typescript +source: Source; +``` diff --git a/docs/answers-headless.sandboxendpoints.md b/docs/search-headless.sandboxendpoints.md similarity index 61% rename from docs/answers-headless.sandboxendpoints.md rename to docs/search-headless.sandboxendpoints.md index 96fd96c1..8f0eb29c 100644 --- a/docs/answers-headless.sandboxendpoints.md +++ b/docs/search-headless.sandboxendpoints.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [SandboxEndpoints](./answers-headless.sandboxendpoints.md) +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [SandboxEndpoints](./search-headless.sandboxendpoints.md) ## SandboxEndpoints variable diff --git a/docs/search-headless.searchheadless._constructor_.md b/docs/search-headless.searchheadless._constructor_.md new file mode 100644 index 00000000..5c45809d --- /dev/null +++ b/docs/search-headless.searchheadless._constructor_.md @@ -0,0 +1,23 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [SearchHeadless](./search-headless.searchheadless.md) > [(constructor)](./search-headless.searchheadless._constructor_.md) + +## SearchHeadless.(constructor) + +Constructs a new instance of the `SearchHeadless` class + +Signature: + +```typescript +constructor(core: AnswersCore, stateManager: StateManager, httpManager: HttpManager, additionalHttpHeaders?: AdditionalHttpHeaders | undefined); +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| core | [AnswersCore](./search-headless.answerscore.md) | | +| stateManager | StateManager | | +| httpManager | HttpManager | | +| additionalHttpHeaders | [AdditionalHttpHeaders](./search-headless.additionalhttpheaders.md) \| undefined | | + diff --git a/docs/answers-headless.answersheadless.addlistener.md b/docs/search-headless.searchheadless.addlistener.md similarity index 62% rename from docs/answers-headless.answersheadless.addlistener.md rename to docs/search-headless.searchheadless.addlistener.md index 2cabd763..51089128 100644 --- a/docs/answers-headless.answersheadless.addlistener.md +++ b/docs/search-headless.searchheadless.addlistener.md @@ -1,8 +1,8 @@ -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [AnswersHeadless](./answers-headless.answersheadless.md) > [addListener](./answers-headless.answersheadless.addlistener.md) +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [SearchHeadless](./search-headless.searchheadless.md) > [addListener](./search-headless.searchheadless.addlistener.md) -## AnswersHeadless.addListener() method +## SearchHeadless.addListener() method Adds a listener for a specific state value of type T. diff --git a/docs/search-headless.searchheadless.executefiltersearch.md b/docs/search-headless.searchheadless.executefiltersearch.md new file mode 100644 index 00000000..b252215d --- /dev/null +++ b/docs/search-headless.searchheadless.executefiltersearch.md @@ -0,0 +1,28 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [SearchHeadless](./search-headless.searchheadless.md) > [executeFilterSearch](./search-headless.searchheadless.executefiltersearch.md) + +## SearchHeadless.executeFilterSearch() method + +Performs a filtersearch request against specified fields within a single vertical using the vertical key stored in state. + +Signature: + +```typescript +executeFilterSearch(query: string, sectioned: boolean, fields: SearchParameterField[]): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| query | string | The query for which to search | +| sectioned | boolean | Whether or not the results should be sectioned by field | +| fields | [SearchParameterField](./search-headless.searchparameterfield.md)\[\] | The entity fields to search | + +Returns: + +Promise<[FilterSearchResponse](./search-headless.filtersearchresponse.md) \| undefined> + +A Promise of a [FilterSearchResponse](./search-headless.filtersearchresponse.md) from the Answers API or of undefined if there is no verticalKey defined in state + diff --git a/docs/search-headless.searchheadless.executeuniversalautocomplete.md b/docs/search-headless.searchheadless.executeuniversalautocomplete.md new file mode 100644 index 00000000..069dbc2b --- /dev/null +++ b/docs/search-headless.searchheadless.executeuniversalautocomplete.md @@ -0,0 +1,19 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [SearchHeadless](./search-headless.searchheadless.md) > [executeUniversalAutocomplete](./search-headless.searchheadless.executeuniversalautocomplete.md) + +## SearchHeadless.executeUniversalAutocomplete() method + +Performs an autocomplete request across all verticals using the query input stored in state. + +Signature: + +```typescript +executeUniversalAutocomplete(): Promise; +``` +Returns: + +Promise<[AutocompleteResponse](./search-headless.autocompleteresponse.md)> + +A Promise of an [AutocompleteResponse](./search-headless.autocompleteresponse.md) from the Answers API + diff --git a/docs/search-headless.searchheadless.executeuniversalquery.md b/docs/search-headless.searchheadless.executeuniversalquery.md new file mode 100644 index 00000000..bee82276 --- /dev/null +++ b/docs/search-headless.searchheadless.executeuniversalquery.md @@ -0,0 +1,19 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [SearchHeadless](./search-headless.searchheadless.md) > [executeUniversalQuery](./search-headless.searchheadless.executeuniversalquery.md) + +## SearchHeadless.executeUniversalQuery() method + +Performs an Answers search across all verticals with relevant parts of the state used as input to the search. Updates the state with the response data. + +Signature: + +```typescript +executeUniversalQuery(): Promise; +``` +Returns: + +Promise<[UniversalSearchResponse](./search-headless.universalsearchresponse.md) \| undefined> + +A Promise of a [UniversalSearchResponse](./search-headless.universalsearchresponse.md) from the Answers API + diff --git a/docs/search-headless.searchheadless.executeverticalautocomplete.md b/docs/search-headless.searchheadless.executeverticalautocomplete.md new file mode 100644 index 00000000..748c3cb7 --- /dev/null +++ b/docs/search-headless.searchheadless.executeverticalautocomplete.md @@ -0,0 +1,19 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [SearchHeadless](./search-headless.searchheadless.md) > [executeVerticalAutocomplete](./search-headless.searchheadless.executeverticalautocomplete.md) + +## SearchHeadless.executeVerticalAutocomplete() method + +Performs an autocomplete request for a single vertical using the query input and vertical key stored in state. + +Signature: + +```typescript +executeVerticalAutocomplete(): Promise; +``` +Returns: + +Promise<[AutocompleteResponse](./search-headless.autocompleteresponse.md) \| undefined> + +A Promise of an [AutocompleteResponse](./search-headless.autocompleteresponse.md) from the Answers API or of undefined if there is no verticalKey defined in state + diff --git a/docs/search-headless.searchheadless.executeverticalquery.md b/docs/search-headless.searchheadless.executeverticalquery.md new file mode 100644 index 00000000..bd452318 --- /dev/null +++ b/docs/search-headless.searchheadless.executeverticalquery.md @@ -0,0 +1,19 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [SearchHeadless](./search-headless.searchheadless.md) > [executeVerticalQuery](./search-headless.searchheadless.executeverticalquery.md) + +## SearchHeadless.executeVerticalQuery() method + +Perform an Answers search for a single vertical with relevant parts of the state used as input to the search. Updates the state with the response data. + +Signature: + +```typescript +executeVerticalQuery(): Promise; +``` +Returns: + +Promise<[VerticalSearchResponse](./search-headless.verticalsearchresponse.md) \| undefined> + +A Promise of a [VerticalSearchResponse](./search-headless.verticalsearchresponse.md) from the Answers API or of undefined if there is no verticalKey defined in state + diff --git a/docs/search-headless.searchheadless.md b/docs/search-headless.searchheadless.md new file mode 100644 index 00000000..0211d5d7 --- /dev/null +++ b/docs/search-headless.searchheadless.md @@ -0,0 +1,62 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [SearchHeadless](./search-headless.searchheadless.md) + +## SearchHeadless class + +Provides the functionality for interacting with an Answers Search experience. + +Signature: + +```typescript +export default class SearchHeadless +``` + +## Constructors + +| Constructor | Modifiers | Description | +| --- | --- | --- | +| [(constructor)(core, stateManager, httpManager, additionalHttpHeaders)](./search-headless.searchheadless._constructor_.md) | | Constructs a new instance of the SearchHeadless class | + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [state](./search-headless.searchheadless.state.md) | | [State](./search-headless.state.md) | Gets the current state of the SearchHeadless instance. | +| [utilities](./search-headless.searchheadless.utilities.md) | | typeof answersUtilities | Common utility functions for manipulating Answers-related data. | + +## Methods + +| Method | Modifiers | Description | +| --- | --- | --- | +| [addListener(listener)](./search-headless.searchheadless.addlistener.md) | | Adds a listener for a specific state value of type T. | +| [executeFilterSearch(query, sectioned, fields)](./search-headless.searchheadless.executefiltersearch.md) | | Performs a filtersearch request against specified fields within a single vertical using the vertical key stored in state. | +| [executeUniversalAutocomplete()](./search-headless.searchheadless.executeuniversalautocomplete.md) | | Performs an autocomplete request across all verticals using the query input stored in state. | +| [executeUniversalQuery()](./search-headless.searchheadless.executeuniversalquery.md) | | Performs an Answers search across all verticals with relevant parts of the state used as input to the search. Updates the state with the response data. | +| [executeVerticalAutocomplete()](./search-headless.searchheadless.executeverticalautocomplete.md) | | Performs an autocomplete request for a single vertical using the query input and vertical key stored in state. | +| [executeVerticalQuery()](./search-headless.searchheadless.executeverticalquery.md) | | Perform an Answers search for a single vertical with relevant parts of the state used as input to the search. Updates the state with the response data. | +| [resetFacets()](./search-headless.searchheadless.resetfacets.md) | | Unselects all [facets](./search-headless.filtersstate.facets.md). | +| [setAlternativeVerticals(alternativeVerticals)](./search-headless.searchheadless.setalternativeverticals.md) | | Sets the alternativeVerticals for [VerticalSearchState.noResults](./search-headless.verticalsearchstate.noresults.md) to the specified verticals. | +| [setContext(context)](./search-headless.searchheadless.setcontext.md) | | Sets [MetaState.context](./search-headless.metastate.context.md) to the specified context. | +| [setFacetOption(fieldId, facetOption, selected)](./search-headless.searchheadless.setfacetoption.md) | | Sets a specified facet option to be selected or unselected. | +| [setFacets(facets)](./search-headless.searchheadless.setfacets.md) | | Sets [FiltersState.facets](./search-headless.filtersstate.facets.md) to the specified facets. | +| [setFilterOption(filter)](./search-headless.searchheadless.setfilteroption.md) | | Sets a static filter option and whether or not it is selected in state. | +| [setOffset(offset)](./search-headless.searchheadless.setoffset.md) | | Sets [VerticalSearchState.offset](./search-headless.verticalsearchstate.offset.md) to the specified offset. | +| [setQuery(input)](./search-headless.searchheadless.setquery.md) | | Sets [QueryState.input](./search-headless.querystate.input.md) to the specified input. | +| [setQuerySource(source)](./search-headless.searchheadless.setquerysource.md) | | Sets [QueryState.querySource](./search-headless.querystate.querysource.md) to the specified source. | +| [setQueryTrigger(trigger)](./search-headless.searchheadless.setquerytrigger.md) | | Sets [QueryState.queryTrigger](./search-headless.querystate.querytrigger.md) to the specified trigger. | +| [setReferrerPageUrl(referrerPageUrl)](./search-headless.searchheadless.setreferrerpageurl.md) | | Sets [MetaState.referrerPageUrl](./search-headless.metastate.referrerpageurl.md) to the specified URL. | +| [setRestrictVerticals(restrictVerticals)](./search-headless.searchheadless.setrestrictverticals.md) | | Sets [UniversalSearchState.restrictVerticals](./search-headless.universalsearchstate.restrictverticals.md) to the specified vertical keys. | +| [setSessionId(sessionId)](./search-headless.searchheadless.setsessionid.md) | | Sets [SessionTrackingState.sessionId](./search-headless.sessiontrackingstate.sessionid.md) to the specified ID. | +| [setSessionTrackingEnabled(enabled)](./search-headless.searchheadless.setsessiontrackingenabled.md) | | Sets [SessionTrackingState.enabled](./search-headless.sessiontrackingstate.enabled.md) to the specified boolean value. | +| [setSortBys(sortBys)](./search-headless.searchheadless.setsortbys.md) | | Sets [VerticalSearchState.sortBys](./search-headless.verticalsearchstate.sortbys.md) to the specified sortBys. | +| [setSpellCheckEnabled(enabled)](./search-headless.searchheadless.setspellcheckenabled.md) | | Sets [SpellCheckState.enabled](./search-headless.spellcheckstate.enabled.md) to the specified boolean value. | +| [setState(state)](./search-headless.searchheadless.setstate.md) | | Sets the [State](./search-headless.state.md) to the specified state. | +| [setStaticFilters(filters)](./search-headless.searchheadless.setstaticfilters.md) | | Sets [FiltersState.static](./search-headless.filtersstate.static.md) to the specified filters. | +| [setUniversal()](./search-headless.searchheadless.setuniversal.md) | | Sets up Headless to manage universal searches. | +| [setUniversalLimit(limit)](./search-headless.searchheadless.setuniversallimit.md) | | Sets [UniversalSearchState.limit](./search-headless.universalsearchstate.limit.md) to the specified limit. | +| [setUserLocation(latLong)](./search-headless.searchheadless.setuserlocation.md) | | Sets [LocationState.userLocation](./search-headless.locationstate.userlocation.md) to the specified latitude and longitude. | +| [setVertical(verticalKey)](./search-headless.searchheadless.setvertical.md) | | Sets up Headless to manage the vertical indicated by the verticalKey. | +| [setVerticalLimit(limit)](./search-headless.searchheadless.setverticallimit.md) | | Sets [VerticalSearchState.limit](./search-headless.verticalsearchstate.limit.md) to the specified limit. | +| [submitQuestion(request)](./search-headless.searchheadless.submitquestion.md) | | Submits a question to the Answers API with the specified request data. | + diff --git a/docs/search-headless.searchheadless.resetfacets.md b/docs/search-headless.searchheadless.resetfacets.md new file mode 100644 index 00000000..261162d0 --- /dev/null +++ b/docs/search-headless.searchheadless.resetfacets.md @@ -0,0 +1,17 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [SearchHeadless](./search-headless.searchheadless.md) > [resetFacets](./search-headless.searchheadless.resetfacets.md) + +## SearchHeadless.resetFacets() method + +Unselects all [facets](./search-headless.filtersstate.facets.md). + +Signature: + +```typescript +resetFacets(): void; +``` +Returns: + +void + diff --git a/docs/search-headless.searchheadless.setalternativeverticals.md b/docs/search-headless.searchheadless.setalternativeverticals.md new file mode 100644 index 00000000..d242487a --- /dev/null +++ b/docs/search-headless.searchheadless.setalternativeverticals.md @@ -0,0 +1,24 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [SearchHeadless](./search-headless.searchheadless.md) > [setAlternativeVerticals](./search-headless.searchheadless.setalternativeverticals.md) + +## SearchHeadless.setAlternativeVerticals() method + +Sets the alternativeVerticals for [VerticalSearchState.noResults](./search-headless.verticalsearchstate.noresults.md) to the specified verticals. + +Signature: + +```typescript +setAlternativeVerticals(alternativeVerticals: VerticalResults[]): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| alternativeVerticals | [VerticalResults](./search-headless.verticalresults.md)\[\] | The alternative verticals to set | + +Returns: + +void + diff --git a/docs/search-headless.searchheadless.setcontext.md b/docs/search-headless.searchheadless.setcontext.md new file mode 100644 index 00000000..e9cdb41d --- /dev/null +++ b/docs/search-headless.searchheadless.setcontext.md @@ -0,0 +1,24 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [SearchHeadless](./search-headless.searchheadless.md) > [setContext](./search-headless.searchheadless.setcontext.md) + +## SearchHeadless.setContext() method + +Sets [MetaState.context](./search-headless.metastate.context.md) to the specified context. + +Signature: + +```typescript +setContext(context: Context): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| context | [Context](./search-headless.context.md) | The context to set | + +Returns: + +void + diff --git a/docs/answers-headless.answersheadless.setfacetoption.md b/docs/search-headless.searchheadless.setfacetoption.md similarity index 56% rename from docs/answers-headless.answersheadless.setfacetoption.md rename to docs/search-headless.searchheadless.setfacetoption.md index 407763a4..dfc5ff61 100644 --- a/docs/answers-headless.answersheadless.setfacetoption.md +++ b/docs/search-headless.searchheadless.setfacetoption.md @@ -1,8 +1,8 @@ -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [AnswersHeadless](./answers-headless.answersheadless.md) > [setFacetOption](./answers-headless.answersheadless.setfacetoption.md) +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [SearchHeadless](./search-headless.searchheadless.md) > [setFacetOption](./search-headless.searchheadless.setfacetoption.md) -## AnswersHeadless.setFacetOption() method +## SearchHeadless.setFacetOption() method Sets a specified facet option to be selected or unselected. @@ -17,7 +17,7 @@ setFacetOption(fieldId: string, facetOption: FacetOption, selected: boolean): vo | Parameter | Type | Description | | --- | --- | --- | | fieldId | string | The fieldId for the facet | -| facetOption | [FacetOption](./answers-headless.facetoption.md) | The option of the facet to select | +| facetOption | [FacetOption](./search-headless.facetoption.md) | The option of the facet to select | | selected | boolean | Whether or not the facet option should be selected | Returns: diff --git a/docs/search-headless.searchheadless.setfacets.md b/docs/search-headless.searchheadless.setfacets.md new file mode 100644 index 00000000..d9d76b16 --- /dev/null +++ b/docs/search-headless.searchheadless.setfacets.md @@ -0,0 +1,24 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [SearchHeadless](./search-headless.searchheadless.md) > [setFacets](./search-headless.searchheadless.setfacets.md) + +## SearchHeadless.setFacets() method + +Sets [FiltersState.facets](./search-headless.filtersstate.facets.md) to the specified facets. + +Signature: + +```typescript +setFacets(facets: DisplayableFacet[]): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| facets | [DisplayableFacet](./search-headless.displayablefacet.md)\[\] | The facets to set | + +Returns: + +void + diff --git a/docs/search-headless.searchheadless.setfilteroption.md b/docs/search-headless.searchheadless.setfilteroption.md new file mode 100644 index 00000000..42b7df55 --- /dev/null +++ b/docs/search-headless.searchheadless.setfilteroption.md @@ -0,0 +1,24 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [SearchHeadless](./search-headless.searchheadless.md) > [setFilterOption](./search-headless.searchheadless.setfilteroption.md) + +## SearchHeadless.setFilterOption() method + +Sets a static filter option and whether or not it is selected in state. + +Signature: + +```typescript +setFilterOption(filter: SelectableFilter): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| filter | [SelectableFilter](./search-headless.selectablefilter.md) | The static filter and whether it is selected | + +Returns: + +void + diff --git a/docs/search-headless.searchheadless.setoffset.md b/docs/search-headless.searchheadless.setoffset.md new file mode 100644 index 00000000..d6093545 --- /dev/null +++ b/docs/search-headless.searchheadless.setoffset.md @@ -0,0 +1,24 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [SearchHeadless](./search-headless.searchheadless.md) > [setOffset](./search-headless.searchheadless.setoffset.md) + +## SearchHeadless.setOffset() method + +Sets [VerticalSearchState.offset](./search-headless.verticalsearchstate.offset.md) to the specified offset. + +Signature: + +```typescript +setOffset(offset: number): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| offset | number | The vertical offset to set | + +Returns: + +void + diff --git a/docs/search-headless.searchheadless.setquery.md b/docs/search-headless.searchheadless.setquery.md new file mode 100644 index 00000000..75cc1dac --- /dev/null +++ b/docs/search-headless.searchheadless.setquery.md @@ -0,0 +1,24 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [SearchHeadless](./search-headless.searchheadless.md) > [setQuery](./search-headless.searchheadless.setquery.md) + +## SearchHeadless.setQuery() method + +Sets [QueryState.input](./search-headless.querystate.input.md) to the specified input. + +Signature: + +```typescript +setQuery(input: string): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| input | string | The input to set | + +Returns: + +void + diff --git a/docs/search-headless.searchheadless.setquerysource.md b/docs/search-headless.searchheadless.setquerysource.md new file mode 100644 index 00000000..94487160 --- /dev/null +++ b/docs/search-headless.searchheadless.setquerysource.md @@ -0,0 +1,24 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [SearchHeadless](./search-headless.searchheadless.md) > [setQuerySource](./search-headless.searchheadless.setquerysource.md) + +## SearchHeadless.setQuerySource() method + +Sets [QueryState.querySource](./search-headless.querystate.querysource.md) to the specified source. + +Signature: + +```typescript +setQuerySource(source: QuerySource): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| source | [QuerySource](./search-headless.querysource.md) | The query source to set | + +Returns: + +void + diff --git a/docs/search-headless.searchheadless.setquerytrigger.md b/docs/search-headless.searchheadless.setquerytrigger.md new file mode 100644 index 00000000..4d557940 --- /dev/null +++ b/docs/search-headless.searchheadless.setquerytrigger.md @@ -0,0 +1,24 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [SearchHeadless](./search-headless.searchheadless.md) > [setQueryTrigger](./search-headless.searchheadless.setquerytrigger.md) + +## SearchHeadless.setQueryTrigger() method + +Sets [QueryState.queryTrigger](./search-headless.querystate.querytrigger.md) to the specified trigger. + +Signature: + +```typescript +setQueryTrigger(trigger: QueryTrigger): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| trigger | [QueryTrigger](./search-headless.querytrigger.md) | The query trigger to set | + +Returns: + +void + diff --git a/docs/search-headless.searchheadless.setreferrerpageurl.md b/docs/search-headless.searchheadless.setreferrerpageurl.md new file mode 100644 index 00000000..385dc682 --- /dev/null +++ b/docs/search-headless.searchheadless.setreferrerpageurl.md @@ -0,0 +1,24 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [SearchHeadless](./search-headless.searchheadless.md) > [setReferrerPageUrl](./search-headless.searchheadless.setreferrerpageurl.md) + +## SearchHeadless.setReferrerPageUrl() method + +Sets [MetaState.referrerPageUrl](./search-headless.metastate.referrerpageurl.md) to the specified URL. + +Signature: + +```typescript +setReferrerPageUrl(referrerPageUrl: string): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| referrerPageUrl | string | The referring page URL to set | + +Returns: + +void + diff --git a/docs/search-headless.searchheadless.setrestrictverticals.md b/docs/search-headless.searchheadless.setrestrictverticals.md new file mode 100644 index 00000000..4ba0ab01 --- /dev/null +++ b/docs/search-headless.searchheadless.setrestrictverticals.md @@ -0,0 +1,24 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [SearchHeadless](./search-headless.searchheadless.md) > [setRestrictVerticals](./search-headless.searchheadless.setrestrictverticals.md) + +## SearchHeadless.setRestrictVerticals() method + +Sets [UniversalSearchState.restrictVerticals](./search-headless.universalsearchstate.restrictverticals.md) to the specified vertical keys. + +Signature: + +```typescript +setRestrictVerticals(restrictVerticals: string[]): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| restrictVerticals | string\[\] | The new verticals to restrict a universal search | + +Returns: + +void + diff --git a/docs/search-headless.searchheadless.setsessionid.md b/docs/search-headless.searchheadless.setsessionid.md new file mode 100644 index 00000000..c0eceb04 --- /dev/null +++ b/docs/search-headless.searchheadless.setsessionid.md @@ -0,0 +1,24 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [SearchHeadless](./search-headless.searchheadless.md) > [setSessionId](./search-headless.searchheadless.setsessionid.md) + +## SearchHeadless.setSessionId() method + +Sets [SessionTrackingState.sessionId](./search-headless.sessiontrackingstate.sessionid.md) to the specified ID. + +Signature: + +```typescript +setSessionId(sessionId: string): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| sessionId | string | The session ID to set | + +Returns: + +void + diff --git a/docs/search-headless.searchheadless.setsessiontrackingenabled.md b/docs/search-headless.searchheadless.setsessiontrackingenabled.md new file mode 100644 index 00000000..be9eb622 --- /dev/null +++ b/docs/search-headless.searchheadless.setsessiontrackingenabled.md @@ -0,0 +1,24 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [SearchHeadless](./search-headless.searchheadless.md) > [setSessionTrackingEnabled](./search-headless.searchheadless.setsessiontrackingenabled.md) + +## SearchHeadless.setSessionTrackingEnabled() method + +Sets [SessionTrackingState.enabled](./search-headless.sessiontrackingstate.enabled.md) to the specified boolean value. + +Signature: + +```typescript +setSessionTrackingEnabled(enabled: boolean): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| enabled | boolean | Whether or not session tracking should be set to enabled | + +Returns: + +void + diff --git a/docs/search-headless.searchheadless.setsortbys.md b/docs/search-headless.searchheadless.setsortbys.md new file mode 100644 index 00000000..a7d1fae2 --- /dev/null +++ b/docs/search-headless.searchheadless.setsortbys.md @@ -0,0 +1,24 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [SearchHeadless](./search-headless.searchheadless.md) > [setSortBys](./search-headless.searchheadless.setsortbys.md) + +## SearchHeadless.setSortBys() method + +Sets [VerticalSearchState.sortBys](./search-headless.verticalsearchstate.sortbys.md) to the specified sortBys. + +Signature: + +```typescript +setSortBys(sortBys: SortBy[]): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| sortBys | [SortBy](./search-headless.sortby.md)\[\] | The sortBys to set | + +Returns: + +void + diff --git a/docs/search-headless.searchheadless.setspellcheckenabled.md b/docs/search-headless.searchheadless.setspellcheckenabled.md new file mode 100644 index 00000000..5470c2e8 --- /dev/null +++ b/docs/search-headless.searchheadless.setspellcheckenabled.md @@ -0,0 +1,24 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [SearchHeadless](./search-headless.searchheadless.md) > [setSpellCheckEnabled](./search-headless.searchheadless.setspellcheckenabled.md) + +## SearchHeadless.setSpellCheckEnabled() method + +Sets [SpellCheckState.enabled](./search-headless.spellcheckstate.enabled.md) to the specified boolean value. + +Signature: + +```typescript +setSpellCheckEnabled(enabled: boolean): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| enabled | boolean | Whether or not spellcheck should be set to enabled | + +Returns: + +void + diff --git a/docs/search-headless.searchheadless.setstate.md b/docs/search-headless.searchheadless.setstate.md new file mode 100644 index 00000000..da8918eb --- /dev/null +++ b/docs/search-headless.searchheadless.setstate.md @@ -0,0 +1,24 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [SearchHeadless](./search-headless.searchheadless.md) > [setState](./search-headless.searchheadless.setstate.md) + +## SearchHeadless.setState() method + +Sets the [State](./search-headless.state.md) to the specified state. + +Signature: + +```typescript +setState(state: State): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| state | [State](./search-headless.state.md) | The state to set | + +Returns: + +void + diff --git a/docs/search-headless.searchheadless.setstaticfilters.md b/docs/search-headless.searchheadless.setstaticfilters.md new file mode 100644 index 00000000..80bb905e --- /dev/null +++ b/docs/search-headless.searchheadless.setstaticfilters.md @@ -0,0 +1,24 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [SearchHeadless](./search-headless.searchheadless.md) > [setStaticFilters](./search-headless.searchheadless.setstaticfilters.md) + +## SearchHeadless.setStaticFilters() method + +Sets [FiltersState.static](./search-headless.filtersstate.static.md) to the specified filters. + +Signature: + +```typescript +setStaticFilters(filters: SelectableFilter[]): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| filters | [SelectableFilter](./search-headless.selectablefilter.md)\[\] | The static filters to set | + +Returns: + +void + diff --git a/docs/search-headless.searchheadless.setuniversal.md b/docs/search-headless.searchheadless.setuniversal.md new file mode 100644 index 00000000..897756be --- /dev/null +++ b/docs/search-headless.searchheadless.setuniversal.md @@ -0,0 +1,17 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [SearchHeadless](./search-headless.searchheadless.md) > [setUniversal](./search-headless.searchheadless.setuniversal.md) + +## SearchHeadless.setUniversal() method + +Sets up Headless to manage universal searches. + +Signature: + +```typescript +setUniversal(): void; +``` +Returns: + +void + diff --git a/docs/search-headless.searchheadless.setuniversallimit.md b/docs/search-headless.searchheadless.setuniversallimit.md new file mode 100644 index 00000000..38b512d8 --- /dev/null +++ b/docs/search-headless.searchheadless.setuniversallimit.md @@ -0,0 +1,24 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [SearchHeadless](./search-headless.searchheadless.md) > [setUniversalLimit](./search-headless.searchheadless.setuniversallimit.md) + +## SearchHeadless.setUniversalLimit() method + +Sets [UniversalSearchState.limit](./search-headless.universalsearchstate.limit.md) to the specified limit. + +Signature: + +```typescript +setUniversalLimit(limit: UniversalLimit): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| limit | [UniversalLimit](./search-headless.universallimit.md) | The universal limit to set | + +Returns: + +void + diff --git a/docs/search-headless.searchheadless.setuserlocation.md b/docs/search-headless.searchheadless.setuserlocation.md new file mode 100644 index 00000000..121f7abd --- /dev/null +++ b/docs/search-headless.searchheadless.setuserlocation.md @@ -0,0 +1,24 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [SearchHeadless](./search-headless.searchheadless.md) > [setUserLocation](./search-headless.searchheadless.setuserlocation.md) + +## SearchHeadless.setUserLocation() method + +Sets [LocationState.userLocation](./search-headless.locationstate.userlocation.md) to the specified latitude and longitude. + +Signature: + +```typescript +setUserLocation(latLong: LatLong): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| latLong | [LatLong](./search-headless.latlong.md) | The user location to set | + +Returns: + +void + diff --git a/docs/answers-headless.answersheadless.setvertical.md b/docs/search-headless.searchheadless.setvertical.md similarity index 58% rename from docs/answers-headless.answersheadless.setvertical.md rename to docs/search-headless.searchheadless.setvertical.md index b32eeb11..a5a0111d 100644 --- a/docs/answers-headless.answersheadless.setvertical.md +++ b/docs/search-headless.searchheadless.setvertical.md @@ -1,8 +1,8 @@ -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [AnswersHeadless](./answers-headless.answersheadless.md) > [setVertical](./answers-headless.answersheadless.setvertical.md) +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [SearchHeadless](./search-headless.searchheadless.md) > [setVertical](./search-headless.searchheadless.setvertical.md) -## AnswersHeadless.setVertical() method +## SearchHeadless.setVertical() method Sets up Headless to manage the vertical indicated by the verticalKey. diff --git a/docs/search-headless.searchheadless.setverticallimit.md b/docs/search-headless.searchheadless.setverticallimit.md new file mode 100644 index 00000000..5437aa3d --- /dev/null +++ b/docs/search-headless.searchheadless.setverticallimit.md @@ -0,0 +1,24 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [SearchHeadless](./search-headless.searchheadless.md) > [setVerticalLimit](./search-headless.searchheadless.setverticallimit.md) + +## SearchHeadless.setVerticalLimit() method + +Sets [VerticalSearchState.limit](./search-headless.verticalsearchstate.limit.md) to the specified limit. + +Signature: + +```typescript +setVerticalLimit(limit: number): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| limit | number | The vertical limit to set | + +Returns: + +void + diff --git a/docs/search-headless.searchheadless.state.md b/docs/search-headless.searchheadless.state.md new file mode 100644 index 00000000..1fcaa9d9 --- /dev/null +++ b/docs/search-headless.searchheadless.state.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [SearchHeadless](./search-headless.searchheadless.md) > [state](./search-headless.searchheadless.state.md) + +## SearchHeadless.state property + +Gets the current state of the SearchHeadless instance. + +Signature: + +```typescript +get state(): State; +``` diff --git a/docs/search-headless.searchheadless.submitquestion.md b/docs/search-headless.searchheadless.submitquestion.md new file mode 100644 index 00000000..6474f8a3 --- /dev/null +++ b/docs/search-headless.searchheadless.submitquestion.md @@ -0,0 +1,26 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [SearchHeadless](./search-headless.searchheadless.md) > [submitQuestion](./search-headless.searchheadless.submitquestion.md) + +## SearchHeadless.submitQuestion() method + +Submits a question to the Answers API with the specified request data. + +Signature: + +```typescript +submitQuestion(request: Omit): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| request | Omit<[QuestionSubmissionRequest](./search-headless.questionsubmissionrequest.md), 'additionalHttpHeaders'> | The data for the network request | + +Returns: + +Promise<[QuestionSubmissionResponse](./search-headless.questionsubmissionresponse.md)> + +A Promise of a [QuestionSubmissionResponse](./search-headless.questionsubmissionresponse.md) from the Answers API + diff --git a/docs/search-headless.searchheadless.utilities.md b/docs/search-headless.searchheadless.utilities.md new file mode 100644 index 00000000..95060580 --- /dev/null +++ b/docs/search-headless.searchheadless.utilities.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [SearchHeadless](./search-headless.searchheadless.md) > [utilities](./search-headless.searchheadless.utilities.md) + +## SearchHeadless.utilities property + +Common utility functions for manipulating Answers-related data. + +Signature: + +```typescript +readonly utilities: typeof answersUtilities; +``` diff --git a/docs/answers-headless.searchintent.md b/docs/search-headless.searchintent.md similarity index 73% rename from docs/answers-headless.searchintent.md rename to docs/search-headless.searchintent.md index 2df515f5..1efe76de 100644 --- a/docs/answers-headless.searchintent.md +++ b/docs/search-headless.searchintent.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [SearchIntent](./answers-headless.searchintent.md) +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [SearchIntent](./search-headless.searchintent.md) ## SearchIntent enum diff --git a/docs/answers-headless.searchparameterfield.entitytype.md b/docs/search-headless.searchparameterfield.entitytype.md similarity index 50% rename from docs/answers-headless.searchparameterfield.entitytype.md rename to docs/search-headless.searchparameterfield.entitytype.md index 0bdedc7d..45d3d1c7 100644 --- a/docs/answers-headless.searchparameterfield.entitytype.md +++ b/docs/search-headless.searchparameterfield.entitytype.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [SearchParameterField](./answers-headless.searchparameterfield.md) > [entityType](./answers-headless.searchparameterfield.entitytype.md) +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [SearchParameterField](./search-headless.searchparameterfield.md) > [entityType](./search-headless.searchparameterfield.entitytype.md) ## SearchParameterField.entityType property diff --git a/docs/search-headless.searchparameterfield.fetchentities.md b/docs/search-headless.searchparameterfield.fetchentities.md new file mode 100644 index 00000000..d96f32c0 --- /dev/null +++ b/docs/search-headless.searchparameterfield.fetchentities.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [SearchParameterField](./search-headless.searchparameterfield.md) > [fetchEntities](./search-headless.searchparameterfield.fetchentities.md) + +## SearchParameterField.fetchEntities property + +Indicates whether or not to return the [AutocompleteResult.relatedItem](./search-headless.autocompleteresult.relateditem.md) associated with the autocomplete result. + +Signature: + +```typescript +fetchEntities: boolean; +``` diff --git a/docs/answers-headless.searchparameterfield.fieldapiname.md b/docs/search-headless.searchparameterfield.fieldapiname.md similarity index 50% rename from docs/answers-headless.searchparameterfield.fieldapiname.md rename to docs/search-headless.searchparameterfield.fieldapiname.md index 53ee224b..e86d5830 100644 --- a/docs/answers-headless.searchparameterfield.fieldapiname.md +++ b/docs/search-headless.searchparameterfield.fieldapiname.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [SearchParameterField](./answers-headless.searchparameterfield.md) > [fieldApiName](./answers-headless.searchparameterfield.fieldapiname.md) +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [SearchParameterField](./search-headless.searchparameterfield.md) > [fieldApiName](./search-headless.searchparameterfield.fieldapiname.md) ## SearchParameterField.fieldApiName property diff --git a/docs/search-headless.searchparameterfield.md b/docs/search-headless.searchparameterfield.md new file mode 100644 index 00000000..a35148b9 --- /dev/null +++ b/docs/search-headless.searchparameterfield.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [SearchParameterField](./search-headless.searchparameterfield.md) + +## SearchParameterField interface + +Indicates which entity field to perform the autocomplete request on. + +Signature: + +```typescript +export declare interface SearchParameterField +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [entityType](./search-headless.searchparameterfield.entitytype.md) | string | The entityType to perform the autocomplete on. | +| [fetchEntities](./search-headless.searchparameterfield.fetchentities.md) | boolean | Indicates whether or not to return the [AutocompleteResult.relatedItem](./search-headless.autocompleteresult.relateditem.md) associated with the autocomplete result. | +| [fieldApiName](./search-headless.searchparameterfield.fieldapiname.md) | string | The fieldApiName to perform the autocomplete on. | + diff --git a/docs/search-headless.searchservice.md b/docs/search-headless.searchservice.md new file mode 100644 index 00000000..d92e497c --- /dev/null +++ b/docs/search-headless.searchservice.md @@ -0,0 +1,21 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [SearchService](./search-headless.searchservice.md) + +## SearchService interface + +A service which performs Yext Answers searches + +Signature: + +```typescript +export declare interface SearchService +``` + +## Methods + +| Method | Description | +| --- | --- | +| [universalSearch(request)](./search-headless.searchservice.universalsearch.md) | Performs a Universal search across all verticals. | +| [verticalSearch(request)](./search-headless.searchservice.verticalsearch.md) | Performs a search across a particular Vertical. | + diff --git a/docs/answers-headless.searchservice.universalsearch.md b/docs/search-headless.searchservice.universalsearch.md similarity index 53% rename from docs/answers-headless.searchservice.universalsearch.md rename to docs/search-headless.searchservice.universalsearch.md index 66e2d393..d8e0ad8c 100644 --- a/docs/answers-headless.searchservice.universalsearch.md +++ b/docs/search-headless.searchservice.universalsearch.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [SearchService](./answers-headless.searchservice.md) > [universalSearch](./answers-headless.searchservice.universalsearch.md) +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [SearchService](./search-headless.searchservice.md) > [universalSearch](./search-headless.searchservice.universalsearch.md) ## SearchService.universalSearch() method @@ -16,9 +16,9 @@ universalSearch(request: UniversalSearchRequest): PromiseReturns: -Promise<[UniversalSearchResponse](./answers-headless.universalsearchresponse.md)> +Promise<[UniversalSearchResponse](./search-headless.universalsearchresponse.md)> diff --git a/docs/search-headless.searchservice.verticalsearch.md b/docs/search-headless.searchservice.verticalsearch.md new file mode 100644 index 00000000..24af017f --- /dev/null +++ b/docs/search-headless.searchservice.verticalsearch.md @@ -0,0 +1,24 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [SearchService](./search-headless.searchservice.md) > [verticalSearch](./search-headless.searchservice.verticalsearch.md) + +## SearchService.verticalSearch() method + +Performs a search across a particular Vertical. + +Signature: + +```typescript +verticalSearch(request: VerticalSearchRequest): Promise; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| request | [VerticalSearchRequest](./search-headless.verticalsearchrequest.md) | The details of the Vertical search request. | + +Returns: + +Promise<[VerticalSearchResponse](./search-headless.verticalsearchresponse.md)> + diff --git a/docs/answers-headless.searchstatusstate.isloading.md b/docs/search-headless.searchstatusstate.isloading.md similarity index 52% rename from docs/answers-headless.searchstatusstate.isloading.md rename to docs/search-headless.searchstatusstate.isloading.md index 7c8ab149..7b91e681 100644 --- a/docs/answers-headless.searchstatusstate.isloading.md +++ b/docs/search-headless.searchstatusstate.isloading.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [SearchStatusState](./answers-headless.searchstatusstate.md) > [isLoading](./answers-headless.searchstatusstate.isloading.md) +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [SearchStatusState](./search-headless.searchstatusstate.md) > [isLoading](./search-headless.searchstatusstate.isloading.md) ## SearchStatusState.isLoading property diff --git a/docs/search-headless.searchstatusstate.md b/docs/search-headless.searchstatusstate.md new file mode 100644 index 00000000..0ae93784 --- /dev/null +++ b/docs/search-headless.searchstatusstate.md @@ -0,0 +1,20 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [SearchStatusState](./search-headless.searchstatusstate.md) + +## SearchStatusState interface + +Maintains the status of the latest search. + +Signature: + +```typescript +export interface SearchStatusState +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [isLoading?](./search-headless.searchstatusstate.isloading.md) | boolean | (Optional) Whether a search is currently loading or has finished loading. | + diff --git a/docs/answers-headless.searchtype.md b/docs/search-headless.searchtype.md similarity index 53% rename from docs/answers-headless.searchtype.md rename to docs/search-headless.searchtype.md index de4f27ff..c6402b5d 100644 --- a/docs/answers-headless.searchtype.md +++ b/docs/search-headless.searchtype.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [SearchType](./answers-headless.searchtype.md) +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [SearchType](./search-headless.searchtype.md) ## SearchType type @@ -11,5 +11,5 @@ An enum and its corresponding string literals which indicate the type of search ```typescript export declare type SearchType = EnumOrLiteral; ``` -References: [EnumOrLiteral](./answers-headless.enumorliteral.md), [SearchTypeEnum](./answers-headless.searchtypeenum.md) +References: [EnumOrLiteral](./search-headless.enumorliteral.md), [SearchTypeEnum](./search-headless.searchtypeenum.md) diff --git a/docs/answers-headless.searchtypeenum.md b/docs/search-headless.searchtypeenum.md similarity index 78% rename from docs/answers-headless.searchtypeenum.md rename to docs/search-headless.searchtypeenum.md index 657a6527..3f5caf7e 100644 --- a/docs/answers-headless.searchtypeenum.md +++ b/docs/search-headless.searchtypeenum.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [SearchTypeEnum](./answers-headless.searchtypeenum.md) +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [SearchTypeEnum](./search-headless.searchtypeenum.md) ## SearchTypeEnum enum diff --git a/docs/answers-headless.answersutilities.isclosematch.md b/docs/search-headless.searchutilities.isclosematch.md similarity index 67% rename from docs/answers-headless.answersutilities.isclosematch.md rename to docs/search-headless.searchutilities.isclosematch.md index ec014b3e..05fe5ea9 100644 --- a/docs/answers-headless.answersutilities.isclosematch.md +++ b/docs/search-headless.searchutilities.isclosematch.md @@ -1,8 +1,8 @@ -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [answersUtilities](./answers-headless.answersutilities.md) > [isCloseMatch](./answers-headless.answersutilities.isclosematch.md) +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [searchUtilities](./search-headless.searchutilities.md) > [isCloseMatch](./search-headless.searchutilities.isclosematch.md) -## answersUtilities.isCloseMatch() function +## searchUtilities.isCloseMatch() function Checks if the searchTerm is a case-insensitive, Levenshtein match for the value. diff --git a/docs/search-headless.searchutilities.md b/docs/search-headless.searchutilities.md new file mode 100644 index 00000000..48807a3b --- /dev/null +++ b/docs/search-headless.searchutilities.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [searchUtilities](./search-headless.searchutilities.md) + +## searchUtilities namespace + +## Functions + +| Function | Description | +| --- | --- | +| [isCloseMatch(value, searchTerm)](./search-headless.searchutilities.isclosematch.md) | Checks if the searchTerm is a case-insensitive, Levenshtein match for the value. | +| [searchThroughFacet(facet, searchTerm)](./search-headless.searchutilities.searchthroughfacet.md) | Searches through the specified facet and filters out the options that aren't a close match for the given searchTerm. The comparison is case insensitive. | + diff --git a/docs/answers-headless.answersutilities.searchthroughfacet.md b/docs/search-headless.searchutilities.searchthroughfacet.md similarity index 56% rename from docs/answers-headless.answersutilities.searchthroughfacet.md rename to docs/search-headless.searchutilities.searchthroughfacet.md index 8ad3b4ec..2471721e 100644 --- a/docs/answers-headless.answersutilities.searchthroughfacet.md +++ b/docs/search-headless.searchutilities.searchthroughfacet.md @@ -1,8 +1,8 @@ -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [answersUtilities](./answers-headless.answersutilities.md) > [searchThroughFacet](./answers-headless.answersutilities.searchthroughfacet.md) +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [searchUtilities](./search-headless.searchutilities.md) > [searchThroughFacet](./search-headless.searchutilities.searchthroughfacet.md) -## answersUtilities.searchThroughFacet() function +## searchUtilities.searchThroughFacet() function Searches through the specified facet and filters out the options that aren't a close match for the given searchTerm. The comparison is case insensitive. @@ -16,12 +16,12 @@ export declare function searchThroughFacet(facet: DisplayableFacet, searchTerm: | Parameter | Type | Description | | --- | --- | --- | -| facet | [DisplayableFacet](./answers-headless.displayablefacet.md) | The facet whose options are searched through | +| facet | [DisplayableFacet](./search-headless.displayablefacet.md) | The facet whose options are searched through | | searchTerm | string | The search term to compare the facet options against | Returns: -[DisplayableFacet](./answers-headless.displayablefacet.md) +[DisplayableFacet](./search-headless.displayablefacet.md) The facet with only its options that are a close match for the searchTerm diff --git a/docs/search-headless.selectablefilter.displayname.md b/docs/search-headless.selectablefilter.displayname.md new file mode 100644 index 00000000..aff2b7fa --- /dev/null +++ b/docs/search-headless.selectablefilter.displayname.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [SelectableFilter](./search-headless.selectablefilter.md) > [displayName](./search-headless.selectablefilter.displayname.md) + +## SelectableFilter.displayName property + +The filter's display name. + +Signature: + +```typescript +displayName?: string; +``` diff --git a/docs/search-headless.selectablefilter.md b/docs/search-headless.selectablefilter.md new file mode 100644 index 00000000..89e3425b --- /dev/null +++ b/docs/search-headless.selectablefilter.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [SelectableFilter](./search-headless.selectablefilter.md) + +## SelectableFilter interface + +A [Filter](./search-headless.filter.md) with additional information, such as an optional display name and whether or not it is selected. + +Signature: + +```typescript +export interface SelectableFilter extends Filter +``` +Extends: [Filter](./search-headless.filter.md) + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [displayName?](./search-headless.selectablefilter.displayname.md) | string | (Optional) The filter's display name. | +| [selected](./search-headless.selectablefilter.selected.md) | boolean | Whether or not the filter is selected. | + diff --git a/docs/answers-headless.selectablefilter.selected.md b/docs/search-headless.selectablefilter.selected.md similarity index 50% rename from docs/answers-headless.selectablefilter.selected.md rename to docs/search-headless.selectablefilter.selected.md index f73896cd..f76e6be2 100644 --- a/docs/answers-headless.selectablefilter.selected.md +++ b/docs/search-headless.selectablefilter.selected.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [SelectableFilter](./answers-headless.selectablefilter.md) > [selected](./answers-headless.selectablefilter.selected.md) +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [SelectableFilter](./search-headless.selectablefilter.md) > [selected](./search-headless.selectablefilter.selected.md) ## SelectableFilter.selected property diff --git a/docs/answers-headless.sessiontrackingstate.enabled.md b/docs/search-headless.sessiontrackingstate.enabled.md similarity index 50% rename from docs/answers-headless.sessiontrackingstate.enabled.md rename to docs/search-headless.sessiontrackingstate.enabled.md index b765342d..1ab82959 100644 --- a/docs/answers-headless.sessiontrackingstate.enabled.md +++ b/docs/search-headless.sessiontrackingstate.enabled.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [SessionTrackingState](./answers-headless.sessiontrackingstate.md) > [enabled](./answers-headless.sessiontrackingstate.enabled.md) +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [SessionTrackingState](./search-headless.sessiontrackingstate.md) > [enabled](./search-headless.sessiontrackingstate.enabled.md) ## SessionTrackingState.enabled property diff --git a/docs/search-headless.sessiontrackingstate.md b/docs/search-headless.sessiontrackingstate.md new file mode 100644 index 00000000..bdba0877 --- /dev/null +++ b/docs/search-headless.sessiontrackingstate.md @@ -0,0 +1,21 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [SessionTrackingState](./search-headless.sessiontrackingstate.md) + +## SessionTrackingState interface + +Maintains whether the user session should be tracked and, if so, the session information. + +Signature: + +```typescript +export interface SessionTrackingState +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [enabled?](./search-headless.sessiontrackingstate.enabled.md) | boolean | (Optional) Whether or not session tracking is enabled. | +| [sessionId?](./search-headless.sessiontrackingstate.sessionid.md) | string | (Optional) The ID of the current session. Used to track session state when cookies are blocked. | + diff --git a/docs/answers-headless.sessiontrackingstate.sessionid.md b/docs/search-headless.sessiontrackingstate.sessionid.md similarity index 54% rename from docs/answers-headless.sessiontrackingstate.sessionid.md rename to docs/search-headless.sessiontrackingstate.sessionid.md index d766e03e..ce9ecacc 100644 --- a/docs/answers-headless.sessiontrackingstate.sessionid.md +++ b/docs/search-headless.sessiontrackingstate.sessionid.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [SessionTrackingState](./answers-headless.sessiontrackingstate.md) > [sessionId](./answers-headless.sessiontrackingstate.sessionid.md) +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [SessionTrackingState](./search-headless.sessiontrackingstate.md) > [sessionId](./search-headless.sessiontrackingstate.sessionid.md) ## SessionTrackingState.sessionId property diff --git a/docs/answers-headless.snippet.matchedsubstrings.md b/docs/search-headless.snippet.matchedsubstrings.md similarity index 51% rename from docs/answers-headless.snippet.matchedsubstrings.md rename to docs/search-headless.snippet.matchedsubstrings.md index d3e55583..76e87f97 100644 --- a/docs/answers-headless.snippet.matchedsubstrings.md +++ b/docs/search-headless.snippet.matchedsubstrings.md @@ -1,10 +1,10 @@ -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [Snippet](./answers-headless.snippet.md) > [matchedSubstrings](./answers-headless.snippet.matchedsubstrings.md) +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [Snippet](./search-headless.snippet.md) > [matchedSubstrings](./search-headless.snippet.matchedsubstrings.md) ## Snippet.matchedSubstrings property -The locations in the document text of the [FeaturedSnippetDirectAnswer.value](./answers-headless.featuredsnippetdirectanswer.value.md) +The locations in the document text of the [FeaturedSnippetDirectAnswer.value](./search-headless.featuredsnippetdirectanswer.value.md) Signature: diff --git a/docs/search-headless.snippet.md b/docs/search-headless.snippet.md new file mode 100644 index 00000000..f2e68469 --- /dev/null +++ b/docs/search-headless.snippet.md @@ -0,0 +1,21 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [Snippet](./search-headless.snippet.md) + +## Snippet interface + +The section of text where a [FeaturedSnippetDirectAnswer](./search-headless.featuredsnippetdirectanswer.md) was found. + +Signature: + +```typescript +export declare interface Snippet +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [matchedSubstrings](./search-headless.snippet.matchedsubstrings.md) | { offset: number; length: number; }\[\] | The locations in the document text of the [FeaturedSnippetDirectAnswer.value](./search-headless.featuredsnippetdirectanswer.value.md) | +| [value](./search-headless.snippet.value.md) | string | The snippet's body of text | + diff --git a/docs/answers-headless.snippet.value.md b/docs/search-headless.snippet.value.md similarity index 51% rename from docs/answers-headless.snippet.value.md rename to docs/search-headless.snippet.value.md index 680d1103..0d30a821 100644 --- a/docs/answers-headless.snippet.value.md +++ b/docs/search-headless.snippet.value.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [Snippet](./answers-headless.snippet.md) > [value](./answers-headless.snippet.value.md) +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [Snippet](./search-headless.snippet.md) > [value](./search-headless.snippet.value.md) ## Snippet.value property diff --git a/docs/answers-headless.sortby.direction.md b/docs/search-headless.sortby.direction.md similarity index 50% rename from docs/answers-headless.sortby.direction.md rename to docs/search-headless.sortby.direction.md index 0c7f66c5..cfe69169 100644 --- a/docs/answers-headless.sortby.direction.md +++ b/docs/search-headless.sortby.direction.md @@ -1,10 +1,10 @@ -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [SortBy](./answers-headless.sortby.md) > [direction](./answers-headless.sortby.direction.md) +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [SortBy](./search-headless.sortby.md) > [direction](./search-headless.sortby.direction.md) ## SortBy.direction property -The direction of the sort. Required if the SortBy type is [SortType.Field](./answers-headless.sorttype.md). +The direction of the sort. Required if the SortBy type is [SortType.Field](./search-headless.sorttype.md). Signature: diff --git a/docs/search-headless.sortby.field.md b/docs/search-headless.sortby.field.md new file mode 100644 index 00000000..980d0c9b --- /dev/null +++ b/docs/search-headless.sortby.field.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [SortBy](./search-headless.sortby.md) > [field](./search-headless.sortby.field.md) + +## SortBy.field property + +The field name to sort by. Required if the SortBy type is [SortType.Field](./search-headless.sorttype.md). + +Signature: + +```typescript +field?: string; +``` diff --git a/docs/search-headless.sortby.md b/docs/search-headless.sortby.md new file mode 100644 index 00000000..8f19707f --- /dev/null +++ b/docs/search-headless.sortby.md @@ -0,0 +1,26 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [SortBy](./search-headless.sortby.md) + +## SortBy interface + +Represents a criterion that can be used to sort results. + +Signature: + +```typescript +export declare interface SortBy +``` + +## Remarks + +Overrides the sort options that are configured on the experience configuration. + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [direction?](./search-headless.sortby.direction.md) | [Direction](./search-headless.direction.md) | (Optional) The direction of the sort. Required if the SortBy type is [SortType.Field](./search-headless.sorttype.md). | +| [field?](./search-headless.sortby.field.md) | string | (Optional) The field name to sort by. Required if the SortBy type is [SortType.Field](./search-headless.sorttype.md). | +| [type](./search-headless.sortby.type.md) | [SortType](./search-headless.sorttype.md) | The method of sorting. | + diff --git a/docs/answers-headless.sortby.type.md b/docs/search-headless.sortby.type.md similarity index 51% rename from docs/answers-headless.sortby.type.md rename to docs/search-headless.sortby.type.md index 9a2b7abc..7b7b8de8 100644 --- a/docs/answers-headless.sortby.type.md +++ b/docs/search-headless.sortby.type.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [SortBy](./answers-headless.sortby.md) > [type](./answers-headless.sortby.type.md) +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [SortBy](./search-headless.sortby.md) > [type](./search-headless.sortby.type.md) ## SortBy.type property diff --git a/docs/answers-headless.sorttype.md b/docs/search-headless.sorttype.md similarity index 81% rename from docs/answers-headless.sorttype.md rename to docs/search-headless.sorttype.md index 0b86583c..86823db6 100644 --- a/docs/answers-headless.sorttype.md +++ b/docs/search-headless.sorttype.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [SortType](./answers-headless.sorttype.md) +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [SortType](./search-headless.sorttype.md) ## SortType enum diff --git a/docs/answers-headless.source.md b/docs/search-headless.source.md similarity index 78% rename from docs/answers-headless.source.md rename to docs/search-headless.source.md index f219ed0d..121707c6 100644 --- a/docs/answers-headless.source.md +++ b/docs/search-headless.source.md @@ -1,10 +1,10 @@ -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [Source](./answers-headless.source.md) +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [Source](./search-headless.source.md) ## Source enum -Represents the source of a [Result](./answers-headless.result.md). +Represents the source of a [Result](./search-headless.result.md). Signature: diff --git a/docs/answers-headless.spellcheck.correctedquery.md b/docs/search-headless.spellcheck.correctedquery.md similarity index 52% rename from docs/answers-headless.spellcheck.correctedquery.md rename to docs/search-headless.spellcheck.correctedquery.md index 88974a44..d7ee4bf7 100644 --- a/docs/answers-headless.spellcheck.correctedquery.md +++ b/docs/search-headless.spellcheck.correctedquery.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [SpellCheck](./answers-headless.spellcheck.md) > [correctedQuery](./answers-headless.spellcheck.correctedquery.md) +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [SpellCheck](./search-headless.spellcheck.md) > [correctedQuery](./search-headless.spellcheck.correctedquery.md) ## SpellCheck.correctedQuery property diff --git a/docs/search-headless.spellcheck.md b/docs/search-headless.spellcheck.md new file mode 100644 index 00000000..5943a31e --- /dev/null +++ b/docs/search-headless.spellcheck.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [SpellCheck](./search-headless.spellcheck.md) + +## SpellCheck interface + +A spellcheck response from a search query. + +Signature: + +```typescript +export declare interface SpellCheck +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [correctedQuery](./search-headless.spellcheck.correctedquery.md) | string | The corrected version of the originalQuery. | +| [originalQuery](./search-headless.spellcheck.originalquery.md) | string | The query that was input into the spell checker. | +| [type](./search-headless.spellcheck.type.md) | [SpellCheckType](./search-headless.spellchecktype.md) | The type of spell check. | + diff --git a/docs/answers-headless.spellcheck.originalquery.md b/docs/search-headless.spellcheck.originalquery.md similarity index 52% rename from docs/answers-headless.spellcheck.originalquery.md rename to docs/search-headless.spellcheck.originalquery.md index 395d27d8..f184ab52 100644 --- a/docs/answers-headless.spellcheck.originalquery.md +++ b/docs/search-headless.spellcheck.originalquery.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [SpellCheck](./answers-headless.spellcheck.md) > [originalQuery](./answers-headless.spellcheck.originalquery.md) +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [SpellCheck](./search-headless.spellcheck.md) > [originalQuery](./search-headless.spellcheck.originalquery.md) ## SpellCheck.originalQuery property diff --git a/docs/answers-headless.spellcheck.type.md b/docs/search-headless.spellcheck.type.md similarity index 51% rename from docs/answers-headless.spellcheck.type.md rename to docs/search-headless.spellcheck.type.md index 381852e4..fb181ef0 100644 --- a/docs/answers-headless.spellcheck.type.md +++ b/docs/search-headless.spellcheck.type.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [SpellCheck](./answers-headless.spellcheck.md) > [type](./answers-headless.spellcheck.type.md) +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [SpellCheck](./search-headless.spellcheck.md) > [type](./search-headless.spellcheck.type.md) ## SpellCheck.type property diff --git a/docs/answers-headless.spellcheckstate.enabled.md b/docs/search-headless.spellcheckstate.enabled.md similarity index 50% rename from docs/answers-headless.spellcheckstate.enabled.md rename to docs/search-headless.spellcheckstate.enabled.md index a28c0a62..84f84bb9 100644 --- a/docs/answers-headless.spellcheckstate.enabled.md +++ b/docs/search-headless.spellcheckstate.enabled.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [SpellCheckState](./answers-headless.spellcheckstate.md) > [enabled](./answers-headless.spellcheckstate.enabled.md) +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [SpellCheckState](./search-headless.spellcheckstate.md) > [enabled](./search-headless.spellcheckstate.enabled.md) ## SpellCheckState.enabled property diff --git a/docs/answers-headless.spellcheckstate.md b/docs/search-headless.spellcheckstate.md similarity index 51% rename from docs/answers-headless.spellcheckstate.md rename to docs/search-headless.spellcheckstate.md index 7d2b0896..3fa0f3a1 100644 --- a/docs/answers-headless.spellcheckstate.md +++ b/docs/search-headless.spellcheckstate.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [SpellCheckState](./answers-headless.spellcheckstate.md) +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [SpellCheckState](./search-headless.spellcheckstate.md) ## SpellCheckState interface @@ -11,11 +11,11 @@ Maintains whether spellcheck is enabled and the spellcheck response from the lat ```typescript export interface SpellCheckState extends Partial ``` -Extends: Partial<[SpellCheck](./answers-headless.spellcheck.md)> +Extends: Partial<[SpellCheck](./search-headless.spellcheck.md)> ## Properties | Property | Type | Description | | --- | --- | --- | -| [enabled](./answers-headless.spellcheckstate.enabled.md) | boolean | Whether or not spellcheck is enabled. | +| [enabled](./search-headless.spellcheckstate.enabled.md) | boolean | Whether or not spellcheck is enabled. | diff --git a/docs/answers-headless.spellchecktype.md b/docs/search-headless.spellchecktype.md similarity index 80% rename from docs/answers-headless.spellchecktype.md rename to docs/search-headless.spellchecktype.md index 19ed6267..f703f0d8 100644 --- a/docs/answers-headless.spellchecktype.md +++ b/docs/search-headless.spellchecktype.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [SpellCheckType](./answers-headless.spellchecktype.md) +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [SpellCheckType](./search-headless.spellchecktype.md) ## SpellCheckType enum diff --git a/docs/answers-headless.state.directanswer.md b/docs/search-headless.state.directanswer.md similarity index 56% rename from docs/answers-headless.state.directanswer.md rename to docs/search-headless.state.directanswer.md index 047d7f89..73717c99 100644 --- a/docs/answers-headless.state.directanswer.md +++ b/docs/search-headless.state.directanswer.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [State](./answers-headless.state.md) > [directAnswer](./answers-headless.state.directanswer.md) +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [State](./search-headless.state.md) > [directAnswer](./search-headless.state.directanswer.md) ## State.directAnswer property diff --git a/docs/answers-headless.state.filters.md b/docs/search-headless.state.filters.md similarity index 57% rename from docs/answers-headless.state.filters.md rename to docs/search-headless.state.filters.md index 5fd9d3c8..4cf02d72 100644 --- a/docs/answers-headless.state.filters.md +++ b/docs/search-headless.state.filters.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [State](./answers-headless.state.md) > [filters](./answers-headless.state.filters.md) +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [State](./search-headless.state.md) > [filters](./search-headless.state.filters.md) ## State.filters property diff --git a/docs/answers-headless.state.location.md b/docs/search-headless.state.location.md similarity index 60% rename from docs/answers-headless.state.location.md rename to docs/search-headless.state.location.md index 74116b3b..21368a66 100644 --- a/docs/answers-headless.state.location.md +++ b/docs/search-headless.state.location.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [State](./answers-headless.state.md) > [location](./answers-headless.state.location.md) +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [State](./search-headless.state.md) > [location](./search-headless.state.location.md) ## State.location property diff --git a/docs/search-headless.state.md b/docs/search-headless.state.md new file mode 100644 index 00000000..52c607b5 --- /dev/null +++ b/docs/search-headless.state.md @@ -0,0 +1,30 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [State](./search-headless.state.md) + +## State interface + +The state representing a SearchHeadless instance. + +Signature: + +```typescript +export interface State +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [directAnswer](./search-headless.state.directanswer.md) | [DirectAnswerState](./search-headless.directanswerstate.md) | Maintains the direct answer associated with the latest search. | +| [filters](./search-headless.state.filters.md) | [FiltersState](./search-headless.filtersstate.md) | Maintains the current state of facets and filters in the application. | +| [location](./search-headless.state.location.md) | [LocationState](./search-headless.locationstate.md) | Maintains the user's location, if given, or the inferred location, that is used to bias search results. | +| [meta](./search-headless.state.meta.md) | [MetaState](./search-headless.metastate.md) | Maintains the metadata for Answers Headless. | +| [query](./search-headless.state.query.md) | [QueryState](./search-headless.querystate.md) | Maintains the latest query and its associated data. | +| [queryRules](./search-headless.state.queryrules.md) | [QueryRulesState](./search-headless.queryrulesstate.md) | Maintains the data from the triggered query rules. | +| [searchStatus](./search-headless.state.searchstatus.md) | [SearchStatusState](./search-headless.searchstatusstate.md) | Maintains the status of the latest search. | +| [sessionTracking](./search-headless.state.sessiontracking.md) | [SessionTrackingState](./search-headless.sessiontrackingstate.md) | Maintains whether the user session should be tracked and, if so, the session information. | +| [spellCheck](./search-headless.state.spellcheck.md) | [SpellCheckState](./search-headless.spellcheckstate.md) | Maintains whether spellcheck is enabled and the spellcheck response from the latest search. | +| [universal](./search-headless.state.universal.md) | [UniversalSearchState](./search-headless.universalsearchstate.md) | Maintains the data for the latest universal search. | +| [vertical](./search-headless.state.vertical.md) | [VerticalSearchState](./search-headless.verticalsearchstate.md) | Maintains the data for the latest vertical search. | + diff --git a/docs/answers-headless.state.meta.md b/docs/search-headless.state.meta.md similarity index 54% rename from docs/answers-headless.state.meta.md rename to docs/search-headless.state.meta.md index d824b5db..1b610f88 100644 --- a/docs/answers-headless.state.meta.md +++ b/docs/search-headless.state.meta.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [State](./answers-headless.state.md) > [meta](./answers-headless.state.meta.md) +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [State](./search-headless.state.md) > [meta](./search-headless.state.meta.md) ## State.meta property diff --git a/docs/answers-headless.state.query.md b/docs/search-headless.state.query.md similarity index 55% rename from docs/answers-headless.state.query.md rename to docs/search-headless.state.query.md index ef0ab03c..5ae4003a 100644 --- a/docs/answers-headless.state.query.md +++ b/docs/search-headless.state.query.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [State](./answers-headless.state.md) > [query](./answers-headless.state.query.md) +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [State](./search-headless.state.md) > [query](./search-headless.state.query.md) ## State.query property diff --git a/docs/answers-headless.state.queryrules.md b/docs/search-headless.state.queryrules.md similarity index 55% rename from docs/answers-headless.state.queryrules.md rename to docs/search-headless.state.queryrules.md index 538ff798..3e319932 100644 --- a/docs/answers-headless.state.queryrules.md +++ b/docs/search-headless.state.queryrules.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [State](./answers-headless.state.md) > [queryRules](./answers-headless.state.queryrules.md) +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [State](./search-headless.state.md) > [queryRules](./search-headless.state.queryrules.md) ## State.queryRules property diff --git a/docs/answers-headless.state.searchstatus.md b/docs/search-headless.state.searchstatus.md similarity index 54% rename from docs/answers-headless.state.searchstatus.md rename to docs/search-headless.state.searchstatus.md index 40e604a6..0794e184 100644 --- a/docs/answers-headless.state.searchstatus.md +++ b/docs/search-headless.state.searchstatus.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [State](./answers-headless.state.md) > [searchStatus](./answers-headless.state.searchstatus.md) +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [State](./search-headless.state.md) > [searchStatus](./search-headless.state.searchstatus.md) ## State.searchStatus property diff --git a/docs/answers-headless.state.sessiontracking.md b/docs/search-headless.state.sessiontracking.md similarity index 59% rename from docs/answers-headless.state.sessiontracking.md rename to docs/search-headless.state.sessiontracking.md index cbd8f5c1..fecfcc6e 100644 --- a/docs/answers-headless.state.sessiontracking.md +++ b/docs/search-headless.state.sessiontracking.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [State](./answers-headless.state.md) > [sessionTracking](./answers-headless.state.sessiontracking.md) +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [State](./search-headless.state.md) > [sessionTracking](./search-headless.state.sessiontracking.md) ## State.sessionTracking property diff --git a/docs/answers-headless.state.spellcheck.md b/docs/search-headless.state.spellcheck.md similarity index 59% rename from docs/answers-headless.state.spellcheck.md rename to docs/search-headless.state.spellcheck.md index 05ee931b..3082b142 100644 --- a/docs/answers-headless.state.spellcheck.md +++ b/docs/search-headless.state.spellcheck.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [State](./answers-headless.state.md) > [spellCheck](./answers-headless.state.spellcheck.md) +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [State](./search-headless.state.md) > [spellCheck](./search-headless.state.spellcheck.md) ## State.spellCheck property diff --git a/docs/answers-headless.state.universal.md b/docs/search-headless.state.universal.md similarity index 56% rename from docs/answers-headless.state.universal.md rename to docs/search-headless.state.universal.md index 50f87043..51db552f 100644 --- a/docs/answers-headless.state.universal.md +++ b/docs/search-headless.state.universal.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [State](./answers-headless.state.md) > [universal](./answers-headless.state.universal.md) +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [State](./search-headless.state.md) > [universal](./search-headless.state.universal.md) ## State.universal property diff --git a/docs/answers-headless.state.vertical.md b/docs/search-headless.state.vertical.md similarity index 56% rename from docs/answers-headless.state.vertical.md rename to docs/search-headless.state.vertical.md index f91c55dc..09b4bc28 100644 --- a/docs/answers-headless.state.vertical.md +++ b/docs/search-headless.state.vertical.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [State](./answers-headless.state.md) > [vertical](./answers-headless.state.vertical.md) +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [State](./search-headless.state.md) > [vertical](./search-headless.state.vertical.md) ## State.vertical property diff --git a/docs/answers-headless.statelistener.callback.md b/docs/search-headless.statelistener.callback.md similarity index 64% rename from docs/answers-headless.statelistener.callback.md rename to docs/search-headless.statelistener.callback.md index 8660df44..6d4033d0 100644 --- a/docs/answers-headless.statelistener.callback.md +++ b/docs/search-headless.statelistener.callback.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [StateListener](./answers-headless.statelistener.md) > [callback](./answers-headless.statelistener.callback.md) +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [StateListener](./search-headless.statelistener.md) > [callback](./search-headless.statelistener.callback.md) ## StateListener.callback() method diff --git a/docs/search-headless.statelistener.md b/docs/search-headless.statelistener.md new file mode 100644 index 00000000..b5594c40 --- /dev/null +++ b/docs/search-headless.statelistener.md @@ -0,0 +1,21 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [StateListener](./search-headless.statelistener.md) + +## StateListener interface + +Represents a listener for a specific value of type T in the state. + +Signature: + +```typescript +export default interface StateListener +``` + +## Methods + +| Method | Description | +| --- | --- | +| [callback(currentValue)](./search-headless.statelistener.callback.md) | The function to call when the state value updates. | +| [valueAccessor(state)](./search-headless.statelistener.valueaccessor.md) | Accesses a value of type T in the state. | + diff --git a/docs/answers-headless.statelistener.valueaccessor.md b/docs/search-headless.statelistener.valueaccessor.md similarity index 55% rename from docs/answers-headless.statelistener.valueaccessor.md rename to docs/search-headless.statelistener.valueaccessor.md index c914cd10..5b79cac3 100644 --- a/docs/answers-headless.statelistener.valueaccessor.md +++ b/docs/search-headless.statelistener.valueaccessor.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [StateListener](./answers-headless.statelistener.md) > [valueAccessor](./answers-headless.statelistener.valueaccessor.md) +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [StateListener](./search-headless.statelistener.md) > [valueAccessor](./search-headless.statelistener.valueaccessor.md) ## StateListener.valueAccessor() method @@ -16,7 +16,7 @@ valueAccessor(state: State): T; | Parameter | Type | Description | | --- | --- | --- | -| state | [State](./answers-headless.state.md) | The current state | +| state | [State](./search-headless.state.md) | The current state | Returns: diff --git a/docs/answers-headless.statemanager.addlistener.md b/docs/search-headless.statemanager.addlistener.md similarity index 68% rename from docs/answers-headless.statemanager.addlistener.md rename to docs/search-headless.statemanager.addlistener.md index 84a49372..4320bed6 100644 --- a/docs/answers-headless.statemanager.addlistener.md +++ b/docs/search-headless.statemanager.addlistener.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [StateManager](./answers-headless.statemanager.md) > [addListener](./answers-headless.statemanager.addlistener.md) +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [StateManager](./search-headless.statemanager.md) > [addListener](./search-headless.statemanager.addlistener.md) ## StateManager.addListener() method diff --git a/docs/answers-headless.statemanager.dispatchevent.md b/docs/search-headless.statemanager.dispatchevent.md similarity index 57% rename from docs/answers-headless.statemanager.dispatchevent.md rename to docs/search-headless.statemanager.dispatchevent.md index 50ae8734..5621af4d 100644 --- a/docs/answers-headless.statemanager.dispatchevent.md +++ b/docs/search-headless.statemanager.dispatchevent.md @@ -1,10 +1,10 @@ -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [StateManager](./answers-headless.statemanager.md) > [dispatchEvent](./answers-headless.statemanager.dispatchevent.md) +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [StateManager](./search-headless.statemanager.md) > [dispatchEvent](./search-headless.statemanager.dispatchevent.md) ## StateManager.dispatchEvent() method -Dispatches an event. This can update the [State](./answers-headless.state.md). +Dispatches an event. This can update the [State](./search-headless.state.md). Signature: diff --git a/docs/search-headless.statemanager.getstate.md b/docs/search-headless.statemanager.getstate.md new file mode 100644 index 00000000..9a373c78 --- /dev/null +++ b/docs/search-headless.statemanager.getstate.md @@ -0,0 +1,17 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [StateManager](./search-headless.statemanager.md) > [getState](./search-headless.statemanager.getstate.md) + +## StateManager.getState() method + +Returns the current state. + +Signature: + +```typescript +getState(): State; +``` +Returns: + +[State](./search-headless.state.md) + diff --git a/docs/search-headless.statemanager.md b/docs/search-headless.statemanager.md new file mode 100644 index 00000000..b838ab48 --- /dev/null +++ b/docs/search-headless.statemanager.md @@ -0,0 +1,26 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [StateManager](./search-headless.statemanager.md) + +## StateManager interface + +Manages the information contained in the state for an SearchHeadless instance. + +Signature: + +```typescript +export default interface StateManager +``` + +## Remarks + +The [State](./search-headless.state.md) is immutable, and can only be updated by dispatched events. + +## Methods + +| Method | Description | +| --- | --- | +| [addListener(listener)](./search-headless.statemanager.addlistener.md) | Adds a listener for a specific state value of type T. | +| [dispatchEvent(type, payload)](./search-headless.statemanager.dispatchevent.md) | Dispatches an event. This can update the [State](./search-headless.state.md). | +| [getState()](./search-headless.statemanager.getstate.md) | Returns the current state. | + diff --git a/docs/search-headless.universalautocompleterequest.input.md b/docs/search-headless.universalautocompleterequest.input.md new file mode 100644 index 00000000..196dfc59 --- /dev/null +++ b/docs/search-headless.universalautocompleterequest.input.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [UniversalAutocompleteRequest](./search-headless.universalautocompleterequest.md) > [input](./search-headless.universalautocompleterequest.input.md) + +## UniversalAutocompleteRequest.input property + +The input string for autocomplete. + +Signature: + +```typescript +input: string; +``` diff --git a/docs/search-headless.universalautocompleterequest.md b/docs/search-headless.universalautocompleterequest.md new file mode 100644 index 00000000..4e67bb45 --- /dev/null +++ b/docs/search-headless.universalautocompleterequest.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [UniversalAutocompleteRequest](./search-headless.universalautocompleterequest.md) + +## UniversalAutocompleteRequest interface + +Options for a universal autocomplete request. + +Signature: + +```typescript +export declare interface UniversalAutocompleteRequest extends AnswersRequest +``` +Extends: [AnswersRequest](./search-headless.answersrequest.md) + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [input](./search-headless.universalautocompleterequest.input.md) | string | The input string for autocomplete. | +| [sessionTrackingEnabled?](./search-headless.universalautocompleterequest.sessiontrackingenabled.md) | boolean | (Optional) Enables session tracking. | + diff --git a/docs/search-headless.universalautocompleterequest.sessiontrackingenabled.md b/docs/search-headless.universalautocompleterequest.sessiontrackingenabled.md new file mode 100644 index 00000000..3a5bd51a --- /dev/null +++ b/docs/search-headless.universalautocompleterequest.sessiontrackingenabled.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [UniversalAutocompleteRequest](./search-headless.universalautocompleterequest.md) > [sessionTrackingEnabled](./search-headless.universalautocompleterequest.sessiontrackingenabled.md) + +## UniversalAutocompleteRequest.sessionTrackingEnabled property + +Enables session tracking. + +Signature: + +```typescript +sessionTrackingEnabled?: boolean; +``` diff --git a/docs/answers-headless.universallimit.md b/docs/search-headless.universallimit.md similarity index 68% rename from docs/answers-headless.universallimit.md rename to docs/search-headless.universallimit.md index ced1acab..833abb68 100644 --- a/docs/answers-headless.universallimit.md +++ b/docs/search-headless.universallimit.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [UniversalLimit](./answers-headless.universallimit.md) +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [UniversalLimit](./search-headless.universallimit.md) ## UniversalLimit interface diff --git a/docs/answers-headless.universalsearchrequest.context.md b/docs/search-headless.universalsearchrequest.context.md similarity index 59% rename from docs/answers-headless.universalsearchrequest.context.md rename to docs/search-headless.universalsearchrequest.context.md index 28345d5c..8016f0ca 100644 --- a/docs/answers-headless.universalsearchrequest.context.md +++ b/docs/search-headless.universalsearchrequest.context.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [UniversalSearchRequest](./answers-headless.universalsearchrequest.md) > [context](./answers-headless.universalsearchrequest.context.md) +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [UniversalSearchRequest](./search-headless.universalsearchrequest.md) > [context](./search-headless.universalsearchrequest.context.md) ## UniversalSearchRequest.context property diff --git a/docs/answers-headless.universalsearchrequest.limit.md b/docs/search-headless.universalsearchrequest.limit.md similarity index 54% rename from docs/answers-headless.universalsearchrequest.limit.md rename to docs/search-headless.universalsearchrequest.limit.md index 6e75d83a..a1ef4c3d 100644 --- a/docs/answers-headless.universalsearchrequest.limit.md +++ b/docs/search-headless.universalsearchrequest.limit.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [UniversalSearchRequest](./answers-headless.universalsearchrequest.md) > [limit](./answers-headless.universalsearchrequest.limit.md) +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [UniversalSearchRequest](./search-headless.universalsearchrequest.md) > [limit](./search-headless.universalsearchrequest.limit.md) ## UniversalSearchRequest.limit property diff --git a/docs/answers-headless.universalsearchrequest.location.md b/docs/search-headless.universalsearchrequest.location.md similarity index 60% rename from docs/answers-headless.universalsearchrequest.location.md rename to docs/search-headless.universalsearchrequest.location.md index a99405ad..b4ee7257 100644 --- a/docs/answers-headless.universalsearchrequest.location.md +++ b/docs/search-headless.universalsearchrequest.location.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [UniversalSearchRequest](./answers-headless.universalsearchrequest.md) > [location](./answers-headless.universalsearchrequest.location.md) +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [UniversalSearchRequest](./search-headless.universalsearchrequest.md) > [location](./search-headless.universalsearchrequest.location.md) ## UniversalSearchRequest.location property diff --git a/docs/search-headless.universalsearchrequest.md b/docs/search-headless.universalsearchrequest.md new file mode 100644 index 00000000..c33262b0 --- /dev/null +++ b/docs/search-headless.universalsearchrequest.md @@ -0,0 +1,31 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [UniversalSearchRequest](./search-headless.universalsearchrequest.md) + +## UniversalSearchRequest interface + +Options which can be specified for a universal search. + +Signature: + +```typescript +export declare interface UniversalSearchRequest extends AnswersRequest +``` +Extends: [AnswersRequest](./search-headless.answersrequest.md) + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [context?](./search-headless.universalsearchrequest.context.md) | [Context](./search-headless.context.md) | (Optional) Used to trigger Answers [Query Rules](https://hitchhikers.yext.com/tracks/answers-advanced/ans302-query-rules/). | +| [limit?](./search-headless.universalsearchrequest.limit.md) | [UniversalLimit](./search-headless.universallimit.md) | (Optional) The maximum limit of results per vertical. Each limit can be set from 1-50, inclusive. | +| [location?](./search-headless.universalsearchrequest.location.md) | [LatLong](./search-headless.latlong.md) | (Optional) The latitude and longitude of the user making the request. Used to bias the results. | +| [query](./search-headless.universalsearchrequest.query.md) | string | The search query. | +| [querySource?](./search-headless.universalsearchrequest.querysource.md) | [QuerySource](./search-headless.querysource.md) \| string | (Optional) The source of the search request. | +| [queryTrigger?](./search-headless.universalsearchrequest.querytrigger.md) | [QueryTrigger](./search-headless.querytrigger.md) | (Optional) Describes the ways a search can be executed besides user input. | +| [referrerPageUrl?](./search-headless.universalsearchrequest.referrerpageurl.md) | string | (Optional) The URl of the page which referred the user to the current page. | +| [restrictVerticals?](./search-headless.universalsearchrequest.restrictverticals.md) | string\[\] | (Optional) If included, the response will only include these verticals. | +| [sessionId?](./search-headless.universalsearchrequest.sessionid.md) | string | (Optional) Used to track session state when cookies are blocked. | +| [sessionTrackingEnabled?](./search-headless.universalsearchrequest.sessiontrackingenabled.md) | boolean | (Optional) Enables session tracking. | +| [skipSpellCheck?](./search-headless.universalsearchrequest.skipspellcheck.md) | boolean | (Optional) Disables spellcheck if true. | + diff --git a/docs/search-headless.universalsearchrequest.query.md b/docs/search-headless.universalsearchrequest.query.md new file mode 100644 index 00000000..53e2b80f --- /dev/null +++ b/docs/search-headless.universalsearchrequest.query.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [UniversalSearchRequest](./search-headless.universalsearchrequest.md) > [query](./search-headless.universalsearchrequest.query.md) + +## UniversalSearchRequest.query property + +The search query. + +Signature: + +```typescript +query: string; +``` diff --git a/docs/answers-headless.universalsearchrequest.querysource.md b/docs/search-headless.universalsearchrequest.querysource.md similarity index 50% rename from docs/answers-headless.universalsearchrequest.querysource.md rename to docs/search-headless.universalsearchrequest.querysource.md index 2ca94eae..dc3e331f 100644 --- a/docs/answers-headless.universalsearchrequest.querysource.md +++ b/docs/search-headless.universalsearchrequest.querysource.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [UniversalSearchRequest](./answers-headless.universalsearchrequest.md) > [querySource](./answers-headless.universalsearchrequest.querysource.md) +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [UniversalSearchRequest](./search-headless.universalsearchrequest.md) > [querySource](./search-headless.universalsearchrequest.querysource.md) ## UniversalSearchRequest.querySource property diff --git a/docs/answers-headless.universalsearchrequest.querytrigger.md b/docs/search-headless.universalsearchrequest.querytrigger.md similarity index 60% rename from docs/answers-headless.universalsearchrequest.querytrigger.md rename to docs/search-headless.universalsearchrequest.querytrigger.md index 3cc11294..3beb2904 100644 --- a/docs/answers-headless.universalsearchrequest.querytrigger.md +++ b/docs/search-headless.universalsearchrequest.querytrigger.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [UniversalSearchRequest](./answers-headless.universalsearchrequest.md) > [queryTrigger](./answers-headless.universalsearchrequest.querytrigger.md) +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [UniversalSearchRequest](./search-headless.universalsearchrequest.md) > [queryTrigger](./search-headless.universalsearchrequest.querytrigger.md) ## UniversalSearchRequest.queryTrigger property diff --git a/docs/answers-headless.universalsearchrequest.referrerpageurl.md b/docs/search-headless.universalsearchrequest.referrerpageurl.md similarity index 63% rename from docs/answers-headless.universalsearchrequest.referrerpageurl.md rename to docs/search-headless.universalsearchrequest.referrerpageurl.md index 82a59dc0..aa7edf37 100644 --- a/docs/answers-headless.universalsearchrequest.referrerpageurl.md +++ b/docs/search-headless.universalsearchrequest.referrerpageurl.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [UniversalSearchRequest](./answers-headless.universalsearchrequest.md) > [referrerPageUrl](./answers-headless.universalsearchrequest.referrerpageurl.md) +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [UniversalSearchRequest](./search-headless.universalsearchrequest.md) > [referrerPageUrl](./search-headless.universalsearchrequest.referrerpageurl.md) ## UniversalSearchRequest.referrerPageUrl property diff --git a/docs/answers-headless.universalsearchrequest.restrictverticals.md b/docs/search-headless.universalsearchrequest.restrictverticals.md similarity index 51% rename from docs/answers-headless.universalsearchrequest.restrictverticals.md rename to docs/search-headless.universalsearchrequest.restrictverticals.md index 309e6864..341cfbf9 100644 --- a/docs/answers-headless.universalsearchrequest.restrictverticals.md +++ b/docs/search-headless.universalsearchrequest.restrictverticals.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [UniversalSearchRequest](./answers-headless.universalsearchrequest.md) > [restrictVerticals](./answers-headless.universalsearchrequest.restrictverticals.md) +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [UniversalSearchRequest](./search-headless.universalsearchrequest.md) > [restrictVerticals](./search-headless.universalsearchrequest.restrictverticals.md) ## UniversalSearchRequest.restrictVerticals property diff --git a/docs/answers-headless.universalsearchrequest.sessionid.md b/docs/search-headless.universalsearchrequest.sessionid.md similarity index 50% rename from docs/answers-headless.universalsearchrequest.sessionid.md rename to docs/search-headless.universalsearchrequest.sessionid.md index afe20bec..dc9edf67 100644 --- a/docs/answers-headless.universalsearchrequest.sessionid.md +++ b/docs/search-headless.universalsearchrequest.sessionid.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [UniversalSearchRequest](./answers-headless.universalsearchrequest.md) > [sessionId](./answers-headless.universalsearchrequest.sessionid.md) +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [UniversalSearchRequest](./search-headless.universalsearchrequest.md) > [sessionId](./search-headless.universalsearchrequest.sessionid.md) ## UniversalSearchRequest.sessionId property diff --git a/docs/search-headless.universalsearchrequest.sessiontrackingenabled.md b/docs/search-headless.universalsearchrequest.sessiontrackingenabled.md new file mode 100644 index 00000000..263ad5e6 --- /dev/null +++ b/docs/search-headless.universalsearchrequest.sessiontrackingenabled.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [UniversalSearchRequest](./search-headless.universalsearchrequest.md) > [sessionTrackingEnabled](./search-headless.universalsearchrequest.sessiontrackingenabled.md) + +## UniversalSearchRequest.sessionTrackingEnabled property + +Enables session tracking. + +Signature: + +```typescript +sessionTrackingEnabled?: boolean; +``` diff --git a/docs/search-headless.universalsearchrequest.skipspellcheck.md b/docs/search-headless.universalsearchrequest.skipspellcheck.md new file mode 100644 index 00000000..ac4d1916 --- /dev/null +++ b/docs/search-headless.universalsearchrequest.skipspellcheck.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [UniversalSearchRequest](./search-headless.universalsearchrequest.md) > [skipSpellCheck](./search-headless.universalsearchrequest.skipspellcheck.md) + +## UniversalSearchRequest.skipSpellCheck property + +Disables spellcheck if true. + +Signature: + +```typescript +skipSpellCheck?: boolean; +``` diff --git a/docs/answers-headless.universalsearchresponse.directanswer.md b/docs/search-headless.universalsearchresponse.directanswer.md similarity index 52% rename from docs/answers-headless.universalsearchresponse.directanswer.md rename to docs/search-headless.universalsearchresponse.directanswer.md index f7ceb1d8..b481219b 100644 --- a/docs/answers-headless.universalsearchresponse.directanswer.md +++ b/docs/search-headless.universalsearchresponse.directanswer.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [UniversalSearchResponse](./answers-headless.universalsearchresponse.md) > [directAnswer](./answers-headless.universalsearchresponse.directanswer.md) +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [UniversalSearchResponse](./search-headless.universalsearchresponse.md) > [directAnswer](./search-headless.universalsearchresponse.directanswer.md) ## UniversalSearchResponse.directAnswer property diff --git a/docs/answers-headless.universalsearchresponse.failedverticals.md b/docs/search-headless.universalsearchresponse.failedverticals.md similarity index 52% rename from docs/answers-headless.universalsearchresponse.failedverticals.md rename to docs/search-headless.universalsearchresponse.failedverticals.md index 899516a6..1921614d 100644 --- a/docs/answers-headless.universalsearchresponse.failedverticals.md +++ b/docs/search-headless.universalsearchresponse.failedverticals.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [UniversalSearchResponse](./answers-headless.universalsearchresponse.md) > [failedVerticals](./answers-headless.universalsearchresponse.failedverticals.md) +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [UniversalSearchResponse](./search-headless.universalsearchresponse.md) > [failedVerticals](./search-headless.universalsearchresponse.failedverticals.md) ## UniversalSearchResponse.failedVerticals property diff --git a/docs/search-headless.universalsearchresponse.locationbias.md b/docs/search-headless.universalsearchresponse.locationbias.md new file mode 100644 index 00000000..b0c211c9 --- /dev/null +++ b/docs/search-headless.universalsearchresponse.locationbias.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [UniversalSearchResponse](./search-headless.universalsearchresponse.md) > [locationBias](./search-headless.universalsearchresponse.locationbias.md) + +## UniversalSearchResponse.locationBias property + +Information about the user's location. + +Signature: + +```typescript +locationBias?: LocationBias; +``` diff --git a/docs/search-headless.universalsearchresponse.md b/docs/search-headless.universalsearchresponse.md new file mode 100644 index 00000000..bd2e465b --- /dev/null +++ b/docs/search-headless.universalsearchresponse.md @@ -0,0 +1,28 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [UniversalSearchResponse](./search-headless.universalsearchresponse.md) + +## UniversalSearchResponse interface + +A representation of a response from a universal search. + +Signature: + +```typescript +export declare interface UniversalSearchResponse +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [directAnswer?](./search-headless.universalsearchresponse.directanswer.md) | [FeaturedSnippetDirectAnswer](./search-headless.featuredsnippetdirectanswer.md) \| [FieldValueDirectAnswer](./search-headless.fieldvaluedirectanswer.md) | (Optional) A direct answer to a search. | +| [failedVerticals?](./search-headless.universalsearchresponse.failedverticals.md) | [FailedVertical](./search-headless.failedvertical.md)\[\] | (Optional) Error information from when a vertical fails to return results. | +| [locationBias?](./search-headless.universalsearchresponse.locationbias.md) | [LocationBias](./search-headless.locationbias.md) | (Optional) Information about the user's location. | +| [queryId?](./search-headless.universalsearchresponse.queryid.md) | string | (Optional) The ID of the search query. | +| [queryRulesActionsData?](./search-headless.universalsearchresponse.queryrulesactionsdata.md) | [QueryRulesActionsData](./search-headless.queryrulesactionsdata.md)\[\] | (Optional) Data returned from the Answers query rules system. | +| [searchIntents?](./search-headless.universalsearchresponse.searchintents.md) | [SearchIntent](./search-headless.searchintent.md)\[\] | (Optional) An array of [SearchIntent](./search-headless.searchintent.md)s which represents requests from the API. | +| [spellCheck?](./search-headless.universalsearchresponse.spellcheck.md) | [SpellCheck](./search-headless.spellcheck.md) | (Optional) A spellcheck response from a search query. | +| [uuid](./search-headless.universalsearchresponse.uuid.md) | string | A unique id which corresponds to the request. | +| [verticalResults](./search-headless.universalsearchresponse.verticalresults.md) | [VerticalResults](./search-headless.verticalresults.md)\[\] | An array of [VerticalResults](./search-headless.verticalresults.md) which represent the results for each vertical. | + diff --git a/docs/search-headless.universalsearchresponse.queryid.md b/docs/search-headless.universalsearchresponse.queryid.md new file mode 100644 index 00000000..7d3e9112 --- /dev/null +++ b/docs/search-headless.universalsearchresponse.queryid.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [UniversalSearchResponse](./search-headless.universalsearchresponse.md) > [queryId](./search-headless.universalsearchresponse.queryid.md) + +## UniversalSearchResponse.queryId property + +The ID of the search query. + +Signature: + +```typescript +queryId?: string; +``` diff --git a/docs/answers-headless.universalsearchresponse.queryrulesactionsdata.md b/docs/search-headless.universalsearchresponse.queryrulesactionsdata.md similarity index 51% rename from docs/answers-headless.universalsearchresponse.queryrulesactionsdata.md rename to docs/search-headless.universalsearchresponse.queryrulesactionsdata.md index 5a816cda..24374dfd 100644 --- a/docs/answers-headless.universalsearchresponse.queryrulesactionsdata.md +++ b/docs/search-headless.universalsearchresponse.queryrulesactionsdata.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [UniversalSearchResponse](./answers-headless.universalsearchresponse.md) > [queryRulesActionsData](./answers-headless.universalsearchresponse.queryrulesactionsdata.md) +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [UniversalSearchResponse](./search-headless.universalsearchresponse.md) > [queryRulesActionsData](./search-headless.universalsearchresponse.queryrulesactionsdata.md) ## UniversalSearchResponse.queryRulesActionsData property diff --git a/docs/search-headless.universalsearchresponse.searchintents.md b/docs/search-headless.universalsearchresponse.searchintents.md new file mode 100644 index 00000000..18441666 --- /dev/null +++ b/docs/search-headless.universalsearchresponse.searchintents.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [UniversalSearchResponse](./search-headless.universalsearchresponse.md) > [searchIntents](./search-headless.universalsearchresponse.searchintents.md) + +## UniversalSearchResponse.searchIntents property + +An array of [SearchIntent](./search-headless.searchintent.md)s which represents requests from the API. + +Signature: + +```typescript +searchIntents?: SearchIntent[]; +``` diff --git a/docs/search-headless.universalsearchresponse.spellcheck.md b/docs/search-headless.universalsearchresponse.spellcheck.md new file mode 100644 index 00000000..8308898f --- /dev/null +++ b/docs/search-headless.universalsearchresponse.spellcheck.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [UniversalSearchResponse](./search-headless.universalsearchresponse.md) > [spellCheck](./search-headless.universalsearchresponse.spellcheck.md) + +## UniversalSearchResponse.spellCheck property + +A spellcheck response from a search query. + +Signature: + +```typescript +spellCheck?: SpellCheck; +``` diff --git a/docs/search-headless.universalsearchresponse.uuid.md b/docs/search-headless.universalsearchresponse.uuid.md new file mode 100644 index 00000000..035917a5 --- /dev/null +++ b/docs/search-headless.universalsearchresponse.uuid.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [UniversalSearchResponse](./search-headless.universalsearchresponse.md) > [uuid](./search-headless.universalsearchresponse.uuid.md) + +## UniversalSearchResponse.uuid property + +A unique id which corresponds to the request. + +Signature: + +```typescript +uuid: string; +``` diff --git a/docs/search-headless.universalsearchresponse.verticalresults.md b/docs/search-headless.universalsearchresponse.verticalresults.md new file mode 100644 index 00000000..d5642608 --- /dev/null +++ b/docs/search-headless.universalsearchresponse.verticalresults.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [UniversalSearchResponse](./search-headless.universalsearchresponse.md) > [verticalResults](./search-headless.universalsearchresponse.verticalresults.md) + +## UniversalSearchResponse.verticalResults property + +An array of [VerticalResults](./search-headless.verticalresults.md) which represent the results for each vertical. + +Signature: + +```typescript +verticalResults: VerticalResults[]; +``` diff --git a/docs/answers-headless.universalsearchstate.limit.md b/docs/search-headless.universalsearchstate.limit.md similarity index 55% rename from docs/answers-headless.universalsearchstate.limit.md rename to docs/search-headless.universalsearchstate.limit.md index e3a90cc4..2c2dd2b3 100644 --- a/docs/answers-headless.universalsearchstate.limit.md +++ b/docs/search-headless.universalsearchstate.limit.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [UniversalSearchState](./answers-headless.universalsearchstate.md) > [limit](./answers-headless.universalsearchstate.limit.md) +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [UniversalSearchState](./search-headless.universalsearchstate.md) > [limit](./search-headless.universalsearchstate.limit.md) ## UniversalSearchState.limit property diff --git a/docs/search-headless.universalsearchstate.md b/docs/search-headless.universalsearchstate.md new file mode 100644 index 00000000..fbe68d2e --- /dev/null +++ b/docs/search-headless.universalsearchstate.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [UniversalSearchState](./search-headless.universalsearchstate.md) + +## UniversalSearchState interface + +Maintains the data for the latest universal search. + +Signature: + +```typescript +export interface UniversalSearchState +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [limit?](./search-headless.universalsearchstate.limit.md) | [UniversalLimit](./search-headless.universallimit.md) | (Optional) An object defining the limit (up to how many results should be returned) for each vertical. | +| [restrictVerticals?](./search-headless.universalsearchstate.restrictverticals.md) | string\[\] | (Optional) If included, the verticals to which the universal search should be restricted. | +| [verticals?](./search-headless.universalsearchstate.verticals.md) | [VerticalResults](./search-headless.verticalresults.md)\[\] | (Optional) The results from each vertical included in the universal search. | + diff --git a/docs/answers-headless.universalsearchstate.restrictverticals.md b/docs/search-headless.universalsearchstate.restrictverticals.md similarity index 53% rename from docs/answers-headless.universalsearchstate.restrictverticals.md rename to docs/search-headless.universalsearchstate.restrictverticals.md index e2c4e77d..3eec2d57 100644 --- a/docs/answers-headless.universalsearchstate.restrictverticals.md +++ b/docs/search-headless.universalsearchstate.restrictverticals.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [UniversalSearchState](./answers-headless.universalsearchstate.md) > [restrictVerticals](./answers-headless.universalsearchstate.restrictverticals.md) +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [UniversalSearchState](./search-headless.universalsearchstate.md) > [restrictVerticals](./search-headless.universalsearchstate.restrictverticals.md) ## UniversalSearchState.restrictVerticals property diff --git a/docs/answers-headless.universalsearchstate.verticals.md b/docs/search-headless.universalsearchstate.verticals.md similarity index 53% rename from docs/answers-headless.universalsearchstate.verticals.md rename to docs/search-headless.universalsearchstate.verticals.md index 6aa1ce90..bbc7ef96 100644 --- a/docs/answers-headless.universalsearchstate.verticals.md +++ b/docs/search-headless.universalsearchstate.verticals.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [UniversalSearchState](./answers-headless.universalsearchstate.md) > [verticals](./answers-headless.universalsearchstate.verticals.md) +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [UniversalSearchState](./search-headless.universalsearchstate.md) > [verticals](./search-headless.universalsearchstate.verticals.md) ## UniversalSearchState.verticals property diff --git a/docs/search-headless.uppernumberrangelimit.matcher.md b/docs/search-headless.uppernumberrangelimit.matcher.md new file mode 100644 index 00000000..81ff614c --- /dev/null +++ b/docs/search-headless.uppernumberrangelimit.matcher.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [UpperNumberRangeLimit](./search-headless.uppernumberrangelimit.md) > [matcher](./search-headless.uppernumberrangelimit.matcher.md) + +## UpperNumberRangeLimit.matcher property + +[Matcher](./search-headless.matcher.md) for the end limit + +Signature: + +```typescript +matcher: Matcher.LessThan | Matcher.LessThanOrEqualTo; +``` diff --git a/docs/search-headless.uppernumberrangelimit.md b/docs/search-headless.uppernumberrangelimit.md new file mode 100644 index 00000000..3cfac58b --- /dev/null +++ b/docs/search-headless.uppernumberrangelimit.md @@ -0,0 +1,21 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [UpperNumberRangeLimit](./search-headless.uppernumberrangelimit.md) + +## UpperNumberRangeLimit interface + +The end limit of [NumberRangeValue](./search-headless.numberrangevalue.md). + +Signature: + +```typescript +export declare interface UpperNumberRangeLimit +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [matcher](./search-headless.uppernumberrangelimit.matcher.md) | [Matcher.LessThan](./search-headless.matcher.md) \| [Matcher.LessThanOrEqualTo](./search-headless.matcher.md) | [Matcher](./search-headless.matcher.md) for the end limit | +| [value](./search-headless.uppernumberrangelimit.value.md) | number | Value of the limit. | + diff --git a/docs/search-headless.uppernumberrangelimit.value.md b/docs/search-headless.uppernumberrangelimit.value.md new file mode 100644 index 00000000..32660513 --- /dev/null +++ b/docs/search-headless.uppernumberrangelimit.value.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [UpperNumberRangeLimit](./search-headless.uppernumberrangelimit.md) > [value](./search-headless.uppernumberrangelimit.value.md) + +## UpperNumberRangeLimit.value property + +Value of the limit. + +Signature: + +```typescript +value: number; +``` diff --git a/docs/search-headless.verticalautocompleterequest.input.md b/docs/search-headless.verticalautocompleterequest.input.md new file mode 100644 index 00000000..aa1390f6 --- /dev/null +++ b/docs/search-headless.verticalautocompleterequest.input.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [VerticalAutocompleteRequest](./search-headless.verticalautocompleterequest.md) > [input](./search-headless.verticalautocompleterequest.input.md) + +## VerticalAutocompleteRequest.input property + +The input string for autocomplete. + +Signature: + +```typescript +input: string; +``` diff --git a/docs/search-headless.verticalautocompleterequest.md b/docs/search-headless.verticalautocompleterequest.md new file mode 100644 index 00000000..53d49fcc --- /dev/null +++ b/docs/search-headless.verticalautocompleterequest.md @@ -0,0 +1,23 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [VerticalAutocompleteRequest](./search-headless.verticalautocompleterequest.md) + +## VerticalAutocompleteRequest interface + +Options for a vertial autocomplete request. + +Signature: + +```typescript +export declare interface VerticalAutocompleteRequest extends AnswersRequest +``` +Extends: [AnswersRequest](./search-headless.answersrequest.md) + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [input](./search-headless.verticalautocompleterequest.input.md) | string | The input string for autocomplete. | +| [sessionTrackingEnabled?](./search-headless.verticalautocompleterequest.sessiontrackingenabled.md) | boolean | (Optional) Enables session tracking. | +| [verticalKey](./search-headless.verticalautocompleterequest.verticalkey.md) | string | The key for the vertical to get autocomplete suggestions from. | + diff --git a/docs/search-headless.verticalautocompleterequest.sessiontrackingenabled.md b/docs/search-headless.verticalautocompleterequest.sessiontrackingenabled.md new file mode 100644 index 00000000..f6fc71d8 --- /dev/null +++ b/docs/search-headless.verticalautocompleterequest.sessiontrackingenabled.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [VerticalAutocompleteRequest](./search-headless.verticalautocompleterequest.md) > [sessionTrackingEnabled](./search-headless.verticalautocompleterequest.sessiontrackingenabled.md) + +## VerticalAutocompleteRequest.sessionTrackingEnabled property + +Enables session tracking. + +Signature: + +```typescript +sessionTrackingEnabled?: boolean; +``` diff --git a/docs/answers-headless.verticalautocompleterequest.verticalkey.md b/docs/search-headless.verticalautocompleterequest.verticalkey.md similarity index 50% rename from docs/answers-headless.verticalautocompleterequest.verticalkey.md rename to docs/search-headless.verticalautocompleterequest.verticalkey.md index 88c767f1..9fe3b45c 100644 --- a/docs/answers-headless.verticalautocompleterequest.verticalkey.md +++ b/docs/search-headless.verticalautocompleterequest.verticalkey.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [VerticalAutocompleteRequest](./answers-headless.verticalautocompleterequest.md) > [verticalKey](./answers-headless.verticalautocompleterequest.verticalkey.md) +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [VerticalAutocompleteRequest](./search-headless.verticalautocompleterequest.md) > [verticalKey](./search-headless.verticalautocompleterequest.verticalkey.md) ## VerticalAutocompleteRequest.verticalKey property diff --git a/docs/search-headless.verticalresults.appliedqueryfilters.md b/docs/search-headless.verticalresults.appliedqueryfilters.md new file mode 100644 index 00000000..1f8589c2 --- /dev/null +++ b/docs/search-headless.verticalresults.appliedqueryfilters.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [VerticalResults](./search-headless.verticalresults.md) > [appliedQueryFilters](./search-headless.verticalresults.appliedqueryfilters.md) + +## VerticalResults.appliedQueryFilters property + +A array of [AppliedQueryFilter](./search-headless.appliedqueryfilter.md)s which were applied to the vertical results. + +Signature: + +```typescript +appliedQueryFilters: AppliedQueryFilter[]; +``` diff --git a/docs/search-headless.verticalresults.md b/docs/search-headless.verticalresults.md new file mode 100644 index 00000000..b75d39f5 --- /dev/null +++ b/docs/search-headless.verticalresults.md @@ -0,0 +1,25 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [VerticalResults](./search-headless.verticalresults.md) + +## VerticalResults interface + +Represents results from a search vertical. + +Signature: + +```typescript +export declare interface VerticalResults +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [appliedQueryFilters](./search-headless.verticalresults.appliedqueryfilters.md) | [AppliedQueryFilter](./search-headless.appliedqueryfilter.md)\[\] | A array of [AppliedQueryFilter](./search-headless.appliedqueryfilter.md)s which were applied to the vertical results. | +| [queryDurationMillis](./search-headless.verticalresults.querydurationmillis.md) | number | The duration of the query in milliseconds. | +| [results](./search-headless.verticalresults.results.md) | [Result](./search-headless.result.md)\[\] | An array of search [Result](./search-headless.result.md)s for the vertical. | +| [resultsCount](./search-headless.verticalresults.resultscount.md) | number | The total number of results within the vertical. | +| [source](./search-headless.verticalresults.source.md) | [Source](./search-headless.source.md) | Represents the source of a [Result](./search-headless.result.md). | +| [verticalKey](./search-headless.verticalresults.verticalkey.md) | string | The vertical key associated with the vertical results. | + diff --git a/docs/answers-headless.verticalresults.querydurationmillis.md b/docs/search-headless.verticalresults.querydurationmillis.md similarity index 50% rename from docs/answers-headless.verticalresults.querydurationmillis.md rename to docs/search-headless.verticalresults.querydurationmillis.md index 15db5173..1d119c3e 100644 --- a/docs/answers-headless.verticalresults.querydurationmillis.md +++ b/docs/search-headless.verticalresults.querydurationmillis.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [VerticalResults](./answers-headless.verticalresults.md) > [queryDurationMillis](./answers-headless.verticalresults.querydurationmillis.md) +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [VerticalResults](./search-headless.verticalresults.md) > [queryDurationMillis](./search-headless.verticalresults.querydurationmillis.md) ## VerticalResults.queryDurationMillis property diff --git a/docs/search-headless.verticalresults.results.md b/docs/search-headless.verticalresults.results.md new file mode 100644 index 00000000..7a332fd8 --- /dev/null +++ b/docs/search-headless.verticalresults.results.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [VerticalResults](./search-headless.verticalresults.md) > [results](./search-headless.verticalresults.results.md) + +## VerticalResults.results property + +An array of search [Result](./search-headless.result.md)s for the vertical. + +Signature: + +```typescript +results: Result[]; +``` diff --git a/docs/answers-headless.verticalresults.resultscount.md b/docs/search-headless.verticalresults.resultscount.md similarity index 63% rename from docs/answers-headless.verticalresults.resultscount.md rename to docs/search-headless.verticalresults.resultscount.md index 012eac5d..fbc34fd1 100644 --- a/docs/answers-headless.verticalresults.resultscount.md +++ b/docs/search-headless.verticalresults.resultscount.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [VerticalResults](./answers-headless.verticalresults.md) > [resultsCount](./answers-headless.verticalresults.resultscount.md) +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [VerticalResults](./search-headless.verticalresults.md) > [resultsCount](./search-headless.verticalresults.resultscount.md) ## VerticalResults.resultsCount property diff --git a/docs/search-headless.verticalresults.source.md b/docs/search-headless.verticalresults.source.md new file mode 100644 index 00000000..0a033f4a --- /dev/null +++ b/docs/search-headless.verticalresults.source.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [VerticalResults](./search-headless.verticalresults.md) > [source](./search-headless.verticalresults.source.md) + +## VerticalResults.source property + +Represents the source of a [Result](./search-headless.result.md). + +Signature: + +```typescript +source: Source; +``` diff --git a/docs/answers-headless.verticalresults.verticalkey.md b/docs/search-headless.verticalresults.verticalkey.md similarity index 52% rename from docs/answers-headless.verticalresults.verticalkey.md rename to docs/search-headless.verticalresults.verticalkey.md index 7e54025e..602f4d81 100644 --- a/docs/answers-headless.verticalresults.verticalkey.md +++ b/docs/search-headless.verticalresults.verticalkey.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [VerticalResults](./answers-headless.verticalresults.md) > [verticalKey](./answers-headless.verticalresults.verticalkey.md) +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [VerticalResults](./search-headless.verticalresults.md) > [verticalKey](./search-headless.verticalresults.verticalkey.md) ## VerticalResults.verticalKey property diff --git a/docs/answers-headless.verticalsearchrequest.context.md b/docs/search-headless.verticalsearchrequest.context.md similarity index 59% rename from docs/answers-headless.verticalsearchrequest.context.md rename to docs/search-headless.verticalsearchrequest.context.md index f01354f0..8a837477 100644 --- a/docs/answers-headless.verticalsearchrequest.context.md +++ b/docs/search-headless.verticalsearchrequest.context.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [VerticalSearchRequest](./answers-headless.verticalsearchrequest.md) > [context](./answers-headless.verticalsearchrequest.context.md) +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [VerticalSearchRequest](./search-headless.verticalsearchrequest.md) > [context](./search-headless.verticalsearchrequest.context.md) ## VerticalSearchRequest.context property diff --git a/docs/search-headless.verticalsearchrequest.facets.md b/docs/search-headless.verticalsearchrequest.facets.md new file mode 100644 index 00000000..e6c6872b --- /dev/null +++ b/docs/search-headless.verticalsearchrequest.facets.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [VerticalSearchRequest](./search-headless.verticalsearchrequest.md) > [facets](./search-headless.verticalsearchrequest.facets.md) + +## VerticalSearchRequest.facets property + +The facet filters to apply to the search. + +Signature: + +```typescript +facets?: Facet[]; +``` diff --git a/docs/answers-headless.verticalsearchrequest.limit.md b/docs/search-headless.verticalsearchrequest.limit.md similarity index 51% rename from docs/answers-headless.verticalsearchrequest.limit.md rename to docs/search-headless.verticalsearchrequest.limit.md index 10ab041b..4e1c6bfa 100644 --- a/docs/answers-headless.verticalsearchrequest.limit.md +++ b/docs/search-headless.verticalsearchrequest.limit.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [VerticalSearchRequest](./answers-headless.verticalsearchrequest.md) > [limit](./answers-headless.verticalsearchrequest.limit.md) +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [VerticalSearchRequest](./search-headless.verticalsearchrequest.md) > [limit](./search-headless.verticalsearchrequest.limit.md) ## VerticalSearchRequest.limit property diff --git a/docs/answers-headless.verticalsearchrequest.location.md b/docs/search-headless.verticalsearchrequest.location.md similarity index 60% rename from docs/answers-headless.verticalsearchrequest.location.md rename to docs/search-headless.verticalsearchrequest.location.md index 9347b9ad..2cb504e5 100644 --- a/docs/answers-headless.verticalsearchrequest.location.md +++ b/docs/search-headless.verticalsearchrequest.location.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [VerticalSearchRequest](./answers-headless.verticalsearchrequest.md) > [location](./answers-headless.verticalsearchrequest.location.md) +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [VerticalSearchRequest](./search-headless.verticalsearchrequest.md) > [location](./search-headless.verticalsearchrequest.location.md) ## VerticalSearchRequest.location property diff --git a/docs/answers-headless.verticalsearchrequest.locationradius.md b/docs/search-headless.verticalsearchrequest.locationradius.md similarity index 51% rename from docs/answers-headless.verticalsearchrequest.locationradius.md rename to docs/search-headless.verticalsearchrequest.locationradius.md index e0136103..5a047c1d 100644 --- a/docs/answers-headless.verticalsearchrequest.locationradius.md +++ b/docs/search-headless.verticalsearchrequest.locationradius.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [VerticalSearchRequest](./answers-headless.verticalsearchrequest.md) > [locationRadius](./answers-headless.verticalsearchrequest.locationradius.md) +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [VerticalSearchRequest](./search-headless.verticalsearchrequest.md) > [locationRadius](./search-headless.verticalsearchrequest.locationradius.md) ## VerticalSearchRequest.locationRadius property diff --git a/docs/search-headless.verticalsearchrequest.md b/docs/search-headless.verticalsearchrequest.md new file mode 100644 index 00000000..5c242ee4 --- /dev/null +++ b/docs/search-headless.verticalsearchrequest.md @@ -0,0 +1,38 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [VerticalSearchRequest](./search-headless.verticalsearchrequest.md) + +## VerticalSearchRequest interface + +Options which can be specified for a vertical search. + +Signature: + +```typescript +export declare interface VerticalSearchRequest extends AnswersRequest +``` +Extends: [AnswersRequest](./search-headless.answersrequest.md) + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [context?](./search-headless.verticalsearchrequest.context.md) | [Context](./search-headless.context.md) | (Optional) Used to trigger Answers [Query Rules](https://hitchhikers.yext.com/tracks/answers-advanced/ans302-query-rules/). | +| [facets?](./search-headless.verticalsearchrequest.facets.md) | [Facet](./search-headless.facet.md)\[\] | (Optional) The facet filters to apply to the search. | +| [limit?](./search-headless.verticalsearchrequest.limit.md) | number | (Optional) The maximum number of results to include with a max of 50. | +| [location?](./search-headless.verticalsearchrequest.location.md) | [LatLong](./search-headless.latlong.md) | (Optional) The latitude and longitude of the user making the request. Used to bias the results. | +| [locationRadius?](./search-headless.verticalsearchrequest.locationradius.md) | number | (Optional) The radius (in meters) to filter the vertical search by. | +| [offset?](./search-headless.verticalsearchrequest.offset.md) | number | (Optional) The result offset which allows for fetching more results with the same query. | +| [query](./search-headless.verticalsearchrequest.query.md) | string | The search query. | +| [queryId?](./search-headless.verticalsearchrequest.queryid.md) | string | (Optional) The queryId for the query, if this is a repeat query. | +| [querySource?](./search-headless.verticalsearchrequest.querysource.md) | [QuerySource](./search-headless.querysource.md) \| string | (Optional) The source of the search request. | +| [queryTrigger?](./search-headless.verticalsearchrequest.querytrigger.md) | [QueryTrigger](./search-headless.querytrigger.md) | (Optional) Describes the ways a search can be executed besides user input. | +| [referrerPageUrl?](./search-headless.verticalsearchrequest.referrerpageurl.md) | string | (Optional) The URl of the page which referred the user to the current page. | +| [retrieveFacets?](./search-headless.verticalsearchrequest.retrievefacets.md) | boolean | (Optional) Indicates that facets should be retrieved. | +| [sessionId?](./search-headless.verticalsearchrequest.sessionid.md) | string | (Optional) Used to track session state when cookies are blocked. | +| [sessionTrackingEnabled?](./search-headless.verticalsearchrequest.sessiontrackingenabled.md) | boolean | (Optional) Enables session tracking. | +| [skipSpellCheck?](./search-headless.verticalsearchrequest.skipspellcheck.md) | boolean | (Optional) Skips spell checking if true. | +| [sortBys?](./search-headless.verticalsearchrequest.sortbys.md) | [SortBy](./search-headless.sortby.md)\[\] | (Optional) Determines how results are sorted. \* | +| [staticFilters?](./search-headless.verticalsearchrequest.staticfilters.md) | [CombinedFilter](./search-headless.combinedfilter.md) \| [Filter](./search-headless.filter.md) | (Optional) The static filters to apply to the search. | +| [verticalKey](./search-headless.verticalsearchrequest.verticalkey.md) | string | The key associated with the vertical. | + diff --git a/docs/answers-headless.verticalsearchrequest.offset.md b/docs/search-headless.verticalsearchrequest.offset.md similarity index 53% rename from docs/answers-headless.verticalsearchrequest.offset.md rename to docs/search-headless.verticalsearchrequest.offset.md index acd5be4a..9e1cbe24 100644 --- a/docs/answers-headless.verticalsearchrequest.offset.md +++ b/docs/search-headless.verticalsearchrequest.offset.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [VerticalSearchRequest](./answers-headless.verticalsearchrequest.md) > [offset](./answers-headless.verticalsearchrequest.offset.md) +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [VerticalSearchRequest](./search-headless.verticalsearchrequest.md) > [offset](./search-headless.verticalsearchrequest.offset.md) ## VerticalSearchRequest.offset property diff --git a/docs/search-headless.verticalsearchrequest.query.md b/docs/search-headless.verticalsearchrequest.query.md new file mode 100644 index 00000000..454a10de --- /dev/null +++ b/docs/search-headless.verticalsearchrequest.query.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [VerticalSearchRequest](./search-headless.verticalsearchrequest.md) > [query](./search-headless.verticalsearchrequest.query.md) + +## VerticalSearchRequest.query property + +The search query. + +Signature: + +```typescript +query: string; +``` diff --git a/docs/answers-headless.verticalsearchrequest.queryid.md b/docs/search-headless.verticalsearchrequest.queryid.md similarity index 50% rename from docs/answers-headless.verticalsearchrequest.queryid.md rename to docs/search-headless.verticalsearchrequest.queryid.md index cf84a90e..061508c1 100644 --- a/docs/answers-headless.verticalsearchrequest.queryid.md +++ b/docs/search-headless.verticalsearchrequest.queryid.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [VerticalSearchRequest](./answers-headless.verticalsearchrequest.md) > [queryId](./answers-headless.verticalsearchrequest.queryid.md) +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [VerticalSearchRequest](./search-headless.verticalsearchrequest.md) > [queryId](./search-headless.verticalsearchrequest.queryid.md) ## VerticalSearchRequest.queryId property diff --git a/docs/answers-headless.verticalsearchrequest.querysource.md b/docs/search-headless.verticalsearchrequest.querysource.md similarity index 50% rename from docs/answers-headless.verticalsearchrequest.querysource.md rename to docs/search-headless.verticalsearchrequest.querysource.md index 3dc478d3..e729b1f9 100644 --- a/docs/answers-headless.verticalsearchrequest.querysource.md +++ b/docs/search-headless.verticalsearchrequest.querysource.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [VerticalSearchRequest](./answers-headless.verticalsearchrequest.md) > [querySource](./answers-headless.verticalsearchrequest.querysource.md) +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [VerticalSearchRequest](./search-headless.verticalsearchrequest.md) > [querySource](./search-headless.verticalsearchrequest.querysource.md) ## VerticalSearchRequest.querySource property diff --git a/docs/answers-headless.verticalsearchrequest.querytrigger.md b/docs/search-headless.verticalsearchrequest.querytrigger.md similarity index 60% rename from docs/answers-headless.verticalsearchrequest.querytrigger.md rename to docs/search-headless.verticalsearchrequest.querytrigger.md index 819b5bb1..2f2db96f 100644 --- a/docs/answers-headless.verticalsearchrequest.querytrigger.md +++ b/docs/search-headless.verticalsearchrequest.querytrigger.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [VerticalSearchRequest](./answers-headless.verticalsearchrequest.md) > [queryTrigger](./answers-headless.verticalsearchrequest.querytrigger.md) +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [VerticalSearchRequest](./search-headless.verticalsearchrequest.md) > [queryTrigger](./search-headless.verticalsearchrequest.querytrigger.md) ## VerticalSearchRequest.queryTrigger property diff --git a/docs/answers-headless.verticalsearchrequest.referrerpageurl.md b/docs/search-headless.verticalsearchrequest.referrerpageurl.md similarity index 51% rename from docs/answers-headless.verticalsearchrequest.referrerpageurl.md rename to docs/search-headless.verticalsearchrequest.referrerpageurl.md index fab33339..8f493b84 100644 --- a/docs/answers-headless.verticalsearchrequest.referrerpageurl.md +++ b/docs/search-headless.verticalsearchrequest.referrerpageurl.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [VerticalSearchRequest](./answers-headless.verticalsearchrequest.md) > [referrerPageUrl](./answers-headless.verticalsearchrequest.referrerpageurl.md) +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [VerticalSearchRequest](./search-headless.verticalsearchrequest.md) > [referrerPageUrl](./search-headless.verticalsearchrequest.referrerpageurl.md) ## VerticalSearchRequest.referrerPageUrl property diff --git a/docs/search-headless.verticalsearchrequest.retrievefacets.md b/docs/search-headless.verticalsearchrequest.retrievefacets.md new file mode 100644 index 00000000..eea638ce --- /dev/null +++ b/docs/search-headless.verticalsearchrequest.retrievefacets.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [VerticalSearchRequest](./search-headless.verticalsearchrequest.md) > [retrieveFacets](./search-headless.verticalsearchrequest.retrievefacets.md) + +## VerticalSearchRequest.retrieveFacets property + +Indicates that facets should be retrieved. + +Signature: + +```typescript +retrieveFacets?: boolean; +``` diff --git a/docs/answers-headless.verticalsearchrequest.sessionid.md b/docs/search-headless.verticalsearchrequest.sessionid.md similarity index 50% rename from docs/answers-headless.verticalsearchrequest.sessionid.md rename to docs/search-headless.verticalsearchrequest.sessionid.md index 08312372..ffcf51a9 100644 --- a/docs/answers-headless.verticalsearchrequest.sessionid.md +++ b/docs/search-headless.verticalsearchrequest.sessionid.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [VerticalSearchRequest](./answers-headless.verticalsearchrequest.md) > [sessionId](./answers-headless.verticalsearchrequest.sessionid.md) +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [VerticalSearchRequest](./search-headless.verticalsearchrequest.md) > [sessionId](./search-headless.verticalsearchrequest.sessionid.md) ## VerticalSearchRequest.sessionId property diff --git a/docs/search-headless.verticalsearchrequest.sessiontrackingenabled.md b/docs/search-headless.verticalsearchrequest.sessiontrackingenabled.md new file mode 100644 index 00000000..ca742f99 --- /dev/null +++ b/docs/search-headless.verticalsearchrequest.sessiontrackingenabled.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [VerticalSearchRequest](./search-headless.verticalsearchrequest.md) > [sessionTrackingEnabled](./search-headless.verticalsearchrequest.sessiontrackingenabled.md) + +## VerticalSearchRequest.sessionTrackingEnabled property + +Enables session tracking. + +Signature: + +```typescript +sessionTrackingEnabled?: boolean; +``` diff --git a/docs/search-headless.verticalsearchrequest.skipspellcheck.md b/docs/search-headless.verticalsearchrequest.skipspellcheck.md new file mode 100644 index 00000000..bb31520e --- /dev/null +++ b/docs/search-headless.verticalsearchrequest.skipspellcheck.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [VerticalSearchRequest](./search-headless.verticalsearchrequest.md) > [skipSpellCheck](./search-headless.verticalsearchrequest.skipspellcheck.md) + +## VerticalSearchRequest.skipSpellCheck property + +Skips spell checking if true. + +Signature: + +```typescript +skipSpellCheck?: boolean; +``` diff --git a/docs/search-headless.verticalsearchrequest.sortbys.md b/docs/search-headless.verticalsearchrequest.sortbys.md new file mode 100644 index 00000000..15cc0165 --- /dev/null +++ b/docs/search-headless.verticalsearchrequest.sortbys.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [VerticalSearchRequest](./search-headless.verticalsearchrequest.md) > [sortBys](./search-headless.verticalsearchrequest.sortbys.md) + +## VerticalSearchRequest.sortBys property + +Determines how results are sorted. \* + +Signature: + +```typescript +sortBys?: SortBy[]; +``` diff --git a/docs/answers-headless.verticalsearchrequest.staticfilters.md b/docs/search-headless.verticalsearchrequest.staticfilters.md similarity index 51% rename from docs/answers-headless.verticalsearchrequest.staticfilters.md rename to docs/search-headless.verticalsearchrequest.staticfilters.md index 22ba0cca..b8f7e797 100644 --- a/docs/answers-headless.verticalsearchrequest.staticfilters.md +++ b/docs/search-headless.verticalsearchrequest.staticfilters.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [VerticalSearchRequest](./answers-headless.verticalsearchrequest.md) > [staticFilters](./answers-headless.verticalsearchrequest.staticfilters.md) +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [VerticalSearchRequest](./search-headless.verticalsearchrequest.md) > [staticFilters](./search-headless.verticalsearchrequest.staticfilters.md) ## VerticalSearchRequest.staticFilters property diff --git a/docs/search-headless.verticalsearchrequest.verticalkey.md b/docs/search-headless.verticalsearchrequest.verticalkey.md new file mode 100644 index 00000000..3349b767 --- /dev/null +++ b/docs/search-headless.verticalsearchrequest.verticalkey.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [VerticalSearchRequest](./search-headless.verticalsearchrequest.md) > [verticalKey](./search-headless.verticalsearchrequest.verticalkey.md) + +## VerticalSearchRequest.verticalKey property + +The key associated with the vertical. + +Signature: + +```typescript +verticalKey: string; +``` diff --git a/docs/answers-headless.verticalsearchresponse.allresultsforvertical.md b/docs/search-headless.verticalsearchresponse.allresultsforvertical.md similarity index 52% rename from docs/answers-headless.verticalsearchresponse.allresultsforvertical.md rename to docs/search-headless.verticalsearchresponse.allresultsforvertical.md index a8f3bb18..2f112b41 100644 --- a/docs/answers-headless.verticalsearchresponse.allresultsforvertical.md +++ b/docs/search-headless.verticalsearchresponse.allresultsforvertical.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [VerticalSearchResponse](./answers-headless.verticalsearchresponse.md) > [allResultsForVertical](./answers-headless.verticalsearchresponse.allresultsforvertical.md) +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [VerticalSearchResponse](./search-headless.verticalsearchresponse.md) > [allResultsForVertical](./search-headless.verticalsearchresponse.allresultsforvertical.md) ## VerticalSearchResponse.allResultsForVertical property diff --git a/docs/search-headless.verticalsearchresponse.alternativeverticals.md b/docs/search-headless.verticalsearchresponse.alternativeverticals.md new file mode 100644 index 00000000..17fad6b1 --- /dev/null +++ b/docs/search-headless.verticalsearchresponse.alternativeverticals.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [VerticalSearchResponse](./search-headless.verticalsearchresponse.md) > [alternativeVerticals](./search-headless.verticalsearchresponse.alternativeverticals.md) + +## VerticalSearchResponse.alternativeVerticals property + +The [VerticalResults](./search-headless.verticalresults.md) for each search vertical. + +Signature: + +```typescript +alternativeVerticals?: VerticalResults[]; +``` diff --git a/docs/answers-headless.verticalsearchresponse.directanswer.md b/docs/search-headless.verticalsearchresponse.directanswer.md similarity index 52% rename from docs/answers-headless.verticalsearchresponse.directanswer.md rename to docs/search-headless.verticalsearchresponse.directanswer.md index 9a36775f..e7256a14 100644 --- a/docs/answers-headless.verticalsearchresponse.directanswer.md +++ b/docs/search-headless.verticalsearchresponse.directanswer.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [VerticalSearchResponse](./answers-headless.verticalsearchresponse.md) > [directAnswer](./answers-headless.verticalsearchresponse.directanswer.md) +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [VerticalSearchResponse](./search-headless.verticalsearchresponse.md) > [directAnswer](./search-headless.verticalsearchresponse.directanswer.md) ## VerticalSearchResponse.directAnswer property diff --git a/docs/search-headless.verticalsearchresponse.facets.md b/docs/search-headless.verticalsearchresponse.facets.md new file mode 100644 index 00000000..972a0bf0 --- /dev/null +++ b/docs/search-headless.verticalsearchresponse.facets.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [VerticalSearchResponse](./search-headless.verticalsearchresponse.md) > [facets](./search-headless.verticalsearchresponse.facets.md) + +## VerticalSearchResponse.facets property + +An array of [Facet](./search-headless.facet.md)s associated with the search results. + +Signature: + +```typescript +facets?: DisplayableFacet[]; +``` diff --git a/docs/search-headless.verticalsearchresponse.locationbias.md b/docs/search-headless.verticalsearchresponse.locationbias.md new file mode 100644 index 00000000..0747bc7a --- /dev/null +++ b/docs/search-headless.verticalsearchresponse.locationbias.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [VerticalSearchResponse](./search-headless.verticalsearchresponse.md) > [locationBias](./search-headless.verticalsearchresponse.locationbias.md) + +## VerticalSearchResponse.locationBias property + +Information about the user's location. + +Signature: + +```typescript +locationBias?: LocationBias; +``` diff --git a/docs/search-headless.verticalsearchresponse.md b/docs/search-headless.verticalsearchresponse.md new file mode 100644 index 00000000..92751551 --- /dev/null +++ b/docs/search-headless.verticalsearchresponse.md @@ -0,0 +1,30 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [VerticalSearchResponse](./search-headless.verticalsearchresponse.md) + +## VerticalSearchResponse interface + +A representation of a response from a vertical search. + +Signature: + +```typescript +export declare interface VerticalSearchResponse +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [allResultsForVertical?](./search-headless.verticalsearchresponse.allresultsforvertical.md) | [VerticalSearchResponse](./search-headless.verticalsearchresponse.md) | (Optional) A representation of a response from a vertical search. | +| [alternativeVerticals?](./search-headless.verticalsearchresponse.alternativeverticals.md) | [VerticalResults](./search-headless.verticalresults.md)\[\] | (Optional) The [VerticalResults](./search-headless.verticalresults.md) for each search vertical. | +| [directAnswer?](./search-headless.verticalsearchresponse.directanswer.md) | [FeaturedSnippetDirectAnswer](./search-headless.featuredsnippetdirectanswer.md) \| [FieldValueDirectAnswer](./search-headless.fieldvaluedirectanswer.md) | (Optional) A direct answer to a search. | +| [facets?](./search-headless.verticalsearchresponse.facets.md) | [DisplayableFacet](./search-headless.displayablefacet.md)\[\] | (Optional) An array of [Facet](./search-headless.facet.md)s associated with the search results. | +| [locationBias?](./search-headless.verticalsearchresponse.locationbias.md) | [LocationBias](./search-headless.locationbias.md) | (Optional) Information about the user's location. | +| [queryId](./search-headless.verticalsearchresponse.queryid.md) | string | The ID of the query. | +| [queryRulesActionsData?](./search-headless.verticalsearchresponse.queryrulesactionsdata.md) | [QueryRulesActionsData](./search-headless.queryrulesactionsdata.md)\[\] | (Optional) Data returned from the Answers query rules system. | +| [searchIntents?](./search-headless.verticalsearchresponse.searchintents.md) | [SearchIntent](./search-headless.searchintent.md)\[\] | (Optional) An array of [SearchIntent](./search-headless.searchintent.md)s. | +| [spellCheck?](./search-headless.verticalsearchresponse.spellcheck.md) | [SpellCheck](./search-headless.spellcheck.md) | (Optional) A spellcheck response from a search query. | +| [uuid](./search-headless.verticalsearchresponse.uuid.md) | string | A unique id which corresponds to the request. | +| [verticalResults](./search-headless.verticalsearchresponse.verticalresults.md) | [VerticalResults](./search-headless.verticalresults.md) | Represents results from a search vertical. | + diff --git a/docs/search-headless.verticalsearchresponse.queryid.md b/docs/search-headless.verticalsearchresponse.queryid.md new file mode 100644 index 00000000..a1f3e583 --- /dev/null +++ b/docs/search-headless.verticalsearchresponse.queryid.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [VerticalSearchResponse](./search-headless.verticalsearchresponse.md) > [queryId](./search-headless.verticalsearchresponse.queryid.md) + +## VerticalSearchResponse.queryId property + +The ID of the query. + +Signature: + +```typescript +queryId: string; +``` diff --git a/docs/answers-headless.verticalsearchresponse.queryrulesactionsdata.md b/docs/search-headless.verticalsearchresponse.queryrulesactionsdata.md similarity index 51% rename from docs/answers-headless.verticalsearchresponse.queryrulesactionsdata.md rename to docs/search-headless.verticalsearchresponse.queryrulesactionsdata.md index e3bcc87a..276c2315 100644 --- a/docs/answers-headless.verticalsearchresponse.queryrulesactionsdata.md +++ b/docs/search-headless.verticalsearchresponse.queryrulesactionsdata.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [VerticalSearchResponse](./answers-headless.verticalsearchresponse.md) > [queryRulesActionsData](./answers-headless.verticalsearchresponse.queryrulesactionsdata.md) +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [VerticalSearchResponse](./search-headless.verticalsearchresponse.md) > [queryRulesActionsData](./search-headless.verticalsearchresponse.queryrulesactionsdata.md) ## VerticalSearchResponse.queryRulesActionsData property diff --git a/docs/search-headless.verticalsearchresponse.searchintents.md b/docs/search-headless.verticalsearchresponse.searchintents.md new file mode 100644 index 00000000..dc8b9674 --- /dev/null +++ b/docs/search-headless.verticalsearchresponse.searchintents.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [VerticalSearchResponse](./search-headless.verticalsearchresponse.md) > [searchIntents](./search-headless.verticalsearchresponse.searchintents.md) + +## VerticalSearchResponse.searchIntents property + +An array of [SearchIntent](./search-headless.searchintent.md)s. + +Signature: + +```typescript +searchIntents?: SearchIntent[]; +``` diff --git a/docs/answers-headless.verticalsearchresponse.spellcheck.md b/docs/search-headless.verticalsearchresponse.spellcheck.md similarity index 50% rename from docs/answers-headless.verticalsearchresponse.spellcheck.md rename to docs/search-headless.verticalsearchresponse.spellcheck.md index 9a23b4ae..98d473fa 100644 --- a/docs/answers-headless.verticalsearchresponse.spellcheck.md +++ b/docs/search-headless.verticalsearchresponse.spellcheck.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [VerticalSearchResponse](./answers-headless.verticalsearchresponse.md) > [spellCheck](./answers-headless.verticalsearchresponse.spellcheck.md) +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [VerticalSearchResponse](./search-headless.verticalsearchresponse.md) > [spellCheck](./search-headless.verticalsearchresponse.spellcheck.md) ## VerticalSearchResponse.spellCheck property diff --git a/docs/search-headless.verticalsearchresponse.uuid.md b/docs/search-headless.verticalsearchresponse.uuid.md new file mode 100644 index 00000000..15bc5f9f --- /dev/null +++ b/docs/search-headless.verticalsearchresponse.uuid.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [VerticalSearchResponse](./search-headless.verticalsearchresponse.md) > [uuid](./search-headless.verticalsearchresponse.uuid.md) + +## VerticalSearchResponse.uuid property + +A unique id which corresponds to the request. + +Signature: + +```typescript +uuid: string; +``` diff --git a/docs/answers-headless.verticalsearchresponse.verticalresults.md b/docs/search-headless.verticalsearchresponse.verticalresults.md similarity index 50% rename from docs/answers-headless.verticalsearchresponse.verticalresults.md rename to docs/search-headless.verticalsearchresponse.verticalresults.md index da29b9e9..9b9b35cf 100644 --- a/docs/answers-headless.verticalsearchresponse.verticalresults.md +++ b/docs/search-headless.verticalsearchresponse.verticalresults.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [VerticalSearchResponse](./answers-headless.verticalsearchresponse.md) > [verticalResults](./answers-headless.verticalsearchresponse.verticalresults.md) +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [VerticalSearchResponse](./search-headless.verticalsearchresponse.md) > [verticalResults](./search-headless.verticalsearchresponse.verticalresults.md) ## VerticalSearchResponse.verticalResults property diff --git a/docs/answers-headless.verticalsearchstate.appliedqueryfilters.md b/docs/search-headless.verticalsearchstate.appliedqueryfilters.md similarity index 54% rename from docs/answers-headless.verticalsearchstate.appliedqueryfilters.md rename to docs/search-headless.verticalsearchstate.appliedqueryfilters.md index ef20b743..95888ed4 100644 --- a/docs/answers-headless.verticalsearchstate.appliedqueryfilters.md +++ b/docs/search-headless.verticalsearchstate.appliedqueryfilters.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [VerticalSearchState](./answers-headless.verticalsearchstate.md) > [appliedQueryFilters](./answers-headless.verticalsearchstate.appliedqueryfilters.md) +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [VerticalSearchState](./search-headless.verticalsearchstate.md) > [appliedQueryFilters](./search-headless.verticalsearchstate.appliedqueryfilters.md) ## VerticalSearchState.appliedQueryFilters property diff --git a/docs/search-headless.verticalsearchstate.displayname.md b/docs/search-headless.verticalsearchstate.displayname.md new file mode 100644 index 00000000..453cb56f --- /dev/null +++ b/docs/search-headless.verticalsearchstate.displayname.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [VerticalSearchState](./search-headless.verticalsearchstate.md) > [displayName](./search-headless.verticalsearchstate.displayname.md) + +## VerticalSearchState.displayName property + +Name to be displayed for the vertical. + +Signature: + +```typescript +displayName?: string; +``` diff --git a/docs/answers-headless.verticalsearchstate.limit.md b/docs/search-headless.verticalsearchstate.limit.md similarity index 52% rename from docs/answers-headless.verticalsearchstate.limit.md rename to docs/search-headless.verticalsearchstate.limit.md index 9a5b0d25..b24a106f 100644 --- a/docs/answers-headless.verticalsearchstate.limit.md +++ b/docs/search-headless.verticalsearchstate.limit.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [VerticalSearchState](./answers-headless.verticalsearchstate.md) > [limit](./answers-headless.verticalsearchstate.limit.md) +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [VerticalSearchState](./search-headless.verticalsearchstate.md) > [limit](./search-headless.verticalsearchstate.limit.md) ## VerticalSearchState.limit property diff --git a/docs/search-headless.verticalsearchstate.md b/docs/search-headless.verticalsearchstate.md new file mode 100644 index 00000000..6f268565 --- /dev/null +++ b/docs/search-headless.verticalsearchstate.md @@ -0,0 +1,30 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [VerticalSearchState](./search-headless.verticalsearchstate.md) + +## VerticalSearchState interface + +Maintains the data for the latest vertical search. + +Signature: + +```typescript +export interface VerticalSearchState +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [appliedQueryFilters?](./search-headless.verticalsearchstate.appliedqueryfilters.md) | [AppliedQueryFilter](./search-headless.appliedqueryfilter.md)\[\] | (Optional) The array of filters inferred from the query and applied to the search. | +| [displayName?](./search-headless.verticalsearchstate.displayname.md) | string | (Optional) Name to be displayed for the vertical. | +| [limit?](./search-headless.verticalsearchstate.limit.md) | number | (Optional) The maximum number of results to include for the vertical search. | +| [noResults?](./search-headless.verticalsearchstate.noresults.md) | { allResultsForVertical: [AllResultsForVertical](./search-headless.allresultsforvertical.md); alternativeVerticals: [VerticalResults](./search-headless.verticalresults.md)\[\]; } | (Optional) The data for when no results are returned in the vertical search. | +| [offset?](./search-headless.verticalsearchstate.offset.md) | number | (Optional) The number of results that should be skipped when fetching results for the response. Allows for fetching more results with the same query. | +| [queryDurationMillis?](./search-headless.verticalsearchstate.querydurationmillis.md) | number | (Optional) The duration of the query in milliseconds. | +| [results?](./search-headless.verticalsearchstate.results.md) | [Result](./search-headless.result.md)\[\] | (Optional) The results from the vertical search. | +| [resultsCount?](./search-headless.verticalsearchstate.resultscount.md) | number | (Optional) The number of results for the vertical search. | +| [sortBys?](./search-headless.verticalsearchstate.sortbys.md) | [SortBy](./search-headless.sortby.md)\[\] | (Optional) The criteria by which the results should be sorted, in the order in which they should be applied. | +| [source?](./search-headless.verticalsearchstate.source.md) | [Source](./search-headless.source.md) | (Optional) The source of the vertical search results. | +| [verticalKey?](./search-headless.verticalsearchstate.verticalkey.md) | string | (Optional) The key associated with the vertical. | + diff --git a/docs/answers-headless.verticalsearchstate.noresults.md b/docs/search-headless.verticalsearchstate.noresults.md similarity index 60% rename from docs/answers-headless.verticalsearchstate.noresults.md rename to docs/search-headless.verticalsearchstate.noresults.md index bc738718..2e75c757 100644 --- a/docs/answers-headless.verticalsearchstate.noresults.md +++ b/docs/search-headless.verticalsearchstate.noresults.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [VerticalSearchState](./answers-headless.verticalsearchstate.md) > [noResults](./answers-headless.verticalsearchstate.noresults.md) +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [VerticalSearchState](./search-headless.verticalsearchstate.md) > [noResults](./search-headless.verticalsearchstate.noresults.md) ## VerticalSearchState.noResults property diff --git a/docs/answers-headless.verticalsearchstate.offset.md b/docs/search-headless.verticalsearchstate.offset.md similarity index 59% rename from docs/answers-headless.verticalsearchstate.offset.md rename to docs/search-headless.verticalsearchstate.offset.md index 4c15b772..a8dfdbe3 100644 --- a/docs/answers-headless.verticalsearchstate.offset.md +++ b/docs/search-headless.verticalsearchstate.offset.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [VerticalSearchState](./answers-headless.verticalsearchstate.md) > [offset](./answers-headless.verticalsearchstate.offset.md) +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [VerticalSearchState](./search-headless.verticalsearchstate.md) > [offset](./search-headless.verticalsearchstate.offset.md) ## VerticalSearchState.offset property diff --git a/docs/answers-headless.verticalsearchstate.querydurationmillis.md b/docs/search-headless.verticalsearchstate.querydurationmillis.md similarity index 50% rename from docs/answers-headless.verticalsearchstate.querydurationmillis.md rename to docs/search-headless.verticalsearchstate.querydurationmillis.md index 1a6548cc..55451efc 100644 --- a/docs/answers-headless.verticalsearchstate.querydurationmillis.md +++ b/docs/search-headless.verticalsearchstate.querydurationmillis.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [VerticalSearchState](./answers-headless.verticalsearchstate.md) > [queryDurationMillis](./answers-headless.verticalsearchstate.querydurationmillis.md) +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [VerticalSearchState](./search-headless.verticalsearchstate.md) > [queryDurationMillis](./search-headless.verticalsearchstate.querydurationmillis.md) ## VerticalSearchState.queryDurationMillis property diff --git a/docs/search-headless.verticalsearchstate.results.md b/docs/search-headless.verticalsearchstate.results.md new file mode 100644 index 00000000..623b7e48 --- /dev/null +++ b/docs/search-headless.verticalsearchstate.results.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [VerticalSearchState](./search-headless.verticalsearchstate.md) > [results](./search-headless.verticalsearchstate.results.md) + +## VerticalSearchState.results property + +The results from the vertical search. + +Signature: + +```typescript +results?: Result[]; +``` diff --git a/docs/answers-headless.verticalsearchstate.resultscount.md b/docs/search-headless.verticalsearchstate.resultscount.md similarity index 50% rename from docs/answers-headless.verticalsearchstate.resultscount.md rename to docs/search-headless.verticalsearchstate.resultscount.md index 797cad31..7742044b 100644 --- a/docs/answers-headless.verticalsearchstate.resultscount.md +++ b/docs/search-headless.verticalsearchstate.resultscount.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [VerticalSearchState](./answers-headless.verticalsearchstate.md) > [resultsCount](./answers-headless.verticalsearchstate.resultscount.md) +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [VerticalSearchState](./search-headless.verticalsearchstate.md) > [resultsCount](./search-headless.verticalsearchstate.resultscount.md) ## VerticalSearchState.resultsCount property diff --git a/docs/answers-headless.verticalsearchstate.sortbys.md b/docs/search-headless.verticalsearchstate.sortbys.md similarity index 55% rename from docs/answers-headless.verticalsearchstate.sortbys.md rename to docs/search-headless.verticalsearchstate.sortbys.md index 6b12cb53..f04557cf 100644 --- a/docs/answers-headless.verticalsearchstate.sortbys.md +++ b/docs/search-headless.verticalsearchstate.sortbys.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [VerticalSearchState](./answers-headless.verticalsearchstate.md) > [sortBys](./answers-headless.verticalsearchstate.sortbys.md) +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [VerticalSearchState](./search-headless.verticalsearchstate.md) > [sortBys](./search-headless.verticalsearchstate.sortbys.md) ## VerticalSearchState.sortBys property diff --git a/docs/answers-headless.verticalsearchstate.source.md b/docs/search-headless.verticalsearchstate.source.md similarity index 50% rename from docs/answers-headless.verticalsearchstate.source.md rename to docs/search-headless.verticalsearchstate.source.md index 0239e1ef..8b484f54 100644 --- a/docs/answers-headless.verticalsearchstate.source.md +++ b/docs/search-headless.verticalsearchstate.source.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [VerticalSearchState](./answers-headless.verticalsearchstate.md) > [source](./answers-headless.verticalsearchstate.source.md) +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [VerticalSearchState](./search-headless.verticalsearchstate.md) > [source](./search-headless.verticalsearchstate.source.md) ## VerticalSearchState.source property diff --git a/docs/search-headless.verticalsearchstate.verticalkey.md b/docs/search-headless.verticalsearchstate.verticalkey.md new file mode 100644 index 00000000..27966856 --- /dev/null +++ b/docs/search-headless.verticalsearchstate.verticalkey.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [VerticalSearchState](./search-headless.verticalsearchstate.md) > [verticalKey](./search-headless.verticalsearchstate.verticalkey.md) + +## VerticalSearchState.verticalKey property + +The key associated with the vertical. + +Signature: + +```typescript +verticalKey?: string; +``` diff --git a/docs/answers-headless.visitor.id.md b/docs/search-headless.visitor.id.md similarity index 51% rename from docs/answers-headless.visitor.id.md rename to docs/search-headless.visitor.id.md index 5a22ef43..6a4c4318 100644 --- a/docs/answers-headless.visitor.id.md +++ b/docs/search-headless.visitor.id.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [Visitor](./answers-headless.visitor.md) > [id](./answers-headless.visitor.id.md) +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [Visitor](./search-headless.visitor.md) > [id](./search-headless.visitor.id.md) ## Visitor.id property diff --git a/docs/answers-headless.visitor.idmethod.md b/docs/search-headless.visitor.idmethod.md similarity index 54% rename from docs/answers-headless.visitor.idmethod.md rename to docs/search-headless.visitor.idmethod.md index 3aa3799a..ae099230 100644 --- a/docs/answers-headless.visitor.idmethod.md +++ b/docs/search-headless.visitor.idmethod.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [Visitor](./answers-headless.visitor.md) > [idMethod](./answers-headless.visitor.idmethod.md) +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [Visitor](./search-headless.visitor.md) > [idMethod](./search-headless.visitor.idmethod.md) ## Visitor.idMethod property diff --git a/docs/answers-headless.visitor.md b/docs/search-headless.visitor.md similarity index 56% rename from docs/answers-headless.visitor.md rename to docs/search-headless.visitor.md index 341a7298..9471f485 100644 --- a/docs/answers-headless.visitor.md +++ b/docs/search-headless.visitor.md @@ -1,6 +1,6 @@ -[Home](./index.md) > [@yext/answers-headless](./answers-headless.md) > [Visitor](./answers-headless.visitor.md) +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [Visitor](./search-headless.visitor.md) ## Visitor interface @@ -20,6 +20,6 @@ Visitor information is included with every request with the exception of questio | Property | Type | Description | | --- | --- | --- | -| [id](./answers-headless.visitor.id.md) | string | The ID associated with the user | -| [idMethod?](./answers-headless.visitor.idmethod.md) | string | (Optional) The type of visitor | +| [id](./search-headless.visitor.id.md) | string | The ID associated with the user | +| [idMethod?](./search-headless.visitor.idmethod.md) | string | (Optional) The type of visitor | diff --git a/etc/search-headless.api.md b/etc/search-headless.api.md new file mode 100644 index 00000000..bcd4d120 --- /dev/null +++ b/etc/search-headless.api.md @@ -0,0 +1,829 @@ +## API Report File for "@yext/search-headless" + +> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). + +```ts + +import { Unsubscribe } from '@reduxjs/toolkit'; + +// @public +export interface AdditionalHttpHeaders { + 'Client-SDK'?: ClientSDKHeaderValues; +} + +// @public +export interface AllResultsForVertical { + facets: DisplayableFacet[]; + results: Result[]; + resultsCount: number; +} + +// @public +export type AnswersConfig = AnswersConfigWithApiKey | AnswersConfigWithToken; + +// @public +export interface AnswersConfigWithApiKey extends BaseAnswersConfig { + apiKey: string; + token?: never; +} + +// @public +export interface AnswersConfigWithToken extends BaseAnswersConfig { + apiKey?: never; + token: string; +} + +// @public +export class AnswersCore { + constructor(searchService: SearchService, questionSubmissionService: QuestionSubmissionService, autoCompleteService: AutocompleteService); + filterSearch(request: FilterSearchRequest): Promise; + submitQuestion(request: QuestionSubmissionRequest): Promise; + universalAutocomplete(request: UniversalAutocompleteRequest): Promise; + universalSearch(request: UniversalSearchRequest): Promise; + verticalAutocomplete(request: VerticalAutocompleteRequest): Promise; + verticalSearch(request: VerticalSearchRequest): Promise; +} + +// @public +export class AnswersError extends Error { + code?: number; + message: string; + type?: string; + /* Excluded from this release type: __constructor */ +} + +// @public @deprecated (undocumented) +export const AnswersHeadless: typeof SearchHeadless; + +// @public +export interface AnswersRequest { + additionalHttpHeaders?: AdditionalHttpHeaders; +} + +// @public @deprecated (undocumented) +export const answersUtilities: typeof searchUtilities; + +// @public +export interface AppliedQueryFilter { + details?: LocationFilterDetails; + displayKey: string; + displayValue: string; + filter: Filter; + type: AppliedQueryFilterType; +} + +// @public +export enum AppliedQueryFilterType { + FieldValue = "FIELD_VALUE", + Intent = "INTENT", + Place = "PLACE" +} + +// @public +export interface AutocompleteResponse { + inputIntents: SearchIntent[]; + queryId?: string; + results: AutocompleteResult[]; + uuid: string; +} + +// @public +export interface AutocompleteResult { + filter?: Filter; + key?: string; + matchedSubstrings?: { + length: number; + offset: number; + }[]; + relatedItem?: Result; + value: string; + verticalKeys?: string[]; +} + +// @public +export interface AutocompleteService { + filterSearch(request: FilterSearchRequest): Promise; + universalAutocomplete(request: UniversalAutocompleteRequest): Promise; + verticalAutocomplete(request: VerticalAutocompleteRequest): Promise; +} + +// @public +export interface BaseAnswersConfig { + endpoints?: Endpoints; + experienceKey: string; + experienceVersion?: 'STAGING' | 'PRODUCTION' | string | number; + locale: string; + visitor?: Visitor; + /* Excluded from this release type: additionalQueryParams */ +} + +// @public +export interface BoundedRange { + max?: RangeBoundary; + min?: RangeBoundary; +} + +// @public +export interface ClientSDKHeaderValues { + [agent: string]: string | undefined; + ANSWERS_CORE?: never; +} + +// @public +export interface CombinedFilter { + combinator: FilterCombinator; + filters: (Filter | CombinedFilter)[]; +} + +// @public +export function combineFilters(filterA: FilterTypes, filterB: FilterTypes, combinator: FilterCombinator): CombinedFilter; + +// @public +export type Context = any; + +// @public +export function createDateRangeFilter(fieldId: string, range: BoundedRange): FilterTypes; + +// @public +export function createEqualsFilter(fieldId: string, value: string | number | boolean): Filter; + +// @public +export function createNearMeFilter(position: NearFilterValue): Filter; + +// @public +export function createNumberRangeFilter(fieldId: string, range: BoundedRange): FilterTypes; + +// @public +export const DEFAULT_HEADLESS_ID = "main"; + +// @public +export interface DirectAnswer { + fieldType: string; + relatedResult: Result; + type: DirectAnswerType; + value?: string; + verticalKey: string; +} + +// @public +export interface DirectAnswerState { + result?: FeaturedSnippetDirectAnswer | FieldValueDirectAnswer; +} + +// @public +export enum DirectAnswerType { + FeaturedSnippet = "FEATURED_SNIPPET", + FieldValue = "FIELD_VALUE" +} + +// @public +export enum Direction { + Ascending = "ASC", + Descending = "DESC" +} + +// @public +export interface DisplayableFacet extends Facet { + displayName: string; + fieldId: string; + options: DisplayableFacetOption[]; +} + +// @public +export interface DisplayableFacetOption extends FacetOption { + count: number; + displayName: string; + matcher: Matcher; + selected: boolean; + value: string | number | boolean | NumberRangeValue; +} + +// @public +export interface Endpoints { + // (undocumented) + filterSearch?: string; + // (undocumented) + questionSubmission?: string; + // (undocumented) + status?: string; + // (undocumented) + universalAutocomplete?: string; + // (undocumented) + universalSearch?: string; + // (undocumented) + verticalAutocomplete?: string; + // (undocumented) + verticalSearch?: string; +} + +// @public +export type EnumOrLiteral = T | `${T}`; + +// @public +export enum ErrorType { + BackendError = "BACKEND_ERROR", + InvalidConfig = "INVALID_CONFIG", + InvalidQuery = "INVALID_QUERY", + Timeout = "TIMEOUT" +} + +// @public +export interface Facet { + fieldId: string; + options: FacetOption[]; +} + +// @public +export interface FacetOption { + matcher: Matcher; + 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; + relatedResult: Result; + snippet: Snippet; + type: DirectAnswerType.FeaturedSnippet; + value?: string; + verticalKey: string; +} + +// @public +export interface FieldValueDirectAnswer extends DirectAnswer { + entityName: string; + fieldApiName: string; + fieldName: string; + fieldType: string; + relatedResult: Result; + type: DirectAnswerType.FieldValue; + value: string; + verticalKey: string; +} + +// @public +export interface Filter { + fieldId: string; + matcher: Matcher; + value: string | number | boolean | NearFilterValue | NumberRangeValue; +} + +// @public +export enum FilterCombinator { + AND = "$and", + OR = "$or" +} + +// @public +export interface FilterSearchRequest extends AnswersRequest { + excluded?: Filter[]; + fields: SearchParameterField[]; + input: string; + sectioned: boolean; + sessionTrackingEnabled?: boolean; + verticalKey: string; +} + +// @public +export interface FilterSearchResponse { + businessId?: string; + queryId?: string; + sections: { + label?: string; + results: AutocompleteResult[]; + }[]; + uuid: string; +} + +// @public +export interface FiltersState { + facets?: DisplayableFacet[]; + static?: SelectableFilter[]; +} + +// @public +export type FilterTypes = Filter | CombinedFilter; + +// @public +export type HeadlessConfig = AnswersConfig & { + headlessId?: string; + verticalKey?: string; +}; + +// @public +export type HighlightedFields = { + [fieldId: string]: HighlightedValue | HighlightedValue[] | HighlightedFields | HighlightedFields[]; +}; + +// @public +export interface HighlightedValue { + matchedSubstrings: { + length: number; + offset: number; + }[]; + value: string; +} + +// @public +function isCloseMatch(value: string, searchTerm: string): boolean; + +// @public +export interface LatLong { + latitude: number; + longitude: number; +} + +// @public +export interface LocationBias { + displayName: string; + latitude: number; + longitude: number; + method: LocationBiasMethod; +} + +// @public +export enum LocationBiasMethod { + Device = "DEVICE", + Ip = "IP", + Unknown = "UNKNOWN" +} + +// @public +export interface LocationBoundingBox { + maxLatitude: number; + maxLongitude: number; + minLatitude: number; + minLongitude: number; +} + +// @public +export interface LocationFilterDetails { + boundingBox?: LocationBoundingBox; + featureTypes: string[]; + latitude: number; + longitude: number; + placeName: string; +} + +// @public +export interface LocationState { + locationBias?: LocationBias; + userLocation?: LatLong; +} + +// @public +export interface LowerNumberRangeLimit { + matcher: Matcher.GreaterThan | Matcher.GreaterThanOrEqualTo; + value: number; +} + +// @public +export enum Matcher { + Between = "$between", + Equals = "$eq", + GreaterThan = "$gt", + GreaterThanOrEqualTo = "$ge", + LessThan = "$lt", + LessThanOrEqualTo = "$le", + Near = "$near", + NotEquals = "!$eq" +} + +// @public +export interface MetaState { + context?: Context; + referrerPageUrl?: string; + searchType: SearchType; + uuid?: string; +} + +// @public +export interface NearFilterValue { + lat: number; + lng: number; + radius: number; +} + +// @public +export interface NumberRangeValue { + end?: UpperNumberRangeLimit; + start?: LowerNumberRangeLimit; +} + +// @public +export interface ParentState { + [headlessId: string]: State; +} + +// @public @deprecated +export const provideAnswersHeadless: typeof provideSearchHeadless; + +// Warning: (ae-internal-mixed-release-tag) Mixed release tags are not allowed for "provideSearchHeadless" because one of its declarations is marked as @internal +// +// @public +export function provideSearchHeadless(config: HeadlessConfig): SearchHeadless; + +// @internal +export function provideSearchHeadless(config: HeadlessConfig, additionalHttpHeaders: AdditionalHttpHeaders): SearchHeadless; + +// @public +export interface QueryRulesActionsData { + data?: Record; + errors?: { + uuid: string; + type: string; + message?: string; + }[]; + key: string; +} + +// @public +export interface QueryRulesState { + actions: QueryRulesActionsData[]; +} + +// @public +export enum QuerySource { + Autocomplete = "AUTOCOMPLETE", + Overlay = "OVERLAY", + Standard = "STANDARD" +} + +// @public +export interface QueryState { + input?: string; + mostRecentSearch?: string; + queryId?: string; + querySource?: QuerySource; + queryTrigger?: QueryTrigger; + searchIntents?: SearchIntent[]; +} + +// @public +export enum QueryTrigger { + Initialize = "initialize", + Suggest = "suggest" +} + +// @public +export interface QuestionSubmissionRequest extends AnswersRequest { + email: string; + entityId: string; + name: string; + questionDescription?: string; + questionText: string; + sessionTrackingEnabled?: boolean; +} + +// @public +export interface QuestionSubmissionResponse { + uuid: string; +} + +// @public +export interface QuestionSubmissionService { + submitQuestion(request: QuestionSubmissionRequest): Promise; +} + +// @public +export interface RangeBoundary { + inclusive: boolean; + value: T; +} + +// @public +export interface Result { + description?: string; + distance?: number; + distanceFromFilter?: number; + entityType?: string; + highlightedFields?: HighlightedFields; + id?: string; + index?: number; + link?: string; + name?: string; + rawData: Record; + source: Source; +} + +// @public +export const SandboxEndpoints: Required; + +// @public +export class SearchHeadless { + // Warning: (ae-forgotten-export) The symbol "HttpManager" needs to be exported by the entry point index.d.ts + constructor(core: AnswersCore, stateManager: StateManager, httpManager: HttpManager, additionalHttpHeaders?: AdditionalHttpHeaders | undefined); + addListener(listener: StateListener): Unsubscribe; + executeFilterSearch(query: string, sectioned: boolean, fields: SearchParameterField[]): Promise; + executeUniversalAutocomplete(): Promise; + executeUniversalQuery(): Promise; + executeVerticalAutocomplete(): Promise; + executeVerticalQuery(): Promise; + resetFacets(): void; + setAlternativeVerticals(alternativeVerticals: VerticalResults[]): void; + setContext(context: Context): void; + setFacetOption(fieldId: string, facetOption: FacetOption, selected: boolean): void; + setFacets(facets: DisplayableFacet[]): void; + setFilterOption(filter: SelectableFilter): void; + setOffset(offset: number): void; + setQuery(input: string): void; + setQuerySource(source: QuerySource): void; + setQueryTrigger(trigger: QueryTrigger): void; + setReferrerPageUrl(referrerPageUrl: string): void; + setRestrictVerticals(restrictVerticals: string[]): void; + setSessionId(sessionId: string): void; + setSessionTrackingEnabled(enabled: boolean): void; + setSortBys(sortBys: SortBy[]): void; + setSpellCheckEnabled(enabled: boolean): void; + setState(state: State): void; + setStaticFilters(filters: SelectableFilter[]): void; + setUniversal(): void; + setUniversalLimit(limit: UniversalLimit): void; + setUserLocation(latLong: LatLong): void; + setVertical(verticalKey: string): void; + setVerticalLimit(limit: number): void; + get state(): State; + submitQuestion(request: Omit): Promise; + readonly utilities: typeof searchUtilities; +} + +// @public +export enum SearchIntent { + NearMe = "NEAR_ME" +} + +// @public +export interface SearchParameterField { + entityType: string; + fetchEntities: boolean; + fieldApiName: string; +} + +// @public +export interface SearchService { + universalSearch(request: UniversalSearchRequest): Promise; + verticalSearch(request: VerticalSearchRequest): Promise; +} + +// @public +export interface SearchStatusState { + isLoading?: boolean; +} + +// @public +function searchThroughFacet(facet: DisplayableFacet, searchTerm: string): DisplayableFacet; + +// @public +export type SearchType = EnumOrLiteral; + +// @public +export enum SearchTypeEnum { + Universal = "universal", + Vertical = "vertical" +} + +declare namespace searchUtilities { + export { + searchThroughFacet, + isCloseMatch + } +} +export { searchUtilities } + +// @public +export interface SelectableFilter extends Filter { + displayName?: string; + selected: boolean; +} + +// @public +export interface SessionTrackingState { + enabled?: boolean; + sessionId?: string; +} + +// @public +export interface Snippet { + matchedSubstrings: { + offset: number; + length: number; + }[]; + value: string; +} + +// @public +export interface SortBy { + direction?: Direction; + field?: string; + type: SortType; +} + +// @public +export enum SortType { + EntityDistance = "ENTITY_DISTANCE", + Field = "FIELD", + Relevance = "RELEVANCE" +} + +// @public +export enum Source { + Algolia = "ALGOLIA", + Bing = "BING_CSE", + Custom = "CUSTOM_SEARCHER", + Google = "GOOGLE_CSE", + KnowledgeManager = "KNOWLEDGE_MANAGER", + Zendesk = "ZENDESK" +} + +// @public +export interface SpellCheck { + correctedQuery: string; + originalQuery: string; + type: SpellCheckType; +} + +// @public +export interface SpellCheckState extends Partial { + enabled: boolean; +} + +// @public +export enum SpellCheckType { + AutoCorrect = "AUTOCORRECT", + Combine = "COMBINE", + Suggest = "SUGGEST" +} + +// @public +export interface State { + directAnswer: DirectAnswerState; + filters: FiltersState; + location: LocationState; + meta: MetaState; + query: QueryState; + queryRules: QueryRulesState; + searchStatus: SearchStatusState; + sessionTracking: SessionTrackingState; + spellCheck: SpellCheckState; + universal: UniversalSearchState; + vertical: VerticalSearchState; +} + +// @public +export interface StateListener { + callback(currentValue: T): any; + valueAccessor(state: State): T; +} + +// @public +export interface StateManager { + addListener(listener: StateListener): Unsubscribe; + dispatchEvent(type: string, payload?: unknown): void; + getState(): State; +} + +// @public +export interface UniversalAutocompleteRequest extends AnswersRequest { + input: string; + sessionTrackingEnabled?: boolean; +} + +// @public +export interface UniversalLimit { + // (undocumented) + [verticalKey: string]: number; +} + +// @public +export interface UniversalSearchRequest extends AnswersRequest { + context?: Context; + limit?: UniversalLimit; + location?: LatLong; + query: string; + querySource?: QuerySource | string; + queryTrigger?: QueryTrigger; + referrerPageUrl?: string; + restrictVerticals?: string[]; + sessionId?: string; + sessionTrackingEnabled?: boolean; + skipSpellCheck?: boolean; +} + +// @public +export interface UniversalSearchResponse { + directAnswer?: FeaturedSnippetDirectAnswer | FieldValueDirectAnswer; + failedVerticals?: FailedVertical[]; + locationBias?: LocationBias; + queryId?: string; + queryRulesActionsData?: QueryRulesActionsData[]; + searchIntents?: SearchIntent[]; + spellCheck?: SpellCheck; + uuid: string; + verticalResults: VerticalResults[]; +} + +// @public +export interface UniversalSearchState { + limit?: UniversalLimit; + restrictVerticals?: string[]; + verticals?: VerticalResults[]; +} + +// @public +export interface UpperNumberRangeLimit { + matcher: Matcher.LessThan | Matcher.LessThanOrEqualTo; + value: number; +} + +// @public +export interface VerticalAutocompleteRequest extends AnswersRequest { + input: string; + sessionTrackingEnabled?: boolean; + verticalKey: string; +} + +// @public +export interface VerticalResults { + appliedQueryFilters: AppliedQueryFilter[]; + queryDurationMillis: number; + results: Result[]; + resultsCount: number; + source: Source; + verticalKey: string; +} + +// @public +export interface VerticalSearchRequest extends AnswersRequest { + context?: Context; + facets?: Facet[]; + limit?: number; + location?: LatLong; + locationRadius?: number; + offset?: number; + query: string; + queryId?: string; + querySource?: QuerySource | string; + queryTrigger?: QueryTrigger; + referrerPageUrl?: string; + retrieveFacets?: boolean; + sessionId?: string; + sessionTrackingEnabled?: boolean; + skipSpellCheck?: boolean; + sortBys?: SortBy[]; + staticFilters?: CombinedFilter | Filter; + verticalKey: string; +} + +// @public +export interface VerticalSearchResponse { + allResultsForVertical?: VerticalSearchResponse; + alternativeVerticals?: VerticalResults[]; + directAnswer?: FeaturedSnippetDirectAnswer | FieldValueDirectAnswer; + facets?: DisplayableFacet[]; + locationBias?: LocationBias; + queryId: string; + queryRulesActionsData?: QueryRulesActionsData[]; + searchIntents?: SearchIntent[]; + spellCheck?: SpellCheck; + uuid: string; + verticalResults: VerticalResults; +} + +// @public +export interface VerticalSearchState { + appliedQueryFilters?: AppliedQueryFilter[]; + displayName?: string; + limit?: number; + noResults?: { + allResultsForVertical: AllResultsForVertical; + alternativeVerticals: VerticalResults[]; + }; + offset?: number; + queryDurationMillis?: number; + results?: Result[]; + resultsCount?: number; + sortBys?: SortBy[]; + source?: Source; + verticalKey?: string; +} + +// @public +export interface Visitor { + id: string; + idMethod?: string; +} + +// (No @packageDocumentation comment for this package) + +``` diff --git a/src/index.ts b/src/index.ts index 843d5e85..26818d53 100644 --- a/src/index.ts +++ b/src/index.ts @@ -122,7 +122,11 @@ function linkSessionTracking(firstHeadless: SearchHeadless, secondHeadless: Sear export { SearchHeadless }; -/** @deprecated answersUtilities has been deprecated and renamed to searchUtilities */ +/** + * @public + * + * @deprecated answersUtilities has been deprecated and renamed to searchUtilities + */ export const answersUtilities = searchUtilities; /** @@ -138,5 +142,9 @@ export const answersUtilities = searchUtilities; */ export const provideAnswersHeadless = provideSearchHeadless; -/** @deprecated AnswersHeadless has been deprecated and renamed to SearchHeadless */ +/** + * @public + * + * @deprecated AnswersHeadless has been deprecated and renamed to SearchHeadless + */ export const AnswersHeadless = SearchHeadless; \ No newline at end of file From b0d8b7c57a98d54646652723a989a535f4c15fbf Mon Sep 17 00:00:00 2001 From: Cindy Yang Date: Wed, 6 Jul 2022 12:45:19 -0400 Subject: [PATCH 03/22] update test site --- test-site-node/package-lock.json | 22 +++++++++++----------- test-site-node/package.json | 2 +- 2 files changed, 12 insertions(+), 12 deletions(-) diff --git a/test-site-node/package-lock.json b/test-site-node/package-lock.json index dae6068e..ead6cae5 100644 --- a/test-site-node/package-lock.json +++ b/test-site-node/package-lock.json @@ -9,16 +9,16 @@ "version": "1.0.0", "license": "ISC", "dependencies": { - "@yext/answers-headless": "file:.." + "@yext/search-headless": "file:.." } }, "..": { - "name": "@yext/answers-headless", - "version": "1.1.1-alpha.96", + "name": "@yext/search-headless", + "version": "1.2.0", "license": "ISC", "dependencies": { "@reduxjs/toolkit": "^1.8.1", - "@yext/answers-core": "^1.7.0-alpha.165", + "@yext/answers-core": "^1.7.0", "js-levenshtein": "^1.1.6", "lodash": "^4.17.21" }, @@ -27,7 +27,7 @@ "@babel/preset-typescript": "^7.16.5", "@microsoft/api-documenter": "^7.13.76", "@microsoft/api-extractor": "^7.19.2", - "@types/jest": "^27.0.3", + "@types/jest": "^28.1.1", "@types/lodash": "^4.14.178", "@types/node": "^16.11.12", "@typescript-eslint/eslint-plugin": "^5.16.0", @@ -39,18 +39,18 @@ "eslint-config-react-app": "^7.0.0", "eslint-plugin-tsdoc": "^0.2.14", "generate-license-file": "^1.3.0", - "jest": "^27.4.5", + "jest": "^28.1.0", "ts-node": "^10.4.0", "typescript": "^4.5.4" } }, - "node_modules/@yext/answers-headless": { + "node_modules/@yext/search-headless": { "resolved": "..", "link": true } }, "dependencies": { - "@yext/answers-headless": { + "@yext/search-headless": { "version": "file:..", "requires": { "@babel/preset-env": "^7.16.5", @@ -58,12 +58,12 @@ "@microsoft/api-documenter": "^7.13.76", "@microsoft/api-extractor": "^7.19.2", "@reduxjs/toolkit": "^1.8.1", - "@types/jest": "^27.0.3", + "@types/jest": "^28.1.1", "@types/lodash": "^4.14.178", "@types/node": "^16.11.12", "@typescript-eslint/eslint-plugin": "^5.16.0", "@typescript-eslint/parser": "^5.16.0", - "@yext/answers-core": "^1.7.0-alpha.165", + "@yext/answers-core": "^1.7.0", "@yext/eslint-config-slapshot": "^0.2.0", "@yext/eslint-plugin-export-star": "^1.0.0", "babel-jest": "^27.4.5", @@ -71,7 +71,7 @@ "eslint-config-react-app": "^7.0.0", "eslint-plugin-tsdoc": "^0.2.14", "generate-license-file": "^1.3.0", - "jest": "^27.4.5", + "jest": "^28.1.0", "js-levenshtein": "^1.1.6", "lodash": "^4.17.21", "ts-node": "^10.4.0", diff --git a/test-site-node/package.json b/test-site-node/package.json index 61fa3ff6..f520540f 100644 --- a/test-site-node/package.json +++ b/test-site-node/package.json @@ -10,6 +10,6 @@ "author": "", "license": "ISC", "dependencies": { - "@yext/answers-headless": "file:.." + "@yext/search-headless": "file:.." } } From c96d42eec252c3aca8f36ff36922a0ff65dad2f6 Mon Sep 17 00:00:00 2001 From: Cindy <74145775+ElemelonWind@users.noreply.github.com> Date: Mon, 11 Jul 2022 12:05:56 -0400 Subject: [PATCH 04/22] Update index.ts --- src/index.ts | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/index.ts b/src/index.ts index 26818d53..d9a67149 100644 --- a/src/index.ts +++ b/src/index.ts @@ -31,7 +31,7 @@ export type HeadlessConfig = AnswersConfig & { headlessId?: string, /** * The verticalKey associated with the vertical to manage. If none is provided, - * Answers Headless will manage universal search. + * Search Headless will manage universal search. */ verticalKey?: string }; @@ -147,4 +147,4 @@ export const provideAnswersHeadless = provideSearchHeadless; * * @deprecated AnswersHeadless has been deprecated and renamed to SearchHeadless */ -export const AnswersHeadless = SearchHeadless; \ No newline at end of file +export const AnswersHeadless = SearchHeadless; From 4b8fb1a1ab6c51ba693b42bce0cfea93c6ccce5e Mon Sep 17 00:00:00 2001 From: Cindy Yang Date: Mon, 11 Jul 2022 12:57:23 -0400 Subject: [PATCH 05/22] Addressed comments --- README.md | 2 +- docs/search-headless.answersheadless.md | 16 - docs/search-headless.answersutilities.md | 16 - docs/search-headless.md | 5 +- .../search-headless.provideanswersheadless.md | 18 - ....md => search-headless.provideheadless.md} | 6 +- etc/answers-headless.api.md | 820 ------------------ etc/search-headless.api.md | 15 +- src/deprecated.ts | 29 + src/index.ts | 35 +- 10 files changed, 41 insertions(+), 921 deletions(-) delete mode 100644 docs/search-headless.answersheadless.md delete mode 100644 docs/search-headless.answersutilities.md delete mode 100644 docs/search-headless.provideanswersheadless.md rename docs/{search-headless.providesearchheadless.md => search-headless.provideheadless.md} (74%) delete mode 100644 etc/answers-headless.api.md create mode 100644 src/deprecated.ts diff --git a/README.md b/README.md index 2aecde82..70dd7d91 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ # search-headless A library for powering UI components for Yext Search integrations. -[Full Documentation](./docs/answers-headless.md) +[Full Documentation](./docs/search-headless.md) Coverage Status diff --git a/docs/search-headless.answersheadless.md b/docs/search-headless.answersheadless.md deleted file mode 100644 index 69138d78..00000000 --- a/docs/search-headless.answersheadless.md +++ /dev/null @@ -1,16 +0,0 @@ - - -[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [AnswersHeadless](./search-headless.answersheadless.md) - -## AnswersHeadless variable - -> Warning: This API is now obsolete. -> -> AnswersHeadless has been deprecated and renamed to SearchHeadless -> - -Signature: - -```typescript -AnswersHeadless: typeof SearchHeadless -``` diff --git a/docs/search-headless.answersutilities.md b/docs/search-headless.answersutilities.md deleted file mode 100644 index 3042e331..00000000 --- a/docs/search-headless.answersutilities.md +++ /dev/null @@ -1,16 +0,0 @@ - - -[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [answersUtilities](./search-headless.answersutilities.md) - -## answersUtilities variable - -> Warning: This API is now obsolete. -> -> answersUtilities has been deprecated and renamed to searchUtilities -> - -Signature: - -```typescript -answersUtilities: typeof searchUtilities -``` diff --git a/docs/search-headless.md b/docs/search-headless.md index 256a0f3f..9af51455 100644 --- a/docs/search-headless.md +++ b/docs/search-headless.md @@ -40,7 +40,7 @@ | [createEqualsFilter(fieldId, value)](./search-headless.createequalsfilter.md) | Creates a simple [Filter](./search-headless.filter.md) that ensures all results will match a specific field value. | | [createNearMeFilter(position)](./search-headless.createnearmefilter.md) | Creates a [Filter](./search-headless.filter.md) that matches all results within a certain radius of the given position. | | [createNumberRangeFilter(fieldId, range)](./search-headless.createnumberrangefilter.md) | Creates a [Filter](./search-headless.filter.md) or [CombinedFilter](./search-headless.combinedfilter.md) that matches all results where the given field value falls in a specific number [BoundedRange](./search-headless.boundedrange.md). | -| [provideSearchHeadless(config)](./search-headless.providesearchheadless.md) | Supplies a new instance of [SearchHeadless](./search-headless.searchheadless.md), using the provided configuration. | +| [provideHeadless(config)](./search-headless.provideheadless.md) | Supplies a new instance of [SearchHeadless](./search-headless.searchheadless.md), using the provided configuration. | ## Interfaces @@ -127,10 +127,7 @@ | Variable | Description | | --- | --- | -| [AnswersHeadless](./search-headless.answersheadless.md) | | -| [answersUtilities](./search-headless.answersutilities.md) | | | [DEFAULT\_HEADLESS\_ID](./search-headless.default_headless_id.md) | The headlessId automatically given to the first SearchHeadless instance created. | -| [provideAnswersHeadless](./search-headless.provideanswersheadless.md) | Supplies a new instance of [SearchHeadless](./search-headless.searchheadless.md), using the provided configuration. | | [SandboxEndpoints](./search-headless.sandboxendpoints.md) | The endpoints to use for sandbox experiences. | ## Type Aliases diff --git a/docs/search-headless.provideanswersheadless.md b/docs/search-headless.provideanswersheadless.md deleted file mode 100644 index 4f11d485..00000000 --- a/docs/search-headless.provideanswersheadless.md +++ /dev/null @@ -1,18 +0,0 @@ - - -[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [provideAnswersHeadless](./search-headless.provideanswersheadless.md) - -## provideAnswersHeadless variable - -> Warning: This API is now obsolete. -> -> provideAnswersHeadless has been deprecated and renamed to provideSearchHeadless -> - -Supplies a new instance of [SearchHeadless](./search-headless.searchheadless.md), using the provided configuration. - -Signature: - -```typescript -provideAnswersHeadless: typeof provideSearchHeadless -``` diff --git a/docs/search-headless.providesearchheadless.md b/docs/search-headless.provideheadless.md similarity index 74% rename from docs/search-headless.providesearchheadless.md rename to docs/search-headless.provideheadless.md index 12209bb7..6b16dac9 100644 --- a/docs/search-headless.providesearchheadless.md +++ b/docs/search-headless.provideheadless.md @@ -1,15 +1,15 @@ -[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [provideSearchHeadless](./search-headless.providesearchheadless.md) +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [provideHeadless](./search-headless.provideheadless.md) -## provideSearchHeadless() function +## provideHeadless() function Supplies a new instance of [SearchHeadless](./search-headless.searchheadless.md), using the provided configuration. Signature: ```typescript -export declare function provideSearchHeadless(config: HeadlessConfig): SearchHeadless; +export declare function provideHeadless(config: HeadlessConfig): SearchHeadless; ``` ## Parameters diff --git a/etc/answers-headless.api.md b/etc/answers-headless.api.md deleted file mode 100644 index 15c6c95e..00000000 --- a/etc/answers-headless.api.md +++ /dev/null @@ -1,820 +0,0 @@ -## API Report File for "@yext/answers-headless" - -> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). - -```ts - -import { Unsubscribe } from '@reduxjs/toolkit'; - -// @public -export interface AdditionalHttpHeaders { - 'Client-SDK'?: ClientSDKHeaderValues; -} - -// @public -export interface AllResultsForVertical { - facets: DisplayableFacet[]; - results: Result[]; - resultsCount: number; -} - -// @public -export type AnswersConfig = AnswersConfigWithApiKey | AnswersConfigWithToken; - -// @public -export interface AnswersConfigWithApiKey extends BaseAnswersConfig { - apiKey: string; - token?: never; -} - -// @public -export interface AnswersConfigWithToken extends BaseAnswersConfig { - apiKey?: never; - token: string; -} - -// @public -export class AnswersCore { - constructor(searchService: SearchService, questionSubmissionService: QuestionSubmissionService, autoCompleteService: AutocompleteService); - filterSearch(request: FilterSearchRequest): Promise; - submitQuestion(request: QuestionSubmissionRequest): Promise; - universalAutocomplete(request: UniversalAutocompleteRequest): Promise; - universalSearch(request: UniversalSearchRequest): Promise; - verticalAutocomplete(request: VerticalAutocompleteRequest): Promise; - verticalSearch(request: VerticalSearchRequest): Promise; -} - -// @public -export class AnswersError extends Error { - code?: number; - message: string; - type?: string; - /* Excluded from this release type: __constructor */ -} - -// @public -export class AnswersHeadless { - // Warning: (ae-forgotten-export) The symbol "HttpManager" needs to be exported by the entry point index.d.ts - constructor(core: AnswersCore, stateManager: StateManager, httpManager: HttpManager, additionalHttpHeaders?: AdditionalHttpHeaders | undefined); - addListener(listener: StateListener): Unsubscribe; - executeFilterSearch(query: string, sectioned: boolean, fields: SearchParameterField[]): Promise; - executeUniversalAutocomplete(): Promise; - executeUniversalQuery(): Promise; - executeVerticalAutocomplete(): Promise; - executeVerticalQuery(): Promise; - resetFacets(): void; - setAlternativeVerticals(alternativeVerticals: VerticalResults[]): void; - setContext(context: Context): void; - setFacetOption(fieldId: string, facetOption: FacetOption, selected: boolean): void; - setFacets(facets: DisplayableFacet[]): void; - setFilterOption(filter: SelectableFilter): void; - setOffset(offset: number): void; - setQuery(input: string): void; - setQuerySource(source: QuerySource): void; - setQueryTrigger(trigger: QueryTrigger): void; - setReferrerPageUrl(referrerPageUrl: string): void; - setRestrictVerticals(restrictVerticals: string[]): void; - setSessionId(sessionId: string): void; - setSessionTrackingEnabled(enabled: boolean): void; - setSortBys(sortBys: SortBy[]): void; - setSpellCheckEnabled(enabled: boolean): void; - setState(state: State): void; - setStaticFilters(filters: SelectableFilter[]): void; - setUniversal(): void; - setUniversalLimit(limit: UniversalLimit): void; - setUserLocation(latLong: LatLong): void; - setVertical(verticalKey: string): void; - setVerticalLimit(limit: number): void; - get state(): State; - submitQuestion(request: Omit): Promise; - readonly utilities: typeof answersUtilities; -} - -// @public -export interface AnswersRequest { - additionalHttpHeaders?: AdditionalHttpHeaders; -} - -declare namespace answersUtilities { - export { - searchThroughFacet, - isCloseMatch - } -} -export { answersUtilities } - -// @public -export interface AppliedQueryFilter { - details?: LocationFilterDetails; - displayKey: string; - displayValue: string; - filter: Filter; - type: AppliedQueryFilterType; -} - -// @public -export enum AppliedQueryFilterType { - FieldValue = "FIELD_VALUE", - Intent = "INTENT", - Place = "PLACE" -} - -// @public -export interface AutocompleteResponse { - inputIntents: SearchIntent[]; - queryId?: string; - results: AutocompleteResult[]; - uuid: string; -} - -// @public -export interface AutocompleteResult { - filter?: Filter; - key?: string; - matchedSubstrings?: { - length: number; - offset: number; - }[]; - relatedItem?: Result; - value: string; - verticalKeys?: string[]; -} - -// @public -export interface AutocompleteService { - filterSearch(request: FilterSearchRequest): Promise; - universalAutocomplete(request: UniversalAutocompleteRequest): Promise; - verticalAutocomplete(request: VerticalAutocompleteRequest): Promise; -} - -// @public -export interface BaseAnswersConfig { - endpoints?: Endpoints; - experienceKey: string; - experienceVersion?: 'STAGING' | 'PRODUCTION' | string | number; - locale: string; - visitor?: Visitor; - /* Excluded from this release type: additionalQueryParams */ -} - -// @public -export interface BoundedRange { - max?: RangeBoundary; - min?: RangeBoundary; -} - -// @public -export interface ClientSDKHeaderValues { - [agent: string]: string | undefined; - ANSWERS_CORE?: never; -} - -// @public -export interface CombinedFilter { - combinator: FilterCombinator; - filters: (Filter | CombinedFilter)[]; -} - -// @public -export function combineFilters(filterA: FilterTypes, filterB: FilterTypes, combinator: FilterCombinator): CombinedFilter; - -// @public -export type Context = any; - -// @public -export function createDateRangeFilter(fieldId: string, range: BoundedRange): FilterTypes; - -// @public -export function createEqualsFilter(fieldId: string, value: string | number | boolean): Filter; - -// @public -export function createNearMeFilter(position: NearFilterValue): Filter; - -// @public -export function createNumberRangeFilter(fieldId: string, range: BoundedRange): FilterTypes; - -// @public -export const DEFAULT_HEADLESS_ID = "main"; - -// @public -export interface DirectAnswer { - fieldType: string; - relatedResult: Result; - type: DirectAnswerType; - value?: string; - verticalKey: string; -} - -// @public -export interface DirectAnswerState { - result?: FeaturedSnippetDirectAnswer | FieldValueDirectAnswer; -} - -// @public -export enum DirectAnswerType { - FeaturedSnippet = "FEATURED_SNIPPET", - FieldValue = "FIELD_VALUE" -} - -// @public -export enum Direction { - Ascending = "ASC", - Descending = "DESC" -} - -// @public -export interface DisplayableFacet extends Facet { - displayName: string; - fieldId: string; - options: DisplayableFacetOption[]; -} - -// @public -export interface DisplayableFacetOption extends FacetOption { - count: number; - displayName: string; - matcher: Matcher; - selected: boolean; - value: string | number | boolean | NumberRangeValue; -} - -// @public -export interface Endpoints { - // (undocumented) - filterSearch?: string; - // (undocumented) - questionSubmission?: string; - // (undocumented) - status?: string; - // (undocumented) - universalAutocomplete?: string; - // (undocumented) - universalSearch?: string; - // (undocumented) - verticalAutocomplete?: string; - // (undocumented) - verticalSearch?: string; -} - -// @public -export type EnumOrLiteral = T | `${T}`; - -// @public -export enum ErrorType { - BackendError = "BACKEND_ERROR", - InvalidConfig = "INVALID_CONFIG", - InvalidQuery = "INVALID_QUERY", - Timeout = "TIMEOUT" -} - -// @public -export interface Facet { - fieldId: string; - options: FacetOption[]; -} - -// @public -export interface FacetOption { - matcher: Matcher; - 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; - relatedResult: Result; - snippet: Snippet; - type: DirectAnswerType.FeaturedSnippet; - value?: string; - verticalKey: string; -} - -// @public -export interface FieldValueDirectAnswer extends DirectAnswer { - entityName: string; - fieldApiName: string; - fieldName: string; - fieldType: string; - relatedResult: Result; - type: DirectAnswerType.FieldValue; - value: string; - verticalKey: string; -} - -// @public -export interface Filter { - fieldId: string; - matcher: Matcher; - value: string | number | boolean | NearFilterValue | NumberRangeValue; -} - -// @public -export enum FilterCombinator { - AND = "$and", - OR = "$or" -} - -// @public -export interface FilterSearchRequest extends AnswersRequest { - excluded?: Filter[]; - fields: SearchParameterField[]; - input: string; - sectioned: boolean; - sessionTrackingEnabled?: boolean; - verticalKey: string; -} - -// @public -export interface FilterSearchResponse { - businessId?: string; - queryId?: string; - sections: { - label?: string; - results: AutocompleteResult[]; - }[]; - uuid: string; -} - -// @public -export interface FiltersState { - facets?: DisplayableFacet[]; - static?: SelectableFilter[]; -} - -// @public -export type FilterTypes = Filter | CombinedFilter; - -// @public -export type HeadlessConfig = AnswersConfig & { - headlessId?: string; - verticalKey?: string; -}; - -// @public -export type HighlightedFields = { - [fieldId: string]: HighlightedValue | HighlightedValue[] | HighlightedFields | HighlightedFields[]; -}; - -// @public -export interface HighlightedValue { - matchedSubstrings: { - length: number; - offset: number; - }[]; - value: string; -} - -// @public -function isCloseMatch(value: string, searchTerm: string): boolean; - -// @public -export interface LatLong { - latitude: number; - longitude: number; -} - -// @public -export interface LocationBias { - displayName: string; - latitude: number; - longitude: number; - method: LocationBiasMethod; -} - -// @public -export enum LocationBiasMethod { - Device = "DEVICE", - Ip = "IP", - Unknown = "UNKNOWN" -} - -// @public -export interface LocationBoundingBox { - maxLatitude: number; - maxLongitude: number; - minLatitude: number; - minLongitude: number; -} - -// @public -export interface LocationFilterDetails { - boundingBox?: LocationBoundingBox; - featureTypes: string[]; - latitude: number; - longitude: number; - placeName: string; -} - -// @public -export interface LocationState { - locationBias?: LocationBias; - userLocation?: LatLong; -} - -// @public -export interface LowerNumberRangeLimit { - matcher: Matcher.GreaterThan | Matcher.GreaterThanOrEqualTo; - value: number; -} - -// @public -export enum Matcher { - Between = "$between", - Equals = "$eq", - GreaterThan = "$gt", - GreaterThanOrEqualTo = "$ge", - LessThan = "$lt", - LessThanOrEqualTo = "$le", - Near = "$near", - NotEquals = "!$eq" -} - -// @public -export interface MetaState { - context?: Context; - referrerPageUrl?: string; - searchType: SearchType; - uuid?: string; -} - -// @public -export interface NearFilterValue { - lat: number; - lng: number; - radius: number; -} - -// @public -export interface NumberRangeValue { - end?: UpperNumberRangeLimit; - start?: LowerNumberRangeLimit; -} - -// @public -export interface ParentState { - [headlessId: string]: State; -} - -// Warning: (ae-internal-mixed-release-tag) Mixed release tags are not allowed for "provideAnswersHeadless" because one of its declarations is marked as @internal -// -// @public -export function provideAnswersHeadless(config: HeadlessConfig): AnswersHeadless; - -// @internal -export function provideAnswersHeadless(config: HeadlessConfig, additionalHttpHeaders: AdditionalHttpHeaders): AnswersHeadless; - -// @public -export interface QueryRulesActionsData { - data?: Record; - errors?: { - uuid: string; - type: string; - message?: string; - }[]; - key: string; -} - -// @public -export interface QueryRulesState { - actions: QueryRulesActionsData[]; -} - -// @public -export enum QuerySource { - Autocomplete = "AUTOCOMPLETE", - Overlay = "OVERLAY", - Standard = "STANDARD" -} - -// @public -export interface QueryState { - input?: string; - mostRecentSearch?: string; - queryId?: string; - querySource?: QuerySource; - queryTrigger?: QueryTrigger; - searchIntents?: SearchIntent[]; -} - -// @public -export enum QueryTrigger { - Initialize = "initialize", - Suggest = "suggest" -} - -// @public -export interface QuestionSubmissionRequest extends AnswersRequest { - email: string; - entityId: string; - name: string; - questionDescription?: string; - questionText: string; - sessionTrackingEnabled?: boolean; -} - -// @public -export interface QuestionSubmissionResponse { - uuid: string; -} - -// @public -export interface QuestionSubmissionService { - submitQuestion(request: QuestionSubmissionRequest): Promise; -} - -// @public -export interface RangeBoundary { - inclusive: boolean; - value: T; -} - -// @public -export interface Result { - description?: string; - distance?: number; - distanceFromFilter?: number; - entityType?: string; - highlightedFields?: HighlightedFields; - id?: string; - index?: number; - link?: string; - name?: string; - rawData: Record; - source: Source; -} - -// @public -export const SandboxEndpoints: Required; - -// @public -export enum SearchIntent { - NearMe = "NEAR_ME" -} - -// @public -export interface SearchParameterField { - entityType: string; - fetchEntities: boolean; - fieldApiName: string; -} - -// @public -export interface SearchService { - universalSearch(request: UniversalSearchRequest): Promise; - verticalSearch(request: VerticalSearchRequest): Promise; -} - -// @public -export interface SearchStatusState { - isLoading?: boolean; -} - -// @public -function searchThroughFacet(facet: DisplayableFacet, searchTerm: string): DisplayableFacet; - -// @public -export type SearchType = EnumOrLiteral; - -// @public -export enum SearchTypeEnum { - Universal = "universal", - Vertical = "vertical" -} - -// @public -export interface SelectableFilter extends Filter { - displayName?: string; - selected: boolean; -} - -// @public -export interface SessionTrackingState { - enabled?: boolean; - sessionId?: string; -} - -// @public -export interface Snippet { - matchedSubstrings: { - offset: number; - length: number; - }[]; - value: string; -} - -// @public -export interface SortBy { - direction?: Direction; - field?: string; - type: SortType; -} - -// @public -export enum SortType { - EntityDistance = "ENTITY_DISTANCE", - Field = "FIELD", - Relevance = "RELEVANCE" -} - -// @public -export enum Source { - Algolia = "ALGOLIA", - Bing = "BING_CSE", - Custom = "CUSTOM_SEARCHER", - Google = "GOOGLE_CSE", - KnowledgeManager = "KNOWLEDGE_MANAGER", - Zendesk = "ZENDESK" -} - -// @public -export interface SpellCheck { - correctedQuery: string; - originalQuery: string; - type: SpellCheckType; -} - -// @public -export interface SpellCheckState extends Partial { - enabled: boolean; -} - -// @public -export enum SpellCheckType { - AutoCorrect = "AUTOCORRECT", - Combine = "COMBINE", - Suggest = "SUGGEST" -} - -// @public -export interface State { - directAnswer: DirectAnswerState; - filters: FiltersState; - location: LocationState; - meta: MetaState; - query: QueryState; - queryRules: QueryRulesState; - searchStatus: SearchStatusState; - sessionTracking: SessionTrackingState; - spellCheck: SpellCheckState; - universal: UniversalSearchState; - vertical: VerticalSearchState; -} - -// @public -export interface StateListener { - callback(currentValue: T): any; - valueAccessor(state: State): T; -} - -// @public -export interface StateManager { - addListener(listener: StateListener): Unsubscribe; - dispatchEvent(type: string, payload?: unknown): void; - getState(): State; -} - -// @public -export interface UniversalAutocompleteRequest extends AnswersRequest { - input: string; - sessionTrackingEnabled?: boolean; -} - -// @public -export interface UniversalLimit { - // (undocumented) - [verticalKey: string]: number; -} - -// @public -export interface UniversalSearchRequest extends AnswersRequest { - context?: Context; - limit?: UniversalLimit; - location?: LatLong; - query: string; - querySource?: QuerySource | string; - queryTrigger?: QueryTrigger; - referrerPageUrl?: string; - restrictVerticals?: string[]; - sessionId?: string; - sessionTrackingEnabled?: boolean; - skipSpellCheck?: boolean; -} - -// @public -export interface UniversalSearchResponse { - directAnswer?: FeaturedSnippetDirectAnswer | FieldValueDirectAnswer; - failedVerticals?: FailedVertical[]; - locationBias?: LocationBias; - queryId?: string; - queryRulesActionsData?: QueryRulesActionsData[]; - searchIntents?: SearchIntent[]; - spellCheck?: SpellCheck; - uuid: string; - verticalResults: VerticalResults[]; -} - -// @public -export interface UniversalSearchState { - limit?: UniversalLimit; - restrictVerticals?: string[]; - verticals?: VerticalResults[]; -} - -// @public -export interface UpperNumberRangeLimit { - matcher: Matcher.LessThan | Matcher.LessThanOrEqualTo; - value: number; -} - -// @public -export interface VerticalAutocompleteRequest extends AnswersRequest { - input: string; - sessionTrackingEnabled?: boolean; - verticalKey: string; -} - -// @public -export interface VerticalResults { - appliedQueryFilters: AppliedQueryFilter[]; - queryDurationMillis: number; - results: Result[]; - resultsCount: number; - source: Source; - verticalKey: string; -} - -// @public -export interface VerticalSearchRequest extends AnswersRequest { - context?: Context; - facets?: Facet[]; - limit?: number; - location?: LatLong; - locationRadius?: number; - offset?: number; - query: string; - queryId?: string; - querySource?: QuerySource | string; - queryTrigger?: QueryTrigger; - referrerPageUrl?: string; - retrieveFacets?: boolean; - sessionId?: string; - sessionTrackingEnabled?: boolean; - skipSpellCheck?: boolean; - sortBys?: SortBy[]; - staticFilters?: CombinedFilter | Filter; - verticalKey: string; -} - -// @public -export interface VerticalSearchResponse { - allResultsForVertical?: VerticalSearchResponse; - alternativeVerticals?: VerticalResults[]; - directAnswer?: FeaturedSnippetDirectAnswer | FieldValueDirectAnswer; - facets?: DisplayableFacet[]; - locationBias?: LocationBias; - queryId: string; - queryRulesActionsData?: QueryRulesActionsData[]; - searchIntents?: SearchIntent[]; - spellCheck?: SpellCheck; - uuid: string; - verticalResults: VerticalResults; -} - -// @public -export interface VerticalSearchState { - appliedQueryFilters?: AppliedQueryFilter[]; - displayName?: string; - limit?: number; - noResults?: { - allResultsForVertical: AllResultsForVertical; - alternativeVerticals: VerticalResults[]; - }; - offset?: number; - queryDurationMillis?: number; - results?: Result[]; - resultsCount?: number; - sortBys?: SortBy[]; - source?: Source; - verticalKey?: string; -} - -// @public -export interface Visitor { - id: string; - idMethod?: string; -} - -// (No @packageDocumentation comment for this package) - -``` diff --git a/etc/search-headless.api.md b/etc/search-headless.api.md index bcd4d120..d98690dc 100644 --- a/etc/search-headless.api.md +++ b/etc/search-headless.api.md @@ -52,17 +52,11 @@ export class AnswersError extends Error { /* Excluded from this release type: __constructor */ } -// @public @deprecated (undocumented) -export const AnswersHeadless: typeof SearchHeadless; - // @public export interface AnswersRequest { additionalHttpHeaders?: AdditionalHttpHeaders; } -// @public @deprecated (undocumented) -export const answersUtilities: typeof searchUtilities; - // @public export interface AppliedQueryFilter { details?: LocationFilterDetails; @@ -426,16 +420,13 @@ export interface ParentState { [headlessId: string]: State; } -// @public @deprecated -export const provideAnswersHeadless: typeof provideSearchHeadless; - -// Warning: (ae-internal-mixed-release-tag) Mixed release tags are not allowed for "provideSearchHeadless" because one of its declarations is marked as @internal +// Warning: (ae-internal-mixed-release-tag) Mixed release tags are not allowed for "provideHeadless" because one of its declarations is marked as @internal // // @public -export function provideSearchHeadless(config: HeadlessConfig): SearchHeadless; +export function provideHeadless(config: HeadlessConfig): SearchHeadless; // @internal -export function provideSearchHeadless(config: HeadlessConfig, additionalHttpHeaders: AdditionalHttpHeaders): SearchHeadless; +export function provideHeadless(config: HeadlessConfig, additionalHttpHeaders: AdditionalHttpHeaders): SearchHeadless; // @public export interface QueryRulesActionsData { diff --git a/src/deprecated.ts b/src/deprecated.ts new file mode 100644 index 00000000..3687a16f --- /dev/null +++ b/src/deprecated.ts @@ -0,0 +1,29 @@ +import { searchUtilities, provideHeadless } from "."; +import SearchHeadless from "./search-headless"; + +/** + * @public + * + * @deprecated answersUtilities has been deprecated and renamed to searchUtilities + */ + export const answersUtilities = searchUtilities; + + /** + * Supplies a new instance of {@link SearchHeadless}, using the provided configuration. + * + * @param config - The apiKey, experienceKey, etc. needed to set up a front-end Answers + * experience. + * @returns The newly created instance of {@link SearchHeadless} + * + * @public + * + * @deprecated provideAnswersHeadless has been deprecated and renamed to provideHeadless + */ + export const provideAnswersHeadless = provideHeadless; + + /** + * @public + * + * @deprecated AnswersHeadless has been deprecated and renamed to SearchHeadless + */ + export const AnswersHeadless = SearchHeadless; \ No newline at end of file diff --git a/src/index.ts b/src/index.ts index d9a67149..47a84db8 100644 --- a/src/index.ts +++ b/src/index.ts @@ -49,7 +49,7 @@ const headlessReducerManager = new HeadlessReducerManager(); * * @public */ -export function provideSearchHeadless(config: HeadlessConfig): SearchHeadless; +export function provideHeadless(config: HeadlessConfig): SearchHeadless; /** * Supplies a new instance of {@link SearchHeadless}, using the provided configuration, @@ -63,13 +63,13 @@ export function provideSearchHeadless(config: HeadlessConfig): SearchHeadless; * @internal */ // eslint-disable-next-line @yext/export-star/no-duplicate-exports -export function provideSearchHeadless( +export function provideHeadless( config: HeadlessConfig, additionalHttpHeaders: AdditionalHttpHeaders ): SearchHeadless; // eslint-disable-next-line @yext/export-star/no-duplicate-exports -export function provideSearchHeadless( +export function provideHeadless( config: HeadlessConfig, additionalHttpHeaders?: AdditionalHttpHeaders ): SearchHeadless { @@ -120,31 +120,4 @@ function linkSessionTracking(firstHeadless: SearchHeadless, secondHeadless: Sear }); } -export { SearchHeadless }; - -/** - * @public - * - * @deprecated answersUtilities has been deprecated and renamed to searchUtilities - */ -export const answersUtilities = searchUtilities; - -/** - * Supplies a new instance of {@link SearchHeadless}, using the provided configuration. - * - * @param config - The apiKey, experienceKey, etc. needed to set up a front-end Answers - * experience. - * @returns The newly created instance of {@link SearchHeadless} - * - * @public - * - * @deprecated provideAnswersHeadless has been deprecated and renamed to provideSearchHeadless - */ -export const provideAnswersHeadless = provideSearchHeadless; - -/** - * @public - * - * @deprecated AnswersHeadless has been deprecated and renamed to SearchHeadless - */ -export const AnswersHeadless = SearchHeadless; +export { SearchHeadless }; \ No newline at end of file From 008778017b60e75029f0dd60b49e0d79d95267eb Mon Sep 17 00:00:00 2001 From: Cindy Yang Date: Mon, 11 Jul 2022 13:00:19 -0400 Subject: [PATCH 06/22] fix provideHeadless --- test-site-node/index.js | 4 ++-- tests/acceptance/multiple-instances.ts | 10 +++++----- tests/acceptance/provideSearchHeadless.ts | 6 +++--- tests/unit/index.ts | 10 +++++----- 4 files changed, 15 insertions(+), 15 deletions(-) diff --git a/test-site-node/index.js b/test-site-node/index.js index 4760dc1c..3b36be4f 100644 --- a/test-site-node/index.js +++ b/test-site-node/index.js @@ -1,6 +1,6 @@ -const { provideSearchHeadless } = require('@yext/search-headless'); +const { provideHeadless } = require('@yext/search-headless'); -const answers = provideSearchHeadless({ +const answers = provideHeadless({ apiKey: '2d8c550071a64ea23e263118a2b0680b', experienceKey: 'slanswers', locale: 'en' diff --git a/tests/acceptance/multiple-instances.ts b/tests/acceptance/multiple-instances.ts index e6be6d83..74e9cccd 100644 --- a/tests/acceptance/multiple-instances.ts +++ b/tests/acceptance/multiple-instances.ts @@ -1,4 +1,4 @@ -import { provideSearchHeadless } from '../../src'; +import { provideHeadless } from '../../src'; import { DEFAULT_HEADLESS_ID } from '../../src/constants'; import { expectedInitialState } from '../mocks/expectedInitialState'; @@ -9,12 +9,12 @@ const config = { }; it('multiple SearchHeadless instances link SessionTrackingState together', () => { - const firstHeadless = provideSearchHeadless(config); - const secondHeadless = provideSearchHeadless({ + const firstHeadless = provideHeadless(config); + const secondHeadless = provideHeadless({ ...config, headlessId: 'second' }); - const thirdHeadless = provideSearchHeadless({ + const thirdHeadless = provideHeadless({ ...config, headlessId: 'third' }); @@ -49,7 +49,7 @@ it('multiple SearchHeadless instances link SessionTrackingState together', () => it('an error is thrown if you manually specify a headlessId equal to the default id', () => { expect(() => { - provideSearchHeadless({ + provideHeadless({ ...config, headlessId: DEFAULT_HEADLESS_ID }); diff --git a/tests/acceptance/provideSearchHeadless.ts b/tests/acceptance/provideSearchHeadless.ts index 3cc2ca18..d07fce7c 100644 --- a/tests/acceptance/provideSearchHeadless.ts +++ b/tests/acceptance/provideSearchHeadless.ts @@ -1,4 +1,4 @@ -import { provideSearchHeadless } from '../../src'; +import { provideHeadless } from '../../src'; const baseConfig = { apiKey: 'api-key', @@ -7,7 +7,7 @@ const baseConfig = { }; it('if apiKey is passed into the headless config, the searchType is set to \'vertical\'', () => { - const headless = provideSearchHeadless({ + const headless = provideHeadless({ ...baseConfig, verticalKey: 'test' }); @@ -17,7 +17,7 @@ it('if apiKey is passed into the headless config, the searchType is set to \'ver }); it('if no apiKey is passed into the headless config, the searchType is \'universal\'', () => { - const headless = provideSearchHeadless(baseConfig); + const headless = provideHeadless(baseConfig); expect(headless.state.vertical.verticalKey).toBeUndefined(); expect(headless.state.meta.searchType).toEqual('universal'); diff --git a/tests/unit/index.ts b/tests/unit/index.ts index 9943d46b..0fe7dfe4 100644 --- a/tests/unit/index.ts +++ b/tests/unit/index.ts @@ -1,4 +1,4 @@ -import { SearchHeadless, provideSearchHeadless } from '../../src'; +import { SearchHeadless, provideHeadless } from '../../src'; import { getHttpHeaders } from '../../src/utils/client-sdk-utils'; jest.mock('../../src/search-headless.ts'); @@ -11,20 +11,20 @@ const baseConfig = { const headlessVersionHeader = getHttpHeaders(); -it('provideSearchHeadless passes Headless agent to SearchHeadless', () => { - provideSearchHeadless(baseConfig); +it('provideHeadless passes Headless agent to SearchHeadless', () => { + provideHeadless(baseConfig); expect(SearchHeadless).toHaveBeenLastCalledWith( expect.anything(), expect.anything(), expect.anything(), headlessVersionHeader); }); -it('provideSearchHeadless passes additional HTTP headers to SearchHeadless', () => { +it('provideHeadless passes additional HTTP headers to SearchHeadless', () => { const additionalHttpHeaders = { 'Client-SDK': { CUSTOM_TEST_SITE: 'test' } }; - provideSearchHeadless(baseConfig, additionalHttpHeaders); + provideHeadless(baseConfig, additionalHttpHeaders); expect(SearchHeadless).toHaveBeenLastCalledWith(expect.anything(), expect.anything(), expect.anything(), { 'Client-SDK': { From 8d0e101e51e1dd9914db939304e0f85cf1ba02bd Mon Sep 17 00:00:00 2001 From: Cindy Yang Date: Mon, 11 Jul 2022 13:04:12 -0400 Subject: [PATCH 07/22] API update for SearchHeadless --- docs/search-headless.md | 2 +- ...less.searchheadless.executefiltersearch.md | 2 +- ...chheadless.executeuniversalautocomplete.md | 2 +- ...ss.searchheadless.executeuniversalquery.md | 4 ++-- ...rchheadless.executeverticalautocomplete.md | 2 +- ...ess.searchheadless.executeverticalquery.md | 4 ++-- docs/search-headless.searchheadless.md | 10 ++++----- ...-headless.searchheadless.submitquestion.md | 4 ++-- ...earch-headless.searchheadless.utilities.md | 2 +- src/search-headless.ts | 22 +++++++++---------- 10 files changed, 27 insertions(+), 27 deletions(-) diff --git a/docs/search-headless.md b/docs/search-headless.md index 9af51455..847bb686 100644 --- a/docs/search-headless.md +++ b/docs/search-headless.md @@ -10,7 +10,7 @@ | --- | --- | | [AnswersCore](./search-headless.answerscore.md) | Provides methods for executing searches, submitting questions, and performing autocompletes. | | [AnswersError](./search-headless.answerserror.md) | Represents an error | -| [SearchHeadless](./search-headless.searchheadless.md) | Provides the functionality for interacting with an Answers Search experience. | +| [SearchHeadless](./search-headless.searchheadless.md) | Provides the functionality for interacting with an Search experience. | ## Enumerations diff --git a/docs/search-headless.searchheadless.executefiltersearch.md b/docs/search-headless.searchheadless.executefiltersearch.md index b252215d..4263b7ac 100644 --- a/docs/search-headless.searchheadless.executefiltersearch.md +++ b/docs/search-headless.searchheadless.executefiltersearch.md @@ -24,5 +24,5 @@ executeFilterSearch(query: string, sectioned: boolean, fields: SearchParameterFi Promise<[FilterSearchResponse](./search-headless.filtersearchresponse.md) \| undefined> -A Promise of a [FilterSearchResponse](./search-headless.filtersearchresponse.md) from the Answers API or of undefined if there is no verticalKey defined in state +A Promise of a [FilterSearchResponse](./search-headless.filtersearchresponse.md) from the Search API or of undefined if there is no verticalKey defined in state diff --git a/docs/search-headless.searchheadless.executeuniversalautocomplete.md b/docs/search-headless.searchheadless.executeuniversalautocomplete.md index 069dbc2b..22acf8e4 100644 --- a/docs/search-headless.searchheadless.executeuniversalautocomplete.md +++ b/docs/search-headless.searchheadless.executeuniversalautocomplete.md @@ -15,5 +15,5 @@ executeUniversalAutocomplete(): Promise; Promise<[AutocompleteResponse](./search-headless.autocompleteresponse.md)> -A Promise of an [AutocompleteResponse](./search-headless.autocompleteresponse.md) from the Answers API +A Promise of an [AutocompleteResponse](./search-headless.autocompleteresponse.md) from the Search API diff --git a/docs/search-headless.searchheadless.executeuniversalquery.md b/docs/search-headless.searchheadless.executeuniversalquery.md index bee82276..71d3fef7 100644 --- a/docs/search-headless.searchheadless.executeuniversalquery.md +++ b/docs/search-headless.searchheadless.executeuniversalquery.md @@ -4,7 +4,7 @@ ## SearchHeadless.executeUniversalQuery() method -Performs an Answers search across all verticals with relevant parts of the state used as input to the search. Updates the state with the response data. +Performs a Search across all verticals with relevant parts of the state used as input to the search. Updates the state with the response data. Signature: @@ -15,5 +15,5 @@ executeUniversalQuery(): Promise; Promise<[UniversalSearchResponse](./search-headless.universalsearchresponse.md) \| undefined> -A Promise of a [UniversalSearchResponse](./search-headless.universalsearchresponse.md) from the Answers API +A Promise of a [UniversalSearchResponse](./search-headless.universalsearchresponse.md) from the Search API diff --git a/docs/search-headless.searchheadless.executeverticalautocomplete.md b/docs/search-headless.searchheadless.executeverticalautocomplete.md index 748c3cb7..d22f3d4d 100644 --- a/docs/search-headless.searchheadless.executeverticalautocomplete.md +++ b/docs/search-headless.searchheadless.executeverticalautocomplete.md @@ -15,5 +15,5 @@ executeVerticalAutocomplete(): Promise; Promise<[AutocompleteResponse](./search-headless.autocompleteresponse.md) \| undefined> -A Promise of an [AutocompleteResponse](./search-headless.autocompleteresponse.md) from the Answers API or of undefined if there is no verticalKey defined in state +A Promise of an [AutocompleteResponse](./search-headless.autocompleteresponse.md) from the Search API or of undefined if there is no verticalKey defined in state diff --git a/docs/search-headless.searchheadless.executeverticalquery.md b/docs/search-headless.searchheadless.executeverticalquery.md index bd452318..04c2a7eb 100644 --- a/docs/search-headless.searchheadless.executeverticalquery.md +++ b/docs/search-headless.searchheadless.executeverticalquery.md @@ -4,7 +4,7 @@ ## SearchHeadless.executeVerticalQuery() method -Perform an Answers search for a single vertical with relevant parts of the state used as input to the search. Updates the state with the response data. +Perform a Search for a single vertical with relevant parts of the state used as input to the search. Updates the state with the response data. Signature: @@ -15,5 +15,5 @@ executeVerticalQuery(): Promise; Promise<[VerticalSearchResponse](./search-headless.verticalsearchresponse.md) \| undefined> -A Promise of a [VerticalSearchResponse](./search-headless.verticalsearchresponse.md) from the Answers API or of undefined if there is no verticalKey defined in state +A Promise of a [VerticalSearchResponse](./search-headless.verticalsearchresponse.md) from the Search API or of undefined if there is no verticalKey defined in state diff --git a/docs/search-headless.searchheadless.md b/docs/search-headless.searchheadless.md index 0211d5d7..9c474e45 100644 --- a/docs/search-headless.searchheadless.md +++ b/docs/search-headless.searchheadless.md @@ -4,7 +4,7 @@ ## SearchHeadless class -Provides the functionality for interacting with an Answers Search experience. +Provides the functionality for interacting with an Search experience. Signature: @@ -23,7 +23,7 @@ export default class SearchHeadless | Property | Modifiers | Type | Description | | --- | --- | --- | --- | | [state](./search-headless.searchheadless.state.md) | | [State](./search-headless.state.md) | Gets the current state of the SearchHeadless instance. | -| [utilities](./search-headless.searchheadless.utilities.md) | | typeof answersUtilities | Common utility functions for manipulating Answers-related data. | +| [utilities](./search-headless.searchheadless.utilities.md) | | typeof answersUtilities | Common utility functions for manipulating Search-related data. | ## Methods @@ -32,9 +32,9 @@ export default class SearchHeadless | [addListener(listener)](./search-headless.searchheadless.addlistener.md) | | Adds a listener for a specific state value of type T. | | [executeFilterSearch(query, sectioned, fields)](./search-headless.searchheadless.executefiltersearch.md) | | Performs a filtersearch request against specified fields within a single vertical using the vertical key stored in state. | | [executeUniversalAutocomplete()](./search-headless.searchheadless.executeuniversalautocomplete.md) | | Performs an autocomplete request across all verticals using the query input stored in state. | -| [executeUniversalQuery()](./search-headless.searchheadless.executeuniversalquery.md) | | Performs an Answers search across all verticals with relevant parts of the state used as input to the search. Updates the state with the response data. | +| [executeUniversalQuery()](./search-headless.searchheadless.executeuniversalquery.md) | | Performs a Search across all verticals with relevant parts of the state used as input to the search. Updates the state with the response data. | | [executeVerticalAutocomplete()](./search-headless.searchheadless.executeverticalautocomplete.md) | | Performs an autocomplete request for a single vertical using the query input and vertical key stored in state. | -| [executeVerticalQuery()](./search-headless.searchheadless.executeverticalquery.md) | | Perform an Answers search for a single vertical with relevant parts of the state used as input to the search. Updates the state with the response data. | +| [executeVerticalQuery()](./search-headless.searchheadless.executeverticalquery.md) | | Perform a Search for a single vertical with relevant parts of the state used as input to the search. Updates the state with the response data. | | [resetFacets()](./search-headless.searchheadless.resetfacets.md) | | Unselects all [facets](./search-headless.filtersstate.facets.md). | | [setAlternativeVerticals(alternativeVerticals)](./search-headless.searchheadless.setalternativeverticals.md) | | Sets the alternativeVerticals for [VerticalSearchState.noResults](./search-headless.verticalsearchstate.noresults.md) to the specified verticals. | | [setContext(context)](./search-headless.searchheadless.setcontext.md) | | Sets [MetaState.context](./search-headless.metastate.context.md) to the specified context. | @@ -58,5 +58,5 @@ export default class SearchHeadless | [setUserLocation(latLong)](./search-headless.searchheadless.setuserlocation.md) | | Sets [LocationState.userLocation](./search-headless.locationstate.userlocation.md) to the specified latitude and longitude. | | [setVertical(verticalKey)](./search-headless.searchheadless.setvertical.md) | | Sets up Headless to manage the vertical indicated by the verticalKey. | | [setVerticalLimit(limit)](./search-headless.searchheadless.setverticallimit.md) | | Sets [VerticalSearchState.limit](./search-headless.verticalsearchstate.limit.md) to the specified limit. | -| [submitQuestion(request)](./search-headless.searchheadless.submitquestion.md) | | Submits a question to the Answers API with the specified request data. | +| [submitQuestion(request)](./search-headless.searchheadless.submitquestion.md) | | Submits a question to the Search API with the specified request data. | diff --git a/docs/search-headless.searchheadless.submitquestion.md b/docs/search-headless.searchheadless.submitquestion.md index 6474f8a3..fc83bd4e 100644 --- a/docs/search-headless.searchheadless.submitquestion.md +++ b/docs/search-headless.searchheadless.submitquestion.md @@ -4,7 +4,7 @@ ## SearchHeadless.submitQuestion() method -Submits a question to the Answers API with the specified request data. +Submits a question to the Search API with the specified request data. Signature: @@ -22,5 +22,5 @@ submitQuestion(request: Omit Promise<[QuestionSubmissionResponse](./search-headless.questionsubmissionresponse.md)> -A Promise of a [QuestionSubmissionResponse](./search-headless.questionsubmissionresponse.md) from the Answers API +A Promise of a [QuestionSubmissionResponse](./search-headless.questionsubmissionresponse.md) from the Search API diff --git a/docs/search-headless.searchheadless.utilities.md b/docs/search-headless.searchheadless.utilities.md index 95060580..02039971 100644 --- a/docs/search-headless.searchheadless.utilities.md +++ b/docs/search-headless.searchheadless.utilities.md @@ -4,7 +4,7 @@ ## SearchHeadless.utilities property -Common utility functions for manipulating Answers-related data. +Common utility functions for manipulating Search-related data. Signature: diff --git a/src/search-headless.ts b/src/search-headless.ts index d3d70f19..00317427 100644 --- a/src/search-headless.ts +++ b/src/search-headless.ts @@ -36,13 +36,13 @@ import { initialState as initialQueryRulesState } from './slices/queryrules'; import { initialState as initialSearchStatusState } from './slices/searchstatus'; /** - * Provides the functionality for interacting with an Answers Search experience. + * Provides the functionality for interacting with an Search experience. * * @public */ export default class SearchHeadless { /** - * Common utility functions for manipulating Answers-related data. + * Common utility functions for manipulating Search-related data. */ public readonly utilities = answersUtilities; @@ -279,10 +279,10 @@ export default class SearchHeadless { } /** - * Submits a question to the Answers API with the specified request data. + * Submits a question to the Search API with the specified request data. * * @param request - The data for the network request - * @returns A Promise of a {@link QuestionSubmissionResponse} from the Answers API + * @returns A Promise of a {@link QuestionSubmissionResponse} from the Search API */ async submitQuestion( request: Omit @@ -294,10 +294,10 @@ export default class SearchHeadless { } /** - * Performs an Answers search across all verticals with relevant parts of the + * Performs a Search across all verticals with relevant parts of the * state used as input to the search. Updates the state with the response data. * - * @returns A Promise of a {@link UniversalSearchResponse} from the Answers API + * @returns A Promise of a {@link UniversalSearchResponse} from the Search API */ async executeUniversalQuery(): Promise { if (this.state.meta.searchType !== SearchTypeEnum.Universal) { @@ -361,7 +361,7 @@ export default class SearchHeadless { * Performs an autocomplete request across all verticals using the query input * stored in state. * - * @returns A Promise of an {@link AutocompleteResponse} from the Answers API + * @returns A Promise of an {@link AutocompleteResponse} from the Search API */ async executeUniversalAutocomplete(): Promise { const query = this.state.query.input || ''; @@ -372,10 +372,10 @@ export default class SearchHeadless { } /** - * Perform an Answers search for a single vertical with relevant parts of the + * Perform a Search for a single vertical with relevant parts of the * state used as input to the search. Updates the state with the response data. * - * @returns A Promise of a {@link VerticalSearchResponse} from the Answers API or + * @returns A Promise of a {@link VerticalSearchResponse} from the Search API or * of undefined if there is no verticalKey defined in state */ async executeVerticalQuery(): Promise { @@ -463,7 +463,7 @@ export default class SearchHeadless { * Performs an autocomplete request for a single vertical using the query input * and vertical key stored in state. * - * @returns A Promise of an {@link AutocompleteResponse} from the Answers API or + * @returns A Promise of an {@link AutocompleteResponse} from the Search API or * of undefined if there is no verticalKey defined in state */ async executeVerticalAutocomplete(): Promise { @@ -493,7 +493,7 @@ export default class SearchHeadless { * @param query - The query for which to search * @param sectioned - Whether or not the results should be sectioned by field * @param fields - The entity fields to search - * @returns A Promise of a {@link FilterSearchResponse} from the Answers API or + * @returns A Promise of a {@link FilterSearchResponse} from the Search API or * of undefined if there is no verticalKey defined in state */ async executeFilterSearch( From 50064d42a67006c3920f2d381e08a43c541db46a Mon Sep 17 00:00:00 2001 From: github-actions <41898282+github-actions[bot]@users.noreply.github.com> Date: Mon, 11 Jul 2022 18:46:43 +0000 Subject: [PATCH 08/22] Automated update to repo's documentation from github action --- ...-headless.answersheadless._constructor_.md | 23 ------- ...ch-headless.answersheadless.addlistener.md | 26 -------- ...ess.answersheadless.executefiltersearch.md | 28 --------- ...rsheadless.executeuniversalautocomplete.md | 19 ------ ...s.answersheadless.executeuniversalquery.md | 19 ------ ...ersheadless.executeverticalautocomplete.md | 19 ------ ...ss.answersheadless.executeverticalquery.md | 19 ------ docs/search-headless.answersheadless.md | 62 ------------------- ...ch-headless.answersheadless.resetfacets.md | 17 ----- ...answersheadless.setalternativeverticals.md | 24 ------- ...rch-headless.answersheadless.setcontext.md | 24 ------- ...headless.answersheadless.setfacetoption.md | 26 -------- ...arch-headless.answersheadless.setfacets.md | 24 ------- ...eadless.answersheadless.setfilteroption.md | 24 ------- ...arch-headless.answersheadless.setoffset.md | 24 ------- ...earch-headless.answersheadless.setquery.md | 24 ------- ...headless.answersheadless.setquerysource.md | 24 ------- ...eadless.answersheadless.setquerytrigger.md | 24 ------- ...less.answersheadless.setreferrerpageurl.md | 24 ------- ...ss.answersheadless.setrestrictverticals.md | 24 ------- ...h-headless.answersheadless.setsessionid.md | 24 ------- ...swersheadless.setsessiontrackingenabled.md | 24 ------- ...rch-headless.answersheadless.setsortbys.md | 24 ------- ...ss.answersheadless.setspellcheckenabled.md | 24 ------- ...earch-headless.answersheadless.setstate.md | 24 ------- ...adless.answersheadless.setstaticfilters.md | 24 ------- ...h-headless.answersheadless.setuniversal.md | 17 ----- ...dless.answersheadless.setuniversallimit.md | 24 ------- ...eadless.answersheadless.setuserlocation.md | 24 ------- ...ch-headless.answersheadless.setvertical.md | 24 ------- ...adless.answersheadless.setverticallimit.md | 24 ------- docs/search-headless.answersheadless.state.md | 13 ---- ...headless.answersheadless.submitquestion.md | 26 -------- ...arch-headless.answersheadless.utilities.md | 13 ---- ...-headless.answersutilities.isclosematch.md | 27 -------- docs/search-headless.answersutilities.md | 13 ---- ...ess.answersutilities.searchthroughfacet.md | 27 -------- .../search-headless.provideanswersheadless.md | 26 -------- 38 files changed, 900 deletions(-) delete mode 100644 docs/search-headless.answersheadless._constructor_.md delete mode 100644 docs/search-headless.answersheadless.addlistener.md delete mode 100644 docs/search-headless.answersheadless.executefiltersearch.md delete mode 100644 docs/search-headless.answersheadless.executeuniversalautocomplete.md delete mode 100644 docs/search-headless.answersheadless.executeuniversalquery.md delete mode 100644 docs/search-headless.answersheadless.executeverticalautocomplete.md delete mode 100644 docs/search-headless.answersheadless.executeverticalquery.md delete mode 100644 docs/search-headless.answersheadless.md delete mode 100644 docs/search-headless.answersheadless.resetfacets.md delete mode 100644 docs/search-headless.answersheadless.setalternativeverticals.md delete mode 100644 docs/search-headless.answersheadless.setcontext.md delete mode 100644 docs/search-headless.answersheadless.setfacetoption.md delete mode 100644 docs/search-headless.answersheadless.setfacets.md delete mode 100644 docs/search-headless.answersheadless.setfilteroption.md delete mode 100644 docs/search-headless.answersheadless.setoffset.md delete mode 100644 docs/search-headless.answersheadless.setquery.md delete mode 100644 docs/search-headless.answersheadless.setquerysource.md delete mode 100644 docs/search-headless.answersheadless.setquerytrigger.md delete mode 100644 docs/search-headless.answersheadless.setreferrerpageurl.md delete mode 100644 docs/search-headless.answersheadless.setrestrictverticals.md delete mode 100644 docs/search-headless.answersheadless.setsessionid.md delete mode 100644 docs/search-headless.answersheadless.setsessiontrackingenabled.md delete mode 100644 docs/search-headless.answersheadless.setsortbys.md delete mode 100644 docs/search-headless.answersheadless.setspellcheckenabled.md delete mode 100644 docs/search-headless.answersheadless.setstate.md delete mode 100644 docs/search-headless.answersheadless.setstaticfilters.md delete mode 100644 docs/search-headless.answersheadless.setuniversal.md delete mode 100644 docs/search-headless.answersheadless.setuniversallimit.md delete mode 100644 docs/search-headless.answersheadless.setuserlocation.md delete mode 100644 docs/search-headless.answersheadless.setvertical.md delete mode 100644 docs/search-headless.answersheadless.setverticallimit.md delete mode 100644 docs/search-headless.answersheadless.state.md delete mode 100644 docs/search-headless.answersheadless.submitquestion.md delete mode 100644 docs/search-headless.answersheadless.utilities.md delete mode 100644 docs/search-headless.answersutilities.isclosematch.md delete mode 100644 docs/search-headless.answersutilities.md delete mode 100644 docs/search-headless.answersutilities.searchthroughfacet.md delete mode 100644 docs/search-headless.provideanswersheadless.md diff --git a/docs/search-headless.answersheadless._constructor_.md b/docs/search-headless.answersheadless._constructor_.md deleted file mode 100644 index e6c81dc7..00000000 --- a/docs/search-headless.answersheadless._constructor_.md +++ /dev/null @@ -1,23 +0,0 @@ - - -[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [AnswersHeadless](./search-headless.answersheadless.md) > [(constructor)](./search-headless.answersheadless._constructor_.md) - -## AnswersHeadless.(constructor) - -Constructs a new instance of the `AnswersHeadless` class - -Signature: - -```typescript -constructor(core: AnswersCore, stateManager: StateManager, httpManager: HttpManager, additionalHttpHeaders?: AdditionalHttpHeaders | undefined); -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| core | [AnswersCore](./search-headless.answerscore.md) | | -| stateManager | StateManager | | -| httpManager | HttpManager | | -| additionalHttpHeaders | [AdditionalHttpHeaders](./search-headless.additionalhttpheaders.md) \| undefined | | - diff --git a/docs/search-headless.answersheadless.addlistener.md b/docs/search-headless.answersheadless.addlistener.md deleted file mode 100644 index d78fbd6e..00000000 --- a/docs/search-headless.answersheadless.addlistener.md +++ /dev/null @@ -1,26 +0,0 @@ - - -[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [AnswersHeadless](./search-headless.answersheadless.md) > [addListener](./search-headless.answersheadless.addlistener.md) - -## AnswersHeadless.addListener() method - -Adds a listener for a specific state value of type T. - -Signature: - -```typescript -addListener(listener: StateListener): Unsubscribe; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| listener | StateListener<T> | The listener to add | - -Returns: - -Unsubscribe - -The function for removing the added listener - diff --git a/docs/search-headless.answersheadless.executefiltersearch.md b/docs/search-headless.answersheadless.executefiltersearch.md deleted file mode 100644 index 81414056..00000000 --- a/docs/search-headless.answersheadless.executefiltersearch.md +++ /dev/null @@ -1,28 +0,0 @@ - - -[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [AnswersHeadless](./search-headless.answersheadless.md) > [executeFilterSearch](./search-headless.answersheadless.executefiltersearch.md) - -## AnswersHeadless.executeFilterSearch() method - -Performs a filtersearch request against specified fields within a single vertical using the vertical key stored in state. - -Signature: - -```typescript -executeFilterSearch(query: string, sectioned: boolean, fields: SearchParameterField[]): Promise; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| query | string | The query for which to search | -| sectioned | boolean | Whether or not the results should be sectioned by field | -| fields | [SearchParameterField](./search-headless.searchparameterfield.md)\[\] | The entity fields to search | - -Returns: - -Promise<[FilterSearchResponse](./search-headless.filtersearchresponse.md) \| undefined> - -A Promise of a [FilterSearchResponse](./search-headless.filtersearchresponse.md) from the Answers API or of undefined if there is no verticalKey defined in state - diff --git a/docs/search-headless.answersheadless.executeuniversalautocomplete.md b/docs/search-headless.answersheadless.executeuniversalautocomplete.md deleted file mode 100644 index 53d942e5..00000000 --- a/docs/search-headless.answersheadless.executeuniversalautocomplete.md +++ /dev/null @@ -1,19 +0,0 @@ - - -[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [AnswersHeadless](./search-headless.answersheadless.md) > [executeUniversalAutocomplete](./search-headless.answersheadless.executeuniversalautocomplete.md) - -## AnswersHeadless.executeUniversalAutocomplete() method - -Performs an autocomplete request across all verticals using the query input stored in state. - -Signature: - -```typescript -executeUniversalAutocomplete(): Promise; -``` -Returns: - -Promise<[AutocompleteResponse](./search-headless.autocompleteresponse.md)> - -A Promise of an [AutocompleteResponse](./search-headless.autocompleteresponse.md) from the Answers API - diff --git a/docs/search-headless.answersheadless.executeuniversalquery.md b/docs/search-headless.answersheadless.executeuniversalquery.md deleted file mode 100644 index c701a72b..00000000 --- a/docs/search-headless.answersheadless.executeuniversalquery.md +++ /dev/null @@ -1,19 +0,0 @@ - - -[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [AnswersHeadless](./search-headless.answersheadless.md) > [executeUniversalQuery](./search-headless.answersheadless.executeuniversalquery.md) - -## AnswersHeadless.executeUniversalQuery() method - -Performs an Answers search across all verticals with relevant parts of the state used as input to the search. Updates the state with the response data. - -Signature: - -```typescript -executeUniversalQuery(): Promise; -``` -Returns: - -Promise<[UniversalSearchResponse](./search-headless.universalsearchresponse.md) \| undefined> - -A Promise of a [UniversalSearchResponse](./search-headless.universalsearchresponse.md) from the Answers API - diff --git a/docs/search-headless.answersheadless.executeverticalautocomplete.md b/docs/search-headless.answersheadless.executeverticalautocomplete.md deleted file mode 100644 index f5489b83..00000000 --- a/docs/search-headless.answersheadless.executeverticalautocomplete.md +++ /dev/null @@ -1,19 +0,0 @@ - - -[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [AnswersHeadless](./search-headless.answersheadless.md) > [executeVerticalAutocomplete](./search-headless.answersheadless.executeverticalautocomplete.md) - -## AnswersHeadless.executeVerticalAutocomplete() method - -Performs an autocomplete request for a single vertical using the query input and vertical key stored in state. - -Signature: - -```typescript -executeVerticalAutocomplete(): Promise; -``` -Returns: - -Promise<[AutocompleteResponse](./search-headless.autocompleteresponse.md) \| undefined> - -A Promise of an [AutocompleteResponse](./search-headless.autocompleteresponse.md) from the Answers API or of undefined if there is no verticalKey defined in state - diff --git a/docs/search-headless.answersheadless.executeverticalquery.md b/docs/search-headless.answersheadless.executeverticalquery.md deleted file mode 100644 index cab0de24..00000000 --- a/docs/search-headless.answersheadless.executeverticalquery.md +++ /dev/null @@ -1,19 +0,0 @@ - - -[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [AnswersHeadless](./search-headless.answersheadless.md) > [executeVerticalQuery](./search-headless.answersheadless.executeverticalquery.md) - -## AnswersHeadless.executeVerticalQuery() method - -Perform an Answers search for a single vertical with relevant parts of the state used as input to the search. Updates the state with the response data. - -Signature: - -```typescript -executeVerticalQuery(): Promise; -``` -Returns: - -Promise<[VerticalSearchResponse](./search-headless.verticalsearchresponse.md) \| undefined> - -A Promise of a [VerticalSearchResponse](./search-headless.verticalsearchresponse.md) from the Answers API or of undefined if there is no verticalKey defined in state - diff --git a/docs/search-headless.answersheadless.md b/docs/search-headless.answersheadless.md deleted file mode 100644 index 3717ef62..00000000 --- a/docs/search-headless.answersheadless.md +++ /dev/null @@ -1,62 +0,0 @@ - - -[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [AnswersHeadless](./search-headless.answersheadless.md) - -## AnswersHeadless class - -Provides the functionality for interacting with an Answers Search experience. - -Signature: - -```typescript -export default class AnswersHeadless -``` - -## Constructors - -| Constructor | Modifiers | Description | -| --- | --- | --- | -| [(constructor)(core, stateManager, httpManager, additionalHttpHeaders)](./search-headless.answersheadless._constructor_.md) | | Constructs a new instance of the AnswersHeadless class | - -## Properties - -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [state](./search-headless.answersheadless.state.md) | | [State](./search-headless.state.md) | Gets the current state of the AnswersHeadless instance. | -| [utilities](./search-headless.answersheadless.utilities.md) | | typeof answersUtilities | Common utility functions for manipulating Answers-related data. | - -## Methods - -| Method | Modifiers | Description | -| --- | --- | --- | -| [addListener(listener)](./search-headless.answersheadless.addlistener.md) | | Adds a listener for a specific state value of type T. | -| [executeFilterSearch(query, sectioned, fields)](./search-headless.answersheadless.executefiltersearch.md) | | Performs a filtersearch request against specified fields within a single vertical using the vertical key stored in state. | -| [executeUniversalAutocomplete()](./search-headless.answersheadless.executeuniversalautocomplete.md) | | Performs an autocomplete request across all verticals using the query input stored in state. | -| [executeUniversalQuery()](./search-headless.answersheadless.executeuniversalquery.md) | | Performs an Answers search across all verticals with relevant parts of the state used as input to the search. Updates the state with the response data. | -| [executeVerticalAutocomplete()](./search-headless.answersheadless.executeverticalautocomplete.md) | | Performs an autocomplete request for a single vertical using the query input and vertical key stored in state. | -| [executeVerticalQuery()](./search-headless.answersheadless.executeverticalquery.md) | | Perform an Answers search for a single vertical with relevant parts of the state used as input to the search. Updates the state with the response data. | -| [resetFacets()](./search-headless.answersheadless.resetfacets.md) | | Unselects all [facets](./search-headless.filtersstate.facets.md). | -| [setAlternativeVerticals(alternativeVerticals)](./search-headless.answersheadless.setalternativeverticals.md) | | Sets the alternativeVerticals for [VerticalSearchState.noResults](./search-headless.verticalsearchstate.noresults.md) to the specified verticals. | -| [setContext(context)](./search-headless.answersheadless.setcontext.md) | | Sets [MetaState.context](./search-headless.metastate.context.md) to the specified context. | -| [setFacetOption(fieldId, facetOption, selected)](./search-headless.answersheadless.setfacetoption.md) | | Sets a specified facet option to be selected or unselected. | -| [setFacets(facets)](./search-headless.answersheadless.setfacets.md) | | Sets [FiltersState.facets](./search-headless.filtersstate.facets.md) to the specified facets. | -| [setFilterOption(filter)](./search-headless.answersheadless.setfilteroption.md) | | Sets a static filter option and whether or not it is selected in state. | -| [setOffset(offset)](./search-headless.answersheadless.setoffset.md) | | Sets [VerticalSearchState.offset](./search-headless.verticalsearchstate.offset.md) to the specified offset. | -| [setQuery(input)](./search-headless.answersheadless.setquery.md) | | Sets [QueryState.input](./search-headless.querystate.input.md) to the specified input. | -| [setQuerySource(source)](./search-headless.answersheadless.setquerysource.md) | | Sets [QueryState.querySource](./search-headless.querystate.querysource.md) to the specified source. | -| [setQueryTrigger(trigger)](./search-headless.answersheadless.setquerytrigger.md) | | Sets [QueryState.queryTrigger](./search-headless.querystate.querytrigger.md) to the specified trigger. | -| [setReferrerPageUrl(referrerPageUrl)](./search-headless.answersheadless.setreferrerpageurl.md) | | Sets [MetaState.referrerPageUrl](./search-headless.metastate.referrerpageurl.md) to the specified URL. | -| [setRestrictVerticals(restrictVerticals)](./search-headless.answersheadless.setrestrictverticals.md) | | Sets [UniversalSearchState.restrictVerticals](./search-headless.universalsearchstate.restrictverticals.md) to the specified vertical keys. | -| [setSessionId(sessionId)](./search-headless.answersheadless.setsessionid.md) | | Sets [SessionTrackingState.sessionId](./search-headless.sessiontrackingstate.sessionid.md) to the specified ID. | -| [setSessionTrackingEnabled(enabled)](./search-headless.answersheadless.setsessiontrackingenabled.md) | | Sets [SessionTrackingState.enabled](./search-headless.sessiontrackingstate.enabled.md) to the specified boolean value. | -| [setSortBys(sortBys)](./search-headless.answersheadless.setsortbys.md) | | Sets [VerticalSearchState.sortBys](./search-headless.verticalsearchstate.sortbys.md) to the specified sortBys. | -| [setSpellCheckEnabled(enabled)](./search-headless.answersheadless.setspellcheckenabled.md) | | Sets [SpellCheckState.enabled](./search-headless.spellcheckstate.enabled.md) to the specified boolean value. | -| [setState(state)](./search-headless.answersheadless.setstate.md) | | Sets the [State](./search-headless.state.md) to the specified state. | -| [setStaticFilters(filters)](./search-headless.answersheadless.setstaticfilters.md) | | Sets [FiltersState.static](./search-headless.filtersstate.static.md) to the specified filters. | -| [setUniversal()](./search-headless.answersheadless.setuniversal.md) | | Sets up Headless to manage universal searches. | -| [setUniversalLimit(limit)](./search-headless.answersheadless.setuniversallimit.md) | | Sets [UniversalSearchState.limit](./search-headless.universalsearchstate.limit.md) to the specified limit. | -| [setUserLocation(latLong)](./search-headless.answersheadless.setuserlocation.md) | | Sets [LocationState.userLocation](./search-headless.locationstate.userlocation.md) to the specified latitude and longitude. | -| [setVertical(verticalKey)](./search-headless.answersheadless.setvertical.md) | | Sets up Headless to manage the vertical indicated by the verticalKey. | -| [setVerticalLimit(limit)](./search-headless.answersheadless.setverticallimit.md) | | Sets [VerticalSearchState.limit](./search-headless.verticalsearchstate.limit.md) to the specified limit. | -| [submitQuestion(request)](./search-headless.answersheadless.submitquestion.md) | | Submits a question to the Answers API with the specified request data. | - diff --git a/docs/search-headless.answersheadless.resetfacets.md b/docs/search-headless.answersheadless.resetfacets.md deleted file mode 100644 index e9d3bca0..00000000 --- a/docs/search-headless.answersheadless.resetfacets.md +++ /dev/null @@ -1,17 +0,0 @@ - - -[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [AnswersHeadless](./search-headless.answersheadless.md) > [resetFacets](./search-headless.answersheadless.resetfacets.md) - -## AnswersHeadless.resetFacets() method - -Unselects all [facets](./search-headless.filtersstate.facets.md). - -Signature: - -```typescript -resetFacets(): void; -``` -Returns: - -void - diff --git a/docs/search-headless.answersheadless.setalternativeverticals.md b/docs/search-headless.answersheadless.setalternativeverticals.md deleted file mode 100644 index f368edec..00000000 --- a/docs/search-headless.answersheadless.setalternativeverticals.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [AnswersHeadless](./search-headless.answersheadless.md) > [setAlternativeVerticals](./search-headless.answersheadless.setalternativeverticals.md) - -## AnswersHeadless.setAlternativeVerticals() method - -Sets the alternativeVerticals for [VerticalSearchState.noResults](./search-headless.verticalsearchstate.noresults.md) to the specified verticals. - -Signature: - -```typescript -setAlternativeVerticals(alternativeVerticals: VerticalResults[]): void; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| alternativeVerticals | [VerticalResults](./search-headless.verticalresults.md)\[\] | The alternative verticals to set | - -Returns: - -void - diff --git a/docs/search-headless.answersheadless.setcontext.md b/docs/search-headless.answersheadless.setcontext.md deleted file mode 100644 index 944b2745..00000000 --- a/docs/search-headless.answersheadless.setcontext.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [AnswersHeadless](./search-headless.answersheadless.md) > [setContext](./search-headless.answersheadless.setcontext.md) - -## AnswersHeadless.setContext() method - -Sets [MetaState.context](./search-headless.metastate.context.md) to the specified context. - -Signature: - -```typescript -setContext(context: Context): void; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| context | [Context](./search-headless.context.md) | The context to set | - -Returns: - -void - diff --git a/docs/search-headless.answersheadless.setfacetoption.md b/docs/search-headless.answersheadless.setfacetoption.md deleted file mode 100644 index c5da7866..00000000 --- a/docs/search-headless.answersheadless.setfacetoption.md +++ /dev/null @@ -1,26 +0,0 @@ - - -[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [AnswersHeadless](./search-headless.answersheadless.md) > [setFacetOption](./search-headless.answersheadless.setfacetoption.md) - -## AnswersHeadless.setFacetOption() method - -Sets a specified facet option to be selected or unselected. - -Signature: - -```typescript -setFacetOption(fieldId: string, facetOption: FacetOption, selected: boolean): void; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| fieldId | string | The fieldId for the facet | -| facetOption | [FacetOption](./search-headless.facetoption.md) | The option of the facet to select | -| selected | boolean | Whether or not the facet option should be selected | - -Returns: - -void - diff --git a/docs/search-headless.answersheadless.setfacets.md b/docs/search-headless.answersheadless.setfacets.md deleted file mode 100644 index ccd35561..00000000 --- a/docs/search-headless.answersheadless.setfacets.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [AnswersHeadless](./search-headless.answersheadless.md) > [setFacets](./search-headless.answersheadless.setfacets.md) - -## AnswersHeadless.setFacets() method - -Sets [FiltersState.facets](./search-headless.filtersstate.facets.md) to the specified facets. - -Signature: - -```typescript -setFacets(facets: DisplayableFacet[]): void; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| facets | [DisplayableFacet](./search-headless.displayablefacet.md)\[\] | The facets to set | - -Returns: - -void - diff --git a/docs/search-headless.answersheadless.setfilteroption.md b/docs/search-headless.answersheadless.setfilteroption.md deleted file mode 100644 index e49f78e4..00000000 --- a/docs/search-headless.answersheadless.setfilteroption.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [AnswersHeadless](./search-headless.answersheadless.md) > [setFilterOption](./search-headless.answersheadless.setfilteroption.md) - -## AnswersHeadless.setFilterOption() method - -Sets a static filter option and whether or not it is selected in state. - -Signature: - -```typescript -setFilterOption(filter: SelectableFilter): void; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| filter | [SelectableFilter](./search-headless.selectablefilter.md) | The static filter and whether it is selected | - -Returns: - -void - diff --git a/docs/search-headless.answersheadless.setoffset.md b/docs/search-headless.answersheadless.setoffset.md deleted file mode 100644 index 7c2f868e..00000000 --- a/docs/search-headless.answersheadless.setoffset.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [AnswersHeadless](./search-headless.answersheadless.md) > [setOffset](./search-headless.answersheadless.setoffset.md) - -## AnswersHeadless.setOffset() method - -Sets [VerticalSearchState.offset](./search-headless.verticalsearchstate.offset.md) to the specified offset. - -Signature: - -```typescript -setOffset(offset: number): void; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| offset | number | The vertical offset to set | - -Returns: - -void - diff --git a/docs/search-headless.answersheadless.setquery.md b/docs/search-headless.answersheadless.setquery.md deleted file mode 100644 index 9fe84359..00000000 --- a/docs/search-headless.answersheadless.setquery.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [AnswersHeadless](./search-headless.answersheadless.md) > [setQuery](./search-headless.answersheadless.setquery.md) - -## AnswersHeadless.setQuery() method - -Sets [QueryState.input](./search-headless.querystate.input.md) to the specified input. - -Signature: - -```typescript -setQuery(input: string): void; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| input | string | The input to set | - -Returns: - -void - diff --git a/docs/search-headless.answersheadless.setquerysource.md b/docs/search-headless.answersheadless.setquerysource.md deleted file mode 100644 index c36bad92..00000000 --- a/docs/search-headless.answersheadless.setquerysource.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [AnswersHeadless](./search-headless.answersheadless.md) > [setQuerySource](./search-headless.answersheadless.setquerysource.md) - -## AnswersHeadless.setQuerySource() method - -Sets [QueryState.querySource](./search-headless.querystate.querysource.md) to the specified source. - -Signature: - -```typescript -setQuerySource(source: QuerySource): void; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| source | [QuerySource](./search-headless.querysource.md) | The query source to set | - -Returns: - -void - diff --git a/docs/search-headless.answersheadless.setquerytrigger.md b/docs/search-headless.answersheadless.setquerytrigger.md deleted file mode 100644 index 02a71b00..00000000 --- a/docs/search-headless.answersheadless.setquerytrigger.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [AnswersHeadless](./search-headless.answersheadless.md) > [setQueryTrigger](./search-headless.answersheadless.setquerytrigger.md) - -## AnswersHeadless.setQueryTrigger() method - -Sets [QueryState.queryTrigger](./search-headless.querystate.querytrigger.md) to the specified trigger. - -Signature: - -```typescript -setQueryTrigger(trigger: QueryTrigger): void; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| trigger | [QueryTrigger](./search-headless.querytrigger.md) | The query trigger to set | - -Returns: - -void - diff --git a/docs/search-headless.answersheadless.setreferrerpageurl.md b/docs/search-headless.answersheadless.setreferrerpageurl.md deleted file mode 100644 index 6050db35..00000000 --- a/docs/search-headless.answersheadless.setreferrerpageurl.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [AnswersHeadless](./search-headless.answersheadless.md) > [setReferrerPageUrl](./search-headless.answersheadless.setreferrerpageurl.md) - -## AnswersHeadless.setReferrerPageUrl() method - -Sets [MetaState.referrerPageUrl](./search-headless.metastate.referrerpageurl.md) to the specified URL. - -Signature: - -```typescript -setReferrerPageUrl(referrerPageUrl: string): void; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| referrerPageUrl | string | The referring page URL to set | - -Returns: - -void - diff --git a/docs/search-headless.answersheadless.setrestrictverticals.md b/docs/search-headless.answersheadless.setrestrictverticals.md deleted file mode 100644 index 72093146..00000000 --- a/docs/search-headless.answersheadless.setrestrictverticals.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [AnswersHeadless](./search-headless.answersheadless.md) > [setRestrictVerticals](./search-headless.answersheadless.setrestrictverticals.md) - -## AnswersHeadless.setRestrictVerticals() method - -Sets [UniversalSearchState.restrictVerticals](./search-headless.universalsearchstate.restrictverticals.md) to the specified vertical keys. - -Signature: - -```typescript -setRestrictVerticals(restrictVerticals: string[]): void; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| restrictVerticals | string\[\] | The new verticals to restrict a universal search | - -Returns: - -void - diff --git a/docs/search-headless.answersheadless.setsessionid.md b/docs/search-headless.answersheadless.setsessionid.md deleted file mode 100644 index 1b875f3e..00000000 --- a/docs/search-headless.answersheadless.setsessionid.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [AnswersHeadless](./search-headless.answersheadless.md) > [setSessionId](./search-headless.answersheadless.setsessionid.md) - -## AnswersHeadless.setSessionId() method - -Sets [SessionTrackingState.sessionId](./search-headless.sessiontrackingstate.sessionid.md) to the specified ID. - -Signature: - -```typescript -setSessionId(sessionId: string): void; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| sessionId | string | The session ID to set | - -Returns: - -void - diff --git a/docs/search-headless.answersheadless.setsessiontrackingenabled.md b/docs/search-headless.answersheadless.setsessiontrackingenabled.md deleted file mode 100644 index deb3852f..00000000 --- a/docs/search-headless.answersheadless.setsessiontrackingenabled.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [AnswersHeadless](./search-headless.answersheadless.md) > [setSessionTrackingEnabled](./search-headless.answersheadless.setsessiontrackingenabled.md) - -## AnswersHeadless.setSessionTrackingEnabled() method - -Sets [SessionTrackingState.enabled](./search-headless.sessiontrackingstate.enabled.md) to the specified boolean value. - -Signature: - -```typescript -setSessionTrackingEnabled(enabled: boolean): void; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| enabled | boolean | Whether or not session tracking should be set to enabled | - -Returns: - -void - diff --git a/docs/search-headless.answersheadless.setsortbys.md b/docs/search-headless.answersheadless.setsortbys.md deleted file mode 100644 index 1d80d18b..00000000 --- a/docs/search-headless.answersheadless.setsortbys.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [AnswersHeadless](./search-headless.answersheadless.md) > [setSortBys](./search-headless.answersheadless.setsortbys.md) - -## AnswersHeadless.setSortBys() method - -Sets [VerticalSearchState.sortBys](./search-headless.verticalsearchstate.sortbys.md) to the specified sortBys. - -Signature: - -```typescript -setSortBys(sortBys: SortBy[]): void; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| sortBys | [SortBy](./search-headless.sortby.md)\[\] | The sortBys to set | - -Returns: - -void - diff --git a/docs/search-headless.answersheadless.setspellcheckenabled.md b/docs/search-headless.answersheadless.setspellcheckenabled.md deleted file mode 100644 index 64051736..00000000 --- a/docs/search-headless.answersheadless.setspellcheckenabled.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [AnswersHeadless](./search-headless.answersheadless.md) > [setSpellCheckEnabled](./search-headless.answersheadless.setspellcheckenabled.md) - -## AnswersHeadless.setSpellCheckEnabled() method - -Sets [SpellCheckState.enabled](./search-headless.spellcheckstate.enabled.md) to the specified boolean value. - -Signature: - -```typescript -setSpellCheckEnabled(enabled: boolean): void; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| enabled | boolean | Whether or not spellcheck should be set to enabled | - -Returns: - -void - diff --git a/docs/search-headless.answersheadless.setstate.md b/docs/search-headless.answersheadless.setstate.md deleted file mode 100644 index ccdd1dee..00000000 --- a/docs/search-headless.answersheadless.setstate.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [AnswersHeadless](./search-headless.answersheadless.md) > [setState](./search-headless.answersheadless.setstate.md) - -## AnswersHeadless.setState() method - -Sets the [State](./search-headless.state.md) to the specified state. - -Signature: - -```typescript -setState(state: State): void; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| state | [State](./search-headless.state.md) | The state to set | - -Returns: - -void - diff --git a/docs/search-headless.answersheadless.setstaticfilters.md b/docs/search-headless.answersheadless.setstaticfilters.md deleted file mode 100644 index 07589577..00000000 --- a/docs/search-headless.answersheadless.setstaticfilters.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [AnswersHeadless](./search-headless.answersheadless.md) > [setStaticFilters](./search-headless.answersheadless.setstaticfilters.md) - -## AnswersHeadless.setStaticFilters() method - -Sets [FiltersState.static](./search-headless.filtersstate.static.md) to the specified filters. - -Signature: - -```typescript -setStaticFilters(filters: SelectableFilter[]): void; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| filters | [SelectableFilter](./search-headless.selectablefilter.md)\[\] | The static filters to set | - -Returns: - -void - diff --git a/docs/search-headless.answersheadless.setuniversal.md b/docs/search-headless.answersheadless.setuniversal.md deleted file mode 100644 index 278891c5..00000000 --- a/docs/search-headless.answersheadless.setuniversal.md +++ /dev/null @@ -1,17 +0,0 @@ - - -[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [AnswersHeadless](./search-headless.answersheadless.md) > [setUniversal](./search-headless.answersheadless.setuniversal.md) - -## AnswersHeadless.setUniversal() method - -Sets up Headless to manage universal searches. - -Signature: - -```typescript -setUniversal(): void; -``` -Returns: - -void - diff --git a/docs/search-headless.answersheadless.setuniversallimit.md b/docs/search-headless.answersheadless.setuniversallimit.md deleted file mode 100644 index 98c194c4..00000000 --- a/docs/search-headless.answersheadless.setuniversallimit.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [AnswersHeadless](./search-headless.answersheadless.md) > [setUniversalLimit](./search-headless.answersheadless.setuniversallimit.md) - -## AnswersHeadless.setUniversalLimit() method - -Sets [UniversalSearchState.limit](./search-headless.universalsearchstate.limit.md) to the specified limit. - -Signature: - -```typescript -setUniversalLimit(limit: UniversalLimit): void; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| limit | [UniversalLimit](./search-headless.universallimit.md) | The universal limit to set | - -Returns: - -void - diff --git a/docs/search-headless.answersheadless.setuserlocation.md b/docs/search-headless.answersheadless.setuserlocation.md deleted file mode 100644 index 68a8b33b..00000000 --- a/docs/search-headless.answersheadless.setuserlocation.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [AnswersHeadless](./search-headless.answersheadless.md) > [setUserLocation](./search-headless.answersheadless.setuserlocation.md) - -## AnswersHeadless.setUserLocation() method - -Sets [LocationState.userLocation](./search-headless.locationstate.userlocation.md) to the specified latitude and longitude. - -Signature: - -```typescript -setUserLocation(latLong: LatLong): void; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| latLong | [LatLong](./search-headless.latlong.md) | The user location to set | - -Returns: - -void - diff --git a/docs/search-headless.answersheadless.setvertical.md b/docs/search-headless.answersheadless.setvertical.md deleted file mode 100644 index b07ec112..00000000 --- a/docs/search-headless.answersheadless.setvertical.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [AnswersHeadless](./search-headless.answersheadless.md) > [setVertical](./search-headless.answersheadless.setvertical.md) - -## AnswersHeadless.setVertical() method - -Sets up Headless to manage the vertical indicated by the verticalKey. - -Signature: - -```typescript -setVertical(verticalKey: string): void; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| verticalKey | string | The vertical key to set | - -Returns: - -void - diff --git a/docs/search-headless.answersheadless.setverticallimit.md b/docs/search-headless.answersheadless.setverticallimit.md deleted file mode 100644 index 82e13e36..00000000 --- a/docs/search-headless.answersheadless.setverticallimit.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [AnswersHeadless](./search-headless.answersheadless.md) > [setVerticalLimit](./search-headless.answersheadless.setverticallimit.md) - -## AnswersHeadless.setVerticalLimit() method - -Sets [VerticalSearchState.limit](./search-headless.verticalsearchstate.limit.md) to the specified limit. - -Signature: - -```typescript -setVerticalLimit(limit: number): void; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| limit | number | The vertical limit to set | - -Returns: - -void - diff --git a/docs/search-headless.answersheadless.state.md b/docs/search-headless.answersheadless.state.md deleted file mode 100644 index dc3fce41..00000000 --- a/docs/search-headless.answersheadless.state.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [AnswersHeadless](./search-headless.answersheadless.md) > [state](./search-headless.answersheadless.state.md) - -## AnswersHeadless.state property - -Gets the current state of the AnswersHeadless instance. - -Signature: - -```typescript -get state(): State; -``` diff --git a/docs/search-headless.answersheadless.submitquestion.md b/docs/search-headless.answersheadless.submitquestion.md deleted file mode 100644 index 5d2e5865..00000000 --- a/docs/search-headless.answersheadless.submitquestion.md +++ /dev/null @@ -1,26 +0,0 @@ - - -[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [AnswersHeadless](./search-headless.answersheadless.md) > [submitQuestion](./search-headless.answersheadless.submitquestion.md) - -## AnswersHeadless.submitQuestion() method - -Submits a question to the Answers API with the specified request data. - -Signature: - -```typescript -submitQuestion(request: Omit): Promise; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| request | Omit<[QuestionSubmissionRequest](./search-headless.questionsubmissionrequest.md), 'additionalHttpHeaders'> | The data for the network request | - -Returns: - -Promise<[QuestionSubmissionResponse](./search-headless.questionsubmissionresponse.md)> - -A Promise of a [QuestionSubmissionResponse](./search-headless.questionsubmissionresponse.md) from the Answers API - diff --git a/docs/search-headless.answersheadless.utilities.md b/docs/search-headless.answersheadless.utilities.md deleted file mode 100644 index 154ae856..00000000 --- a/docs/search-headless.answersheadless.utilities.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [AnswersHeadless](./search-headless.answersheadless.md) > [utilities](./search-headless.answersheadless.utilities.md) - -## AnswersHeadless.utilities property - -Common utility functions for manipulating Answers-related data. - -Signature: - -```typescript -readonly utilities: typeof answersUtilities; -``` diff --git a/docs/search-headless.answersutilities.isclosematch.md b/docs/search-headless.answersutilities.isclosematch.md deleted file mode 100644 index 32c71f29..00000000 --- a/docs/search-headless.answersutilities.isclosematch.md +++ /dev/null @@ -1,27 +0,0 @@ - - -[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [answersUtilities](./search-headless.answersutilities.md) > [isCloseMatch](./search-headless.answersutilities.isclosematch.md) - -## answersUtilities.isCloseMatch() function - -Checks if the searchTerm is a case-insensitive, Levenshtein match for the value. - -Signature: - -```typescript -export declare function isCloseMatch(value: string, searchTerm: string): boolean; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| value | string | The string to compare against | -| searchTerm | string | The term being searched for | - -Returns: - -boolean - -Whether or not the searchTerm is a substring of or a close Levenshtein match for the value - diff --git a/docs/search-headless.answersutilities.md b/docs/search-headless.answersutilities.md deleted file mode 100644 index 75057e71..00000000 --- a/docs/search-headless.answersutilities.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [answersUtilities](./search-headless.answersutilities.md) - -## answersUtilities namespace - -## Functions - -| Function | Description | -| --- | --- | -| [isCloseMatch(value, searchTerm)](./search-headless.answersutilities.isclosematch.md) | Checks if the searchTerm is a case-insensitive, Levenshtein match for the value. | -| [searchThroughFacet(facet, searchTerm)](./search-headless.answersutilities.searchthroughfacet.md) | Searches through the specified facet and filters out the options that aren't a close match for the given searchTerm. The comparison is case insensitive. | - diff --git a/docs/search-headless.answersutilities.searchthroughfacet.md b/docs/search-headless.answersutilities.searchthroughfacet.md deleted file mode 100644 index 05580f41..00000000 --- a/docs/search-headless.answersutilities.searchthroughfacet.md +++ /dev/null @@ -1,27 +0,0 @@ - - -[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [answersUtilities](./search-headless.answersutilities.md) > [searchThroughFacet](./search-headless.answersutilities.searchthroughfacet.md) - -## answersUtilities.searchThroughFacet() function - -Searches through the specified facet and filters out the options that aren't a close match for the given searchTerm. The comparison is case insensitive. - -Signature: - -```typescript -export declare function searchThroughFacet(facet: DisplayableFacet, searchTerm: string): DisplayableFacet; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| facet | [DisplayableFacet](./search-headless.displayablefacet.md) | The facet whose options are searched through | -| searchTerm | string | The search term to compare the facet options against | - -Returns: - -[DisplayableFacet](./search-headless.displayablefacet.md) - -The facet with only its options that are a close match for the searchTerm - diff --git a/docs/search-headless.provideanswersheadless.md b/docs/search-headless.provideanswersheadless.md deleted file mode 100644 index b1ffcd1e..00000000 --- a/docs/search-headless.provideanswersheadless.md +++ /dev/null @@ -1,26 +0,0 @@ - - -[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [provideAnswersHeadless](./search-headless.provideanswersheadless.md) - -## provideAnswersHeadless() function - -Supplies a new instance of [AnswersHeadless](./search-headless.answersheadless.md), using the provided configuration. - -Signature: - -```typescript -export declare function provideAnswersHeadless(config: HeadlessConfig): AnswersHeadless; -``` - -## Parameters - -| Parameter | Type | Description | -| --- | --- | --- | -| config | [HeadlessConfig](./search-headless.headlessconfig.md) | The apiKey, experienceKey, etc. needed to set up a front-end Answers experience. | - -Returns: - -AnswersHeadless - -The newly created instance of [AnswersHeadless](./search-headless.answersheadless.md) - From 0d098d6c1bc7cd7323ac098b2710151567e99905 Mon Sep 17 00:00:00 2001 From: Cindy Yang Date: Mon, 11 Jul 2022 15:36:57 -0400 Subject: [PATCH 09/22] answers-core -> search-core --- THIRD-PARTY-NOTICES | 124 +++++++++--------- __mocks__/@yext/answers-core.ts | 2 +- api-extractor.json | 2 +- package-lock.json | 44 +++---- package.json | 2 +- src/index.ts | 6 +- src/models/slices/directanswer.ts | 2 +- src/models/slices/filters.ts | 2 +- src/models/slices/location.ts | 2 +- src/models/slices/meta.ts | 2 +- src/models/slices/query.ts | 2 +- src/models/slices/queryrules.ts | 2 +- src/models/slices/spellcheck.ts | 2 +- src/models/slices/universal.ts | 2 +- src/models/slices/vertical.ts | 2 +- src/models/utils/selectableFilter.ts | 2 +- ...e-exports.ts => search-core-re-exports.ts} | 16 +-- src/search-headless.ts | 6 +- src/search-utilities.ts | 2 +- src/slices/directanswer.ts | 2 +- src/slices/filters.ts | 2 +- src/slices/location.ts | 2 +- src/slices/meta.ts | 2 +- src/slices/query.ts | 2 +- src/slices/queryrules.ts | 2 +- src/slices/spellcheck.ts | 2 +- src/slices/universal.ts | 2 +- src/slices/vertical.ts | 2 +- src/utils/client-sdk-utils.ts | 2 +- src/utils/filter-creators.ts | 2 +- src/utils/filter-utils.ts | 2 +- src/utils/transform-filters.ts | 2 +- test-site-node/package-lock.json | 4 +- tests/integration/directanswer.ts | 2 +- tests/integration/facets.ts | 2 +- tests/integration/location.ts | 2 +- tests/integration/meta.ts | 2 +- tests/integration/query.ts | 2 +- tests/integration/redux-state-manager.ts | 10 +- tests/integration/sortbys.ts | 2 +- tests/integration/status.ts | 2 +- tests/integration/universalsearch.ts | 2 +- tests/integration/verticalsearch.ts | 2 +- tests/unit/answers-headless.ts | 2 +- tests/unit/slices/filters.ts | 2 +- tests/unit/slices/query.ts | 2 +- tests/unit/slices/spellcheck.ts | 2 +- tests/unit/slices/universal.ts | 2 +- tests/unit/utils/filter-creator.ts | 2 +- tests/unit/utils/transform-filters.ts | 2 +- 50 files changed, 148 insertions(+), 148 deletions(-) rename src/{answers-core-re-exports.ts => search-core-re-exports.ts} (88%) diff --git a/THIRD-PARTY-NOTICES b/THIRD-PARTY-NOTICES index 9ae4310c..a7edd6ff 100644 --- a/THIRD-PARTY-NOTICES +++ b/THIRD-PARTY-NOTICES @@ -36,37 +36,37 @@ The following NPM package may be included in this product: This package contains the following license and notice below: -MIT License - -Copyright (c) 2018 Mark Erikson - -Permission is hereby granted, free of charge, to any person obtaining a copy -of this software and associated documentation files (the "Software"), to deal -in the Software without restriction, including without limitation the rights -to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -copies of the Software, and to permit persons to whom the Software is -furnished to do so, subject to the following conditions: - -The above copyright notice and this permission notice shall be included in all -copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +MIT License + +Copyright (c) 2018 Mark Erikson + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ----------- The following NPM package may be included in this product: - - @yext/answers-core@1.7.0 + - @yext/search-core@1.8.0 This package contains the following license and notice below: -The Answers Core files listed in this repository are licensed under the below license.  All other features and products are subject to separate agreements +The Search Core files listed in this repository are licensed under the below license.  All other features and products are subject to separate agreements and certain functionality requires paid subscriptions to Yext products. Contains information from the language-subtag-registry JSON Database (https://github.com/mattcg/language-subtag-registry/tree/master/data/json) @@ -314,26 +314,26 @@ The following NPM package may be included in this product: This package contains the following license and notice below: -The MIT License (MIT) - -Copyright (c) 2015-present Dan Abramov - -Permission is hereby granted, free of charge, to any person obtaining a copy -of this software and associated documentation files (the "Software"), to deal -in the Software without restriction, including without limitation the rights -to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -copies of the Software, and to permit persons to whom the Software is -furnished to do so, subject to the following conditions: - -The above copyright notice and this permission notice shall be included in all -copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +The MIT License (MIT) + +Copyright (c) 2015-present Dan Abramov + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ----------- @@ -404,26 +404,26 @@ The following NPM package may be included in this product: This package contains the following license and notice below: -The MIT License (MIT) - -Copyright (c) 2015-2018 Reselect Contributors - -Permission is hereby granted, free of charge, to any person obtaining a copy -of this software and associated documentation files (the "Software"), to deal -in the Software without restriction, including without limitation the rights -to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -copies of the Software, and to permit persons to whom the Software is -furnished to do so, subject to the following conditions: - -The above copyright notice and this permission notice shall be included in all -copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +The MIT License (MIT) + +Copyright (c) 2015-2018 Reselect Contributors + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ----------- diff --git a/__mocks__/@yext/answers-core.ts b/__mocks__/@yext/answers-core.ts index b5360b84..21782a94 100644 --- a/__mocks__/@yext/answers-core.ts +++ b/__mocks__/@yext/answers-core.ts @@ -1,4 +1,4 @@ -export * from '@yext/answers-core'; +export * from '@yext/search-core'; export function provideCore(): unknown { return { diff --git a/api-extractor.json b/api-extractor.json index 19381780..da4041fc 100644 --- a/api-extractor.json +++ b/api-extractor.json @@ -60,7 +60,7 @@ * This would direct API Extractor to embed those types directly in the .d.ts rollup, as if they had been * local files for library1. */ - "bundledPackages": [ "@yext/answers-core" ], + "bundledPackages": [ "@yext/search-core" ], /** * Determines how the TypeScript compiler engine will be invoked by API Extractor. diff --git a/package-lock.json b/package-lock.json index 935ddbaa..2587d232 100644 --- a/package-lock.json +++ b/package-lock.json @@ -10,7 +10,7 @@ "license": "ISC", "dependencies": { "@reduxjs/toolkit": "^1.8.1", - "@yext/answers-core": "^1.7.0", + "@yext/search-core": "^1.8.0", "js-levenshtein": "^1.1.6", "lodash": "^4.17.21" }, @@ -4647,18 +4647,6 @@ "url": "https://opencollective.com/typescript-eslint" } }, - "node_modules/@yext/answers-core": { - "version": "1.7.0", - "resolved": "https://registry.npmjs.org/@yext/answers-core/-/answers-core-1.7.0.tgz", - "integrity": "sha512-wOG9TAj3fVUXVJvS5HO+S54O6Ehyd32FfRUtZ4j1kE8ES5T9bhJ8xALos4NC+gCuXIMmV1kHXzsKLafeuSrpAg==", - "dependencies": { - "@babel/runtime-corejs3": "^7.12.5", - "cross-fetch": "^3.1.5" - }, - "engines": { - "node": ">=12" - } - }, "node_modules/@yext/eslint-config-slapshot": { "version": "0.2.0", "resolved": "https://registry.npmjs.org/@yext/eslint-config-slapshot/-/eslint-config-slapshot-0.2.0.tgz", @@ -4688,6 +4676,18 @@ "eslint-module-utils": "^2.7.1" } }, + "node_modules/@yext/search-core": { + "version": "1.8.0", + "resolved": "https://registry.npmjs.org/@yext/search-core/-/search-core-1.8.0.tgz", + "integrity": "sha512-t7rg9JZ9K6pIt2nBZ1O+xhzG+zMFVAu9Vgwh8cTey8NA7878cQ6n6BauTwimVdbrNGHq3D2dPUno/kVtKAgPiQ==", + "dependencies": { + "@babel/runtime-corejs3": "^7.12.5", + "cross-fetch": "^3.1.5" + }, + "engines": { + "node": ">=12" + } + }, "node_modules/abbrev": { "version": "1.1.1", "resolved": "https://registry.npmjs.org/abbrev/-/abbrev-1.1.1.tgz", @@ -16247,15 +16247,6 @@ "eslint-visitor-keys": "^3.0.0" } }, - "@yext/answers-core": { - "version": "1.7.0", - "resolved": "https://registry.npmjs.org/@yext/answers-core/-/answers-core-1.7.0.tgz", - "integrity": "sha512-wOG9TAj3fVUXVJvS5HO+S54O6Ehyd32FfRUtZ4j1kE8ES5T9bhJ8xALos4NC+gCuXIMmV1kHXzsKLafeuSrpAg==", - "requires": { - "@babel/runtime-corejs3": "^7.12.5", - "cross-fetch": "^3.1.5" - } - }, "@yext/eslint-config-slapshot": { "version": "0.2.0", "resolved": "https://registry.npmjs.org/@yext/eslint-config-slapshot/-/eslint-config-slapshot-0.2.0.tgz", @@ -16277,6 +16268,15 @@ "eslint-module-utils": "^2.7.1" } }, + "@yext/search-core": { + "version": "1.8.0", + "resolved": "https://registry.npmjs.org/@yext/search-core/-/search-core-1.8.0.tgz", + "integrity": "sha512-t7rg9JZ9K6pIt2nBZ1O+xhzG+zMFVAu9Vgwh8cTey8NA7878cQ6n6BauTwimVdbrNGHq3D2dPUno/kVtKAgPiQ==", + "requires": { + "@babel/runtime-corejs3": "^7.12.5", + "cross-fetch": "^3.1.5" + } + }, "abbrev": { "version": "1.1.1", "resolved": "https://registry.npmjs.org/abbrev/-/abbrev-1.1.1.tgz", diff --git a/package.json b/package.json index 54aec867..1bd04c52 100644 --- a/package.json +++ b/package.json @@ -23,7 +23,7 @@ }, "dependencies": { "@reduxjs/toolkit": "^1.8.1", - "@yext/answers-core": "^1.7.0", + "@yext/search-core": "^1.8.0", "js-levenshtein": "^1.1.6", "lodash": "^4.17.21" }, diff --git a/src/index.ts b/src/index.ts index 47a84db8..d795e8fc 100644 --- a/src/index.ts +++ b/src/index.ts @@ -1,4 +1,4 @@ -import { provideCore, AnswersConfig, AdditionalHttpHeaders } from '@yext/answers-core'; +import { provideCore, SearchConfig, AdditionalHttpHeaders } from '@yext/search-core'; import HttpManager from './http-manager'; import ReduxStateManager from './redux-state-manager'; import SearchHeadless from './search-headless'; @@ -9,7 +9,7 @@ import { SessionTrackingState } from './models/slices/sessiontracking'; import * as searchUtilities from './search-utilities'; import { getHttpHeaders } from './utils/client-sdk-utils'; -export * from './answers-core-re-exports'; +export * from './search-core-re-exports'; export * from './models'; export * from './constants'; export * from './utils/filter-creators'; @@ -21,7 +21,7 @@ export { searchUtilities }; * * @public */ -export type HeadlessConfig = AnswersConfig & { +export type HeadlessConfig = SearchConfig & { /** * The ID of the SearchHeadless instance. * diff --git a/src/models/slices/directanswer.ts b/src/models/slices/directanswer.ts index 9168c1cd..ac7f3fc8 100644 --- a/src/models/slices/directanswer.ts +++ b/src/models/slices/directanswer.ts @@ -1,4 +1,4 @@ -import { FeaturedSnippetDirectAnswer, FieldValueDirectAnswer } from '@yext/answers-core'; +import { FeaturedSnippetDirectAnswer, FieldValueDirectAnswer } from '@yext/search-core'; /** * Maintains the direct answer associated with the latest search. diff --git a/src/models/slices/filters.ts b/src/models/slices/filters.ts index a8eeb5ab..c2286db7 100644 --- a/src/models/slices/filters.ts +++ b/src/models/slices/filters.ts @@ -1,4 +1,4 @@ -import { DisplayableFacet } from '@yext/answers-core'; +import { DisplayableFacet } from '@yext/search-core'; import { SelectableFilter } from '../utils/selectableFilter'; /** diff --git a/src/models/slices/location.ts b/src/models/slices/location.ts index 61847ff6..312509f5 100644 --- a/src/models/slices/location.ts +++ b/src/models/slices/location.ts @@ -1,4 +1,4 @@ -import { LatLong, LocationBias } from '@yext/answers-core'; +import { LatLong, LocationBias } from '@yext/search-core'; /** * Maintains the user's location, if given, or the inferred location, that is diff --git a/src/models/slices/meta.ts b/src/models/slices/meta.ts index 043b3f6f..72508599 100644 --- a/src/models/slices/meta.ts +++ b/src/models/slices/meta.ts @@ -1,4 +1,4 @@ -import { Context } from '@yext/answers-core'; +import { Context } from '@yext/search-core'; import { SearchType } from '../utils/searchType'; /** diff --git a/src/models/slices/query.ts b/src/models/slices/query.ts index 41807949..f5d7ed54 100644 --- a/src/models/slices/query.ts +++ b/src/models/slices/query.ts @@ -1,4 +1,4 @@ -import { QuerySource, QueryTrigger, SearchIntent } from '@yext/answers-core'; +import { QuerySource, QueryTrigger, SearchIntent } from '@yext/search-core'; /** * Maintains the latest query and its associated data. diff --git a/src/models/slices/queryrules.ts b/src/models/slices/queryrules.ts index 6a7f6b11..93cfc523 100644 --- a/src/models/slices/queryrules.ts +++ b/src/models/slices/queryrules.ts @@ -1,4 +1,4 @@ -import { QueryRulesActionsData } from '@yext/answers-core'; +import { QueryRulesActionsData } from '@yext/search-core'; /** * Maintains the data from the triggered query rules. diff --git a/src/models/slices/spellcheck.ts b/src/models/slices/spellcheck.ts index 1117760d..1950141a 100644 --- a/src/models/slices/spellcheck.ts +++ b/src/models/slices/spellcheck.ts @@ -1,4 +1,4 @@ -import { SpellCheck } from '@yext/answers-core'; +import { SpellCheck } from '@yext/search-core'; /** * Maintains whether spellcheck is enabled and the spellcheck response from the diff --git a/src/models/slices/universal.ts b/src/models/slices/universal.ts index 29a2c521..41cc222a 100644 --- a/src/models/slices/universal.ts +++ b/src/models/slices/universal.ts @@ -1,4 +1,4 @@ -import { UniversalLimit, VerticalResults } from '@yext/answers-core'; +import { UniversalLimit, VerticalResults } from '@yext/search-core'; /** * Maintains the data for the latest universal search. diff --git a/src/models/slices/vertical.ts b/src/models/slices/vertical.ts index 670efc7b..6805f041 100644 --- a/src/models/slices/vertical.ts +++ b/src/models/slices/vertical.ts @@ -5,7 +5,7 @@ import { SortBy, Source, VerticalResults -} from '@yext/answers-core'; +} from '@yext/search-core'; /** * Represents all results for the current vertical. diff --git a/src/models/utils/selectableFilter.ts b/src/models/utils/selectableFilter.ts index 1d46f6f9..27b82d79 100644 --- a/src/models/utils/selectableFilter.ts +++ b/src/models/utils/selectableFilter.ts @@ -1,4 +1,4 @@ -import { Filter } from '@yext/answers-core'; +import { Filter } from '@yext/search-core'; /** * A {@link Filter} with additional information, such as an diff --git a/src/answers-core-re-exports.ts b/src/search-core-re-exports.ts similarity index 88% rename from src/answers-core-re-exports.ts rename to src/search-core-re-exports.ts index addcc122..c272af05 100644 --- a/src/answers-core-re-exports.ts +++ b/src/search-core-re-exports.ts @@ -1,17 +1,17 @@ export { AdditionalHttpHeaders, - AnswersConfig, - AnswersConfigWithApiKey, - AnswersConfigWithToken, - AnswersCore, - AnswersError, - AnswersRequest, + SearchConfig, + SearchConfigWithApiKey, + SearchConfigWithToken, + SearchCore, + SearchError, + SearchRequest, AppliedQueryFilter, AppliedQueryFilterType, AutocompleteResponse, AutocompleteResult, AutocompleteService, - BaseAnswersConfig, + BaseSearchConfig, CombinedFilter, Context, ClientSDKHeaderValues, @@ -69,4 +69,4 @@ export { VerticalSearchRequest, VerticalSearchResponse, Visitor -} from '@yext/answers-core'; +} from '@yext/search-core'; diff --git a/src/search-headless.ts b/src/search-headless.ts index 00317427..deca17f7 100644 --- a/src/search-headless.ts +++ b/src/search-headless.ts @@ -1,5 +1,5 @@ import { - AnswersCore, + SearchCore, QueryTrigger, QuerySource, QuestionSubmissionRequest, @@ -17,7 +17,7 @@ import { UniversalLimit, VerticalSearchResponse, AdditionalHttpHeaders -} from '@yext/answers-core'; +} from '@yext/search-core'; import StateListener from './models/state-listener'; import { State } from './models/state'; @@ -47,7 +47,7 @@ export default class SearchHeadless { public readonly utilities = answersUtilities; constructor( - private core: AnswersCore, + private core: SearchCore, private stateManager: StateManager, private httpManager: HttpManager, private additionalHttpHeaders?: AdditionalHttpHeaders diff --git a/src/search-utilities.ts b/src/search-utilities.ts index 14b93101..3d9d8a5e 100644 --- a/src/search-utilities.ts +++ b/src/search-utilities.ts @@ -1,4 +1,4 @@ -import { DisplayableFacet } from '@yext/answers-core'; +import { DisplayableFacet } from '@yext/search-core'; import { isLevenshteinMatch } from './utils/searchable-facets'; /** diff --git a/src/slices/directanswer.ts b/src/slices/directanswer.ts index a028889b..64ccbbd4 100644 --- a/src/slices/directanswer.ts +++ b/src/slices/directanswer.ts @@ -1,5 +1,5 @@ import { createSlice, PayloadAction, Slice } from '@reduxjs/toolkit'; -import { FeaturedSnippetDirectAnswer, FieldValueDirectAnswer } from '@yext/answers-core'; +import { FeaturedSnippetDirectAnswer, FieldValueDirectAnswer } from '@yext/search-core'; import { DirectAnswerState } from '../models/slices/directanswer'; export const initialState: DirectAnswerState = {}; diff --git a/src/slices/filters.ts b/src/slices/filters.ts index 39de12ea..b083a382 100644 --- a/src/slices/filters.ts +++ b/src/slices/filters.ts @@ -1,5 +1,5 @@ import { createSlice, PayloadAction, Slice } from '@reduxjs/toolkit'; -import { FacetOption, DisplayableFacet } from '@yext/answers-core'; +import { FacetOption, DisplayableFacet } from '@yext/search-core'; import { SelectableFilter } from '../models/utils/selectableFilter'; import { FiltersState } from '../models/slices/filters'; import isEqual from 'lodash/isEqual'; diff --git a/src/slices/location.ts b/src/slices/location.ts index 5e7f4ca4..f6ee9463 100644 --- a/src/slices/location.ts +++ b/src/slices/location.ts @@ -1,5 +1,5 @@ import { createSlice, PayloadAction, Slice } from '@reduxjs/toolkit'; -import { LatLong, LocationBias } from '@yext/answers-core'; +import { LatLong, LocationBias } from '@yext/search-core'; import { LocationState } from '../models/slices/location'; const initialState: LocationState = {}; diff --git a/src/slices/meta.ts b/src/slices/meta.ts index 26c57094..24e069cb 100644 --- a/src/slices/meta.ts +++ b/src/slices/meta.ts @@ -1,5 +1,5 @@ import { createSlice, PayloadAction, Slice } from '@reduxjs/toolkit'; -import { Context } from '@yext/answers-core'; +import { Context } from '@yext/search-core'; import { MetaState } from '../models/slices/meta'; import { SearchTypeEnum } from '../models/utils/searchType'; diff --git a/src/slices/query.ts b/src/slices/query.ts index dbfa70b4..84fb2f4f 100644 --- a/src/slices/query.ts +++ b/src/slices/query.ts @@ -1,5 +1,5 @@ import { createSlice, PayloadAction, Slice } from '@reduxjs/toolkit'; -import { QuerySource, QueryTrigger, SearchIntent } from '@yext/answers-core'; +import { QuerySource, QueryTrigger, SearchIntent } from '@yext/search-core'; import { QueryState } from '../models/slices/query'; const initialState: QueryState = {}; diff --git a/src/slices/queryrules.ts b/src/slices/queryrules.ts index b76c735b..76c2c94a 100644 --- a/src/slices/queryrules.ts +++ b/src/slices/queryrules.ts @@ -1,5 +1,5 @@ import { createSlice, PayloadAction, Slice } from '@reduxjs/toolkit'; -import { QueryRulesActionsData } from '@yext/answers-core'; +import { QueryRulesActionsData } from '@yext/search-core'; import { QueryRulesState } from '../models/slices/queryrules'; export const initialState: QueryRulesState = { actions: [] }; diff --git a/src/slices/spellcheck.ts b/src/slices/spellcheck.ts index cf561ffc..97936a0c 100644 --- a/src/slices/spellcheck.ts +++ b/src/slices/spellcheck.ts @@ -1,5 +1,5 @@ import { createSlice, PayloadAction, Slice } from '@reduxjs/toolkit'; -import { SpellCheck } from '@yext/answers-core'; +import { SpellCheck } from '@yext/search-core'; import { SpellCheckState } from '../models/slices/spellcheck'; const initialState: SpellCheckState = { diff --git a/src/slices/universal.ts b/src/slices/universal.ts index 38c71dfc..eee70cf7 100644 --- a/src/slices/universal.ts +++ b/src/slices/universal.ts @@ -1,5 +1,5 @@ import { createSlice, PayloadAction, Slice } from '@reduxjs/toolkit'; -import { UniversalLimit, VerticalResults } from '@yext/answers-core'; +import { UniversalLimit, VerticalResults } from '@yext/search-core'; import { UniversalSearchState } from '../models/slices/universal'; export const initialState: UniversalSearchState = {}; diff --git a/src/slices/vertical.ts b/src/slices/vertical.ts index 05ddf3b1..1ef469d4 100644 --- a/src/slices/vertical.ts +++ b/src/slices/vertical.ts @@ -2,7 +2,7 @@ import { createSlice, PayloadAction, Slice } from '@reduxjs/toolkit'; import { SortBy, VerticalSearchResponse -} from '@yext/answers-core'; +} from '@yext/search-core'; import { AllResultsForVertical, VerticalSearchState } from '../models/slices/vertical'; export const initialState: VerticalSearchState = {}; diff --git a/src/utils/client-sdk-utils.ts b/src/utils/client-sdk-utils.ts index 03468a2c..b155d17d 100644 --- a/src/utils/client-sdk-utils.ts +++ b/src/utils/client-sdk-utils.ts @@ -1,4 +1,4 @@ -import { AdditionalHttpHeaders, ClientSDKHeaderValues } from '@yext/answers-core'; +import { AdditionalHttpHeaders, ClientSDKHeaderValues } from '@yext/search-core'; import packageJson from '../../package.json'; const CLIENT_SDK_HEADER = 'Client-SDK'; diff --git a/src/utils/filter-creators.ts b/src/utils/filter-creators.ts index eab3f1a2..b0b87364 100644 --- a/src/utils/filter-creators.ts +++ b/src/utils/filter-creators.ts @@ -1,4 +1,4 @@ -import { CombinedFilter, Filter, FilterCombinator, Matcher, NearFilterValue } from '@yext/answers-core'; +import { CombinedFilter, Filter, FilterCombinator, Matcher, NearFilterValue } from '@yext/search-core'; import { BoundedRange } from '../models/utils/boundedrange'; /** diff --git a/src/utils/filter-utils.ts b/src/utils/filter-utils.ts index 34e0de09..3384124a 100644 --- a/src/utils/filter-utils.ts +++ b/src/utils/filter-utils.ts @@ -1,6 +1,6 @@ import isEqual from 'lodash/isEqual'; -import { Filter } from '@yext/answers-core'; +import { Filter } from '@yext/search-core'; /** * Returns true if the two given filters are the same. diff --git a/src/utils/transform-filters.ts b/src/utils/transform-filters.ts index c68e2309..840d06f7 100644 --- a/src/utils/transform-filters.ts +++ b/src/utils/transform-filters.ts @@ -1,4 +1,4 @@ -import { CombinedFilter, Filter, FilterCombinator } from '@yext/answers-core'; +import { CombinedFilter, Filter, FilterCombinator } from '@yext/search-core'; import { SelectableFilter } from '../models/utils/selectableFilter'; /** diff --git a/test-site-node/package-lock.json b/test-site-node/package-lock.json index ead6cae5..96c63d0d 100644 --- a/test-site-node/package-lock.json +++ b/test-site-node/package-lock.json @@ -18,7 +18,7 @@ "license": "ISC", "dependencies": { "@reduxjs/toolkit": "^1.8.1", - "@yext/answers-core": "^1.7.0", + "@yext/search-core": "^1.8.0", "js-levenshtein": "^1.1.6", "lodash": "^4.17.21" }, @@ -63,7 +63,7 @@ "@types/node": "^16.11.12", "@typescript-eslint/eslint-plugin": "^5.16.0", "@typescript-eslint/parser": "^5.16.0", - "@yext/answers-core": "^1.7.0", + "@yext/search-core": "^1.8.0", "@yext/eslint-config-slapshot": "^0.2.0", "@yext/eslint-plugin-export-star": "^1.0.0", "babel-jest": "^27.4.5", diff --git a/tests/integration/directanswer.ts b/tests/integration/directanswer.ts index c7ad3311..8bccf02e 100644 --- a/tests/integration/directanswer.ts +++ b/tests/integration/directanswer.ts @@ -1,5 +1,5 @@ import { createMockedAnswersHeadless } from '../mocks/createMockedAnswersHeadless'; -import { FeaturedSnippetDirectAnswer, DirectAnswerType, Source } from '@yext/answers-core'; +import { FeaturedSnippetDirectAnswer, DirectAnswerType, Source } from '@yext/search-core'; import { State } from '../../src/models/state'; import { SearchTypeEnum } from '../../src/models/utils/searchType'; diff --git a/tests/integration/facets.ts b/tests/integration/facets.ts index 53dddd1e..05b7fc18 100644 --- a/tests/integration/facets.ts +++ b/tests/integration/facets.ts @@ -1,4 +1,4 @@ -import { DisplayableFacet, DisplayableFacetOption, Matcher } from '@yext/answers-core'; +import { DisplayableFacet, DisplayableFacetOption, Matcher } from '@yext/search-core'; import { State } from '../../src/models/state'; import { SearchTypeEnum } from '../../src/models/utils/searchType'; import { createMockedAnswersHeadless } from '../mocks/createMockedAnswersHeadless'; diff --git a/tests/integration/location.ts b/tests/integration/location.ts index df20bcce..e97fd7d1 100644 --- a/tests/integration/location.ts +++ b/tests/integration/location.ts @@ -1,4 +1,4 @@ -import { VerticalSearchRequest, UniversalSearchRequest, LocationBias, LocationBiasMethod, LatLong } from '@yext/answers-core'; +import { VerticalSearchRequest, UniversalSearchRequest, LocationBias, LocationBiasMethod, LatLong } from '@yext/search-core'; import { createMockedAnswersHeadless } from '../mocks/createMockedAnswersHeadless'; describe('userLocation', () => { diff --git a/tests/integration/meta.ts b/tests/integration/meta.ts index 3c0bc8d9..2ef2683c 100644 --- a/tests/integration/meta.ts +++ b/tests/integration/meta.ts @@ -1,4 +1,4 @@ -import { UniversalSearchRequest, VerticalSearchRequest } from '@yext/answers-core'; +import { UniversalSearchRequest, VerticalSearchRequest } from '@yext/search-core'; import { createMockedAnswersHeadless } from '../mocks/createMockedAnswersHeadless'; it('by default no meta attributes are sent', async () => { diff --git a/tests/integration/query.ts b/tests/integration/query.ts index 190eebdb..e327ca07 100644 --- a/tests/integration/query.ts +++ b/tests/integration/query.ts @@ -2,7 +2,7 @@ import { VerticalSearchRequest, UniversalSearchRequest, SearchIntent -} from '@yext/answers-core'; +} from '@yext/search-core'; import HttpManager from '../../src/http-manager'; import ReduxStateManager from '../../src/redux-state-manager'; import SearchHeadless from '../../src/search-headless'; diff --git a/tests/integration/redux-state-manager.ts b/tests/integration/redux-state-manager.ts index 351ce0ca..f9e4d1c1 100644 --- a/tests/integration/redux-state-manager.ts +++ b/tests/integration/redux-state-manager.ts @@ -4,7 +4,7 @@ import HeadlessReducerManager from '../../src/headless-reducer-manager'; import SearchHeadless from '../../src/search-headless'; import { expectedInitialState } from '../mocks/expectedInitialState'; import HttpManager from '../../src/http-manager'; -import { AnswersCore } from '@yext/answers-core'; +import { SearchCore } from '@yext/search-core'; it('instantiating a ReduxStateManager creates adjacent state subtrees', () => { const store = createBaseStore(); @@ -57,7 +57,7 @@ it('dispatching answers actions through SearchHeadless', () => { const store = createBaseStore(); const headlessReducerManager = new HeadlessReducerManager(); const stateManager = new ReduxStateManager(store, 'anId', headlessReducerManager); - const headless = new SearchHeadless({} as AnswersCore, stateManager, new HttpManager()); + const headless = new SearchHeadless({} as SearchCore, stateManager, new HttpManager()); headless.setQuery('yo'); expect(store.getState()).toEqual({ anId: { @@ -73,7 +73,7 @@ it('addListener works with multiple headless instances', () => { const store = createBaseStore(); const headlessReducerManager = new HeadlessReducerManager(); const stateManager = new ReduxStateManager(store, 'anId', headlessReducerManager); - const headless = new SearchHeadless({} as AnswersCore, stateManager, new HttpManager()); + const headless = new SearchHeadless({} as SearchCore, stateManager, new HttpManager()); const callback = jest.fn(); headless.addListener({ valueAccessor: state => state.query.input, @@ -93,12 +93,12 @@ it('addListener can be used to link together different headless instances', () = const store = createBaseStore(); const headlessReducerManager = new HeadlessReducerManager(); const firstHeadless = new SearchHeadless( - {} as AnswersCore, + {} as SearchCore, new ReduxStateManager(store, 'first', headlessReducerManager), new HttpManager() ); const secondHeadless = new SearchHeadless( - {} as AnswersCore, + {} as SearchCore, new ReduxStateManager(store, 'second', headlessReducerManager), new HttpManager() ); diff --git a/tests/integration/sortbys.ts b/tests/integration/sortbys.ts index f5db95a9..c4dc2e3b 100644 --- a/tests/integration/sortbys.ts +++ b/tests/integration/sortbys.ts @@ -1,4 +1,4 @@ -import { Direction, SortType, VerticalSearchRequest } from '@yext/answers-core'; +import { Direction, SortType, VerticalSearchRequest } from '@yext/search-core'; import { createMockedAnswersHeadless } from '../mocks/createMockedAnswersHeadless'; it('executeVerticalQuery properly updates spellcheck state', async () => { diff --git a/tests/integration/status.ts b/tests/integration/status.ts index a3c7e24c..be5c0b6a 100644 --- a/tests/integration/status.ts +++ b/tests/integration/status.ts @@ -1,4 +1,4 @@ -import { UniversalSearchRequest, VerticalSearchRequest } from '@yext/answers-core'; +import { UniversalSearchRequest, VerticalSearchRequest } from '@yext/search-core'; import { createMockedAnswersHeadless } from '../mocks/createMockedAnswersHeadless'; import setTimeout from '../utils/setTimeout'; diff --git a/tests/integration/universalsearch.ts b/tests/integration/universalsearch.ts index b4f56731..f886aa6c 100644 --- a/tests/integration/universalsearch.ts +++ b/tests/integration/universalsearch.ts @@ -1,4 +1,4 @@ -import { UniversalSearchRequest } from '@yext/answers-core'; +import { UniversalSearchRequest } from '@yext/search-core'; import HttpManager from '../../src/http-manager'; import { getHttpHeaders } from '../../src/utils/client-sdk-utils'; import { createMockedAnswersHeadless } from '../mocks/createMockedAnswersHeadless'; diff --git a/tests/integration/verticalsearch.ts b/tests/integration/verticalsearch.ts index 7ea837ba..f2fe159e 100644 --- a/tests/integration/verticalsearch.ts +++ b/tests/integration/verticalsearch.ts @@ -1,4 +1,4 @@ -import { AppliedQueryFilter, Matcher, Result, Source, VerticalResults, VerticalSearchRequest, VerticalSearchResponse } from '@yext/answers-core'; +import { AppliedQueryFilter, Matcher, Result, Source, VerticalResults, VerticalSearchRequest, VerticalSearchResponse } from '@yext/search-core'; import HttpManager from '../../src/http-manager'; import { AllResultsForVertical } from '../../src/models/slices/vertical'; import { State } from '../../src/models/state'; diff --git a/tests/unit/answers-headless.ts b/tests/unit/answers-headless.ts index fabeb965..8362d2a8 100644 --- a/tests/unit/answers-headless.ts +++ b/tests/unit/answers-headless.ts @@ -1,4 +1,4 @@ -import { Matcher, QuerySource, QueryTrigger } from '@yext/answers-core'; +import { Matcher, QuerySource, QueryTrigger } from '@yext/search-core'; import HttpManager from '../../src/http-manager'; import StateManager from '../../src/models/state-manager'; import SearchHeadless from '../../src/search-headless'; diff --git a/tests/unit/slices/filters.ts b/tests/unit/slices/filters.ts index 503ab769..9ef1c9ce 100644 --- a/tests/unit/slices/filters.ts +++ b/tests/unit/slices/filters.ts @@ -1,4 +1,4 @@ -import { DisplayableFacetOption, Filter, Matcher } from '@yext/answers-core'; +import { DisplayableFacetOption, Filter, Matcher } from '@yext/search-core'; import createFiltersSlice from '../../../src/slices/filters'; import _ from 'lodash'; import { FiltersState, SelectableFilter } from '../../../src'; diff --git a/tests/unit/slices/query.ts b/tests/unit/slices/query.ts index 5be826cd..97c2966b 100644 --- a/tests/unit/slices/query.ts +++ b/tests/unit/slices/query.ts @@ -1,4 +1,4 @@ -import { QuerySource, QueryTrigger } from '@yext/answers-core'; +import { QuerySource, QueryTrigger } from '@yext/search-core'; import createQuerySlice from '../../../src/slices/query'; const { reducer, actions } = createQuerySlice(''); diff --git a/tests/unit/slices/spellcheck.ts b/tests/unit/slices/spellcheck.ts index d41754b3..9a2b1924 100644 --- a/tests/unit/slices/spellcheck.ts +++ b/tests/unit/slices/spellcheck.ts @@ -1,4 +1,4 @@ -import { SpellCheck, SpellCheckType } from '@yext/answers-core'; +import { SpellCheck, SpellCheckType } from '@yext/search-core'; import createSpellCheckSlice from '../../../src/slices/spellcheck'; const { reducer, actions } = createSpellCheckSlice(''); diff --git a/tests/unit/slices/universal.ts b/tests/unit/slices/universal.ts index ca08fdbf..52f5cea2 100644 --- a/tests/unit/slices/universal.ts +++ b/tests/unit/slices/universal.ts @@ -1,4 +1,4 @@ -import { Source, VerticalResults } from '@yext/answers-core'; +import { Source, VerticalResults } from '@yext/search-core'; import createUniversalSlice from '../../../src/slices/universal'; const { reducer, actions } = createUniversalSlice(''); diff --git a/tests/unit/utils/filter-creator.ts b/tests/unit/utils/filter-creator.ts index a762cd78..25b2ebc9 100644 --- a/tests/unit/utils/filter-creator.ts +++ b/tests/unit/utils/filter-creator.ts @@ -1,4 +1,4 @@ -import { FilterCombinator, Matcher } from '@yext/answers-core'; +import { FilterCombinator, Matcher } from '@yext/search-core'; import { combineFilters, createDateRangeFilter, createEqualsFilter, createNearMeFilter, createNumberRangeFilter } from '../../../src/utils/filter-creators'; describe('filter creators work properly', () => { diff --git a/tests/unit/utils/transform-filters.ts b/tests/unit/utils/transform-filters.ts index a7fcec46..e5a115aa 100644 --- a/tests/unit/utils/transform-filters.ts +++ b/tests/unit/utils/transform-filters.ts @@ -1,4 +1,4 @@ -import { CombinedFilter, Filter, FilterCombinator, Matcher } from '@yext/answers-core'; +import { CombinedFilter, Filter, FilterCombinator, Matcher } from '@yext/search-core'; import { SelectableFilter } from '../../../src/models/utils/selectableFilter'; import { transformFiltersToCoreFormat } from '../../../src/utils/transform-filters'; From 6b6f8b703b68e52d61ac5bac1261a28d42ee85ec Mon Sep 17 00:00:00 2001 From: Cindy Yang Date: Mon, 11 Jul 2022 15:41:16 -0400 Subject: [PATCH 10/22] update exports --- LICENSE | 2 +- docs/search-headless.directanswerstate.md | 2 +- docs/search-headless.directanswerstate.result.md | 2 +- docs/search-headless.locationstate.locationbias.md | 2 +- docs/search-headless.locationstate.md | 2 +- docs/search-headless.md | 2 +- docs/search-headless.metastate.md | 4 ++-- docs/search-headless.metastate.searchtype.md | 2 +- docs/search-headless.querystate.md | 4 ++-- docs/search-headless.querystate.querysource.md | 2 +- docs/search-headless.querystate.searchintents.md | 2 +- docs/search-headless.state.md | 2 +- docs/search-headless.state.meta.md | 2 +- src/models/slices/directanswer.ts | 2 +- src/models/slices/location.ts | 2 +- src/models/slices/meta.ts | 4 ++-- src/models/slices/query.ts | 4 ++-- src/slices/searchstatus.ts | 2 +- src/slices/sessiontracking.ts | 2 +- src/utils/transform-filters.ts | 4 ++-- tests/mocks/createMockedAnswersHeadless.ts | 8 ++++---- 21 files changed, 29 insertions(+), 29 deletions(-) diff --git a/LICENSE b/LICENSE index 6337be8d..8ba5a106 100644 --- a/LICENSE +++ b/LICENSE @@ -1,4 +1,4 @@ -The Answers Headless files listed in this repository are licensed under the below license.  All other features and products are subject to separate agreements +The Search Headless files listed in this repository are licensed under the below license.  All other features and products are subject to separate agreements and certain functionality requires paid subscriptions to Yext products. Contains information from the language-subtag-registry JSON Database (https://github.com/mattcg/language-subtag-registry/tree/master/data/json) diff --git a/docs/search-headless.directanswerstate.md b/docs/search-headless.directanswerstate.md index 5f9a0848..67b011f5 100644 --- a/docs/search-headless.directanswerstate.md +++ b/docs/search-headless.directanswerstate.md @@ -16,5 +16,5 @@ export interface DirectAnswerState | Property | Type | Description | | --- | --- | --- | -| [result?](./search-headless.directanswerstate.result.md) | [FeaturedSnippetDirectAnswer](./search-headless.featuredsnippetdirectanswer.md) \| [FieldValueDirectAnswer](./search-headless.fieldvaluedirectanswer.md) | (Optional) The data for the direct answer. The type of the data is determined by the Answers API based on whether the answer was found within a document or was a field value in the knowledge graph. | +| [result?](./search-headless.directanswerstate.result.md) | [FeaturedSnippetDirectAnswer](./search-headless.featuredsnippetdirectanswer.md) \| [FieldValueDirectAnswer](./search-headless.fieldvaluedirectanswer.md) | (Optional) The data for the direct answer. The type of the data is determined by the Search API based on whether the answer was found within a document or was a field value in the knowledge graph. | diff --git a/docs/search-headless.directanswerstate.result.md b/docs/search-headless.directanswerstate.result.md index d9d42f1a..28205ae7 100644 --- a/docs/search-headless.directanswerstate.result.md +++ b/docs/search-headless.directanswerstate.result.md @@ -4,7 +4,7 @@ ## DirectAnswerState.result property -The data for the direct answer. The type of the data is determined by the Answers API based on whether the answer was found within a document or was a field value in the knowledge graph. +The data for the direct answer. The type of the data is determined by the Search API based on whether the answer was found within a document or was a field value in the knowledge graph. Signature: diff --git a/docs/search-headless.locationstate.locationbias.md b/docs/search-headless.locationstate.locationbias.md index bcabbf02..9cb1bbda 100644 --- a/docs/search-headless.locationstate.locationbias.md +++ b/docs/search-headless.locationstate.locationbias.md @@ -4,7 +4,7 @@ ## LocationState.locationBias property -The geographical location bias used in the search, returned from the Answers API. +The geographical location bias used in the search, returned from the Search API. Signature: diff --git a/docs/search-headless.locationstate.md b/docs/search-headless.locationstate.md index aa922ad1..15500ebc 100644 --- a/docs/search-headless.locationstate.md +++ b/docs/search-headless.locationstate.md @@ -16,6 +16,6 @@ export interface LocationState | Property | Type | Description | | --- | --- | --- | -| [locationBias?](./search-headless.locationstate.locationbias.md) | [LocationBias](./search-headless.locationbias.md) | (Optional) The geographical location bias used in the search, returned from the Answers API. | +| [locationBias?](./search-headless.locationstate.locationbias.md) | [LocationBias](./search-headless.locationbias.md) | (Optional) The geographical location bias used in the search, returned from the Search API. | | [userLocation?](./search-headless.locationstate.userlocation.md) | [LatLong](./search-headless.latlong.md) | (Optional) The latitude and longitude of the user making the request. Used to bias the results. | diff --git a/docs/search-headless.md b/docs/search-headless.md index 847bb686..769094d4 100644 --- a/docs/search-headless.md +++ b/docs/search-headless.md @@ -80,7 +80,7 @@ | [LocationFilterDetails](./search-headless.locationfilterdetails.md) | Additional details relevant to the filter with "PLACE" for its [AppliedQueryFilterType](./search-headless.appliedqueryfiltertype.md). | | [LocationState](./search-headless.locationstate.md) | Maintains the user's location, if given, or the inferred location, that is used to bias search results. | | [LowerNumberRangeLimit](./search-headless.lowernumberrangelimit.md) | The start limit of [NumberRangeValue](./search-headless.numberrangevalue.md). | -| [MetaState](./search-headless.metastate.md) | Maintains the metadata for Answers Headless. | +| [MetaState](./search-headless.metastate.md) | Maintains the metadata for Search Headless. | | [NearFilterValue](./search-headless.nearfiltervalue.md) | A filter value for a filter with a $near [Matcher](./search-headless.matcher.md). | | [NumberRangeValue](./search-headless.numberrangevalue.md) | A filter value for a filter with a $between [Matcher](./search-headless.matcher.md). | | [ParentState](./search-headless.parentstate.md) | The overall shape of the redux state tree, with each key value pair of headlessId to [State](./search-headless.state.md) representing a single SearchHeadless instance. | diff --git a/docs/search-headless.metastate.md b/docs/search-headless.metastate.md index 1d19d501..32aae716 100644 --- a/docs/search-headless.metastate.md +++ b/docs/search-headless.metastate.md @@ -4,7 +4,7 @@ ## MetaState interface -Maintains the metadata for Answers Headless. +Maintains the metadata for Search Headless. Signature: @@ -18,6 +18,6 @@ export interface MetaState | --- | --- | --- | | [context?](./search-headless.metastate.context.md) | [Context](./search-headless.context.md) | (Optional) A JSON object used for passing data to and triggering Answers [Query Rules](https://hitchhikers.yext.com/tracks/answers-advanced/ans302-query-rules/). | | [referrerPageUrl?](./search-headless.metastate.referrerpageurl.md) | string | (Optional) The URL of the referring page (the page that directed to the current page from which the request was made). | -| [searchType](./search-headless.metastate.searchtype.md) | [SearchType](./search-headless.searchtype.md) | Indicates the type of search that Answers Headless is managing. | +| [searchType](./search-headless.metastate.searchtype.md) | [SearchType](./search-headless.searchtype.md) | Indicates the type of search that Search Headless is managing. | | [uuid?](./search-headless.metastate.uuid.md) | string | (Optional) A unique id which corresponds to the latest request/response. | diff --git a/docs/search-headless.metastate.searchtype.md b/docs/search-headless.metastate.searchtype.md index 4433a40b..0b2301bf 100644 --- a/docs/search-headless.metastate.searchtype.md +++ b/docs/search-headless.metastate.searchtype.md @@ -4,7 +4,7 @@ ## MetaState.searchType property -Indicates the type of search that Answers Headless is managing. +Indicates the type of search that Search Headless is managing. Signature: diff --git a/docs/search-headless.querystate.md b/docs/search-headless.querystate.md index a723d431..5af080be 100644 --- a/docs/search-headless.querystate.md +++ b/docs/search-headless.querystate.md @@ -19,7 +19,7 @@ export interface QueryState | [input?](./search-headless.querystate.input.md) | string | (Optional) The user input used for the next search query. | | [mostRecentSearch?](./search-headless.querystate.mostrecentsearch.md) | string | (Optional) The query of the most recent search. | | [queryId?](./search-headless.querystate.queryid.md) | string | (Optional) The ID of the query from the latest search. | -| [querySource?](./search-headless.querystate.querysource.md) | [QuerySource](./search-headless.querysource.md) | (Optional) The source of the query (from a standard Answers integration, an Answers overlay, or from visual autocomplete). | +| [querySource?](./search-headless.querystate.querysource.md) | [QuerySource](./search-headless.querysource.md) | (Optional) The source of the query (from a standard Search integration, an Search overlay, or from visual autocomplete). | | [queryTrigger?](./search-headless.querystate.querytrigger.md) | [QueryTrigger](./search-headless.querytrigger.md) | (Optional) How the query was triggered (besides user input). | -| [searchIntents?](./search-headless.querystate.searchintents.md) | [SearchIntent](./search-headless.searchintent.md)\[\] | (Optional) The computed intents of the mostRecentSearch, as returned by the Answers API. | +| [searchIntents?](./search-headless.querystate.searchintents.md) | [SearchIntent](./search-headless.searchintent.md)\[\] | (Optional) The computed intents of the mostRecentSearch, as returned by the Search API. | diff --git a/docs/search-headless.querystate.querysource.md b/docs/search-headless.querystate.querysource.md index 9abba4a6..2c2e5e23 100644 --- a/docs/search-headless.querystate.querysource.md +++ b/docs/search-headless.querystate.querysource.md @@ -4,7 +4,7 @@ ## QueryState.querySource property -The source of the query (from a standard Answers integration, an Answers overlay, or from visual autocomplete). +The source of the query (from a standard Search integration, an Search overlay, or from visual autocomplete). Signature: diff --git a/docs/search-headless.querystate.searchintents.md b/docs/search-headless.querystate.searchintents.md index f9a16a79..48dad570 100644 --- a/docs/search-headless.querystate.searchintents.md +++ b/docs/search-headless.querystate.searchintents.md @@ -4,7 +4,7 @@ ## QueryState.searchIntents property -The computed intents of the mostRecentSearch, as returned by the Answers API. +The computed intents of the mostRecentSearch, as returned by the Search API. Signature: diff --git a/docs/search-headless.state.md b/docs/search-headless.state.md index 52c607b5..3254e858 100644 --- a/docs/search-headless.state.md +++ b/docs/search-headless.state.md @@ -19,7 +19,7 @@ export interface State | [directAnswer](./search-headless.state.directanswer.md) | [DirectAnswerState](./search-headless.directanswerstate.md) | Maintains the direct answer associated with the latest search. | | [filters](./search-headless.state.filters.md) | [FiltersState](./search-headless.filtersstate.md) | Maintains the current state of facets and filters in the application. | | [location](./search-headless.state.location.md) | [LocationState](./search-headless.locationstate.md) | Maintains the user's location, if given, or the inferred location, that is used to bias search results. | -| [meta](./search-headless.state.meta.md) | [MetaState](./search-headless.metastate.md) | Maintains the metadata for Answers Headless. | +| [meta](./search-headless.state.meta.md) | [MetaState](./search-headless.metastate.md) | Maintains the metadata for Search Headless. | | [query](./search-headless.state.query.md) | [QueryState](./search-headless.querystate.md) | Maintains the latest query and its associated data. | | [queryRules](./search-headless.state.queryrules.md) | [QueryRulesState](./search-headless.queryrulesstate.md) | Maintains the data from the triggered query rules. | | [searchStatus](./search-headless.state.searchstatus.md) | [SearchStatusState](./search-headless.searchstatusstate.md) | Maintains the status of the latest search. | diff --git a/docs/search-headless.state.meta.md b/docs/search-headless.state.meta.md index 1b610f88..6570286e 100644 --- a/docs/search-headless.state.meta.md +++ b/docs/search-headless.state.meta.md @@ -4,7 +4,7 @@ ## State.meta property -Maintains the metadata for Answers Headless. +Maintains the metadata for Search Headless. Signature: diff --git a/src/models/slices/directanswer.ts b/src/models/slices/directanswer.ts index 9168c1cd..a657978b 100644 --- a/src/models/slices/directanswer.ts +++ b/src/models/slices/directanswer.ts @@ -8,7 +8,7 @@ import { FeaturedSnippetDirectAnswer, FieldValueDirectAnswer } from '@yext/answe export interface DirectAnswerState { /** * The data for the direct answer. The type of the data is determined by the - * Answers API based on whether the answer was found within a document or was a + * Search API based on whether the answer was found within a document or was a * field value in the knowledge graph. */ result?: FeaturedSnippetDirectAnswer | FieldValueDirectAnswer diff --git a/src/models/slices/location.ts b/src/models/slices/location.ts index 61847ff6..7923fa3a 100644 --- a/src/models/slices/location.ts +++ b/src/models/slices/location.ts @@ -9,7 +9,7 @@ import { LatLong, LocationBias } from '@yext/answers-core'; export interface LocationState { /** * The geographical location bias used in the search, returned from the - * Answers API. + * Search API. */ locationBias?: LocationBias, /** diff --git a/src/models/slices/meta.ts b/src/models/slices/meta.ts index 043b3f6f..9b24989c 100644 --- a/src/models/slices/meta.ts +++ b/src/models/slices/meta.ts @@ -2,7 +2,7 @@ import { Context } from '@yext/answers-core'; import { SearchType } from '../utils/searchType'; /** - * Maintains the metadata for Answers Headless. + * Maintains the metadata for Search Headless. * * @public */ @@ -22,7 +22,7 @@ export interface MetaState { */ uuid?: string, /** - * Indicates the type of search that Answers Headless is managing. + * Indicates the type of search that Search Headless is managing. */ searchType: SearchType } \ No newline at end of file diff --git a/src/models/slices/query.ts b/src/models/slices/query.ts index 41807949..aed59851 100644 --- a/src/models/slices/query.ts +++ b/src/models/slices/query.ts @@ -19,7 +19,7 @@ export interface QueryState { */ queryTrigger?: QueryTrigger, /** - * The source of the query (from a standard Answers integration, an Answers + * The source of the query (from a standard Search integration, an Search * overlay, or from visual autocomplete). */ querySource?: QuerySource, @@ -28,7 +28,7 @@ export interface QueryState { */ mostRecentSearch?: string, /** - * The computed intents of the mostRecentSearch, as returned by the Answers API. + * The computed intents of the mostRecentSearch, as returned by the Search API. */ searchIntents?: SearchIntent[] } \ No newline at end of file diff --git a/src/slices/searchstatus.ts b/src/slices/searchstatus.ts index 0167d190..e8d093aa 100644 --- a/src/slices/searchstatus.ts +++ b/src/slices/searchstatus.ts @@ -11,7 +11,7 @@ const reducers = { /** * Registers with Redux the slice of {@link State} pertaining to the loading status - * of Answers Headless. + * of Search Headless. */ export default function createSearchStatusSlice(prefix: string): Slice { return createSlice({ diff --git a/src/slices/sessiontracking.ts b/src/slices/sessiontracking.ts index acb238ef..c95a3237 100644 --- a/src/slices/sessiontracking.ts +++ b/src/slices/sessiontracking.ts @@ -16,7 +16,7 @@ const reducers = { /** * Registers with Redux the slice of {@link State} pertaining to session tracking of - * an Answers experience. + * an Search experience. */ export default function createSessionTrackingSlice( prefix: string diff --git a/src/utils/transform-filters.ts b/src/utils/transform-filters.ts index c68e2309..4a27eb97 100644 --- a/src/utils/transform-filters.ts +++ b/src/utils/transform-filters.ts @@ -19,8 +19,8 @@ function combineFiltersWithOR(filters: Filter[]): Filter | CombinedFilter { } /** - * Converts a list of {@link SelectableFilter}s used in Answers Headless - * to a single nested filter stucture used in Answers Core. + * Converts a list of {@link SelectableFilter}s used in Search Headless + * to a single nested filter stucture used in Search Core. * * @param selectableFilters - The filters to be transformed * @returns The filters in a singly-nested {@link CombinedFilter}, or if there diff --git a/tests/mocks/createMockedAnswersHeadless.ts b/tests/mocks/createMockedAnswersHeadless.ts index 865e3d31..27aadc4e 100644 --- a/tests/mocks/createMockedAnswersHeadless.ts +++ b/tests/mocks/createMockedAnswersHeadless.ts @@ -8,11 +8,11 @@ import HeadlessReducerManager from '../../src/headless-reducer-manager'; import { getHttpHeaders } from '../../src/utils/client-sdk-utils'; /** - * Creates an Answers Headless instance with a mocked Answers Core. + * Creates an Search Headless instance with a mocked Search Core. * - * @param mockedAnswersCore - Answers Core overrides - * @param initialState - The initial state of Answers Headless - * @returns The new Answers Headless instance + * @param mockedAnswersCore - Search Core overrides + * @param initialState - The initial state of Search Headless + * @returns The new Search Headless instance */ export function createMockedAnswersHeadless( mockedAnswersCore: any = {}, From 45581bfe8d265b36b450252b4dfa57326431d89b Mon Sep 17 00:00:00 2001 From: Cindy Yang Date: Tue, 12 Jul 2022 09:52:13 -0400 Subject: [PATCH 11/22] export from deprecated --- docs/search-headless.answersheadless.md | 16 +++++++ docs/search-headless.answersutilities.md | 16 +++++++ docs/search-headless.md | 3 ++ .../search-headless.provideanswersheadless.md | 18 ++++++++ docs/search-headless.provideheadless.md | 2 +- etc/search-headless.api.md | 9 ++++ src/deprecated.ts | 44 +++++++++---------- src/index.ts | 5 ++- 8 files changed, 88 insertions(+), 25 deletions(-) create mode 100644 docs/search-headless.answersheadless.md create mode 100644 docs/search-headless.answersutilities.md create mode 100644 docs/search-headless.provideanswersheadless.md diff --git a/docs/search-headless.answersheadless.md b/docs/search-headless.answersheadless.md new file mode 100644 index 00000000..69138d78 --- /dev/null +++ b/docs/search-headless.answersheadless.md @@ -0,0 +1,16 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [AnswersHeadless](./search-headless.answersheadless.md) + +## AnswersHeadless variable + +> Warning: This API is now obsolete. +> +> AnswersHeadless has been deprecated and renamed to SearchHeadless +> + +Signature: + +```typescript +AnswersHeadless: typeof SearchHeadless +``` diff --git a/docs/search-headless.answersutilities.md b/docs/search-headless.answersutilities.md new file mode 100644 index 00000000..3042e331 --- /dev/null +++ b/docs/search-headless.answersutilities.md @@ -0,0 +1,16 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [answersUtilities](./search-headless.answersutilities.md) + +## answersUtilities variable + +> Warning: This API is now obsolete. +> +> answersUtilities has been deprecated and renamed to searchUtilities +> + +Signature: + +```typescript +answersUtilities: typeof searchUtilities +``` diff --git a/docs/search-headless.md b/docs/search-headless.md index 769094d4..9cb86f2d 100644 --- a/docs/search-headless.md +++ b/docs/search-headless.md @@ -127,7 +127,10 @@ | Variable | Description | | --- | --- | +| [AnswersHeadless](./search-headless.answersheadless.md) | | +| [answersUtilities](./search-headless.answersutilities.md) | | | [DEFAULT\_HEADLESS\_ID](./search-headless.default_headless_id.md) | The headlessId automatically given to the first SearchHeadless instance created. | +| [provideAnswersHeadless](./search-headless.provideanswersheadless.md) | Supplies a new instance of [SearchHeadless](./search-headless.searchheadless.md), using the provided configuration. | | [SandboxEndpoints](./search-headless.sandboxendpoints.md) | The endpoints to use for sandbox experiences. | ## Type Aliases diff --git a/docs/search-headless.provideanswersheadless.md b/docs/search-headless.provideanswersheadless.md new file mode 100644 index 00000000..7c1280ea --- /dev/null +++ b/docs/search-headless.provideanswersheadless.md @@ -0,0 +1,18 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [provideAnswersHeadless](./search-headless.provideanswersheadless.md) + +## provideAnswersHeadless variable + +> Warning: This API is now obsolete. +> +> provideAnswersHeadless has been deprecated and renamed to provideHeadless +> + +Supplies a new instance of [SearchHeadless](./search-headless.searchheadless.md), using the provided configuration. + +Signature: + +```typescript +provideAnswersHeadless: typeof provideHeadless +``` diff --git a/docs/search-headless.provideheadless.md b/docs/search-headless.provideheadless.md index 6b16dac9..79dbf187 100644 --- a/docs/search-headless.provideheadless.md +++ b/docs/search-headless.provideheadless.md @@ -16,7 +16,7 @@ export declare function provideHeadless(config: HeadlessConfig): SearchHeadless; | Parameter | Type | Description | | --- | --- | --- | -| config | [HeadlessConfig](./search-headless.headlessconfig.md) | The apiKey, experienceKey, etc. needed to set up a front-end Answers experience. | +| config | [HeadlessConfig](./search-headless.headlessconfig.md) | The apiKey, experienceKey, etc. needed to set up a front-end Search experience. | Returns: diff --git a/etc/search-headless.api.md b/etc/search-headless.api.md index d98690dc..75d31c54 100644 --- a/etc/search-headless.api.md +++ b/etc/search-headless.api.md @@ -52,11 +52,17 @@ export class AnswersError extends Error { /* Excluded from this release type: __constructor */ } +// @public @deprecated (undocumented) +export const AnswersHeadless: typeof SearchHeadless; + // @public export interface AnswersRequest { additionalHttpHeaders?: AdditionalHttpHeaders; } +// @public @deprecated (undocumented) +export const answersUtilities: typeof searchUtilities; + // @public export interface AppliedQueryFilter { details?: LocationFilterDetails; @@ -420,6 +426,9 @@ export interface ParentState { [headlessId: string]: State; } +// @public @deprecated +export const provideAnswersHeadless: typeof provideHeadless; + // Warning: (ae-internal-mixed-release-tag) Mixed release tags are not allowed for "provideHeadless" because one of its declarations is marked as @internal // // @public diff --git a/src/deprecated.ts b/src/deprecated.ts index 3687a16f..1775d586 100644 --- a/src/deprecated.ts +++ b/src/deprecated.ts @@ -1,29 +1,29 @@ -import { searchUtilities, provideHeadless } from "."; -import SearchHeadless from "./search-headless"; +import { searchUtilities, provideHeadless } from '.'; +import SearchHeadless from './search-headless' /** * @public * * @deprecated answersUtilities has been deprecated and renamed to searchUtilities */ - export const answersUtilities = searchUtilities; +export const answersUtilities = searchUtilities; - /** - * Supplies a new instance of {@link SearchHeadless}, using the provided configuration. - * - * @param config - The apiKey, experienceKey, etc. needed to set up a front-end Answers - * experience. - * @returns The newly created instance of {@link SearchHeadless} - * - * @public - * - * @deprecated provideAnswersHeadless has been deprecated and renamed to provideHeadless - */ - export const provideAnswersHeadless = provideHeadless; - - /** - * @public - * - * @deprecated AnswersHeadless has been deprecated and renamed to SearchHeadless - */ - export const AnswersHeadless = SearchHeadless; \ No newline at end of file +/** + * Supplies a new instance of {@link SearchHeadless}, using the provided configuration. + * + * @param config - The apiKey, experienceKey, etc. needed to set up a front-end Answers + * experience. + * @returns The newly created instance of {@link SearchHeadless} + * + * @public + * + * @deprecated provideAnswersHeadless has been deprecated and renamed to provideHeadless + */ +export const provideAnswersHeadless = provideHeadless; + +/** + * @public + * + * @deprecated AnswersHeadless has been deprecated and renamed to SearchHeadless + */ +export const AnswersHeadless = SearchHeadless; \ No newline at end of file diff --git a/src/index.ts b/src/index.ts index 47a84db8..a9f19d2b 100644 --- a/src/index.ts +++ b/src/index.ts @@ -14,6 +14,7 @@ export * from './models'; export * from './constants'; export * from './utils/filter-creators'; export * from './utils/types'; +export * from './deprecated' export { searchUtilities }; /** @@ -43,7 +44,7 @@ const headlessReducerManager = new HeadlessReducerManager(); /** * Supplies a new instance of {@link SearchHeadless}, using the provided configuration. * - * @param config - The apiKey, experienceKey, etc. needed to set up a front-end Answers + * @param config - The apiKey, experienceKey, etc. needed to set up a front-end Search * experience. * @returns The newly created instance of {@link SearchHeadless} * @@ -55,7 +56,7 @@ export function provideHeadless(config: HeadlessConfig): SearchHeadless; * Supplies a new instance of {@link SearchHeadless}, using the provided configuration, * and accepts additional HTTP headers to pass with API requests. * - * @param config - The apiKey, experienceKey, etc. needed to set up a front-end Answers + * @param config - The apiKey, experienceKey, etc. needed to set up a front-end Search * experience * @param additionalHttpHeaders - Additional value for specific HTTP headers * @returns The newly created instance of {@link SearchHeadless} From e201e475ec49a10cd406a5663f676769c2681f4f Mon Sep 17 00:00:00 2001 From: Cindy Yang Date: Tue, 12 Jul 2022 10:09:29 -0400 Subject: [PATCH 12/22] renamed files --- src/deprecated.ts | 2 +- src/index.ts | 2 +- tests/.DS_Store | Bin 0 -> 6148 bytes ...deSearchHeadless.ts => provideHeadless.ts} | 0 tests/integration/directanswer.ts | 8 ++--- tests/integration/facets.ts | 28 +++++++++--------- tests/integration/location.ts | 10 +++---- tests/integration/meta.ts | 12 ++++---- tests/integration/query.ts | 8 ++--- tests/integration/queryrules.ts | 6 ++-- tests/integration/sortbys.ts | 4 +-- tests/integration/spellcheck.ts | 8 ++--- tests/integration/status.ts | 6 ++-- tests/integration/universalsearch.ts | 12 ++++---- tests/integration/verticalsearch.ts | 22 +++++++------- ...ersHeadless.ts => createMockedHeadless.ts} | 2 +- 16 files changed, 65 insertions(+), 65 deletions(-) create mode 100644 tests/.DS_Store rename tests/acceptance/{provideSearchHeadless.ts => provideHeadless.ts} (100%) rename tests/mocks/{createMockedAnswersHeadless.ts => createMockedHeadless.ts} (96%) diff --git a/src/deprecated.ts b/src/deprecated.ts index 1775d586..00bc4cda 100644 --- a/src/deprecated.ts +++ b/src/deprecated.ts @@ -1,5 +1,5 @@ import { searchUtilities, provideHeadless } from '.'; -import SearchHeadless from './search-headless' +import SearchHeadless from './search-headless'; /** * @public diff --git a/src/index.ts b/src/index.ts index a9f19d2b..1e0b233e 100644 --- a/src/index.ts +++ b/src/index.ts @@ -14,7 +14,7 @@ export * from './models'; export * from './constants'; export * from './utils/filter-creators'; export * from './utils/types'; -export * from './deprecated' +export * from './deprecated'; export { searchUtilities }; /** diff --git a/tests/.DS_Store b/tests/.DS_Store new file mode 100644 index 0000000000000000000000000000000000000000..e0ae54f0eb30992b05daab6f708cccc7ab025927 GIT binary patch literal 6148 zcmeHKIc~#13?v;FhTW)4xnIZ+7KZWyeZYYdqzPmrh*PV|yZkf{4;VJ26e-*ULx7xJ zE@uTzA&MfR+vDq#NFyRExS{-5n3|oNPi&DH1;TO1LB8Zg2I=K(QaztA?i!rlIamDe z?sNFq5ASjJJegT4Kn17(6`%rC;Li$J?}e>4fs9mu3Q&QI0``3Eo^g9;3)=7^y|N4{iTO&kM*E}FxK=94ui6!oX${^I4LHIR`C zP=Q+o9%9>A|9^)6GXLL_xT6A8;9n`A%eHH`c%|&Elb5qzTi`pm)tumFSUUy5+cD7F hF*eqYAH68*imh>86URWOBkyz|e+En!8Wp&=0%s-p6?6aq literal 0 HcmV?d00001 diff --git a/tests/acceptance/provideSearchHeadless.ts b/tests/acceptance/provideHeadless.ts similarity index 100% rename from tests/acceptance/provideSearchHeadless.ts rename to tests/acceptance/provideHeadless.ts diff --git a/tests/integration/directanswer.ts b/tests/integration/directanswer.ts index c7ad3311..b92d7efc 100644 --- a/tests/integration/directanswer.ts +++ b/tests/integration/directanswer.ts @@ -1,4 +1,4 @@ -import { createMockedAnswersHeadless } from '../mocks/createMockedAnswersHeadless'; +import { createMockedHeadless } from '../mocks/createMockedHeadless'; import { FeaturedSnippetDirectAnswer, DirectAnswerType, Source } from '@yext/answers-core'; import { State } from '../../src/models/state'; import { SearchTypeEnum } from '../../src/models/utils/searchType'; @@ -40,7 +40,7 @@ const featuredSnippedDirectAnswer: FeaturedSnippetDirectAnswer = { describe('AnswersHeadless spellcheck interactions properly update state', () => { it('executeVerticalQuery properly updates direct answer state', async () => { - const answers = createMockedAnswersHeadless({ + const answers = createMockedHeadless({ verticalSearch: () => Promise.resolve({ directAnswer: featuredSnippedDirectAnswer }) }, initialState); answers.setVertical('123'); @@ -59,7 +59,7 @@ describe('AnswersHeadless spellcheck interactions properly update state', () => }); it('executeUniversalQuery properly updates direct answer state', async () => { - const answers = createMockedAnswersHeadless({ + const answers = createMockedHeadless({ universalSearch: () => Promise.resolve({ directAnswer: featuredSnippedDirectAnswer }) }, initialState); answers.setUniversal(); @@ -79,7 +79,7 @@ describe('AnswersHeadless spellcheck interactions properly update state', () => ...initialState, directAnswer: { result: featuredSnippedDirectAnswer } }; - const answers = createMockedAnswersHeadless({ + const answers = createMockedHeadless({ universalSearch: () => Promise.resolve({ directAnswer: undefined }) }, initialStateWithDA); answers.setUniversal(); diff --git a/tests/integration/facets.ts b/tests/integration/facets.ts index 53dddd1e..f8fd3923 100644 --- a/tests/integration/facets.ts +++ b/tests/integration/facets.ts @@ -1,11 +1,11 @@ import { DisplayableFacet, DisplayableFacetOption, Matcher } from '@yext/answers-core'; import { State } from '../../src/models/state'; import { SearchTypeEnum } from '../../src/models/utils/searchType'; -import { createMockedAnswersHeadless } from '../mocks/createMockedAnswersHeadless'; +import { createMockedHeadless } from '../mocks/createMockedHeadless'; it('can select a facet option', () => { const [initialState, facetOption] = createInitialState(false); - const answers = createMockedAnswersHeadless({}, initialState); + const answers = createMockedHeadless({}, initialState); answers.setFacetOption('testFieldId', facetOption, true); expect(answers.state.filters.facets[0].options[0]).toEqual({ matcher: Matcher.Equals, @@ -23,7 +23,7 @@ it('handles multiple facets with the same fieldId', () => { fieldId: 'testFieldId', options: [{ ...facetOption }] }); - const answers = createMockedAnswersHeadless({}, initialState); + const answers = createMockedHeadless({}, initialState); answers.setFacetOption('testFieldId', facetOption, true); expect(answers.state.filters.facets).toEqual([ { @@ -54,7 +54,7 @@ it('handles multiple facets with the same fieldId', () => { it('handles selecting multiple facetOptions at the same time', () => { const [initialState, facetOption] = createInitialState(false); initialState.filters.facets[0].options.push({ ...facetOption }); - const answers = createMockedAnswersHeadless({}, initialState); + const answers = createMockedHeadless({}, initialState); answers.setFacetOption('testFieldId', facetOption, true); expect(answers.state.filters.facets[0].options).toEqual([ { @@ -76,7 +76,7 @@ it('handles selecting multiple facetOptions at the same time', () => { it('can unselect a facet option', () => { const [initialState, facetOption] = createInitialState(true); - const answers = createMockedAnswersHeadless({}, initialState); + const answers = createMockedHeadless({}, initialState); answers.setFacetOption('testFieldId', facetOption, false); expect(answers.state.filters.facets[0].options[0]).toEqual({ matcher: Matcher.Equals, @@ -89,7 +89,7 @@ it('can unselect a facet option', () => { it('gives a console warning when facets do not exist in state', () => { const consoleWarnSpy = jest.spyOn(global.console, 'warn').mockImplementation(); - const answers = createMockedAnswersHeadless(); + const answers = createMockedHeadless(); answers.setFacetOption('testFieldId', {} as DisplayableFacetOption, true); expect(consoleWarnSpy).toHaveBeenCalledTimes(1); consoleWarnSpy.mockClear(); @@ -98,7 +98,7 @@ it('gives a console warning when facets do not exist in state', () => { it('gives a console warning when the facet option\'s fieldId is not found in state', () => { const consoleWarnSpy = jest.spyOn(global.console, 'warn').mockImplementation(); const [initialState] = createInitialState(true); - const answers = createMockedAnswersHeadless({}, initialState); + const answers = createMockedHeadless({}, initialState); answers.setFacetOption('fakeFieldId', {} as DisplayableFacetOption, true); expect(consoleWarnSpy).toHaveBeenCalledTimes(1); consoleWarnSpy.mockClear(); @@ -121,7 +121,7 @@ it('facets are updated after a vertical search', async () => { query: { input: 'test query' }, spellCheck: { enabled: true } }; - const answers = createMockedAnswersHeadless(mockAnswersCore, initialState); + const answers = createMockedHeadless(mockAnswersCore, initialState); expect(answers.state.filters.facets).toEqual(undefined); answers.setVertical('vertical-key'); await answers.executeVerticalQuery(); @@ -144,7 +144,7 @@ it('only selected facets are sent in the vertical search request', () => { const mockedCore = { verticalSearch: jest.fn(() => { return {}; }) }; - const answers = createMockedAnswersHeadless(mockedCore, initialState); + const answers = createMockedHeadless(mockedCore, initialState); answers.setVertical('vertical-key'); answers.setFacets(initialState.filters.facets); answers.executeVerticalQuery(); @@ -178,7 +178,7 @@ it('searchThroughFacet filters facet options correctly', () => { ...facetOption, displayName: 'ignore me' }); - const answers = createMockedAnswersHeadless({}, initialState); + const answers = createMockedHeadless({}, initialState); const facet = answers.state.filters.facets[0]; const searchedFacet = answers.utilities.searchThroughFacet(facet, 'cation'); expect(searchedFacet).toEqual({ @@ -211,7 +211,7 @@ it('searchThroughFacet filters facet options correctly for similar searchTerm', ...facetOption, displayName: 'Cation' }); - const answers = createMockedAnswersHeadless({}, initialState); + const answers = createMockedHeadless({}, initialState); const facet = answers.state.filters.facets[0]; const searchedFacet = answers.utilities.searchThroughFacet(facet, 'car'); expect(searchedFacet).toEqual({ @@ -248,7 +248,7 @@ it('searchThroughFacet filters facet options correctly for short searchTerm', () ...facetOption, displayName: 'ignore me' }); - const answers = createMockedAnswersHeadless({}, initialState); + const answers = createMockedHeadless({}, initialState); const facet = answers.state.filters.facets[0]; const searchedFacet = answers.utilities.searchThroughFacet(facet, 'ca'); expect(searchedFacet).toEqual({ @@ -273,7 +273,7 @@ it('searchThroughFacet filters facet options correctly for short searchTerm', () it('can set facets correctly', () => { const [initialState, facetOption] = createInitialState(true); - const answers = createMockedAnswersHeadless({}, initialState); + const answers = createMockedHeadless({}, initialState); const facets = [ { fieldId: 'newFieldId', @@ -287,7 +287,7 @@ it('can set facets correctly', () => { it('can reset facets correctly', () => { const [initialState, ] = createInitialState(true); - const answers = createMockedAnswersHeadless({}, initialState); + const answers = createMockedHeadless({}, initialState); answers.resetFacets(); answers.state.filters.facets.map(facet => facet.options.map(option => expect(option.selected).toBeFalsy()) diff --git a/tests/integration/location.ts b/tests/integration/location.ts index df20bcce..686fed4c 100644 --- a/tests/integration/location.ts +++ b/tests/integration/location.ts @@ -1,5 +1,5 @@ import { VerticalSearchRequest, UniversalSearchRequest, LocationBias, LocationBiasMethod, LatLong } from '@yext/answers-core'; -import { createMockedAnswersHeadless } from '../mocks/createMockedAnswersHeadless'; +import { createMockedHeadless } from '../mocks/createMockedHeadless'; describe('userLocation', () => { it('vertical searches pass userLocation', async () => { @@ -8,7 +8,7 @@ describe('userLocation', () => { longitude: 1 }; const mockSearch = jest.fn((_request: VerticalSearchRequest) => Promise.resolve({})); - const answers = createMockedAnswersHeadless({ + const answers = createMockedHeadless({ verticalSearch: mockSearch }); answers.setVertical('vertical-key'); @@ -23,7 +23,7 @@ describe('userLocation', () => { longitude: 1 }; const mockSearch = jest.fn((_request: UniversalSearchRequest) => Promise.resolve({})); - const answers = createMockedAnswersHeadless({ + const answers = createMockedHeadless({ universalSearch: mockSearch }); answers.setUserLocation(userLocation); @@ -41,7 +41,7 @@ describe('locationBias', () => { method: LocationBiasMethod.Ip }; const mockSearch = jest.fn((_request: VerticalSearchRequest) => Promise.resolve({ locationBias })); - const answers = createMockedAnswersHeadless({ + const answers = createMockedHeadless({ verticalSearch: mockSearch }); answers.setVertical('vertical-key'); @@ -58,7 +58,7 @@ describe('locationBias', () => { method: LocationBiasMethod.Ip }; const mockSearch = jest.fn((_request: UniversalSearchRequest) => Promise.resolve({ locationBias })); - const answers = createMockedAnswersHeadless({ + const answers = createMockedHeadless({ universalSearch: mockSearch }); expect(answers.state.location.locationBias).toEqual(undefined); diff --git a/tests/integration/meta.ts b/tests/integration/meta.ts index 3c0bc8d9..69fc400a 100644 --- a/tests/integration/meta.ts +++ b/tests/integration/meta.ts @@ -1,9 +1,9 @@ import { UniversalSearchRequest, VerticalSearchRequest } from '@yext/answers-core'; -import { createMockedAnswersHeadless } from '../mocks/createMockedAnswersHeadless'; +import { createMockedHeadless } from '../mocks/createMockedHeadless'; it('by default no meta attributes are sent', async () => { const mockSearch = jest.fn((_request: VerticalSearchRequest) => Promise.resolve({})); - const answers = createMockedAnswersHeadless({ + const answers = createMockedHeadless({ verticalSearch: mockSearch }); answers.setQuery('lol'); @@ -15,7 +15,7 @@ it('by default no meta attributes are sent', async () => { it('vertical searches send meta data', async () => { const mockSearch = jest.fn((_request: VerticalSearchRequest) => Promise.resolve({})); - const answers = createMockedAnswersHeadless({ + const answers = createMockedHeadless({ verticalSearch: mockSearch }); answers.setQuery('lol'); @@ -39,7 +39,7 @@ it('vertical searches send meta data', async () => { it('universal searches send context', async () => { const mockSearch = jest.fn((_request: UniversalSearchRequest) => Promise.resolve({})); - const answers = createMockedAnswersHeadless({ + const answers = createMockedHeadless({ universalSearch: mockSearch }); answers.setQuery('lol'); @@ -65,7 +65,7 @@ it('universal searches update the uuid', async () => { const mockSearch = jest.fn((_request: UniversalSearchRequest) => Promise.resolve({ uuid: 123 })); - const answers = createMockedAnswersHeadless({ + const answers = createMockedHeadless({ universalSearch: mockSearch }); answers.setUniversal(); @@ -78,7 +78,7 @@ it('vertical searches update the uuid', async () => { const mockSearch = jest.fn((_request: UniversalSearchRequest) => Promise.resolve({ uuid: 456 })); - const answers = createMockedAnswersHeadless({ + const answers = createMockedHeadless({ verticalSearch: mockSearch }); answers.setQuery('lol'); diff --git a/tests/integration/query.ts b/tests/integration/query.ts index 190eebdb..457f97f7 100644 --- a/tests/integration/query.ts +++ b/tests/integration/query.ts @@ -6,7 +6,7 @@ import { import HttpManager from '../../src/http-manager'; import ReduxStateManager from '../../src/redux-state-manager'; import SearchHeadless from '../../src/search-headless'; -import { createMockedAnswersHeadless } from '../mocks/createMockedAnswersHeadless'; +import { createMockedHeadless } from '../mocks/createMockedHeadless'; import { createBaseStore } from '../../src/store'; import { DEFAULT_HEADLESS_ID } from '../../src/constants'; import HeadlessReducerManager from '../../src/headless-reducer-manager'; @@ -15,7 +15,7 @@ it('vertical searches set search intents', async () => { const mockSearch = jest.fn((_request: VerticalSearchRequest) => Promise.resolve({ searchIntents: [SearchIntent.NearMe] })); - const answers = createMockedAnswersHeadless({ + const answers = createMockedHeadless({ verticalSearch: mockSearch }); answers.setVertical('vertical-key'); @@ -28,7 +28,7 @@ it('universal searches set search intents', async () => { const mockSearch = jest.fn((_request: UniversalSearchRequest) => Promise.resolve({ searchIntents: [SearchIntent.NearMe] })); - const answers = createMockedAnswersHeadless({ + const answers = createMockedHeadless({ universalSearch: mockSearch }); expect(answers.state.query.searchIntents).toEqual(undefined); @@ -39,7 +39,7 @@ it('universal searches set search intents', async () => { describe('sessionId to request works as expected', () => { const verticalMockSearch = jest.fn().mockReturnValue({}); const universalMockSearch = jest.fn().mockReturnValue({}); - const answers = createMockedAnswersHeadless({ + const answers = createMockedHeadless({ verticalSearch: verticalMockSearch, universalSearch: universalMockSearch }); diff --git a/tests/integration/queryrules.ts b/tests/integration/queryrules.ts index 2a0907ad..179e8eb1 100644 --- a/tests/integration/queryrules.ts +++ b/tests/integration/queryrules.ts @@ -1,4 +1,4 @@ -import { createMockedAnswersHeadless } from '../mocks/createMockedAnswersHeadless'; +import { createMockedHeadless } from '../mocks/createMockedHeadless'; const initialState = { queryRules: { @@ -30,7 +30,7 @@ function mockSearchWithQueryRules() { describe('AnswersHeadless queryRules interactions properly update state', () => { it('executeVerticalQuery properly updates queryRules state', async () => { - const answers = createMockedAnswersHeadless({ + const answers = createMockedHeadless({ verticalSearch: mockSearchWithQueryRules }, initialState); answers.setVertical('123'); @@ -45,7 +45,7 @@ describe('AnswersHeadless queryRules interactions properly update state', () => }); it('executeUniversalQuery properly updates queryRules state', async () => { - const answers = createMockedAnswersHeadless({ + const answers = createMockedHeadless({ universalSearch: mockSearchWithQueryRules }, initialState); answers.setUniversal(); diff --git a/tests/integration/sortbys.ts b/tests/integration/sortbys.ts index f5db95a9..814525ca 100644 --- a/tests/integration/sortbys.ts +++ b/tests/integration/sortbys.ts @@ -1,9 +1,9 @@ import { Direction, SortType, VerticalSearchRequest } from '@yext/answers-core'; -import { createMockedAnswersHeadless } from '../mocks/createMockedAnswersHeadless'; +import { createMockedHeadless } from '../mocks/createMockedHeadless'; it('executeVerticalQuery properly updates spellcheck state', async () => { const mockSearch = jest.fn((_request: VerticalSearchRequest) => Promise.resolve({})); - const answers = createMockedAnswersHeadless({ + const answers = createMockedHeadless({ verticalSearch: mockSearch }); answers.setQuery('lol'); diff --git a/tests/integration/spellcheck.ts b/tests/integration/spellcheck.ts index 27b3310e..e8a11a03 100644 --- a/tests/integration/spellcheck.ts +++ b/tests/integration/spellcheck.ts @@ -1,4 +1,4 @@ -import { createMockedAnswersHeadless } from '../mocks/createMockedAnswersHeadless'; +import { createMockedHeadless } from '../mocks/createMockedHeadless'; const initialState = { query: { @@ -27,7 +27,7 @@ function mockSearchWithSpellcheck() { describe('AnswersHeadless spellcheck interactions properly update state', () => { it('executeVerticalQuery properly updates spellcheck state', async () => { - const answers = createMockedAnswersHeadless({ + const answers = createMockedHeadless({ verticalSearch: mockSearchWithSpellcheck }, initialState); answers.setVertical('123'); @@ -46,7 +46,7 @@ describe('AnswersHeadless spellcheck interactions properly update state', () => }); it('executeUniversalQuery properly updates spellcheck state', async () => { - const answers = createMockedAnswersHeadless({ + const answers = createMockedHeadless({ universalSearch: mockSearchWithSpellcheck }, initialState); answers.setUniversal(); @@ -62,7 +62,7 @@ describe('AnswersHeadless spellcheck interactions properly update state', () => }); it('setSpellCheckEnabled properly updates state', async () => { - const answers = createMockedAnswersHeadless({}, initialState); + const answers = createMockedHeadless({}, initialState); await answers.setSpellCheckEnabled(false); const expectedState = { spellCheck: { diff --git a/tests/integration/status.ts b/tests/integration/status.ts index a3c7e24c..4ea7528f 100644 --- a/tests/integration/status.ts +++ b/tests/integration/status.ts @@ -1,10 +1,10 @@ import { UniversalSearchRequest, VerticalSearchRequest } from '@yext/answers-core'; -import { createMockedAnswersHeadless } from '../mocks/createMockedAnswersHeadless'; +import { createMockedHeadless } from '../mocks/createMockedHeadless'; import setTimeout from '../utils/setTimeout'; it('universal searches update the search loading state', async () => { const mockSearch = createMockSearch(); - const answers = createMockedAnswersHeadless({ + const answers = createMockedHeadless({ universalSearch: mockSearch }); @@ -16,7 +16,7 @@ it('universal searches update the search loading state', async () => { it('vertical searches update the search loading state', async () => { const mockSearch = createMockSearch(); - const answers = createMockedAnswersHeadless({ + const answers = createMockedHeadless({ verticalSearch: mockSearch }); answers.setVertical('vertical-key'); diff --git a/tests/integration/universalsearch.ts b/tests/integration/universalsearch.ts index b4f56731..eb25f7b2 100644 --- a/tests/integration/universalsearch.ts +++ b/tests/integration/universalsearch.ts @@ -1,12 +1,12 @@ import { UniversalSearchRequest } from '@yext/answers-core'; import HttpManager from '../../src/http-manager'; import { getHttpHeaders } from '../../src/utils/client-sdk-utils'; -import { createMockedAnswersHeadless } from '../mocks/createMockedAnswersHeadless'; +import { createMockedHeadless } from '../mocks/createMockedHeadless'; import setTimeout from '../utils/setTimeout'; it('universal searches send blank queries by default', async () => { const mockSearch = createMockSearch(); - const answers = createMockedAnswersHeadless({ + const answers = createMockedHeadless({ universalSearch: mockSearch }); await answers.executeUniversalQuery(); @@ -14,7 +14,7 @@ it('universal searches send blank queries by default', async () => { }); it('answers.setUniversalLimit sets the universal limit when a UniversalLimit is passed to it', () => { - const answers = createMockedAnswersHeadless(); + const answers = createMockedHeadless(); const universalLimit = { faq: 5, people: 5 @@ -25,7 +25,7 @@ it('answers.setUniversalLimit sets the universal limit when a UniversalLimit is it('answers.setRestrictVerticals sets the restrictVerticals param', async () => { const mockSearch = createMockSearch(); - const answers = createMockedAnswersHeadless({ + const answers = createMockedHeadless({ universalSearch: mockSearch }); answers.setRestrictVerticals(['KM', 'people']); @@ -37,7 +37,7 @@ it('handle a rejected promise from core', async () => { const mockSearch = createMockRejectedSearch(); const mockCore = { universalSearch: mockSearch }; const httpManager = new HttpManager(); - const answers = createMockedAnswersHeadless(mockCore, {}, undefined, undefined, httpManager); + const answers = createMockedHeadless(mockCore, {}, undefined, undefined, httpManager); try { await answers.executeUniversalQuery(); } catch (e) { @@ -49,7 +49,7 @@ it('handle a rejected promise from core', async () => { it('executeUniversalQuery passes the additional HTTP headers', async () => { const mockSearch = createMockSearch(); - const answers = createMockedAnswersHeadless({ + const answers = createMockedHeadless({ universalSearch: mockSearch }); await answers.executeUniversalQuery(); diff --git a/tests/integration/verticalsearch.ts b/tests/integration/verticalsearch.ts index 7ea837ba..6241ed88 100644 --- a/tests/integration/verticalsearch.ts +++ b/tests/integration/verticalsearch.ts @@ -4,7 +4,7 @@ import { AllResultsForVertical } from '../../src/models/slices/vertical'; import { State } from '../../src/models/state'; import { SearchTypeEnum } from '../../src/models/utils/searchType'; import { getHttpHeaders } from '../../src/utils/client-sdk-utils'; -import { createMockedAnswersHeadless } from '../mocks/createMockedAnswersHeadless'; +import { createMockedHeadless } from '../mocks/createMockedHeadless'; import setTimeout from '../utils/setTimeout'; const initialState: State = { @@ -60,7 +60,7 @@ const allResultsForVertical: VerticalSearchResponse = { }; it('vertical searches set allResultsForVertical and alternativeVerticals', async () => { - const answers = createMockedAnswersHeadless({ + const answers = createMockedHeadless({ verticalSearch: () => Promise.resolve({ allResultsForVertical, alternativeVerticals, @@ -89,7 +89,7 @@ it('vertical searches set appliedQueryFilters', async () => { value: 42 } }]; - const answers = createMockedAnswersHeadless({ + const answers = createMockedHeadless({ verticalSearch: () => Promise.resolve({ verticalResults: { appliedQueryFilters: mockAppliedQueryFilters @@ -101,7 +101,7 @@ it('vertical searches set appliedQueryFilters', async () => { }); it('vertical searches set queryDurationMillis', async () => { - const answers = createMockedAnswersHeadless({ + const answers = createMockedHeadless({ verticalSearch: () => Promise.resolve({ verticalResults: { queryDurationMillis: 42 @@ -117,7 +117,7 @@ it('vertical searches set results', async () => { rawData: { test: 'hello' }, source: Source.KnowledgeManager }]; - const answers = createMockedAnswersHeadless({ + const answers = createMockedHeadless({ verticalSearch: () => Promise.resolve({ verticalResults: { results: mockResults @@ -129,7 +129,7 @@ it('vertical searches set results', async () => { }); it('vertical searches set results count', async () => { - const answers = createMockedAnswersHeadless({ + const answers = createMockedHeadless({ verticalSearch: () => Promise.resolve({ verticalResults: { resultsCount: 3 @@ -141,7 +141,7 @@ it('vertical searches set results count', async () => { }); it('vertical searches set the source', async () => { - const answers = createMockedAnswersHeadless({ + const answers = createMockedHeadless({ verticalSearch: () => Promise.resolve({ verticalResults: { source: Source.KnowledgeManager @@ -154,7 +154,7 @@ it('vertical searches set the source', async () => { it('vertical searches send blank queries by default', async () => { const mockSearch = createMockSearch(); - const answers = createMockedAnswersHeadless({ + const answers = createMockedHeadless({ verticalSearch: mockSearch }); answers.setVertical('vertical-key'); @@ -163,7 +163,7 @@ it('vertical searches send blank queries by default', async () => { }); it('answers.setVerticalLimit sets the vertical limit when a number is passed to it', () => { - const answers = createMockedAnswersHeadless(); + const answers = createMockedHeadless(); answers.setVerticalLimit(7); expect(answers.state.vertical.limit).toEqual(7); }); @@ -173,7 +173,7 @@ it('handle a rejected promise from core', async () => { const mockSearch = createMockRejectedSearch(); const mockCore = { verticalSearch: mockSearch }; const httpManager = new HttpManager(); - const answers = createMockedAnswersHeadless(mockCore, {}, undefined, undefined, httpManager); + const answers = createMockedHeadless(mockCore, {}, undefined, undefined, httpManager); answers.setVertical('vertical-key'); try { await answers.executeVerticalQuery(); @@ -186,7 +186,7 @@ it('handle a rejected promise from core', async () => { it('executeVerticalQuery passes the additional HTTP headers', async () => { const mockSearch = createMockSearch(); - const answers = createMockedAnswersHeadless({ + const answers = createMockedHeadless({ verticalSearch: mockSearch }); answers.setVertical('vertical-key'); diff --git a/tests/mocks/createMockedAnswersHeadless.ts b/tests/mocks/createMockedHeadless.ts similarity index 96% rename from tests/mocks/createMockedAnswersHeadless.ts rename to tests/mocks/createMockedHeadless.ts index 27aadc4e..4e8a7a82 100644 --- a/tests/mocks/createMockedAnswersHeadless.ts +++ b/tests/mocks/createMockedHeadless.ts @@ -14,7 +14,7 @@ import { getHttpHeaders } from '../../src/utils/client-sdk-utils'; * @param initialState - The initial state of Search Headless * @returns The new Search Headless instance */ -export function createMockedAnswersHeadless( +export function createMockedHeadless( mockedAnswersCore: any = {}, initialState: Partial = {}, store?: HeadlessEnhancedStore, From f01c21010e5040095d0451955f679542a5078da9 Mon Sep 17 00:00:00 2001 From: Cindy Yang Date: Tue, 12 Jul 2022 11:41:53 -0400 Subject: [PATCH 13/22] file edits --- .gitignore | 3 ++- tests/unit/{answers-headless.ts => search-headless.ts} | 0 2 files changed, 2 insertions(+), 1 deletion(-) rename tests/unit/{answers-headless.ts => search-headless.ts} (100%) diff --git a/.gitignore b/.gitignore index d40ffbd0..018c4180 100644 --- a/.gitignore +++ b/.gitignore @@ -1,4 +1,5 @@ node_modules/ coverage/ dist/ -temp/ \ No newline at end of file +temp/ +.DS_STORE \ No newline at end of file diff --git a/tests/unit/answers-headless.ts b/tests/unit/search-headless.ts similarity index 100% rename from tests/unit/answers-headless.ts rename to tests/unit/search-headless.ts From 040b3d076c101f8eef69256c293886548ed04fc1 Mon Sep 17 00:00:00 2001 From: Cindy Yang Date: Tue, 12 Jul 2022 12:32:08 -0400 Subject: [PATCH 14/22] rm ds store --- tests/.DS_Store | Bin 6148 -> 0 bytes 1 file changed, 0 insertions(+), 0 deletions(-) delete mode 100644 tests/.DS_Store diff --git a/tests/.DS_Store b/tests/.DS_Store deleted file mode 100644 index e0ae54f0eb30992b05daab6f708cccc7ab025927..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 6148 zcmeHKIc~#13?v;FhTW)4xnIZ+7KZWyeZYYdqzPmrh*PV|yZkf{4;VJ26e-*ULx7xJ zE@uTzA&MfR+vDq#NFyRExS{-5n3|oNPi&DH1;TO1LB8Zg2I=K(QaztA?i!rlIamDe z?sNFq5ASjJJegT4Kn17(6`%rC;Li$J?}e>4fs9mu3Q&QI0``3Eo^g9;3)=7^y|N4{iTO&kM*E}FxK=94ui6!oX${^I4LHIR`C zP=Q+o9%9>A|9^)6GXLL_xT6A8;9n`A%eHH`c%|&Elb5qzTi`pm)tumFSUUy5+cD7F hF*eqYAH68*imh>86URWOBkyz|e+En!8Wp&=0%s-p6?6aq From 7386ab4222f5c9b2d291f8396f86562058eb5c3c Mon Sep 17 00:00:00 2001 From: Cindy Yang Date: Tue, 12 Jul 2022 12:33:30 -0400 Subject: [PATCH 15/22] gitignore fix --- .gitignore | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.gitignore b/.gitignore index 018c4180..316dff4f 100644 --- a/.gitignore +++ b/.gitignore @@ -2,4 +2,4 @@ node_modules/ coverage/ dist/ temp/ -.DS_STORE \ No newline at end of file +.DS_Store \ No newline at end of file From 8b448ae1bd24ee7a6b51f01159b4fda49734013b Mon Sep 17 00:00:00 2001 From: Cindy Yang Date: Tue, 12 Jul 2022 12:40:14 -0400 Subject: [PATCH 16/22] minor fixes --- src/index.ts | 4 ++-- src/models/slices/query.ts | 2 +- src/models/state-manager.ts | 2 +- src/search-headless.ts | 4 ++-- src/slices/sessiontracking.ts | 2 +- tests/acceptance/multiple-instances.ts | 2 +- tests/mocks/createMockedHeadless.ts | 2 +- 7 files changed, 9 insertions(+), 9 deletions(-) diff --git a/src/index.ts b/src/index.ts index 1e0b233e..996cb4f0 100644 --- a/src/index.ts +++ b/src/index.ts @@ -18,7 +18,7 @@ export * from './deprecated'; export { searchUtilities }; /** - * The configuration for an SearchHeadless instance. + * The configuration for a SearchHeadless instance. * * @public */ @@ -80,7 +80,7 @@ export function provideHeadless( ...answersConfig } = config; if (headlessId === DEFAULT_HEADLESS_ID) { - throw new Error(`Cannot instantiate an SearchHeadless using the default headlessId "${headlessId}". ` + throw new Error(`Cannot instantiate a SearchHeadless using the default headlessId "${headlessId}". ` + 'Specify a different headlessId.'); } const answersCore = provideCore(answersConfig); diff --git a/src/models/slices/query.ts b/src/models/slices/query.ts index aed59851..f819b73d 100644 --- a/src/models/slices/query.ts +++ b/src/models/slices/query.ts @@ -19,7 +19,7 @@ export interface QueryState { */ queryTrigger?: QueryTrigger, /** - * The source of the query (from a standard Search integration, an Search + * The source of the query (from a standard Search integration, a Search * overlay, or from visual autocomplete). */ querySource?: QuerySource, diff --git a/src/models/state-manager.ts b/src/models/state-manager.ts index c9676bc3..d4e63238 100644 --- a/src/models/state-manager.ts +++ b/src/models/state-manager.ts @@ -3,7 +3,7 @@ import { State } from './state'; import StateListener from './state-listener'; /** - * Manages the information contained in the state for an SearchHeadless instance. + * Manages the information contained in the state for a SearchHeadless instance. * * @remarks * The {@link State} is immutable, and can only be updated by dispatched events. diff --git a/src/search-headless.ts b/src/search-headless.ts index 00317427..58ee4d4e 100644 --- a/src/search-headless.ts +++ b/src/search-headless.ts @@ -24,7 +24,7 @@ import { State } from './models/state'; import StateManager from './models/state-manager'; import { Unsubscribe } from '@reduxjs/toolkit'; import HttpManager from './http-manager'; -import * as answersUtilities from './search-utilities'; +import * as searchUtilities from './search-utilities'; import { SelectableFilter } from './models/utils/selectableFilter'; import { transformFiltersToCoreFormat } from './utils/transform-filters'; import { SearchTypeEnum } from './models/utils/searchType'; @@ -44,7 +44,7 @@ export default class SearchHeadless { /** * Common utility functions for manipulating Search-related data. */ - public readonly utilities = answersUtilities; + public readonly utilities = searchUtilities; constructor( private core: AnswersCore, diff --git a/src/slices/sessiontracking.ts b/src/slices/sessiontracking.ts index c95a3237..27262380 100644 --- a/src/slices/sessiontracking.ts +++ b/src/slices/sessiontracking.ts @@ -16,7 +16,7 @@ const reducers = { /** * Registers with Redux the slice of {@link State} pertaining to session tracking of - * an Search experience. + * a Search experience. */ export default function createSessionTrackingSlice( prefix: string diff --git a/tests/acceptance/multiple-instances.ts b/tests/acceptance/multiple-instances.ts index 74e9cccd..71b5539d 100644 --- a/tests/acceptance/multiple-instances.ts +++ b/tests/acceptance/multiple-instances.ts @@ -53,5 +53,5 @@ it('an error is thrown if you manually specify a headlessId equal to the default ...config, headlessId: DEFAULT_HEADLESS_ID }); - }).toThrow('Cannot instantiate an SearchHeadless using the default headlessId'); + }).toThrow('Cannot instantiate a SearchHeadless using the default headlessId'); }); \ No newline at end of file diff --git a/tests/mocks/createMockedHeadless.ts b/tests/mocks/createMockedHeadless.ts index 4e8a7a82..73a98173 100644 --- a/tests/mocks/createMockedHeadless.ts +++ b/tests/mocks/createMockedHeadless.ts @@ -8,7 +8,7 @@ import HeadlessReducerManager from '../../src/headless-reducer-manager'; import { getHttpHeaders } from '../../src/utils/client-sdk-utils'; /** - * Creates an Search Headless instance with a mocked Search Core. + * Creates a Search Headless instance with a mocked Search Core. * * @param mockedAnswersCore - Search Core overrides * @param initialState - The initial state of Search Headless From 6609b011c1fffb5fa8f8f1920c9675d92a1f5d33 Mon Sep 17 00:00:00 2001 From: github-actions <41898282+github-actions[bot]@users.noreply.github.com> Date: Tue, 12 Jul 2022 17:07:39 +0000 Subject: [PATCH 17/22] Automated update to THIRD-PARTY-NOTICES from github action's 3rd party notices check --- THIRD-PARTY-NOTICES | 120 ++++++++++++++++++++++---------------------- 1 file changed, 60 insertions(+), 60 deletions(-) diff --git a/THIRD-PARTY-NOTICES b/THIRD-PARTY-NOTICES index a7edd6ff..8c826c40 100644 --- a/THIRD-PARTY-NOTICES +++ b/THIRD-PARTY-NOTICES @@ -36,26 +36,26 @@ The following NPM package may be included in this product: This package contains the following license and notice below: -MIT License - -Copyright (c) 2018 Mark Erikson - -Permission is hereby granted, free of charge, to any person obtaining a copy -of this software and associated documentation files (the "Software"), to deal -in the Software without restriction, including without limitation the rights -to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -copies of the Software, and to permit persons to whom the Software is -furnished to do so, subject to the following conditions: - -The above copyright notice and this permission notice shall be included in all -copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +MIT License + +Copyright (c) 2018 Mark Erikson + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ----------- @@ -314,26 +314,26 @@ The following NPM package may be included in this product: This package contains the following license and notice below: -The MIT License (MIT) - -Copyright (c) 2015-present Dan Abramov - -Permission is hereby granted, free of charge, to any person obtaining a copy -of this software and associated documentation files (the "Software"), to deal -in the Software without restriction, including without limitation the rights -to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -copies of the Software, and to permit persons to whom the Software is -furnished to do so, subject to the following conditions: - -The above copyright notice and this permission notice shall be included in all -copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +The MIT License (MIT) + +Copyright (c) 2015-present Dan Abramov + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ----------- @@ -404,26 +404,26 @@ The following NPM package may be included in this product: This package contains the following license and notice below: -The MIT License (MIT) - -Copyright (c) 2015-2018 Reselect Contributors - -Permission is hereby granted, free of charge, to any person obtaining a copy -of this software and associated documentation files (the "Software"), to deal -in the Software without restriction, including without limitation the rights -to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -copies of the Software, and to permit persons to whom the Software is -furnished to do so, subject to the following conditions: - -The above copyright notice and this permission notice shall be included in all -copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +The MIT License (MIT) + +Copyright (c) 2015-2018 Reselect Contributors + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ----------- From d12c8c4d7bf3e9ea58d65711b4f675e7b2a86b4c Mon Sep 17 00:00:00 2001 From: github-actions <41898282+github-actions[bot]@users.noreply.github.com> Date: Tue, 12 Jul 2022 17:07:43 +0000 Subject: [PATCH 18/22] Automated update to repo's documentation from github action --- ...less.additionalhttpheaders._client-sdk_.md | 2 +- docs/search-headless.additionalhttpheaders.md | 2 +- docs/search-headless.answersconfig.md | 15 --- ...headless.answersconfigwithapikey.apikey.md | 13 --- ...search-headless.answersconfigwithapikey.md | 22 ----- .../search-headless.answersconfigwithtoken.md | 22 ----- ...h-headless.answersconfigwithtoken.token.md | 13 --- docs/search-headless.answerscore.md | 31 ------ docs/search-headless.answerserror.md | 27 ------ docs/search-headless.answersrequest.md | 20 ---- docs/search-headless.appliedqueryfilter.md | 2 +- ...dless.autocompleteresponse.inputintents.md | 2 +- docs/search-headless.autocompleteresponse.md | 2 +- ...eadless.baseanswersconfig.experiencekey.md | 13 --- ...earch-headless.baseanswersconfig.locale.md | 13 --- docs/search-headless.baseanswersconfig.md | 24 ----- ...ch-headless.basesearchconfig.endpoints.md} | 6 +- ...headless.basesearchconfig.experiencekey.md | 13 +++ ...ess.basesearchconfig.experienceversion.md} | 6 +- ...search-headless.basesearchconfig.locale.md | 13 +++ docs/search-headless.basesearchconfig.md | 24 +++++ ...arch-headless.basesearchconfig.visitor.md} | 4 +- ...less.clientsdkheadervalues.answers_core.md | 2 +- docs/search-headless.clientsdkheadervalues.md | 4 +- docs/search-headless.context.md | 2 +- docs/search-headless.endpoints.md | 2 +- docs/search-headless.facet.md | 2 +- docs/search-headless.filtersearchrequest.md | 4 +- ...eadless.filtersearchresponse.businessid.md | 2 +- docs/search-headless.filtersearchresponse.md | 2 +- docs/search-headless.headlessconfig.md | 4 +- docs/search-headless.highlightedfields.md | 2 +- docs/search-headless.highlightedvalue.md | 2 +- .../search-headless.highlightedvalue.value.md | 2 +- docs/search-headless.md | 38 ++++---- docs/search-headless.queryrulesactionsdata.md | 2 +- docs/search-headless.querysource.md | 4 +- docs/search-headless.querytrigger.md | 2 +- ...arch-headless.questionsubmissionrequest.md | 4 +- ...arch-headless.questionsubmissionservice.md | 2 +- docs/search-headless.searchconfig.md | 15 +++ ...-headless.searchconfigwithapikey.apikey.md | 13 +++ .../search-headless.searchconfigwithapikey.md | 22 +++++ ...-headless.searchconfigwithapikey.token.md} | 4 +- ...-headless.searchconfigwithtoken.apikey.md} | 4 +- docs/search-headless.searchconfigwithtoken.md | 22 +++++ ...ch-headless.searchconfigwithtoken.token.md | 13 +++ ...arch-headless.searchcore._constructor_.md} | 6 +- ...earch-headless.searchcore.filtersearch.md} | 6 +- docs/search-headless.searchcore.md | 31 ++++++ ...rch-headless.searchcore.submitquestion.md} | 8 +- ...dless.searchcore.universalautocomplete.md} | 6 +- ...ch-headless.searchcore.universalsearch.md} | 8 +- ...adless.searchcore.verticalautocomplete.md} | 6 +- ...rch-headless.searchcore.verticalsearch.md} | 8 +- ...md => search-headless.searcherror.code.md} | 6 +- docs/search-headless.searcherror.md | 27 ++++++ ...=> search-headless.searcherror.message.md} | 4 +- ...md => search-headless.searcherror.type.md} | 6 +- ...h-headless.searchheadless._constructor_.md | 4 +- docs/search-headless.searchheadless.md | 2 +- ...earch-headless.searchheadless.utilities.md | 1 + docs/search-headless.searchintent.md | 4 +- ...ss.searchrequest.additionalhttpheaders.md} | 4 +- docs/search-headless.searchrequest.md | 20 ++++ docs/search-headless.searchservice.md | 2 +- docs/search-headless.source.md | 2 +- ...h-headless.universalautocompleterequest.md | 4 +- ...headless.universalsearchrequest.context.md | 2 +- .../search-headless.universalsearchrequest.md | 6 +- ...search-headless.universalsearchresponse.md | 2 +- ...salsearchresponse.queryrulesactionsdata.md | 2 +- ...ch-headless.verticalautocompleterequest.md | 4 +- ...-headless.verticalsearchrequest.context.md | 2 +- docs/search-headless.verticalsearchrequest.md | 6 +- .../search-headless.verticalsearchresponse.md | 2 +- ...calsearchresponse.queryrulesactionsdata.md | 2 +- etc/search-headless.api.md | 96 +++++++++---------- 78 files changed, 377 insertions(+), 376 deletions(-) delete mode 100644 docs/search-headless.answersconfig.md delete mode 100644 docs/search-headless.answersconfigwithapikey.apikey.md delete mode 100644 docs/search-headless.answersconfigwithapikey.md delete mode 100644 docs/search-headless.answersconfigwithtoken.md delete mode 100644 docs/search-headless.answersconfigwithtoken.token.md delete mode 100644 docs/search-headless.answerscore.md delete mode 100644 docs/search-headless.answerserror.md delete mode 100644 docs/search-headless.answersrequest.md delete mode 100644 docs/search-headless.baseanswersconfig.experiencekey.md delete mode 100644 docs/search-headless.baseanswersconfig.locale.md delete mode 100644 docs/search-headless.baseanswersconfig.md rename docs/{search-headless.baseanswersconfig.endpoints.md => search-headless.basesearchconfig.endpoints.md} (56%) create mode 100644 docs/search-headless.basesearchconfig.experiencekey.md rename docs/{search-headless.baseanswersconfig.experienceversion.md => search-headless.basesearchconfig.experienceversion.md} (57%) create mode 100644 docs/search-headless.basesearchconfig.locale.md create mode 100644 docs/search-headless.basesearchconfig.md rename docs/{search-headless.baseanswersconfig.visitor.md => search-headless.basesearchconfig.visitor.md} (66%) create mode 100644 docs/search-headless.searchconfig.md create mode 100644 docs/search-headless.searchconfigwithapikey.apikey.md create mode 100644 docs/search-headless.searchconfigwithapikey.md rename docs/{search-headless.answersconfigwithapikey.token.md => search-headless.searchconfigwithapikey.token.md} (55%) rename docs/{search-headless.answersconfigwithtoken.apikey.md => search-headless.searchconfigwithtoken.apikey.md} (55%) create mode 100644 docs/search-headless.searchconfigwithtoken.md create mode 100644 docs/search-headless.searchconfigwithtoken.token.md rename docs/{search-headless.answerscore._constructor_.md => search-headless.searchcore._constructor_.md} (74%) rename docs/{search-headless.answerscore.filtersearch.md => search-headless.searchcore.filtersearch.md} (80%) create mode 100644 docs/search-headless.searchcore.md rename docs/{search-headless.answerscore.submitquestion.md => search-headless.searchcore.submitquestion.md} (64%) rename docs/{search-headless.answerscore.universalautocomplete.md => search-headless.searchcore.universalautocomplete.md} (68%) rename docs/{search-headless.answerscore.universalsearch.md => search-headless.searchcore.universalsearch.md} (63%) rename docs/{search-headless.answerscore.verticalautocomplete.md => search-headless.searchcore.verticalautocomplete.md} (68%) rename docs/{search-headless.answerscore.verticalsearch.md => search-headless.searchcore.verticalsearch.md} (63%) rename docs/{search-headless.answerserror.code.md => search-headless.searcherror.code.md} (52%) create mode 100644 docs/search-headless.searcherror.md rename docs/{search-headless.answerserror.message.md => search-headless.searcherror.message.md} (57%) rename docs/{search-headless.answerserror.type.md => search-headless.searcherror.type.md} (52%) rename docs/{search-headless.answersrequest.additionalhttpheaders.md => search-headless.searchrequest.additionalhttpheaders.md} (60%) create mode 100644 docs/search-headless.searchrequest.md diff --git a/docs/search-headless.additionalhttpheaders._client-sdk_.md b/docs/search-headless.additionalhttpheaders._client-sdk_.md index 65685d74..5c3ff41f 100644 --- a/docs/search-headless.additionalhttpheaders._client-sdk_.md +++ b/docs/search-headless.additionalhttpheaders._client-sdk_.md @@ -4,7 +4,7 @@ ## AdditionalHttpHeaders."Client-SDK" property -Additional agents and their versions used to create the Answers experience. The information for these agents is added to the Client-SDK HTTP header along with that of the ANSWERS\_CORE agent. +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. Signature: diff --git a/docs/search-headless.additionalhttpheaders.md b/docs/search-headless.additionalhttpheaders.md index 6cd3d732..36da04a0 100644 --- a/docs/search-headless.additionalhttpheaders.md +++ b/docs/search-headless.additionalhttpheaders.md @@ -16,5 +16,5 @@ export declare interface AdditionalHttpHeaders | Property | Type | Description | | --- | --- | --- | -| ["Client-SDK"?](./search-headless.additionalhttpheaders._client-sdk_.md) | [ClientSDKHeaderValues](./search-headless.clientsdkheadervalues.md) | (Optional) Additional agents and their versions used to create the Answers experience. The information for these agents is added to the Client-SDK HTTP header along with that of the ANSWERS\_CORE agent. | +| ["Client-SDK"?](./search-headless.additionalhttpheaders._client-sdk_.md) | [ClientSDKHeaderValues](./search-headless.clientsdkheadervalues.md) | (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. | diff --git a/docs/search-headless.answersconfig.md b/docs/search-headless.answersconfig.md deleted file mode 100644 index 3bfb92f3..00000000 --- a/docs/search-headless.answersconfig.md +++ /dev/null @@ -1,15 +0,0 @@ - - -[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [AnswersConfig](./search-headless.answersconfig.md) - -## AnswersConfig type - -The main configuration options for [AnswersCore](./search-headless.answerscore.md). For a full description of the options, see [BaseAnswersConfig](./search-headless.baseanswersconfig.md). The config requires either an apiKey or a token. - -Signature: - -```typescript -export declare type AnswersConfig = AnswersConfigWithApiKey | AnswersConfigWithToken; -``` -References: [AnswersConfigWithApiKey](./search-headless.answersconfigwithapikey.md), [AnswersConfigWithToken](./search-headless.answersconfigwithtoken.md) - diff --git a/docs/search-headless.answersconfigwithapikey.apikey.md b/docs/search-headless.answersconfigwithapikey.apikey.md deleted file mode 100644 index 72c66e34..00000000 --- a/docs/search-headless.answersconfigwithapikey.apikey.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [AnswersConfigWithApiKey](./search-headless.answersconfigwithapikey.md) > [apiKey](./search-headless.answersconfigwithapikey.apikey.md) - -## AnswersConfigWithApiKey.apiKey property - -The api key of the answers experience which will be sent as a query param. - -Signature: - -```typescript -apiKey: string; -``` diff --git a/docs/search-headless.answersconfigwithapikey.md b/docs/search-headless.answersconfigwithapikey.md deleted file mode 100644 index 43cdeb09..00000000 --- a/docs/search-headless.answersconfigwithapikey.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [AnswersConfigWithApiKey](./search-headless.answersconfigwithapikey.md) - -## AnswersConfigWithApiKey interface - -Configuration options for [AnswersCore](./search-headless.answerscore.md), which includes the options from [BaseAnswersConfig](./search-headless.baseanswersconfig.md), but requires apiKey. - -Signature: - -```typescript -export declare interface AnswersConfigWithApiKey extends BaseAnswersConfig -``` -Extends: [BaseAnswersConfig](./search-headless.baseanswersconfig.md) - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [apiKey](./search-headless.answersconfigwithapikey.apikey.md) | string | The api key of the answers experience which will be sent as a query param. | -| [token?](./search-headless.answersconfigwithapikey.token.md) | never | (Optional) token should NOT be provided along with apiKey. | - diff --git a/docs/search-headless.answersconfigwithtoken.md b/docs/search-headless.answersconfigwithtoken.md deleted file mode 100644 index 9aad9d5e..00000000 --- a/docs/search-headless.answersconfigwithtoken.md +++ /dev/null @@ -1,22 +0,0 @@ - - -[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [AnswersConfigWithToken](./search-headless.answersconfigwithtoken.md) - -## AnswersConfigWithToken interface - -Configuration options for [AnswersCore](./search-headless.answerscore.md), which includes the options from [BaseAnswersConfig](./search-headless.baseanswersconfig.md), but requires token. - -Signature: - -```typescript -export declare interface AnswersConfigWithToken extends BaseAnswersConfig -``` -Extends: [BaseAnswersConfig](./search-headless.baseanswersconfig.md) - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [apiKey?](./search-headless.answersconfigwithtoken.apikey.md) | never | (Optional) apiKey should NOT be provided along with token. | -| [token](./search-headless.answersconfigwithtoken.token.md) | string | The authentication token of the answers experience which will be passed in the Auth header as a Bearer token. | - diff --git a/docs/search-headless.answersconfigwithtoken.token.md b/docs/search-headless.answersconfigwithtoken.token.md deleted file mode 100644 index 50f34915..00000000 --- a/docs/search-headless.answersconfigwithtoken.token.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [AnswersConfigWithToken](./search-headless.answersconfigwithtoken.md) > [token](./search-headless.answersconfigwithtoken.token.md) - -## AnswersConfigWithToken.token property - -The authentication token of the answers experience which will be passed in the Auth header as a Bearer token. - -Signature: - -```typescript -token: string; -``` diff --git a/docs/search-headless.answerscore.md b/docs/search-headless.answerscore.md deleted file mode 100644 index 2ce43d0c..00000000 --- a/docs/search-headless.answerscore.md +++ /dev/null @@ -1,31 +0,0 @@ - - -[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [AnswersCore](./search-headless.answerscore.md) - -## AnswersCore class - -Provides methods for executing searches, submitting questions, and performing autocompletes. - -Signature: - -```typescript -export declare class AnswersCore -``` - -## Constructors - -| Constructor | Modifiers | Description | -| --- | --- | --- | -| [(constructor)(searchService, questionSubmissionService, autoCompleteService)](./search-headless.answerscore._constructor_.md) | | Constructs a new instance of the AnswersCore class | - -## Methods - -| Method | Modifiers | Description | -| --- | --- | --- | -| [filterSearch(request)](./search-headless.answerscore.filtersearch.md) | | Performs a filtersearch request against specified fields within a single vertical. | -| [submitQuestion(request)](./search-headless.answerscore.submitquestion.md) | | Submits a custom question to the Answers API. | -| [universalAutocomplete(request)](./search-headless.answerscore.universalautocomplete.md) | | Performs an autocomplete request across all verticals. | -| [universalSearch(request)](./search-headless.answerscore.universalsearch.md) | | Performs an Answers search across all verticals. | -| [verticalAutocomplete(request)](./search-headless.answerscore.verticalautocomplete.md) | | Performs an autocomplete request for a single vertical. | -| [verticalSearch(request)](./search-headless.answerscore.verticalsearch.md) | | Performs an Answers search for a single vertical. | - diff --git a/docs/search-headless.answerserror.md b/docs/search-headless.answerserror.md deleted file mode 100644 index 7f847a46..00000000 --- a/docs/search-headless.answerserror.md +++ /dev/null @@ -1,27 +0,0 @@ - - -[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [AnswersError](./search-headless.answerserror.md) - -## AnswersError class - -Represents an error - -Signature: - -```typescript -export declare class AnswersError extends Error -``` -Extends: Error - -## Remarks - -If the error originates from the Answer API, the code and type property will be present. - -## Properties - -| Property | Modifiers | Type | Description | -| --- | --- | --- | --- | -| [code?](./search-headless.answerserror.code.md) | | number | (Optional) Answers API error code. | -| [message](./search-headless.answerserror.message.md) | | string | The error message. | -| [type?](./search-headless.answerserror.type.md) | | string | (Optional) Answers API error type. | - diff --git a/docs/search-headless.answersrequest.md b/docs/search-headless.answersrequest.md deleted file mode 100644 index 45cfc5d3..00000000 --- a/docs/search-headless.answersrequest.md +++ /dev/null @@ -1,20 +0,0 @@ - - -[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [AnswersRequest](./search-headless.answersrequest.md) - -## AnswersRequest interface - -Options for an Answers API request. - -Signature: - -```typescript -export declare interface AnswersRequest -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [additionalHttpHeaders?](./search-headless.answersrequest.additionalhttpheaders.md) | [AdditionalHttpHeaders](./search-headless.additionalhttpheaders.md) | (Optional) AdditionalHttpHeaders allows users to specify additional values for specific HTTP headers. | - diff --git a/docs/search-headless.appliedqueryfilter.md b/docs/search-headless.appliedqueryfilter.md index 0f30bd66..ed342f5e 100644 --- a/docs/search-headless.appliedqueryfilter.md +++ b/docs/search-headless.appliedqueryfilter.md @@ -4,7 +4,7 @@ ## AppliedQueryFilter interface -A filter that the Answers API applied to the search. +A filter that the Search API applied to the search. Signature: diff --git a/docs/search-headless.autocompleteresponse.inputintents.md b/docs/search-headless.autocompleteresponse.inputintents.md index ebb3cca2..a229ca6b 100644 --- a/docs/search-headless.autocompleteresponse.inputintents.md +++ b/docs/search-headless.autocompleteresponse.inputintents.md @@ -4,7 +4,7 @@ ## AutocompleteResponse.inputIntents property -Represents intents from the Answers API. +Represents intents from the Search API. Signature: diff --git a/docs/search-headless.autocompleteresponse.md b/docs/search-headless.autocompleteresponse.md index 60ee61e5..0d915373 100644 --- a/docs/search-headless.autocompleteresponse.md +++ b/docs/search-headless.autocompleteresponse.md @@ -16,7 +16,7 @@ export declare interface AutocompleteResponse | Property | Type | Description | | --- | --- | --- | -| [inputIntents](./search-headless.autocompleteresponse.inputintents.md) | [SearchIntent](./search-headless.searchintent.md)\[\] | Represents intents from the Answers API. | +| [inputIntents](./search-headless.autocompleteresponse.inputintents.md) | [SearchIntent](./search-headless.searchintent.md)\[\] | Represents intents from the Search API. | | [queryId?](./search-headless.autocompleteresponse.queryid.md) | string | (Optional) The ID of the search query. | | [results](./search-headless.autocompleteresponse.results.md) | [AutocompleteResult](./search-headless.autocompleteresult.md)\[\] | An array of [AutocompleteResult](./search-headless.autocompleteresult.md)s. | | [uuid](./search-headless.autocompleteresponse.uuid.md) | string | A unique id which corresponds to the request. | diff --git a/docs/search-headless.baseanswersconfig.experiencekey.md b/docs/search-headless.baseanswersconfig.experiencekey.md deleted file mode 100644 index 5ef58900..00000000 --- a/docs/search-headless.baseanswersconfig.experiencekey.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [BaseAnswersConfig](./search-headless.baseanswersconfig.md) > [experienceKey](./search-headless.baseanswersconfig.experiencekey.md) - -## BaseAnswersConfig.experienceKey property - -The experience key of the answers experience. - -Signature: - -```typescript -experienceKey: string; -``` diff --git a/docs/search-headless.baseanswersconfig.locale.md b/docs/search-headless.baseanswersconfig.locale.md deleted file mode 100644 index 4078a994..00000000 --- a/docs/search-headless.baseanswersconfig.locale.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [BaseAnswersConfig](./search-headless.baseanswersconfig.md) > [locale](./search-headless.baseanswersconfig.locale.md) - -## BaseAnswersConfig.locale property - -The locale of the answers experience. - -Signature: - -```typescript -locale: string; -``` diff --git a/docs/search-headless.baseanswersconfig.md b/docs/search-headless.baseanswersconfig.md deleted file mode 100644 index febb96a9..00000000 --- a/docs/search-headless.baseanswersconfig.md +++ /dev/null @@ -1,24 +0,0 @@ - - -[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [BaseAnswersConfig](./search-headless.baseanswersconfig.md) - -## BaseAnswersConfig interface - -The base configuration options for [AnswersCore](./search-headless.answerscore.md). - -Signature: - -```typescript -export declare interface BaseAnswersConfig -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [endpoints?](./search-headless.baseanswersconfig.endpoints.md) | [Endpoints](./search-headless.endpoints.md) | (Optional) Overrides for the URLs which are used when making requests to the Answers API. | -| [experienceKey](./search-headless.baseanswersconfig.experiencekey.md) | string | The experience key of the answers experience. | -| [experienceVersion?](./search-headless.baseanswersconfig.experienceversion.md) | 'STAGING' \| 'PRODUCTION' \| string \| number | (Optional) The version of the answers experience configuration. | -| [locale](./search-headless.baseanswersconfig.locale.md) | string | The locale of the answers experience. | -| [visitor?](./search-headless.baseanswersconfig.visitor.md) | [Visitor](./search-headless.visitor.md) | (Optional) Information used to associate requests with a particular user. | - diff --git a/docs/search-headless.baseanswersconfig.endpoints.md b/docs/search-headless.basesearchconfig.endpoints.md similarity index 56% rename from docs/search-headless.baseanswersconfig.endpoints.md rename to docs/search-headless.basesearchconfig.endpoints.md index be9ad45d..01ea98aa 100644 --- a/docs/search-headless.baseanswersconfig.endpoints.md +++ b/docs/search-headless.basesearchconfig.endpoints.md @@ -1,10 +1,10 @@ -[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [BaseAnswersConfig](./search-headless.baseanswersconfig.md) > [endpoints](./search-headless.baseanswersconfig.endpoints.md) +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [BaseSearchConfig](./search-headless.basesearchconfig.md) > [endpoints](./search-headless.basesearchconfig.endpoints.md) -## BaseAnswersConfig.endpoints property +## BaseSearchConfig.endpoints property -Overrides for the URLs which are used when making requests to the Answers API. +Overrides for the URLs which are used when making requests to the Search API. Signature: diff --git a/docs/search-headless.basesearchconfig.experiencekey.md b/docs/search-headless.basesearchconfig.experiencekey.md new file mode 100644 index 00000000..74356661 --- /dev/null +++ b/docs/search-headless.basesearchconfig.experiencekey.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [BaseSearchConfig](./search-headless.basesearchconfig.md) > [experienceKey](./search-headless.basesearchconfig.experiencekey.md) + +## BaseSearchConfig.experienceKey property + +The experience key of the search experience. + +Signature: + +```typescript +experienceKey: string; +``` diff --git a/docs/search-headless.baseanswersconfig.experienceversion.md b/docs/search-headless.basesearchconfig.experienceversion.md similarity index 57% rename from docs/search-headless.baseanswersconfig.experienceversion.md rename to docs/search-headless.basesearchconfig.experienceversion.md index 8e4f294c..647080b2 100644 --- a/docs/search-headless.baseanswersconfig.experienceversion.md +++ b/docs/search-headless.basesearchconfig.experienceversion.md @@ -1,10 +1,10 @@ -[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [BaseAnswersConfig](./search-headless.baseanswersconfig.md) > [experienceVersion](./search-headless.baseanswersconfig.experienceversion.md) +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [BaseSearchConfig](./search-headless.basesearchconfig.md) > [experienceVersion](./search-headless.basesearchconfig.experienceversion.md) -## BaseAnswersConfig.experienceVersion property +## BaseSearchConfig.experienceVersion property -The version of the answers experience configuration. +The version of the search experience configuration. Signature: diff --git a/docs/search-headless.basesearchconfig.locale.md b/docs/search-headless.basesearchconfig.locale.md new file mode 100644 index 00000000..b2b9abe8 --- /dev/null +++ b/docs/search-headless.basesearchconfig.locale.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [BaseSearchConfig](./search-headless.basesearchconfig.md) > [locale](./search-headless.basesearchconfig.locale.md) + +## BaseSearchConfig.locale property + +The locale of the search experience. + +Signature: + +```typescript +locale: string; +``` diff --git a/docs/search-headless.basesearchconfig.md b/docs/search-headless.basesearchconfig.md new file mode 100644 index 00000000..41211133 --- /dev/null +++ b/docs/search-headless.basesearchconfig.md @@ -0,0 +1,24 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [BaseSearchConfig](./search-headless.basesearchconfig.md) + +## BaseSearchConfig interface + +The base configuration options for [SearchCore](./search-headless.searchcore.md). + +Signature: + +```typescript +export declare interface BaseSearchConfig +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [endpoints?](./search-headless.basesearchconfig.endpoints.md) | [Endpoints](./search-headless.endpoints.md) | (Optional) Overrides for the URLs which are used when making requests to the Search API. | +| [experienceKey](./search-headless.basesearchconfig.experiencekey.md) | string | The experience key of the search experience. | +| [experienceVersion?](./search-headless.basesearchconfig.experienceversion.md) | 'STAGING' \| 'PRODUCTION' \| string \| number | (Optional) The version of the search experience configuration. | +| [locale](./search-headless.basesearchconfig.locale.md) | string | The locale of the search experience. | +| [visitor?](./search-headless.basesearchconfig.visitor.md) | [Visitor](./search-headless.visitor.md) | (Optional) Information used to associate requests with a particular user. | + diff --git a/docs/search-headless.baseanswersconfig.visitor.md b/docs/search-headless.basesearchconfig.visitor.md similarity index 66% rename from docs/search-headless.baseanswersconfig.visitor.md rename to docs/search-headless.basesearchconfig.visitor.md index 055b50ff..46cbdc32 100644 --- a/docs/search-headless.baseanswersconfig.visitor.md +++ b/docs/search-headless.basesearchconfig.visitor.md @@ -1,8 +1,8 @@ -[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [BaseAnswersConfig](./search-headless.baseanswersconfig.md) > [visitor](./search-headless.baseanswersconfig.visitor.md) +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [BaseSearchConfig](./search-headless.basesearchconfig.md) > [visitor](./search-headless.basesearchconfig.visitor.md) -## BaseAnswersConfig.visitor property +## BaseSearchConfig.visitor property Information used to associate requests with a particular user. diff --git a/docs/search-headless.clientsdkheadervalues.answers_core.md b/docs/search-headless.clientsdkheadervalues.answers_core.md index 27564cea..6ef8911c 100644 --- a/docs/search-headless.clientsdkheadervalues.answers_core.md +++ b/docs/search-headless.clientsdkheadervalues.answers_core.md @@ -4,7 +4,7 @@ ## ClientSDKHeaderValues.ANSWERS\_CORE property -The ANSWERS\_CORE agent should not be supplied. Instead, it will be automatically added to the header and populated with the version of Answers Core being used. +The ANSWERS\_CORE agent should not be supplied. Instead, it will be automatically added to the header and populated with the version of Search Core being used. Signature: diff --git a/docs/search-headless.clientsdkheadervalues.md b/docs/search-headless.clientsdkheadervalues.md index f9471afb..51c1620e 100644 --- a/docs/search-headless.clientsdkheadervalues.md +++ b/docs/search-headless.clientsdkheadervalues.md @@ -4,7 +4,7 @@ ## ClientSDKHeaderValues interface -Additional agents and their versions used to create the Answers experience. The information for these agents is added to the Client-SDK HTTP header along with that of the ANSWERS\_CORE agent. +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. Signature: @@ -16,5 +16,5 @@ export declare interface ClientSDKHeaderValues | Property | Type | Description | | --- | --- | --- | -| [ANSWERS\_CORE?](./search-headless.clientsdkheadervalues.answers_core.md) | never | (Optional) The ANSWERS\_CORE agent should not be supplied. Instead, it will be automatically added to the header and populated with the version of Answers Core being used. | +| [ANSWERS\_CORE?](./search-headless.clientsdkheadervalues.answers_core.md) | never | (Optional) The ANSWERS\_CORE agent should not be supplied. Instead, it will be automatically added to the header and populated with the version of Search Core being used. | diff --git a/docs/search-headless.context.md b/docs/search-headless.context.md index fddc047f..6b53a350 100644 --- a/docs/search-headless.context.md +++ b/docs/search-headless.context.md @@ -4,7 +4,7 @@ ## Context type -Used to trigger Answers [Query Rules](https://hitchhikers.yext.com/tracks/answers-advanced/ans302-query-rules/). +Used to trigger Search [Query Rules](https://hitchhikers.yext.com/tracks/answers-advanced/ans302-query-rules/). Signature: diff --git a/docs/search-headless.endpoints.md b/docs/search-headless.endpoints.md index 4cebfe5e..7df496cc 100644 --- a/docs/search-headless.endpoints.md +++ b/docs/search-headless.endpoints.md @@ -4,7 +4,7 @@ ## Endpoints interface -Overrides for the URLs which are used when making requests to the Answers API. +Overrides for the URLs which are used when making requests to the Search API. Signature: diff --git a/docs/search-headless.facet.md b/docs/search-headless.facet.md index 6249ab14..8d195ca5 100644 --- a/docs/search-headless.facet.md +++ b/docs/search-headless.facet.md @@ -4,7 +4,7 @@ ## Facet interface -Represents dynamic filter options for the Answers API. +Represents dynamic filter options for the Search API. Signature: diff --git a/docs/search-headless.filtersearchrequest.md b/docs/search-headless.filtersearchrequest.md index 4d78f6c0..d4159e38 100644 --- a/docs/search-headless.filtersearchrequest.md +++ b/docs/search-headless.filtersearchrequest.md @@ -9,9 +9,9 @@ Options for a filtersearch request. Signature: ```typescript -export declare interface FilterSearchRequest extends AnswersRequest +export declare interface FilterSearchRequest extends SearchRequest ``` -Extends: [AnswersRequest](./search-headless.answersrequest.md) +Extends: [SearchRequest](./search-headless.searchrequest.md) ## Properties diff --git a/docs/search-headless.filtersearchresponse.businessid.md b/docs/search-headless.filtersearchresponse.businessid.md index 0bc5fbd4..f165643d 100644 --- a/docs/search-headless.filtersearchresponse.businessid.md +++ b/docs/search-headless.filtersearchresponse.businessid.md @@ -4,7 +4,7 @@ ## FilterSearchResponse.businessId property -ID of the account associated with this Answers experience +ID of the account associated with this Search experience. Signature: diff --git a/docs/search-headless.filtersearchresponse.md b/docs/search-headless.filtersearchresponse.md index bb83b6c4..9d28833c 100644 --- a/docs/search-headless.filtersearchresponse.md +++ b/docs/search-headless.filtersearchresponse.md @@ -16,7 +16,7 @@ export declare interface FilterSearchResponse | Property | Type | Description | | --- | --- | --- | -| [businessId?](./search-headless.filtersearchresponse.businessid.md) | string | (Optional) ID of the account associated with this Answers experience | +| [businessId?](./search-headless.filtersearchresponse.businessid.md) | string | (Optional) ID of the account associated with this Search experience. | | [queryId?](./search-headless.filtersearchresponse.queryid.md) | string | (Optional) The ID of the search query. | | [sections](./search-headless.filtersearchresponse.sections.md) | { label?: string; results: [AutocompleteResult](./search-headless.autocompleteresult.md)\[\]; }\[\] | Represents autocomplete results separated by field. | | [uuid](./search-headless.filtersearchresponse.uuid.md) | string | A unique id which corresponds to the request. | diff --git a/docs/search-headless.headlessconfig.md b/docs/search-headless.headlessconfig.md index 19257d26..62554b43 100644 --- a/docs/search-headless.headlessconfig.md +++ b/docs/search-headless.headlessconfig.md @@ -9,10 +9,10 @@ The configuration for a SearchHeadless instance. Signature: ```typescript -export declare type HeadlessConfig = AnswersConfig & { +export declare type HeadlessConfig = SearchConfig & { headlessId?: string; verticalKey?: string; }; ``` -References: [AnswersConfig](./search-headless.answersconfig.md) +References: [SearchConfig](./search-headless.searchconfig.md) diff --git a/docs/search-headless.highlightedfields.md b/docs/search-headless.highlightedfields.md index 7c523832..347c4547 100644 --- a/docs/search-headless.highlightedfields.md +++ b/docs/search-headless.highlightedfields.md @@ -4,7 +4,7 @@ ## HighlightedFields type -A mapping of fields to the values emphasized by the Answers API +A mapping of fields to the values emphasized by the Search API. Signature: diff --git a/docs/search-headless.highlightedvalue.md b/docs/search-headless.highlightedvalue.md index 7a3103ad..2c130a51 100644 --- a/docs/search-headless.highlightedvalue.md +++ b/docs/search-headless.highlightedvalue.md @@ -4,7 +4,7 @@ ## HighlightedValue interface -A field value and its substring matches as emphasized by the Answers API. +A field value and its substring matches as emphasized by the Search API. Signature: diff --git a/docs/search-headless.highlightedvalue.value.md b/docs/search-headless.highlightedvalue.value.md index efe8cef6..3e5de0cd 100644 --- a/docs/search-headless.highlightedvalue.value.md +++ b/docs/search-headless.highlightedvalue.value.md @@ -14,5 +14,5 @@ value: string; ## Remarks -No formatting is applied to this value. This is simply the value that the Answers API determined should be highlighted. +No formatting is applied to this value. This is simply the value that the Search API determined should be highlighted. diff --git a/docs/search-headless.md b/docs/search-headless.md index 9dab6bcd..927d4e99 100644 --- a/docs/search-headless.md +++ b/docs/search-headless.md @@ -8,9 +8,9 @@ | Class | Description | | --- | --- | -| [AnswersCore](./search-headless.answerscore.md) | Provides methods for executing searches, submitting questions, and performing autocompletes. | -| [AnswersError](./search-headless.answerserror.md) | Represents an error | -| [SearchHeadless](./search-headless.searchheadless.md) | Provides the functionality for interacting with an Search experience. | +| [SearchCore](./search-headless.searchcore.md) | Provides methods for executing searches, submitting questions, and performing autocompletes. | +| [SearchError](./search-headless.searcherror.md) | Represents an error | +| [SearchHeadless](./search-headless.searchheadless.md) | Provides the functionality for interacting with a Search experience. | ## Enumerations @@ -25,7 +25,7 @@ | [Matcher](./search-headless.matcher.md) | A Matcher is a filtering operation. | | [QuerySource](./search-headless.querysource.md) | The source of the search request. | | [QueryTrigger](./search-headless.querytrigger.md) | Describes the ways a search can be executed besides user input. | -| [SearchIntent](./search-headless.searchintent.md) | Represents intents from the Answers API. | +| [SearchIntent](./search-headless.searchintent.md) | Represents intents from the Search API. | | [SearchTypeEnum](./search-headless.searchtypeenum.md) | An enum which indicates the type of search that Headless is managing. | | [SortType](./search-headless.sorttype.md) | The method of sorting. | | [Source](./search-headless.source.md) | Represents the source of a [Result](./search-headless.result.md). | @@ -48,23 +48,20 @@ | --- | --- | | [AdditionalHttpHeaders](./search-headless.additionalhttpheaders.md) | AdditionalHttpHeaders allows users to specify additional values for specific HTTP headers. | | [AllResultsForVertical](./search-headless.allresultsforvertical.md) | Represents all results for the current vertical. | -| [AnswersConfigWithApiKey](./search-headless.answersconfigwithapikey.md) | Configuration options for [AnswersCore](./search-headless.answerscore.md), which includes the options from [BaseAnswersConfig](./search-headless.baseanswersconfig.md), but requires apiKey. | -| [AnswersConfigWithToken](./search-headless.answersconfigwithtoken.md) | Configuration options for [AnswersCore](./search-headless.answerscore.md), which includes the options from [BaseAnswersConfig](./search-headless.baseanswersconfig.md), but requires token. | -| [AnswersRequest](./search-headless.answersrequest.md) | Options for an Answers API request. | -| [AppliedQueryFilter](./search-headless.appliedqueryfilter.md) | A filter that the Answers API applied to the search. | +| [AppliedQueryFilter](./search-headless.appliedqueryfilter.md) | A filter that the Search API applied to the search. | | [AutocompleteResponse](./search-headless.autocompleteresponse.md) | The response of a universal or vertical autocomplete request. | | [AutocompleteResult](./search-headless.autocompleteresult.md) | An autocomplete suggestion. | | [AutocompleteService](./search-headless.autocompleteservice.md) | A service for autocomplete requests. | -| [BaseAnswersConfig](./search-headless.baseanswersconfig.md) | The base configuration options for [AnswersCore](./search-headless.answerscore.md). | +| [BaseSearchConfig](./search-headless.basesearchconfig.md) | The base configuration options for [SearchCore](./search-headless.searchcore.md). | | [BoundedRange](./search-headless.boundedrange.md) | An interface representing a range of values of type T. | -| [ClientSDKHeaderValues](./search-headless.clientsdkheadervalues.md) | Additional agents and their versions used to create the Answers experience. The information for these agents is added to the Client-SDK HTTP header along with that of the ANSWERS\_CORE agent. | +| [ClientSDKHeaderValues](./search-headless.clientsdkheadervalues.md) | 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. | | [CombinedFilter](./search-headless.combinedfilter.md) | Represents multiple filters that will be combined to refine results. | | [DirectAnswer](./search-headless.directanswer.md) | A direct answer to a search. | | [DirectAnswerState](./search-headless.directanswerstate.md) | Maintains the direct answer associated with the latest search. | | [DisplayableFacet](./search-headless.displayablefacet.md) | A [Facet](./search-headless.facet.md) which contains extra fields meant to be displayed to the end user. | | [DisplayableFacetOption](./search-headless.displayablefacetoption.md) | A [FacetOption](./search-headless.facetoption.md) with extra data meant to be displayed to the end user. | -| [Endpoints](./search-headless.endpoints.md) | Overrides for the URLs which are used when making requests to the Answers API. | -| [Facet](./search-headless.facet.md) | Represents dynamic filter options for the Answers API. | +| [Endpoints](./search-headless.endpoints.md) | Overrides for the URLs which are used when making requests to the Search API. | +| [Facet](./search-headless.facet.md) | Represents dynamic filter options for the Search API. | | [FacetOption](./search-headless.facetoption.md) | A filter associated with the facet. | | [FailedVertical](./search-headless.failedvertical.md) | Error information from when a vertical fails to return results. | | [FeaturedSnippetDirectAnswer](./search-headless.featuredsnippetdirectanswer.md) | A direct answer which was found within a document. | @@ -73,7 +70,7 @@ | [FilterSearchRequest](./search-headless.filtersearchrequest.md) | Options for a filtersearch request. | | [FilterSearchResponse](./search-headless.filtersearchresponse.md) | The response of a filtersearch request. | | [FiltersState](./search-headless.filtersstate.md) | Maintains the current state of facets and filters in the application. | -| [HighlightedValue](./search-headless.highlightedvalue.md) | A field value and its substring matches as emphasized by the Answers API. | +| [HighlightedValue](./search-headless.highlightedvalue.md) | A field value and its substring matches as emphasized by the Search API. | | [LatLong](./search-headless.latlong.md) | The latitude and longitude of the user making the request. Used to bias the results. | | [LocationBias](./search-headless.locationbias.md) | Information about the user's location. | | [LocationBoundingBox](./search-headless.locationboundingbox.md) | Location boundaries for a filter with "Place" for its [AppliedQueryFilterType](./search-headless.appliedqueryfiltertype.md). (e.g. boundary for a locality or region specific location filter) | @@ -84,16 +81,19 @@ | [NearFilterValue](./search-headless.nearfiltervalue.md) | A filter value for a filter with a $near [Matcher](./search-headless.matcher.md). | | [NumberRangeValue](./search-headless.numberrangevalue.md) | A filter value for a filter with a $between [Matcher](./search-headless.matcher.md). | | [ParentState](./search-headless.parentstate.md) | The overall shape of the redux state tree, with each key value pair of headlessId to [State](./search-headless.state.md) representing a single SearchHeadless instance. | -| [QueryRulesActionsData](./search-headless.queryrulesactionsdata.md) | Data returned from the Answers query rules system. | +| [QueryRulesActionsData](./search-headless.queryrulesactionsdata.md) | Data returned from the Search query rules system. | | [QueryRulesState](./search-headless.queryrulesstate.md) | Maintains the data from the triggered query rules. | | [QueryState](./search-headless.querystate.md) | Maintains the latest query and its associated data. | | [QuestionSubmissionRequest](./search-headless.questionsubmissionrequest.md) | Options for a QuestionSubmission request. | | [QuestionSubmissionResponse](./search-headless.questionsubmissionresponse.md) | A representation of a question submission response. | -| [QuestionSubmissionService](./search-headless.questionsubmissionservice.md) | Submits a custom question to the Answers API. | +| [QuestionSubmissionService](./search-headless.questionsubmissionservice.md) | Submits a custom question to the Search API. | | [RangeBoundary](./search-headless.rangeboundary.md) | A boundary for a [BoundedRange](./search-headless.boundedrange.md) of type T. | | [Result](./search-headless.result.md) | An individual search result. | +| [SearchConfigWithApiKey](./search-headless.searchconfigwithapikey.md) | Configuration options for [SearchCore](./search-headless.searchcore.md), which includes the options from [BaseSearchConfig](./search-headless.basesearchconfig.md), but requires apiKey. | +| [SearchConfigWithToken](./search-headless.searchconfigwithtoken.md) | Configuration options for [SearchCore](./search-headless.searchcore.md), which includes the options from [BaseSearchConfig](./search-headless.basesearchconfig.md), but requires token. | | [SearchParameterField](./search-headless.searchparameterfield.md) | Indicates which entity field to perform the autocomplete request on. | -| [SearchService](./search-headless.searchservice.md) | A service which performs Yext Answers searches | +| [SearchRequest](./search-headless.searchrequest.md) | Options for a Search API request. | +| [SearchService](./search-headless.searchservice.md) | A service which performs Yext Search. | | [SearchStatusState](./search-headless.searchstatusstate.md) | Maintains the status of the latest search. | | [SelectableFilter](./search-headless.selectablefilter.md) | A [Filter](./search-headless.filter.md) with additional information, such as an optional display name and whether or not it is selected. | | [SessionTrackingState](./search-headless.sessiontrackingstate.md) | Maintains whether the user session should be tracked and, if so, the session information. | @@ -137,11 +137,11 @@ | Type Alias | Description | | --- | --- | -| [AnswersConfig](./search-headless.answersconfig.md) | The main configuration options for [AnswersCore](./search-headless.answerscore.md). For a full description of the options, see [BaseAnswersConfig](./search-headless.baseanswersconfig.md). The config requires either an apiKey or a token. | -| [Context](./search-headless.context.md) | Used to trigger Answers [Query Rules](https://hitchhikers.yext.com/tracks/answers-advanced/ans302-query-rules/). | +| [Context](./search-headless.context.md) | Used to trigger Search [Query Rules](https://hitchhikers.yext.com/tracks/answers-advanced/ans302-query-rules/). | | [EnumOrLiteral](./search-headless.enumorliteral.md) | Produces a union type from the enum passed as a generic which consists of the enum values and the string literals of the enum. | | [FilterTypes](./search-headless.filtertypes.md) | A union type for the different kinds of filter. | | [HeadlessConfig](./search-headless.headlessconfig.md) | The configuration for a SearchHeadless instance. | -| [HighlightedFields](./search-headless.highlightedfields.md) | A mapping of fields to the values emphasized by the Answers API | +| [HighlightedFields](./search-headless.highlightedfields.md) | A mapping of fields to the values emphasized by the Search API. | +| [SearchConfig](./search-headless.searchconfig.md) | The main configuration options for [SearchCore](./search-headless.searchcore.md). For a full description of the options, see [BaseSearchConfig](./search-headless.basesearchconfig.md). The config requires either an apiKey or a token. | | [SearchType](./search-headless.searchtype.md) | An enum and its corresponding string literals which indicate the type of search that Headless is managing. | diff --git a/docs/search-headless.queryrulesactionsdata.md b/docs/search-headless.queryrulesactionsdata.md index 9733adc1..016b9f3a 100644 --- a/docs/search-headless.queryrulesactionsdata.md +++ b/docs/search-headless.queryrulesactionsdata.md @@ -4,7 +4,7 @@ ## QueryRulesActionsData interface -Data returned from the Answers query rules system. +Data returned from the Search query rules system. Signature: diff --git a/docs/search-headless.querysource.md b/docs/search-headless.querysource.md index 191cffe1..2760cbdd 100644 --- a/docs/search-headless.querysource.md +++ b/docs/search-headless.querysource.md @@ -17,6 +17,6 @@ export declare enum QuerySource | Member | Value | Description | | --- | --- | --- | | Autocomplete | "AUTOCOMPLETE" | Indicates that the query was initiated from visual autocomplete. | -| Overlay | "OVERLAY" | Indicates that the query was initiated from an Answers Overlay. | -| Standard | "STANDARD" | Indicates that the query was initiated from a standard Answers integration. | +| Overlay | "OVERLAY" | Indicates that the query was initiated from a Search Overlay. | +| Standard | "STANDARD" | Indicates that the query was initiated from a standard Search integration. | diff --git a/docs/search-headless.querytrigger.md b/docs/search-headless.querytrigger.md index 9c67cce2..adfe5209 100644 --- a/docs/search-headless.querytrigger.md +++ b/docs/search-headless.querytrigger.md @@ -25,5 +25,5 @@ Used for search analytics. If a user supplied the search query, do not include a ## Example -An answers site may be configured to perform a search for 'What services do you offer?' when the page loads. Because that query is a default query rather than a user-supplied query, the Initialize QueryTrigger should be included in the request. +A Search site may be configured to perform a search for 'What services do you offer?' when the page loads. Because that query is a default query rather than a user-supplied query, the Initialize QueryTrigger should be included in the request. diff --git a/docs/search-headless.questionsubmissionrequest.md b/docs/search-headless.questionsubmissionrequest.md index 0c6cbc9b..10becc40 100644 --- a/docs/search-headless.questionsubmissionrequest.md +++ b/docs/search-headless.questionsubmissionrequest.md @@ -9,9 +9,9 @@ Options for a QuestionSubmission request. Signature: ```typescript -export declare interface QuestionSubmissionRequest extends AnswersRequest +export declare interface QuestionSubmissionRequest extends SearchRequest ``` -Extends: [AnswersRequest](./search-headless.answersrequest.md) +Extends: [SearchRequest](./search-headless.searchrequest.md) ## Properties diff --git a/docs/search-headless.questionsubmissionservice.md b/docs/search-headless.questionsubmissionservice.md index 0e7cf4d0..b117006e 100644 --- a/docs/search-headless.questionsubmissionservice.md +++ b/docs/search-headless.questionsubmissionservice.md @@ -4,7 +4,7 @@ ## QuestionSubmissionService interface -Submits a custom question to the Answers API. +Submits a custom question to the Search API. Signature: diff --git a/docs/search-headless.searchconfig.md b/docs/search-headless.searchconfig.md new file mode 100644 index 00000000..88b80bf4 --- /dev/null +++ b/docs/search-headless.searchconfig.md @@ -0,0 +1,15 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [SearchConfig](./search-headless.searchconfig.md) + +## SearchConfig type + +The main configuration options for [SearchCore](./search-headless.searchcore.md). For a full description of the options, see [BaseSearchConfig](./search-headless.basesearchconfig.md). The config requires either an apiKey or a token. + +Signature: + +```typescript +export declare type SearchConfig = SearchConfigWithApiKey | SearchConfigWithToken; +``` +References: [SearchConfigWithApiKey](./search-headless.searchconfigwithapikey.md), [SearchConfigWithToken](./search-headless.searchconfigwithtoken.md) + diff --git a/docs/search-headless.searchconfigwithapikey.apikey.md b/docs/search-headless.searchconfigwithapikey.apikey.md new file mode 100644 index 00000000..0b0ce9ba --- /dev/null +++ b/docs/search-headless.searchconfigwithapikey.apikey.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [SearchConfigWithApiKey](./search-headless.searchconfigwithapikey.md) > [apiKey](./search-headless.searchconfigwithapikey.apikey.md) + +## SearchConfigWithApiKey.apiKey property + +The api key of the search experience which will be sent as a query param. + +Signature: + +```typescript +apiKey: string; +``` diff --git a/docs/search-headless.searchconfigwithapikey.md b/docs/search-headless.searchconfigwithapikey.md new file mode 100644 index 00000000..090f71ef --- /dev/null +++ b/docs/search-headless.searchconfigwithapikey.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [SearchConfigWithApiKey](./search-headless.searchconfigwithapikey.md) + +## SearchConfigWithApiKey interface + +Configuration options for [SearchCore](./search-headless.searchcore.md), which includes the options from [BaseSearchConfig](./search-headless.basesearchconfig.md), but requires apiKey. + +Signature: + +```typescript +export declare interface SearchConfigWithApiKey extends BaseSearchConfig +``` +Extends: [BaseSearchConfig](./search-headless.basesearchconfig.md) + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [apiKey](./search-headless.searchconfigwithapikey.apikey.md) | string | The api key of the search experience which will be sent as a query param. | +| [token?](./search-headless.searchconfigwithapikey.token.md) | never | (Optional) token should NOT be provided along with apiKey. | + diff --git a/docs/search-headless.answersconfigwithapikey.token.md b/docs/search-headless.searchconfigwithapikey.token.md similarity index 55% rename from docs/search-headless.answersconfigwithapikey.token.md rename to docs/search-headless.searchconfigwithapikey.token.md index ae39b2d4..58550fad 100644 --- a/docs/search-headless.answersconfigwithapikey.token.md +++ b/docs/search-headless.searchconfigwithapikey.token.md @@ -1,8 +1,8 @@ -[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [AnswersConfigWithApiKey](./search-headless.answersconfigwithapikey.md) > [token](./search-headless.answersconfigwithapikey.token.md) +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [SearchConfigWithApiKey](./search-headless.searchconfigwithapikey.md) > [token](./search-headless.searchconfigwithapikey.token.md) -## AnswersConfigWithApiKey.token property +## SearchConfigWithApiKey.token property token should NOT be provided along with apiKey. diff --git a/docs/search-headless.answersconfigwithtoken.apikey.md b/docs/search-headless.searchconfigwithtoken.apikey.md similarity index 55% rename from docs/search-headless.answersconfigwithtoken.apikey.md rename to docs/search-headless.searchconfigwithtoken.apikey.md index 52ffa271..3579426a 100644 --- a/docs/search-headless.answersconfigwithtoken.apikey.md +++ b/docs/search-headless.searchconfigwithtoken.apikey.md @@ -1,8 +1,8 @@ -[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [AnswersConfigWithToken](./search-headless.answersconfigwithtoken.md) > [apiKey](./search-headless.answersconfigwithtoken.apikey.md) +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [SearchConfigWithToken](./search-headless.searchconfigwithtoken.md) > [apiKey](./search-headless.searchconfigwithtoken.apikey.md) -## AnswersConfigWithToken.apiKey property +## SearchConfigWithToken.apiKey property apiKey should NOT be provided along with token. diff --git a/docs/search-headless.searchconfigwithtoken.md b/docs/search-headless.searchconfigwithtoken.md new file mode 100644 index 00000000..2d0a30f0 --- /dev/null +++ b/docs/search-headless.searchconfigwithtoken.md @@ -0,0 +1,22 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [SearchConfigWithToken](./search-headless.searchconfigwithtoken.md) + +## SearchConfigWithToken interface + +Configuration options for [SearchCore](./search-headless.searchcore.md), which includes the options from [BaseSearchConfig](./search-headless.basesearchconfig.md), but requires token. + +Signature: + +```typescript +export declare interface SearchConfigWithToken extends BaseSearchConfig +``` +Extends: [BaseSearchConfig](./search-headless.basesearchconfig.md) + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [apiKey?](./search-headless.searchconfigwithtoken.apikey.md) | never | (Optional) apiKey should NOT be provided along with token. | +| [token](./search-headless.searchconfigwithtoken.token.md) | string | The authentication token of the search experience which will be passed in the Auth header as a Bearer token. | + diff --git a/docs/search-headless.searchconfigwithtoken.token.md b/docs/search-headless.searchconfigwithtoken.token.md new file mode 100644 index 00000000..c749fb8b --- /dev/null +++ b/docs/search-headless.searchconfigwithtoken.token.md @@ -0,0 +1,13 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [SearchConfigWithToken](./search-headless.searchconfigwithtoken.md) > [token](./search-headless.searchconfigwithtoken.token.md) + +## SearchConfigWithToken.token property + +The authentication token of the search experience which will be passed in the Auth header as a Bearer token. + +Signature: + +```typescript +token: string; +``` diff --git a/docs/search-headless.answerscore._constructor_.md b/docs/search-headless.searchcore._constructor_.md similarity index 74% rename from docs/search-headless.answerscore._constructor_.md rename to docs/search-headless.searchcore._constructor_.md index 29e9942a..763c7487 100644 --- a/docs/search-headless.answerscore._constructor_.md +++ b/docs/search-headless.searchcore._constructor_.md @@ -1,10 +1,10 @@ -[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [AnswersCore](./search-headless.answerscore.md) > [(constructor)](./search-headless.answerscore._constructor_.md) +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [SearchCore](./search-headless.searchcore.md) > [(constructor)](./search-headless.searchcore._constructor_.md) -## AnswersCore.(constructor) +## SearchCore.(constructor) -Constructs a new instance of the `AnswersCore` class +Constructs a new instance of the `SearchCore` class Signature: diff --git a/docs/search-headless.answerscore.filtersearch.md b/docs/search-headless.searchcore.filtersearch.md similarity index 80% rename from docs/search-headless.answerscore.filtersearch.md rename to docs/search-headless.searchcore.filtersearch.md index 698ca48b..850d60b2 100644 --- a/docs/search-headless.answerscore.filtersearch.md +++ b/docs/search-headless.searchcore.filtersearch.md @@ -1,8 +1,8 @@ -[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [AnswersCore](./search-headless.answerscore.md) > [filterSearch](./search-headless.answerscore.filtersearch.md) +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [SearchCore](./search-headless.searchcore.md) > [filterSearch](./search-headless.searchcore.filtersearch.md) -## AnswersCore.filterSearch() method +## SearchCore.filterSearch() method Performs a filtersearch request against specified fields within a single vertical. @@ -24,7 +24,7 @@ Promise<[FilterSearchResponse](./search-headless.filtersearchresponse.md). +This differs from the vertical autocomplete because the vertical autocomplete operates on all entity fields whereas filtersearch operates only on specified fields. If rejected, the reason will be an [SearchError](./search-headless.searcherror.md). ## Example diff --git a/docs/search-headless.searchcore.md b/docs/search-headless.searchcore.md new file mode 100644 index 00000000..ae4a2086 --- /dev/null +++ b/docs/search-headless.searchcore.md @@ -0,0 +1,31 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [SearchCore](./search-headless.searchcore.md) + +## SearchCore class + +Provides methods for executing searches, submitting questions, and performing autocompletes. + +Signature: + +```typescript +export declare class SearchCore +``` + +## Constructors + +| Constructor | Modifiers | Description | +| --- | --- | --- | +| [(constructor)(searchService, questionSubmissionService, autoCompleteService)](./search-headless.searchcore._constructor_.md) | | Constructs a new instance of the SearchCore class | + +## Methods + +| Method | Modifiers | Description | +| --- | --- | --- | +| [filterSearch(request)](./search-headless.searchcore.filtersearch.md) | | Performs a filtersearch request against specified fields within a single vertical. | +| [submitQuestion(request)](./search-headless.searchcore.submitquestion.md) | | Submits a custom question to the Search API. | +| [universalAutocomplete(request)](./search-headless.searchcore.universalautocomplete.md) | | Performs an autocomplete request across all verticals. | +| [universalSearch(request)](./search-headless.searchcore.universalsearch.md) | | Performs a search across all verticals. | +| [verticalAutocomplete(request)](./search-headless.searchcore.verticalautocomplete.md) | | Performs an autocomplete request for a single vertical. | +| [verticalSearch(request)](./search-headless.searchcore.verticalsearch.md) | | Performs a search for a single vertical. | + diff --git a/docs/search-headless.answerscore.submitquestion.md b/docs/search-headless.searchcore.submitquestion.md similarity index 64% rename from docs/search-headless.answerscore.submitquestion.md rename to docs/search-headless.searchcore.submitquestion.md index 18baac8d..320963c7 100644 --- a/docs/search-headless.answerscore.submitquestion.md +++ b/docs/search-headless.searchcore.submitquestion.md @@ -1,10 +1,10 @@ -[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [AnswersCore](./search-headless.answerscore.md) > [submitQuestion](./search-headless.answerscore.submitquestion.md) +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [SearchCore](./search-headless.searchcore.md) > [submitQuestion](./search-headless.searchcore.submitquestion.md) -## AnswersCore.submitQuestion() method +## SearchCore.submitQuestion() method -Submits a custom question to the Answers API. +Submits a custom question to the Search API. Signature: @@ -24,5 +24,5 @@ Promise<[QuestionSubmissionResponse](./search-headless.questionsubmissionresp ## Remarks -If rejected, the reason will be an [AnswersError](./search-headless.answerserror.md). +If rejected, the reason will be an [SearchError](./search-headless.searcherror.md). diff --git a/docs/search-headless.answerscore.universalautocomplete.md b/docs/search-headless.searchcore.universalautocomplete.md similarity index 68% rename from docs/search-headless.answerscore.universalautocomplete.md rename to docs/search-headless.searchcore.universalautocomplete.md index b6bc7b82..cebca219 100644 --- a/docs/search-headless.answerscore.universalautocomplete.md +++ b/docs/search-headless.searchcore.universalautocomplete.md @@ -1,8 +1,8 @@ -[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [AnswersCore](./search-headless.answerscore.md) > [universalAutocomplete](./search-headless.answerscore.universalautocomplete.md) +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [SearchCore](./search-headless.searchcore.md) > [universalAutocomplete](./search-headless.searchcore.universalautocomplete.md) -## AnswersCore.universalAutocomplete() method +## SearchCore.universalAutocomplete() method Performs an autocomplete request across all verticals. @@ -24,5 +24,5 @@ Promise<[AutocompleteResponse](./search-headless.autocompleteresponse.md). +If rejected, the reason will be an [SearchError](./search-headless.searcherror.md). diff --git a/docs/search-headless.answerscore.universalsearch.md b/docs/search-headless.searchcore.universalsearch.md similarity index 63% rename from docs/search-headless.answerscore.universalsearch.md rename to docs/search-headless.searchcore.universalsearch.md index 5d5462f0..b5b96b0c 100644 --- a/docs/search-headless.answerscore.universalsearch.md +++ b/docs/search-headless.searchcore.universalsearch.md @@ -1,10 +1,10 @@ -[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [AnswersCore](./search-headless.answerscore.md) > [universalSearch](./search-headless.answerscore.universalsearch.md) +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [SearchCore](./search-headless.searchcore.md) > [universalSearch](./search-headless.searchcore.universalsearch.md) -## AnswersCore.universalSearch() method +## SearchCore.universalSearch() method -Performs an Answers search across all verticals. +Performs a search across all verticals. Signature: @@ -24,5 +24,5 @@ Promise<[UniversalSearchResponse](./search-headless.universalsearchresponse.m ## Remarks -If rejected, the reason will be an [AnswersError](./search-headless.answerserror.md). +If rejected, the reason will be an [SearchError](./search-headless.searcherror.md). diff --git a/docs/search-headless.answerscore.verticalautocomplete.md b/docs/search-headless.searchcore.verticalautocomplete.md similarity index 68% rename from docs/search-headless.answerscore.verticalautocomplete.md rename to docs/search-headless.searchcore.verticalautocomplete.md index 987e3b1c..2e961f2f 100644 --- a/docs/search-headless.answerscore.verticalautocomplete.md +++ b/docs/search-headless.searchcore.verticalautocomplete.md @@ -1,8 +1,8 @@ -[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [AnswersCore](./search-headless.answerscore.md) > [verticalAutocomplete](./search-headless.answerscore.verticalautocomplete.md) +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [SearchCore](./search-headless.searchcore.md) > [verticalAutocomplete](./search-headless.searchcore.verticalautocomplete.md) -## AnswersCore.verticalAutocomplete() method +## SearchCore.verticalAutocomplete() method Performs an autocomplete request for a single vertical. @@ -24,5 +24,5 @@ Promise<[AutocompleteResponse](./search-headless.autocompleteresponse.md). +If rejected, the reason will be an [SearchError](./search-headless.searcherror.md). diff --git a/docs/search-headless.answerscore.verticalsearch.md b/docs/search-headless.searchcore.verticalsearch.md similarity index 63% rename from docs/search-headless.answerscore.verticalsearch.md rename to docs/search-headless.searchcore.verticalsearch.md index b427cb82..6efac35e 100644 --- a/docs/search-headless.answerscore.verticalsearch.md +++ b/docs/search-headless.searchcore.verticalsearch.md @@ -1,10 +1,10 @@ -[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [AnswersCore](./search-headless.answerscore.md) > [verticalSearch](./search-headless.answerscore.verticalsearch.md) +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [SearchCore](./search-headless.searchcore.md) > [verticalSearch](./search-headless.searchcore.verticalsearch.md) -## AnswersCore.verticalSearch() method +## SearchCore.verticalSearch() method -Performs an Answers search for a single vertical. +Performs a search for a single vertical. Signature: @@ -24,5 +24,5 @@ Promise<[VerticalSearchResponse](./search-headless.verticalsearchresponse.md) ## Remarks -If rejected, the reason will be an [AnswersError](./search-headless.answerserror.md). +If rejected, the reason will be an [SearchError](./search-headless.searcherror.md). diff --git a/docs/search-headless.answerserror.code.md b/docs/search-headless.searcherror.code.md similarity index 52% rename from docs/search-headless.answerserror.code.md rename to docs/search-headless.searcherror.code.md index 27bee863..1c8b8fb5 100644 --- a/docs/search-headless.answerserror.code.md +++ b/docs/search-headless.searcherror.code.md @@ -1,10 +1,10 @@ -[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [AnswersError](./search-headless.answerserror.md) > [code](./search-headless.answerserror.code.md) +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [SearchError](./search-headless.searcherror.md) > [code](./search-headless.searcherror.code.md) -## AnswersError.code property +## SearchError.code property -Answers API error code. +Search API error code. Signature: diff --git a/docs/search-headless.searcherror.md b/docs/search-headless.searcherror.md new file mode 100644 index 00000000..9e70279f --- /dev/null +++ b/docs/search-headless.searcherror.md @@ -0,0 +1,27 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [SearchError](./search-headless.searcherror.md) + +## SearchError class + +Represents an error + +Signature: + +```typescript +export declare class SearchError extends Error +``` +Extends: Error + +## Remarks + +If the error originates from the Search API, the code and type property will be present. + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [code?](./search-headless.searcherror.code.md) | | number | (Optional) Search API error code. | +| [message](./search-headless.searcherror.message.md) | | string | The error message. | +| [type?](./search-headless.searcherror.type.md) | | string | (Optional) Search API error type. | + diff --git a/docs/search-headless.answerserror.message.md b/docs/search-headless.searcherror.message.md similarity index 57% rename from docs/search-headless.answerserror.message.md rename to docs/search-headless.searcherror.message.md index 7e29f286..8df7939e 100644 --- a/docs/search-headless.answerserror.message.md +++ b/docs/search-headless.searcherror.message.md @@ -1,8 +1,8 @@ -[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [AnswersError](./search-headless.answerserror.md) > [message](./search-headless.answerserror.message.md) +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [SearchError](./search-headless.searcherror.md) > [message](./search-headless.searcherror.message.md) -## AnswersError.message property +## SearchError.message property The error message. diff --git a/docs/search-headless.answerserror.type.md b/docs/search-headless.searcherror.type.md similarity index 52% rename from docs/search-headless.answerserror.type.md rename to docs/search-headless.searcherror.type.md index d1d03584..1173d5c8 100644 --- a/docs/search-headless.answerserror.type.md +++ b/docs/search-headless.searcherror.type.md @@ -1,10 +1,10 @@ -[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [AnswersError](./search-headless.answerserror.md) > [type](./search-headless.answerserror.type.md) +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [SearchError](./search-headless.searcherror.md) > [type](./search-headless.searcherror.type.md) -## AnswersError.type property +## SearchError.type property -Answers API error type. +Search API error type. Signature: diff --git a/docs/search-headless.searchheadless._constructor_.md b/docs/search-headless.searchheadless._constructor_.md index 5c45809d..e6d1be0b 100644 --- a/docs/search-headless.searchheadless._constructor_.md +++ b/docs/search-headless.searchheadless._constructor_.md @@ -9,14 +9,14 @@ Constructs a new instance of the `SearchHeadless` class Signature: ```typescript -constructor(core: AnswersCore, stateManager: StateManager, httpManager: HttpManager, additionalHttpHeaders?: AdditionalHttpHeaders | undefined); +constructor(core: SearchCore, stateManager: StateManager, httpManager: HttpManager, additionalHttpHeaders?: AdditionalHttpHeaders | undefined); ``` ## Parameters | Parameter | Type | Description | | --- | --- | --- | -| core | [AnswersCore](./search-headless.answerscore.md) | | +| core | [SearchCore](./search-headless.searchcore.md) | | | stateManager | StateManager | | | httpManager | HttpManager | | | additionalHttpHeaders | [AdditionalHttpHeaders](./search-headless.additionalhttpheaders.md) \| undefined | | diff --git a/docs/search-headless.searchheadless.md b/docs/search-headless.searchheadless.md index 658d509a..4163f2ae 100644 --- a/docs/search-headless.searchheadless.md +++ b/docs/search-headless.searchheadless.md @@ -4,7 +4,7 @@ ## SearchHeadless class -Provides the functionality for interacting with an Search experience. +Provides the functionality for interacting with a Search experience. Signature: diff --git a/docs/search-headless.searchheadless.utilities.md b/docs/search-headless.searchheadless.utilities.md index 0340903d..042aee69 100644 --- a/docs/search-headless.searchheadless.utilities.md +++ b/docs/search-headless.searchheadless.utilities.md @@ -10,3 +10,4 @@ Common utility functions for manipulating Search-related data. ```typescript readonly utilities: typeof searchUtilities; +``` diff --git a/docs/search-headless.searchintent.md b/docs/search-headless.searchintent.md index 1efe76de..1dc82924 100644 --- a/docs/search-headless.searchintent.md +++ b/docs/search-headless.searchintent.md @@ -4,7 +4,7 @@ ## SearchIntent enum -Represents intents from the Answers API. +Represents intents from the Search API. Signature: @@ -16,5 +16,5 @@ export declare enum SearchIntent | Member | Value | Description | | --- | --- | --- | -| NearMe | "NEAR_ME" | The Answers API is requesting a prompt for the user's location. | +| NearMe | "NEAR_ME" | The Search API is requesting a prompt for the user's location. | diff --git a/docs/search-headless.answersrequest.additionalhttpheaders.md b/docs/search-headless.searchrequest.additionalhttpheaders.md similarity index 60% rename from docs/search-headless.answersrequest.additionalhttpheaders.md rename to docs/search-headless.searchrequest.additionalhttpheaders.md index 7b57cc90..bb991b68 100644 --- a/docs/search-headless.answersrequest.additionalhttpheaders.md +++ b/docs/search-headless.searchrequest.additionalhttpheaders.md @@ -1,8 +1,8 @@ -[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [AnswersRequest](./search-headless.answersrequest.md) > [additionalHttpHeaders](./search-headless.answersrequest.additionalhttpheaders.md) +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [SearchRequest](./search-headless.searchrequest.md) > [additionalHttpHeaders](./search-headless.searchrequest.additionalhttpheaders.md) -## AnswersRequest.additionalHttpHeaders property +## SearchRequest.additionalHttpHeaders property AdditionalHttpHeaders allows users to specify additional values for specific HTTP headers. diff --git a/docs/search-headless.searchrequest.md b/docs/search-headless.searchrequest.md new file mode 100644 index 00000000..f051600b --- /dev/null +++ b/docs/search-headless.searchrequest.md @@ -0,0 +1,20 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [SearchRequest](./search-headless.searchrequest.md) + +## SearchRequest interface + +Options for a Search API request. + +Signature: + +```typescript +export declare interface SearchRequest +``` + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [additionalHttpHeaders?](./search-headless.searchrequest.additionalhttpheaders.md) | [AdditionalHttpHeaders](./search-headless.additionalhttpheaders.md) | (Optional) AdditionalHttpHeaders allows users to specify additional values for specific HTTP headers. | + diff --git a/docs/search-headless.searchservice.md b/docs/search-headless.searchservice.md index d92e497c..8a3c8227 100644 --- a/docs/search-headless.searchservice.md +++ b/docs/search-headless.searchservice.md @@ -4,7 +4,7 @@ ## SearchService interface -A service which performs Yext Answers searches +A service which performs Yext Search. Signature: diff --git a/docs/search-headless.source.md b/docs/search-headless.source.md index 121707c6..678c26c2 100644 --- a/docs/search-headless.source.md +++ b/docs/search-headless.source.md @@ -20,6 +20,6 @@ export declare enum Source | Bing | "BING_CSE" | The result is from Bing Search Engine. | | Custom | "CUSTOM_SEARCHER" | The result was from a custom source. | | Google | "GOOGLE_CSE" | The result is from Google Custom Search Engine. | -| KnowledgeManager | "KNOWLEDGE_MANAGER" | The result is from an Answers Knowledge Graph. | +| KnowledgeManager | "KNOWLEDGE_MANAGER" | The result is from a Knowledge Graph. | | Zendesk | "ZENDESK" | The result is from Zendesk. | diff --git a/docs/search-headless.universalautocompleterequest.md b/docs/search-headless.universalautocompleterequest.md index 4e67bb45..dd26eaa5 100644 --- a/docs/search-headless.universalautocompleterequest.md +++ b/docs/search-headless.universalautocompleterequest.md @@ -9,9 +9,9 @@ Options for a universal autocomplete request. Signature: ```typescript -export declare interface UniversalAutocompleteRequest extends AnswersRequest +export declare interface UniversalAutocompleteRequest extends SearchRequest ``` -Extends: [AnswersRequest](./search-headless.answersrequest.md) +Extends: [SearchRequest](./search-headless.searchrequest.md) ## Properties diff --git a/docs/search-headless.universalsearchrequest.context.md b/docs/search-headless.universalsearchrequest.context.md index 8016f0ca..e6f08168 100644 --- a/docs/search-headless.universalsearchrequest.context.md +++ b/docs/search-headless.universalsearchrequest.context.md @@ -4,7 +4,7 @@ ## UniversalSearchRequest.context property -Used to trigger Answers [Query Rules](https://hitchhikers.yext.com/tracks/answers-advanced/ans302-query-rules/). +Used to trigger Search [Query Rules](https://hitchhikers.yext.com/tracks/answers-advanced/ans302-query-rules/). Signature: diff --git a/docs/search-headless.universalsearchrequest.md b/docs/search-headless.universalsearchrequest.md index c33262b0..9af59147 100644 --- a/docs/search-headless.universalsearchrequest.md +++ b/docs/search-headless.universalsearchrequest.md @@ -9,15 +9,15 @@ Options which can be specified for a universal search. Signature: ```typescript -export declare interface UniversalSearchRequest extends AnswersRequest +export declare interface UniversalSearchRequest extends SearchRequest ``` -Extends: [AnswersRequest](./search-headless.answersrequest.md) +Extends: [SearchRequest](./search-headless.searchrequest.md) ## Properties | Property | Type | Description | | --- | --- | --- | -| [context?](./search-headless.universalsearchrequest.context.md) | [Context](./search-headless.context.md) | (Optional) Used to trigger Answers [Query Rules](https://hitchhikers.yext.com/tracks/answers-advanced/ans302-query-rules/). | +| [context?](./search-headless.universalsearchrequest.context.md) | [Context](./search-headless.context.md) | (Optional) Used to trigger Search [Query Rules](https://hitchhikers.yext.com/tracks/answers-advanced/ans302-query-rules/). | | [limit?](./search-headless.universalsearchrequest.limit.md) | [UniversalLimit](./search-headless.universallimit.md) | (Optional) The maximum limit of results per vertical. Each limit can be set from 1-50, inclusive. | | [location?](./search-headless.universalsearchrequest.location.md) | [LatLong](./search-headless.latlong.md) | (Optional) The latitude and longitude of the user making the request. Used to bias the results. | | [query](./search-headless.universalsearchrequest.query.md) | string | The search query. | diff --git a/docs/search-headless.universalsearchresponse.md b/docs/search-headless.universalsearchresponse.md index bd2e465b..44e16d63 100644 --- a/docs/search-headless.universalsearchresponse.md +++ b/docs/search-headless.universalsearchresponse.md @@ -20,7 +20,7 @@ export declare interface UniversalSearchResponse | [failedVerticals?](./search-headless.universalsearchresponse.failedverticals.md) | [FailedVertical](./search-headless.failedvertical.md)\[\] | (Optional) Error information from when a vertical fails to return results. | | [locationBias?](./search-headless.universalsearchresponse.locationbias.md) | [LocationBias](./search-headless.locationbias.md) | (Optional) Information about the user's location. | | [queryId?](./search-headless.universalsearchresponse.queryid.md) | string | (Optional) The ID of the search query. | -| [queryRulesActionsData?](./search-headless.universalsearchresponse.queryrulesactionsdata.md) | [QueryRulesActionsData](./search-headless.queryrulesactionsdata.md)\[\] | (Optional) Data returned from the Answers query rules system. | +| [queryRulesActionsData?](./search-headless.universalsearchresponse.queryrulesactionsdata.md) | [QueryRulesActionsData](./search-headless.queryrulesactionsdata.md)\[\] | (Optional) Data returned from the Search query rules system. | | [searchIntents?](./search-headless.universalsearchresponse.searchintents.md) | [SearchIntent](./search-headless.searchintent.md)\[\] | (Optional) An array of [SearchIntent](./search-headless.searchintent.md)s which represents requests from the API. | | [spellCheck?](./search-headless.universalsearchresponse.spellcheck.md) | [SpellCheck](./search-headless.spellcheck.md) | (Optional) A spellcheck response from a search query. | | [uuid](./search-headless.universalsearchresponse.uuid.md) | string | A unique id which corresponds to the request. | diff --git a/docs/search-headless.universalsearchresponse.queryrulesactionsdata.md b/docs/search-headless.universalsearchresponse.queryrulesactionsdata.md index 24374dfd..ceaee97b 100644 --- a/docs/search-headless.universalsearchresponse.queryrulesactionsdata.md +++ b/docs/search-headless.universalsearchresponse.queryrulesactionsdata.md @@ -4,7 +4,7 @@ ## UniversalSearchResponse.queryRulesActionsData property -Data returned from the Answers query rules system. +Data returned from the Search query rules system. Signature: diff --git a/docs/search-headless.verticalautocompleterequest.md b/docs/search-headless.verticalautocompleterequest.md index 53d49fcc..f2bf3b7b 100644 --- a/docs/search-headless.verticalautocompleterequest.md +++ b/docs/search-headless.verticalautocompleterequest.md @@ -9,9 +9,9 @@ Options for a vertial autocomplete request. Signature: ```typescript -export declare interface VerticalAutocompleteRequest extends AnswersRequest +export declare interface VerticalAutocompleteRequest extends SearchRequest ``` -Extends: [AnswersRequest](./search-headless.answersrequest.md) +Extends: [SearchRequest](./search-headless.searchrequest.md) ## Properties diff --git a/docs/search-headless.verticalsearchrequest.context.md b/docs/search-headless.verticalsearchrequest.context.md index 8a837477..f229070f 100644 --- a/docs/search-headless.verticalsearchrequest.context.md +++ b/docs/search-headless.verticalsearchrequest.context.md @@ -4,7 +4,7 @@ ## VerticalSearchRequest.context property -Used to trigger Answers [Query Rules](https://hitchhikers.yext.com/tracks/answers-advanced/ans302-query-rules/). +Used to trigger Search [Query Rules](https://hitchhikers.yext.com/tracks/answers-advanced/ans302-query-rules/). Signature: diff --git a/docs/search-headless.verticalsearchrequest.md b/docs/search-headless.verticalsearchrequest.md index 5c242ee4..4602ba9b 100644 --- a/docs/search-headless.verticalsearchrequest.md +++ b/docs/search-headless.verticalsearchrequest.md @@ -9,15 +9,15 @@ Options which can be specified for a vertical search. Signature: ```typescript -export declare interface VerticalSearchRequest extends AnswersRequest +export declare interface VerticalSearchRequest extends SearchRequest ``` -Extends: [AnswersRequest](./search-headless.answersrequest.md) +Extends: [SearchRequest](./search-headless.searchrequest.md) ## Properties | Property | Type | Description | | --- | --- | --- | -| [context?](./search-headless.verticalsearchrequest.context.md) | [Context](./search-headless.context.md) | (Optional) Used to trigger Answers [Query Rules](https://hitchhikers.yext.com/tracks/answers-advanced/ans302-query-rules/). | +| [context?](./search-headless.verticalsearchrequest.context.md) | [Context](./search-headless.context.md) | (Optional) Used to trigger Search [Query Rules](https://hitchhikers.yext.com/tracks/answers-advanced/ans302-query-rules/). | | [facets?](./search-headless.verticalsearchrequest.facets.md) | [Facet](./search-headless.facet.md)\[\] | (Optional) The facet filters to apply to the search. | | [limit?](./search-headless.verticalsearchrequest.limit.md) | number | (Optional) The maximum number of results to include with a max of 50. | | [location?](./search-headless.verticalsearchrequest.location.md) | [LatLong](./search-headless.latlong.md) | (Optional) The latitude and longitude of the user making the request. Used to bias the results. | diff --git a/docs/search-headless.verticalsearchresponse.md b/docs/search-headless.verticalsearchresponse.md index 92751551..7c0e1168 100644 --- a/docs/search-headless.verticalsearchresponse.md +++ b/docs/search-headless.verticalsearchresponse.md @@ -22,7 +22,7 @@ export declare interface VerticalSearchResponse | [facets?](./search-headless.verticalsearchresponse.facets.md) | [DisplayableFacet](./search-headless.displayablefacet.md)\[\] | (Optional) An array of [Facet](./search-headless.facet.md)s associated with the search results. | | [locationBias?](./search-headless.verticalsearchresponse.locationbias.md) | [LocationBias](./search-headless.locationbias.md) | (Optional) Information about the user's location. | | [queryId](./search-headless.verticalsearchresponse.queryid.md) | string | The ID of the query. | -| [queryRulesActionsData?](./search-headless.verticalsearchresponse.queryrulesactionsdata.md) | [QueryRulesActionsData](./search-headless.queryrulesactionsdata.md)\[\] | (Optional) Data returned from the Answers query rules system. | +| [queryRulesActionsData?](./search-headless.verticalsearchresponse.queryrulesactionsdata.md) | [QueryRulesActionsData](./search-headless.queryrulesactionsdata.md)\[\] | (Optional) Data returned from the Search query rules system. | | [searchIntents?](./search-headless.verticalsearchresponse.searchintents.md) | [SearchIntent](./search-headless.searchintent.md)\[\] | (Optional) An array of [SearchIntent](./search-headless.searchintent.md)s. | | [spellCheck?](./search-headless.verticalsearchresponse.spellcheck.md) | [SpellCheck](./search-headless.spellcheck.md) | (Optional) A spellcheck response from a search query. | | [uuid](./search-headless.verticalsearchresponse.uuid.md) | string | A unique id which corresponds to the request. | diff --git a/docs/search-headless.verticalsearchresponse.queryrulesactionsdata.md b/docs/search-headless.verticalsearchresponse.queryrulesactionsdata.md index 276c2315..796bd7d8 100644 --- a/docs/search-headless.verticalsearchresponse.queryrulesactionsdata.md +++ b/docs/search-headless.verticalsearchresponse.queryrulesactionsdata.md @@ -4,7 +4,7 @@ ## VerticalSearchResponse.queryRulesActionsData property -Data returned from the Answers query rules system. +Data returned from the Search query rules system. Signature: diff --git a/etc/search-headless.api.md b/etc/search-headless.api.md index 75d31c54..049e5f9b 100644 --- a/etc/search-headless.api.md +++ b/etc/search-headless.api.md @@ -18,48 +18,9 @@ export interface AllResultsForVertical { resultsCount: number; } -// @public -export type AnswersConfig = AnswersConfigWithApiKey | AnswersConfigWithToken; - -// @public -export interface AnswersConfigWithApiKey extends BaseAnswersConfig { - apiKey: string; - token?: never; -} - -// @public -export interface AnswersConfigWithToken extends BaseAnswersConfig { - apiKey?: never; - token: string; -} - -// @public -export class AnswersCore { - constructor(searchService: SearchService, questionSubmissionService: QuestionSubmissionService, autoCompleteService: AutocompleteService); - filterSearch(request: FilterSearchRequest): Promise; - submitQuestion(request: QuestionSubmissionRequest): Promise; - universalAutocomplete(request: UniversalAutocompleteRequest): Promise; - universalSearch(request: UniversalSearchRequest): Promise; - verticalAutocomplete(request: VerticalAutocompleteRequest): Promise; - verticalSearch(request: VerticalSearchRequest): Promise; -} - -// @public -export class AnswersError extends Error { - code?: number; - message: string; - type?: string; - /* Excluded from this release type: __constructor */ -} - // @public @deprecated (undocumented) export const AnswersHeadless: typeof SearchHeadless; -// @public -export interface AnswersRequest { - additionalHttpHeaders?: AdditionalHttpHeaders; -} - // @public @deprecated (undocumented) export const answersUtilities: typeof searchUtilities; @@ -108,7 +69,7 @@ export interface AutocompleteService { } // @public -export interface BaseAnswersConfig { +export interface BaseSearchConfig { endpoints?: Endpoints; experienceKey: string; experienceVersion?: 'STAGING' | 'PRODUCTION' | string | number; @@ -286,7 +247,7 @@ export enum FilterCombinator { } // @public -export interface FilterSearchRequest extends AnswersRequest { +export interface FilterSearchRequest extends SearchRequest { excluded?: Filter[]; fields: SearchParameterField[]; input: string; @@ -316,7 +277,7 @@ export interface FiltersState { export type FilterTypes = Filter | CombinedFilter; // @public -export type HeadlessConfig = AnswersConfig & { +export type HeadlessConfig = SearchConfig & { headlessId?: string; verticalKey?: string; }; @@ -477,7 +438,7 @@ export enum QueryTrigger { } // @public -export interface QuestionSubmissionRequest extends AnswersRequest { +export interface QuestionSubmissionRequest extends SearchRequest { email: string; entityId: string; name: string; @@ -520,10 +481,44 @@ export interface Result { // @public export const SandboxEndpoints: Required; +// @public +export type SearchConfig = SearchConfigWithApiKey | SearchConfigWithToken; + +// @public +export interface SearchConfigWithApiKey extends BaseSearchConfig { + apiKey: string; + token?: never; +} + +// @public +export interface SearchConfigWithToken extends BaseSearchConfig { + apiKey?: never; + token: string; +} + +// @public +export class SearchCore { + constructor(searchService: SearchService, questionSubmissionService: QuestionSubmissionService, autoCompleteService: AutocompleteService); + filterSearch(request: FilterSearchRequest): Promise; + submitQuestion(request: QuestionSubmissionRequest): Promise; + universalAutocomplete(request: UniversalAutocompleteRequest): Promise; + universalSearch(request: UniversalSearchRequest): Promise; + verticalAutocomplete(request: VerticalAutocompleteRequest): Promise; + verticalSearch(request: VerticalSearchRequest): Promise; +} + +// @public +export class SearchError extends Error { + code?: number; + message: string; + type?: string; + /* Excluded from this release type: __constructor */ +} + // @public export class SearchHeadless { // Warning: (ae-forgotten-export) The symbol "HttpManager" needs to be exported by the entry point index.d.ts - constructor(core: AnswersCore, stateManager: StateManager, httpManager: HttpManager, additionalHttpHeaders?: AdditionalHttpHeaders | undefined); + constructor(core: SearchCore, stateManager: StateManager, httpManager: HttpManager, additionalHttpHeaders?: AdditionalHttpHeaders | undefined); addListener(listener: StateListener): Unsubscribe; executeFilterSearch(query: string, sectioned: boolean, fields: SearchParameterField[]): Promise; executeUniversalAutocomplete(): Promise; @@ -570,6 +565,11 @@ export interface SearchParameterField { fieldApiName: string; } +// @public +export interface SearchRequest { + additionalHttpHeaders?: AdditionalHttpHeaders; +} + // @public export interface SearchService { universalSearch(request: UniversalSearchRequest): Promise; @@ -694,7 +694,7 @@ export interface StateManager { } // @public -export interface UniversalAutocompleteRequest extends AnswersRequest { +export interface UniversalAutocompleteRequest extends SearchRequest { input: string; sessionTrackingEnabled?: boolean; } @@ -706,7 +706,7 @@ export interface UniversalLimit { } // @public -export interface UniversalSearchRequest extends AnswersRequest { +export interface UniversalSearchRequest extends SearchRequest { context?: Context; limit?: UniversalLimit; location?: LatLong; @@ -747,7 +747,7 @@ export interface UpperNumberRangeLimit { } // @public -export interface VerticalAutocompleteRequest extends AnswersRequest { +export interface VerticalAutocompleteRequest extends SearchRequest { input: string; sessionTrackingEnabled?: boolean; verticalKey: string; @@ -764,7 +764,7 @@ export interface VerticalResults { } // @public -export interface VerticalSearchRequest extends AnswersRequest { +export interface VerticalSearchRequest extends SearchRequest { context?: Context; facets?: Facet[]; limit?: number; From 9fd0eb90a04a7fd9ac984c03ee59e9e0b681c102 Mon Sep 17 00:00:00 2001 From: Cindy Yang Date: Tue, 12 Jul 2022 16:13:57 -0400 Subject: [PATCH 19/22] export deprecated answers-core things --- src/deprecated.ts | 10 ++++++++++ src/search-core-re-exports.ts | 2 +- 2 files changed, 11 insertions(+), 1 deletion(-) diff --git a/src/deprecated.ts b/src/deprecated.ts index 00bc4cda..3d326d29 100644 --- a/src/deprecated.ts +++ b/src/deprecated.ts @@ -1,6 +1,16 @@ import { searchUtilities, provideHeadless } from '.'; import SearchHeadless from './search-headless'; +export { + AnswersConfig, + AnswersConfigWithToken, + AnswersConfigWithApiKey, + AnswersCore, + AnswersError, + AnswersRequest, + BaseAnswersConfig +} from '@yext/search-core'; + /** * @public * diff --git a/src/search-core-re-exports.ts b/src/search-core-re-exports.ts index c272af05..d1331649 100644 --- a/src/search-core-re-exports.ts +++ b/src/search-core-re-exports.ts @@ -69,4 +69,4 @@ export { VerticalSearchRequest, VerticalSearchResponse, Visitor -} from '@yext/search-core'; +} from '@yext/search-core'; \ No newline at end of file From 2110f303eaa4c48d87b4c3e458a9a6964af26412 Mon Sep 17 00:00:00 2001 From: Cindy Yang Date: Tue, 12 Jul 2022 16:15:23 -0400 Subject: [PATCH 20/22] fix link --- src/http-manager.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/http-manager.ts b/src/http-manager.ts index 1594081f..bea3b142 100644 --- a/src/http-manager.ts +++ b/src/http-manager.ts @@ -6,7 +6,7 @@ type ServiceIds = { /** * Assigns numeric IDs to every http request and the corresponding response - * through {@link AnswersCore}. This helps track the received order of requests + * through {@link SearchCore}. This helps track the received order of requests * and responses. {@link SearchHeadless} uses it to ensure dispatch events for * state updates are triggered with up-to-date responses (e.g. if the newly received * response has a higher ID number than the recorded received response). From e1948e1850a0b8c55dc83d28fd1b160a5aa480b3 Mon Sep 17 00:00:00 2001 From: github-actions <41898282+github-actions[bot]@users.noreply.github.com> Date: Tue, 12 Jul 2022 20:15:51 +0000 Subject: [PATCH 21/22] Automated update to repo's documentation from github action --- docs/search-headless.answersconfig.md | 18 +++++++++++++ ...search-headless.answersconfigwithapikey.md | 18 +++++++++++++ .../search-headless.answersconfigwithtoken.md | 18 +++++++++++++ docs/search-headless.answerscore.md | 18 +++++++++++++ docs/search-headless.answerserror.md | 18 +++++++++++++ docs/search-headless.answersrequest.md | 18 +++++++++++++ docs/search-headless.baseanswersconfig.md | 18 +++++++++++++ docs/search-headless.md | 7 +++++ etc/search-headless.api.md | 27 +++++++++++++++++++ 9 files changed, 160 insertions(+) create mode 100644 docs/search-headless.answersconfig.md create mode 100644 docs/search-headless.answersconfigwithapikey.md create mode 100644 docs/search-headless.answersconfigwithtoken.md create mode 100644 docs/search-headless.answerscore.md create mode 100644 docs/search-headless.answerserror.md create mode 100644 docs/search-headless.answersrequest.md create mode 100644 docs/search-headless.baseanswersconfig.md diff --git a/docs/search-headless.answersconfig.md b/docs/search-headless.answersconfig.md new file mode 100644 index 00000000..3642f101 --- /dev/null +++ b/docs/search-headless.answersconfig.md @@ -0,0 +1,18 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [AnswersConfig](./search-headless.answersconfig.md) + +## AnswersConfig type + +> Warning: This API is now obsolete. +> +> AnswersConfig is deprecated and has been replaced by [SearchConfig](./search-headless.searchconfig.md) +> + +Signature: + +```typescript +export declare type AnswersConfig = SearchConfig; +``` +References: [SearchConfig](./search-headless.searchconfig.md) + diff --git a/docs/search-headless.answersconfigwithapikey.md b/docs/search-headless.answersconfigwithapikey.md new file mode 100644 index 00000000..70b3d3f1 --- /dev/null +++ b/docs/search-headless.answersconfigwithapikey.md @@ -0,0 +1,18 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [AnswersConfigWithApiKey](./search-headless.answersconfigwithapikey.md) + +## AnswersConfigWithApiKey interface + +> Warning: This API is now obsolete. +> +> AnswersConfigWithApiKey is deprecated and has been replaced by [SearchConfigWithApiKey](./search-headless.searchconfigwithapikey.md) +> + +Signature: + +```typescript +export declare interface AnswersConfigWithApiKey extends SearchConfigWithApiKey +``` +Extends: [SearchConfigWithApiKey](./search-headless.searchconfigwithapikey.md) + diff --git a/docs/search-headless.answersconfigwithtoken.md b/docs/search-headless.answersconfigwithtoken.md new file mode 100644 index 00000000..dd00b76a --- /dev/null +++ b/docs/search-headless.answersconfigwithtoken.md @@ -0,0 +1,18 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [AnswersConfigWithToken](./search-headless.answersconfigwithtoken.md) + +## AnswersConfigWithToken interface + +> Warning: This API is now obsolete. +> +> AnswersConfigWithToken is deprecated and has been replaced by [SearchConfigWithToken](./search-headless.searchconfigwithtoken.md) +> + +Signature: + +```typescript +export declare interface AnswersConfigWithToken extends SearchConfigWithToken +``` +Extends: [SearchConfigWithToken](./search-headless.searchconfigwithtoken.md) + diff --git a/docs/search-headless.answerscore.md b/docs/search-headless.answerscore.md new file mode 100644 index 00000000..8d9b67af --- /dev/null +++ b/docs/search-headless.answerscore.md @@ -0,0 +1,18 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [AnswersCore](./search-headless.answerscore.md) + +## AnswersCore class + +> Warning: This API is now obsolete. +> +> AnswersCore is deprecated and has been replaced by [SearchCore](./search-headless.searchcore.md) +> + +Signature: + +```typescript +export declare class AnswersCore extends SearchCore +``` +Extends: [SearchCore](./search-headless.searchcore.md) + diff --git a/docs/search-headless.answerserror.md b/docs/search-headless.answerserror.md new file mode 100644 index 00000000..c6aa99a6 --- /dev/null +++ b/docs/search-headless.answerserror.md @@ -0,0 +1,18 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [AnswersError](./search-headless.answerserror.md) + +## AnswersError interface + +> Warning: This API is now obsolete. +> +> AnswersError is deprecated and has been replaced by [SearchError](./search-headless.searcherror.md) +> + +Signature: + +```typescript +export declare interface AnswersError extends SearchError +``` +Extends: [SearchError](./search-headless.searcherror.md) + diff --git a/docs/search-headless.answersrequest.md b/docs/search-headless.answersrequest.md new file mode 100644 index 00000000..ef1f1198 --- /dev/null +++ b/docs/search-headless.answersrequest.md @@ -0,0 +1,18 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [AnswersRequest](./search-headless.answersrequest.md) + +## AnswersRequest interface + +> Warning: This API is now obsolete. +> +> AnswersRequest is deprecated and has been replaced by [SearchRequest](./search-headless.searchrequest.md) +> + +Signature: + +```typescript +export declare interface AnswersRequest extends SearchRequest +``` +Extends: [SearchRequest](./search-headless.searchrequest.md) + diff --git a/docs/search-headless.baseanswersconfig.md b/docs/search-headless.baseanswersconfig.md new file mode 100644 index 00000000..cf0a755f --- /dev/null +++ b/docs/search-headless.baseanswersconfig.md @@ -0,0 +1,18 @@ + + +[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [BaseAnswersConfig](./search-headless.baseanswersconfig.md) + +## BaseAnswersConfig interface + +> Warning: This API is now obsolete. +> +> BaseAnswersConfig is deprecated and has been replaced by [BaseSearchConfig](./search-headless.basesearchconfig.md) +> + +Signature: + +```typescript +export declare interface BaseAnswersConfig extends BaseSearchConfig +``` +Extends: [BaseSearchConfig](./search-headless.basesearchconfig.md) + diff --git a/docs/search-headless.md b/docs/search-headless.md index 927d4e99..54d637cf 100644 --- a/docs/search-headless.md +++ b/docs/search-headless.md @@ -8,6 +8,7 @@ | Class | Description | | --- | --- | +| [AnswersCore](./search-headless.answerscore.md) | | | [SearchCore](./search-headless.searchcore.md) | Provides methods for executing searches, submitting questions, and performing autocompletes. | | [SearchError](./search-headless.searcherror.md) | Represents an error | | [SearchHeadless](./search-headless.searchheadless.md) | Provides the functionality for interacting with a Search experience. | @@ -48,10 +49,15 @@ | --- | --- | | [AdditionalHttpHeaders](./search-headless.additionalhttpheaders.md) | AdditionalHttpHeaders allows users to specify additional values for specific HTTP headers. | | [AllResultsForVertical](./search-headless.allresultsforvertical.md) | Represents all results for the current vertical. | +| [AnswersConfigWithApiKey](./search-headless.answersconfigwithapikey.md) | | +| [AnswersConfigWithToken](./search-headless.answersconfigwithtoken.md) | | +| [AnswersError](./search-headless.answerserror.md) | | +| [AnswersRequest](./search-headless.answersrequest.md) | | | [AppliedQueryFilter](./search-headless.appliedqueryfilter.md) | A filter that the Search API applied to the search. | | [AutocompleteResponse](./search-headless.autocompleteresponse.md) | The response of a universal or vertical autocomplete request. | | [AutocompleteResult](./search-headless.autocompleteresult.md) | An autocomplete suggestion. | | [AutocompleteService](./search-headless.autocompleteservice.md) | A service for autocomplete requests. | +| [BaseAnswersConfig](./search-headless.baseanswersconfig.md) | | | [BaseSearchConfig](./search-headless.basesearchconfig.md) | The base configuration options for [SearchCore](./search-headless.searchcore.md). | | [BoundedRange](./search-headless.boundedrange.md) | An interface representing a range of values of type T. | | [ClientSDKHeaderValues](./search-headless.clientsdkheadervalues.md) | 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. | @@ -137,6 +143,7 @@ | Type Alias | Description | | --- | --- | +| [AnswersConfig](./search-headless.answersconfig.md) | | | [Context](./search-headless.context.md) | Used to trigger Search [Query Rules](https://hitchhikers.yext.com/tracks/answers-advanced/ans302-query-rules/). | | [EnumOrLiteral](./search-headless.enumorliteral.md) | Produces a union type from the enum passed as a generic which consists of the enum values and the string literals of the enum. | | [FilterTypes](./search-headless.filtertypes.md) | A union type for the different kinds of filter. | diff --git a/etc/search-headless.api.md b/etc/search-headless.api.md index 049e5f9b..6aa62db7 100644 --- a/etc/search-headless.api.md +++ b/etc/search-headless.api.md @@ -18,9 +18,32 @@ export interface AllResultsForVertical { resultsCount: number; } +// @public @deprecated (undocumented) +export type AnswersConfig = SearchConfig; + +// @public @deprecated (undocumented) +export interface AnswersConfigWithApiKey extends SearchConfigWithApiKey { +} + +// @public @deprecated (undocumented) +export interface AnswersConfigWithToken extends SearchConfigWithToken { +} + +// @public @deprecated (undocumented) +export class AnswersCore extends SearchCore { +} + +// @public @deprecated (undocumented) +export interface AnswersError extends SearchError { +} + // @public @deprecated (undocumented) export const AnswersHeadless: typeof SearchHeadless; +// @public @deprecated (undocumented) +export interface AnswersRequest extends SearchRequest { +} + // @public @deprecated (undocumented) export const answersUtilities: typeof searchUtilities; @@ -68,6 +91,10 @@ export interface AutocompleteService { verticalAutocomplete(request: VerticalAutocompleteRequest): Promise; } +// @public @deprecated (undocumented) +export interface BaseAnswersConfig extends BaseSearchConfig { +} + // @public export interface BaseSearchConfig { endpoints?: Endpoints; From 421a8beff73eaa81862a77c0561175815cd81b33 Mon Sep 17 00:00:00 2001 From: Cindy Yang Date: Tue, 12 Jul 2022 16:18:09 -0400 Subject: [PATCH 22/22] replaced some imports from search-core in index --- src/index.ts | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/index.ts b/src/index.ts index 3ce0a9f9..984e2724 100644 --- a/src/index.ts +++ b/src/index.ts @@ -77,13 +77,13 @@ export function provideHeadless( const { verticalKey, headlessId, - ...answersConfig + ...searchConfig } = config; if (headlessId === DEFAULT_HEADLESS_ID) { throw new Error(`Cannot instantiate a SearchHeadless using the default headlessId "${headlessId}". ` + 'Specify a different headlessId.'); } - const answersCore = provideCore(answersConfig); + const answersCore = provideCore(searchConfig); const stateManager = new ReduxStateManager( store, headlessId || DEFAULT_HEADLESS_ID, headlessReducerManager); const httpManager = new HttpManager();