schema-org-python 0.1.0__py3-none-any.whl

schema_models/drug.py

@@ -0,0 +1,61 @@
+from typing import List, Optional, Union
+
+from pydantic import HttpUrl
+
+from schema_models.drug_class import DrugClass
+from schema_models.health_insurance_plan import HealthInsurancePlan
+from schema_models.substance import Substance
+
+
+class Drug(Substance):
+    """
+    Specifying a drug or medicine used in a medication procedure.
+    """
+
+    dosageForm: Optional[Union[str, List[str]]] = None
+    alcoholWarning: Optional[Union[str, List[str]]] = None
+    mechanismOfAction: Optional[Union[str, List[str]]] = None
+    interactingDrug: Optional[Union["Drug", List["Drug"]]] = None
+    prescriptionStatus: Optional[
+        Union["DrugPrescriptionStatus", List["DrugPrescriptionStatus"], str, List[str]]
+    ] = None
+    relatedDrug: Optional[Union["Drug", List["Drug"]]] = None
+    availableStrength: Optional[Union["DrugStrength", List["DrugStrength"]]] = None
+    clincalPharmacology: Optional[Union[str, List[str]]] = None
+    rxcui: Optional[Union[str, List[str]]] = None
+    administrationRoute: Optional[Union[str, List[str]]] = None
+    maximumIntake: Optional[
+        Union["MaximumDoseSchedule", List["MaximumDoseSchedule"]]
+    ] = None
+    legalStatus: Optional[
+        Union[
+            "DrugLegalStatus",
+            List["DrugLegalStatus"],
+            "MedicalEnumeration",
+            List["MedicalEnumeration"],
+            str,
+            List[str],
+        ]
+    ] = None
+    drugUnit: Optional[Union[str, List[str]]] = None
+    pregnancyCategory: Optional[
+        Union["DrugPregnancyCategory", List["DrugPregnancyCategory"]]
+    ] = None
+    labelDetails: Optional[Union[HttpUrl, List[HttpUrl]]] = None
+    overdosage: Optional[Union[str, List[str]]] = None
+    warning: Optional[Union[str, List[str], HttpUrl, List[HttpUrl]]] = None
+    proprietaryName: Optional[Union[str, List[str]]] = None
+    nonProprietaryName: Optional[Union[str, List[str]]] = None
+    activeIngredient: Optional[Union[str, List[str]]] = None
+    prescribingInfo: Optional[Union[HttpUrl, List[HttpUrl]]] = None
+    clinicalPharmacology: Optional[Union[str, List[str]]] = None
+    isAvailableGenerically: Optional[Union[bool, List[bool]]] = None
+    includedInHealthInsurancePlan: Optional[
+        Union[HealthInsurancePlan, List[HealthInsurancePlan]]
+    ] = None
+    pregnancyWarning: Optional[Union[str, List[str]]] = None
+    drugClass: Optional[Union[DrugClass, List[DrugClass]]] = None
+    doseSchedule: Optional[Union["DoseSchedule", List["DoseSchedule"]]] = None
+    breastfeedingWarning: Optional[Union[str, List[str]]] = None
+    isProprietary: Optional[Union[bool, List[bool]]] = None
+    foodWarning: Optional[Union[str, List[str]]] = None

schema_models/drug_class.py

@@ -0,0 +1,11 @@
+from typing import List, Optional, Union
+
+from schema_models.medical_entity import MedicalEntity
+
+
+class DrugClass(MedicalEntity):
+    """
+    The class of drug this belongs to (e.g., statins).
+    """
+
+    drug: Optional[Union["Drug", List["Drug"]]] = None

schema_models/drug_cost.py

@@ -0,0 +1,27 @@
+from typing import List, Optional, Union
+
+from schema_models.medical_entity import MedicalEntity
+
+
+class DrugCost(MedicalEntity):
+    """
+    The cost per unit of a medical drug. Note that this type is not meant to represent the price in an offer of a drug for sale; see the Offer type for that. This type will typically be used to tag wholesale or average retail cost of a drug, or maximum reimbursable cost. Costs of medical drugs vary widely depending on how and where they are paid for, so while this type captures some of the variables, costs should be used with caution by consumers of this schema's markup.
+    """
+
+    applicableLocation: Optional[
+        Union["AdministrativeArea", List["AdministrativeArea"]]
+    ] = None
+    costOrigin: Optional[Union[str, List[str]]] = None
+    costCurrency: Optional[Union[str, List[str]]] = None
+    costCategory: Optional[Union["DrugCostCategory", List["DrugCostCategory"]]] = None
+    costPerUnit: Optional[
+        Union[
+            str,
+            List[str],
+            float,
+            List[float],
+            "QualitativeValue",
+            List["QualitativeValue"],
+        ]
+    ] = None
+    drugUnit: Optional[Union[str, List[str]]] = None

schema_models/drug_cost_category.py

@@ -0,0 +1,7 @@
+from schema_models.medical_enumeration import MedicalEnumeration
+
+
+class DrugCostCategory(MedicalEnumeration):
+    """
+    Enumerated categories of medical drug costs.
+    """

schema_models/drug_legal_status.py

@@ -0,0 +1,14 @@
+from typing import List, Optional, Union
+
+from schema_models.administrative_area import AdministrativeArea
+from schema_models.medical_intangible import MedicalIntangible
+
+
+class DrugLegalStatus(MedicalIntangible):
+    """
+    The legal availability status of a medical drug.
+    """
+
+    applicableLocation: Optional[
+        Union[AdministrativeArea, List[AdministrativeArea]]
+    ] = None

schema_models/drug_pregnancy_category.py

@@ -0,0 +1,7 @@
+from schema_models.medical_enumeration import MedicalEnumeration
+
+
+class DrugPregnancyCategory(MedicalEnumeration):
+    """
+    Categories that represent an assessment of the risk of fetal injury due to a drug or pharmaceutical used as directed by the mother during pregnancy.
+    """

schema_models/drug_prescription_status.py

@@ -0,0 +1,7 @@
+from schema_models.medical_enumeration import MedicalEnumeration
+
+
+class DrugPrescriptionStatus(MedicalEnumeration):
+    """
+    Indicates whether this drug is available by prescription or over-the-counter.
+    """

schema_models/drug_strength.py

@@ -0,0 +1,18 @@
+from typing import List, Optional, Union
+
+from schema_models.administrative_area import AdministrativeArea
+from schema_models.medical_intangible import MedicalIntangible
+
+
+class DrugStrength(MedicalIntangible):
+    """
+    A specific strength in which a medical drug is available in a specific country.
+    """
+
+    strengthUnit: Optional[Union[str, List[str]]] = None
+    strengthValue: Optional[Union[float, List[float]]] = None
+    maximumIntake: Optional[
+        Union["MaximumDoseSchedule", List["MaximumDoseSchedule"]]
+    ] = None
+    availableIn: Optional[Union[AdministrativeArea, List[AdministrativeArea]]] = None
+    activeIngredient: Optional[Union[str, List[str]]] = None

schema_models/dry_cleaning_or_laundry.py

@@ -0,0 +1,7 @@
+from schema_models.local_business import LocalBusiness
+
+
+class DryCleaningOrLaundry(LocalBusiness):
+    """
+    A dry-cleaning business.
+    """

schema_models/duration.py

@@ -0,0 +1,7 @@
+from schema_models.quantity import Quantity
+
+
+class Duration(Quantity):
+    """
+    The duration of the item (movie, audio recording, event, etc.) in [ISO 8601 duration format](http://en.wikipedia.org/wiki/ISO_8601).
+    """

schema_models/eat_action.py

@@ -0,0 +1,7 @@
+from schema_models.consume_action import ConsumeAction
+
+
+class EatAction(ConsumeAction):
+    """
+    The act of swallowing solid objects.
+    """

schema_models/education_event.py

@@ -0,0 +1,19 @@
+from typing import List, Optional, Union
+
+from pydantic import HttpUrl
+
+from schema_models.event import Event
+
+
+class EducationEvent(Event):
+    """
+    Event type: Education event.
+    """
+
+    teaches: Optional[Union[str, List[str], "DefinedTerm", List["DefinedTerm"]]] = None
+    assesses: Optional[Union["DefinedTerm", List["DefinedTerm"], str, List[str]]] = None
+    educationalLevel: Optional[
+        Union[
+            str, List[str], HttpUrl, List[HttpUrl], "DefinedTerm", List["DefinedTerm"]
+        ]
+    ] = None

schema_models/educational_audience.py

@@ -0,0 +1,11 @@
+from typing import List, Optional, Union
+
+from schema_models.audience import Audience
+
+
+class EducationalAudience(Audience):
+    """
+    An EducationalAudience.
+    """
+
+    educationalRole: Optional[Union[str, List[str]]] = None

schema_models/educational_occupational_credential.py

@@ -0,0 +1,27 @@
+from typing import List, Optional, Union
+
+from pydantic import HttpUrl
+
+from schema_models.administrative_area import AdministrativeArea
+from schema_models.creative_work import CreativeWork
+from schema_models.defined_term import DefinedTerm
+from schema_models.organization import Organization
+
+
+class EducationalOccupationalCredential(CreativeWork):
+    """
+    An educational or occupational credential. A diploma, academic degree, certification, qualification, badge, etc., that may be awarded to a person or other entity that meets the requirements defined by the credentialer.
+    """
+
+    validIn: Optional[Union[AdministrativeArea, List[AdministrativeArea]]] = None
+    recognizedBy: Optional[Union[Organization, List[Organization]]] = None
+    educationalLevel: Optional[
+        Union[str, List[str], HttpUrl, List[HttpUrl], DefinedTerm, List[DefinedTerm]]
+    ] = None
+    validFor: Optional[Union["Duration", List["Duration"]]] = None
+    competencyRequired: Optional[
+        Union[str, List[str], HttpUrl, List[HttpUrl], DefinedTerm, List[DefinedTerm]]
+    ] = None
+    credentialCategory: Optional[
+        Union[str, List[str], HttpUrl, List[HttpUrl], DefinedTerm, List[DefinedTerm]]
+    ] = None

schema_models/educational_occupational_program.py

@@ -0,0 +1,89 @@
+from datetime import date, datetime
+from typing import List, Optional, Union
+
+from pydantic import HttpUrl
+
+from schema_models.alignment_object import AlignmentObject
+from schema_models.defined_term import DefinedTerm
+from schema_models.demand import Demand
+from schema_models.intangible import Intangible
+from schema_models.offer import Offer
+from schema_models.organization import Organization
+from schema_models.person import Person
+from schema_models.structured_value import StructuredValue
+
+
+class EducationalOccupationalProgram(Intangible):
+    """
+    A program offered by an institution which determines the learning progress to achieve an outcome, usually a credential like a degree or certificate. This would define a discrete set of opportunities (e.g., job, courses) that together constitute a program with a clear start, end, set of requirements, and transition to a new occupational opportunity (e.g., a job), or sometimes a higher educational opportunity (e.g., an advanced degree).
+    """
+
+    applicationStartDate: Optional[Union[date, List[date]]] = None
+    provider: Optional[
+        Union[Person, List[Person], Organization, List[Organization]]
+    ] = None
+    salaryUponCompletion: Optional[
+        Union["MonetaryAmountDistribution", List["MonetaryAmountDistribution"]]
+    ] = None
+    maximumEnrollment: Optional[Union[int, List[int]]] = None
+    educationalCredentialAwarded: Optional[
+        Union[
+            str,
+            List[str],
+            "EducationalOccupationalCredential",
+            List["EducationalOccupationalCredential"],
+            HttpUrl,
+            List[HttpUrl],
+        ]
+    ] = None
+    applicationDeadline: Optional[Union[date, List[date], str, List[str]]] = None
+    educationalProgramMode: Optional[Union[str, List[str], HttpUrl, List[HttpUrl]]] = (
+        None
+    )
+    hasCourse: Optional[Union["Course", List["Course"]]] = None
+    termsPerYear: Optional[Union[float, List[float]]] = None
+    typicalCreditsPerTerm: Optional[
+        Union[StructuredValue, List[StructuredValue], int, List[int]]
+    ] = None
+    programPrerequisites: Optional[
+        Union[
+            str,
+            List[str],
+            "EducationalOccupationalCredential",
+            List["EducationalOccupationalCredential"],
+            AlignmentObject,
+            List[AlignmentObject],
+            "Course",
+            List["Course"],
+        ]
+    ] = None
+    startDate: Optional[Union[datetime, List[datetime], date, List[date]]] = None
+    dayOfWeek: Optional[Union["DayOfWeek", List["DayOfWeek"]]] = None
+    trainingSalary: Optional[
+        Union["MonetaryAmountDistribution", List["MonetaryAmountDistribution"]]
+    ] = None
+    numberOfCredits: Optional[
+        Union[int, List[int], StructuredValue, List[StructuredValue]]
+    ] = None
+    programType: Optional[Union[str, List[str], DefinedTerm, List[DefinedTerm]]] = None
+    offers: Optional[Union[Offer, List[Offer], Demand, List[Demand]]] = None
+    occupationalCategory: Optional[
+        Union["CategoryCode", List["CategoryCode"], str, List[str]]
+    ] = None
+    endDate: Optional[Union[date, List[date], datetime, List[datetime]]] = None
+    timeToComplete: Optional[Union["Duration", List["Duration"]]] = None
+    timeOfDay: Optional[Union[str, List[str]]] = None
+    financialAidEligible: Optional[
+        Union[str, List[str], DefinedTerm, List[DefinedTerm]]
+    ] = None
+    occupationalCredentialAwarded: Optional[
+        Union[
+            str,
+            List[str],
+            "EducationalOccupationalCredential",
+            List["EducationalOccupationalCredential"],
+            HttpUrl,
+            List[HttpUrl],
+        ]
+    ] = None
+    termDuration: Optional[Union["Duration", List["Duration"]]] = None

schema_models/educational_organization.py

@@ -0,0 +1,12 @@
+from typing import List, Optional, Union
+
+from schema_models.civic_structure import CivicStructure
+from schema_models.person import Person
+
+
+class EducationalOrganization(CivicStructure):
+    """
+    An educational organization.
+    """
+
+    alumni: Optional[Union[Person, List[Person]]] = None

schema_models/electrician.py

@@ -0,0 +1,7 @@
+from schema_models.home_and_construction_business import HomeAndConstructionBusiness
+
+
+class Electrician(HomeAndConstructionBusiness):
+    """
+    An electrician.
+    """

schema_models/electronics_store.py

@@ -0,0 +1,7 @@
+from schema_models.store import Store
+
+
+class ElectronicsStore(Store):
+    """
+    An electronics store.
+    """

schema_models/elementary_school.py

@@ -0,0 +1,7 @@
+from schema_models.educational_organization import EducationalOrganization
+
+
+class ElementarySchool(EducationalOrganization):
+    """
+    An elementary school.
+    """

schema_models/email_message.py

@@ -0,0 +1,7 @@
+from schema_models.message import Message
+
+
+class EmailMessage(Message):
+    """
+    An email message.
+    """

schema_models/embassy.py

@@ -0,0 +1,7 @@
+from schema_models.government_building import GovernmentBuilding
+
+
+class Embassy(GovernmentBuilding):
+    """
+    An embassy.
+    """

schema_models/emergency_service.py

@@ -0,0 +1,7 @@
+from schema_models.local_business import LocalBusiness
+
+
+class EmergencyService(LocalBusiness):
+    """
+    An emergency service, such as a fire station or ER.
+    """

schema_models/employee_role.py

@@ -0,0 +1,23 @@
+from typing import List, Optional, Union
+
+from schema_models.monetary_amount import MonetaryAmount
+from schema_models.organization_role import OrganizationRole
+from schema_models.price_specification import PriceSpecification
+
+
+class EmployeeRole(OrganizationRole):
+    """
+    A subclass of OrganizationRole used to describe employee relationships.
+    """
+
+    baseSalary: Optional[
+        Union[
+            PriceSpecification,
+            List[PriceSpecification],
+            MonetaryAmount,
+            List[MonetaryAmount],
+            float,
+            List[float],
+        ]
+    ] = None
+    salaryCurrency: Optional[Union[str, List[str]]] = None

schema_models/employer_aggregate_rating.py

@@ -0,0 +1,7 @@
+from schema_models.aggregate_rating import AggregateRating
+
+
+class EmployerAggregateRating(AggregateRating):
+    """
+    An aggregate rating of an Organization related to its role as an employer.
+    """

schema_models/employer_review.py

@@ -0,0 +1,7 @@
+from schema_models.review import Review
+
+
+class EmployerReview(Review):
+    """
+    An [[EmployerReview]] is a review of an [[Organization]] regarding its role as an employer, written by a current or former employee of that organization.
+    """

schema_models/employment_agency.py

@@ -0,0 +1,7 @@
+from schema_models.local_business import LocalBusiness
+
+
+class EmploymentAgency(LocalBusiness):
+    """
+    An employment agency.
+    """

schema_models/endorse_action.py

@@ -0,0 +1,15 @@
+from typing import List, Optional, Union
+
+from schema_models.organization import Organization
+from schema_models.person import Person
+from schema_models.react_action import ReactAction
+
+
+class EndorseAction(ReactAction):
+    """
+    An agent approves/certifies/likes/supports/sanctions an object.
+    """
+
+    endorsee: Optional[
+        Union[Person, List[Person], Organization, List[Organization]]
+    ] = None

schema_models/endorsement_rating.py

@@ -0,0 +1,13 @@
+from schema_models.rating import Rating
+
+
+class EndorsementRating(Rating):
+    """
+    An EndorsementRating is a rating that expresses some level of endorsement, for example inclusion in a "critic's pick" blog, a
+    "Like" or "+1" on a social network. It can be considered the [[result]] of an [[EndorseAction]] in which the [[object]] of the action is rated positively by
+    some [[agent]]. As is common elsewhere in schema.org, it is sometimes more useful to describe the results of such an action without explicitly describing the [[Action]].
+
+    An [[EndorsementRating]] may be part of a numeric scale or organized system, but this is not required: having an explicit type for indicating a positive,
+    endorsement rating is particularly useful in the absence of numeric scales as it helps consumers understand that the rating is broadly positive.
+
+    """

schema_models/energy.py

@@ -0,0 +1,7 @@
+from schema_models.quantity import Quantity
+
+
+class Energy(Quantity):
+    """
+    Properties that take Energy as values are of the form '<Number> <Energy unit of measure>'.
+    """

schema_models/energy_consumption_details.py

@@ -0,0 +1,19 @@
+from typing import List, Optional, Union
+
+from schema_models.intangible import Intangible
+
+
+class EnergyConsumptionDetails(Intangible):
+    """
+    EnergyConsumptionDetails represents information related to the energy efficiency of a product that consumes energy. The information that can be provided is based on international regulations such as for example [EU directive 2017/1369](https://eur-lex.europa.eu/eli/reg/2017/1369/oj) for energy labeling and the [Energy labeling rule](https://www.ftc.gov/enforcement/rules/rulemaking-regulatory-reform-proceedings/energy-water-use-labeling-consumer) under the Energy Policy and Conservation Act (EPCA) in the US.
+    """
+
+    hasEnergyEfficiencyCategory: Optional[
+        Union["EnergyEfficiencyEnumeration", List["EnergyEfficiencyEnumeration"]]
+    ] = None
+    energyEfficiencyScaleMax: Optional[
+        Union["EUEnergyEfficiencyEnumeration", List["EUEnergyEfficiencyEnumeration"]]
+    ] = None
+    energyEfficiencyScaleMin: Optional[
+        Union["EUEnergyEfficiencyEnumeration", List["EUEnergyEfficiencyEnumeration"]]
+    ] = None

schema_models/energy_efficiency_enumeration.py

@@ -0,0 +1,7 @@
+from schema_models.enumeration import Enumeration
+
+
+class EnergyEfficiencyEnumeration(Enumeration):
+    """
+    Enumerates energy efficiency levels (also known as "classes" or "ratings") and certifications that are part of several international energy efficiency standards.
+    """

schema_models/energy_star_energy_efficiency_enumeration.py

@@ -0,0 +1,7 @@
+from schema_models.energy_efficiency_enumeration import EnergyEfficiencyEnumeration
+
+
+class EnergyStarEnergyEfficiencyEnumeration(EnergyEfficiencyEnumeration):
+    """
+    Used to indicate whether a product is EnergyStar certified.
+    """

schema_models/engine_specification.py

@@ -0,0 +1,38 @@
+from typing import List, Optional, Union
+
+from pydantic import HttpUrl
+
+from schema_models.qualitative_value import QualitativeValue
+from schema_models.structured_value import StructuredValue
+
+
+class EngineSpecification(StructuredValue):
+    """
+    Information about the engine of the vehicle. A vehicle can have multiple engines represented by multiple engine specification entities.
+    """
+
+    enginePower: Optional[Union["QuantitativeValue", List["QuantitativeValue"]]] = None
+    torque: Optional[Union["QuantitativeValue", List["QuantitativeValue"]]] = None
+    engineType: Optional[
+        Union[
+            QualitativeValue,
+            List[QualitativeValue],
+            str,
+            List[str],
+            HttpUrl,
+            List[HttpUrl],
+        ]
+    ] = None
+    engineDisplacement: Optional[
+        Union["QuantitativeValue", List["QuantitativeValue"]]
+    ] = None
+    fuelType: Optional[
+        Union[
+            HttpUrl,
+            List[HttpUrl],
+            QualitativeValue,
+            List[QualitativeValue],
+            str,
+            List[str],
+        ]
+    ] = None

schema_models/entertainment_business.py

@@ -0,0 +1,7 @@
+from schema_models.local_business import LocalBusiness
+
+
+class EntertainmentBusiness(LocalBusiness):
+    """
+    A sub property of location. The entertainment business where the action occurred.
+    """

schema_models/entry_point.py

@@ -0,0 +1,32 @@
+from typing import List, Optional, Union
+
+from pydantic import HttpUrl
+
+from schema_models.intangible import Intangible
+
+
+class EntryPoint(Intangible):
+    """
+    An entry point, within some Web-based protocol.
+    """
+
+    httpMethod: Optional[Union[str, List[str]]] = None
+    encodingType: Optional[Union[str, List[str]]] = None
+    urlTemplate: Optional[Union[str, List[str]]] = None
+    actionPlatform: Optional[
+        Union[
+            "DigitalPlatformEnumeration",
+            List["DigitalPlatformEnumeration"],
+            str,
+            List[str],
+            HttpUrl,
+            List[HttpUrl],
+        ]
+    ] = None
+    application: Optional[Union["SoftwareApplication", List["SoftwareApplication"]]] = (
+        None
+    )
+    actionApplication: Optional[
+        Union["SoftwareApplication", List["SoftwareApplication"]]
+    ] = None
+    contentType: Optional[Union[str, List[str]]] = None

schema_models/enumeration.py

@@ -0,0 +1,20 @@
+from typing import List, Optional, Union
+
+from schema_models.intangible import Intangible
+
+
+class Enumeration(Intangible):
+    """
+    Lists or enumerations—for example, a list of cuisines or music genres, etc.
+    """
+
+    supersededBy: Optional[
+        Union[
+            "Property",
+            List["Property"],
+            "_Class",
+            List["_Class"],
+            "Enumeration",
+            List["Enumeration"],
+        ]
+    ] = None