here.content.hmc2.models module

Models for the HMC Layers.

class here.content.hmc2.models.Address(partition_id: Partition, postal_codes: List[PostalCode], location_address_type: str, source_type: str, cities: List[DecodedMessage] | None = None, states: List[DecodedMessage] | None = None, counties: List[DecodedMessage] | None = None, regions: List[DecodedMessage] | None = None, districts: List[DecodedMessage] | None = None, areas: List[DecodedMessage] | None = None, streets: List[DecodedMessage] | None = None, houses: List[DecodedMessage] | None = None, buildings: List[DecodedMessage] | None = None, building_units: List[DecodedMessage] | None = None, level_names: List[DecodedMessage] | None = None, unit_names: List[DecodedMessage] | None = None, postal_mappings: List[DecodedMessage] | None = None, state_codes: List[DecodedMessage] | None = None, country_code: int | None = None, category: Ref | None = None)
Bases: object

Address Details.

areas: List[DecodedMessage] | None = None

building_units: List[DecodedMessage] | None = None

buildings: List[DecodedMessage] | None = None

category: Ref | None = None

cities: List[DecodedMessage] | None = None

counties: List[DecodedMessage] | None = None

country_code: int | None = None

districts: List[DecodedMessage] | None = None

houses: List[DecodedMessage] | None = None

indexer = ContentIndexer(partition='partition_id', identifier=None, refs=)

level_names: List[DecodedMessage] | None = None

location_address_type: str

partition_id: Partition

postal_codes: List[PostalCode]

postal_mappings: List[DecodedMessage] | None = None

regions: List[DecodedMessage] | None = None

source_type: str

state_codes: List[DecodedMessage] | None = None

states: List[DecodedMessage] | None = None

streets: List[DecodedMessage] | None = None

unit_names: List[DecodedMessage] | None = None

class here.content.hmc2.models.AffiliationAttribute(partition_id: Partition, value: DecodedMessage)
Bases: object

Affiliation Details.

indexer = ContentIndexer(partition='partition_id', identifier=None, refs=)

partition_id: Partition

value: DecodedMessage

class here.content.hmc2.models.AlcoholServiceAttribute(partition_id: Partition, places: List[Place], alcohol_notes: List[DecodedMessage], beer: bool, wine: bool, liquor: bool, category: Ref | None = None)
Bases: object

Alcohol Service Details.

alcohol_notes: List[DecodedMessage]

beer: bool

category: Ref | None = None

indexer = ContentIndexer(partition='partition_id', identifier=None, refs=)

liquor: bool

partition_id: Partition

places: List[Place]

wine: bool

class here.content.hmc2.models.AmenitiesAttribute(partition_id: Partition, places: List[Place], air_conditioning: bool | None = False, elevators: bool | None = False, escalators: bool | None = False, family_friendly: bool | None = False, onsite_heart_defribillator: bool | None = False, restrooms_available: bool | None = False, security_guard: bool | None = False, smoking: bool | None = False, television: bool | None = False, seating_options: str | None = None, seating_capacity: str | None = None, category: Ref | None = None)
Bases: object

Amenities Details.

air_conditioning: bool | None = False

category: Ref | None = None

elevators: bool | None = False

escalators: bool | None = False

family_friendly: bool | None = False

indexer = ContentIndexer(partition='partition_id', identifier=None, refs=)

onsite_heart_defribillator: bool | None = False

partition_id: Partition

places: List[Place]

restrooms_available: bool | None = False

seating_capacity: str | None = None

seating_options: str | None = None

security_guard: bool | None = False

smoking: bool | None = False

television: bool | None = False

class here.content.hmc2.models.Author(partition_id: Partition, value: DecodedMessage)
Bases: object

Author Details.

indexer = ContentIndexer(partition='partition_id', identifier=None, refs=)

partition_id: Partition

value: DecodedMessage

class here.content.hmc2.models.BasicInfoAttribute(partition_id: Partition, places: List[Place], access_type: str | None = None, building_type: str | None = None, capital_indicator: str | None = None, capital_level: str | None = None, population: str | None = None, category: Ref | None = None)
Bases: object

Basic Information.

access_type: str | None = None

building_type: str | None = None

capital_indicator: str | None = None

capital_level: str | None = None

category: Ref | None = None

indexer = ContentIndexer(partition='partition_id', identifier=None, refs=)

partition_id: Partition

places: List[Place]

population: str | None = None

class here.content.hmc2.models.BlackSpot(partition_id: Partition, value: DecodedMessage)
Bases: object

Black Spot Details.

indexer = ContentIndexer(partition='partition_id', identifier=None, refs=)

partition_id: Partition

value: DecodedMessage

class here.content.hmc2.models.CapacityAttribute(partition_id: Partition, value: DecodedMessage)
Bases: object

Capacity Details.

indexer = ContentIndexer(partition='partition_id', identifier=None, refs=)

partition_id: Partition

value: DecodedMessage

class here.content.hmc2.models.Contact(type: str, value: str, preferred: bool, category: Ref | None = None, label: DecodedMessage | None = None, country_code: int | None = None, additional_data: List[ContactAdditionalData] | None = None)
Bases: object

Contact Details.

additional_data: List[ContactAdditionalData] | None = None

category: Ref | None = None

country_code: int | None = None

label: DecodedMessage | None = None

preferred: bool

type: str

value: str

class here.content.hmc2.models.ContactAdditionalData(key: str, value: str, language_code: str, language_type: str)
Bases: object

Additional Data in Contact.

key: str

language_code: str

language_type: str

value: str

class here.content.hmc2.models.ContactInformation(partition_id: Partition, places: List[Place], contacts: List[Contact])
Bases: object

Contact Information Details.

contacts: List[Contact]

indexer = ContentIndexer(partition='partition_id', identifier=None, refs=)

partition_id: Partition

places: List[Place]

class here.content.hmc2.models.DTO(**kwargs)
Bases: object

Object to carry dynamic data to pass to parser functions.

class here.content.hmc2.models.ElectricChargeAttribute(partition_id: Partition, value: DecodedMessage)
Bases: object

Electric Charge Details.

indexer = ContentIndexer(partition='partition_id', identifier=None, refs=)

partition_id: Partition

value: DecodedMessage

class here.content.hmc2.models.ExternalIdentifier(partition_id: Partition, id: Identifier, places: List[Place], supplier: Supplier, inactive: bool, category: Ref, type: str)
Bases: object

External Identifier Details.

category: Ref

id: Identifier

inactive: bool

indexer = ContentIndexer(partition='partition_id', identifier='id', refs=)

partition_id: Partition

places: List[Place]

supplier: Supplier

type: str

class here.content.hmc2.models.Feedback(partition_id: Partition, value: DecodedMessage)
Bases: object

Feedback Details.

indexer = ContentIndexer(partition='partition_id', identifier=None, refs=)

partition_id: Partition

value: DecodedMessage

class here.content.hmc2.models.FuelTypeAttribute(partition_id: Partition, places: List[Place], biodiesel: bool | None = False, biodiesel_grade: str | None = None, cng: bool | None = False, diesel: bool | None = False, diesel_additive: str | None = None, diesel_additive_type: str | None = None, diesel_with_additives: bool | None = False, e85: bool | None = False, e10: bool | None = False, ethanol: bool | None = False, ethanol_with_additives: bool | None = False, gasoline: bool | None = False, high_volume_pumps: bool | None = False, hydrogen: bool | None = False, hydrogen_pressure: str | None = None, lpg: bool | None = False, midgrade: bool | None = False, pay_at_pump: bool | None = False, premium: bool | None = False, premium_with_additives: bool | None = False, regular: bool | None = False, regular_with_additives: bool | None = False, lng: bool | None = False, category: Ref | None = None)
Bases: object

Fuel Type Details.

biodiesel: bool | None = False

biodiesel_grade: str | None = None

category: Ref | None = None

cng: bool | None = False

diesel: bool | None = False

diesel_additive: str | None = None

diesel_additive_type: str | None = None

diesel_with_additives: bool | None = False

e10: bool | None = False

e85: bool | None = False

ethanol: bool | None = False

ethanol_with_additives: bool | None = False

gasoline: bool | None = False

high_volume_pumps: bool | None = False

hydrogen: bool | None = False

hydrogen_pressure: str | None = None

indexer = ContentIndexer(partition='partition_id', identifier=None, refs=)

lng: bool | None = False

lpg: bool | None = False

midgrade: bool | None = False

partition_id: Partition

pay_at_pump: bool | None = False

places: List[Place]

premium: bool | None = False

premium_with_additives: bool | None = False

regular: bool | None = False

regular_with_additives: bool | None = False

class here.content.hmc2.models.HotelAttribute(partition_id: Partition, places: List[Place], breakfast_included: bool | None = False, conference_hall: bool | None = False, handicap_rooms: bool | None = False, hot_tub: bool | None = False, sauna: bool | None = False, spa: bool | None = False, sports_infrastructure: bool | None = False, swimming: bool | None = False, swimming_pool: bool | None = False, swimming_pool_indoor: bool | None = False, swimming_pool_outdoor: bool | None = False, category: Ref | None = None)
Bases: object

Hotel Details.

breakfast_included: bool | None = False

category: Ref | None = None

conference_hall: bool | None = False

handicap_rooms: bool | None = False

hot_tub: bool | None = False

indexer = ContentIndexer(partition='partition_id', identifier=None, refs=)

partition_id: Partition

places: List[Place]

sauna: bool | None = False

spa: bool | None = False

sports_infrastructure: bool | None = False

swimming: bool | None = False

swimming_pool: bool | None = False

swimming_pool_indoor: bool | None = False

swimming_pool_outdoor: bool | None = False

class here.content.hmc2.models.InternetConnectionAttribute(partition_id: Partition, value: DecodedMessage)
Bases: object

Internet Connection Details.

indexer = ContentIndexer(partition='partition_id', identifier=None, refs=)

partition_id: Partition

value: DecodedMessage

class here.content.hmc2.models.Location(partition_id: Partition, location_id: Identifier, location_type: str, display_position: Point, address: Address, address_relation: str, area_type: str, segment_anchor: DecodedMessage, segment_anchor_side: str, geometry: MultiPolygon | None = None, level_info: DecodedMessage | None = None, accessors: DecodedMessage | None = None, political_geometry: DecodedMessage | None = None, alternate_geometry: DecodedMessage | None = None, within_location_ref: DecodedMessage | None = None, bounding_box: DecodedMessage | None = None)
Bases: object

Location Details.

accessors: DecodedMessage | None = None

address: Address

address_relation: str

alternate_geometry: DecodedMessage | None = None

area_type: str

bounding_box: DecodedMessage | None = None

display_position: Point

geometry: MultiPolygon | None = None

indexer = ContentIndexer(partition='partition_id', identifier='location_id', refs=)

level_info: DecodedMessage | None = None

location_id: Identifier

location_type: str

partition_id: Partition

political_geometry: DecodedMessage | None = None

segment_anchor: DecodedMessage

segment_anchor_side: str

within_location_ref: DecodedMessage | None = None

class here.content.hmc2.models.LocationInformation(partition_id: Partition, value: DecodedMessage)
Bases: object

Location Information Details.

indexer = ContentIndexer(partition='partition_id', identifier=None, refs=)

partition_id: Partition

value: DecodedMessage

class here.content.hmc2.models.MatchLevelAttribute(partition_id: Partition, places: List[Place], match_level: str)
Bases: object

Match Level Attribute Details.

indexer = ContentIndexer(partition='partition_id', identifier=None, refs=)

match_level: str

partition_id: Partition

places: List[Place]

class here.content.hmc2.models.MediaReference(labels: List[str], url: str, type: str, id: str | None = None)
Bases: object

Media Reference Details.

id: str | None = None

labels: List[str]

type: str

url: str

class here.content.hmc2.models.MediaReferenceAttribute(partition_id: Partition, places: List[Place], media_refs: List[MediaReference])
Bases: object

Media Reference Attribute Details.

indexer = ContentIndexer(partition='partition_id', identifier=None, refs=)

media_refs: List[MediaReference]

partition_id: Partition

places: List[Place]

class here.content.hmc2.models.Name(text: DecodedMessage, type: str, representation: List[DecodedMessage] | None = None, primary: DecodedMessage | None = None)
Bases: object

Names Details.

primary: DecodedMessage | None = None

representation: List[DecodedMessage] | None = None

text: DecodedMessage

type: str

class here.content.hmc2.models.NoteTypeAttribute(partition_id: Partition, value: DecodedMessage)
Bases: object

Note Type Details.

indexer = ContentIndexer(partition='partition_id', identifier=None, refs=)

partition_id: Partition

value: DecodedMessage

class here.content.hmc2.models.OfficeTypeAttribute(partition_id: Partition, value: DecodedMessage)
Bases: object

Office Type Details.

indexer = ContentIndexer(partition='partition_id', identifier=None, refs=)

partition_id: Partition

value: DecodedMessage

class here.content.hmc2.models.OperatingTime(partition_id: Partition, places: List[Place], operation_times: List[OperationTime], open24x7: bool, categories: List[Ref] | None = None, additional_data: List[DecodedMessage] | None = None)
Bases: object

Operating Time Details.

additional_data: List[DecodedMessage] | None = None

categories: List[Ref] | None = None

indexer = ContentIndexer(partition='partition_id', identifier=None, refs=)

open24x7: bool

operation_times: List[OperationTime]

partition_id: Partition

places: List[Place]

class here.content.hmc2.models.OperationTime(excluded: bool, approx_seasonal_range: bool, days_of_week: List[str], time_range: TimeRange)
Bases: object

Operation Time Details.

approx_seasonal_range: bool

days_of_week: List[str]

excluded: bool

time_range: TimeRange

class here.content.hmc2.models.OtherInformation(partition_id: Partition, places: List[Place], additional_notes: List[DecodedMessage], national_importance: bool, category: Ref | None = None)
Bases: object

Other Information.

additional_notes: List[DecodedMessage]

category: Ref | None = None

indexer = ContentIndexer(partition='partition_id', identifier=None, refs=)

national_importance: bool

partition_id: Partition

places: List[Place]

class here.content.hmc2.models.ParkingAttribute(partition_id: Partition, value: DecodedMessage)
Bases: object

Parking Details.

indexer = ContentIndexer(partition='partition_id', identifier=None, refs=)

partition_id: Partition

value: DecodedMessage

class here.content.hmc2.models.Payment(partition_id: Partition, places: List[Place], type_qualifier: List[str], type: str, accepted: bool)
Bases: object

Payment Details.

accepted: bool

indexer = ContentIndexer(partition='partition_id', identifier=None, refs=)

partition_id: Partition

places: List[Place]

type: str

type_qualifier: List[str]

class here.content.hmc2.models.Place(partition_id: Partition, id: Identifier, names: List[Name], location: Ref, categories: List[Ref] | None = None, alt_categories: List[Ref] | None = None, political_view_name_replacement: List[DecodedMessage] | None = None, political_view_action: List[DecodedMessage] | None = None, valid_unnamed: DecodedMessage | None = None)
Bases: object

Place Details.

alt_categories: List[Ref] | None = None

categories: List[Ref] | None = None

id: Identifier

indexer = ContentIndexer(partition='partition_id', identifier='id', refs=)

location: Ref

names: List[Name]

partition_id: Partition

political_view_action: List[DecodedMessage] | None = None

political_view_name_replacement: List[DecodedMessage] | None = None

valid_unnamed: DecodedMessage | None = None

class here.content.hmc2.models.PlaceAccessAttribute(partition_id: Partition, places: List[Place], group_restrictions: List[DecodedMessage], dogs_allowed: bool, handicap_accessible: str, private_access: bool, category: Ref | None = None)
Bases: object

Place Access Details.

category: Ref | None = None

dogs_allowed: bool

group_restrictions: List[DecodedMessage]

handicap_accessible: str

indexer = ContentIndexer(partition='partition_id', identifier=None, refs=)

partition_id: Partition

places: List[Place]

private_access: bool

class here.content.hmc2.models.PlaceCategoryConfidenceAttribute(partition_id: Partition, value: DecodedMessage)
Bases: object

Place Category Confidence Details.

indexer = ContentIndexer(partition='partition_id', identifier=None, refs=)

partition_id: Partition

value: DecodedMessage

class here.content.hmc2.models.PopularityAttribute(partition_id: Partition, value: DecodedMessage)
Bases: object

Popularity Details.

indexer = ContentIndexer(partition='partition_id', identifier=None, refs=)

partition_id: Partition

value: DecodedMessage

class here.content.hmc2.models.PortAttribute(partition_id: Partition, value: DecodedMessage)
Bases: object

Port Details Details.

indexer = ContentIndexer(partition='partition_id', identifier=None, refs=)

partition_id: Partition

value: DecodedMessage

class here.content.hmc2.models.PostalCode(text: DecodedMessage, type: str, representation: List[DecodedMessage] | None = None, primary: DecodedMessage | None = None)
Bases: Name

Postal Code Details.

class here.content.hmc2.models.PriceRange(partition_id: Partition, places: List[Place], qualifiers: List[Qualifier], notes: List[DecodedMessage], min_range: float, max_range: float, currency_type: str)
Bases: object

Price Range Details.

currency_type: str

indexer = ContentIndexer(partition='partition_id', identifier=None, refs=)

max_range: float

min_range: float

notes: List[DecodedMessage]

partition_id: Partition

places: List[Place]

qualifiers: List[Qualifier]

class here.content.hmc2.models.QrCodeAttribute(partition_id: Partition, value: DecodedMessage)
Bases: object

QR Code Details.

indexer = ContentIndexer(partition='partition_id', identifier=None, refs=)

partition_id: Partition

value: DecodedMessage

class here.content.hmc2.models.Qualifier(value: str, language: str)
Bases: object

Qualifier for Price Range.

language: str

value: str

class here.content.hmc2.models.QualityScore(partition_id: Partition, places: List[Place], overall_confidence: str, place_confidence: str, open_confidence: str, address_confidence: str, name_confidence: str, phone_confidence: str, model_version: str, place_quality_level: str, open_quality_level: str, address_quality_level: str, name_quality_level: str, phone_quality_level: str, reality_confidence: str, reality_quality_level: str, category: Ref | None = None)
Bases: object

Quality Score Details.

address_confidence: str

address_quality_level: str

category: Ref | None = None

indexer = ContentIndexer(partition='partition_id', identifier=None, refs=)

model_version: str

name_confidence: str

name_quality_level: str

open_confidence: str

open_quality_level: str

overall_confidence: str

partition_id: Partition

phone_confidence: str

phone_quality_level: str

place_confidence: str

place_quality_level: str

places: List[Place]

reality_confidence: str

reality_quality_level: str

class here.content.hmc2.models.Relationship(references: List[DecodedMessage], type: str, primary: bool, system: str, name: str, id: str)
Bases: object

Relationship Details.

id: str

name: str

primary: bool

references: List[DecodedMessage]

system: str

type: str

class here.content.hmc2.models.RelationshipAttribute(partition_id: Partition, places: List[Place], relationships: List[Relationship])
Bases: object

Releation Attribute Details.

indexer = ContentIndexer(partition='partition_id', identifier=None, refs=)

partition_id: Partition

places: List[Place]

relationships: List[Relationship]

class here.content.hmc2.models.RestaurantAttribute(partition_id: Partition, places: List[Place], beer_selections: List[DecodedMessage] | None = None, cooking_types: List[DecodedMessage] | None = None, specialities: List[DecodedMessage] | None = None, wine_selections: List[DecodedMessage] | None = None, catering: bool | None = False, childrens_menu: bool | None = False, delivery: bool | None = False, dress_code: str | None = None, reservation_required: bool | None = False, takeout: bool | None = False, category: Ref | None = None)
Bases: object

Restaurant Details.

beer_selections: List[DecodedMessage] | None = None

category: Ref | None = None

catering: bool | None = False

childrens_menu: bool | None = False

cooking_types: List[DecodedMessage] | None = None

delivery: bool | None = False

dress_code: str | None = None

indexer = ContentIndexer(partition='partition_id', identifier=None, refs=)

partition_id: Partition

places: List[Place]

reservation_required: bool | None = False

specialities: List[DecodedMessage] | None = None

takeout: bool | None = False

wine_selections: List[DecodedMessage] | None = None

class here.content.hmc2.models.SafetyCamera(partition_id: Partition, value: DecodedMessage)
Bases: object

Safety Camera Details.

indexer = ContentIndexer(partition='partition_id', identifier=None, refs=)

partition_id: Partition

value: DecodedMessage

class here.content.hmc2.models.SocialSignal(partition_id: Partition, value: DecodedMessage)
Bases: object

Social Signal Details.

indexer = ContentIndexer(partition='partition_id', identifier=None, refs=)

partition_id: Partition

value: DecodedMessage

class here.content.hmc2.models.SpokenLanguage(partition_id: Partition, value: DecodedMessage)
Bases: object

Spoken Language Details.

indexer = ContentIndexer(partition='partition_id', identifier=None, refs=)

partition_id: Partition

value: DecodedMessage

class here.content.hmc2.models.Supplier(partition_id: Partition, id: Identifier, names: List[Name], category: Ref)
Bases: object

Supplier Details.

category: Ref

id: Identifier

indexer = ContentIndexer(partition='partition_id', identifier='id', refs=)

names: List[Name]

partition_id: Partition

class here.content.hmc2.models.Time(seconds: int, nanos: int)
Bases: object

Time in Seconds and Nanos.

nanos: int

seconds: int

class here.content.hmc2.models.TimeRange(start_time_of_day: Time, end_time_of_day: Time)
Bases: object

Time Range with Start and End Time of the Day.

end_time_of_day: Time

start_time_of_day: Time

class here.content.hmc2.models.TransitAttribute(partition_id: Partition, value: DecodedMessage)
Bases: object

Transit Details.

indexer = ContentIndexer(partition='partition_id', identifier=None, refs=)

partition_id: Partition

value: DecodedMessage

class here.content.hmc2.models.TruckAttribute(partition_id: Partition, places: List[Place], high_canopy: bool | None = False, idle_reduction_system: bool | None = False, number_of_showers: str | None = None, showers: bool | None = False, truck_parking: bool | None = False, truck_scales: bool | None = False, truck_service: bool | None = False, truck_wash: bool | None = False, truck_secure_parking: bool | None = False, truck_night_parking_only: bool | None = False, truck_stop: bool | None = False, category: Ref | None = None)
Bases: object

Truck Attribute Details.

category: Ref | None = None

high_canopy: bool | None = False

idle_reduction_system: bool | None = False

indexer = ContentIndexer(partition='partition_id', identifier=None, refs=)

number_of_showers: str | None = None

partition_id: Partition

places: List[Place]

showers: bool | None = False

truck_night_parking_only: bool | None = False

truck_parking: bool | None = False

truck_scales: bool | None = False

truck_secure_parking: bool | None = False

truck_service: bool | None = False

truck_stop: bool | None = False

truck_wash: bool | None = False

class here.content.hmc2.models.VehicleServicesAttribute(partition_id: Partition, value: DecodedMessage)
Bases: object

Vehicle Service Details.

indexer = ContentIndexer(partition='partition_id', identifier=None, refs=)

partition_id: Partition

value: DecodedMessage

class here.content.hmc2.models.VendorUrlAttribute(partition_id: Partition, value: DecodedMessage)
Bases: object

Vendor Url Details.

indexer = ContentIndexer(partition='partition_id', identifier=None, refs=)

partition_id: Partition

value: DecodedMessage

class here.content.hmc2.models.Verification(attributes: List[str], method: str, status: str, type: str, system: str, verified: str, start_date: str, end_date: str, expiration_date: str)
Bases: object

Verification Details.

attributes: List[str]

end_date: str

expiration_date: str

method: str

start_date: str

status: str

system: str

type: str

verified: str

class here.content.hmc2.models.VerificationAttribute(partition_id: Partition, places: List[Place], verifications: List[Verification])
Bases: object

Verification Attribute Details.

indexer = ContentIndexer(partition='partition_id', identifier=None, refs=)

partition_id: Partition

places: List[Place]

verifications: List[Verification]