Common Models

Shared sub-models used across multiple response models.

Shared sub-models reused across multiple response models.

class ab.api.models.common.Coordinates(*, latitude=None, longitude=None, **extra_data)[source]

Bases: ResponseModel

GPS coordinates — nested in address objects.

Parameters:

  • latitude (float | None)

  • longitude (float | None)

  • extra_data (Any)

latitude: float | None
longitude: float | None
model_config = {'alias_generator': <function _to_camel>, 'extra': 'allow', 'populate_by_name': True, 'str_strip_whitespace': True, 'use_enum_values': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class ab.api.models.common.CompanyAddress(*, id=None, isValid=None, dontValidate=None, propertyType=None, address1Value=None, address2Value=None, countryName=None, countryCode=None, countryId=None, countrySkipZipCodeVerification=None, zipCodeResolvingFailed=None, latitude=None, longitude=None, fullCityLine=None, coordinates=None, address1=None, address2=None, city=None, state=None, zipCode=None, **extra_data)[source]

Bases: ResponseModel

Full address object — used by CompanyDetails.address and ContactPrimaryDetails.address.

Parameters:

  • id (int | None)

  • isValid (bool | None)

  • dontValidate (bool | None)

  • propertyType (int | None)

  • address1Value (str | None)

  • address2Value (str | None)

  • countryName (str | None)

  • countryCode (str | None)

  • countryId (str | None)

  • countrySkipZipCodeVerification (bool | None)

  • zipCodeResolvingFailed (bool | None)

  • latitude (float | None)

  • longitude (float | None)

  • fullCityLine (str | None)

  • coordinates (Coordinates | None)

  • address1 (str | None)

  • address2 (str | None)

  • city (str | None)

  • state (str | None)

  • zipCode (str | None)

  • extra_data (Any)

id: int | None
is_valid: bool | None
dont_validate: bool | None
property_type: int | None
address1_value: str | None
address2_value: str | None
country_name: str | None
country_code: str | None
country_id: str | None
country_skip_zip_code_verification: bool | None
zip_code_resolving_failed: bool | None
latitude: float | None
longitude: float | None
full_city_line: str | None
coordinates: Coordinates | None
address1: str | None
address2: str | None
city: str | None
state: str | None
zip_code: str | None
model_config = {'alias_generator': <function _to_camel>, 'extra': 'allow', 'populate_by_name': True, 'str_strip_whitespace': True, 'use_enum_values': True, 'validate_by_alias': True, 'validate_by_name': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].