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

schema_models/reservation.py

@@ -0,0 +1,50 @@
+from datetime import datetime
+from typing import List, Optional, Union
+
+from schema_models.intangible import Intangible
+from schema_models.organization import Organization
+from schema_models.person import Person
+from schema_models.thing import Thing
+
+
+class Reservation(Intangible):
+    """
+    Describes a reservation for travel, dining or an event. Some reservations require tickets.
+
+    Note: This type is for information about actual reservations, e.g. in confirmation emails or HTML pages with individual confirmations of reservations. For offers of tickets, restaurant reservations, flights, or rental cars, use [[Offer]].
+    """
+
+    totalPrice: Optional[
+        Union[
+            str,
+            List[str],
+            "PriceSpecification",
+            List["PriceSpecification"],
+            float,
+            List[float],
+        ]
+    ] = None
+    underName: Optional[
+        Union[Person, List[Person], Organization, List[Organization]]
+    ] = None
+    programMembershipUsed: Optional[
+        Union["ProgramMembership", List["ProgramMembership"]]
+    ] = None
+    bookingTime: Optional[Union[datetime, List[datetime]]] = None
+    reservationFor: Optional[Union[Thing, List[Thing]]] = None
+    broker: Optional[Union[Organization, List[Organization], Person, List[Person]]] = (
+        None
+    )
+    reservedTicket: Optional[Union["Ticket", List["Ticket"]]] = None
+    reservationStatus: Optional[
+        Union["ReservationStatusType", List["ReservationStatusType"]]
+    ] = None
+    reservationId: Optional[Union[str, List[str]]] = None
+    modifiedTime: Optional[Union[datetime, List[datetime]]] = None
+    priceCurrency: Optional[Union[str, List[str]]] = None
+    provider: Optional[
+        Union[Person, List[Person], Organization, List[Organization]]
+    ] = None
+    bookingAgent: Optional[
+        Union[Person, List[Person], Organization, List[Organization]]
+    ] = None

schema_models/reservation_package.py

@@ -0,0 +1,11 @@
+from typing import List, Optional, Union
+
+from schema_models.reservation import Reservation
+
+
+class ReservationPackage(Reservation):
+    """
+    A group of multiple reservations with common values for all sub-reservations.
+    """
+
+    subReservation: Optional[Union[Reservation, List[Reservation]]] = None

schema_models/reservation_status_type.py

@@ -0,0 +1,7 @@
+from schema_models.status_enumeration import StatusEnumeration
+
+
+class ReservationStatusType(StatusEnumeration):
+    """
+    Enumerated status values for Reservation.
+    """

schema_models/reserve_action.py

@@ -0,0 +1,11 @@
+from schema_models.plan_action import PlanAction
+
+
+class ReserveAction(PlanAction):
+    """
+    Reserving a concrete object.
+
+    Related actions:
+
+    * [[ScheduleAction]]: Unlike ScheduleAction, ReserveAction reserves concrete objects (e.g. a table, a hotel) towards a time slot / spatial allocation.
+    """

schema_models/reservoir.py

@@ -0,0 +1,7 @@
+from schema_models.body_of_water import BodyOfWater
+
+
+class Reservoir(BodyOfWater):
+    """
+    A reservoir of water, typically an artificially created lake, like the Lake Kariba reservoir.
+    """

schema_models/residence.py

@@ -0,0 +1,12 @@
+from typing import List, Optional, Union
+
+from schema_models.floor_plan import FloorPlan
+from schema_models.place import Place
+
+
+class Residence(Place):
+    """
+    The place where a person lives.
+    """
+
+    accommodationFloorPlan: Optional[Union[FloorPlan, List[FloorPlan]]] = None

schema_models/resort.py

@@ -0,0 +1,10 @@
+from schema_models.lodging_business import LodgingBusiness
+
+
+class Resort(LodgingBusiness):
+    """
+    A resort is a place used for relaxation or recreation, attracting visitors for holidays or vacations. Resorts are places, towns or sometimes commercial establishments operated by a single company (source: Wikipedia, the free encyclopedia, see <a href="http://en.wikipedia.org/wiki/Resort">http://en.wikipedia.org/wiki/Resort</a>).
+    <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/restaurant.py

@@ -0,0 +1,7 @@
+from schema_models.food_establishment import FoodEstablishment
+
+
+class Restaurant(FoodEstablishment):
+    """
+    A restaurant.
+    """

schema_models/restricted_diet.py

@@ -0,0 +1,7 @@
+from schema_models.enumeration import Enumeration
+
+
+class RestrictedDiet(Enumeration):
+    """
+    A diet restricted to certain foods or preparations for cultural, religious, health or lifestyle reasons.
+    """

schema_models/resume_action.py

@@ -0,0 +1,7 @@
+from schema_models.control_action import ControlAction
+
+
+class ResumeAction(ControlAction):
+    """
+    The act of resuming a device or application which was formerly paused (e.g. resume music playback or resume a timer).
+    """

schema_models/return_action.py

@@ -0,0 +1,26 @@
+from typing import List, Optional, Union
+
+from schema_models.audience import Audience
+from schema_models.contact_point import ContactPoint
+from schema_models.organization import Organization
+from schema_models.person import Person
+from schema_models.transfer_action import TransferAction
+
+
+class ReturnAction(TransferAction):
+    """
+    The act of returning to the origin that which was previously received (concrete objects) or taken (ownership).
+    """
+
+    recipient: Optional[
+        Union[
+            Audience,
+            List[Audience],
+            ContactPoint,
+            List[ContactPoint],
+            Person,
+            List[Person],
+            Organization,
+            List[Organization],
+        ]
+    ] = None

schema_models/return_fees_enumeration.py

@@ -0,0 +1,7 @@
+from schema_models.enumeration import Enumeration
+
+
+class ReturnFeesEnumeration(Enumeration):
+    """
+    Enumerates several kinds of policies for product return fees.
+    """

schema_models/return_label_source_enumeration.py

@@ -0,0 +1,7 @@
+from schema_models.enumeration import Enumeration
+
+
+class ReturnLabelSourceEnumeration(Enumeration):
+    """
+    Enumerates several types of return labels for product returns.
+    """

schema_models/return_method_enumeration.py

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

schema_models/review.py

@@ -0,0 +1,46 @@
+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
+from schema_models.rating import Rating
+from schema_models.thing import Thing
+from schema_models.web_content import WebContent
+
+
+class Review(CreativeWork):
+    """
+    A review of an item - for example, of a restaurant, movie, or store.
+    """
+
+    reviewRating: Optional[Union[Rating, List[Rating]]] = None
+    itemReviewed: Optional[Union[Thing, List[Thing]]] = None
+    negativeNotes: Optional[
+        Union[
+            WebContent,
+            List[WebContent],
+            ItemList,
+            List[ItemList],
+            ListItem,
+            List[ListItem],
+            str,
+            List[str],
+        ]
+    ] = None
+    associatedReview: Optional[Union["Review", List["Review"]]] = None
+    reviewAspect: Optional[Union[str, List[str]]] = None
+    reviewBody: Optional[Union[str, List[str]]] = None
+    associatedClaimReview: Optional[Union["Review", List["Review"]]] = None
+    associatedMediaReview: Optional[Union["Review", List["Review"]]] = None
+    positiveNotes: Optional[
+        Union[
+            ItemList,
+            List[ItemList],
+            WebContent,
+            List[WebContent],
+            ListItem,
+            List[ListItem],
+            str,
+            List[str],
+        ]
+    ] = None

schema_models/review_action.py

@@ -0,0 +1,12 @@
+from typing import List, Optional, Union
+
+from schema_models.assess_action import AssessAction
+from schema_models.review import Review
+
+
+class ReviewAction(AssessAction):
+    """
+    The act of producing a balanced opinion about the object for an audience. An agent reviews an object with participants resulting in a review.
+    """
+
+    resultReview: Optional[Union[Review, List[Review]]] = None

schema_models/review_news_article.py

@@ -0,0 +1,7 @@
+from schema_models.news_article import NewsArticle
+
+
+class ReviewNewsArticle(NewsArticle):
+    """
+    A [[NewsArticle]] and [[CriticReview]] providing a professional critic's assessment of a service, product, performance, or artistic or literary work.
+    """

schema_models/river_body_of_water.py

@@ -0,0 +1,7 @@
+from schema_models.body_of_water import BodyOfWater
+
+
+class RiverBodyOfWater(BodyOfWater):
+    """
+    A river (for example, the broad majestic Shannon).
+    """

schema_models/role.py

@@ -0,0 +1,19 @@
+from datetime import date, datetime
+from typing import List, Optional, Union
+
+from pydantic import HttpUrl
+
+from schema_models.intangible import Intangible
+
+
+class Role(Intangible):
+    """
+    Represents additional information about a relationship or property. For example a Role can be used to say that a 'member' role linking some SportsTeam to a player occurred during a particular time period. Or that a Person's 'actor' role in a Movie was for some particular characterName. Such properties can be attached to a Role entity, which is then associated with the main entities using ordinary properties like 'member' or 'actor'.
+
+    See also [blog post](http://blog.schema.org/2014/06/introducing-role.html).
+    """
+
+    roleName: Optional[Union[str, List[str], HttpUrl, List[HttpUrl]]] = None
+    startDate: Optional[Union[datetime, List[datetime], date, List[date]]] = None
+    endDate: Optional[Union[date, List[date], datetime, List[datetime]]] = None
+    namedPosition: Optional[Union[str, List[str], HttpUrl, List[HttpUrl]]] = None

schema_models/roofing_contractor.py

@@ -0,0 +1,7 @@
+from schema_models.home_and_construction_business import HomeAndConstructionBusiness
+
+
+class RoofingContractor(HomeAndConstructionBusiness):
+    """
+    A roofing contractor.
+    """

schema_models/room.py

@@ -0,0 +1,10 @@
+from schema_models.accommodation import Accommodation
+
+
+class Room(Accommodation):
+    """
+    A room is a distinguishable space within a structure, usually separated from other spaces by interior walls (source: Wikipedia, the free encyclopedia, see <a href="http://en.wikipedia.org/wiki/Room">http://en.wikipedia.org/wiki/Room</a>).
+    <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/rsvp_action.py

@@ -0,0 +1,15 @@
+from typing import List, Optional, Union
+
+from schema_models.comment import Comment
+from schema_models.inform_action import InformAction
+from schema_models.rsvp_response_type import RsvpResponseType
+
+
+class RsvpAction(InformAction):
+    """
+    The act of notifying an event organizer as to whether you expect to attend the event.
+    """
+
+    rsvpResponse: Optional[Union[RsvpResponseType, List[RsvpResponseType]]] = None
+    additionalNumberOfGuests: Optional[Union[float, List[float]]] = None
+    comment: Optional[Union[Comment, List[Comment]]] = None

schema_models/rsvp_response_type.py

@@ -0,0 +1,7 @@
+from schema_models.enumeration import Enumeration
+
+
+class RsvpResponseType(Enumeration):
+    """
+    RsvpResponseType is an enumeration type whose instances represent responding to an RSVP request.
+    """

schema_models/rv_park.py

@@ -0,0 +1,7 @@
+from schema_models.civic_structure import CivicStructure
+
+
+class RVPark(CivicStructure):
+    """
+    A place offering space for "Recreational Vehicles", Caravans, mobile homes and the like.
+    """

schema_models/sale_event.py

@@ -0,0 +1,7 @@
+from schema_models.event import Event
+
+
+class SaleEvent(Event):
+    """
+    Event type: Sales event.
+    """

schema_models/satirical_article.py

@@ -0,0 +1,7 @@
+from schema_models.article import Article
+
+
+class SatiricalArticle(Article):
+    """
+    An [[Article]] whose content is primarily [[satirical]](https://en.wikipedia.org/wiki/Satire) in nature, i.e. unlikely to be literally true. A satirical article is sometimes but not necessarily also a [[NewsArticle]]. [[ScholarlyArticle]]s are also sometimes satirized.
+    """

schema_models/schedule.py

@@ -0,0 +1,28 @@
+from datetime import date, datetime, time
+from typing import List, Optional, Union
+
+from schema_models.intangible import Intangible
+
+
+class Schedule(Intangible):
+    """
+    A schedule defines a repeating time period used to describe a regularly occurring [[Event]]. At a minimum a schedule will specify [[repeatFrequency]] which describes the interval between occurrences of the event. Additional information can be provided to specify the schedule more precisely.
+          This includes identifying the day(s) of the week or month when the recurring event will take place, in addition to its start and end time. Schedules may also
+          have start and end dates to indicate when they are active, e.g. to define a limited calendar of events.
+    """
+
+    startDate: Optional[Union[datetime, List[datetime], date, List[date]]] = None
+    exceptDate: Optional[Union[datetime, List[datetime], date, List[date]]] = None
+    endTime: Optional[Union[datetime, List[datetime], time, List[time]]] = None
+    repeatFrequency: Optional[Union[str, List[str], "Duration", List["Duration"]]] = (
+        None
+    )
+    byMonth: Optional[Union[int, List[int]]] = None
+    repeatCount: Optional[Union[int, List[int]]] = None
+    byMonthWeek: Optional[Union[int, List[int]]] = None
+    endDate: Optional[Union[date, List[date], datetime, List[datetime]]] = None
+    duration: Optional[Union["Duration", List["Duration"]]] = None
+    byDay: Optional[Union[str, List[str], "DayOfWeek", List["DayOfWeek"]]] = None
+    byMonthDay: Optional[Union[int, List[int]]] = None
+    scheduleTimezone: Optional[Union[str, List[str]]] = None
+    startTime: Optional[Union[datetime, List[datetime], time, List[time]]] = None

schema_models/schedule_action.py

@@ -0,0 +1,11 @@
+from schema_models.plan_action import PlanAction
+
+
+class ScheduleAction(PlanAction):
+    """
+    Scheduling future actions, events, or tasks.
+
+    Related actions:
+
+    * [[ReserveAction]]: Unlike ReserveAction, ScheduleAction allocates future actions (e.g. an event, a task, etc) towards a time slot / spatial allocation.
+    """

schema_models/scholarly_article.py

@@ -0,0 +1,7 @@
+from schema_models.article import Article
+
+
+class ScholarlyArticle(Article):
+    """
+    A scholarly article.
+    """

schema_models/school.py

@@ -0,0 +1,7 @@
+from schema_models.educational_organization import EducationalOrganization
+
+
+class School(EducationalOrganization):
+    """
+    A school.
+    """

schema_models/school_district.py

@@ -0,0 +1,7 @@
+from schema_models.administrative_area import AdministrativeArea
+
+
+class SchoolDistrict(AdministrativeArea):
+    """
+    A School District is an administrative area for the administration of schools.
+    """

schema_models/screening_event.py

@@ -0,0 +1,15 @@
+from typing import List, Optional, Union
+
+from schema_models.event import Event
+
+
+class ScreeningEvent(Event):
+    """
+    A screening of a movie or other video.
+    """
+
+    videoFormat: Optional[Union[str, List[str]]] = None
+    subtitleLanguage: Optional[Union[str, List[str], "Language", List["Language"]]] = (
+        None
+    )
+    workPresented: Optional[Union["Movie", List["Movie"]]] = None

schema_models/sculpture.py

@@ -0,0 +1,7 @@
+from schema_models.creative_work import CreativeWork
+
+
+class Sculpture(CreativeWork):
+    """
+    A piece of sculpture.
+    """

schema_models/sea_body_of_water.py

@@ -0,0 +1,7 @@
+from schema_models.body_of_water import BodyOfWater
+
+
+class SeaBodyOfWater(BodyOfWater):
+    """
+    A sea (for example, the Caspian sea).
+    """

schema_models/search_action.py

@@ -0,0 +1,15 @@
+from typing import List, Optional, Union
+
+from schema_models.action import Action
+
+
+class SearchAction(Action):
+    """
+    The act of searching for an object.
+
+    Related actions:
+
+    * [[FindAction]]: SearchAction generally leads to a FindAction, but not necessarily.
+    """
+
+    query: Optional[Union[str, List[str]]] = None

schema_models/search_rescue_organization.py

@@ -0,0 +1,7 @@
+from schema_models.organization import Organization
+
+
+class SearchRescueOrganization(Organization):
+    """
+    A Search and Rescue organization of some kind.
+    """

schema_models/search_results_page.py

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

schema_models/season.py

@@ -0,0 +1,7 @@
+from schema_models.creative_work import CreativeWork
+
+
+class Season(CreativeWork):
+    """
+    A season in a media series.
+    """

schema_models/seat.py

@@ -0,0 +1,16 @@
+from typing import List, Optional, Union
+
+from schema_models.intangible import Intangible
+
+
+class Seat(Intangible):
+    """
+    Used to describe a seat, such as a reserved seat in an event reservation.
+    """
+
+    seatRow: Optional[Union[str, List[str]]] = None
+    seatingType: Optional[
+        Union["QualitativeValue", List["QualitativeValue"], str, List[str]]
+    ] = None
+    seatSection: Optional[Union[str, List[str]]] = None
+    seatNumber: Optional[Union[str, List[str]]] = None

schema_models/seek_to_action.py

@@ -0,0 +1,13 @@
+from typing import List, Optional, Union
+
+from schema_models.action import Action
+
+
+class SeekToAction(Action):
+    """
+    This is the [[Action]] of navigating to a specific [[startOffset]] timestamp within a [[VideoObject]], typically represented with a URL template structure.
+    """
+
+    startOffset: Optional[
+        Union["HyperTocEntry", List["HyperTocEntry"], float, List[float]]
+    ] = None

schema_models/self_storage.py

@@ -0,0 +1,7 @@
+from schema_models.local_business import LocalBusiness
+
+
+class SelfStorage(LocalBusiness):
+    """
+    A self-storage facility.
+    """

schema_models/sell_action.py

@@ -0,0 +1,17 @@
+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
+from schema_models.warranty_promise import WarrantyPromise
+
+
+class SellAction(TradeAction):
+    """
+    The act of taking money from a buyer in exchange for goods or services rendered. An agent sells an object, product, or service to a buyer for a price. Reciprocal of BuyAction.
+    """
+
+    warrantyPromise: Optional[Union[WarrantyPromise, List[WarrantyPromise]]] = None
+    buyer: Optional[Union[Organization, List[Organization], Person, List[Person]]] = (
+        None
+    )

schema_models/send_action.py

@@ -0,0 +1,31 @@
+from typing import List, Optional, Union
+
+from schema_models.audience import Audience
+from schema_models.contact_point import ContactPoint
+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 SendAction(TransferAction):
+    """
+    The act of physically/electronically dispatching an object for transfer from an origin to a destination. Related actions:
+
+    * [[ReceiveAction]]: The reciprocal of SendAction.
+    * [[GiveAction]]: Unlike GiveAction, SendAction does not imply the transfer of ownership (e.g. I can send you my laptop, but I'm not necessarily giving it to you).
+    """
+
+    recipient: Optional[
+        Union[
+            Audience,
+            List[Audience],
+            ContactPoint,
+            List[ContactPoint],
+            Person,
+            List[Person],
+            Organization,
+            List[Organization],
+        ]
+    ] = None
+    deliveryMethod: Optional[Union[DeliveryMethod, List[DeliveryMethod]]] = None

schema_models/series.py

@@ -0,0 +1,7 @@
+from schema_models.intangible import Intangible
+
+
+class Series(Intangible):
+    """
+    A Series in schema.org is a group of related items, typically but not necessarily of the same kind. See also [[CreativeWorkSeries]], [[EventSeries]].
+    """