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

schema_models/hostel.py

@@ -0,0 +1,10 @@
+from schema_models.lodging_business import LodgingBusiness
+
+
+class Hostel(LodgingBusiness):
+    """
+    A hostel - cheap accommodation, often in shared dormitories.
+    <br /><br />
+    See also the <a href="/docs/hotels.html">dedicated document on the use of schema.org for marking up hotels and other forms of accommodations</a>.
+
+    """

schema_models/hotel.py

@@ -0,0 +1,10 @@
+from schema_models.lodging_business import LodgingBusiness
+
+
+class Hotel(LodgingBusiness):
+    """
+    A hotel is an establishment that provides lodging paid on a short-term basis (source: Wikipedia, the free encyclopedia, see http://en.wikipedia.org/wiki/Hotel).
+    <br /><br />
+    See also the <a href="/docs/hotels.html">dedicated document on the use of schema.org for marking up hotels and other forms of accommodations</a>.
+
+    """

schema_models/hotel_room.py

@@ -0,0 +1,20 @@
+from typing import List, Optional, Union
+
+from schema_models.bed_details import BedDetails
+from schema_models.bed_type import BedType
+from schema_models.quantitative_value import QuantitativeValue
+from schema_models.room import Room
+
+
+class HotelRoom(Room):
+    """
+    A hotel room is a single room in a hotel.
+    <br /><br />
+    See also the <a href="/docs/hotels.html">dedicated document on the use of schema.org for marking up hotels and other forms of accommodations</a>.
+
+    """
+
+    bed: Optional[
+        Union[BedType, List[BedType], BedDetails, List[BedDetails], str, List[str]]
+    ] = None
+    occupancy: Optional[Union[QuantitativeValue, List[QuantitativeValue]]] = None

schema_models/house.py

@@ -0,0 +1,14 @@
+from typing import List, Optional, Union
+
+from schema_models.accommodation import Accommodation
+from schema_models.quantitative_value import QuantitativeValue
+
+
+class House(Accommodation):
+    """
+    A house is a building or structure that has the ability to be occupied for habitation by humans or other creatures (source: Wikipedia, the free encyclopedia, see <a href="http://en.wikipedia.org/wiki/House">http://en.wikipedia.org/wiki/House</a>).
+    """
+
+    numberOfRooms: Optional[
+        Union[QuantitativeValue, List[QuantitativeValue], float, List[float]]
+    ] = None

schema_models/house_painter.py

@@ -0,0 +1,7 @@
+from schema_models.home_and_construction_business import HomeAndConstructionBusiness
+
+
+class HousePainter(HomeAndConstructionBusiness):
+    """
+    A house painting service.
+    """

schema_models/how_to.py

@@ -0,0 +1,39 @@
+from typing import List, Optional, Union
+
+from schema_models.creative_work import CreativeWork
+from schema_models.item_list import ItemList
+
+
+class HowTo(CreativeWork):
+    """
+    Instructions that explain how to achieve a result by performing a sequence of steps.
+    """
+
+    estimatedCost: Optional[
+        Union["MonetaryAmount", List["MonetaryAmount"], str, List[str]]
+    ] = None
+    supply: Optional[Union[str, List[str], "HowToSupply", List["HowToSupply"]]] = None
+    _yield: Optional[
+        Union["QuantitativeValue", List["QuantitativeValue"], str, List[str]]
+    ] = None
+    tool: Optional[Union["HowToTool", List["HowToTool"], str, List[str]]] = None
+    steps: Optional[
+        Union[
+            ItemList, List[ItemList], CreativeWork, List[CreativeWork], str, List[str]
+        ]
+    ] = None
+    prepTime: Optional[Union["Duration", List["Duration"]]] = None
+    step: Optional[
+        Union[
+            "HowToSection",
+            List["HowToSection"],
+            "HowToStep",
+            List["HowToStep"],
+            CreativeWork,
+            List[CreativeWork],
+            str,
+            List[str],
+        ]
+    ] = None
+    totalTime: Optional[Union["Duration", List["Duration"]]] = None
+    performTime: Optional[Union["Duration", List["Duration"]]] = None

schema_models/how_to_direction.py

@@ -0,0 +1,28 @@
+from typing import List, Optional, Union
+
+from pydantic import HttpUrl
+
+from schema_models.duration import Duration
+from schema_models.list_item import ListItem
+from schema_models.media_object import MediaObject
+
+
+class HowToDirection(ListItem):
+    """
+    A direction indicating a single action to do in the instructions for how to achieve a result.
+    """
+
+    supply: Optional[Union[str, List[str], "HowToSupply", List["HowToSupply"]]] = None
+    tool: Optional[Union["HowToTool", List["HowToTool"], str, List[str]]] = None
+    prepTime: Optional[Union[Duration, List[Duration]]] = None
+    totalTime: Optional[Union[Duration, List[Duration]]] = None
+    performTime: Optional[Union[Duration, List[Duration]]] = None
+    beforeMedia: Optional[
+        Union[HttpUrl, List[HttpUrl], MediaObject, List[MediaObject]]
+    ] = None
+    duringMedia: Optional[
+        Union[HttpUrl, List[HttpUrl], MediaObject, List[MediaObject]]
+    ] = None
+    afterMedia: Optional[
+        Union[HttpUrl, List[HttpUrl], MediaObject, List[MediaObject]]
+    ] = None

schema_models/how_to_item.py

@@ -0,0 +1,20 @@
+from typing import List, Optional, Union
+
+from schema_models.list_item import ListItem
+
+
+class HowToItem(ListItem):
+    """
+    An item used as either a tool or supply when performing the instructions for how to achieve a result.
+    """
+
+    requiredQuantity: Optional[
+        Union[
+            "QuantitativeValue",
+            List["QuantitativeValue"],
+            str,
+            List[str],
+            float,
+            List[float],
+        ]
+    ] = None

schema_models/how_to_section.py

@@ -0,0 +1,17 @@
+from typing import List, Optional, Union
+
+from schema_models.creative_work import CreativeWork
+from schema_models.item_list import ItemList
+from schema_models.list_item import ListItem
+
+
+class HowToSection(ListItem):
+    """
+    A sub-grouping of steps in the instructions for how to achieve a result (e.g. steps for making a pie crust within a pie recipe).
+    """
+
+    steps: Optional[
+        Union[
+            ItemList, List[ItemList], CreativeWork, List[CreativeWork], str, List[str]
+        ]
+    ] = None

schema_models/how_to_step.py

@@ -0,0 +1,7 @@
+from schema_models.list_item import ListItem
+
+
+class HowToStep(ListItem):
+    """
+    A step in the instructions for how to achieve a result. It is an ordered list with HowToDirection and/or HowToTip items.
+    """

schema_models/how_to_supply.py

@@ -0,0 +1,14 @@
+from typing import List, Optional, Union
+
+from schema_models.how_to_item import HowToItem
+from schema_models.monetary_amount import MonetaryAmount
+
+
+class HowToSupply(HowToItem):
+    """
+    A supply consumed when performing the instructions for how to achieve a result.
+    """
+
+    estimatedCost: Optional[
+        Union[MonetaryAmount, List[MonetaryAmount], str, List[str]]
+    ] = None

schema_models/how_to_tip.py

@@ -0,0 +1,7 @@
+from schema_models.list_item import ListItem
+
+
+class HowToTip(ListItem):
+    """
+    An explanation in the instructions for how to achieve a result. It provides supplementary information about a technique, supply, author's preference, etc. It can explain what could be done, or what should not be done, but doesn't specify what should be done (see HowToDirection).
+    """

schema_models/how_to_tool.py

@@ -0,0 +1,7 @@
+from schema_models.how_to_item import HowToItem
+
+
+class HowToTool(HowToItem):
+    """
+    A tool used (but not consumed) when performing instructions for how to achieve a result.
+    """

schema_models/hvac_business.py

@@ -0,0 +1,7 @@
+from schema_models.home_and_construction_business import HomeAndConstructionBusiness
+
+
+class HVACBusiness(HomeAndConstructionBusiness):
+    """
+    A business that provides Heating, Ventilation and Air Conditioning services.
+    """

schema_models/hyper_toc.py

@@ -0,0 +1,13 @@
+from typing import List, Optional, Union
+
+from schema_models.creative_work import CreativeWork
+from schema_models.media_object import MediaObject
+
+
+class HyperToc(CreativeWork):
+    """
+    A HyperToc represents a hypertext table of contents for complex media objects, such as [[VideoObject]], [[AudioObject]]. Items in the table of contents are indicated using the [[tocEntry]] property, and typed [[HyperTocEntry]]. For cases where the same larger work is split into multiple files, [[associatedMedia]] can be used on individual [[HyperTocEntry]] items.
+    """
+
+    associatedMedia: Optional[Union[MediaObject, List[MediaObject]]] = None
+    tocEntry: Optional[Union["HyperTocEntry", List["HyperTocEntry"]]] = None

schema_models/hyper_toc_entry.py

@@ -0,0 +1,14 @@
+from typing import List, Optional, Union
+
+from schema_models.creative_work import CreativeWork
+from schema_models.media_object import MediaObject
+
+
+class HyperTocEntry(CreativeWork):
+    """
+    A HyperToEntry is an item within a [[HyperToc]], which represents a hypertext table of contents for complex media objects, such as [[VideoObject]], [[AudioObject]]. The media object itself is indicated using [[associatedMedia]]. Each section of interest within that content can be described with a [[HyperTocEntry]], with associated [[startOffset]] and [[endOffset]]. When several entries are all from the same file, [[associatedMedia]] is used on the overarching [[HyperTocEntry]]; if the content has been split into multiple files, they can be referenced using [[associatedMedia]] on each [[HyperTocEntry]].
+    """
+
+    utterances: Optional[Union[str, List[str]]] = None
+    associatedMedia: Optional[Union[MediaObject, List[MediaObject]]] = None
+    tocContinuation: Optional[Union["HyperTocEntry", List["HyperTocEntry"]]] = None

schema_models/ice_cream_shop.py

@@ -0,0 +1,7 @@
+from schema_models.food_establishment import FoodEstablishment
+
+
+class IceCreamShop(FoodEstablishment):
+    """
+    An ice cream shop.
+    """

schema_models/ignore_action.py

@@ -0,0 +1,7 @@
+from schema_models.assess_action import AssessAction
+
+
+class IgnoreAction(AssessAction):
+    """
+    The act of intentionally disregarding the object. An agent ignores an object.
+    """

schema_models/image_gallery.py

@@ -0,0 +1,7 @@
+from schema_models.media_gallery import MediaGallery
+
+
+class ImageGallery(MediaGallery):
+    """
+    Web page type: Image gallery page.
+    """

schema_models/image_object.py

@@ -0,0 +1,15 @@
+from typing import List, Optional, Union
+
+from schema_models.media_object import MediaObject
+from schema_models.property_value import PropertyValue
+
+
+class ImageObject(MediaObject):
+    """
+    An image file.
+    """
+
+    representativeOfPage: Optional[Union[bool, List[bool]]] = None
+    embeddedTextCaption: Optional[Union[str, List[str]]] = None
+    exifData: Optional[Union[str, List[str], PropertyValue, List[PropertyValue]]] = None
+    caption: Optional[Union[MediaObject, List[MediaObject], str, List[str]]] = None

schema_models/image_object_snapshot.py

@@ -0,0 +1,7 @@
+from schema_models.image_object import ImageObject
+
+
+class ImageObjectSnapshot(ImageObject):
+    """
+    A specific and exact (byte-for-byte) version of an [[ImageObject]]. Two byte-for-byte identical files, for the purposes of this type, considered identical. If they have different embedded metadata (e.g. XMP, EXIF) the files will differ. Different external facts about the files, e.g. creator or dateCreated that aren't represented in their actual content, do not affect this notion of identity.
+    """

schema_models/imaging_test.py

@@ -0,0 +1,13 @@
+from typing import List, Optional, Union
+
+from schema_models.medical_test import MedicalTest
+
+
+class ImagingTest(MedicalTest):
+    """
+    Any medical imaging modality typically used for diagnostic purposes.
+    """
+
+    imagingTechnique: Optional[
+        Union["MedicalImagingTechnique", List["MedicalImagingTechnique"]]
+    ] = None

schema_models/individual_physician.py

@@ -0,0 +1,13 @@
+from typing import List, Optional, Union
+
+from schema_models.medical_organization import MedicalOrganization
+from schema_models.physician import Physician
+
+
+class IndividualPhysician(Physician):
+    """
+    An individual medical practitioner. For their official address use [[address]], for affiliations to hospitals use [[hospitalAffiliation]].
+    The [[practicesAt]] property can be used to indicate [[MedicalOrganization]] hospitals, clinics, pharmacies etc. where this physician practices.
+    """
+
+    practicesAt: Optional[Union[MedicalOrganization, List[MedicalOrganization]]] = None

schema_models/individual_product.py

@@ -0,0 +1,11 @@
+from typing import List, Optional, Union
+
+from schema_models.product import Product
+
+
+class IndividualProduct(Product):
+    """
+    A single, identifiable product instance (e.g. a laptop with a particular serial number).
+    """
+
+    serialNumber: Optional[Union[str, List[str]]] = None

schema_models/infectious_agent_class.py

@@ -0,0 +1,7 @@
+from schema_models.medical_enumeration import MedicalEnumeration
+
+
+class InfectiousAgentClass(MedicalEnumeration):
+    """
+    Classes of agents or pathogens that transmit infectious diseases. Enumerated type.
+    """

schema_models/infectious_disease.py

@@ -0,0 +1,15 @@
+from typing import List, Optional, Union
+
+from schema_models.medical_condition import MedicalCondition
+
+
+class InfectiousDisease(MedicalCondition):
+    """
+    An infectious disease is a clinically evident human disease resulting from the presence of pathogenic microbial agents, like pathogenic viruses, pathogenic bacteria, fungi, protozoa, multicellular parasites, and prions. To be considered an infectious disease, such pathogens are known to be able to cause this disease.
+    """
+
+    infectiousAgentClass: Optional[
+        Union["InfectiousAgentClass", List["InfectiousAgentClass"]]
+    ] = None
+    infectiousAgent: Optional[Union[str, List[str]]] = None
+    transmissionMethod: Optional[Union[str, List[str]]] = None

schema_models/inform_action.py

@@ -0,0 +1,12 @@
+from typing import List, Optional, Union
+
+from schema_models.communicate_action import CommunicateAction
+from schema_models.event import Event
+
+
+class InformAction(CommunicateAction):
+    """
+    The act of notifying someone of information pertinent to them, with no expectation of a response.
+    """
+
+    event: Optional[Union[Event, List[Event]]] = None

schema_models/insert_action.py

@@ -0,0 +1,12 @@
+from typing import List, Optional, Union
+
+from schema_models.add_action import AddAction
+from schema_models.place import Place
+
+
+class InsertAction(AddAction):
+    """
+    The act of adding at a specific location in an ordered collection.
+    """
+
+    toLocation: Optional[Union[Place, List[Place]]] = None

schema_models/install_action.py

@@ -0,0 +1,7 @@
+from schema_models.consume_action import ConsumeAction
+
+
+class InstallAction(ConsumeAction):
+    """
+    The act of installing an application.
+    """

schema_models/insurance_agency.py

@@ -0,0 +1,7 @@
+from schema_models.financial_service import FinancialService
+
+
+class InsuranceAgency(FinancialService):
+    """
+    An Insurance agency.
+    """

schema_models/intangible.py

@@ -0,0 +1,7 @@
+from schema_models.thing import Thing
+
+
+class Intangible(Thing):
+    """
+    A utility class that serves as the umbrella for a number of 'intangible' things such as quantities, structured values, etc.
+    """

schema_models/integer.py

@@ -0,0 +1,6 @@
+from fquery.pydantic import pydantic
+
+
+@pydantic
+class Integer:
+    pass

schema_models/interact_action.py

@@ -0,0 +1,7 @@
+from schema_models.action import Action
+
+
+class InteractAction(Action):
+    """
+    The act of interacting with another person or organization.
+    """

schema_models/interaction_counter.py

@@ -0,0 +1,35 @@
+from datetime import datetime, time
+from typing import List, Optional, Union
+
+from schema_models.action import Action
+from schema_models.place import Place
+from schema_models.software_application import SoftwareApplication
+from schema_models.structured_value import StructuredValue
+from schema_models.virtual_location import VirtualLocation
+from schema_models.web_site import WebSite
+
+
+class InteractionCounter(StructuredValue):
+    """
+    A summary of how users have interacted with this CreativeWork. In most cases, authors will use a subtype to specify the specific type of interaction.
+    """
+
+    userInteractionCount: Optional[Union[int, List[int]]] = None
+    endTime: Optional[Union[datetime, List[datetime], time, List[time]]] = None
+    location: Optional[
+        Union[
+            str,
+            List[str],
+            Place,
+            List[Place],
+            VirtualLocation,
+            List[VirtualLocation],
+            "PostalAddress",
+            List["PostalAddress"],
+        ]
+    ] = None
+    startTime: Optional[Union[datetime, List[datetime], time, List[time]]] = None
+    interactionType: Optional[Union[Action, List[Action]]] = None
+    interactionService: Optional[
+        Union[WebSite, List[WebSite], SoftwareApplication, List[SoftwareApplication]]
+    ] = None

schema_models/internet_cafe.py

@@ -0,0 +1,7 @@
+from schema_models.local_business import LocalBusiness
+
+
+class InternetCafe(LocalBusiness):
+    """
+    An internet cafe.
+    """

schema_models/investment_fund.py

@@ -0,0 +1,7 @@
+from schema_models.investment_or_deposit import InvestmentOrDeposit
+
+
+class InvestmentFund(InvestmentOrDeposit):
+    """
+    A company or fund that gathers capital from a number of investors to create a pool of money that is then re-invested into stocks, bonds and other assets.
+    """

schema_models/investment_or_deposit.py

@@ -0,0 +1,14 @@
+from typing import List, Optional, Union
+
+from schema_models.financial_product import FinancialProduct
+from schema_models.monetary_amount import MonetaryAmount
+
+
+class InvestmentOrDeposit(FinancialProduct):
+    """
+    A type of financial product that typically requires the client to transfer funds to a financial service in return for potential beneficial financial return.
+    """
+
+    amount: Optional[
+        Union[MonetaryAmount, List[MonetaryAmount], float, List[float]]
+    ] = None

schema_models/invite_action.py

@@ -0,0 +1,12 @@
+from typing import List, Optional, Union
+
+from schema_models.communicate_action import CommunicateAction
+from schema_models.event import Event
+
+
+class InviteAction(CommunicateAction):
+    """
+    The act of asking someone to attend an event. Reciprocal of RsvpAction.
+    """
+
+    event: Optional[Union[Event, List[Event]]] = None

schema_models/invoice.py

@@ -0,0 +1,70 @@
+from datetime import date, datetime
+from typing import List, Optional, Union
+
+from pydantic import HttpUrl
+
+from schema_models.intangible import Intangible
+from schema_models.order import Order
+from schema_models.organization import Organization
+from schema_models.person import Person
+from schema_models.thing import Thing
+
+
+class Invoice(Intangible):
+    """
+    A statement of the money due for goods or services; a bill.
+    """
+
+    billingPeriod: Optional[Union["Duration", List["Duration"]]] = None
+    paymentMethodId: Optional[Union[str, List[str]]] = None
+    referencesOrder: Optional[Union[Order, List[Order]]] = None
+    totalPaymentDue: Optional[
+        Union[
+            "PriceSpecification",
+            List["PriceSpecification"],
+            "MonetaryAmount",
+            List["MonetaryAmount"],
+        ]
+    ] = None
+    paymentMethod: Optional[
+        Union[str, List[str], "PaymentMethod", List["PaymentMethod"]]
+    ] = None
+    paymentDue: Optional[Union[datetime, List[datetime]]] = None
+    confirmationNumber: Optional[Union[str, List[str]]] = None
+    paymentStatus: Optional[
+        Union[str, List[str], "PaymentStatusType", List["PaymentStatusType"]]
+    ] = None
+    provider: Optional[
+        Union[Person, List[Person], Organization, List[Organization]]
+    ] = None
+    accountId: Optional[Union[str, List[str]]] = None
+    paymentDueDate: Optional[Union[date, List[date], datetime, List[datetime]]] = None
+    category: Optional[
+        Union[
+            Thing,
+            List[Thing],
+            "PhysicalActivityCategory",
+            List["PhysicalActivityCategory"],
+            "CategoryCode",
+            List["CategoryCode"],
+            str,
+            List[str],
+            HttpUrl,
+            List[HttpUrl],
+        ]
+    ] = None
+    customer: Optional[
+        Union[Person, List[Person], Organization, List[Organization]]
+    ] = None
+    minimumPaymentDue: Optional[
+        Union[
+            "MonetaryAmount",
+            List["MonetaryAmount"],
+            "PriceSpecification",
+            List["PriceSpecification"],
+        ]
+    ] = None
+    scheduledPaymentDate: Optional[Union[date, List[date]]] = None
+    broker: Optional[Union[Organization, List[Organization], Person, List[Person]]] = (
+        None
+    )

schema_models/iptc_digital_source_enumeration.py

@@ -0,0 +1,9 @@
+from schema_models.media_enumeration import MediaEnumeration
+
+
+class IPTCDigitalSourceEnumeration(MediaEnumeration):
+    """
+    <a href="https://www.iptc.org/">IPTC</a> "Digital Source" codes for use with the [[digitalSourceType]] property, providing information about the source for a digital media object.
+    In general these codes are not declared here to be mutually exclusive, although some combinations would be contradictory if applied simultaneously, or might be considered mutually incompatible by upstream maintainers of the definitions. See the IPTC <a href="https://www.iptc.org/std/photometadata/documentation/userguide/">documentation</a>
+     for <a href="https://cv.iptc.org/newscodes/digitalsourcetype/">detailed definitions</a> of all terms.
+    """

schema_models/item_availability.py

@@ -0,0 +1,7 @@
+from schema_models.enumeration import Enumeration
+
+
+class ItemAvailability(Enumeration):
+    """
+    A list of possible product availability options.
+    """

schema_models/item_list.py

@@ -0,0 +1,18 @@
+from typing import List, Optional, Union
+
+from schema_models.intangible import Intangible
+from schema_models.thing import Thing
+
+
+class ItemList(Intangible):
+    """
+    A list of items of any sort—for example, Top 10 Movies About Weathermen, or Top 100 Party Songs. Not to be confused with HTML lists, which are often used only for formatting.
+    """
+
+    itemListElement: Optional[
+        Union["ListItem", List["ListItem"], Thing, List[Thing], str, List[str]]
+    ] = None
+    numberOfItems: Optional[Union[int, List[int]]] = None
+    itemListOrder: Optional[
+        Union["ItemListOrderType", List["ItemListOrderType"], str, List[str]]
+    ] = None

schema_models/item_list_order_type.py

@@ -0,0 +1,7 @@
+from schema_models.enumeration import Enumeration
+
+
+class ItemListOrderType(Enumeration):
+    """
+    Enumerated for values for itemListOrder for indicating how an ordered ItemList is organized.
+    """