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

schema_models/observation.py

@@ -0,0 +1,71 @@
+from datetime import datetime
+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_method_enum import MeasurementMethodEnum
+from schema_models.place import Place
+from schema_models.property import Property
+from schema_models.property_value import PropertyValue
+from schema_models.quantitative_value import QuantitativeValue
+from schema_models.statistical_variable import StatisticalVariable
+from schema_models.thing import Thing
+
+
+class Observation(QuantitativeValue):
+    """
+    Instances of the class [[Observation]] are used to specify observations about an entity at a particular time. The principal properties of an [[Observation]] are [[observationAbout]], [[measuredProperty]], [[statType]], [[value] and [[observationDate]]  and [[measuredProperty]]. Some but not all Observations represent a [[QuantitativeValue]]. Quantitative observations can be about a [[StatisticalVariable]], which is an abstract specification about which we can make observations that are grounded at a particular location and time.
+
+    Observations can also encode a subset of simple RDF-like statements (its observationAbout, a StatisticalVariable, defining the measuredPoperty; its observationAbout property indicating the entity the statement is about, and [[value]] )
+
+    In the context of a quantitative knowledge graph, typical properties could include [[measuredProperty]], [[observationAbout]], [[observationDate]], [[value]], [[unitCode]], [[unitText]], [[measurementMethod]].
+
+    """
+
+    measurementQualifier: Optional[Union[Enumeration, List[Enumeration]]] = None
+    measurementMethod: Optional[
+        Union[
+            HttpUrl,
+            List[HttpUrl],
+            DefinedTerm,
+            List[DefinedTerm],
+            MeasurementMethodEnum,
+            List[MeasurementMethodEnum],
+            str,
+            List[str],
+        ]
+    ] = None
+    measuredProperty: Optional[Union[Property, List[Property]]] = None
+    observationDate: Optional[Union[datetime, List[datetime]]] = None
+    observationAbout: Optional[Union[Place, List[Place], Thing, List[Thing]]] = None
+    observationPeriod: Optional[Union[str, List[str]]] = None
+    measurementDenominator: Optional[
+        Union[StatisticalVariable, List[StatisticalVariable]]
+    ] = None
+    measurementTechnique: Optional[
+        Union[
+            str,
+            List[str],
+            HttpUrl,
+            List[HttpUrl],
+            DefinedTerm,
+            List[DefinedTerm],
+            MeasurementMethodEnum,
+            List[MeasurementMethodEnum],
+        ]
+    ] = None
+    marginOfError: Optional[Union[QuantitativeValue, List[QuantitativeValue]]] = None
+    variableMeasured: Optional[
+        Union[
+            StatisticalVariable,
+            List[StatisticalVariable],
+            Property,
+            List[Property],
+            str,
+            List[str],
+            PropertyValue,
+            List[PropertyValue],
+        ]
+    ] = None

schema_models/occupation.py

@@ -0,0 +1,55 @@
+from typing import List, Optional, Union
+
+from schema_models.intangible import Intangible
+from schema_models.occupational_experience_requirements import (
+    OccupationalExperienceRequirements,
+)
+
+
+class Occupation(Intangible):
+    """
+    A profession, may involve prolonged training and/or a formal qualification.
+    """
+
+    experienceRequirements: Optional[
+        Union[
+            OccupationalExperienceRequirements,
+            List[OccupationalExperienceRequirements],
+            str,
+            List[str],
+        ]
+    ] = None
+    estimatedSalary: Optional[
+        Union[
+            "MonetaryAmount",
+            List["MonetaryAmount"],
+            float,
+            List[float],
+            "MonetaryAmountDistribution",
+            List["MonetaryAmountDistribution"],
+        ]
+    ] = None
+    educationRequirements: Optional[
+        Union[
+            str,
+            List[str],
+            "EducationalOccupationalCredential",
+            List["EducationalOccupationalCredential"],
+        ]
+    ] = None
+    occupationalCategory: Optional[
+        Union["CategoryCode", List["CategoryCode"], str, List[str]]
+    ] = None
+    skills: Optional[Union[str, List[str], "DefinedTerm", List["DefinedTerm"]]] = None
+    qualifications: Optional[
+        Union[
+            str,
+            List[str],
+            "EducationalOccupationalCredential",
+            List["EducationalOccupationalCredential"],
+        ]
+    ] = None
+    responsibilities: Optional[Union[str, List[str]]] = None
+    occupationLocation: Optional[
+        Union["AdministrativeArea", List["AdministrativeArea"]]
+    ] = None

schema_models/occupational_experience_requirements.py

@@ -0,0 +1,11 @@
+from typing import List, Optional, Union
+
+from schema_models.intangible import Intangible
+
+
+class OccupationalExperienceRequirements(Intangible):
+    """
+    Indicates employment-related experience requirements, e.g. [[monthsOfExperience]].
+    """
+
+    monthsOfExperience: Optional[Union[float, List[float]]] = None

schema_models/occupational_therapy.py

@@ -0,0 +1,7 @@
+from schema_models.medical_therapy import MedicalTherapy
+
+
+class OccupationalTherapy(MedicalTherapy):
+    """
+    A treatment of people with physical, emotional, or social problems, using purposeful activity to help them overcome or learn to deal with their problems.
+    """

schema_models/ocean_body_of_water.py

@@ -0,0 +1,7 @@
+from schema_models.body_of_water import BodyOfWater
+
+
+class OceanBodyOfWater(BodyOfWater):
+    """
+    An ocean (for example, the Pacific).
+    """

schema_models/offer.py

@@ -0,0 +1,180 @@
+from datetime import date, datetime, time
+from typing import List, Optional, Union
+
+from pydantic import HttpUrl
+
+from schema_models.creative_work import CreativeWork
+from schema_models.event import Event
+from schema_models.intangible import Intangible
+from schema_models.member_program_tier import MemberProgramTier
+from schema_models.organization import Organization
+from schema_models.person import Person
+from schema_models.place import Place
+from schema_models.product import Product
+from schema_models.thing import Thing
+from schema_models.trip import Trip
+
+
+class Offer(Intangible):
+    """
+    An offer to transfer some rights to an item or to provide a service — for example, an offer to sell tickets to an event, to rent the DVD of a movie, to stream a TV show over the internet, to repair a motorcycle, or to loan a book.
+
+    Note: As the [[businessFunction]] property, which identifies the form of offer (e.g. sell, lease, repair, dispose), defaults to http://purl.org/goodrelations/v1#Sell; an Offer without a defined businessFunction value can be assumed to be an offer to sell.
+
+    For [GTIN](http://www.gs1.org/barcodes/technical/idkeys/gtin)-related fields, see [Check Digit calculator](http://www.gs1.org/barcodes/support/check_digit_calculator) and [validation guide](http://www.gs1us.org/resources/standards/gtin-validation-guide) from [GS1](http://www.gs1.org/).
+    """
+
+    hasGS1DigitalLink: Optional[Union[HttpUrl, List[HttpUrl]]] = None
+    areaServed: Optional[
+        Union[
+            str,
+            List[str],
+            Place,
+            List[Place],
+            "GeoShape",
+            List["GeoShape"],
+            "AdministrativeArea",
+            List["AdministrativeArea"],
+        ]
+    ] = None
+    aggregateRating: Optional[Union["AggregateRating", List["AggregateRating"]]] = None
+    priceSpecification: Optional[
+        Union["PriceSpecification", List["PriceSpecification"]]
+    ] = None
+    gtin8: Optional[Union[str, List[str]]] = None
+    gtin14: Optional[Union[str, List[str]]] = None
+    hasMerchantReturnPolicy: Optional[
+        Union["MerchantReturnPolicy", List["MerchantReturnPolicy"]]
+    ] = None
+    includesObject: Optional[
+        Union["TypeAndQuantityNode", List["TypeAndQuantityNode"]]
+    ] = None
+    review: Optional[Union["Review", List["Review"]]] = None
+    checkoutPageURLTemplate: Optional[Union[str, List[str]]] = None
+    eligibleRegion: Optional[
+        Union["GeoShape", List["GeoShape"], str, List[str], Place, List[Place]]
+    ] = None
+    advanceBookingRequirement: Optional[
+        Union["QuantitativeValue", List["QuantitativeValue"]]
+    ] = None
+    leaseLength: Optional[
+        Union[
+            "QuantitativeValue", List["QuantitativeValue"], "Duration", List["Duration"]
+        ]
+    ] = None
+    eligibleCustomerType: Optional[
+        Union["BusinessEntityType", List["BusinessEntityType"]]
+    ] = None
+    availableDeliveryMethod: Optional[
+        Union["DeliveryMethod", List["DeliveryMethod"]]
+    ] = None
+    eligibleDuration: Optional[
+        Union["QuantitativeValue", List["QuantitativeValue"]]
+    ] = None
+    itemOffered: Optional[
+        Union[
+            "MenuItem",
+            List["MenuItem"],
+            CreativeWork,
+            List[CreativeWork],
+            "Service",
+            List["Service"],
+            Product,
+            List[Product],
+            Trip,
+            List[Trip],
+            Event,
+            List[Event],
+            "AggregateOffer",
+            List["AggregateOffer"],
+        ]
+    ] = None
+    shippingDetails: Optional[
+        Union["OfferShippingDetails", List["OfferShippingDetails"]]
+    ] = None
+    eligibleTransactionVolume: Optional[
+        Union["PriceSpecification", List["PriceSpecification"]]
+    ] = None
+    validFrom: Optional[Union[datetime, List[datetime], date, List[date]]] = None
+    deliveryLeadTime: Optional[
+        Union["QuantitativeValue", List["QuantitativeValue"]]
+    ] = None
+    validForMemberTier: Optional[Union[MemberProgramTier, List[MemberProgramTier]]] = (
+        None
+    )
+    reviews: Optional[Union["Review", List["Review"]]] = None
+    hasAdultConsideration: Optional[
+        Union["AdultOrientedEnumeration", List["AdultOrientedEnumeration"]]
+    ] = None
+    itemCondition: Optional[Union["OfferItemCondition", List["OfferItemCondition"]]] = (
+        None
+    )
+    hasMeasurement: Optional[Union["QuantitativeValue", List["QuantitativeValue"]]] = (
+        None
+    )
+    gtin13: Optional[Union[str, List[str]]] = None
+    acceptedPaymentMethod: Optional[
+        Union[
+            str,
+            List[str],
+            "PaymentMethod",
+            List["PaymentMethod"],
+            "LoanOrCredit",
+            List["LoanOrCredit"],
+        ]
+    ] = None
+    seller: Optional[Union[Person, List[Person], Organization, List[Organization]]] = (
+        None
+    )
+    availability: Optional[Union["ItemAvailability", List["ItemAvailability"]]] = None
+    additionalProperty: Optional[Union["PropertyValue", List["PropertyValue"]]] = None
+    mobileUrl: Optional[Union[str, List[str]]] = None
+    sku: Optional[Union[str, List[str]]] = None
+    gtin: Optional[Union[str, List[str], HttpUrl, List[HttpUrl]]] = None
+    inventoryLevel: Optional[Union["QuantitativeValue", List["QuantitativeValue"]]] = (
+        None
+    )
+    availabilityEnds: Optional[
+        Union[datetime, List[datetime], time, List[time], date, List[date]]
+    ] = None
+    validThrough: Optional[Union[datetime, List[datetime], date, List[date]]] = None
+    asin: Optional[Union[str, List[str], HttpUrl, List[HttpUrl]]] = None
+    warranty: Optional[Union["WarrantyPromise", List["WarrantyPromise"]]] = None
+    ineligibleRegion: Optional[
+        Union[Place, List[Place], str, List[str], "GeoShape", List["GeoShape"]]
+    ] = None
+    mpn: Optional[Union[str, List[str]]] = None
+    serialNumber: Optional[Union[str, List[str]]] = None
+    offeredBy: Optional[
+        Union[Person, List[Person], Organization, List[Organization]]
+    ] = None
+    availableAtOrFrom: Optional[Union[Place, List[Place]]] = None
+    eligibleQuantity: Optional[
+        Union["QuantitativeValue", List["QuantitativeValue"]]
+    ] = None
+    price: Optional[Union[str, List[str], float, List[float]]] = None
+    gtin12: Optional[Union[str, List[str]]] = None
+    priceCurrency: Optional[Union[str, List[str]]] = None
+    addOn: Optional[Union["Offer", List["Offer"]]] = None
+    businessFunction: Optional[Union["BusinessFunction", List["BusinessFunction"]]] = (
+        None
+    )
+    availabilityStarts: Optional[
+        Union[date, List[date], time, List[time], datetime, List[datetime]]
+    ] = None
+    isFamilyFriendly: Optional[Union[bool, List[bool]]] = None
+    category: Optional[
+        Union[
+            Thing,
+            List[Thing],
+            "PhysicalActivityCategory",
+            List["PhysicalActivityCategory"],
+            "CategoryCode",
+            List["CategoryCode"],
+            str,
+            List[str],
+            HttpUrl,
+            List[HttpUrl],
+        ]
+    ] = None
+    priceValidUntil: Optional[Union[date, List[date]]] = None

schema_models/offer_catalog.py

@@ -0,0 +1,7 @@
+from schema_models.item_list import ItemList
+
+
+class OfferCatalog(ItemList):
+    """
+    An OfferCatalog is an ItemList that contains related Offers and/or further OfferCatalogs that are offeredBy the same provider.
+    """

schema_models/offer_for_lease.py

@@ -0,0 +1,10 @@
+from schema_models.offer import Offer
+
+
+class OfferForLease(Offer):
+    """
+    An [[OfferForLease]] in Schema.org represents an [[Offer]] to lease out something, i.e. an [[Offer]] whose
+      [[businessFunction]] is [lease out](http://purl.org/goodrelations/v1#LeaseOut.). See [Good Relations](https://en.wikipedia.org/wiki/GoodRelations) for
+      background on the underlying concepts.
+
+    """

schema_models/offer_for_purchase.py

@@ -0,0 +1,10 @@
+from schema_models.offer import Offer
+
+
+class OfferForPurchase(Offer):
+    """
+    An [[OfferForPurchase]] in Schema.org represents an [[Offer]] to sell something, i.e. an [[Offer]] whose
+      [[businessFunction]] is [sell](http://purl.org/goodrelations/v1#Sell.). See [Good Relations](https://en.wikipedia.org/wiki/GoodRelations) for
+      background on the underlying concepts.
+
+    """

schema_models/offer_item_condition.py

@@ -0,0 +1,7 @@
+from schema_models.enumeration import Enumeration
+
+
+class OfferItemCondition(Enumeration):
+    """
+    A list of possible conditions for the item.
+    """

schema_models/offer_shipping_details.py

@@ -0,0 +1,50 @@
+from typing import List, Optional, Union
+
+from pydantic import HttpUrl
+
+from schema_models.defined_region import DefinedRegion
+from schema_models.distance import Distance
+from schema_models.member_program_tier import MemberProgramTier
+from schema_models.monetary_amount import MonetaryAmount
+from schema_models.structured_value import StructuredValue
+
+
+class OfferShippingDetails(StructuredValue):
+    """
+    OfferShippingDetails represents information about shipping destinations.
+
+    Multiple of these entities can be used to represent different shipping rates for different destinations:
+
+    One entity for Alaska/Hawaii. A different one for continental US. A different one for all France.
+
+    Multiple of these entities can be used to represent different shipping costs and delivery times.
+
+    Two entities that are identical but differ in rate and time:
+
+    E.g. Cheaper and slower: $5 in 5-7 days
+    or Fast and expensive: $15 in 1-2 days.
+    """
+
+    shippingSettingsLink: Optional[Union[HttpUrl, List[HttpUrl]]] = None
+    shippingOrigin: Optional[Union[DefinedRegion, List[DefinedRegion]]] = None
+    shippingLabel: Optional[Union[str, List[str]]] = None
+    height: Optional[
+        Union[Distance, List[Distance], "QuantitativeValue", List["QuantitativeValue"]]
+    ] = None
+    transitTimeLabel: Optional[Union[str, List[str]]] = None
+    width: Optional[
+        Union[Distance, List[Distance], "QuantitativeValue", List["QuantitativeValue"]]
+    ] = None
+    deliveryTime: Optional[
+        Union["ShippingDeliveryTime", List["ShippingDeliveryTime"]]
+    ] = None
+    validForMemberTier: Optional[Union[MemberProgramTier, List[MemberProgramTier]]] = (
+        None
+    )
+    depth: Optional[
+        Union["QuantitativeValue", List["QuantitativeValue"], Distance, List[Distance]]
+    ] = None
+    doesNotShip: Optional[Union[bool, List[bool]]] = None
+    shippingDestination: Optional[Union[DefinedRegion, List[DefinedRegion]]] = None
+    shippingRate: Optional[Union[MonetaryAmount, List[MonetaryAmount]]] = None
+    weight: Optional[Union["QuantitativeValue", List["QuantitativeValue"]]] = None

schema_models/office_equipment_store.py

@@ -0,0 +1,7 @@
+from schema_models.store import Store
+
+
+class OfficeEquipmentStore(Store):
+    """
+    An office equipment store.
+    """

schema_models/on_demand_event.py

@@ -0,0 +1,7 @@
+from schema_models.publication_event import PublicationEvent
+
+
+class OnDemandEvent(PublicationEvent):
+    """
+    A publication event, e.g. catch-up TV or radio podcast, during which a program is available on-demand.
+    """

schema_models/online_business.py

@@ -0,0 +1,7 @@
+from schema_models.organization import Organization
+
+
+class OnlineBusiness(Organization):
+    """
+    A particular online business, either standalone or the online part of a broader organization. Examples include an eCommerce site, an online travel booking site, an online learning site, an online logistics and shipping provider, an online (virtual) doctor, etc.
+    """

schema_models/online_store.py

@@ -0,0 +1,7 @@
+from schema_models.online_business import OnlineBusiness
+
+
+class OnlineStore(OnlineBusiness):
+    """
+    An eCommerce site.
+    """

schema_models/opening_hours_specification.py

@@ -0,0 +1,23 @@
+from datetime import date, datetime, time
+from typing import List, Optional, Union
+
+from schema_models.day_of_week import DayOfWeek
+from schema_models.structured_value import StructuredValue
+
+
+class OpeningHoursSpecification(StructuredValue):
+    """
+    A structured value providing information about the opening hours of a place or a certain service inside a place.
+
+
+    The place is __open__ if the [[opens]] property is specified, and __closed__ otherwise.
+
+    If the value for the [[closes]] property is less than the value for the [[opens]] property then the hour range is assumed to span over the next day.
+
+    """
+
+    validFrom: Optional[Union[datetime, List[datetime], date, List[date]]] = None
+    dayOfWeek: Optional[Union[DayOfWeek, List[DayOfWeek]]] = None
+    validThrough: Optional[Union[datetime, List[datetime], date, List[date]]] = None
+    closes: Optional[Union[time, List[time]]] = None
+    opens: Optional[Union[time, List[time]]] = None

schema_models/opinion_news_article.py

@@ -0,0 +1,7 @@
+from schema_models.news_article import NewsArticle
+
+
+class OpinionNewsArticle(NewsArticle):
+    """
+    An [[OpinionNewsArticle]] is a [[NewsArticle]] that primarily expresses opinions rather than journalistic reporting of news and events. For example, a [[NewsArticle]] consisting of a column or [[Blog]]/[[BlogPosting]] entry in the Opinions section of a news publication.
+    """

schema_models/optician.py

@@ -0,0 +1,7 @@
+from schema_models.medical_business import MedicalBusiness
+
+
+class Optician(MedicalBusiness):
+    """
+    A store that sells reading glasses and similar devices for improving vision.
+    """

schema_models/order.py

@@ -0,0 +1,58 @@
+from datetime import date, datetime
+from typing import List, Optional, Union
+
+from pydantic import HttpUrl
+
+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.product import Product
+
+
+class Order(Intangible):
+    """
+    An order is a confirmation of a transaction (a receipt), which can contain multiple line items, each represented by an Offer that has been accepted by the customer.
+    """
+
+    discountCurrency: Optional[Union[str, List[str]]] = None
+    seller: Optional[Union[Person, List[Person], Organization, List[Organization]]] = (
+        None
+    )
+    orderedItem: Optional[
+        Union[
+            "Service",
+            List["Service"],
+            Product,
+            List[Product],
+            "OrderItem",
+            List["OrderItem"],
+        ]
+    ] = None
+    paymentMethodId: Optional[Union[str, List[str]]] = None
+    paymentMethod: Optional[
+        Union[str, List[str], "PaymentMethod", List["PaymentMethod"]]
+    ] = None
+    isGift: Optional[Union[bool, List[bool]]] = None
+    paymentDue: Optional[Union[datetime, List[datetime]]] = None
+    merchant: Optional[
+        Union[Person, List[Person], Organization, List[Organization]]
+    ] = None
+    orderNumber: Optional[Union[str, List[str]]] = None
+    acceptedOffer: Optional[Union[Offer, List[Offer]]] = None
+    partOfInvoice: Optional[Union["Invoice", List["Invoice"]]] = None
+    paymentUrl: Optional[Union[HttpUrl, List[HttpUrl]]] = None
+    confirmationNumber: Optional[Union[str, List[str]]] = None
+    orderDelivery: Optional[Union["ParcelDelivery", List["ParcelDelivery"]]] = None
+    orderDate: Optional[Union[date, List[date], datetime, List[datetime]]] = None
+    discountCode: Optional[Union[str, List[str]]] = None
+    billingAddress: Optional[Union["PostalAddress", List["PostalAddress"]]] = None
+    discount: Optional[Union[str, List[str], float, List[float]]] = None
+    customer: Optional[
+        Union[Person, List[Person], Organization, List[Organization]]
+    ] = None
+    paymentDueDate: Optional[Union[date, List[date], datetime, List[datetime]]] = None
+    orderStatus: Optional[Union["OrderStatus", List["OrderStatus"]]] = None
+    broker: Optional[Union[Organization, List[Organization], Person, List[Person]]] = (
+        None
+    )

schema_models/order_action.py

@@ -0,0 +1,12 @@
+from typing import List, Optional, Union
+
+from schema_models.delivery_method import DeliveryMethod
+from schema_models.trade_action import TradeAction
+
+
+class OrderAction(TradeAction):
+    """
+    An agent orders an object/product/service to be delivered/sent.
+    """
+
+    deliveryMethod: Optional[Union[DeliveryMethod, List[DeliveryMethod]]] = None

schema_models/order_item.py

@@ -0,0 +1,27 @@
+from typing import List, Optional, Union
+
+from schema_models.intangible import Intangible
+from schema_models.product import Product
+
+
+class OrderItem(Intangible):
+    """
+    An order item is a line of an order. It includes the quantity and shipping details of a bought offer.
+    """
+
+    orderDelivery: Optional[Union["ParcelDelivery", List["ParcelDelivery"]]] = None
+    orderItemStatus: Optional[Union["OrderStatus", List["OrderStatus"]]] = None
+    orderedItem: Optional[
+        Union[
+            "Service",
+            List["Service"],
+            Product,
+            List[Product],
+            "OrderItem",
+            List["OrderItem"],
+        ]
+    ] = None
+    orderQuantity: Optional[
+        Union[float, List[float], "QuantitativeValue", List["QuantitativeValue"]]
+    ] = None
+    orderItemNumber: Optional[Union[str, List[str]]] = None

schema_models/order_status.py

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