Address Models

Address models for the ACPortal API.

class ab.api.models.address.AddressValidateParams(*, Line1=None, City=None, State=None, Zip=None)[source]

Bases: RequestModel

Query parameters for GET /address/isvalid.

Parameters:

  • Line1 (str | None)

  • City (str | None)

  • State (str | None)

  • Zip (str | None)

line1: str | None
city: str | None
state: str | None
zip: str | None
model_config = {'alias_generator': <function _to_camel>, 'extra': 'forbid', '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.address.AddressPropertyTypeParams(*, Address1=None, Address2=None, City=None, State=None, ZipCode=None)[source]

Bases: RequestModel

Query parameters for GET /address/propertytype.

Parameters:

  • Address1 (str | None)

  • Address2 (str | None)

  • City (str | None)

  • State (str | None)

  • ZipCode (str | 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': 'forbid', '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.address.AddressIsValidResult(*, isValid=None, validatedAddress=None, suggestions=None, dontValidate=None, countryId=None, countryCode=None, latitude=None, longitude=None, propertyType=None, **extra_data)[source]

Bases: ResponseModel

Result from GET /address/isvalid.

Parameters:

  • isValid (bool | None)

  • validatedAddress (dict | None)

  • suggestions (List[dict] | None)

  • dontValidate (bool | None)

  • countryId (str | None)

  • countryCode (str | None)

  • latitude (float | None)

  • longitude (float | None)

  • propertyType (int | None)

  • extra_data (Any)

is_valid: bool | None
validated_address: dict | None
suggestions: List[dict] | None
dont_validate: bool | None
country_id: str | None
country_code: str | None
latitude: float | None
longitude: float | None
property_type: int | 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.address.PropertyType(*, propertyType=None, confidence=None, **extra_data)[source]

Bases: ResponseModel

Result from GET /address/propertytype.

Parameters:

  • propertyType (str | None)

  • confidence (float | None)

  • extra_data (Any)

property_type: str | None
confidence: 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].