@yext/search-core/src/models/searchservice/response/directanswer/fieldvaluedirectanswers/AddressDirectAnswer.ts

Typescript Networking Library for the Yext Search API

import { BuiltInFieldType } from '../BuiltInFieldType';
import { BaseFieldValueDirectAnswer } from '../BaseFieldValueDirectAnswer';
import { EnumOrLiteral } from '../../../../utils/EnumOrLiteral';

/**
 * A {@link BaseFieldValueDirectAnswer} interface with 'address' field type.
 *
 * @public
 */
export interface AddressDirectAnswer extends BaseFieldValueDirectAnswer<Address> {
  fieldType: EnumOrLiteral<BuiltInFieldType.Address>
}

/**
 * An interface with address fields to use in {@link BaseFieldValueDirectAnswer.value}.
 *
 * @public
 */
export interface Address {
  line1?: string,
  line2?: string,
  line3?: string,
  sublocality?: string,
  city?: string,
  region?: string,
  postalCode?: string,
  extraDescription?: string,
  countryCode: string
}