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

schema_models/about_page.py

@@ -0,0 +1,7 @@
+from schema_models.web_page import WebPage
+
+
+class AboutPage(WebPage):
+    """
+    Web page type: About page.
+    """

schema_models/accept_action.py

@@ -0,0 +1,11 @@
+from schema_models.allocate_action import AllocateAction
+
+
+class AcceptAction(AllocateAction):
+    """
+    The act of committing to/adopting an object.
+
+    Related actions:
+
+    * [[RejectAction]]: The antonym of AcceptAction.
+    """

schema_models/accommodation.py

@@ -0,0 +1,47 @@
+from typing import List, Optional, Union
+
+from pydantic import HttpUrl
+
+from schema_models.bed_details import BedDetails
+from schema_models.floor_plan import FloorPlan
+from schema_models.place import Place
+
+
+class Accommodation(Place):
+    """
+    An accommodation is a place that can accommodate human beings, e.g. a hotel room, a camping pitch, or a meeting room. Many accommodations are for overnight stays, but this is not a mandatory requirement.
+    For more specific types of accommodations not defined in schema.org, one can use [[additionalType]] with external vocabularies.
+    <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>.
+
+    """
+
+    numberOfBathroomsTotal: Optional[Union[int, List[int]]] = None
+    accommodationCategory: Optional[Union[str, List[str]]] = None
+    floorLevel: Optional[Union[str, List[str]]] = None
+    bed: Optional[
+        Union["BedType", List["BedType"], BedDetails, List[BedDetails], str, List[str]]
+    ] = None
+    numberOfBedrooms: Optional[
+        Union[float, List[float], "QuantitativeValue", List["QuantitativeValue"]]
+    ] = None
+    leaseLength: Optional[
+        Union[
+            "QuantitativeValue", List["QuantitativeValue"], "Duration", List["Duration"]
+        ]
+    ] = None
+    numberOfFullBathrooms: Optional[Union[float, List[float]]] = None
+    floorSize: Optional[Union["QuantitativeValue", List["QuantitativeValue"]]] = None
+    yearBuilt: Optional[Union[float, List[float]]] = None
+    numberOfRooms: Optional[
+        Union["QuantitativeValue", List["QuantitativeValue"], float, List[float]]
+    ] = None
+    petsAllowed: Optional[Union[str, List[str], bool, List[bool]]] = None
+    accommodationFloorPlan: Optional[Union[FloorPlan, List[FloorPlan]]] = None
+    amenityFeature: Optional[
+        Union["LocationFeatureSpecification", List["LocationFeatureSpecification"]]
+    ] = None
+    occupancy: Optional[Union["QuantitativeValue", List["QuantitativeValue"]]] = None
+    permittedUsage: Optional[Union[str, List[str]]] = None
+    tourBookingPage: Optional[Union[HttpUrl, List[HttpUrl]]] = None
+    numberOfPartialBathrooms: Optional[Union[float, List[float]]] = None

schema_models/accounting_service.py

@@ -0,0 +1,10 @@
+from schema_models.financial_service import FinancialService
+
+
+class AccountingService(FinancialService):
+    """
+    Accountancy business.
+
+    As a [[LocalBusiness]] it can be described as a [[provider]] of one or more [[Service]]\\(s).
+
+    """

schema_models/achieve_action.py

@@ -0,0 +1,7 @@
+from schema_models.action import Action
+
+
+class AchieveAction(Action):
+    """
+    The act of accomplishing something via previous efforts. It is an instantaneous action rather than an ongoing process.
+    """

schema_models/action.py

@@ -0,0 +1,48 @@
+from datetime import datetime, time
+from typing import List, Optional, Union
+
+from pydantic import HttpUrl
+
+from schema_models.organization import Organization
+from schema_models.thing import Thing
+
+
+class Action(Thing):
+    """
+    An action performed by a direct agent and indirect participants upon a direct object. Optionally happens at a location with the help of an inanimate instrument. The execution of the action may produce a result. Specific action sub-type documentation specifies the exact expectation of each argument/role.
+
+    See also [blog post](http://blog.schema.org/2014/04/announcing-schemaorg-actions.html) and [Actions overview document](https://schema.org/docs/actions.html).
+    """
+
+    participant: Optional[
+        Union["Person", List["Person"], Organization, List[Organization]]
+    ] = None
+    provider: Optional[
+        Union["Person", List["Person"], Organization, List[Organization]]
+    ] = None
+    error: Optional[Union[Thing, List[Thing]]] = None
+    location: Optional[
+        Union[
+            str,
+            List[str],
+            "Place",
+            List["Place"],
+            "VirtualLocation",
+            List["VirtualLocation"],
+            "PostalAddress",
+            List["PostalAddress"],
+        ]
+    ] = None
+    result: Optional[Union[Thing, List[Thing]]] = None
+    startTime: Optional[Union[datetime, List[datetime], time, List[time]]] = None
+    actionStatus: Optional[Union["ActionStatusType", List["ActionStatusType"]]] = None
+    instrument: Optional[Union[Thing, List[Thing]]] = None
+    actionProcess: Optional[Union["HowTo", List["HowTo"]]] = None
+    endTime: Optional[Union[datetime, List[datetime], time, List[time]]] = None
+    target: Optional[
+        Union[HttpUrl, List[HttpUrl], "EntryPoint", List["EntryPoint"]]
+    ] = None
+    object: Optional[Union[Thing, List[Thing]]] = None
+    agent: Optional[
+        Union["Person", List["Person"], Organization, List[Organization]]
+    ] = None

schema_models/action_access_specification.py

@@ -0,0 +1,47 @@
+from datetime import date, datetime, time
+from typing import List, Optional, Union
+
+from pydantic import HttpUrl
+
+from schema_models.intangible import Intangible
+from schema_models.media_subscription import MediaSubscription
+from schema_models.offer import Offer
+from schema_models.place import Place
+from schema_models.thing import Thing
+
+
+class ActionAccessSpecification(Intangible):
+    """
+    A set of requirements that must be fulfilled in order to perform an Action.
+    """
+
+    requiresSubscription: Optional[
+        Union[bool, List[bool], MediaSubscription, List[MediaSubscription]]
+    ] = None
+    expectsAcceptanceOf: Optional[Union[Offer, List[Offer]]] = None
+    availabilityEnds: Optional[
+        Union[datetime, List[datetime], time, List[time], date, List[date]]
+    ] = None
+    ineligibleRegion: Optional[
+        Union[Place, List[Place], str, List[str], "GeoShape", List["GeoShape"]]
+    ] = None
+    availabilityStarts: Optional[
+        Union[date, List[date], time, List[time], datetime, List[datetime]]
+    ] = None
+    category: Optional[
+        Union[
+            Thing,
+            List[Thing],
+            "PhysicalActivityCategory",
+            List["PhysicalActivityCategory"],
+            "CategoryCode",
+            List["CategoryCode"],
+            str,
+            List[str],
+            HttpUrl,
+            List[HttpUrl],
+        ]
+    ] = None
+    eligibleRegion: Optional[
+        Union["GeoShape", List["GeoShape"], str, List[str], Place, List[Place]]
+    ] = None

schema_models/action_status_type.py

@@ -0,0 +1,7 @@
+from schema_models.status_enumeration import StatusEnumeration
+
+
+class ActionStatusType(StatusEnumeration):
+    """
+    The status of an Action.
+    """

schema_models/activate_action.py

@@ -0,0 +1,7 @@
+from schema_models.control_action import ControlAction
+
+
+class ActivateAction(ControlAction):
+    """
+    The act of starting or activating a device or application (e.g. starting a timer or turning on a flashlight).
+    """

schema_models/add_action.py

@@ -0,0 +1,7 @@
+from schema_models.update_action import UpdateAction
+
+
+class AddAction(UpdateAction):
+    """
+    The act of editing by adding an object to a collection.
+    """

schema_models/administrative_area.py

@@ -0,0 +1,7 @@
+from schema_models.place import Place
+
+
+class AdministrativeArea(Place):
+    """
+    A geographical region, typically under the jurisdiction of a particular government.
+    """

schema_models/adult_entertainment.py

@@ -0,0 +1,7 @@
+from schema_models.entertainment_business import EntertainmentBusiness
+
+
+class AdultEntertainment(EntertainmentBusiness):
+    """
+    An adult entertainment establishment.
+    """

schema_models/adult_oriented_enumeration.py

@@ -0,0 +1,7 @@
+from schema_models.enumeration import Enumeration
+
+
+class AdultOrientedEnumeration(Enumeration):
+    """
+    Enumeration of considerations that make a product relevant or potentially restricted for adults only.
+    """

schema_models/advertiser_content_article.py

@@ -0,0 +1,7 @@
+from schema_models.article import Article
+
+
+class AdvertiserContentArticle(Article):
+    """
+    An [[Article]] that an external entity has paid to place or to produce to its specifications. Includes [advertorials](https://en.wikipedia.org/wiki/Advertorial), sponsored content, native advertising and other paid content.
+    """

schema_models/aggregate_offer.py

@@ -0,0 +1,17 @@
+from typing import List, Optional, Union
+
+from schema_models.demand import Demand
+from schema_models.offer import Offer
+
+
+class AggregateOffer(Offer):
+    """
+    When a single product is associated with multiple offers (for example, the same pair of shoes is offered by different merchants), then AggregateOffer can be used.
+
+    Note: AggregateOffers are normally expected to associate multiple offers that all share the same defined [[businessFunction]] value, or default to http://purl.org/goodrelations/v1#Sell if businessFunction is not explicitly defined.
+    """
+
+    highPrice: Optional[Union[str, List[str], float, List[float]]] = None
+    offerCount: Optional[Union[int, List[int]]] = None
+    lowPrice: Optional[Union[str, List[str], float, List[float]]] = None
+    offers: Optional[Union[Offer, List[Offer], Demand, List[Demand]]] = None

schema_models/aggregate_rating.py

@@ -0,0 +1,14 @@
+from typing import List, Optional, Union
+
+from schema_models.rating import Rating
+from schema_models.thing import Thing
+
+
+class AggregateRating(Rating):
+    """
+    The average rating based on multiple ratings or reviews.
+    """
+
+    reviewCount: Optional[Union[int, List[int]]] = None
+    ratingCount: Optional[Union[int, List[int]]] = None
+    itemReviewed: Optional[Union[Thing, List[Thing]]] = None

schema_models/agree_action.py

@@ -0,0 +1,7 @@
+from schema_models.react_action import ReactAction
+
+
+class AgreeAction(ReactAction):
+    """
+    The act of expressing a consistency of opinion with the object. An agent agrees to/about an object (a proposition, topic or theme) with participants.
+    """

schema_models/airline.py

@@ -0,0 +1,14 @@
+from typing import List, Optional, Union
+
+from schema_models.organization import Organization
+
+
+class Airline(Organization):
+    """
+    An organization that provides flights for passengers.
+    """
+
+    iataCode: Optional[Union[str, List[str]]] = None
+    boardingPolicy: Optional[
+        Union["BoardingPolicyType", List["BoardingPolicyType"]]
+    ] = None

schema_models/airport.py

@@ -0,0 +1,12 @@
+from typing import List, Optional, Union
+
+from schema_models.civic_structure import CivicStructure
+
+
+class Airport(CivicStructure):
+    """
+    An airport.
+    """
+
+    iataCode: Optional[Union[str, List[str]]] = None
+    icaoCode: Optional[Union[str, List[str]]] = None

schema_models/alignment_object.py

@@ -0,0 +1,19 @@
+from typing import List, Optional, Union
+
+from pydantic import HttpUrl
+
+from schema_models.intangible import Intangible
+
+
+class AlignmentObject(Intangible):
+    """
+    An intangible item that describes an alignment between a learning resource and a node in an educational framework.
+
+    Should not be used where the nature of the alignment can be described using a simple property, for example to express that a resource [[teaches]] or [[assesses]] a competency.
+    """
+
+    alignmentType: Optional[Union[str, List[str]]] = None
+    targetUrl: Optional[Union[HttpUrl, List[HttpUrl]]] = None
+    targetDescription: Optional[Union[str, List[str]]] = None
+    educationalFramework: Optional[Union[str, List[str]]] = None
+    targetName: Optional[Union[str, List[str]]] = None

schema_models/allocate_action.py

@@ -0,0 +1,7 @@
+from schema_models.organize_action import OrganizeAction
+
+
+class AllocateAction(OrganizeAction):
+    """
+    The act of organizing tasks/objects/events by associating resources to it.
+    """

schema_models/am_radio_channel.py

@@ -0,0 +1,7 @@
+from schema_models.radio_channel import RadioChannel
+
+
+class AMRadioChannel(RadioChannel):
+    """
+    A radio channel that uses AM.
+    """

schema_models/amp_story.py

@@ -0,0 +1,7 @@
+from schema_models.media_object import MediaObject
+
+
+class AmpStory(MediaObject):
+    """
+    A creative work with a visual storytelling format intended to be viewed online, particularly on mobile devices.
+    """

schema_models/amusement_park.py

@@ -0,0 +1,7 @@
+from schema_models.entertainment_business import EntertainmentBusiness
+
+
+class AmusementPark(EntertainmentBusiness):
+    """
+    An amusement park.
+    """

schema_models/analysis_news_article.py

@@ -0,0 +1,7 @@
+from schema_models.news_article import NewsArticle
+
+
+class AnalysisNewsArticle(NewsArticle):
+    """
+    An AnalysisNewsArticle is a [[NewsArticle]] that, while based on factual reporting, incorporates the expertise of the author/producer, offering interpretations and conclusions.
+    """

schema_models/anatomical_structure.py

@@ -0,0 +1,24 @@
+from typing import List, Optional, Union
+
+from schema_models.anatomical_system import AnatomicalSystem
+from schema_models.medical_condition import MedicalCondition
+from schema_models.medical_entity import MedicalEntity
+
+
+class AnatomicalStructure(MedicalEntity):
+    """
+    Any part of the human body, typically a component of an anatomical system. Organs, tissues, and cells are all anatomical structures.
+    """
+
+    partOfSystem: Optional[Union[AnatomicalSystem, List[AnatomicalSystem]]] = None
+    relatedCondition: Optional[Union[MedicalCondition, List[MedicalCondition]]] = None
+    bodyLocation: Optional[Union[str, List[str]]] = None
+    relatedTherapy: Optional[Union["MedicalTherapy", List["MedicalTherapy"]]] = None
+    associatedPathophysiology: Optional[Union[str, List[str]]] = None
+    subStructure: Optional[
+        Union["AnatomicalStructure", List["AnatomicalStructure"]]
+    ] = None
+    connectedTo: Optional[Union["AnatomicalStructure", List["AnatomicalStructure"]]] = (
+        None
+    )
+    diagram: Optional[Union["ImageObject", List["ImageObject"]]] = None

schema_models/anatomical_system.py

@@ -0,0 +1,26 @@
+from typing import List, Optional, Union
+
+from schema_models.medical_entity import MedicalEntity
+
+
+class AnatomicalSystem(MedicalEntity):
+    """
+    An anatomical system is a group of anatomical structures that work together to perform a certain task. Anatomical systems, such as organ systems, are one organizing principle of anatomy, and can include circulatory, digestive, endocrine, integumentary, immune, lymphatic, muscular, nervous, reproductive, respiratory, skeletal, urinary, vestibular, and other systems.
+    """
+
+    relatedCondition: Optional[Union["MedicalCondition", List["MedicalCondition"]]] = (
+        None
+    )
+    relatedStructure: Optional[
+        Union["AnatomicalStructure", List["AnatomicalStructure"]]
+    ] = None
+    relatedTherapy: Optional[Union["MedicalTherapy", List["MedicalTherapy"]]] = None
+    associatedPathophysiology: Optional[Union[str, List[str]]] = None
+    comprisedOf: Optional[
+        Union[
+            "AnatomicalStructure",
+            List["AnatomicalStructure"],
+            "AnatomicalSystem",
+            List["AnatomicalSystem"],
+        ]
+    ] = None

schema_models/animal_shelter.py

@@ -0,0 +1,7 @@
+from schema_models.local_business import LocalBusiness
+
+
+class AnimalShelter(LocalBusiness):
+    """
+    Animal shelter.
+    """

schema_models/answer.py

@@ -0,0 +1,18 @@
+from typing import List, Optional, Union
+
+from schema_models.comment import Comment
+from schema_models.creative_work import CreativeWork
+from schema_models.web_content import WebContent
+
+
+class Answer(Comment):
+    """
+    An answer offered to a question; perhaps correct, perhaps opinionated or wrong.
+    """
+
+    answerExplanation: Optional[
+        Union[Comment, List[Comment], WebContent, List[WebContent]]
+    ] = None
+    parentItem: Optional[
+        Union[CreativeWork, List[CreativeWork], Comment, List[Comment]]
+    ] = None

schema_models/apartment.py

@@ -0,0 +1,15 @@
+from typing import List, Optional, Union
+
+from schema_models.accommodation import Accommodation
+from schema_models.quantitative_value import QuantitativeValue
+
+
+class Apartment(Accommodation):
+    """
+    An apartment (in American English) or flat (in British English) is a self-contained housing unit (a type of residential real estate) that occupies only part of a building (source: Wikipedia, the free encyclopedia, see <a href="http://en.wikipedia.org/wiki/Apartment">http://en.wikipedia.org/wiki/Apartment</a>).
+    """
+
+    numberOfRooms: Optional[
+        Union[QuantitativeValue, List[QuantitativeValue], float, List[float]]
+    ] = None
+    occupancy: Optional[Union[QuantitativeValue, List[QuantitativeValue]]] = None

schema_models/apartment_complex.py

@@ -0,0 +1,24 @@
+from typing import List, Optional, Union
+
+from pydantic import HttpUrl
+
+from schema_models.quantitative_value import QuantitativeValue
+from schema_models.residence import Residence
+
+
+class ApartmentComplex(Residence):
+    """
+    Residence type: Apartment complex.
+    """
+
+    numberOfAvailableAccommodationUnits: Optional[
+        Union[QuantitativeValue, List[QuantitativeValue]]
+    ] = None
+    numberOfAccommodationUnits: Optional[
+        Union[QuantitativeValue, List[QuantitativeValue]]
+    ] = None
+    numberOfBedrooms: Optional[
+        Union[float, List[float], QuantitativeValue, List[QuantitativeValue]]
+    ] = None
+    petsAllowed: Optional[Union[str, List[str], bool, List[bool]]] = None
+    tourBookingPage: Optional[Union[HttpUrl, List[HttpUrl]]] = None

schema_models/api_reference.py

@@ -0,0 +1,15 @@
+from typing import List, Optional, Union
+
+from schema_models.tech_article import TechArticle
+
+
+class APIReference(TechArticle):
+    """
+    Reference documentation for application programming interfaces (APIs).
+    """
+
+    executableLibraryName: Optional[Union[str, List[str]]] = None
+    targetPlatform: Optional[Union[str, List[str]]] = None
+    programmingModel: Optional[Union[str, List[str]]] = None
+    assemblyVersion: Optional[Union[str, List[str]]] = None
+    assembly: Optional[Union[str, List[str]]] = None

schema_models/append_action.py

@@ -0,0 +1,7 @@
+from schema_models.insert_action import InsertAction
+
+
+class AppendAction(InsertAction):
+    """
+    The act of inserting at the end if an ordered collection.
+    """

schema_models/apply_action.py

@@ -0,0 +1,11 @@
+from schema_models.organize_action import OrganizeAction
+
+
+class ApplyAction(OrganizeAction):
+    """
+    The act of registering to an organization/service without the guarantee to receive it.
+
+    Related actions:
+
+    * [[RegisterAction]]: Unlike RegisterAction, ApplyAction has no guarantees that the application will be accepted.
+    """

schema_models/approved_indication.py

@@ -0,0 +1,7 @@
+from schema_models.medical_indication import MedicalIndication
+
+
+class ApprovedIndication(MedicalIndication):
+    """
+    An indication for a medical therapy that has been formally specified or approved by a regulatory body that regulates use of the therapy; for example, the US FDA approves indications for most drugs in the US.
+    """

schema_models/aquarium.py

@@ -0,0 +1,7 @@
+from schema_models.civic_structure import CivicStructure
+
+
+class Aquarium(CivicStructure):
+    """
+    Aquarium.
+    """

schema_models/archive_component.py

@@ -0,0 +1,19 @@
+from typing import List, Optional, Union
+
+from schema_models.creative_work import CreativeWork
+from schema_models.place import Place
+
+
+class ArchiveComponent(CreativeWork):
+    """
+    An intangible type to be applied to any archive content, carrying with it a set of properties required to describe archival items and collections.
+    """
+
+    itemLocation: Optional[
+        Union[
+            str, List[str], Place, List[Place], "PostalAddress", List["PostalAddress"]
+        ]
+    ] = None
+    holdingArchive: Optional[
+        Union["ArchiveOrganization", List["ArchiveOrganization"]]
+    ] = None

schema_models/archive_organization.py

@@ -0,0 +1,12 @@
+from typing import List, Optional, Union
+
+from schema_models.archive_component import ArchiveComponent
+from schema_models.local_business import LocalBusiness
+
+
+class ArchiveOrganization(LocalBusiness):
+    """
+    An organization with archival holdings. An organization which keeps and preserves archival material and typically makes it accessible to the public.
+    """
+
+    archiveHeld: Optional[Union[ArchiveComponent, List[ArchiveComponent]]] = None

schema_models/arrive_action.py

@@ -0,0 +1,7 @@
+from schema_models.move_action import MoveAction
+
+
+class ArriveAction(MoveAction):
+    """
+    The act of arriving at a place. An agent arrives at a destination from a fromLocation, optionally with participants.
+    """

schema_models/art_gallery.py

@@ -0,0 +1,7 @@
+from schema_models.entertainment_business import EntertainmentBusiness
+
+
+class ArtGallery(EntertainmentBusiness):
+    """
+    An art gallery.
+    """

schema_models/artery.py

@@ -0,0 +1,15 @@
+from typing import List, Optional, Union
+
+from schema_models.anatomical_structure import AnatomicalStructure
+from schema_models.vessel import Vessel
+
+
+class Artery(Vessel):
+    """
+    A type of blood vessel that specifically carries blood away from the heart.
+    """
+
+    arterialBranch: Optional[Union[AnatomicalStructure, List[AnatomicalStructure]]] = (
+        None
+    )
+    supplyTo: Optional[Union[AnatomicalStructure, List[AnatomicalStructure]]] = None