diff --git a/docs/search-core.builtinfieldtype.md b/docs/search-core.builtinfieldtype.md index e6a1f6d2..feeacf39 100644 --- a/docs/search-core.builtinfieldtype.md +++ b/docs/search-core.builtinfieldtype.md @@ -16,6 +16,7 @@ export declare enum BuiltInFieldType | Member | Value | Description | | --- | --- | --- | +| Email | "email" | | | MultiLineText | "multi_line_text" | | | Phone | "phone" | | | RichText | "rich_text" | | diff --git a/docs/search-core.emaildirectanswer.fieldtype.md b/docs/search-core.emaildirectanswer.fieldtype.md new file mode 100644 index 00000000..18086048 --- /dev/null +++ b/docs/search-core.emaildirectanswer.fieldtype.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@yext/search-core](./search-core.md) > [EmailDirectAnswer](./search-core.emaildirectanswer.md) > [fieldType](./search-core.emaildirectanswer.fieldtype.md) + +## EmailDirectAnswer.fieldType property + +Signature: + +```typescript +fieldType: BuiltInFieldType.Email; +``` diff --git a/docs/search-core.emaildirectanswer.md b/docs/search-core.emaildirectanswer.md new file mode 100644 index 00000000..704d098b --- /dev/null +++ b/docs/search-core.emaildirectanswer.md @@ -0,0 +1,21 @@ + + +[Home](./index.md) > [@yext/search-core](./search-core.md) > [EmailDirectAnswer](./search-core.emaildirectanswer.md) + +## EmailDirectAnswer interface + +An interface for direct answers [DirectAnswer](./search-core.directanswer.md) with email values. + +Signature: + +```typescript +export interface EmailDirectAnswer extends DirectAnswer +``` +Extends: [DirectAnswer](./search-core.directanswer.md)<string\[\]> + +## Properties + +| Property | Type | Description | +| --- | --- | --- | +| [fieldType](./search-core.emaildirectanswer.fieldtype.md) | [BuiltInFieldType.Email](./search-core.builtinfieldtype.md) | | + diff --git a/docs/search-core.md b/docs/search-core.md index b6151471..c75f8f7c 100644 --- a/docs/search-core.md +++ b/docs/search-core.md @@ -59,6 +59,7 @@ | [DisjunctionStaticFilter](./search-core.disjunctionstaticfilter.md) | A static filter composed by combining filters with the logical OR operator. The combined filters can either be field value filters or other disjunction filters. | | [DisplayableFacet](./search-core.displayablefacet.md) | A [Facet](./search-core.facet.md) which contains extra fields meant to be displayed to the end user. | | [DisplayableFacetOption](./search-core.displayablefacetoption.md) | A [FacetOption](./search-core.facetoption.md) with extra data meant to be displayed to the end user. | +| [EmailDirectAnswer](./search-core.emaildirectanswer.md) | An interface for direct answers [DirectAnswer](./search-core.directanswer.md) with email values. | | [Endpoints](./search-core.endpoints.md) | Overrides for the URLs which are used when making requests to the Search API. | | [Facet](./search-core.facet.md) | Represents dynamic filter options for the Search API. | | [FacetOption](./search-core.facetoption.md) | A filter associated with the facet. | diff --git a/etc/search-core.api.md b/etc/search-core.api.md index 3579d0b4..b9d96044 100644 --- a/etc/search-core.api.md +++ b/etc/search-core.api.md @@ -104,6 +104,8 @@ export interface BaseSearchConfig { // @public export enum BuiltInFieldType { + // (undocumented) + Email = "email", // (undocumented) MultiLineText = "multi_line_text", // (undocumented) @@ -169,6 +171,12 @@ export interface DisplayableFacetOption extends FacetOption { selected: boolean; } +// @public +export interface EmailDirectAnswer extends DirectAnswer { + // (undocumented) + fieldType: BuiltInFieldType.Email; +} + // @public export interface Endpoints { // (undocumented) diff --git a/src/models/index.ts b/src/models/index.ts index 5b118384..41d86e13 100644 --- a/src/models/index.ts +++ b/src/models/index.ts @@ -79,6 +79,7 @@ export { VerticalSearchResponse } from './searchservice/response/VerticalSearchR export { Snippet } from './searchservice/response/Snippet'; export { ErrorType } from './searchservice/response/ErrorType'; export { FailedVertical } from './searchservice/response/FailedVertical'; +export { EmailDirectAnswer } from './searchservice/response/EmailDirectAnswer'; // Search service common models export { Matcher } from './searchservice/common/Matcher'; diff --git a/src/models/searchservice/response/EmailDirectAnswer.ts b/src/models/searchservice/response/EmailDirectAnswer.ts new file mode 100644 index 00000000..469dd0ce --- /dev/null +++ b/src/models/searchservice/response/EmailDirectAnswer.ts @@ -0,0 +1,11 @@ +import { BuiltInFieldType } from './directanswer/BuiltInFieldType'; +import { DirectAnswer } from './directanswer/DirectAnswer'; + +/** + * An interface for direct answers {@link DirectAnswer} with email values. + * + * @public + */ +export interface EmailDirectAnswer extends DirectAnswer { + fieldType: BuiltInFieldType.Email +} \ No newline at end of file diff --git a/src/models/searchservice/response/directanswer/BuiltInFieldType.ts b/src/models/searchservice/response/directanswer/BuiltInFieldType.ts index 220785db..6f589ac4 100644 --- a/src/models/searchservice/response/directanswer/BuiltInFieldType.ts +++ b/src/models/searchservice/response/directanswer/BuiltInFieldType.ts @@ -8,7 +8,7 @@ export enum BuiltInFieldType { // IOSAppURL = 'ios_app_url', // AndroidAppURL = 'android_app_url', // FacebookURL = 'facebook_url', - // Email = 'email', + Email = 'email', // InstagramHandle = 'instagram_handle', // TwitterHandle = 'twitter_handle', Phone = 'phone',