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

schema_models/price_specification.py

@@ -0,0 +1,31 @@
+from datetime import date, datetime
+from typing import List, Optional, Union
+
+from schema_models.member_program_tier import MemberProgramTier
+from schema_models.structured_value import StructuredValue
+
+
+class PriceSpecification(StructuredValue):
+    """
+    A structured value representing a price or price range. Typically, only the subclasses of this type are used for markup. It is recommended to use [[MonetaryAmount]] to describe independent amounts of money such as a salary, credit card limits, etc.
+    """
+
+    eligibleTransactionVolume: Optional[
+        Union["PriceSpecification", List["PriceSpecification"]]
+    ] = None
+    validFrom: Optional[Union[datetime, List[datetime], date, List[date]]] = None
+    validForMemberTier: Optional[Union[MemberProgramTier, List[MemberProgramTier]]] = (
+        None
+    )
+    valueAddedTaxIncluded: Optional[Union[bool, List[bool]]] = None
+    maxPrice: Optional[Union[float, List[float]]] = None
+    validThrough: Optional[Union[datetime, List[datetime], date, List[date]]] = None
+    membershipPointsEarned: Optional[
+        Union[float, List[float], "QuantitativeValue", List["QuantitativeValue"]]
+    ] = None
+    price: Optional[Union[str, List[str], float, List[float]]] = None
+    eligibleQuantity: Optional[
+        Union["QuantitativeValue", List["QuantitativeValue"]]
+    ] = None
+    priceCurrency: Optional[Union[str, List[str]]] = None
+    minPrice: Optional[Union[float, List[float]]] = None

schema_models/price_type_enumeration.py

@@ -0,0 +1,7 @@
+from schema_models.enumeration import Enumeration
+
+
+class PriceTypeEnumeration(Enumeration):
+    """
+    Enumerates different price types, for example list price, invoice price, and sale price.
+    """

schema_models/product.py

@@ -0,0 +1,162 @@
+from datetime import date
+from typing import List, Optional, Union
+
+from pydantic import HttpUrl
+
+from schema_models.thing import Thing
+
+
+class Product(Thing):
+    """
+    Any offered product or service. For example: a pair of shoes; a concert ticket; the rental of a car; a haircut; or an episode of a TV show streamed online.
+    """
+
+    hasMerchantReturnPolicy: Optional[
+        Union["MerchantReturnPolicy", List["MerchantReturnPolicy"]]
+    ] = None
+    audience: Optional[Union["Audience", List["Audience"]]] = None
+    width: Optional[
+        Union[
+            "Distance", List["Distance"], "QuantitativeValue", List["QuantitativeValue"]
+        ]
+    ] = None
+    review: Optional[Union["Review", List["Review"]]] = None
+    hasEnergyConsumptionDetails: Optional[
+        Union["EnergyConsumptionDetails", List["EnergyConsumptionDetails"]]
+    ] = None
+    countryOfAssembly: Optional[Union[str, List[str]]] = None
+    negativeNotes: Optional[
+        Union[
+            "WebContent",
+            List["WebContent"],
+            "ItemList",
+            List["ItemList"],
+            "ListItem",
+            List["ListItem"],
+            str,
+            List[str],
+        ]
+    ] = None
+    height: Optional[
+        Union[
+            "Distance", List["Distance"], "QuantitativeValue", List["QuantitativeValue"]
+        ]
+    ] = None
+    pattern: Optional[Union[str, List[str], "DefinedTerm", List["DefinedTerm"]]] = None
+    countryOfLastProcessing: Optional[Union[str, List[str]]] = None
+    hasCertification: Optional[Union["Certification", List["Certification"]]] = None
+    color: Optional[Union[str, List[str]]] = None
+    reviews: Optional[Union["Review", List["Review"]]] = None
+    awards: Optional[Union[str, List[str]]] = None
+    material: Optional[
+        Union[HttpUrl, List[HttpUrl], "Product", List["Product"], str, List[str]]
+    ] = None
+    purchaseDate: Optional[Union[date, List[date]]] = None
+    productID: Optional[Union[str, List[str]]] = None
+    manufacturer: Optional[Union["Organization", List["Organization"]]] = None
+    award: Optional[Union[str, List[str]]] = None
+    hasProductReturnPolicy: Optional[
+        Union["ProductReturnPolicy", List["ProductReturnPolicy"]]
+    ] = None
+    logo: Optional[
+        Union[HttpUrl, List[HttpUrl], "ImageObject", List["ImageObject"]]
+    ] = None
+    additionalProperty: Optional[Union["PropertyValue", List["PropertyValue"]]] = None
+    isAccessoryOrSparePartFor: Optional[Union["Product", List["Product"]]] = None
+    countryOfOrigin: Optional[Union["Country", List["Country"]]] = None
+    keywords: Optional[
+        Union[
+            HttpUrl, List[HttpUrl], "DefinedTerm", List["DefinedTerm"], str, List[str]
+        ]
+    ] = None
+    hasAdultConsideration: Optional[
+        Union["AdultOrientedEnumeration", List["AdultOrientedEnumeration"]]
+    ] = None
+    itemCondition: Optional[Union["OfferItemCondition", List["OfferItemCondition"]]] = (
+        None
+    )
+    offers: Optional[Union["Offer", List["Offer"], "Demand", List["Demand"]]] = None
+    hasMeasurement: Optional[Union["QuantitativeValue", List["QuantitativeValue"]]] = (
+        None
+    )
+    gtin13: Optional[Union[str, List[str]]] = None
+    asin: Optional[Union[str, List[str], HttpUrl, List[HttpUrl]]] = None
+    model: Optional[Union[str, List[str], "ProductModel", List["ProductModel"]]] = None
+    isConsumableFor: Optional[Union["Product", List["Product"]]] = None
+    isVariantOf: Optional[
+        Union[
+            "ProductModel", List["ProductModel"], "ProductGroup", List["ProductGroup"]
+        ]
+    ] = None
+    inProductGroupWithID: Optional[Union[str, List[str]]] = None
+    depth: Optional[
+        Union[
+            "QuantitativeValue", List["QuantitativeValue"], "Distance", List["Distance"]
+        ]
+    ] = None
+    isRelatedTo: Optional[
+        Union["Product", List["Product"], "Service", List["Service"]]
+    ] = None
+    mobileUrl: Optional[Union[str, List[str]]] = None
+    weight: Optional[Union["QuantitativeValue", List["QuantitativeValue"]]] = None
+    sku: Optional[Union[str, List[str]]] = None
+    gtin: Optional[Union[str, List[str], HttpUrl, List[HttpUrl]]] = None
+    isFamilyFriendly: Optional[Union[bool, List[bool]]] = None
+    funding: Optional[Union["Grant", List["Grant"]]] = None
+    productionDate: Optional[Union[date, List[date]]] = None
+    size: Optional[
+        Union[
+            "QuantitativeValue",
+            List["QuantitativeValue"],
+            "SizeSpecification",
+            List["SizeSpecification"],
+            str,
+            List[str],
+            "DefinedTerm",
+            List["DefinedTerm"],
+        ]
+    ] = None
+    mpn: Optional[Union[str, List[str]]] = None
+    slogan: Optional[Union[str, List[str]]] = None
+    gtin14: Optional[Union[str, List[str]]] = None
+    gtin12: Optional[Union[str, List[str]]] = None
+    isSimilarTo: Optional[
+        Union["Product", List["Product"], "Service", List["Service"]]
+    ] = None
+    releaseDate: Optional[Union[date, List[date]]] = None
+    brand: Optional[
+        Union["Organization", List["Organization"], "Brand", List["Brand"]]
+    ] = None
+    category: Optional[
+        Union[
+            Thing,
+            List[Thing],
+            "PhysicalActivityCategory",
+            List["PhysicalActivityCategory"],
+            "CategoryCode",
+            List["CategoryCode"],
+            str,
+            List[str],
+            HttpUrl,
+            List[HttpUrl],
+        ]
+    ] = None
+    positiveNotes: Optional[
+        Union[
+            "ItemList",
+            List["ItemList"],
+            "WebContent",
+            List["WebContent"],
+            "ListItem",
+            List["ListItem"],
+            str,
+            List[str],
+        ]
+    ] = None
+    hasGS1DigitalLink: Optional[Union[HttpUrl, List[HttpUrl]]] = None
+    colorSwatch: Optional[
+        Union["ImageObject", List["ImageObject"], HttpUrl, List[HttpUrl]]
+    ] = None
+    aggregateRating: Optional[Union["AggregateRating", List["AggregateRating"]]] = None
+    nsn: Optional[Union[str, List[str]]] = None
+    gtin8: Optional[Union[str, List[str]]] = None

schema_models/product_collection.py

@@ -0,0 +1,13 @@
+from typing import List, Optional, Union
+
+from schema_models.product import Product
+
+
+class ProductCollection(Product):
+    """
+    A set of products (either [[ProductGroup]]s or specific variants) that are listed together e.g. in an [[Offer]].
+    """
+
+    includesObject: Optional[
+        Union["TypeAndQuantityNode", List["TypeAndQuantityNode"]]
+    ] = None

schema_models/product_group.py

@@ -0,0 +1,15 @@
+from typing import List, Optional, Union
+
+from schema_models.product import Product
+
+
+class ProductGroup(Product):
+    """
+    A ProductGroup represents a group of [[Product]]s that vary only in certain well-described ways, such as by [[size]], [[color]], [[material]] etc.
+
+    While a ProductGroup itself is not directly offered for sale, the various varying products that it represents can be. The ProductGroup serves as a prototype or template, standing in for all of the products who have an [[isVariantOf]] relationship to it. As such, properties (including additional types) can be applied to the ProductGroup to represent characteristics shared by each of the (possibly very many) variants. Properties that reference a ProductGroup are not included in this mechanism; neither are the following specific properties [[variesBy]], [[hasVariant]], [[url]].
+    """
+
+    productGroupID: Optional[Union[str, List[str]]] = None
+    hasVariant: Optional[Union[Product, List[Product]]] = None
+    variesBy: Optional[Union["DefinedTerm", List["DefinedTerm"], str, List[str]]] = None

schema_models/product_model.py

@@ -0,0 +1,17 @@
+from typing import List, Optional, Union
+
+from schema_models.product import Product
+
+
+class ProductModel(Product):
+    """
+    A datasheet or vendor specification of a product (in the sense of a prototypical description).
+    """
+
+    successorOf: Optional[Union["ProductModel", List["ProductModel"]]] = None
+    isVariantOf: Optional[
+        Union[
+            "ProductModel", List["ProductModel"], "ProductGroup", List["ProductGroup"]
+        ]
+    ] = None
+    predecessorOf: Optional[Union["ProductModel", List["ProductModel"]]] = None

schema_models/product_return_enumeration.py

@@ -0,0 +1,7 @@
+from schema_models.enumeration import Enumeration
+
+
+class ProductReturnEnumeration(Enumeration):
+    """
+    ProductReturnEnumeration enumerates several kinds of product return policy. Note that this structure may not capture all aspects of the policy.
+    """

schema_models/product_return_policy.py

@@ -0,0 +1,14 @@
+from typing import List, Optional, Union
+
+from pydantic import HttpUrl
+
+from schema_models.intangible import Intangible
+
+
+class ProductReturnPolicy(Intangible):
+    """
+    A ProductReturnPolicy provides information about product return policies associated with an [[Organization]] or [[Product]].
+    """
+
+    productReturnDays: Optional[Union[int, List[int]]] = None
+    productReturnLink: Optional[Union[HttpUrl, List[HttpUrl]]] = None

schema_models/professional_service.py

@@ -0,0 +1,11 @@
+from schema_models.local_business import LocalBusiness
+
+
+class ProfessionalService(LocalBusiness):
+    """
+    Original definition: "provider of professional services."
+
+    The general [[ProfessionalService]] type for local businesses was deprecated due to confusion with [[Service]]. For reference, the types that it included were: [[Dentist]],
+            [[AccountingService]], [[Attorney]], [[Notary]], as well as types for several kinds of [[HomeAndConstructionBusiness]]: [[Electrician]], [[GeneralContractor]],
+            [[HousePainter]], [[Locksmith]], [[Plumber]], [[RoofingContractor]]. [[LegalService]] was introduced as a more inclusive supertype of [[Attorney]].
+    """

schema_models/profile_page.py

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

schema_models/program_membership.py

@@ -0,0 +1,25 @@
+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 ProgramMembership(Intangible):
+    """
+    Used to describe membership in a loyalty programs (e.g. "StarAliance"), traveler clubs (e.g. "AAA"), purchase clubs ("Safeway Club"), etc.
+    """
+
+    member: Optional[Union[Person, List[Person], Organization, List[Organization]]] = (
+        None
+    )
+    program: Optional[Union["MemberProgram", List["MemberProgram"]]] = None
+    programName: Optional[Union[str, List[str]]] = None
+    membershipPointsEarned: Optional[
+        Union[float, List[float], "QuantitativeValue", List["QuantitativeValue"]]
+    ] = None
+    members: Optional[Union[Organization, List[Organization], Person, List[Person]]] = (
+        None
+    )
+    hostingOrganization: Optional[Union[Organization, List[Organization]]] = None
+    membershipNumber: Optional[Union[str, List[str]]] = None

schema_models/project.py

@@ -0,0 +1,9 @@
+from schema_models.organization import Organization
+
+
+class Project(Organization):
+    """
+    An enterprise (potentially individual but typically collaborative), planned to achieve a particular aim.
+    Use properties from [[Organization]], [[subOrganization]]/[[parentOrganization]] to indicate project sub-structures.
+
+    """

schema_models/pronounceable_text.py

@@ -0,0 +1,14 @@
+from typing import List, Optional, Union
+
+from schema_models.text import Text
+
+
+class PronounceableText(Text):
+    """
+    Data type: PronounceableText.
+    """
+
+    textValue: Optional[Union[str, List[str]]] = None
+    inLanguage: Optional[Union["Language", List["Language"], str, List[str]]] = None
+    speechToTextMarkup: Optional[Union[str, List[str]]] = None
+    phoneticText: Optional[Union[str, List[str]]] = None

schema_models/property.py

@@ -0,0 +1,24 @@
+from typing import List, Optional, Union
+
+from schema_models.enumeration import Enumeration
+from schema_models.intangible import Intangible
+
+
+class Property(Intangible):
+    """
+    A property, used to indicate attributes and relationships of some Thing; equivalent to rdf:Property.
+    """
+
+    rangeIncludes: Optional[Union["_Class", List["_Class"]]] = None
+    domainIncludes: Optional[Union["_Class", List["_Class"]]] = None
+    supersededBy: Optional[
+        Union[
+            "Property",
+            List["Property"],
+            "_Class",
+            List["_Class"],
+            Enumeration,
+            List[Enumeration],
+        ]
+    ] = None
+    inverseOf: Optional[Union["Property", List["Property"]]] = None

schema_models/property_value.py

@@ -0,0 +1,81 @@
+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.measurement_type_enumeration import MeasurementTypeEnumeration
+from schema_models.qualitative_value import QualitativeValue
+from schema_models.structured_value import StructuredValue
+
+
+class PropertyValue(StructuredValue):
+    """
+    A property-value pair, e.g. representing a feature of a product or place. Use the 'name' property for the name of the property. If there is an additional human-readable version of the value, put that into the 'description' property.
+
+     Always use specific schema.org properties when a) they exist and b) you can populate them. Using PropertyValue as a substitute will typically not trigger the same effect as using the original, specific property.
+
+    """
+
+    unitText: Optional[Union[str, List[str]]] = None
+    unitCode: Optional[Union[str, List[str], HttpUrl, List[HttpUrl]]] = None
+    minValue: Optional[Union[float, List[float]]] = None
+    measurementTechnique: Optional[
+        Union[
+            str,
+            List[str],
+            HttpUrl,
+            List[HttpUrl],
+            DefinedTerm,
+            List[DefinedTerm],
+            MeasurementMethodEnum,
+            List[MeasurementMethodEnum],
+        ]
+    ] = None
+    propertyID: Optional[Union[str, List[str], HttpUrl, List[HttpUrl]]] = None
+    measurementMethod: Optional[
+        Union[
+            HttpUrl,
+            List[HttpUrl],
+            DefinedTerm,
+            List[DefinedTerm],
+            MeasurementMethodEnum,
+            List[MeasurementMethodEnum],
+            str,
+            List[str],
+        ]
+    ] = None
+    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
+    maxValue: Optional[Union[float, List[float]]] = None

schema_models/property_value_specification.py

@@ -0,0 +1,22 @@
+from typing import List, Optional, Union
+
+from schema_models.intangible import Intangible
+from schema_models.thing import Thing
+
+
+class PropertyValueSpecification(Intangible):
+    """
+    A Property value specification.
+    """
+
+    defaultValue: Optional[Union[Thing, List[Thing], str, List[str]]] = None
+    stepValue: Optional[Union[float, List[float]]] = None
+    multipleValues: Optional[Union[bool, List[bool]]] = None
+    valuePattern: Optional[Union[str, List[str]]] = None
+    valueMinLength: Optional[Union[float, List[float]]] = None
+    valueRequired: Optional[Union[bool, List[bool]]] = None
+    maxValue: Optional[Union[float, List[float]]] = None
+    valueMaxLength: Optional[Union[float, List[float]]] = None
+    readonlyValue: Optional[Union[bool, List[bool]]] = None
+    valueName: Optional[Union[str, List[str]]] = None
+    minValue: Optional[Union[float, List[float]]] = None

schema_models/protein.py

@@ -0,0 +1,11 @@
+from typing import List, Optional, Union
+
+from schema_models.bio_chem_entity import BioChemEntity
+
+
+class Protein(BioChemEntity):
+    """
+    Protein is here used in its widest possible definition, as classes of amino acid based molecules. Amyloid-beta Protein in human (UniProt P05067), eukaryota (e.g. an OrthoDB group) or even a single molecule that one can point to are all of type :Protein. A protein can thus be a subclass of another protein, e.g. :Protein as a UniProt record can have multiple isoforms inside it which would also be :Protein. They can be imagined, synthetic, hypothetical or naturally occurring.
+    """
+
+    hasBioPolymerSequence: Optional[Union[str, List[str]]] = None

schema_models/psychological_treatment.py

@@ -0,0 +1,7 @@
+from schema_models.therapeutic_procedure import TherapeuticProcedure
+
+
+class PsychologicalTreatment(TherapeuticProcedure):
+    """
+    A process of care relying upon counseling, dialogue and communication  aimed at improving a mental health condition without use of drugs.
+    """

schema_models/public_swimming_pool.py

@@ -0,0 +1,7 @@
+from schema_models.sports_activity_location import SportsActivityLocation
+
+
+class PublicSwimmingPool(SportsActivityLocation):
+    """
+    A public swimming pool.
+    """

schema_models/public_toilet.py

@@ -0,0 +1,7 @@
+from schema_models.civic_structure import CivicStructure
+
+
+class PublicToilet(CivicStructure):
+    """
+    A public toilet is a room or small building containing one or more toilets (and possibly also urinals) which is available for use by the general public, or by customers or employees of certain businesses.
+    """

schema_models/publication_event.py

@@ -0,0 +1,17 @@
+from typing import List, Optional, Union
+
+from schema_models.event import Event
+from schema_models.organization import Organization
+from schema_models.person import Person
+
+
+class PublicationEvent(Event):
+    """
+    A PublicationEvent corresponds indifferently to the event of publication for a CreativeWork of any type, e.g. a broadcast event, an on-demand event, a book/journal publication via a variety of delivery media.
+    """
+
+    publishedBy: Optional[
+        Union[Person, List[Person], Organization, List[Organization]]
+    ] = None
+    publishedOn: Optional[Union["BroadcastService", List["BroadcastService"]]] = None
+    free: Optional[Union[bool, List[bool]]] = None

schema_models/publication_issue.py

@@ -0,0 +1,16 @@
+from typing import List, Optional, Union
+
+from schema_models.creative_work import CreativeWork
+
+
+class PublicationIssue(CreativeWork):
+    """
+    A part of a successively published publication such as a periodical or publication volume, often numbered, usually containing a grouping of works such as articles.
+
+    See also [blog post](http://blog.schema.org/2014/09/schemaorg-support-for-bibliographic_2.html).
+    """
+
+    pagination: Optional[Union[str, List[str]]] = None
+    pageEnd: Optional[Union[int, List[int], str, List[str]]] = None
+    pageStart: Optional[Union[str, List[str], int, List[int]]] = None
+    issueNumber: Optional[Union[str, List[str], int, List[int]]] = None

schema_models/publication_volume.py

@@ -0,0 +1,16 @@
+from typing import List, Optional, Union
+
+from schema_models.creative_work import CreativeWork
+
+
+class PublicationVolume(CreativeWork):
+    """
+    A part of a successively published publication such as a periodical or multi-volume work, often numbered. It may represent a time span, such as a year.
+
+    See also [blog post](http://blog.schema.org/2014/09/schemaorg-support-for-bibliographic_2.html).
+    """
+
+    pagination: Optional[Union[str, List[str]]] = None
+    volumeNumber: Optional[Union[str, List[str], int, List[int]]] = None
+    pageEnd: Optional[Union[int, List[int], str, List[str]]] = None
+    pageStart: Optional[Union[str, List[str], int, List[int]]] = None

schema_models/qa_page.py

@@ -0,0 +1,7 @@
+from schema_models.web_page import WebPage
+
+
+class QAPage(WebPage):
+    """
+    A QAPage is a WebPage focussed on a specific Question and its Answer(s), e.g. in a question answering site or documenting Frequently Asked Questions (FAQs).
+    """

schema_models/qualitative_value.py

@@ -0,0 +1,40 @@
+from typing import List, Optional, Union
+
+from schema_models.defined_term import DefinedTerm
+from schema_models.enumeration import Enumeration
+from schema_models.measurement_type_enumeration import MeasurementTypeEnumeration
+from schema_models.structured_value import StructuredValue
+
+
+class QualitativeValue(Enumeration):
+    """
+    A predefined value for a product characteristic, e.g. the power cord plug type 'US' or the garment sizes 'S', 'M', 'L', and 'XL'.
+    """
+
+    greaterOrEqual: Optional[Union["QualitativeValue", List["QualitativeValue"]]] = None
+    greater: Optional[Union["QualitativeValue", List["QualitativeValue"]]] = None
+    additionalProperty: Optional[Union["PropertyValue", List["PropertyValue"]]] = None
+    nonEqual: Optional[Union["QualitativeValue", List["QualitativeValue"]]] = None
+    equal: Optional[Union["QualitativeValue", List["QualitativeValue"]]] = 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
+    lesser: Optional[Union["QualitativeValue", List["QualitativeValue"]]] = None
+    lesserOrEqual: Optional[Union["QualitativeValue", List["QualitativeValue"]]] = None