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

schema_models/day_of_week.py

@@ -0,0 +1,10 @@
+from schema_models.enumeration import Enumeration
+
+
+class DayOfWeek(Enumeration):
+    """
+    The day of the week, e.g. used to specify to which day the opening hours of an OpeningHoursSpecification refer.
+
+    Originally, URLs from [GoodRelations](http://purl.org/goodrelations/v1) were used (for [[Monday]], [[Tuesday]], [[Wednesday]], [[Thursday]], [[Friday]], [[Saturday]], [[Sunday]] plus a special entry for [[PublicHolidays]]); these have now been integrated directly into schema.org.
+
+    """

schema_models/day_spa.py

@@ -0,0 +1,7 @@
+from schema_models.health_and_beauty_business import HealthAndBeautyBusiness
+
+
+class DaySpa(HealthAndBeautyBusiness):
+    """
+    A day spa.
+    """

schema_models/deactivate_action.py

@@ -0,0 +1,7 @@
+from schema_models.control_action import ControlAction
+
+
+class DeactivateAction(ControlAction):
+    """
+    The act of stopping or deactivating a device or application (e.g. stopping a timer or turning off a flashlight).
+    """

schema_models/defence_establishment.py

@@ -0,0 +1,7 @@
+from schema_models.government_building import GovernmentBuilding
+
+
+class DefenceEstablishment(GovernmentBuilding):
+    """
+    A defence establishment, such as an army or navy base.
+    """

schema_models/defined_region.py

@@ -0,0 +1,31 @@
+from typing import List, Optional, Union
+
+from schema_models.postal_code_range_specification import PostalCodeRangeSpecification
+from schema_models.structured_value import StructuredValue
+
+
+class DefinedRegion(StructuredValue):
+    """
+    A DefinedRegion is a geographic area defined by potentially arbitrary (rather than political, administrative or natural geographical) criteria. Properties are provided for defining a region by reference to sets of postal codes.
+
+    Examples: a delivery destination when shopping. Region where regional pricing is configured.
+
+    Requirement 1:
+    Country: US
+    States: "NY", "CA"
+
+    Requirement 2:
+    Country: US
+    PostalCode Set: { [94000-94585], [97000, 97999], [13000, 13599]}
+    { [12345, 12345], [78945, 78945], }
+    Region = state, canton, prefecture, autonomous community...
+
+    """
+
+    postalCodeRange: Optional[
+        Union[PostalCodeRangeSpecification, List[PostalCodeRangeSpecification]]
+    ] = None
+    postalCodePrefix: Optional[Union[str, List[str]]] = None
+    postalCode: Optional[Union[str, List[str]]] = None
+    addressRegion: Optional[Union[str, List[str]]] = None
+    addressCountry: Optional[Union[str, List[str], "Country", List["Country"]]] = None

schema_models/defined_term.py

@@ -0,0 +1,16 @@
+from typing import List, Optional, Union
+
+from pydantic import HttpUrl
+
+from schema_models.intangible import Intangible
+
+
+class DefinedTerm(Intangible):
+    """
+    A word, name, acronym, phrase, etc. with a formal definition. Often used in the context of category or subject classification, glossaries or dictionaries, product or creative work types, etc. Use the name property for the term being defined, use termCode if the term has an alpha-numeric code allocated, use description to provide the definition of the term.
+    """
+
+    inDefinedTermSet: Optional[
+        Union[HttpUrl, List[HttpUrl], "DefinedTermSet", List["DefinedTermSet"]]
+    ] = None
+    termCode: Optional[Union[str, List[str]]] = None

schema_models/defined_term_set.py

@@ -0,0 +1,12 @@
+from typing import List, Optional, Union
+
+from schema_models.creative_work import CreativeWork
+from schema_models.defined_term import DefinedTerm
+
+
+class DefinedTermSet(CreativeWork):
+    """
+    A set of defined terms, for example a set of categories or a classification scheme, a glossary, dictionary or enumeration.
+    """
+
+    hasDefinedTerm: Optional[Union[DefinedTerm, List[DefinedTerm]]] = None

schema_models/delete_action.py

@@ -0,0 +1,7 @@
+from schema_models.update_action import UpdateAction
+
+
+class DeleteAction(UpdateAction):
+    """
+    The act of editing a recipient by removing one of its objects.
+    """

schema_models/delivery_charge_specification.py

@@ -0,0 +1,35 @@
+from typing import List, Optional, Union
+
+from schema_models.administrative_area import AdministrativeArea
+from schema_models.delivery_method import DeliveryMethod
+from schema_models.geo_shape import GeoShape
+from schema_models.place import Place
+from schema_models.price_specification import PriceSpecification
+
+
+class DeliveryChargeSpecification(PriceSpecification):
+    """
+    The price for the delivery of an offer using a particular delivery method.
+    """
+
+    eligibleRegion: Optional[
+        Union[GeoShape, List[GeoShape], str, List[str], Place, List[Place]]
+    ] = None
+    areaServed: Optional[
+        Union[
+            str,
+            List[str],
+            Place,
+            List[Place],
+            GeoShape,
+            List[GeoShape],
+            AdministrativeArea,
+            List[AdministrativeArea],
+        ]
+    ] = None
+    appliesToDeliveryMethod: Optional[Union[DeliveryMethod, List[DeliveryMethod]]] = (
+        None
+    )
+    ineligibleRegion: Optional[
+        Union[Place, List[Place], str, List[str], GeoShape, List[GeoShape]]
+    ] = None

schema_models/delivery_event.py

@@ -0,0 +1,15 @@
+from datetime import datetime
+from typing import List, Optional, Union
+
+from schema_models.event import Event
+
+
+class DeliveryEvent(Event):
+    """
+    An event involving the delivery of an item.
+    """
+
+    availableThrough: Optional[Union[datetime, List[datetime]]] = None
+    availableFrom: Optional[Union[datetime, List[datetime]]] = None
+    accessCode: Optional[Union[str, List[str]]] = None
+    hasDeliveryMethod: Optional[Union["DeliveryMethod", List["DeliveryMethod"]]] = None

schema_models/delivery_method.py

@@ -0,0 +1,7 @@
+from schema_models.enumeration import Enumeration
+
+
+class DeliveryMethod(Enumeration):
+    """
+    A sub property of instrument. The method of delivery.
+    """

schema_models/delivery_time_settings.py

@@ -0,0 +1,16 @@
+from typing import List, Optional, Union
+
+from schema_models.structured_value import StructuredValue
+
+
+class DeliveryTimeSettings(StructuredValue):
+    """
+    A DeliveryTimeSettings represents re-usable pieces of shipping information, relating to timing. It is designed for publication on an URL that may be referenced via the [[shippingSettingsLink]] property of an [[OfferShippingDetails]]. Several occurrences can be published, distinguished (and identified/referenced) by their different values for [[transitTimeLabel]].
+    """
+
+    transitTimeLabel: Optional[Union[str, List[str]]] = None
+    deliveryTime: Optional[
+        Union["ShippingDeliveryTime", List["ShippingDeliveryTime"]]
+    ] = None
+    isUnlabelledFallback: Optional[Union[bool, List[bool]]] = None
+    shippingDestination: Optional[Union["DefinedRegion", List["DefinedRegion"]]] = None

schema_models/demand.py

@@ -0,0 +1,125 @@
+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.organization import Organization
+from schema_models.person import Person
+from schema_models.place import Place
+from schema_models.product import Product
+from schema_models.trip import Trip
+
+
+class Demand(Intangible):
+    """
+    A demand entity represents the public, not necessarily binding, not necessarily exclusive, announcement by an organization or person to seek a certain type of goods or services. For describing demand using this type, the very same properties used for Offer apply.
+    """
+
+    gtin14: Optional[Union[str, List[str]]] = None
+    gtin12: Optional[Union[str, List[str]]] = None
+    businessFunction: Optional[Union["BusinessFunction", List["BusinessFunction"]]] = (
+        None
+    )
+    eligibleRegion: Optional[
+        Union["GeoShape", List["GeoShape"], str, List[str], Place, List[Place]]
+    ] = None
+    areaServed: Optional[
+        Union[
+            str,
+            List[str],
+            Place,
+            List[Place],
+            "GeoShape",
+            List["GeoShape"],
+            "AdministrativeArea",
+            List["AdministrativeArea"],
+        ]
+    ] = None
+    priceSpecification: Optional[
+        Union["PriceSpecification", List["PriceSpecification"]]
+    ] = None
+    advanceBookingRequirement: Optional[
+        Union["QuantitativeValue", List["QuantitativeValue"]]
+    ] = None
+    gtin8: Optional[Union[str, List[str]]] = None
+    availableDeliveryMethod: Optional[
+        Union["DeliveryMethod", List["DeliveryMethod"]]
+    ] = None
+    includesObject: Optional[
+        Union["TypeAndQuantityNode", List["TypeAndQuantityNode"]]
+    ] = None
+    eligibleTransactionVolume: Optional[
+        Union["PriceSpecification", List["PriceSpecification"]]
+    ] = None
+    deliveryLeadTime: Optional[
+        Union["QuantitativeValue", List["QuantitativeValue"]]
+    ] = None
+    eligibleCustomerType: Optional[
+        Union["BusinessEntityType", List["BusinessEntityType"]]
+    ] = None
+    seller: Optional[Union[Person, List[Person], Organization, List[Organization]]] = (
+        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
+    availability: Optional[Union["ItemAvailability", List["ItemAvailability"]]] = None
+    validFrom: Optional[Union[datetime, List[datetime], date, List[date]]] = None
+    itemCondition: Optional[Union["OfferItemCondition", List["OfferItemCondition"]]] = (
+        None
+    )
+    inventoryLevel: Optional[Union["QuantitativeValue", List["QuantitativeValue"]]] = (
+        None
+    )
+    validThrough: Optional[Union[datetime, List[datetime], date, List[date]]] = None
+    gtin13: Optional[Union[str, List[str]]] = None
+    acceptedPaymentMethod: Optional[
+        Union[
+            str,
+            List[str],
+            "PaymentMethod",
+            List["PaymentMethod"],
+            "LoanOrCredit",
+            List["LoanOrCredit"],
+        ]
+    ] = None
+    asin: Optional[Union[str, List[str], HttpUrl, List[HttpUrl]]] = None
+    serialNumber: Optional[Union[str, List[str]]] = None
+    sku: Optional[Union[str, List[str]]] = None
+    gtin: Optional[Union[str, List[str], HttpUrl, List[HttpUrl]]] = None
+    availabilityEnds: Optional[
+        Union[datetime, List[datetime], time, List[time], date, List[date]]
+    ] = None
+    availabilityStarts: Optional[
+        Union[date, List[date], time, List[time], datetime, List[datetime]]
+    ] = 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
+    availableAtOrFrom: Optional[Union[Place, List[Place]]] = None
+    eligibleQuantity: Optional[
+        Union["QuantitativeValue", List["QuantitativeValue"]]
+    ] = None

schema_models/dentist.py

@@ -0,0 +1,7 @@
+from schema_models.medical_organization import MedicalOrganization
+
+
+class Dentist(MedicalOrganization):
+    """
+    A dentist.
+    """

schema_models/depart_action.py

@@ -0,0 +1,7 @@
+from schema_models.move_action import MoveAction
+
+
+class DepartAction(MoveAction):
+    """
+    The act of  departing from a place. An agent departs from a fromLocation for a destination, optionally with participants.
+    """

schema_models/department_store.py

@@ -0,0 +1,7 @@
+from schema_models.store import Store
+
+
+class DepartmentStore(Store):
+    """
+    A department store.
+    """

schema_models/deposit_account.py

@@ -0,0 +1,7 @@
+from schema_models.bank_account import BankAccount
+
+
+class DepositAccount(BankAccount):
+    """
+    A type of Bank Account with a main purpose of depositing funds to gain interest or other benefits.
+    """

schema_models/diagnostic_lab.py

@@ -0,0 +1,12 @@
+from typing import List, Optional, Union
+
+from schema_models.medical_organization import MedicalOrganization
+from schema_models.medical_test import MedicalTest
+
+
+class DiagnosticLab(MedicalOrganization):
+    """
+    A medical laboratory that offers on-site or off-site diagnostic services.
+    """
+
+    availableTest: Optional[Union[MedicalTest, List[MedicalTest]]] = None

schema_models/diagnostic_procedure.py

@@ -0,0 +1,7 @@
+from schema_models.medical_procedure import MedicalProcedure
+
+
+class DiagnosticProcedure(MedicalProcedure):
+    """
+    A medical procedure intended primarily for diagnostic, as opposed to therapeutic, purposes.
+    """

schema_models/diet.py

@@ -0,0 +1,19 @@
+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 Diet(CreativeWork):
+    """
+    A strategy of regulating the intake of food to achieve or maintain a specific health-related goal.
+    """
+
+    dietFeatures: Optional[Union[str, List[str]]] = None
+    endorsers: Optional[
+        Union[Person, List[Person], Organization, List[Organization]]
+    ] = None
+    expertConsiderations: Optional[Union[str, List[str]]] = None
+    physiologicalBenefits: Optional[Union[str, List[str]]] = None
+    risks: Optional[Union[str, List[str]]] = None

schema_models/dietary_supplement.py

@@ -0,0 +1,33 @@
+from typing import List, Optional, Union
+
+from schema_models.substance import Substance
+
+
+class DietarySupplement(Substance):
+    """
+    A product taken by mouth that contains a dietary ingredient intended to supplement the diet. Dietary ingredients may include vitamins, minerals, herbs or other botanicals, amino acids, and substances such as enzymes, organ tissues, glandulars and metabolites.
+    """
+
+    activeIngredient: Optional[Union[str, List[str]]] = None
+    isProprietary: Optional[Union[bool, List[bool]]] = None
+    recommendedIntake: Optional[
+        Union["RecommendedDoseSchedule", List["RecommendedDoseSchedule"]]
+    ] = None
+    mechanismOfAction: Optional[Union[str, List[str]]] = None
+    targetPopulation: Optional[Union[str, List[str]]] = None
+    proprietaryName: Optional[Union[str, List[str]]] = None
+    maximumIntake: Optional[
+        Union["MaximumDoseSchedule", List["MaximumDoseSchedule"]]
+    ] = None
+    legalStatus: Optional[
+        Union[
+            "DrugLegalStatus",
+            List["DrugLegalStatus"],
+            "MedicalEnumeration",
+            List["MedicalEnumeration"],
+            str,
+            List[str],
+        ]
+    ] = None
+    safetyConsideration: Optional[Union[str, List[str]]] = None
+    nonProprietaryName: Optional[Union[str, List[str]]] = None

schema_models/digital_document.py

@@ -0,0 +1,14 @@
+from typing import List, Optional, Union
+
+from schema_models.creative_work import CreativeWork
+from schema_models.digital_document_permission import DigitalDocumentPermission
+
+
+class DigitalDocument(CreativeWork):
+    """
+    An electronic file or document.
+    """
+
+    hasDigitalDocumentPermission: Optional[
+        Union[DigitalDocumentPermission, List[DigitalDocumentPermission]]
+    ] = None

schema_models/digital_document_permission.py

@@ -0,0 +1,27 @@
+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 DigitalDocumentPermission(Intangible):
+    """
+    A permission for a particular person or group to access a particular file.
+    """
+
+    permissionType: Optional[
+        Union["DigitalDocumentPermissionType", List["DigitalDocumentPermissionType"]]
+    ] = None
+    grantee: Optional[
+        Union[
+            Person,
+            List[Person],
+            Organization,
+            List[Organization],
+            "Audience",
+            List["Audience"],
+            "ContactPoint",
+            List["ContactPoint"],
+        ]
+    ] = None

schema_models/digital_document_permission_type.py

@@ -0,0 +1,7 @@
+from schema_models.enumeration import Enumeration
+
+
+class DigitalDocumentPermissionType(Enumeration):
+    """
+    A type of permission which can be granted for accessing a digital document.
+    """

schema_models/digital_platform_enumeration.py

@@ -0,0 +1,7 @@
+from schema_models.enumeration import Enumeration
+
+
+class DigitalPlatformEnumeration(Enumeration):
+    """
+    Enumerates some common technology platforms, for use with properties such as [[actionPlatform]]. It is not supposed to be comprehensive - when a suitable code is not enumerated here, textual or URL values can be used instead. These codes are at a fairly high level and do not deal with versioning and other nuance. Additional codes can be suggested [in github](https://github.com/schemaorg/schemaorg/issues/3057).
+    """

schema_models/disagree_action.py

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

schema_models/discover_action.py

@@ -0,0 +1,7 @@
+from schema_models.find_action import FindAction
+
+
+class DiscoverAction(FindAction):
+    """
+    The act of discovering/finding an object.
+    """

schema_models/discussion_forum_posting.py

@@ -0,0 +1,7 @@
+from schema_models.social_media_posting import SocialMediaPosting
+
+
+class DiscussionForumPosting(SocialMediaPosting):
+    """
+    A posting to a discussion forum.
+    """

schema_models/dislike_action.py

@@ -0,0 +1,7 @@
+from schema_models.react_action import ReactAction
+
+
+class DislikeAction(ReactAction):
+    """
+    The act of expressing a negative sentiment about the object. An agent dislikes an object (a proposition, topic or theme) with participants.
+    """

schema_models/distance.py

@@ -0,0 +1,7 @@
+from schema_models.quantity import Quantity
+
+
+class Distance(Quantity):
+    """
+    Properties that take Distances as values are of the form '<Number> <Length unit of measure>'. E.g., '7 ft'.
+    """

schema_models/distillery.py

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

schema_models/donate_action.py

@@ -0,0 +1,32 @@
+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.price_specification import PriceSpecification
+from schema_models.transfer_action import TransferAction
+
+
+class DonateAction(TransferAction):
+    """
+    The act of providing goods, services, or money without compensation, often for philanthropic reasons.
+    """
+
+    price: Optional[Union[str, List[str], float, List[float]]] = None
+    priceCurrency: Optional[Union[str, List[str]]] = None
+    priceSpecification: Optional[
+        Union[PriceSpecification, List[PriceSpecification]]
+    ] = None
+    recipient: Optional[
+        Union[
+            Audience,
+            List[Audience],
+            ContactPoint,
+            List[ContactPoint],
+            Person,
+            List[Person],
+            Organization,
+            List[Organization],
+        ]
+    ] = None

schema_models/dose_schedule.py

@@ -0,0 +1,16 @@
+from typing import List, Optional, Union
+
+from schema_models.medical_intangible import MedicalIntangible
+
+
+class DoseSchedule(MedicalIntangible):
+    """
+    A dosing schedule for the drug for a given population, either observed, recommended, or maximum dose based on the type used.
+    """
+
+    doseValue: Optional[
+        Union[float, List[float], "QualitativeValue", List["QualitativeValue"]]
+    ] = None
+    frequency: Optional[Union[str, List[str]]] = None
+    targetPopulation: Optional[Union[str, List[str]]] = None
+    doseUnit: Optional[Union[str, List[str]]] = None

schema_models/download_action.py

@@ -0,0 +1,7 @@
+from schema_models.transfer_action import TransferAction
+
+
+class DownloadAction(TransferAction):
+    """
+    The act of downloading an object.
+    """

schema_models/draw_action.py

@@ -0,0 +1,7 @@
+from schema_models.create_action import CreateAction
+
+
+class DrawAction(CreateAction):
+    """
+    The act of producing a visual/graphical representation of an object, typically with a pen/pencil and paper as instruments.
+    """

schema_models/drawing.py

@@ -0,0 +1,7 @@
+from schema_models.creative_work import CreativeWork
+
+
+class Drawing(CreativeWork):
+    """
+    A picture or diagram made with a pencil, pen, or crayon rather than paint.
+    """

schema_models/drink_action.py

@@ -0,0 +1,7 @@
+from schema_models.consume_action import ConsumeAction
+
+
+class DrinkAction(ConsumeAction):
+    """
+    The act of swallowing liquids.
+    """

schema_models/drive_wheel_configuration_value.py

@@ -0,0 +1,7 @@
+from schema_models.qualitative_value import QualitativeValue
+
+
+class DriveWheelConfigurationValue(QualitativeValue):
+    """
+    A value indicating which roadwheels will receive torque.
+    """