Merge eb9b635 into f4066f2

yext · Aug 16, 2022 · c15c242 · c15c242
2 parents f4066f2 + eb9b635
commit c15c242
Show file tree

Hide file tree

Showing 5 changed files with 23 additions and 1 deletion.
diff --git a/docs/search-core.builtinfieldtype.md b/docs/search-core.builtinfieldtype.md
@@ -20,6 +20,7 @@ export declare enum BuiltInFieldType
 |  Decimal | <code>&quot;decimal&quot;</code> |  |
 |  FacebookURL | <code>&quot;facebook_url&quot;</code> |  |
 |  InstagramHandle | <code>&quot;instagram_handle&quot;</code> |  |
+|  Integer | <code>&quot;integer&quot;</code> |  |
 |  IOSAppURL | <code>&quot;ios_app_url&quot;</code> |  |
 |  MultiLineText | <code>&quot;multi_line_text&quot;</code> |  |
 |  Phone | <code>&quot;phone&quot;</code> |  |

diff --git 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
@@ -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/...models/searchservice/response/directanswer/fieldvaluedirectanswers/IntegerDirectAnswer.ts b/...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<number> {
+  fieldType: EnumOrLiteral<BuiltInFieldType.Integer>
+}
diff --git 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() {