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

schema_models/quantitative_value.py

@@ -0,0 +1,54 @@
+from typing import List, Optional, Union
+
+from pydantic import HttpUrl
+
+from schema_models.defined_term import DefinedTerm
+from schema_models.enumeration import Enumeration
+from schema_models.measurement_type_enumeration import MeasurementTypeEnumeration
+from schema_models.property_value import PropertyValue
+from schema_models.qualitative_value import QualitativeValue
+from schema_models.structured_value import StructuredValue
+
+
+class QuantitativeValue(StructuredValue):
+    """
+    A point value or interval for product characteristics and other purposes.
+    """
+
+    value: Optional[
+        Union[
+            bool,
+            List[bool],
+            str,
+            List[str],
+            float,
+            List[float],
+            StructuredValue,
+            List[StructuredValue],
+        ]
+    ] = None
+    valueReference: Optional[
+        Union[
+            str,
+            List[str],
+            DefinedTerm,
+            List[DefinedTerm],
+            PropertyValue,
+            List[PropertyValue],
+            MeasurementTypeEnumeration,
+            List[MeasurementTypeEnumeration],
+            StructuredValue,
+            List[StructuredValue],
+            Enumeration,
+            List[Enumeration],
+            QualitativeValue,
+            List[QualitativeValue],
+            "QuantitativeValue",
+            List["QuantitativeValue"],
+        ]
+    ] = None
+    additionalProperty: Optional[Union[PropertyValue, List[PropertyValue]]] = None
+    unitCode: Optional[Union[str, List[str], HttpUrl, List[HttpUrl]]] = None
+    maxValue: Optional[Union[float, List[float]]] = None
+    minValue: Optional[Union[float, List[float]]] = None
+    unitText: Optional[Union[str, List[str]]] = None

schema_models/quantitative_value_distribution.py

@@ -0,0 +1,17 @@
+from typing import List, Optional, Union
+
+from schema_models.duration import Duration
+from schema_models.structured_value import StructuredValue
+
+
+class QuantitativeValueDistribution(StructuredValue):
+    """
+    A statistical distribution of values.
+    """
+
+    duration: Optional[Union[Duration, List[Duration]]] = None
+    percentile10: Optional[Union[float, List[float]]] = None
+    percentile25: Optional[Union[float, List[float]]] = None
+    percentile90: Optional[Union[float, List[float]]] = None
+    percentile75: Optional[Union[float, List[float]]] = None
+    median: Optional[Union[float, List[float]]] = None

schema_models/quantity.py

@@ -0,0 +1,7 @@
+from schema_models.intangible import Intangible
+
+
+class Quantity(Intangible):
+    """
+    Quantities such as distance, time, mass, weight, etc. Particular instances of say Mass are entities like '3 kg' or '4 milligrams'.
+    """

schema_models/question.py

@@ -0,0 +1,23 @@
+from typing import List, Optional, Union
+
+from schema_models.comment import Comment
+from schema_models.creative_work import CreativeWork
+from schema_models.item_list import ItemList
+
+
+class Question(Comment):
+    """
+    A sub property of object. A question.
+    """
+
+    acceptedAnswer: Optional[
+        Union["Answer", List["Answer"], ItemList, List[ItemList]]
+    ] = None
+    parentItem: Optional[
+        Union[CreativeWork, List[CreativeWork], Comment, List[Comment]]
+    ] = None
+    suggestedAnswer: Optional[
+        Union["Answer", List["Answer"], ItemList, List[ItemList]]
+    ] = None
+    answerCount: Optional[Union[int, List[int]]] = None
+    eduQuestionType: Optional[Union[str, List[str]]] = None

schema_models/quiz.py

@@ -0,0 +1,7 @@
+from schema_models.learning_resource import LearningResource
+
+
+class Quiz(LearningResource):
+    """
+    Quiz: A test of knowledge, skills and abilities.
+    """

schema_models/quotation.py

@@ -0,0 +1,15 @@
+from typing import List, Optional, Union
+
+from schema_models.creative_work import CreativeWork
+from schema_models.organization import Organization
+from schema_models.person import Person
+
+
+class Quotation(CreativeWork):
+    """
+    A quotation. Often but not necessarily from some written work, attributable to a real world author and - if associated with a fictional character - to any fictional Person. Use [[isBasedOn]] to link to source/origin. The [[recordedIn]] property can be used to reference a Quotation from an [[Event]].
+    """
+
+    spokenByCharacter: Optional[
+        Union[Organization, List[Organization], Person, List[Person]]
+    ] = None

schema_models/quote_action.py

@@ -0,0 +1,7 @@
+from schema_models.trade_action import TradeAction
+
+
+class QuoteAction(TradeAction):
+    """
+    An agent quotes/estimates/appraises an object/product/service with a price at a location/store.
+    """

schema_models/radiation_therapy.py

@@ -0,0 +1,7 @@
+from schema_models.medical_therapy import MedicalTherapy
+
+
+class RadiationTherapy(MedicalTherapy):
+    """
+    A process of care using radiation aimed at improving a health condition.
+    """

schema_models/radio_broadcast_service.py

@@ -0,0 +1,7 @@
+from schema_models.broadcast_service import BroadcastService
+
+
+class RadioBroadcastService(BroadcastService):
+    """
+    A delivery service through which radio content is provided via broadcast over the air or online.
+    """

schema_models/radio_channel.py

@@ -0,0 +1,7 @@
+from schema_models.broadcast_channel import BroadcastChannel
+
+
+class RadioChannel(BroadcastChannel):
+    """
+    A unique instance of a radio BroadcastService on a CableOrSatelliteService lineup.
+    """

schema_models/radio_clip.py

@@ -0,0 +1,7 @@
+from schema_models.clip import Clip
+
+
+class RadioClip(Clip):
+    """
+    A short radio program or a segment/part of a radio program.
+    """

schema_models/radio_episode.py

@@ -0,0 +1,7 @@
+from schema_models.episode import Episode
+
+
+class RadioEpisode(Episode):
+    """
+    A radio episode which can be part of a series or season.
+    """

schema_models/radio_season.py

@@ -0,0 +1,7 @@
+from schema_models.creative_work_season import CreativeWorkSeason
+
+
+class RadioSeason(CreativeWorkSeason):
+    """
+    Season dedicated to radio broadcast and associated online delivery.
+    """

schema_models/radio_series.py

@@ -0,0 +1,37 @@
+from typing import List, Optional, Union
+
+from pydantic import HttpUrl
+
+from schema_models.creative_work_season import CreativeWorkSeason
+from schema_models.creative_work_series import CreativeWorkSeries
+from schema_models.episode import Episode
+from schema_models.music_group import MusicGroup
+from schema_models.organization import Organization
+from schema_models.performing_group import PerformingGroup
+from schema_models.person import Person
+from schema_models.video_object import VideoObject
+
+
+class RadioSeries(CreativeWorkSeries):
+    """
+    CreativeWorkSeries dedicated to radio broadcast and associated online delivery.
+    """
+
+    numberOfSeasons: Optional[Union[int, List[int]]] = None
+    trailer: Optional[Union[VideoObject, List[VideoObject]]] = None
+    numberOfEpisodes: Optional[Union[int, List[int]]] = None
+    seasons: Optional[Union[CreativeWorkSeason, List[CreativeWorkSeason]]] = None
+    productionCompany: Optional[Union[Organization, List[Organization]]] = None
+    director: Optional[Union[Person, List[Person]]] = None
+    actors: Optional[Union[Person, List[Person]]] = None
+    episode: Optional[Union[Episode, List[Episode]]] = None
+    season: Optional[
+        Union[HttpUrl, List[HttpUrl], CreativeWorkSeason, List[CreativeWorkSeason]]
+    ] = None
+    actor: Optional[
+        Union[Person, List[Person], PerformingGroup, List[PerformingGroup]]
+    ] = None
+    directors: Optional[Union[Person, List[Person]]] = None
+    episodes: Optional[Union[Episode, List[Episode]]] = None
+    musicBy: Optional[Union[Person, List[Person], MusicGroup, List[MusicGroup]]] = None
+    containsSeason: Optional[Union[CreativeWorkSeason, List[CreativeWorkSeason]]] = None

schema_models/radio_station.py

@@ -0,0 +1,7 @@
+from schema_models.local_business import LocalBusiness
+
+
+class RadioStation(LocalBusiness):
+    """
+    A radio station.
+    """

schema_models/rating.py

@@ -0,0 +1,20 @@
+from typing import List, Optional, Union
+
+from schema_models.intangible import Intangible
+from schema_models.organization import Organization
+from schema_models.person import Person
+
+
+class Rating(Intangible):
+    """
+    A rating is an evaluation on a numeric scale, such as 1 to 5 stars.
+    """
+
+    reviewAspect: Optional[Union[str, List[str]]] = None
+    worstRating: Optional[Union[float, List[float], str, List[str]]] = None
+    author: Optional[Union[Person, List[Person], Organization, List[Organization]]] = (
+        None
+    )
+    ratingExplanation: Optional[Union[str, List[str]]] = None
+    ratingValue: Optional[Union[float, List[float], str, List[str]]] = None
+    bestRating: Optional[Union[float, List[float], str, List[str]]] = None

schema_models/react_action.py

@@ -0,0 +1,7 @@
+from schema_models.assess_action import AssessAction
+
+
+class ReactAction(AssessAction):
+    """
+    The act of responding instinctively and emotionally to an object, expressing a sentiment.
+    """

schema_models/read_action.py

@@ -0,0 +1,7 @@
+from schema_models.consume_action import ConsumeAction
+
+
+class ReadAction(ConsumeAction):
+    """
+    The act of consuming written content.
+    """

schema_models/real_estate_agent.py

@@ -0,0 +1,7 @@
+from schema_models.local_business import LocalBusiness
+
+
+class RealEstateAgent(LocalBusiness):
+    """
+    A sub property of participant. The real estate agent involved in the action.
+    """

schema_models/real_estate_listing.py

@@ -0,0 +1,19 @@
+from datetime import date, datetime
+from typing import List, Optional, Union
+
+from schema_models.duration import Duration
+from schema_models.quantitative_value import QuantitativeValue
+from schema_models.web_page import WebPage
+
+
+class RealEstateListing(WebPage):
+    """
+    A [[RealEstateListing]] is a listing that describes one or more real-estate [[Offer]]s (whose [[businessFunction]] is typically to lease out, or to sell).
+      The [[RealEstateListing]] type itself represents the overall listing, as manifested in some [[WebPage]].
+
+    """
+
+    datePosted: Optional[Union[datetime, List[datetime], date, List[date]]] = None
+    leaseLength: Optional[
+        Union[QuantitativeValue, List[QuantitativeValue], Duration, List[Duration]]
+    ] = None

schema_models/receive_action.py

@@ -0,0 +1,30 @@
+from typing import List, Optional, Union
+
+from schema_models.audience import Audience
+from schema_models.delivery_method import DeliveryMethod
+from schema_models.organization import Organization
+from schema_models.person import Person
+from schema_models.transfer_action import TransferAction
+
+
+class ReceiveAction(TransferAction):
+    """
+    The act of physically/electronically taking delivery of an object that has been transferred from an origin to a destination. Reciprocal of SendAction.
+
+    Related actions:
+
+    * [[SendAction]]: The reciprocal of ReceiveAction.
+    * [[TakeAction]]: Unlike TakeAction, ReceiveAction does not imply that the ownership has been transferred (e.g. I can receive a package, but it does not mean the package is now mine).
+    """
+
+    sender: Optional[
+        Union[
+            Organization,
+            List[Organization],
+            Audience,
+            List[Audience],
+            Person,
+            List[Person],
+        ]
+    ] = None
+    deliveryMethod: Optional[Union[DeliveryMethod, List[DeliveryMethod]]] = None

schema_models/recipe.py

@@ -0,0 +1,32 @@
+from typing import List, Optional, Union
+
+from schema_models.creative_work import CreativeWork
+from schema_models.duration import Duration
+from schema_models.how_to import HowTo
+from schema_models.item_list import ItemList
+from schema_models.nutrition_information import NutritionInformation
+from schema_models.quantitative_value import QuantitativeValue
+from schema_models.restricted_diet import RestrictedDiet
+
+
+class Recipe(HowTo):
+    """
+    A sub property of instrument. The recipe/instructions used to perform the action.
+    """
+
+    recipeYield: Optional[
+        Union[QuantitativeValue, List[QuantitativeValue], str, List[str]]
+    ] = None
+    recipeCuisine: Optional[Union[str, List[str]]] = None
+    recipeCategory: Optional[Union[str, List[str]]] = None
+    suitableForDiet: Optional[Union[RestrictedDiet, List[RestrictedDiet]]] = None
+    recipeInstructions: Optional[
+        Union[
+            CreativeWork, List[CreativeWork], str, List[str], ItemList, List[ItemList]
+        ]
+    ] = None
+    cookTime: Optional[Union[Duration, List[Duration]]] = None
+    ingredients: Optional[Union[str, List[str]]] = None
+    recipeIngredient: Optional[Union[str, List[str]]] = None
+    cookingMethod: Optional[Union[str, List[str]]] = None
+    nutrition: Optional[Union[NutritionInformation, List[NutritionInformation]]] = None

schema_models/recommendation.py

@@ -0,0 +1,29 @@
+from typing import List, Optional, Union
+
+from pydantic import HttpUrl
+
+from schema_models.category_code import CategoryCode
+from schema_models.physical_activity_category import PhysicalActivityCategory
+from schema_models.review import Review
+from schema_models.thing import Thing
+
+
+class Recommendation(Review):
+    """
+    [[Recommendation]] is a type of [[Review]] that suggests or proposes something as the best option or best course of action. Recommendations may be for products or services, or other concrete things, as in the case of a ranked list or product guide. A [[Guide]] may list multiple recommendations for different categories. For example, in a [[Guide]] about which TVs to buy, the author may have several [[Recommendation]]s.
+    """
+
+    category: Optional[
+        Union[
+            Thing,
+            List[Thing],
+            PhysicalActivityCategory,
+            List[PhysicalActivityCategory],
+            CategoryCode,
+            List[CategoryCode],
+            str,
+            List[str],
+            HttpUrl,
+            List[HttpUrl],
+        ]
+    ] = None

schema_models/recommended_dose_schedule.py

@@ -0,0 +1,7 @@
+from schema_models.dose_schedule import DoseSchedule
+
+
+class RecommendedDoseSchedule(DoseSchedule):
+    """
+    A recommended dosing schedule for a drug or supplement as prescribed or recommended by an authority or by the drug/supplement's manufacturer. Capture the recommending authority in the recognizingAuthority property of MedicalEntity.
+    """

schema_models/recycling_center.py

@@ -0,0 +1,7 @@
+from schema_models.local_business import LocalBusiness
+
+
+class RecyclingCenter(LocalBusiness):
+    """
+    A recycling center.
+    """

schema_models/refund_type_enumeration.py

@@ -0,0 +1,7 @@
+from schema_models.enumeration import Enumeration
+
+
+class RefundTypeEnumeration(Enumeration):
+    """
+    Enumerates several kinds of product return refund types.
+    """

schema_models/register_action.py

@@ -0,0 +1,13 @@
+from schema_models.interact_action import InteractAction
+
+
+class RegisterAction(InteractAction):
+    """
+    The act of registering to be a user of a service, product or web page.
+
+    Related actions:
+
+    * [[JoinAction]]: Unlike JoinAction, RegisterAction implies you are registering to be a user of a service, *not* a group/team of people.
+    * [[FollowAction]]: Unlike FollowAction, RegisterAction doesn't imply that the agent is expecting to poll for updates from the object.
+    * [[SubscribeAction]]: Unlike SubscribeAction, RegisterAction doesn't imply that the agent is expecting updates from the object.
+    """

schema_models/reject_action.py

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

schema_models/rent_action.py

@@ -0,0 +1,16 @@
+from typing import List, Optional, Union
+
+from schema_models.organization import Organization
+from schema_models.person import Person
+from schema_models.trade_action import TradeAction
+
+
+class RentAction(TradeAction):
+    """
+    The act of giving money in return for temporary use, but not ownership, of an object such as a vehicle or property. For example, an agent rents a property from a landlord in exchange for a periodic payment.
+    """
+
+    realEstateAgent: Optional[Union["RealEstateAgent", List["RealEstateAgent"]]] = None
+    landlord: Optional[
+        Union[Person, List[Person], Organization, List[Organization]]
+    ] = None

schema_models/rental_car_reservation.py

@@ -0,0 +1,18 @@
+from datetime import datetime
+from typing import List, Optional, Union
+
+from schema_models.place import Place
+from schema_models.reservation import Reservation
+
+
+class RentalCarReservation(Reservation):
+    """
+    A reservation for a rental car.
+
+    Note: This type is for information about actual reservations, e.g. in confirmation emails or HTML pages with individual confirmations of reservations.
+    """
+
+    pickupTime: Optional[Union[datetime, List[datetime]]] = None
+    dropoffTime: Optional[Union[datetime, List[datetime]]] = None
+    dropoffLocation: Optional[Union[Place, List[Place]]] = None
+    pickupLocation: Optional[Union[Place, List[Place]]] = None

schema_models/repayment_specification.py

@@ -0,0 +1,18 @@
+from typing import List, Optional, Union
+
+from schema_models.monetary_amount import MonetaryAmount
+from schema_models.structured_value import StructuredValue
+
+
+class RepaymentSpecification(StructuredValue):
+    """
+    A structured value representing repayment.
+    """
+
+    loanPaymentAmount: Optional[Union[MonetaryAmount, List[MonetaryAmount]]] = None
+    loanPaymentFrequency: Optional[Union[float, List[float]]] = None
+    numberOfLoanPayments: Optional[Union[float, List[float]]] = None
+    downPayment: Optional[
+        Union[MonetaryAmount, List[MonetaryAmount], float, List[float]]
+    ] = None
+    earlyPrepaymentPenalty: Optional[Union[MonetaryAmount, List[MonetaryAmount]]] = None

schema_models/replace_action.py

@@ -0,0 +1,13 @@
+from typing import List, Optional, Union
+
+from schema_models.thing import Thing
+from schema_models.update_action import UpdateAction
+
+
+class ReplaceAction(UpdateAction):
+    """
+    The act of editing a recipient by replacing an old object with a new object.
+    """
+
+    replacee: Optional[Union[Thing, List[Thing]]] = None
+    replacer: Optional[Union[Thing, List[Thing]]] = None

schema_models/reply_action.py

@@ -0,0 +1,16 @@
+from typing import List, Optional, Union
+
+from schema_models.comment import Comment
+from schema_models.communicate_action import CommunicateAction
+
+
+class ReplyAction(CommunicateAction):
+    """
+    The act of responding to a question/message asked/sent by the object. Related to [[AskAction]].
+
+    Related actions:
+
+    * [[AskAction]]: Appears generally as an origin of a ReplyAction.
+    """
+
+    resultComment: Optional[Union[Comment, List[Comment]]] = None

schema_models/report.py

@@ -0,0 +1,11 @@
+from typing import List, Optional, Union
+
+from schema_models.article import Article
+
+
+class Report(Article):
+    """
+    A Report generated by governmental or non-governmental organization.
+    """
+
+    reportNumber: Optional[Union[str, List[str]]] = None

schema_models/reportage_news_article.py

@@ -0,0 +1,15 @@
+from schema_models.news_article import NewsArticle
+
+
+class ReportageNewsArticle(NewsArticle):
+    """
+    The [[ReportageNewsArticle]] type is a subtype of [[NewsArticle]] representing
+     news articles which are the result of journalistic news reporting conventions.
+
+    In practice many news publishers produce a wide variety of article types, many of which might be considered a [[NewsArticle]] but not a [[ReportageNewsArticle]]. For example, opinion pieces, reviews, analysis, sponsored or satirical articles, or articles that combine several of these elements.
+
+    The [[ReportageNewsArticle]] type is based on a stricter ideal for "news" as a work of journalism, with articles based on factual information either observed or verified by the author, or reported and verified from knowledgeable sources.  This often includes perspectives from multiple viewpoints on a particular issue (distinguishing news reports from public relations or propaganda).  News reports in the [[ReportageNewsArticle]] sense de-emphasize the opinion of the author, with commentary and value judgements typically expressed elsewhere.
+
+    A [[ReportageNewsArticle]] which goes deeper into analysis can also be marked with an additional type of [[AnalysisNewsArticle]].
+
+    """

schema_models/reported_dose_schedule.py

@@ -0,0 +1,7 @@
+from schema_models.dose_schedule import DoseSchedule
+
+
+class ReportedDoseSchedule(DoseSchedule):
+    """
+    A patient-reported or observed dosing schedule for a drug or supplement.
+    """

schema_models/research_organization.py

@@ -0,0 +1,7 @@
+from schema_models.organization import Organization
+
+
+class ResearchOrganization(Organization):
+    """
+    A Research Organization (e.g. scientific institute, research company).
+    """

schema_models/research_project.py

@@ -0,0 +1,7 @@
+from schema_models.project import Project
+
+
+class ResearchProject(Project):
+    """
+    A Research project.
+    """

schema_models/researcher.py

@@ -0,0 +1,7 @@
+from schema_models.audience import Audience
+
+
+class Researcher(Audience):
+    """
+    Researchers.
+    """