v2.0.0

Version 2.0.0

Changes

• additionalQueryParameter is now a public field in SearchConfig models (#217)

Breaking Changes

• Updated default and sandbox URL endpoints from ../answers/.. to ../search/.. as part of rebranding process (#196 )
• Restructured StaticFilters models for better developer experience and enforce proper restriction in the kind of combinations of filters supported by the backend
  • Now, static filters can be either a field value filter or a nested object that is composed by combining field value filters. (#201 )
  • ConjunctionStaticFilter and DisjunctionStaticFilter models were created to reflect such limitation. For example, ANDs of ORs combination is allowed, ORs of ANDs combination is not allowed. (#204 )
• Updated FieldValueDirectAnswer model to properly handle different value types. Previously, FieldValueDirectAnswer interface enforces that the value field will always be of type string. Now, FieldValueDirectAnswer is a union type of predefined interfaces with known value type and UnknownFieldValueDirectAnswer with a generic value type for other fieldType outside of BuiltInFieldType. (#200 #202 )
  • The newly added built-in interfaces can be found in the document page here (#206 #208 #210 #211 #205 #209 #203 #220 )
• Narrow down FeaturedSnippetDirectAnswer TypeScript model to be a union type of MultiLineTextSnippetDirectAnswer and RichTextSnippetDirectAnswer as a featured snippet direct answer can only be of fieldType multi_line_text or rich_text. (#207 #212 )
• All exports marked as @deprecated in previous version(s) as part of the rebranding process is now removed in V2 (#216 )
  • For more details, the deprecated identifiers are listed in v1.8 release notes