diff --git a/docs/search-core.builtinfieldtype.md b/docs/search-core.builtinfieldtype.md index 1bf120b2..689cc075 100644 --- a/docs/search-core.builtinfieldtype.md +++ b/docs/search-core.builtinfieldtype.md @@ -20,6 +20,7 @@ export declare enum BuiltInFieldType | Decimal | "decimal" | | | FacebookURL | "facebook_url" | | | InstagramHandle | "instagram_handle" | | +| Integer | "integer" | | | IOSAppURL | "ios_app_url" | | | MultiLineText | "multi_line_text" | | | Phone | "phone" | | diff --git a/etc/search-core.api.md b/etc/search-core.api.md index 58d96d52..b6b61d7a 100644 --- a/etc/search-core.api.md +++ b/etc/search-core.api.md @@ -126,6 +126,8 @@ export enum BuiltInFieldType { // (undocumented) InstagramHandle = "instagram_handle", // (undocumented) + Integer = "integer", + // (undocumented) IOSAppURL = "ios_app_url", // (undocumented) MultiLineText = "multi_line_text", diff --git a/src/models/searchservice/response/directanswer/BuiltInFieldType.ts b/src/models/searchservice/response/directanswer/BuiltInFieldType.ts index 0256a317..14b92625 100644 --- a/src/models/searchservice/response/directanswer/BuiltInFieldType.ts +++ b/src/models/searchservice/response/directanswer/BuiltInFieldType.ts @@ -16,7 +16,7 @@ export enum BuiltInFieldType { // Address = 'address', // Hours = 'hours', Decimal = 'decimal', - // Integer = 'integer', + Integer = 'integer', SingleLineText = 'single_line_text', RichText = 'rich_text', MultiLineText = 'multi_line_text' diff --git a/src/models/searchservice/response/directanswer/fieldvaluedirectanswers/IntegerDirectAnswer.ts b/src/models/searchservice/response/directanswer/fieldvaluedirectanswers/IntegerDirectAnswer.ts new file mode 100644 index 00000000..96116622 --- /dev/null +++ b/src/models/searchservice/response/directanswer/fieldvaluedirectanswers/IntegerDirectAnswer.ts @@ -0,0 +1,16 @@ +import { EnumOrLiteral } from '../../../../utils/EnumOrLiteral'; +import { BaseFieldValueDirectAnswer } from '../BaseFieldValueDirectAnswer'; +import { BuiltInFieldType } from '../BuiltInFieldType'; + +/** + * A direct answer for an integer field. + * + * @remarks + * `IntegerDirectAnswer`s are only used for built in number fields. + * Custom number fields use {@link DecimalDirectAnswer} instead. + * + * @public + */ +export interface IntegerDirectAnswer extends BaseFieldValueDirectAnswer { + fieldType: EnumOrLiteral +} diff --git a/test-site/src/ts/initDirectAnswers.ts b/test-site/src/ts/initDirectAnswers.ts index e1358940..7b555578 100644 --- a/test-site/src/ts/initDirectAnswers.ts +++ b/test-site/src/ts/initDirectAnswers.ts @@ -44,6 +44,9 @@ const FIELD_VALUE_QUERIES = { 'oliver shi my rich text field', // string 'oliver shi multi line rich text' // string[] ], + [BuiltInFieldType.Integer]: [ + 'oliver shi outdoor pools?' // number + ] }; export default function initDirectAnswers() {